projects/pwm

diff 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
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Thu Sep 21 09:45:59 2017 +0200
     1.3 @@ -0,0 +1,107 @@
     1.4 +pwm
     1.5 +===
     1.6 +
     1.7 +Description
     1.8 +-----------
     1.9 +
    1.10 +The pwm utility is a password manager which stores passwords and associated
    1.11 +metadata in an encrypted database protected by a master password.  It has a
    1.12 +text-based user interface and can be used both interactively and
    1.13 +non-interactively.  The database uses the PasswordSafe database format
    1.14 +version 3 and is thus compatible with other password managers using this
    1.15 +format.
    1.16 +
    1.17 +Build Instructions
    1.18 +------------------
    1.19 +
    1.20 +pwm requires a POSIX:2004 compatible operating system, it has been tested to
    1.21 +work on Linux distributions, FreeBSD, NetBSD, OpenBSD, Solaris and
    1.22 +Illumos-derived distributions.  The following tools and shared libraries are
    1.23 +required to build pwm:
    1.24 +
    1.25 +- GNU make >= 3.81
    1.26 +- GNU or BSD install
    1.27 +- libtecla >= 1.6.0
    1.28 +- libpws >= 1.0.0
    1.29 +
    1.30 +Rebuilding the man pages additionally requires the xsltproc tool from libxml2.
    1.31 +
    1.32 +Before building pwm check the commented macros in the Makefile for any
    1.33 +macros you may need to override depending on the used toolchain and operating
    1.34 +system.
    1.35 +
    1.36 +By default, all files will be installed under the "/usr/local" directory, a
    1.37 +different installation path prefix can be set via the `prefix` macro.  In
    1.38 +addition, a second path prefix can be specified via the `DESTDIR` macro which
    1.39 +will be prepended to any path, incuding the `prefix` macro path prefix.  In
    1.40 +contrast to `prefix`, the path specified via the `DESTDIR` macro will only be
    1.41 +prepended to paths during installation and not be used for constructing
    1.42 +internal paths.
    1.43 +
    1.44 +The following instructions assume that `make` is GNU make, on some platforms
    1.45 +it may be installed under a different name or a non-default path.  In order to
    1.46 +start the build process run `make all`.  After a successful build, run `make
    1.47 +install` to install the program, any associated data files and the
    1.48 +documentation.
    1.49 +
    1.50 +Previously built binaries, object files, generated data files and
    1.51 +documentation can be removed by running `make clean`, any additional,
    1.52 +generated files which are not removed by the `clean` target can be removed by
    1.53 +running `make clobber`.
    1.54 +
    1.55 +Contact
    1.56 +-------
    1.57 +
    1.58 +Please send any feedback, translations or bug reports via email to
    1.59 +<guido+pwm@berhoerster.name>.
    1.60 +
    1.61 +Bug Reports
    1.62 +-----------
    1.63 +
    1.64 +When sending bug reports, please always mention the exact version of pwm
    1.65 +with which the issue occurs as well as the version of the operating system you
    1.66 +are using and make sure that you provide sufficient information to reproduce
    1.67 +the issue and include any input, output, any error messages.
    1.68 +
    1.69 +In case of build issues, please also specify the implementations and versions
    1.70 +of the tools and shared libraries used to build the program, in particular the
    1.71 +compiler.
    1.72 +
    1.73 +In case of crashes, please generate a stack trace with a suitable debugger
    1.74 +such as gdb, lldb, dbx, or debug after a crash has occurred either by
    1.75 +examining the resulting core file or by running the program from the debugger
    1.76 +and attach it to the bug report.  In order to generate a meaningful stack
    1.77 +trace the program as well as any dynamically linked libraries need to be built
    1.78 +with debugging information, see the documentation of the used compiler for the
    1.79 +required compiler flags.  If any of the dynamically linked shared libraries do
    1.80 +not contain debugging information, please either install debugging information
    1.81 +for these libraries using mechanisms provided by your operating system or
    1.82 +rebuild the libraries accordingly.  Please refer to the documentation of the
    1.83 +debugger for detailed instructions on generating backtraces.
    1.84 +
    1.85 +License
    1.86 +-------
    1.87 +
    1.88 +Except otherwise noted, all files are Copyright (C) 2017 Guido Berhoerster and
    1.89 +distributed under the following license terms:
    1.90 +
    1.91 +Copyright (C) 2017 Guido Berhoerster <guido+pwm@berhoerster.name>
    1.92 +
    1.93 +Permission is hereby granted, free of charge, to any person obtaining
    1.94 +a copy of this software and associated documentation files (the
    1.95 +"Software"), to deal in the Software without restriction, including
    1.96 +without limitation the rights to use, copy, modify, merge, publish,
    1.97 +distribute, sublicense, and/or sell copies of the Software, and to
    1.98 +permit persons to whom the Software is furnished to do so, subject to
    1.99 +the following conditions:
   1.100 +
   1.101 +The above copyright notice and this permission notice shall be included
   1.102 +in all copies or substantial portions of the Software.
   1.103 +
   1.104 +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
   1.105 +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
   1.106 +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
   1.107 +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
   1.108 +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
   1.109 +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
   1.110 +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.