diff options
Diffstat (limited to 'doc/options.rst')
| -rw-r--r-- | doc/options.rst | 102 |
1 files changed, 51 insertions, 51 deletions
diff --git a/doc/options.rst b/doc/options.rst index 9219037dcd37..bd0fa565e281 100644 --- a/doc/options.rst +++ b/doc/options.rst @@ -33,36 +33,36 @@ Option Keywords Options is a comma-separated list of tokens that correspond to output styles, flags, or features: -=============== ======================================================= -Token Action -=============== ======================================================= -color Enable colors/effects for display styles (TEXT, HTML) -colors=xxxx Adjust color output values -dtrt Enable "Do The Right Thing" mode -flush Flush after every libxo function call -flush-line Flush after every line (line-buffered) -html Emit HTML output -indent=xx Set the indentation level -info Add info attributes (HTML) -json Emit JSON output -keys Emit the key attribute for keys (XML) -log-gettext Log (via stderr) each gettext(3) string lookup -log-syslog Log (via stderr) each syslog message (via xo_syslog) -no-humanize Ignore the {h:} modifier (TEXT, HTML) -no-locale Do not initialize the locale setting -no-retain Prevent retaining formatting information -no-top Do not emit a top set of braces (JSON) -not-first Pretend the 1st output item was not 1st (JSON) -pretty Emit pretty-printed output -retain Force retaining formatting information -text Emit TEXT output -underscores Replace XML-friendly "-"s with JSON friendly "_"s -units Add the 'units' (XML) or 'data-units (HTML) attribute -warn Emit warnings when libxo detects bad calls -warn-xml Emit warnings in XML -xml Emit XML output -xpath Add XPath expressions (HTML) -=============== ======================================================= + =============== ======================================================= + Token Action + =============== ======================================================= + color Enable colors/effects for display styles (TEXT, HTML) + colors=xxxx Adjust color output values + dtrt Enable "Do The Right Thing" mode + flush Flush after every libxo function call + flush-line Flush after every line (line-buffered) + html Emit HTML output + indent=xx Set the indentation level + info Add info attributes (HTML) + json Emit JSON output + keys Emit the key attribute for keys (XML) + log-gettext Log (via stderr) each gettext(3) string lookup + log-syslog Log (via stderr) each syslog message (via xo_syslog) + no-humanize Ignore the {h:} modifier (TEXT, HTML) + no-locale Do not initialize the locale setting + no-retain Prevent retaining formatting information + no-top Do not emit a top set of braces (JSON) + not-first Pretend the 1st output item was not 1st (JSON) + pretty Emit pretty-printed output + retain Force retaining formatting information + text Emit TEXT output + underscores Replace XML-friendly "-"s with JSON friendly "_"s + units Add the 'units' (XML) or 'data-units (HTML) attribute + warn Emit warnings when libxo detects bad calls + warn-xml Emit warnings in XML + xml Emit XML output + xpath Add XPath expressions (HTML) + =============== ======================================================= Most of these option are simple and direct, but some require additional details: @@ -94,25 +94,25 @@ Brief Options The brief options are simple single-letter aliases to the normal keywords, as detailed below: -======== ============================================= - Option Action -======== ============================================= - c Enable color/effects for TEXT/HTML - F Force line-buffered flushing - H Enable HTML output (XO_STYLE_HTML) - I Enable info output (XOF_INFO) - i<num> Indent by <number> - J Enable JSON output (XO_STYLE_JSON) - k Add keys to XPATH expressions in HTML - n Disable humanization (TEXT, HTML) - P Enable pretty-printed output (XOF_PRETTY) - T Enable text output (XO_STYLE_TEXT) - U Add units to HTML output - u Change "-"s to "_"s in element names (JSON) - W Enable warnings (XOF_WARN) - X Enable XML output (XO_STYLE_XML) - x Enable XPath data (XOF_XPATH) -======== ============================================= + ======== ============================================= + Option Action + ======== ============================================= + c Enable color/effects for TEXT/HTML + F Force line-buffered flushing + H Enable HTML output (XO_STYLE_HTML) + I Enable info output (XOF_INFO) + i<num> Indent by <number> + J Enable JSON output (XO_STYLE_JSON) + k Add keys to XPATH expressions in HTML + n Disable humanization (TEXT, HTML) + P Enable pretty-printed output (XOF_PRETTY) + T Enable text output (XO_STYLE_TEXT) + U Add units to HTML output + u Change "-"s to "_"s in element names (JSON) + W Enable warnings (XOF_WARN) + X Enable XML output (XO_STYLE_XML) + x Enable XPath data (XOF_XPATH) + ======== ============================================= .. index:: Colors @@ -145,7 +145,7 @@ For example consider the following xo_emit call:: xo_emit("{C:fg-red,bg-green}Merry XMas!!{C:}\n"); To turn all colored output to red-on-blue, use eight pairs of -"red/blue" mappings separated by "+"s:: +"red/blue" mappings separated by plus signs ("+"):: --libxo colors=red/blue+red/blue+red/blue+red/blue+\ red/blue+red/blue+red/blue+red/blue @@ -159,6 +159,6 @@ to green (the third mapping):: Consider the common situation where blue output looks unreadable on a terminal session with a black background. To turn both "blue" foreground and background output to "yellow", give only the fifth -mapping, skipping the first four mappings with bare "+"s:: +mapping, skipping the first four mappings with bare plus signs ("+"):: --libxo colors=++++yellow/yellow |