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