.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "INSTALL-DOCS 8" .TH INSTALL-DOCS 8 "21 January 2024" "doc-base v0.11.2" Debian .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME install\-docs \- manage online Debian documentation .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& install\-docs [options] \-i,\-\-install | \-r,\-\-remove | \-c,\-\-check file [ file ... ] \& \& install\-docs [options] \-I,\-\-install\-all | \-C,\-\-install\-changed | \-R,\-\-remove\-all \& \& install\-docs [options] \-s,\-\-status docid [ docid ... ] \& \& install\-docs [options] \-\-dump\-db dbname \& \& install\-docs \-h,\-\-help | \-V,\-\-version .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" \&\fBinstall-docs\fR is a tool allow Debian package maintainers to register documentation to various documentation systems. It currently supports \&\fBdhelp\fR, \fBdwww\fR, \fBdochelp\fR, and \fBdoc-central\fR browsers. .PP This manual page provides a quick synopsis of \fBinstall-docs\fR usage. Full documentation can be found in the documentation, including a description of the control file syntax and grammar. .SH OPTIONS .IX Header "OPTIONS" .IP "\fB\-v\fR, \fB\-\-verbose\fR" 4 .IX Item "-v, --verbose" Operate verbosely. .IP "\fB\-d\fR, \fB\-\-debug\fR" 4 .IX Item "-d, --debug" Print some debugging information. .IP \fB\-\-no\-update\-menus\fR 4 .IX Item "--no-update-menus" Inhibit running \fBdwww\-build\-menu\fR\|(8), and \fBdhelp_parse\fR\|(8). .IP "\fB\-\-rootdir\fR \fIdir\fR" 4 .IX Item "--rootdir dir" Set the root directory to \fIdir\fR instead of `\fI/\fR'. Useful and valid only with the \fB\-\-check\fR action. .SH ACTIONS .IX Header "ACTIONS" Below is list of possible actions \fBinstall-docs\fR could handle. There can be only one action option passed to install-docs, moreover the action with its arguments must be the last option passed. .PP Each \fIfile\fR argument should be the full path for the doc-base control file (i.e. `/usr/share/doc\-base/some_file' or `/etc/doc\-base/documents/some_file'), and each \&\fIdocid\fR should be the document identifier (Document identifiers are set in the `Document' field of the control file, and usually correspond to the package name.) .PP If \fIfile\fR or \fIdocid\fR equals `\fB\-\fR' (the minus sign), the list of arguments is read from the standard input (each file name or document id in separate line). .IP "\fB\-i\fR \fIfile\fR [\fIfile\fR ...], \fB\-\-install\fR \fIfile\fR [\fIfile\fR ...]" 4 .IX Item "-i file [file ...], --install file [file ...]" Install the documentation described by the control file \fIfile\fR. .IP "\fB\-r\fR \fIfile\fR [\fIfile\fR ...], \fB\-\-remove\fR \fIfile\fR [\fIfile\fR ...]" 4 .IX Item "-r file [file ...], --remove file [file ...]" Remove the documentation identified by the control file \&\fIfile\fR. .IP "\fB\-c\fR \fIfile\fR [\fIfile\fR ...], \fB\-\-check\fR \fIfile\fR [\fIfile\fR ...]" 4 .IX Item "-c file [file ...], --check file [file ...]" Check the control file \fIfile\fR and display number of possible problems found. Use with \fI\-\-verbose\fR to get the actual locations of errors and warnings. If \fI\-\-rootdir\fR was also given, its argument will be prepended to names of the files given if the `Files' and `Index' fields of the \fIfile\fR. .IP "\fB\-R\fR, \fB\-\-remove\-all\fR" 4 .IX Item "-R, --remove-all" De-register all registered documents. .IP "\fB\-I\fR, \fB\-\-install\-all\fR" 4 .IX Item "-I, --install-all" (Re)register all documents from \fI/usr/share/doc\-base\fR and \fI/etc/doc\-base/documents\fR. .IP "\fB\-C\fR, \fB\-\-install\-changed\fR" 4 .IX Item "-C, --install-changed" Compare contents of \fI/usr/share/doc\-base\fR and \fI/etc/doc\-base/documents\fR directories with registered documents database and de-register any files that are missing and (re)register only changed or new files. .IP "\fB\-s\fR \fIdocid\fR [\fIdocid\fR ...], \fB\-\-status\fR \fIdocid\fR [\fIdocid\fR ...]" 4 .IX Item "-s docid [docid ...], --status docid [docid ...]" Display the status of the document identifier \fIdocid\fR. .IP "\fB\-L\fR \fIdocid\fR [\fIdocid\fR ...], \fB\-\-listfiles\fR \fIdocid\fR [\fIdocid\fR ...]" 4 .IX Item "-L docid [docid ...], --listfiles docid [docid ...]" Deprecated option. Does nothing. .IP "\fB\-\-dump\-db\fR \fIdbname\fR" 4 .IX Item "--dump-db dbname" Dumps contents of internal databases, for debugging purposes. \fIdbname\fR can be either \fBfiles.db\fR or \&\fBstatus.db\fR. .IP "\fB\-h\fR, \fB\-\-help\fR" 4 .IX Item "-h, --help" Show a short help message. .IP "\fB\-V\fR, \fB\-\-version\fR" 4 .IX Item "-V, --version" Display version information. .SH "COMPATIBILITY ISSUES" .IX Header "COMPATIBILITY ISSUES" The following features were added in version 0.8.4, please make sure to add proper `\fIConflicts\fR' or `\fIDepends\fR' lines if you would like to use them in your package's scripts: .IP \(bu 4 support for passing more than one argument to the \fB\-i\fR and \fB\-r\fR actions, .IP \(bu 4 reading arguments from the standard input, .IP \(bu 4 \&\fB\-I\fR,\fB\-\-install\-all\fR, \fB\-R\fR, \fB\-\-\-remove\-all\fR, \fB\-c\fR, \fB\-\-check\fR actions, .IP \(bu 4 \&\fB\-d\fR, \fB\-\-debug\fR, \fB\-h\fR, \fB\-\-help\fR options. .PP The \fB\-C\fR, \fB\-\-install\-changed\fR, \fB\-\-dump\-db\fR, \fB\-V\fR, \fB\-\-version\fR options were added in 0.8.12. .SH FILES .IX Header "FILES" .IP \fI/usr/share/doc\-base/\fR 4 .IX Item "/usr/share/doc-base/" The location of doc-base control files provided by various packages. .IP \fI/etc/doc\-base/documents/\fR 4 .IX Item "/etc/doc-base/documents/" The location of doc-base control files provided by local administrator. .IP \fI/var/lib/doc\-base/info/documents/\fR 4 .IX Item "/var/lib/doc-base/info/documents/" The location of registered control files. .IP \fI/var/lib/doc\-base/info/status.db\fR 4 .IX Item "/var/lib/doc-base/info/status.db" Statuses of registered documents. .IP \fI/var/lib/doc\-base/info/files.db\fR 4 .IX Item "/var/lib/doc-base/info/files.db" Timestamps and documents ids of registered doc-base files. .SH BUGS .IX Header "BUGS" See . .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBdhelp\fR\|(1), \fBdoccentral\fR\|(1), \fBdochelp\fR\|(1), \fBdwww\fR\|(7), Debian doc-base Manual \fI/usr/share/doc/doc\-base/doc\-base.html/index.html\fR .SH AUTHOR .IX Header "AUTHOR" This program was originally written by Christian Schwarz , for the Debian GNU/Linux system, and the next maintainer was Adam Di Carlo . Robert Luberda is currently maintaining and extending it. .PP 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 .