projects/pwm

annotate README @ 26:5bdea77d0c1d

Add pwm-clip utility for setting the X11 CLIPBOARD selection
author Guido Berhoerster <guido+pwm@berhoerster.name>
date Thu Sep 21 09:45:59 2017 +0200 (2017-09-21)
parents
children
rev   line source
guido+pwm@1 1 pwm
guido+pwm@1 2 ===
guido+pwm@1 3
guido+pwm@1 4 Description
guido+pwm@1 5 -----------
guido+pwm@1 6
guido+pwm@1 7 The pwm utility is a password manager which stores passwords and associated
guido+pwm@1 8 metadata in an encrypted database protected by a master password. It has a
guido+pwm@1 9 text-based user interface and can be used both interactively and
guido+pwm@1 10 non-interactively. The database uses the PasswordSafe database format
guido+pwm@1 11 version 3 and is thus compatible with other password managers using this
guido+pwm@1 12 format.
guido+pwm@1 13
guido+pwm@1 14 Build Instructions
guido+pwm@1 15 ------------------
guido+pwm@1 16
guido+pwm@1 17 pwm requires a POSIX:2004 compatible operating system, it has been tested to
guido+pwm@1 18 work on Linux distributions, FreeBSD, NetBSD, OpenBSD, Solaris and
guido+pwm@1 19 Illumos-derived distributions. The following tools and shared libraries are
guido+pwm@1 20 required to build pwm:
guido+pwm@1 21
guido+pwm@1 22 - GNU make >= 3.81
guido+pwm@1 23 - GNU or BSD install
guido+pwm@1 24 - libtecla >= 1.6.0
guido+pwm@1 25 - libpws >= 1.0.0
guido+pwm@1 26
guido+pwm@1 27 Rebuilding the man pages additionally requires the xsltproc tool from libxml2.
guido+pwm@1 28
guido+pwm@1 29 Before building pwm check the commented macros in the Makefile for any
guido+pwm@1 30 macros you may need to override depending on the used toolchain and operating
guido+pwm@1 31 system.
guido+pwm@1 32
guido+pwm@1 33 By default, all files will be installed under the "/usr/local" directory, a
guido+pwm@1 34 different installation path prefix can be set via the `prefix` macro. In
guido+pwm@1 35 addition, a second path prefix can be specified via the `DESTDIR` macro which
guido+pwm@1 36 will be prepended to any path, incuding the `prefix` macro path prefix. In
guido+pwm@1 37 contrast to `prefix`, the path specified via the `DESTDIR` macro will only be
guido+pwm@1 38 prepended to paths during installation and not be used for constructing
guido+pwm@1 39 internal paths.
guido+pwm@1 40
guido+pwm@1 41 The following instructions assume that `make` is GNU make, on some platforms
guido+pwm@1 42 it may be installed under a different name or a non-default path. In order to
guido+pwm@1 43 start the build process run `make all`. After a successful build, run `make
guido+pwm@1 44 install` to install the program, any associated data files and the
guido+pwm@1 45 documentation.
guido+pwm@1 46
guido+pwm@1 47 Previously built binaries, object files, generated data files and
guido+pwm@1 48 documentation can be removed by running `make clean`, any additional,
guido+pwm@1 49 generated files which are not removed by the `clean` target can be removed by
guido+pwm@1 50 running `make clobber`.
guido+pwm@1 51
guido+pwm@1 52 Contact
guido+pwm@1 53 -------
guido+pwm@1 54
guido+pwm@1 55 Please send any feedback, translations or bug reports via email to
guido+pwm@1 56 <guido+pwm@berhoerster.name>.
guido+pwm@1 57
guido+pwm@1 58 Bug Reports
guido+pwm@1 59 -----------
guido+pwm@1 60
guido+pwm@1 61 When sending bug reports, please always mention the exact version of pwm
guido+pwm@1 62 with which the issue occurs as well as the version of the operating system you
guido+pwm@1 63 are using and make sure that you provide sufficient information to reproduce
guido+pwm@1 64 the issue and include any input, output, any error messages.
guido+pwm@1 65
guido+pwm@1 66 In case of build issues, please also specify the implementations and versions
guido+pwm@1 67 of the tools and shared libraries used to build the program, in particular the
guido+pwm@1 68 compiler.
guido+pwm@1 69
guido+pwm@1 70 In case of crashes, please generate a stack trace with a suitable debugger
guido+pwm@1 71 such as gdb, lldb, dbx, or debug after a crash has occurred either by
guido+pwm@1 72 examining the resulting core file or by running the program from the debugger
guido+pwm@1 73 and attach it to the bug report. In order to generate a meaningful stack
guido+pwm@1 74 trace the program as well as any dynamically linked libraries need to be built
guido+pwm@1 75 with debugging information, see the documentation of the used compiler for the
guido+pwm@1 76 required compiler flags. If any of the dynamically linked shared libraries do
guido+pwm@1 77 not contain debugging information, please either install debugging information
guido+pwm@1 78 for these libraries using mechanisms provided by your operating system or
guido+pwm@1 79 rebuild the libraries accordingly. Please refer to the documentation of the
guido+pwm@1 80 debugger for detailed instructions on generating backtraces.
guido+pwm@1 81
guido+pwm@1 82 License
guido+pwm@1 83 -------
guido+pwm@1 84
guido+pwm@1 85 Except otherwise noted, all files are Copyright (C) 2017 Guido Berhoerster and
guido+pwm@1 86 distributed under the following license terms:
guido+pwm@1 87
guido+pwm@1 88 Copyright (C) 2017 Guido Berhoerster <guido+pwm@berhoerster.name>
guido+pwm@1 89
guido+pwm@1 90 Permission is hereby granted, free of charge, to any person obtaining
guido+pwm@1 91 a copy of this software and associated documentation files (the
guido+pwm@1 92 "Software"), to deal in the Software without restriction, including
guido+pwm@1 93 without limitation the rights to use, copy, modify, merge, publish,
guido+pwm@1 94 distribute, sublicense, and/or sell copies of the Software, and to
guido+pwm@1 95 permit persons to whom the Software is furnished to do so, subject to
guido+pwm@1 96 the following conditions:
guido+pwm@1 97
guido+pwm@1 98 The above copyright notice and this permission notice shall be included
guido+pwm@1 99 in all copies or substantial portions of the Software.
guido+pwm@1 100
guido+pwm@1 101 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
guido+pwm@1 102 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
guido+pwm@1 103 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
guido+pwm@1 104 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
guido+pwm@1 105 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
guido+pwm@1 106 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
guido+pwm@1 107 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.