2 .\" # Copyright (c) 2015, Juniper Networks, Inc.
3 .\" # All rights reserved.
4 .\" # This SOFTWARE is licensed under the LICENSE provided in the
5 .\" # ../Copyright file. By downloading, installing, copying, or
6 .\" # using the SOFTWARE, you agree to be bound by the terms of that
8 .\" # Phil Shafer, July 2014
15 .Nd display libxo html output
23 .Op Ar command [argument ...]
26 is a tool for preparing
28 HTML output for display in modern HTML web browsers.
30 can operate in two modes.
31 If command is provided
34 option or as argument(s) to the
36 command, that command is executed and the resulting output is processed.
37 If no command is given, the
38 standard input is used.
41 is typically used to wrap
43 output with sufficient HTML content to allow display in a web browser.
44 This includes parent HTML tags as well as
50 If the command is given directly on the command line,
52 will add the "--libxo=html" option needed to generate HTML output
59 The following options are available:
60 .Bl -tag -width indent
61 .It Ic -b Ar base | Ic --base Ar base
62 Supplies a source path for the CSS and Javascript files referenced in
65 .It Ic -c Ar command | Ic --command Ar command
66 Use the given command instead of one on the command line.
67 This command should be quoted if it consists of multiple tokens, and
68 should contain the "--libxo=html" option or equivalent, since the
69 command is used directly.
70 .It Ic -f Ar file | Ic --file Ar file
71 Output is saved to the given file, rather than to the standard output
76 website URL as the source path for the CSS and Javascript files
77 referenced in the output of
82 The following command line will run "du --libxo=html ~/src" and save
83 the output to /tmp/src.html:
84 .Bd -literal -offset indent
85 xohtml du ~/src > /tmp/src.html
88 The following command line will run "du --libxo=html,warn ~/src" and save
89 the output to /tmp/src.html:
90 .Bd -literal -offset indent
91 du --libxo=html,warn ~/src | xohtml -f /tmp/src.html
94 The following command line will run "du --libxo=html,warn ~/src" and save
95 the output to /tmp/src.html:
96 .Bd -literal -offset indent
97 xohtml -c "du --libxo=html,warn ~/src" -f /tmp/src.html