From owner-svn-doc-all@FreeBSD.ORG Mon Jan 12 03:17:56 2015 Return-Path: Delivered-To: svn-doc-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTPS id 02B56DA; Mon, 12 Jan 2015 03:17:56 +0000 (UTC) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id D94A5907; Mon, 12 Jan 2015 03:17:55 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.9/8.14.9) with ESMTP id t0C3Htcl022033; Mon, 12 Jan 2015 03:17:55 GMT (envelope-from bjk@FreeBSD.org) Received: (from bjk@localhost) by svn.freebsd.org (8.14.9/8.14.9/Submit) id t0C3Htea022032; Mon, 12 Jan 2015 03:17:55 GMT (envelope-from bjk@FreeBSD.org) Message-Id: <201501120317.t0C3Htea022032@svn.freebsd.org> X-Authentication-Warning: svn.freebsd.org: bjk set sender to bjk@FreeBSD.org using -f From: Benjamin Kaduk Date: Mon, 12 Jan 2015 03:17:55 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r46190 - head/en_US.ISO8859-1/htdocs/news/status X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.18-1 Precedence: list List-Id: "SVN commit messages for the entire doc trees \(except for " user" , " projects" , and " translations" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 12 Jan 2015 03:17:56 -0000 Author: bjk Date: Mon Jan 12 03:17:54 2015 New Revision: 46190 URL: https://svnweb.freebsd.org/changeset/doc/46190 Log: Add libxo report Approved by: hrs (mentor, blanket) Modified: head/en_US.ISO8859-1/htdocs/news/status/report-2014-10-2014-12.xml Modified: head/en_US.ISO8859-1/htdocs/news/status/report-2014-10-2014-12.xml ============================================================================== --- head/en_US.ISO8859-1/htdocs/news/status/report-2014-10-2014-12.xml Sun Jan 11 16:16:29 2015 (r46189) +++ head/en_US.ISO8859-1/htdocs/news/status/report-2014-10-2014-12.xml Mon Jan 12 03:17:54 2015 (r46190) @@ -2265,4 +2265,64 @@ + + libxo: generate text, XML, JSON, and HTML output + + + + + Marcel + Moolenaar + + marcel@FreeBSD.org + + + + + libxo: The Easy Way to Generate text, XML, JSON, and HTML output. + + + +

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.

+ +

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 —libxo 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.

+ +

Related to this, &os; now also has the xo utility that + allows scripts to grow the same capabilities. Instead of + using echo or printf in scripts, output can be + done using the xo utility.

+ +

The df, w, and wc utilities + have been converted to use libxo. The netstat + utility is in the process of being converted and others are + planned.

+ + + + +

&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.

+ + + +