Created
November 21, 2017 03:31
-
-
Save grahamc/62b7b1370659ad94aa5643d01151bd38 to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
[1] grahamc@Morbo> ./result/bin/daps ~/projects | |
Usage: | |
1. daps -d DC-file [--options] <subcommand> [--subcommand-options] | |
2. daps -m MAIN file [--options] <subcommand> [--subcommand-options] | |
Global Options: | |
--builddir=BUILD_DIR Directory where every output daps generates will | |
end up. | |
Default: <doc dir>/build/ | |
--color=(0|1) By default errors, results, warnings and certain | |
info messages are printed in color using bash color | |
codes. Set to '0' to turn off colors. | |
Default: 1 (when the output does not go to a | |
terminal, colored output will be | |
disabled automatically) | |
--commands Show a list of available DAPS sub commands | |
--debug Print debugging messages. Alternatively see the | |
verbosity options for an output that is better | |
readable. | |
--docconfig=DC-file, | |
-d DC-file Path to doc config file to use. Mandatory, | |
unless there is only a single DC-file in the | |
current directory or unless you have configured a | |
default value (DOCCONF_DEFAULT) in /home/grahamc/.config/daps/dapsrc. | |
Note: Options --docconfig and --main exclude | |
each other. | |
--fb_styleroot Fallback styleroot directories. Can only be used in | |
conjunction with --styleroot. By default, the | |
DocBook stylesheets are used as a fallback if | |
custom styles for an output format are not present. | |
With this option you can specify a list of | |
alternative fallbacks (space separated absolute | |
paths). The directories will be tested in the order | |
specified, the first one that applies to the | |
requested format, will be used. The original | |
DocBook stylesheets will be used as a last resort. | |
Useful if you have forks of your custom | |
stylesheets. | |
--force Force a rebuild of the document even when an | |
up-to-date version exists. | |
--help, -h Help | |
--jobs Specify how many parallel jobs to use. Higher | |
numbers will significantly increase the processing | |
speed, but will also set your machine under heavy | |
load, up to a point where it may become | |
(temporarily) unresponsive. | |
Default: Use as man jobs as available CPU cores. | |
--main, -m Path to the main file defining your document. | |
Note: Options --main and --docconfig exclude | |
each other. | |
--schema URN to a DocBook 5 schema that is to be used for | |
validation. Will be ignored when validating | |
DocBook 4 documents. | |
Note: To validate with a local schema, specify an | |
absolute path with a "file://" prefix | |
(e.g. "file:///foo/schema.rnc"). | |
--styleroot By default, daps uses the DocBook Stylesheets to | |
create output. If you have your own set of | |
stylesheets, specify the absolute path to the | |
stylesheet directory here. The DocBook stylesheets | |
will be used as a fallback in case styles are not | |
defined for all output formats. | |
--verbosity=0, -v0 Verbosity Level 0 (print 1 line of results) | |
--verbosity=1, -v1, -v Verbosity Level 1 (print intermediate results) | |
--verbosity=2, -v2, -vv Verbosity Level 2 (print all files created) | |
--verbosity=3, -v3, -vvv Verbosity Level 3 (print all commands, very | |
verbose) | |
--version Print version number | |
--xsltprocessor=PROCESSOR Specify an xslt processor that is used to transorm | |
the XML files. Currently supported are "xsltproc" | |
and "saxon" (version 6). | |
Default: xsltproc | |
Subcommands: | |
help Print this help. | |
Generate Books: | |
epub ePUB book | |
html HTML book (chunked or single file HTML, jsp) | |
man man pages | |
mobi Amazon Kindle eBook | |
pdf PDF book (color, grayscale, printable) | |
text ASCII book | |
webhelp HTML book with collapsable TOC and search | |
File lists: | |
list-file Lists the filename that contains the ID specified | |
with the mandatory parameter --rootid. | |
list-srcfiles List source files (XML sources, images, entity | |
declarations, DC-file) used by the document | |
reference by the DC-file. | |
list-srcfiles-unused List files from the xml/ and images/src/ | |
directories not used by the document reference | |
by the DC-file. | |
list-images-missing List images referenced in the XML sources but | |
missing in the images' source directory. | |
list-images-multisrc List images for which mutiple sources exist | |
(e.g. foo.svg and foo.png). | |
Cleaning up: | |
clean Remove all profiled sources and temporary files. | |
clean-images Remove all generated images. | |
clean-package Remove all generated package data for the given | |
DC-file. Generated images and profiled sources | |
will _not_ be deleted. | |
clean-results Remove all generated books, archives, and log | |
files for the given DC-file. Generated images | |
and profiled sources will _not_ be deleted. | |
clean-all, real-clean Remove everything generated by daps. | |
Packaging: | |
package-html Provide an HTML tarball (chunked HTML, | |
single HTML, or JSP), desktop, document, | |
and/or page files (for KDE and GNOME). | |
package-pdf Provide a PDF, desktop, document, and/or | |
page files (for KDE and GNOME). | |
package-src Provide profiled XML sources and graphics | |
Deploying: | |
locdrop Provide everything that is needed to translate a | |
set. | |
online-docs Provide a profiled XML bigfile, a graphics | |
tarball (PNG only), color-pdf, epub, and | |
a single-html archive. | |
unpack-locdrop Unpack a localization drop packages source. | |
Other Commands: | |
checklink Linkchecker for links from <ulink> tags | |
getimages List or display images from a profiled DocBook | |
XML file. | |
optipng Optimize (size) source PNGs. | |
profile Profile XML sources. | |
spellcheck Spellchecks the file specified with --file or the | |
document specified by rootid. | |
stylecheck Performs a style check on the given DC-file or | |
rootid. | |
validate Validate profiled sources. Automatically profiles | |
the XML sources if needed. | |
xmlformat Prettify the XML source files using | |
daps-xmlformat. | |
File and Directory Names: | |
<target>-name Print resulting file name for <target>. <target> | |
may be one of color-pdf, epub, html-single, | |
pdf, txt. | |
<target>-dir-name Print resulting directory name for <target>. | |
<target> may be html, man or webhelp. | |
Debugging: | |
bigfile Creates a single "big" XML file by resolving | |
xi:includes. Useful for detecting validation | |
errors that cannot be found otherwise. | |
dapsenv Print a list of the most important make variables | |
and their value. | |
images Generates all images for the given DC-file or | |
rootid. | |
showvariable Print value of a given make variable: | |
daps showvariable VARIABLE=<MAKE_VARIABLE>. | |
Type 'daps <subcommand> -h' for help on a specific subcommand. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment