odoctool - Online Docs utility
odoctool [-D|--debug] [-V|--version] [-h|--help] [--log <FILE>] odoctool createbundle [-d <DIR>|--destdir <DIR>] [--keep] \ [--overwrite] /path/to/bundlespec odoctool listtargets [-d <NUMBER>|--depth <NUMBER>] <bundle_id> odoctool <subcommand> -h|--help
The odoctool command is a multi-purpose utility for working with Online Documentation bundles, most notably for generating bundles according to the given odoc-bundle bundlespec file. For more information, see the odoc-bundle(5) man page.
Using the odoctool command, you can perform the following tasks:
Generate a new bundle.
List available link targets for document authors.
The odoctool command has the subcommands and their options listed below.
Displays available general options and their meanings, as well as list of available subcommands.
Following options might be used in combination with subcommand:
Outputs verbose "debug" messages.
Prints program version and exit.
Logs output messages into given file instead of STDOUT/STDERR.
Prints short usage help and exit.
Reads given bundlespec file and converts contained sources into a bundle in current working directory or optionally given –-destdir. If bundlespec file is not valid or sources cannot be converted cleanly, errors are reported on STDERR.
Directory to put bundle in to (default is current $PWD).
Keeps temporary files after failure.
Overwrites existing bundle directory.
Lists link targets which can be printed from the olink XML Docbook element. Lists elements in an installed bundle if bundle_id is specified, otherwise list IDs of all installed bundles. If depth option is specified, lists the number of target levels. Otherwise lists the top level only.
The following command creates a bundle in the current working directory using the bundlespec my.bundlespec:
example% odoctool createbundle -d . my.bundlespecExample 2 Creating a Bundle, Overwrite Existing
The following command creates a bundle in the current working directory using the bundlespec my.bundlespec. If such bundle already exists, it is overwritten:
example% odoctool createbundle --overwrite -d . my.bundlespecExample 3 Listing Installed Bundles
The following command lists bundles that are installed on the system and links can therefore point to targets in them:
example% odoctool listtargetsExample 4 Listing Targets in a Bundle
The following command lists link targets in the bundle mybundle that is installed on the system:
example% odoctool listtargets mybundleExample 5 Listing Three Levels of Targets in a Bundle
The following command lists three levels of link targets in the bundle mybundle that is installed on the system:
example% odoctool listtargets -d 3 mybundle
Failure. Errors reported on STDERR.
See attributes(7) for descriptions of the following attributes: