install-docs

install-docs - manage online Debian documentation

install-docs [options] -i,--install | -r,--remove | -c,--check file [ file ... ]

install-docs [options] -I,--install-all | -R,--remove-all

install-docs [options] -s,--status docid [ docid ... ]

install-docs -h | --help

install-docs is a tool allow Debian package maintainers to register documentation to various documentation systems. It currently supports dhelp, dwww, doc-central, and scrollkeeper browsers.

This manual page provides a quick synopsis of install-docs usage. Full documentation can be found in the documentation, including a description of the control file syntax and grammar.

"-v, Operate verbosely.

"-d, Print some debugging informations.

"--no-update-menus" Inhibit running both update-menus(1) (used for the dwww(8) update program) and scrollkeeper-update(8).

"--rootdir Set the root directory to dir instead of `/'. Useful and valid only with the --check action.

"-h, Show a short help message.

Below is list of possible actions install-docs could handle. There can be only one action option passed to install-docs, moreover the action with its arguments must be the last option passed.

Each file argument should be the full path for the doc-base control file (i.e. `/usr/share/doc-base/some_file'), and each docid should be the document identifier (Document identifiers are set in the `Document' field of the control file, and usually correspond to the package name.)

If file or docid equals `-' (the minus sign), the list of arguments is read from the standard input (each file name or document id in separate line).

"-i Install the documentation described by the control file file.

"-r Remove the documentation identified by the control file file.

"-c Check the control file file and display number of possible problems found. Use with --verbose to get the actual locations of errors and warnings. If --rootdir was also given, its argument will be prepended to names of the files given if the `Files' and `Index' fields of the file.

"-R, De-register all registered documents.

"-I, (Re)register all documents from /usr/share/doc-base.

"-s Display the status of the document identifier docid.

"-L Deprecated option. Does nothing.

The following features were added in version 0.8.4, please make sure to add proper `Conflicts' or `Depends' lines if you would like to use them in your package's scripts:

"" support for passing more than one argument to the -i and -r actions,

"" reading arguments from the standard input,

"" -I,--install-all, -R,---remove-all, -c,--check actions,

"" -d,--debug, -h,--help options.

"/usr/share/doc-base/" The location of doc-base control files installed by various packages.

"/var/lib/doc-base/info/*.status" Statuses of registered documents.

"/var/lib/doc-base/omf/" The location of generated scrollkeeper \s-1OMF\s0 files. Note: /usr/share/omf/doc-base should be a symbolic link pointing to the directory.

"/usr/share/doc/*/.dhelp" The location of generated dhelp files.

See <http://bugs.debian.org/doc-base>.

dwww(8), scrollkeeper(7), Debian doc-base Manual /usr/share/doc/doc-base/doc-base.html/index.html, dhelp Manual /usr/share/doc/dhelp/dhelp.html

This program was originally written by Christian Schwarz <schwarz@debian.org>, for the Debian GNU/Linux system, and the next maintainer was Adam Di Carlo <aph@debian.org>. Robert Luberda <robert@debian.org> is currently maintaining and extending it.

This software was meant to be for the benefit of the entire Debian user and developer community. If you are interested in being involved with this software, please join the mailing list <debian-doc@lists.debian.org>.