release/man2/truncate.2

   1 .\" Copyright (c) 1983, 1991 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by the University of
  16 .\"     California, Berkeley and its contributors.
  17 .\" 4. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\" %%%LICENSE_END
  33 .\"
  34 .\"     @(#)truncate.2  6.9 (Berkeley) 3/10/91
  35 .\"
  36 .\" Modified 1993-07-24 by Rik Faith <faith@cs.unc.edu>
  37 .\" Modified 1996-10-22 by Eric S. Raymond <esr@thyrsus.com>
  38 .\" Modified 1998-12-21 by Andries Brouwer <aeb@cwi.nl>
  39 .\" Modified 2002-01-07 by Michael Kerrisk <mtk.manpages@gmail.com>
  40 .\" Modified 2002-04-06 by Andries Brouwer <aeb@cwi.nl>
  41 .\" Modified 2004-06-23 by Michael Kerrisk <mtk.manpages@gmail.com>
  42 .\"
  43 .\"*******************************************************************
  44 .\"
  45 .\" This file was generated with po4a. Translate the source file.
  46 .\"
  47 .\"*******************************************************************
  48 .TH TRUNCATE 2 2011\-09\-08 Linux "Linux Programmer's Manual"
  49 .SH 名前
  50 truncate, ftruncate \- 指定した長さにファイルを切り詰める
  51 .SH 書式
  52 \fB#include <unistd.h>\fP
  53 .br
  54 \fB#include <sys/types.h>\fP
  55 .sp
  56 \fBint truncate(const char *\fP\fIpath\fP\fB, off_t \fP\fIlength\fP\fB);\fP
  57 .br
  58 \fBint ftruncate(int \fP\fIfd\fP\fB, off_t \fP\fIlength\fP\fB);\fP
  59 .sp
  60 .in -4n
  61 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  62 .in
  63 .ad l
  64 .PD 0
  65 .sp
  66 \fBtruncate\fP():
  67 .RS 4
  68 _BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500 || _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
  69 .br
  70 || /* glibc 2.12 以降: */ _POSIX_C_SOURCE\ >=\ 200809L
  71 .RE
  72 .sp
  73 \fBftruncate\fP():
  74 .RS 4
  75 _BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500 || _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
  76 .br
  77 || /* glibc 2.3.5 以降: */ _POSIX_C_SOURCE\ >=\ 200112L
  78 .RE
  79 .PD
  80 .ad b
  81 .SH 説明
  82 \fBtruncate\fP()  は \fIpath\fP で指定されるファイルを、 \fBftruncate\fP()  は \fIfd\fP で参照されるファイルを
  83 \fIlength\fP バイトの長さになるように延長する、もしくは切り詰める。
  84 .LP
  85 もし切り詰める前のファイルが \fIlength\fP より長ければ、length バイトを越える部分のデータは失われる。 もし切り詰める前のファイルが
  86 \fIlength\fP より短かければ、伸張される。 伸張された部分を読んだ場合は NULL バイト (\(aq\e0\(aq) の列が返される。
  87 .LP
  88 ファイルオフセットは変更されない。
  89 .LP
  90 大きさが変更されると、ファイルの st_ctime と st_mtime フィールド (それぞれ最終状態変更時刻、最終修正時刻; \fBstat\fP(2)
  91 参照) が更新される。 また、set\-user\-ID と set\-group\-ID の許可ビットがクリアされるかもしれない。
  92 .LP
  93 \fBftruncate\fP()  の場合、ファイルは書き込み用に開いていなければならない。 \fBtruncate\fP()
  94 の場合、ファイルは書き込み可能でなければならない。
  95 .SH 返り値
  96 成功した場合は 0 が返される。エラーの場合は \-1 が返され、 \fIerrno\fP が適切に設定される。
  97 .SH エラー
  98 \fBtruncate\fP()  では以下のエラーコードが定義されている。
  99 .TP
 100 \fBEACCES\fP
 101 パスで指定されているディレクトリに検索許可のないものがある (訳注:x ビットが立っていない)。
 102 あるいは、指定されたファイルに対する書き込み許可を持っていない。 (\fBpath_resolution\fP(7)  も参照のこと)
 103 .TP
 104 \fBEFAULT\fP
 105 \fIpath\fP がプロセスに割り当てられているアドレス空間外を指している。
 106 .TP
 107 \fBEFBIG\fP
 108 引き数 \fIlength\fP が最大ファイルサイズより大きい。(XSI)
 109 .TP
 110 \fBEINTR\fP
 111 完了待ちで停止 (block) している間に、呼び出しが シグナルハンドラにより割り込まれた。 \fBfcntl\fP(2)  と \fBsignal\fP(7)
 112 を参照。
 113 .TP
 114 \fBEINVAL\fP
 115 引き数 \fIlength\fP が負数であるか、最大ファイルサイズより大きい。
 116 .TP
 117 \fBEIO\fP
 118 inode の更新時に I/O エラーが発生した。
 119 .TP
 120 \fBEISDIR\fP
 121 指定されたファイルはディレクトリである。
 122 .TP
 123 \fBELOOP\fP
 124 パス名を解釈する際にシンボリックリンクが多すぎた。
 125 .TP
 126 \fBENAMETOOLONG\fP
 127 パス名中のディレクトリ名が 255 文字を越えている、もしくはパス名全体が 1023 文字を越えている。
 128 .TP
 129 \fBENOENT\fP
 130 指定された名前のファイルが存在しない。
 131 .TP
 132 \fBENOTDIR\fP
 133 パス名の構成要素がディレクトリではない。
 134 .TP
 135 \fBEPERM\fP
 136 .\" This happens for at least MSDOS and VFAT file systems
 137 .\" on kernel 2.6.13
 138 下層にあるファイルシステムでは、現在のファイル長を越えて ファイルを伸長することができない。
 139 .TP
 140 \fBEROFS\fP
 141 ファイルが読み込み専用 (read only) のファイル・システム上にある。
 142 .TP
 143 \fBETXTBSY\fP
 144 指定されたファイルは実行されているファイルである。
 145 .PP
 146 \fBftruncate\fP()  にも同様のエラーが適用される。 但し、 \fIpath\fP に関するエラーの場合は、ファイルディスクリプター \fIfd\fP
 147 に関するエラーとなる。
 148 .TP
 149 \fBEBADF\fP
 150 \fIfd\fP が無効なディスクリプターである。
 151 .TP
 152 \fBEBADF\fP または \fBEINVAL\fP
 153 \fIfd\fP で指定されているものが書き込みモードで開かれていない。
 154 .TP
 155 \fBEINVAL\fP
 156 \fIfd\fP が通常のファイルを参照していない。
 157 .SH 準拠
 158 .\" POSIX.1-1996 has
 159 .\" .BR ftruncate ().
 160 .\" POSIX.1-2001 also has
 161 .\" .BR truncate (),
 162 .\" as an XSI extension.
 163 .\" .LP
 164 .\" SVr4 documents additional
 165 .\" .BR truncate ()
 166 .\" error conditions EMFILE, EMULTIHP, ENFILE, ENOLINK.  SVr4 documents for
 167 .\" .BR ftruncate ()
 168 .\" an additional EAGAIN error condition.
 169 4.4BSD, SVr4, POSIX.1\-2001 (これらのコールは 4.2BSD で初めて登場した)。
 170 .SH 注意
 171 .\" At the very least: OSF/1, Solaris 7, and FreeBSD conform, mtk, Jan 2002
 172 「説明」の節で述べた詳細は XSI 準拠のシステムについてのものである。
 173 XSI 非準拠のシステムの場合、POSIX 標準は \fBftruncate\fP() に対して \fIlength\fP が
 174 ファイルの長さより長かった場合、 エラーを返すかファイルを伸張するかの二つの
 175 動作を許容している。 \fBtruncate\fP() に対しては全く規定されていない。
 176 ほとんどの UNIX 実装と同様、Linux はネイティブ (Linux 由来) の ファイルシステム
 177 の扱いでは XSI 要求仕様にしたがっている。 しかしながら、いくつかの非ネイティブ
 178 のファイルシステムでは、 \fBtruncate\fP() や \fBftruncate\fP() を使って現在のファイル
 179 長を越えてファイルを伸長することができない。 Linux での有名な例としては
 180 VFAT がある。
 181
 182 元々の Linux の \fBtruncate\fP() と \fBftruncate\fP() システムコールは
 183 大きなファイルオフセットを扱えるように設計されていなかった。
 184 その結果、大きなファイルファイルを扱うことができる \fBtruncate64\fP() と \fBftruncate64\fP()
 185 システムコールが Linux 2.4 で追加された。
 186 ただし、glibc を使ったアプリケーションではこれらの詳細は気にする必要はない。
 187 glibc のラッパー関数は新しいシステムコールが利用できる場合にはそれらを利用する
 188 ようになっているからである。
 189 .SH バグ
 190 .\" http://sourceware.org/bugzilla/show_bug.cgi?id=12037
 191 glibc 2.12 のヘッダファイルにはバグがあり、 \fBftruncate\fP()  の宣言を公開するのに必要な \fB_POSIX_C_SOURCE\fP
 192 の最小値が 200112L ではなく 200809L となっていた。 このバグは、これ以降のバージョンの glibc では修正されている。
 193 .SH 関連項目
 194 \fBopen\fP(2), \fBstat\fP(2), \fBpath_resolution\fP(7)
 195 .SH この文書について
 196 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.50 の一部
 197 である。プロジェクトの説明とバグ報告に関する情報は
 198 http://www.kernel.org/doc/man\-pages/ に書かれている。