Whole document tree

Debian doc-base Manual
Chapter 3 - Getting information about installed documents

If you want to get information about the status of an installed manual, you can use the `-s' or `--status' option of install-docs followed by the document id:

     $ install-docs -s foo
     ---document-information---
     Document: foo
     Abstract: This manual is about foos, bars, and Debian.
     Author: Wile E. Coyote
     Section: debian
     Title: Debian Foo's Manual
     
     ---format-description---
     Format: debiandoc-sgml
     Files: /usr/doc/foo/sgml/foo.sgml.gz
     
     ---format-description---
     Format: html
     Files: /usr/doc/foo/html-sgml/*.html
     Index: /usr/doc/foo/html-sgml/index.html
     
     ---status-information---
     Control-File: ../foo-0.0/foo.desc
     Registered-to-dhelp: 1
     Registered-to-dwww: 1

In some cases, doc-base creates files when installing a document. For example, when a document is registered to dhelp a file `.dhelp' is generated. You can check out which files have been created by doc-base with the `-L' or `--listfiles' options followed by the document id. Here is an example:

     $ install-docs -L foo
     /usr/doc/foo/html-sgml/.dhelp
     /usr/lib/menu/doc-base-foo

Debian doc-base Manual