YAPET - Yet Another Password Encryption Tool 1.0

Installation Instructions

Rafael Ostertag

$Id: INSTALL.sgml.in 5987 2014-02-18 20:08:24Z rafi $

Copyright © 2008, 2009, 2010, 2011, 2013, 2014 Rafael Ostertag
<rafi@guengel.ch>

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Table of Contents

1. Build Prerequisites

    1.1. Supported Platforms
    1.2. Supported Compilers

2. Brief Build Instructions
3. Brief configure Options Description
4. What Gets Installed?
5. Further Information

1. 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.

1.1. Supported Platforms

YAPET has been tested on following platforms:

  ● Oracle Solaris
  ● FreeBSD
  ● OpenBSD
  ● NetBSD
  ● Linux
  ● Cygwin

1.2. 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/Solaris Studio 12.2 C++ Compiler or later
  ● Clang
  ● GNU GCC

2. 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-1.0.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.

3. Brief configure Options Description

--prefix=<PATH>

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

--with-openssl=<PATH>

    Installation prefix of OpenSSL. The build system will search for OpenSSL
    headers in <PATH>/include and for OpenSSL libraries in <PATH>/lib.

--disable-converters

    If provided the csv2yapet and yapet2csv utility will not be built.

--disable-nls

    Disables Native Language Support.

4. What Gets Installed?

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

<PATH>/bin/yapet

    The YAPET binary.

<PATH>/bin/[csv2yapet|yapet2csv]

    Conversion utilities.

    csv2yapet and yapet2csv will be installed only when --disable-converters
    has not been provided.

<PATH>/share/man/man1/[yapet.1|csv2yapet.1|yapet2csv.1|yapet_config.5|
    yapet_colors.5]

    The manual page for YAPET.

    csv2yapet.1 and yapet2csv.1 will be installed only when
    --disable-converters has not been provided.

<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 using --disable-install-doc.

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

    Various documentation files in HTML format.

    csv2yapet.html and yapet2csv.html will be installed only when
    --disable-converters has not been provided.

    Files won't be installed when installation of documentation files has been
    disabled using --disable-install-doc.

<PATH>/share/locale/LANG

    The translation files.

5. Further Information

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

