unixdev.net


Switch to SpeakEasy.net DSL

The Modular Manual Browser

Home Page
Manual: (Debian-3.1)
Page:
Section:
Apropos / Subsearch:
optional field

INSTALL-DOCS(8)                Debian Utilities                INSTALL-DOCS(8)



NAME
       install-docs - manage online Debian documentation

SYNOPSIS
        install-docs [ -v, --verbose ]
                     [ --no-update-menus ]
                     -i --install |
                     -r --remove  |
                     -s --status  |
                     -L --listfiles
                       <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 descrip-
       tion of the control file syntax and grammar.

OPTIONS
       -v | --verbose
           Operate verbosely.

       --no-update-menus
           Inhibit running update-menus(1L), used for the dwww(1) update pro-
           gram.

       -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.

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

AUTHOR
       This program was originally written by Christian Schwarz
       <schwarzATdebian.org>, for the Debian GNU/Linux system.  Adam Di Carlo
       <aphATdebian.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-docATlists.org>.



doc-base v0.7.18-0.1              2005-05-12                   INSTALL-DOCS(8)