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