Mercurial > projects > sencrypt

comparison README @ 6:fcaa8b650cdd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improve README file Improve build instructions. Add information on bug reporting. Add contact information.
author Guido Berhoerster <guido+sencrypt@berhoerster.name>
date Fri, 09 Jan 2015 17:13:58 +0100
parents f0ceb0ad20e7
children b7309b030e8d
comparison
equal deleted inserted replaced
5:5cc938aff9ab 6:fcaa8b650cdd
13 encrypt and decrypt utilities in Solaris/Illumos-based operating systems. 13 encrypt and decrypt utilities in Solaris/Illumos-based operating systems.
14 14
15 Build Instructions 15 Build Instructions
16 ------------------ 16 ------------------
17 17
18 sencrypt requires a POSIX:2004 compatible operating system, and needs GNU make, 18 sencrypt requires a POSIX:2004 compatible operating system, it has been tested
19 GNU or BSD install, the xsltproc tool from libxml2 and the OpenSSL library to 19 to work on Linux distributions, FreeBSD, Solaris and Illumos-derived
20 be installed. It has been tested on Linux distributions, FreeBSD, Solaris and 20 distributions, UnixWare, and OpenServer. The following tools and shared
21 Illumos-derived distributions, UnixWare, and OpenServer. 21 libraries are required to build sencrypt:
22
23 - GNU make >= 3.81
24 - GNU or BSD install
25 - OpenSSL
26
27 Rebuilding the man pages additionally requires the xsltproc tool from libxml2.
28
29 Before building sencrypt 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+sencrypt@berhoerster.name>.
57
58 Bug Reports
59 -----------
60
61 When sending bug reports, please always mention the exact version of sencrypt
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.
22 81
23 License 82 License
24 ------- 83 -------
25 84
26 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and 85 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and