mirror of
https://git.FreeBSD.org/src.git
synced 2024-12-18 10:35:55 +00:00
76afb20c58
- move from "oxtradoc" to RST/Sphinx documentation - new "csv" encoder, which allows path and leaf lists - address warnings from PVS-Stdio tool - add "xolint" detected errors to the documentation
68 lines
1.9 KiB
Markdown
68 lines
1.9 KiB
Markdown
libxo
|
|
=====
|
|
|
|
libxo - A Library for Generating Text, XML, JSON, and HTML Output
|
|
|
|
The libxo library allows an application to generate text, XML, JSON,
|
|
and HTML output using a common set of function calls. The application
|
|
decides at run time which output style should be produced. The
|
|
application calls a function "xo_emit" to product output that is
|
|
described in a format string. A "field descriptor" tells libxo what
|
|
the field is and what it means.
|
|
|
|
Imagine a simplified ``wc`` that emits its output fields in a single
|
|
xo_emit call:
|
|
|
|
```
|
|
xo_emit(" {:lines/%7ju/%ju} {:words/%7ju/%ju} "
|
|
"{:characters/%7ju/%ju}{d:filename/%s}\n",
|
|
linect, wordct, charct, file);
|
|
```
|
|
|
|
Output can then be generated in various style, using the "--libxo"
|
|
option:
|
|
|
|
```
|
|
% wc /etc/motd
|
|
25 165 1140 /etc/motd
|
|
% wc --libxo xml,pretty,warn /etc/motd
|
|
<wc>
|
|
<file>
|
|
<filename>/etc/motd</filename>
|
|
<lines>25</lines>
|
|
<words>165</words>
|
|
<characters>1140</characters>
|
|
</file>
|
|
</wc>
|
|
% wc --libxo json,pretty,warn /etc/motd
|
|
{
|
|
"wc": {
|
|
"file": [
|
|
{
|
|
"filename": "/etc/motd",
|
|
"lines": 25,
|
|
"words": 165,
|
|
"characters": 1140
|
|
}
|
|
]
|
|
}
|
|
}
|
|
% wc --libxo html,pretty,warn /etc/motd
|
|
<div class="line">
|
|
<div class="text"> </div>
|
|
<div class="data" data-tag="lines"> 25</div>
|
|
<div class="text"> </div>
|
|
<div class="data" data-tag="words"> 165</div>
|
|
<div class="text"> </div>
|
|
<div class="data" data-tag="characters"> 1140</div>
|
|
<div class="text"> </div>
|
|
<div class="data" data-tag="filename">/etc/motd</div>
|
|
</div>
|
|
```
|
|
|
|
View the beautiful documentation at:
|
|
|
|
http://juniper.github.io/libxo/libxo-manual.html
|
|
|
|
[](https://github.com/Juniper/libxo)
|