xref: /freebsd/contrib/libxo/doc/index.rst (revision 76afb20c58adb296f09857aed214b91464242264)
1983afe33SPhil Shafer.. #
2983afe33SPhil Shafer   # Copyright (c) 2014, Juniper Networks, Inc.
3983afe33SPhil Shafer   # All rights reserved.
4983afe33SPhil Shafer   # This SOFTWARE is licensed under the LICENSE provided in the
5983afe33SPhil Shafer   # ../Copyright file. By downloading, installing, copying, or
6983afe33SPhil Shafer   # using the SOFTWARE, you agree to be bound by the terms of that
7983afe33SPhil Shafer   # LICENSE.
8983afe33SPhil Shafer   # Phil Shafer, July 2014
9983afe33SPhil Shafer   #
10983afe33SPhil Shafer
11983afe33SPhil Shafer.. default-role:: code
12983afe33SPhil Shafer
13983afe33SPhil Shaferlibxo - A Library for Generating Text, XML, JSON, and HTML Output
14983afe33SPhil Shafer===================================================================
15983afe33SPhil Shafer
16983afe33SPhil ShaferThe libxo library allows an application to generate text, XML, JSON,
17983afe33SPhil Shaferand HTML output, suitable for both command line use and for web
18983afe33SPhil Shaferapplications.  The application decides at run time which output style
19983afe33SPhil Shafershould be produced.  By using libxo, a single source code path can
20983afe33SPhil Shaferemit multiple styles of output using command line options to select
21983afe33SPhil Shaferthe style, along with optional behaviors.  libxo includes support for
22983afe33SPhil Shafermultiple output streams, pluralization, color, syslog,
23983afe33SPhil Shafer:manpage:`humanized(3)` output, internationalization, and UTF-8.  The
24983afe33SPhil Shaferlibrary aims to minimize the cost of migrating code to libxo.
25983afe33SPhil Shafer
26983afe33SPhil Shaferlibxo ships as part of FreeBSD.
27983afe33SPhil Shafer
28983afe33SPhil Shafer.. toctree::
29983afe33SPhil Shafer    :maxdepth: 3
30983afe33SPhil Shafer    :caption: Documentation Contents:
31983afe33SPhil Shafer
32983afe33SPhil Shafer    intro
33983afe33SPhil Shafer    getting
34983afe33SPhil Shafer    formatting
35983afe33SPhil Shafer    options
36983afe33SPhil Shafer    format-strings
37983afe33SPhil Shafer    field-roles
38983afe33SPhil Shafer    field-modifiers
39983afe33SPhil Shafer    field-formatting
40983afe33SPhil Shafer    api
41*76afb20cSPhil Shafer    encoders
42983afe33SPhil Shafer    xo
43983afe33SPhil Shafer    xolint
44983afe33SPhil Shafer    xohtml
45983afe33SPhil Shafer    xopo
46983afe33SPhil Shafer    faq
47983afe33SPhil Shafer    howto
48983afe33SPhil Shafer    example
49983afe33SPhil Shafer
50983afe33SPhil ShaferIndices and tables
51983afe33SPhil Shafer==================
52983afe33SPhil Shafer
53983afe33SPhil Shafer* :ref:`genindex`
54983afe33SPhil Shafer* :ref:`search`
55