[ previous ] [ Contents ] [ 1 ] [ 2 ] [ 3 ] [ 4 ] [ next ]

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/share/doc/foo/sgml/foo.sgml.gz
     
     ---format-description---
     Format: html
     Files: /usr/share/doc/foo/html-sgml/*.html
     Index: /usr/share/doc/foo/html-sgml/index.html
     
     ---status-information---
     Control-File: /usr/share/doc-base/foo
     Dhelp-file: /usr/share/doc/foo/.dhelp
     Scrollkeeper-omf-file: /var/lib/doc-base/omf/foo/foo-C.omf
     Scrollkeeper-sid: 99999999-0000-8888-0000-1234567890ab

In some cases, doc-base creates files when installing a document. When a document is registered to dhelp a file `.dhelp' is generated, whereas for scrollkeeper package `*-C.omf' is needed. Names of the generated files are recorded in the Dhelp-file and Scrollkeeper-omf-file fields. Lack of any of the fields means the documents was not registered to appropriate package.

[ previous ] [ Contents ] [ 1 ] [ 2 ] [ 3 ] [ 4 ] [ next ]

Debian doc-base Manual