INSTALL-DOCS

Section: Debian Utilities (8)
Updated: 2005-05-14
Index
Return to Main Contents

NAME

install-docs - manage online Debian documentation

SYNOPSIS

 install-docs -i --install | 
              -r --remove  |
              -s --status  |
              -L --listfiles
              [ -v, --verbose ]
                <doc-id | file>

DESCRIPTION

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

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.

OPTIONS

-v | --verbose: Operate verbosely.
-i file | --install file: Install the documentation described by the control file file.
-r docid | --remove docid: Remove the documentation identified by the document identifier docid. Document identifiers are tags which are set in the control file, and usually correspond to the package name.
-s docid | --status docid: Display the status of the document identifier docid.
-L docid | --listfiles docid: List the files associated with the document identifier docid.

BUGS

None known, but a much more robust system is being planned as the next generation of doc-base.

AUTHOR

This program was originally written by Christian Schwarz <schwarz@debian.org>, for the Debian GNU/Linux system. Adam Di Carlo <aph@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>.

This document was created by man2html, using the manual pages.
Time: 12:01:34 GMT, April 26, 2024