日本語 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
LIBARCHIVE(3) FreeBSD ライブラリ関数マニュアル LIBARCHIVE(3)
名称
libarchive -- ストリーミングアーカイブを読み込み書き込みするための関数
概説
libarchive ライブラリは、tar と cpio のような様々な形式のアーカイブを読み
込んで、書き込むための柔軟性のあるインタフェースを提供しています。また、
libarchive は、gzip と bzip2 のような様々な圧縮フィルタを使用して圧縮され
たアーカイブの読み込みと書き込みをサポートしています。ライブラリは、本質
的にストリーム指向です。読み込み手は、アーカイブを通して順次繰り返して、
書き込み手は、アーカイブに順次追加します。特に、ランダムアクセスまたはイ
ンプレース (in-place) 修正のための組み込みサポートがないことに注意してく
ださい。訳注: インプレース修正は、作業用の領域を使わずに直接修正するこ
と。
アーカイブを読み込むとき、ライブラリは、自動的に形式と圧縮を検出します。
ライブラリは、現在、次の読み込みサポートがあります:
• 古いスタイルの tar アーカイブ。
• POSIX ``ustar'' 形式のほとんどの変形。
• POSIX ``pax 交換'' 形式
• GNU 形式 tar アーカイブ
• ほとんどの一般的な cpio アーカイブ形式
• ISO9660 CD イメージ (RockRidge と Joliet 拡張仕様を含む)
• zip アーカイブ。
• ar アーカイブ (GNU/SysV と BSD 拡張を含む)。
• Microsoft CAB アーカイブ。
• LHA アーカイブ。
• mtree ファイルツリー記述。
• RAR アーカイブ。
• XAR アーカイブ。
ライブラリは、自動的に gzip(1), bzip2(1), xz(1), lzip(1) または
compress(1) で圧縮されたアーカイブ検出して、ユーザが気付くことなくそれら
を圧縮復元します。それは、uuencode(1) で処理されるか、または rpm(1) ヘッ
ダがあるアーカイブを同様に検出してデコードすることができます。
アーカイブを書き込むとき、利用者は、使用される圧縮と使用される形式を指定
することができます。ライブラリは、次を書き込むことができます:
• POSIX 標準の ``ustar'' アーカイブ
• POSIX ``pax 交換形式'' アーカイブ
• POSIX オクテット指向の cpio アーカイブ。
• zip アーカイブ。
• shar アーカイブの 2 つの異なった変形。
• ISO9660 CD イメージ。
• 7-Zip アーカイブ。
• ar アーカイブ。
• mtree ファイルツリー記述。
• XAR アーカイブ。
pax 交換形式は、tar(1) のいくつかのより新しい実装と同様に、多くのシステム
上で POSIX 準拠の pax(1) 実装によってサポートされる一般的な方法で、歴史的
な tar 形式の制限のすべてを本質的に排除する tar アーカイブ形式の拡張で
す。デフォルトの書き込み形式は、ほとんどのエントリのために pax 拡張属性を
抑制することに注意してください。明らかに pax 書式を要求すると、すべてのエ
ントリのためのそれらの属性を有効にします。
読み込みと書き込みの API は、それぞれ archive_read_XXX() 関数と
archive_write_XXX() 関数を通してアクセスされ、いずれも他とは無関係に使用
することができます。
このマニュアルページの残りでライブラリ操作の概説を提供します。それぞれの
API かユーティリティ関数に関しては、個々のマニュアルページでより詳細な情
報を見つけることができます。
アーカイブの読み込み
archive_read(3) を参照してください。
アーカイブへの書き込み
archive_write(3) を参照してください。
ディスクへの書き込みエントリ
archive_write_disk(3) API によって、利用者は、archive_entry(3) オブジェク
トを archive_write(3) によって使用された同じ API を使用するディスクに書き
込むことができます。archive_write_disk(3) API は、archive_read_extract()
によって内部的に使用されます。直接それを使用して、エントリがどのように
ディスクに書き込まれているかのより大きな制御を提供することができます。ま
た、この API によって、アーカイブからアーカイブへのコピーとアーカイブから
ディスクへの抽出操作の間でコードを共有することができます。
ディスクからエントリを読み込む
archive_read_disk(3) は、ファイルシステムの情報から archive_entry(3) オブ
ジェクトの追加をサポートします。これは、ACL、拡張属性と他のメタデータと同
様に stat(2) システムコールからのアクセス可能な情報を含んでいます。また、
archive_read_disk(3) API は、ファイルのディレクトリが archive_read(3) API
と互換性がある API を使用して読み込むことができる、ディレクトリツリーに関
する繰り返しをサポートします。
解説
それぞれの関数の詳細な説明は、対応するマニュアルページによって提供されま
す。
すべての関数は、アーカイブの内容へのアクセスを提供する不透明な (サイズ及
び形がわからない) struct archive データ型式を利用します。
struct archive_entry 構造体は、単一のアーカイブエントリの完全な記述を含ん
でいます。それは、archive_entry(3) に完全に文書化されている不透明な (サイ
ズ及び形がわからない) インタフェースを使用します。
歴史的な形式に詳しいユーザは、より新しい異形がテキストフィールドのの長さ
におけるほとんどの制限を排除したことを承知しているべきです。クライアント
は、ファイル名、リンク名、ユーザ名、またはグループ名の長さが制限されると
仮定するべきではありません。特に、pax 交換形式は、PATH_MAX を超える適切な
文字セットで容易に適応することができます。
戻り値
ほとんどの関数は、成功すれば ARCHIVE_OK (0) を返し、エラーの場合は、0 以
外を返します。おそらくユーザに報告されるべきである小さな問題を示す、
ARCHIVE_WARN から、このアーカイブでどんなさらなる操作も防ぐ深刻な問題を示
す、ARCHIVE_FATAL の範囲で、返り値は、エラーの一般的な重大性を示します。
エラーのときに、archive_errno() 関数は、数値エラーコードを検索するために
使用することができます (errno(2) を参照)。archive_error_string() は、表示
に適したテキスト形式のエラーメッセージを返します。
archive_read_new() と archive_write_new() は、割り付けられて初期化された
struct archive オブジェクトへのポインタを返します。
archive_read_data() と archive_write_data() は、実際に読み込まれたか、ま
たは書き込まれたバイト数を返します。0 の値は、このエントリのためのデータ
の終わりを示します。負の数は、エラーを示します、その場合、archive_errno()
と archive_error_string() 関数は、詳しい情報を得るために使用することがで
きます。
環境変数
現在選択されたロケールによって影響される archive_entry(3) 関数中に文字
セット変換があります。
関連項目
tar(1), archive_entry(3), archive_read(3), archive_util(3),
archive_write(3), tar(5)
歴史
libarchive ライブラリは、FreeBSD 5.3 ではじめて登場しました。
作者
libarchive ライブラリは、最初に Tim Kientzle <kientzle@acm.org> によって
書かれました。
バグ
いくつかのアーカイブ形式は、struct archive_entry でサポートされない情報を
サポートします。そのような情報は、このライブラリを使用して完全にアーカイ
ブすることができないし、復旧することができません。例えば、これは、コメン
ト、文字セット、または pax 交換形式アーカイブに現れることができる任意の
キー/値を含んでいます。
逆に、もちろん、struct archive_entry に格納することができるすべての情報が
すべての形式でサポートされるわけではありません。例えば、cpio 形式は、ナノ
秒のタイムスタンプをサポートしません。古い tar 形式は、大きなデバイス番号
をサポートしません。
ISO9660 リーダは、まだすべての ISO9660 イメージを読み込むことができませ
ん。それは、シークする方法を学ぶべきです。
AR ライタは、他のすべての libarchive ライタと異なり、2 つのパスを使用する
ことをクライアントプログラムに要求します。
FreeBSD 11.2 March 18, 2012 FreeBSD 11.2