LinuxDoc-Tools User's Guide: Installation

## 2. Installation

## 2.1 Where to get the linuxdoc-tools sources

- You can get the source archive of the Linuxdoc-Tools from the page: https://packages.debian.org/source/unstable/linuxdoc-tools/. The name of the archive will be something like `linuxdoc-tools_x.y.z.orig.tar.gz`.
- Linuxdoc-Tools git repository can currently be reached at https://gitlab.com/agmartin/linuxdoc-tools. It contains an issue tracker to report problems.

## 2.2 What LinuxDoc-Tools Needs

LinuxDoc-Tools depends on the usage of sgml parser from Jade or OpenJade (nsgmls or onsgmls). You have to install either of them to use this.

The source archive of the linuxdoc-tools contains the tools and data that you need to write SGML documents and convert them to groff, LaTeX, PostScript, HTML, GNU info, LyX, and RTF. In addition to this package, you will need some additional tools for generating formatted output.

1. `groff`. You need version 1.08 or greater. You can get this from https://www.gnu.org/software/groff. You will need `groff` to produce plain text from your SGML documents. `nroff` will not work! You can find the version of your `groff` from `groff -v < /dev/null`.
2. TeX and LaTeX. This is available more or less everywhere; you should have no problem getting it and installing it (there is a Linux binary distribution on `sunsite.unc.edu`). Of course, you only need TeX/LaTeX if you want to format your SGML documents with LaTeX. So, installing TeX/LaTeX is optional. If you need PDF output, then you need pdfLaTeX also.
3. `flex`. (`lex` will probably not work). You can get flex from http://flex.sourceforge.net/.
4. The GNU info tools, for formatting and viewing info files. These are available on https://www.gnu.org/software/texinfo/.
5. LyX (a quasi-WYSIWYG interface to LaTeX, with SGML layouts), is available on https://www.lyx.org/.

## 2.3 Installing The Software

The steps needed to install and configure the LinuxDoc-Tools are:

1. First, unpack the tar file of the source archive somewhere. This will create the directory `linuxdoc-tools-x.y.z`. It doesn't matter where you unpack this file; just don't move things around within the extracted source tree.
2. Read the `INSTALL` file - it has detailed installation instructions. Follow them. If all went well, you should be ready to use the system immediately once you have done so.