File: INSTALL

package info (click to toggle)
yapet 0.6-3
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 6,012 kB
  • ctags: 2,913
  • sloc: ansic: 13,661; cpp: 11,384; sh: 4,814; makefile: 847; yacc: 291; sed: 16
file content (204 lines) | stat: -rw-r--r-- 5,632 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
YAPET - Yet Another Password Encryption Tool 0.6

Installation Instructions

Rafael Ostertag

$Id: INSTALL.sgml.in 2904 2009-09-04 05:11:30Z rafi $

Copyright  2008, 2009 Rafael Ostertag <rafi@guengel.ch>

-------------------------------------------------------------------------------

Table of Contents

Build Prerequisites

    Supported Platforms
    Supported Compilers

Brief Build Instructions
Brief configure Options Description
What gets installed?
Further Information

Build Prerequisites

YAPET was designed to have only few library dependencies, and to build on most
popular Unixes.

YAPET depends on two libraries

  * OpenSSL (http://www.openssl.org)
  * curses or ncurses (http://www.gnu.org/software/ncurses/)

As of version 0.3 YAPET uses GNU Gettext for internationalization, hence GNU
Gettext is an optional dependency. In case GNU Gettext is not available on the
build system, the GNU Gettext version included in the source distribution is
used.

Supported Platforms

YAPET has been tested to build and run on following platforms:

  * FreeBSD
  * Sun? Solaris? x86
  * Linux
  * Cygwin

Supported Compilers

YAPET is written in C++, so you obviously need a C++ compiler to compile. It
compiles out of the box using the following compilers

  * Sun? Studio 11/12 C++ Compiler (only tested under Sun? Solaris? 10 x86)
  * GNU GCC

Brief Build Instructions

YAPET uses a configure script as generated by autoconf and friends for
configuring the build process of YAPET. Change to the directory where you
unpacked yapet-0.6.tar.gz and simply type

  # ./configure

on the command line. The configure script will then check the system and
prepare for the build process.

If the configure script successfully finishes, type

  # make

YAPET will now be built. After the build has finished, switch to the root user
if not done already, and type

  # make install

This will install YAPET into the /usr/local/bin directory, if the prefix has
not been changed by providing --prefix=<PATH> to the configure script.

To start YAPET issue /usr/local/bin/yapet on the command line.

Brief configure Options Description

--prefix=<PATH>

    <PATH> is the base directory where YAPET will be installed. The executable
    is installed in <PATH>/bin.

--with-curses-include=<PATH>

    This option tells the compiler where to find the header files of curses/
    ncurses. <PATH> has to be the directory where the header files are located,
    not the file name of the header file.

--with-curses-lib=<PATH>

    This option tells the linker where to find the curses/ncurses shared
    library. <PATH> has to be the directory where the shared library is
    located, not the file name of the shared library.

--with-openssl-include=<PATH>

    This options tells the compiler where to find the header files of OpenSSL.
    <PATH> has to be the directory where the header files are located, not the
    file name of the header file.

--with-openssl-lib=<PATH>

    This option tells the linker where to find the OpenSSL shared library.
    <PATH> has to be the directory where the shared library is located, not the
    file name of the shared library.

--enable-build-doc

    Instructs the build system to (re-)generate the documentation files. You
    usually do not need this, since the source distribution ships with
    pre-built documentation files.

    This option depends on the two applications xsltproc and lynx/w3m . They
    need to be installed on the system and to be found by configure else
    setting this option won't have any effect.

--enable-source-doc

    Providing this option will make the build system to generate the source
    code documentation using doxygen.

    This options has only effect if doxygen is installed on the system and
    found by configure.

    The source code documentation will not be installed. It is located in the
    doc/ directory of the build directory.

--enable-terminal-title

    Instructs the build process to compile YAPET with support for setting the
    terminal title in XTerm and friends. Enabled by default.

--disable-csv2yapet

    If given the csv2yapet import utility will not be built.

--disable-pwgen

    Disables built-in password generator.

--disable-nls

    Disables the Native Language Support.

What gets installed?

Upon issuing make install the following files are installed in <PATH>

<PATH>/bin/yapet

    The YAPET binary.

<PATH>/bin/csv2yapet

    Utility for converting CSV files into YAPET files.

    Will be installed only when the build of csv2yapet has not been disabled.

<PATH>/share/man/man1/[yapet.1|csv2yapet.1]

    The manual page for YAPET.

    csv2yapet.1 will be installed only when the build of csv2yapet has not been
    disabled.

    Files won't be installed when installation of documentation files has been
    disabled.

<PATH>/share/applications/yapet.desktop

    The desktop file for GNOME et al.

<PATH>/share/doc/[AUTHORS|COPYING|DESIGN|LICENSE|README]

    Various documentation files.

    Files won't be installed when installation of documentation files has been
    disabled.

<PATH>/share/doc/html/[DESIGN.html|README.html|yapet.html|csv2yapet.html]

    Various documentation files in HTML format.

    csv2yapet.html will be installed only when the build of csv2yapet has not
    been disabled.

    Files won't be installed when installation of documentation files has been
    disabled.

<PATH>/share/locale/LANG

    The translation files.

Further Information

For more detailed information about the configure script, read the file
INSTALL.generic which comes along with the tarball of YAPET.