update-yorickdoc(1) Build HTML documentation for Yorick


--auto | -a
This flag is being deprecated by the advent of triggers in dpkg. On systems where dpkg supports triggers, -a turns update-yorickdoc into a no-op. On older systems, it behaves like -A below.
| -A
This flag is meant to be used only in the postinst script of the yorick-doc package, which is turn is supposed to be triggered each time a yorick add-on package is installed, upgraded, or removed. It is possible to turn update-yorickdoc into a no-op when this flag is set by setting ENABLE_AUTO to 0 in /etc/yorick-doc.
Read configuration from this file. This file is parsed as the option is found on the command line, overwriting the options coming before.
Colon-separated list of directories to scan for Yorick files. Default: /usr/share/yorick/i:/usr/share/yorick/i0.
--purge | -p
Only delete /usr/share/doc/yorick-doc/html_xref (or the directory set using --to and --xref-dir, or the equivalent variables in /etc/yorick-doc), do not rebuild the documentation afterwards.
| -q
Be quiet, only telling shortly what update-yorickdoc does. This is the built-in default but may have been overridden in a configuration file.
Directory containing .packinfo, .keywords and .aliases files when building the documentation. Each of these three types of files will be concatenated in lexicographical order and fed to htmldoc.i using the --packinfo, --keywords, and --aliases options (see htmldoc.i). Default: /usr/share/yorick-doc.
Template file for htmldoc.i. The correct format is detailed htmldoc.i. Default: /usr/share/yorick-doc/template.html.
Top-level directory of the Yorick HTML hierarchy to update. This is one level above the directory that will be deleted and/or (re)built. Defaults to /usr/share/doc/yorick-doc.
--verbose | -v
Be verbose, outputting lots of debugging information. The built-in default is to be quiet, just telling shortly what update-yorickdoc does.
The sub-directory of the "TO" directory in which to compile the documentation. Certain hyperlinks in the documentation will use this value. This should not be set to a directory whose content you value, since this directory will be first erased. Default: html_xref.