#
 # Copyright (c) 2015, Juniper Networks, Inc.
 # All rights reserved.
 # This SOFTWARE is licensed under the LICENSE provided in the
 # ../Copyright file. By downloading, installing, copying, or 
 # using the SOFTWARE, you agree to be bound by the terms of that
 # LICENSE.
 # Phil Shafer, July 2014
 
.Dd December 4, 2014
.Dt XOHTML 1
.Os
.Sh NAME
.Nm xohtml
.Nd display libxo html output
.Xr xo_emit 3
.Sh SYNOPSIS
.Nm xohtml
.Op Fl c
.Op Fl "b <base>"
.Op Fl "c" <command>"
.Op Fl "f" <output>
.Op Ar command argument...
.Sh DESCRIPTION
.Nm
is a tool for preparing
.Xr libxo 3
HTML output for display in modern HTML web browsers.
.Nm
can operate in two modes.
If command is provided
either with the
.Fl c
option or as argument(s) to the
.Nm
command, that command is executed and the resulting output is processed.
If no command is given, the
standard input is used.

p
.Nm
is typically used to wrap
.Nm libxo
output with sufficient HTML content to allow display in a web browser.
This includes parent HTML tags as well as
.Nm CSS
stylesheets and
.Nm Javascript
files.

p
If the command is given directly on the command line,
.Nm
will add the "--libxo=html" option needed to generate HTML output
from
.Nm libxo "-enabled"
applications. See
.Xr libxo 3
for details.

p
The following options are available:
l -tag -width indent t Fl "b <base>" t Fl "-base <base>" Supplies a source path for the CSS and Javascript files referenced in
the output of
.Nm xohtml .
t Fl "c <command>" t Fl "-command <command>" Use the given command instead of one on the command line.
This command should be quoted if it consists of multiple tokens, and
should contain the "--libxo=html" option or equivalent, since the
command is used directly.
t Fl "f <file>" t Fl "-file <file>" Output is saved to the given file, rather than to the standard output
descriptor.
.El

p
.Sh EXAMPLES
The following command line will run "du --libxo=html ~/src" and save
the output to /tmp/src.html:
d -literal -offset indent  xohtml du ~/src > /tmp/src.html
.Ed

p
The following command line will run "du --libxo=html,warn ~/src" and save
the output to /tmp/src.html:
d -literal -offset indent  du --libxo=html,warn ~/src | xohtml -f /tmp/src.html
.Ed

p
The following command line will run "du --libxo=html,warn ~/src" and save
the output to /tmp/src.html:
d -literal -offset indent  xohtml -c "du --libxo=html,warn ~/src" -f /tmp/src.html
.Ed

p
.Sh SEE ALSO
.Xr libxo 3 ,
.Xr xo_emit 3