1.\" # 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 7.\" # LICENSE. 8.\" # Phil Shafer, July 2014 9.\" 10.Dd December 4, 2014 11.Dt XOHTML 1 12.Os 13.Sh NAME 14.Nm xohtml 15.Nd display libxo html output 16.Xr xo_emit 3 17.Sh SYNOPSIS 18.Nm xohtml 19.Op Fl "b <base>" 20.Op Fl "c" <command>" 21.Op Fl "f" <output> 22.Op Fl "w" 23.Op Ar command [argument ...] 24.Sh DESCRIPTION 25.Nm 26is a tool for preparing 27.Xr libxo 3 28HTML output for display in modern HTML web browsers. 29.Nm 30can operate in two modes. 31If command is provided 32either with the 33.Fl c 34option or as argument(s) to the 35.Nm 36command, that command is executed and the resulting output is processed. 37If no command is given, the 38standard input is used. 39.Pp 40.Nm 41is typically used to wrap 42.Nm libxo 43output with sufficient HTML content to allow display in a web browser. 44This includes parent HTML tags as well as 45.Nm CSS 46stylesheets and 47.Nm Javascript 48files. 49.Pp 50If the command is given directly on the command line, 51.Nm 52will add the "--libxo=html" option needed to generate HTML output 53from 54.Nm libxo "-enabled" 55applications. See 56.Xr xo_options 7 57for details. 58.Pp 59The following options are available: 60.Bl -tag -width indent 61.It Ic -b Ar base | Ic --base Ar base 62Supplies a source path for the CSS and Javascript files referenced in 63the output of 64.Nm xohtml . 65.It Ic -c Ar command | Ic --command Ar command 66Use the given command instead of one on the command line. 67This command should be quoted if it consists of multiple tokens, and 68should contain the "--libxo=html" option or equivalent, since the 69command is used directly. 70.It Ic -f Ar file | Ic --file Ar file 71Output is saved to the given file, rather than to the standard output 72descriptor. 73.It Ic -w | --web 74Uses the official 75.Nm libxo 76website URL as the source path for the CSS and Javascript files 77referenced in the output of 78.Nm xohtml . 79.El 80.Pp 81.Sh EXAMPLES 82The following command line will run "du --libxo=html ~/src" and save 83the output to /tmp/src.html: 84.Bd -literal -offset indent 85 xohtml du ~/src > /tmp/src.html 86.Ed 87.Pp 88The following command line will run "du --libxo=html,warn ~/src" and save 89the output to /tmp/src.html: 90.Bd -literal -offset indent 91 du --libxo=html,warn ~/src | xohtml -f /tmp/src.html 92.Ed 93.Pp 94The following command line will run "du --libxo=html,warn ~/src" and save 95the output to /tmp/src.html: 96.Bd -literal -offset indent 97 xohtml -c "du --libxo=html,warn ~/src" -f /tmp/src.html 98.Ed 99.Pp 100.Sh SEE ALSO 101.Xr libxo 3 , 102.Xr xo_emit 3 , 103.Xr xo_options 7 104