To make it easy for users to find documentation, as much as possible
should be installed under the /store/doc/<app> directory. This
means user guides, reference cards, background information etc.
If possible, such documentation should be available as ascii text, dvi files, and postscript files.
Most programs will have at least some manual pages, to be made available
under the /store/man directory. The directories are divided
as follows:
Note that this follows the traditional BSD layout. In most cases,
installing the nroff source files will be sufficient. In some
cases, it may be desirable to process the manual pages into postscript
and put them with other documentation under /store/doc/<app> as
above.
Most applications from FSF (the Free Software Foundation), like gcc and bison, come with their documentation in the TeXinfo format. The TeXinfo format can be used to create printable documentation (using Don Knuth's TeX typesetting program) and to create info files. Info files are hypertext documents that can be read by Emacs, and by standalone info readers like info, xinfo, and ivinfo.
To process a texinfo file, use the makeinfo and texi2dvi
programs (these are in the texinfo application). In addition, you need
to create a one line description to be merged into the top level menu
(/store/emacs/info/dir). The STORE convention for this is to
put the description into a file named programname.dir.type
where type is one of the following:
calc
gcc, gdb and so on
tar
The division into types is controlled by the file /store/emacs/info/dir.pre. To get a correct syntax for the short-description file, just copy one of the preexisting files --- it will be merged into an emacs-info menu.
Up : Installing software in STORE, Previous: Installation tools, Next : Example installation: Gopher.
arnej@lise.unit.no