[ 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-Files: /usr/share/doc-base/foo (changed: Tue Apr  8 23:09:24 2008)
     Scrollkeeper-omf-file: /var/lib/doc-base/omf/foo/foo-C.omf
     Scrollkeeper-sid: 99999999-0000-8888-0000-1234567890ab

doc-base always creates a /var/lib/doc-base/documents/<document-id> file when installing a document.

When a document is registered to scrollkeeper, doc-base will create `*-C.omf' file under the /var/lib/doc-base/omf directory. Name of the generated file is recorded in the Scrollkeeper-omf-file field. Lack of the field means the documents was not registered to the package.

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

Debian doc-base Manual