1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
.\" #
.\" # 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.
.Pp
.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.
.Pp
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.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl "b <base>"
.It Fl "-base <base>"
Supplies a source path for the CSS and Javascript files referenced in
the output of
.Nm xohtml .
.It Fl "c <command>"
.It 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.
.It Fl "f <file>"
.It Fl "-file <file>"
Output is saved to the given file, rather than to the standard output
descriptor.
.El
.Pp
.Sh EXAMPLES
The following command line will run "du --libxo=html ~/src" and save
the output to /tmp/src.html:
.Bd -literal -offset indent
xohtml du ~/src > /tmp/src.html
.Ed
.Pp
The following command line will run "du --libxo=html,warn ~/src" and save
the output to /tmp/src.html:
.Bd -literal -offset indent
du --libxo=html,warn ~/src | xohtml -f /tmp/src.html
.Ed
.Pp
The following command line will run "du --libxo=html,warn ~/src" and save
the output to /tmp/src.html:
.Bd -literal -offset indent
xohtml -c "du --libxo=html,warn ~/src" -f /tmp/src.html
.Ed
.Pp
.Sh ADDITIONAL DOCUMENTATION
Complete documentation can be found on github:
.Bd -literal -offset indent
http://juniper.github.io/libxo/libxo-manual.html
.Ed
.Pp
.Nm libxo
lives on github as:
.Bd -literal -offset indent
https://github.com/Juniper/libxo
.Ed
.Pp
The latest release of
.Nm libxo
is available at:
.Bd -literal -offset indent
https://github.com/Juniper/libxo/releases
.Ed
.Sh SEE ALSO
.Xr libxo 3 ,
.Xr xo_emit 3
.Sh HISTORY
The
.Nm libxo
library was added in
.Fx 11.0 .
.Sh AUTHOR
Phil Shafer
|
