index.rst revision 334458 
1.. #
2   # Copyright (c) 2014, 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
11.. default-role:: code
12
13libxo - A Library for Generating Text, XML, JSON, and HTML Output
14===================================================================
15
16The libxo library allows an application to generate text, XML, JSON,
17and HTML output, suitable for both command line use and for web
18applications.  The application decides at run time which output style
19should be produced.  By using libxo, a single source code path can
20emit multiple styles of output using command line options to select
21the style, along with optional behaviors.  libxo includes support for
22multiple output streams, pluralization, color, syslog,
23:manpage:`humanized(3)` output, internationalization, and UTF-8.  The
24library aims to minimize the cost of migrating code to libxo.
25
26libxo ships as part of FreeBSD.
27
28.. toctree::
29    :maxdepth: 3
30    :caption: Documentation Contents:
31
32    intro
33    getting
34    formatting
35    options
36    format-strings
37    field-roles
38    field-modifiers
39    field-formatting
40    api
41    xo
42    xolint
43    xohtml
44    xopo
45    faq
46    howto
47    example
48
49Indices and tables
50==================
51
52* :ref:`genindex`
53* :ref:`search`
54