- Table of Contents
- Previous Chapter
- Next Chapter

# Chapter 2: Installation

This chapter describes stealth's compilation and installation.

## 2.1: Compiling and installing Stealth

After downloading the stealth archive, it should be unpacked. The name of the archive is of the form `stealth-4.04.00.tar.gz`, where `4.04.00` is a version number. Below, `4.04.00` should be altered into the version of the archive that is actually used.

Required, non-standard software, for compiling stealth is summarized in the file `required`, which is included in the source file distribution. Currently, its contents are:

    This file lists non-standard software only. Thus, standard utilities like cp,
    mv, sed, etc, etc, are not explicitly mentioned. Neither is the gcc compiler
    explicitly mentioned, but a fairly recent one is assumed.

    Required software for building Stealth:
    ---------------------------------------

    Latest versions of:

        libbobcat-dev   (cf. https://fbb-git.gitlab.io/bobcat/)
        icmake          (cf. https://fbb-git.gitlab.io/icmake/)
        yodl            (cf. https://fbb-git.gitlab.io/yodl/)

    To construct the user guide:

        texlive-latex-base,
        texlive-generic-recommended,
        texlive-latex-recommended,
        texlive-latex-extra,
        texlive-fonts-recommended,
        cm-super-minimal,
        ghostscript

- Stealth compilation is controlled by icmake(1). The program maintenance utility icmake(1) can be obtained at https://fbb-git.gitlab.io/icmake/, and it is also available in several Linux distributions (e.g., Debian, Ubuntu);

- Determine a directory where the files in stealth's archive ashould be stored. E.g., if the files in the archive should be stored under `/tmp` (and assuming the archive itself is stored in `/tmp` as well) then do:

          cd /tmp
          tar xzf stealth-_CurVers_.tar.gz

  This creates a subdirectory `stealth` containing stealth's sources;

- Change-dir to that directory:

          chdir stealth

- Check the contents of the files `INSTALL.im` and `icmconf`, and verify that all `#defines` match your computer's file system and software.

  When compiling stealth, the bobcat header files must be available. When stealth is run it is dynamically linked against the bobcat library. Bobcat can be downloaded from https://gitlab.com/fbb-git/bobcat/ (and follow its installation instructions). Alternatively, bobcat may be available in your distribution, (e.g., Debian or Ubuntu). Make sure to install both the run-time (bobcat_...) and the development (bobcat-dev_...) versions.

- Execute the command

          ./build program strip

  This command by default creates the program ./tmp/bin/binary.

- To install stealth and its documentation, several commands are available:

         ./build install program [path] - installs the program as `path'
                                      (by default as `/usr/bin/stealth')
         ./build install man [base]   - install the man pages below `base'
                                      (by default below `/usr/share/man/man1')
         ./build install manual [base]- install the manual below `base'
                                      (by default below
                                          `/usr/share/doc/stealth-doc/manual')
         ./build install std [base]   - install standard docs below `base'
                                      (by default below `/usr/share/doc/stealth')
         ./build install extra [base] - install extra docs below `base'
                                      (by default below
                                          `/usr/share/doc/stealth-doc')

- Table of Contents
- Previous Chapter
- Next Chapter