diff options
author | marcel <marcel@FreeBSD.org> | 2014-10-23 22:30:14 +0000 |
---|---|---|
committer | marcel <marcel@FreeBSD.org> | 2014-10-23 22:30:14 +0000 |
commit | fefcd296e4716886912a74acd38abba4c94bc340 (patch) | |
tree | ce8b178967e5d33cbba89d0b2f3d2c2ea45616cb /contrib/libxo/README.md | |
parent | bc4f095bf4554f6047f55bd8d28df41679cade6b (diff) | |
download | FreeBSD-src-fefcd296e4716886912a74acd38abba4c94bc340.zip FreeBSD-src-fefcd296e4716886912a74acd38abba4c94bc340.tar.gz |
Import libxo 0.1.4
Obtained from: https://github.com/Juniper/libxo
Sponsored by: Juniper Networks, Inc.
Diffstat (limited to 'contrib/libxo/README.md')
-rw-r--r-- | contrib/libxo/README.md | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/contrib/libxo/README.md b/contrib/libxo/README.md new file mode 100644 index 0000000..40c162b --- /dev/null +++ b/contrib/libxo/README.md @@ -0,0 +1,62 @@ +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. + +``` + 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 |