Add libxo report
Approved by: hrs (mentor, blanket)
This commit is contained in:
parent
d734e27d9b
commit
522b508ed6
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=46190
1 changed files with 60 additions and 0 deletions
|
@ -2265,4 +2265,64 @@
|
|||
</help>
|
||||
</project>
|
||||
|
||||
<project cat='bin'>
|
||||
<title>libxo: generate text, XML, JSON, and HTML output</title>
|
||||
|
||||
<contact>
|
||||
<person>
|
||||
<name>
|
||||
<given>Marcel</given>
|
||||
<common>Moolenaar</common>
|
||||
</name>
|
||||
<email>marcel@FreeBSD.org</email>
|
||||
</person>
|
||||
</contact>
|
||||
|
||||
<links>
|
||||
<url href="http://juniper.github.io/libxo/libxo-manual.html">libxo: The Easy Way to Generate text, XML, JSON, and HTML output.</url>
|
||||
</links>
|
||||
|
||||
<body>
|
||||
<p>Many &os; utilities provide insight into the operational
|
||||
state of a running &os; system and as such are used regularly to
|
||||
monitor the system. These utilities provide their output in a human
|
||||
readable form and sometimes even optimized for the limited width of
|
||||
traditional terminals. Often times these utilities are used by other
|
||||
programs that want to present the output in different ways or as part
|
||||
of other user interfaces. For such use cases, it is infinitely better
|
||||
to work with machine-readable output instead of human-readable
|
||||
output.</p>
|
||||
|
||||
<p>Juniper Networks has created a library called libxo, that
|
||||
makes it easy for utilities to emit output in various
|
||||
formats. By default the text output is emitted, but with the
|
||||
introduction of the <tt>—libxo</tt> option this can be changed to
|
||||
XML, JSON and HTML. The &os; project has imported this library
|
||||
into the base system and is in the process of rewriting utilities
|
||||
to use libxo.</p>
|
||||
|
||||
<p>Related to this, &os; now also has the <tt>xo</tt> utility that
|
||||
allows scripts to grow the same capabilities. Instead of
|
||||
using <tt>echo</tt> or <tt>printf</tt> in scripts, output can be
|
||||
done using the <tt>xo</tt> utility.</p>
|
||||
|
||||
<p>The <tt>df</tt>, <tt>w</tt>, and <tt>wc</tt> utilities
|
||||
have been converted to use libxo. The <tt>netstat</tt>
|
||||
utility is in the process of being converted and others are
|
||||
planned.</p>
|
||||
</body>
|
||||
|
||||
<help>
|
||||
<task>
|
||||
<p>&os; contains a lot of utilities that could benefit from
|
||||
having the ability to emit various output formats,
|
||||
too many for a few people to convert in time for &os; 11.0-RELEASE.
|
||||
If you or your company would like to see a particular
|
||||
utility converted, consider learning about libxo and
|
||||
trying to perform the conversion of said utility to help
|
||||
out.</p>
|
||||
</task>
|
||||
</help>
|
||||
</project>
|
||||
|
||||
</report>
|
||||
|
|
Loading…
Reference in a new issue