xref: /freebsd/contrib/libxo/doc/xohtml.rst (revision bdd1243df58e60e85101c09001d9812a789b6bc4)
1.. index:: xohtml
2
3.. _xohtml:
4
5xohtml
6======
7
8`xohtml` is a tool for turning the output of libxo-enabled commands into
9html files suitable for display in modern HTML web browsers.  It can
10be used to test and debug HTML output, as well as to make the user
11ache to escape the world of '70s terminal devices.
12
13`xohtml` is given a command, either on the command line or via the "-c"
14option.  If not command is given, standard input is used.  The
15command's output is wrapped in HTML tags, with references to
16supporting CSS and Javascript files, and written to standard output or
17the file given in the "-f" option.  The "-b" option can be used to
18provide an alternative base path for the support files:
19
20  ============== ===================================================
21   Option         Meaning
22  ============== ===================================================
23   -b <base>      Base path for finding css/javascript files
24   -c <command>   Command to execute
25   -f <file>      Output file name
26  ============== ===================================================
27
28The "-c" option takes a full command with arguments, including
29any libxo options needed to generate html (`--libxo=html`).  This
30value must be quoted if it consists of multiple tokens.
31