日本語 man コマンド類 (ja-man-1.1j_5) と日本語 man ドキュメント (ja-man-doc-5.4 (5.4-RELEASE 用) など) をインストールすると、以下のような man コマンド閲覧、キーワード検索が コンソールからできるようになります。
4.11-RELEASE-K, 5.4-RELEASE-K, 5.5-RELEASE-K, 6.0-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K, 12.1-RELEASE-K は、 プライベート版 (小金丸が編集してまとめたもの) ですが、 より多くの翻訳したファイルが含まれています。 (5.4-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K から 12.3-RELEASE-K, 13.0-RELEASE-K から 13.2-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
LIBXO(3) FreeBSD ライブラリ関数マニュアル LIBXO(3)
名称
xo_open_container, xo_open_container_h, xo_open_container_hd,
xo_open_container_d xo_close_container, xo_close_container_h,
xo_close_container_hd, xo_close_container_d -- コンテナ構成をオープンして
(クローズする)
ライブラリ
libxo Library (libxo, -lxo)
書式
#include <libxo/xo.h>
int
xo_open_container(const char *name);
int
xo_open_container_h(xo_handle_t *handle, const char *name);
int
xo_open_container_hd(xo_handle_t *handle, const char *name);
int
xo_open_container_d(const char *name);
int
xo_close_container(const char *name);
int
xo_close_container_h(xo_handle_t *handle, const char *name);
int
xo_close_container_hd(xo_handle_t *handle);
int
xo_close_container_d(void);
解説
libxo は、次の階層の 2 つのタイプを表します: ``containers'' と
``lists''。コンテナは、リストが複合回に見ることができるインスタンスを含ん
でいるところで、与えられた親の下で一度現われます。コンテナは、関連する
フィールドを保持し、データ構成とスコープを与えるために使用されます。コン
テナには値がありませんが、他のノードを含む役目をします。
コンテナをオープンするために、xo_open_container() または
xo_open_container_h() を呼び出します。前者は、デフォルトのハンドルを使用
し、後者は、特定のハンドルを受け付けます。
レベルをクローズするために、xo_close_container() または
xo_close_container_h() 関数を使用します。
各オープン呼び出しには、一致するクローズの呼び出しがあるべきです。
XOF_WARN フラグが設定され、与えられた名前が、現在オープンしているコンテナ
の名前と一致しないなら、警告が生成されます。
Example:
xo_open_container("top");
xo_open_container("system");
xo_emit("{:host-name/%s%s%s", hostname,
domainname ? "." : "", domainname ?: "");
xo_close_container("system");
xo_close_container("top");
Sample Output:
Text:
my-host.example.org
XML:
<top>
<system>
<host-name>my-host.example.org</host-name>
</system>
</top>
JSON:
"top" : {
"system" : {
"host-name": "my-host.example.org"
}
}
HTML:
<div class="data"
data-tag="host-name">my-host.example.org</div>
階層構造の発行
コンテナを作成するために、xo_open_container() と xo_close_container() 関
数の組を使用します。handle パラメータは、デフォルトのハンドルを使用するた
めに xo_create(3) または NULL によって返されたようなハンドルを含んでいま
す。name パラメータは、UTF-8 でエンコード化される、コンテナの名前を与えま
す。ASCII が UTF-8 の正確なサブセットであるので、従来の C 文字列を直接使
用することができます。
``_d'' 接尾辞があるクローズ関数は、``Do The Right Thing'' (正しいことをす
る) モードで使用されます、ここで、呼び出し側がオープンしたコンテナ名のの
経過を追わないようにすることができるように、オープンしたコンテナ、リスト
とインスタンスの名前は、libxo によって内部適に維持されます。
クローズで与えられた名前が現在のオープンされているコンテナと一致しないな
ら、警告を生成するために XOF_WARN フラグを使用します。
TEXT と HTML 出力について、XOF_XPATH フラグが設定されるとき、それらが使用
される HTML について、コンテナは、出力テキストに提供されません。
EXAMPLE:
xo_open_container("system");
xo_emit("The host name is {:host-name}0, hn);
xo_close_container("system");
XML:
<system><host-name>foo</host-name></system>
DTRT モード
あるユーザは、不便なオープンされたコンテナ、リストとインスタンスの名前を
追跡して見つけます。libxo は、``Do The Right Thing'' (正しいことをする)
モードで提供します、ここで、libxo は、オープンされたコンテナ、リストとイ
ンスタンスの名前を追跡するので、名前なしでクローズ関数を呼び出すことがで
きます。DTRT モードを有効にするために、他の libxo 出力を行う前に XOF_DTRT
フラグをオンに切り替えます。
xo_set_flags(NULL, XOF_DTRT);
各オープンとクローズ関数には、オープンされたコンテナ、リストまたはインス
タンスをクローズする、接尾辞 ``_d'' を付けたバージョンがあります:
xo_open_container("top");
...
xo_close_container_d();
XOF_WARN フラグは、また、libxo が、オープンしたコンテナ、リストとインスタ
ンスを追跡することに注意してください。警告は、クローズ関数に与えられた名
前と記録された名前が一致しないとき、生成されます。
関連項目
xo_emit(3), libxo(3)
歴史
libxo ライブラリは、FreeBSD 11.0 ではじめて登場しました。
作者
libxo は、Phil Shafer <phil@freebsd.org> によって書かれました。
FreeBSD 11.2 December 4, 2014 FreeBSD 11.2