www.delorie.com/gnu/gnu2html/gnudocs.ini.html   search  
gnudocs.ini format

Each line in gnudocs.ini is a command to gnu2html. Blank lines and lines beginning with a hash sign (#) are ignored. Remaining lines begin with a command (usually a single character) followed by parameters or other data. Commands are processed in sequence. Converted files are listed in the sequence they are converted; the first such conversion is linked from the main index entry.

Commands described with "find and ..." mean that they search for the given file anywhere in the source distribution, copy it to the temporary working directory, and use it.

x source-archive-V.R

Locate the given source archive on the FTP server, create a temporary working directory, and extract the archive there. Note that you should not provide the .tar.gz as gnu2html searches a number of such extensions automatically, and because the name you give is used to create the index page. This archive (and all command up to the next x) is automatically skipped if the archive hasn't changed since the last time it was converted.

d directory file(s)

Manually start a new subdirectory (and index section) with the given name. Since this isn't automatically done by an archive, you may list archives (or any other file on the ftp site) and gnu2html will check to see if those files have changed, and skip this directory if they haven't.

t file.texi optional title
T file.texi optional title

Find and convert the given texinfo file. The title is usually taken from the texinfo itself, but you can override that by providing a title after the file name. If the texinfo file includes other texinfo files, you'll need to use the f command to find those before converting the main file. If you use T instead of t, the result is a single HTML file instead of one per node.

m file.1 optional title

Find and convert the given man page file. The title is usually taken from the man page itself, but you can override that by providing a title after the file name.

f wildcard(s)

Find all files matching the given wildcards in the source archive and copy them to the temporary working directory. This uses the "find" command. You'll need to use this to gather files included by the main texinfo files.

w file optional title

Find the given file and copy it directly to the web area.

! command

Run the given command

C number

Specify that the list of documentation links for this archive should be presented in that many columns (instead of just one).

z archive.tar.gz file(s)
z file(s)

In the first case, extract the given files from the given archive and put them in the temporary working directory. In the second case, copy the given files from the ftp archive to the temporary working directory.

S

This indicates that the given archive's links should exist only on the subpage, and the one link in the main index will link to that. This is used when there are a lot of small files (say, man pages)

n name

Pretend that the archive's name is name. This can be used for files like gst115.tgz that are not named with the same convention as the other files.

NI

This means "No Index", for cases where the archive contains its own HTML index.


  webmaster   donations   bookstore     delorie software   privacy  
  Copyright 1997   by The Free Software Foundation     Updated Oct 1997