Mercurial > projects > libpws

comparison README @ 1:e1309515d111

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