lseekのヘルプ・マニュアル／リナックスコマンド

lseekのヘルプ・マニュアル

help
man

lseek --help

man lseek

LSEEK(2) Linux Programmer’s Manual LSEEK(2) 名前 lseek - ファイルの読み書きオフセットの位置を変える書式 #include #include off_t lseek(int fd, off_t offset, int whence); 説明 lseek() 関数は、ファイルディスクリプタ (descriptor) fd に対応するオープンされたファイルのオフセットを、 whence に基づき offset 引き数の位置へ以下のように変更する: SEEK_SET オフセットは offset バイトに設定される。 SEEK_CUR オフセットは現在位置に offset バイトを足した位置になる。 SEEK_END オフセットはファイルのサイズに offset バイトを足した位置になる。 lseek() 関数は、オフセットをファイルの末尾を越えた位置に設定できる ( 但し、これによりファイルのサイズが変わらない)。もしデータがこのオフセット位置以降に書き込まれた場合、間の空隙の部分 ("穴 (hole)") の読み出しがあると、実際にそこにデータを書き込まれるまでは NULL バイト ('\0') の列が返される。返り値成功した場合、 lseek() は結果のファイル位置をファイルの先頭からのバイト数で返す。エラーの場合、値として (off_t) -1 を返し、 errno にエラーが指示される。エラー EBADF fd がオープンされたファイルディスクリプタでない。 EINVAL whence が SEEK_SET, SEEK_CUR, SEEK_END のどれでもない。または、seek の結果、ファイル・オフセットが負になってしまうか、 seek 可能なデバイスの末尾を越えてしまう。 EOVERFLOW 結果のファイル・オフセットを off_t 型で表現することができない。 ESPIPE fd がパイプ、ソケット、FIFO を参照している。準拠 SVr4, 4.3BSD, POSIX.1-2001. 注意この文章で使用した whence は英語として正しくないが、歴史的理由によりそのまま使われている。いくつかのデバイスでは seek ができない。 POSIX はどのデバイスが lseek() に対応すべきかは規定していない。 Linux では、 tty デバイスに lseek() を使用すると ESPIPE を返す。古いコードを変換する時は whence の値を以下のマクロに置き換えること: old new 0 SEEK_SET 1 SEEK_CUR 2 SEEK_END L_SET SEEK_SET L_INCR SEEK_CUR L_XTND SEEK_END 返り値の型は、SVr1-3 では off_t ではなく long であり、 BSD では int である。 dup(2) や fork(2) で作成されたファイルディスクリプタは、現在のファイル位置ポインタ (current file position pointer) を共有しているので、このようなファイルで移動を行うと競合状態を引き起こす可能性がある。関連項目 dup(2), fork(2), open(2), fseek(3), lseek64(3), posix_fallocate(3) Linux 2001-09-24 LSEEK(2)

LSEEK(2) Linux Programmer’s Manual LSEEK(2) NAME lseek - reposition read/write file offset SYNOPSIS #include #include off_t lseek(int fd, off_t offset, int whence); DESCRIPTION The lseek() function repositions the offset of the open file associated with the file descriptor fd to the argument offset according to the directive whence as follows: SEEK_SET The offset is set to offset bytes. SEEK_CUR The offset is set to its current location plus offset bytes. SEEK_END The offset is set to the size of the file plus offset bytes. The lseek() function allows the file offset to be set beyond the end of the file (but this does not change the size of the file). If data is later written at this point, subsequent reads of the data in the gap (a "hole") return null bytes ('\0') until data is actually written into the gap. RETURN VALUE Upon successful completion, lseek() returns the resulting offset loca- tion as measured in bytes from the beginning of the file. Otherwise, a value of (off_t) -1 is returned and errno is set to indicate the error. ERRORS EBADF fd is not an open file descriptor. EINVAL whence is not one of SEEK_SET, SEEK_CUR, SEEK_END; or the resulting file offset would be negative, or beyond the end of a seekable device. EOVERFLOW The resulting file offset cannot be represented in an off_t. ESPIPE fd is associated with a pipe, socket, or FIFO. CONFORMING TO SVr4, 4.3BSD, POSIX.1-2001. NOTES This document’s use of whence is incorrect English, but maintained for historical reasons. Some devices are incapable of seeking and POSIX does not specify which devices must support lseek(). On Linux, using lseek() on a tty device returns ESPIPE. When converting old code, substitute values for whence with the follow- ing macros: old new 0 SEEK_SET 1 SEEK_CUR 2 SEEK_END L_SET SEEK_SET L_INCR SEEK_CUR L_XTND SEEK_END SVr1-3 returns long instead of off_t, BSD returns int. Note that file descriptors created by dup(2) or fork(2) share the cur- rent file position pointer, so seeking on such files may be subject to race conditions. SEE ALSO dup(2), fork(2), open(2), fseek(3), lseek64(3), posix_fallocate(3) COLOPHON This page is part of release 3.22 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/. Linux 2001-09-24 LSEEK(2)

リナックスコマンド