日本語 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.4-RELEASE-K, 13.0-RELEASE-K から 13.3-RELEASE-K, 14.0-RELEASE-K から 14.1-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
LSEEK(2) FreeBSD システムコールマニュアル LSEEK(2)
名称
lseek -- 読み込み/書き込みファイルのオフセットを再び位置付けする
ライブラリ
標準 C ライブラリ (libc, -lc)
書式
#include <unistd.h>
off_t
lseek(int fildes, off_t offset, int whence);
解説
lseek() システムコールは、ファイル記述子 fildes のオフセットを、指示
whence に従って引数 offset に再位置付けします。引数 fildes は、オープンし
ているファイル記述子でなければなりません。lseek() システムコールは、次の
ようなファイル記述子 fildes に関連したファイル位置ポインタに再位置付けま
す。
whence が SEEK_SET であるなら、オフセットは、offset バイトに設定さ
れます。
whence が SEEK_CUR であるなら、オフセットは、その現在の位置プラス
offset バイトに設定されます。
whence が SEEK_END であるなら、オフセットは、ファイルのサイズプラス
offset バイトに設定されます。
whence が SEEK_HOLE であるなら、オフセットは、供給された offset 以
上の次のホールの開始に設定されます。ホールの定義は、以下に提供され
ます。
whence が SEEK_DATA であるなら、オフセットは、供給された offset と
等しいか大きい次のホールでない開始に設定されます。
lseek() システムコールによって、ファイルの既存のエンドオブファイル (end
of-file) の終わりを越えてファイルオフセットを、設定することができます。
データが後でこの時点に書き込まれるなら、ギャップのデータの続く読み込み
は、(データが実際にギャップに書き込まれるまで) 0 のバイトを返します。
しかしながら、lseek() システムコールは、ファイルのサイズは自然に拡張され
ません。
"hole" は、ファイルの連続しているバイトの範囲として定義され、すべての 0
の値がありますが、SEEK_HOLE で返されたホールは、ファイル中のすべての 0 と
して表示することが保証されます。ファイルシステムは、SEEK_HOLE がある 0 の
公開された範囲として許可されていますが、必要ではありません。アプリケー
ションは、0 の範囲のためのそれらの振る舞いを最適化するために SEEK_HOLE を
使用することができますが、ファイルのそのようなすべての範囲を見つけるため
にそれに依存してはいけません。各ファイルは、ファイルのまさに終わりに 0 サ
イズの仮想のホールがあるように存在します。すべてのデータ領域の終わりの
ホール存在は、簡単なプログラミングのために許可され、Solaris のオリジナル
の実装への互換性も提供しています。また、供給された offset を過ぎてホール
がないことを示すために、現在のファイルサイズ (すなわち、ファイルの終りの
オフセット) を返します。アプリケーションは、ファイルシステムが SEEK_HOLE
をサポートするかどうか決定するために、fpathconf(_PC_MIN_HOLE_SIZE) または
pathconf(_PC_MIN_HOLE_SIZE) を使用するべきです。pathconf(2) を参照してく
ださい。
ホールに関する情報を提供しないファイルシステムにおいては、ファイルは、全
体が 1 つのデータ領域として表現されます。
戻り値
成功して完了すると、lseek() は、ファイルの先頭からバイト単位で測定される
結果のオフセットの位置を返します。そうでなければ、-1 の値が返され、errno
は、エラーを示す値に設定されます。
エラー
lseek() システムコールは、次の場合に失敗して、ファイルの位置ポインタは、
変更されないままとなります:
[EBADF] fildes 引数が、オープンしているファイル記述子ではあり
ません。
[EINVAL] whence 引数が、適切な値ではないか、または、結果のファ
イルオフセットが、キャラクタ特殊ファイルでないのに対し
て負となっています。
[ENXIO] SEEK_DATA で、供給されたオフセットを通り超える、それ以
上のデータ領域がありません。SEEK_HOLE のためのファイル
の終わりのホールの存在のために、このエラーは、offset
が、既にファイルの終りの位置を指すときのみ、返されま
す。
[EOVERFLOW] 結果のファイルオフセットが、タイプ off_t のオブジェク
トで正しく表すことができない値です。
[ESPIPE] fildes 引数が、パイプ、ソケット、または FIFO と関連し
ています。
関連項目
dup(2), open(2), pathconf(2)
規格
lseek() システムコールは、IEEE Std 1003.1-2008 (``POSIX.1'') に適合するは
ずです。
SEEK_HOLE と SEEK_DATA ディレクティブは、ENXIO エラーとともに、その指定に
展開されます。
歴史
lseek() 関数は、Version 7 AT&T UNIX で登場しました。
バグ
lseek() システムコールが、シークすることが不可能なデバイスで動作している
なら、それは、たとえシークが実行されなくても、シーク操作を要求し、成功し
て返ります。offset 引数は、そのデバイスのファイル記述子で無条件に格納され
るので、(例えば、ftell() 関数を使用して) シーク操作が成功しても、しなくて
も、確認するための方法はありません。シークすることが不可能であると知られ
ているデバイスタイプは、テープドライブを含みます。
lseek() システムコールは、メディアが DVD またはブルーレイデバイスのような
変更できるメディアデバイスの存在するかどうかは検出されません。そのため
に、要求された seek 操作は、メディアが存在しないとき成功して返ります。
この文書の whence の使用は、間違った英語ですが、歴史的の理由のために維持
されています。
FreeBSD 13.2 July 13, 2020 FreeBSD 13.2