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 c 20.Op Fl "b <base>" 21.Op Fl "c" <command>" 22.Op Fl "f" <output> 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 libxo 3 57for details. 58.Pp 59The following options are available: 60.Bl -tag -width indent 61.It Fl "b <base>" 62.It Fl "-base <base>" 63Supplies a source path for the CSS and Javascript files referenced in 64the output of 65.Nm xohtml . 66.It Fl "c <command>" 67.It Fl "-command <command>" 68Use the given command instead of one on the command line. 69This command should be quoted if it consists of multiple tokens, and 70should contain the "--libxo=html" option or equivalent, since the 71command is used directly. 72.It Fl "f <file>" 73.It Fl "-file <file>" 74Output is saved to the given file, rather than to the standard output 75descriptor. 76.El 77.Pp 78.Sh EXAMPLES 79The following command line will run "du --libxo=html ~/src" and save 80the output to /tmp/src.html: 81.Bd -literal -offset indent 82 xohtml du ~/src > /tmp/src.html 83.Ed 84.Pp 85The following command line will run "du --libxo=html,warn ~/src" and save 86the output to /tmp/src.html: 87.Bd -literal -offset indent 88 du --libxo=html,warn ~/src | xohtml -f /tmp/src.html 89.Ed 90.Pp 91The following command line will run "du --libxo=html,warn ~/src" and save 92the output to /tmp/src.html: 93.Bd -literal -offset indent 94 xohtml -c "du --libxo=html,warn ~/src" -f /tmp/src.html 95.Ed 96.Pp 97.Sh ADDITIONAL DOCUMENTATION 98Complete documentation can be found on github: 99.Bd -literal -offset indent 100http://juniper.github.io/libxo/libxo-manual.html 101.Ed 102.Pp 103.Nm libxo 104lives on github as: 105.Bd -literal -offset indent 106https://github.com/Juniper/libxo 107.Ed 108.Pp 109The latest release of 110.Nm libxo 111is available at: 112.Bd -literal -offset indent 113https://github.com/Juniper/libxo/releases 114.Ed 115.Sh SEE ALSO 116.Xr libxo 3 , 117.Xr xo_emit 3 118.Sh HISTORY 119The 120.Nm libxo 121library was added in 122.Fx 11.0 . 123.Sh AUTHOR 124Phil Shafer 125 126