systags1

Usage

Overview

This manual page documents briefly the systags command.

This manual page was written for the Debian GNU/Linux distribution because the original program does not have a manual page.

systags is a script that generates a tagged html version of a source code directory. The script is specially prepared to work with the source of FreeBSD, NetBSD, OpenBSD, Linux, GNUmach and GNUhurd.

systags invokes htags(1) with -lhna options, which can significantly increase the size of the html tree produced.

To build the HTML tree the command must be called from the root of the source tree.

Options

-c

Compress html files by gzip(1). The option is passed to the htags(1) command.

-C

Option passed to htags(1) to produce compressed files with html.gz suffix. This may be preferred to -c on Debian GNU/Linux systems.

-g

Generate only the databases needed by global(1). Basically it only executes the gtags(1) command.

-f

Support an input form and a dynamic index with a CGI program. The option is passed to the htags(1) command.

-n

Run in test mode. Shows the commands that the script calls to do its work, but does not execute them.

dir

The directory in which hypertext is generated. The default is the current directory.

Examples

To generate a compressed browseable version of the linux kernel on a Debian system you can do:

cd /usr/src/linux systags