release/man2/unlink.2

   1 .\" This manpage is Copyright (C) 1992 Drew Eckhardt;
   2 .\"             and Copyright (C) 1993 Ian Jackson
   3 .\"             and Copyright (C) 2006, 2014 Michael Kerrisk.
   4 .\"
   5 .\" %%%LICENSE_START(VERBATIM)
   6 .\" Permission is granted to make and distribute verbatim copies of this
   7 .\" manual provided the copyright notice and this permission notice are
   8 .\" preserved on all copies.
   9 .\"
  10 .\" Permission is granted to copy and distribute modified versions of this
  11 .\" manual under the conditions for verbatim copying, provided that the
  12 .\" entire resulting derived work is distributed under the terms of a
  13 .\" permission notice identical to this one.
  14 .\"
  15 .\" Since the Linux kernel and libraries are constantly changing, this
  16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  17 .\" responsibility for errors or omissions, or for damages resulting from
  18 .\" the use of the information contained herein.  The author(s) may not
  19 .\" have taken the same level of care in the production of this manual,
  20 .\" which is licensed free of charge, as they might when working
  21 .\" professionally.
  22 .\"
  23 .\" Formatted or processed versions of this manual, if unaccompanied by
  24 .\" the source, must acknowledge the copyright and authors of this work.
  25 .\" %%%LICENSE_END
  26 .\"
  27 .\" Modified 1993-07-24 by Rik Faith <faith@cs.unc.edu>
  28 .\" Modified 1996-09-08 by Arnt Gulbrandsen <agulbra@troll.no>
  29 .\" Modified 1997-01-31 by Eric S. Raymond <esr@thyrsus.com>
  30 .\" Modified 2001-05-17 by aeb
  31 .\" Modified 2004-06-23 by Michael Kerrisk <mtk.manpages@gmail.com>
  32 .\"
  33 .\"*******************************************************************
  34 .\"
  35 .\" This file was generated with po4a. Translate the source file.
  36 .\"
  37 .\"*******************************************************************
  38 .\"
  39 .\" Japanese Version Copyright (c) 1997 HANATAKA Shinya
  40 .\"         all rights reserved.
  41 .\" Translated Fri Dec 12 00:42:31 JST 1997
  42 .\"         by HANATAKA Shinya <hanataka@abyss.rim.or.jp>
  43 .\" Modified Tue Sep  5 02:03:33 JST 2000
  44 .\"         by Yuichi SATO <ysato@h4.dion.ne.jp>
  45 .\" Modified Sat Jun  2 08:48:36 JST 2001 by Yuichi SATO
  46 .\" Modified Sun Jul  7 02:58:51 JST 2002 by Yuichi SATO
  47 .\" Updated & Modified Sun Jan  9 23:28:11 JST 2005
  48 .\"         by Yuichi SATO <ysato444@yahoo.co.jp>
  49 .\" Updated 2012-05-08, Akihiro MOTOKI <amotoki@gmail.com>
  50 .\"
  51 .TH UNLINK 2 2014\-02\-21 Linux "Linux Programmer's Manual"
  52 .SH 名前
  53 unlink, unlinkat \- 名前を削除し、場合によってはそれが参照しているファイルも削除する
  54 .SH 書式
  55 .nf
  56 \fB#include <unistd.h>\fP
  57 .sp
  58 \fBint unlink(const char *\fP\fIpathname\fP\fB);\fP
  59 .sp
  60 \fB#include <fcntl.h>           \fP/* AT_* 定数の定義 */
  61 \fB#include <unistd.h>\fP
  62 .sp
  63 \fBint unlinkat(int \fP\fIdirfd\fP\fB, const char *\fP\fIpathname\fP\fB, int \fP\fIflags\fP\fB);\fP
  64 .fi
  65 .sp
  66 .in -4n
  67 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  68 .in
  69 .sp
  70 \fBunlinkat\fP():
  71 .PD 0
  72 .ad l
  73 .RS 4
  74 .TP  4
  75 glibc 2.10 以降:
  76 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  77 .TP
  78 glibc 2.10 より前:
  79 _ATFILE_SOURCE
  80 .RE
  81 .ad
  82 .PD
  83 .SH 説明
  84 \fBunlink\fP()  はファイルシステム上の名前を削除する。 もしその名前がファイルへの最後のリンク (link) であり、
  85 どのプロセスもそのファイルをオープン (open) していなければ、 ファイルは削除される。
  86 ファイルが使用していたディスク上の領域は再利用が可能になる。
  87
  88 もし削除する名前がファイルへの最後のリンクだが、どれかのプロセスが そのファイルをまだオープンしている場合は、
  89 そのファイルを参照している最後のファイルディスクリプタ (file descriptor)  がクローズ (close)
  90 されるまでファイルは存在し続ける。
  91
  92 もしその名前がシンボリックリンク (symbolic link) を参照していれば、 リンクは削除される。
  93
  94 もし名前がソケット (socket) や fifo やデバイス (device) を参照していれば
  95 名前は削除されるがそのオブジェクトをオープンしていたプロセスは それを使い続けることができる。
  96 .SS unlinkat()
  97 \fBunlinkat\fP() システムコールは、\fBunlink\fP() と \fBrmdir\fP(2) のいずれかと全く同じ動作をする
  98 (どちらと同じになるかは \fIflags\fP に \fBAT_REMOVEDIR\fP フラグが指定されたかにより決まる) が、以下で説明する点が異なる。
  99
 100 \fIpathname\fP で指定されたパス名が相対パスの場合、このパス名はファイルディスクリプター \fIdirfd\fP
 101 が参照するディレクトリに対する相対パスと解釈される (\fBunlink\fP() や \fBrmdir\fP(2)
 102 に相対パス名を渡した場合のように、呼び出したプロセスのカレントワーキングディレクトリに対する相対パスではない)。
 103
 104 \fIpathname\fP で指定されたパス名が相対パスで、 \fIdirfd\fP が特別な値 \fBAT_FDCWD\fP の場合、 (\fBunlink\fP() や
 105 \fBrmdir\fP(2) と同様に) \fIpathname\fP は呼び出したプロセスのカレントワーキングディレクトリに対する相対パスと解釈される。
 106
 107 \fIpathname\fP で指定されたパス名が絶対パスの場合、 \fIdirfd\fP は無視される。
 108
 109 \fIflags\fP はビットマスクで、0 もしくは \fBunlinkat\fP()
 110 の動作を制御するフラグ値を論理和の形で指定することができる。現在のところ、定義されているフラグはひとつだけである。
 111 .TP
 112 \fBAT_REMOVEDIR\fP
 113 デフォルトでは、 \fBunlinkat\fP() は \fIpathname\fP に対して \fBunlink\fP() と等価な動作をする。
 114 \fBAT_REMOVEDIR\fP フラグが指定された場合、 \fIpathname\fP に対して \fBrmdir\fP(2) と等価な動作をする。
 115 .PP
 116 \fBunlinkat\fP() の必要性についての説明については \fBopenat\fP(2) を参照。
 117 .SH 返り値
 118 成功した場合は 0 が返される。エラーの場合は \-1 が返され、 \fIerrno\fP が適切に設定される。
 119 .SH エラー
 120 .TP
 121 \fBEACCES\fP
 122 \fIpathname\fP を含んでいるディレクトリの書き込み許可がプロセスの実効 (effective)  ユーザー ID に与えられていないか、
 123 \fIpathname\fP の中のディレクトリのどれかに検索許可が与えられていない (\fBpath_resolution\fP(7)  も参照すること)。
 124 .TP
 125 \fBEBUSY\fP
 126 システムか別のプロセスがそのファイルを使用中のため、
 127 ファイル \fIpathname\fP を unlink できない。
 128 例えば、そのファイルがマウントポイントの場合や、
 129 NFS クライアントソフトウェアがそのファイルがアクティブであるが
 130 名前なし inode (nameless inode) であることを示すために作成した
 131 場合 ("NFS silly renamed") などがある。
 132 .TP
 133 \fBEFAULT\fP
 134 \fIpathname\fP がアクセス可能なアドレス空間の外を指している。
 135 .TP
 136 \fBEIO\fP
 137 I/O エラーが発生した。
 138 .TP
 139 \fBEISDIR\fP
 140 \fIpathname\fP がディレクトリを参照している。 (これは POSIX で規定されていない値で、Linux 2.1.132 以降で返される。)
 141 .TP
 142 \fBELOOP\fP
 143 \fIpathname\fP を解決する際に遭遇したシンボリックリンクが多過ぎる。
 144 .TP
 145 \fBENAMETOOLONG\fP
 146 \fIpathname\fP が長過ぎる。
 147 .TP
 148 \fBENOENT\fP
 149 \fIpathname\fP に対応するものが存在しないか、壊れたシンボリックリンクであるか、 \fIpathname\fP が空である。
 150 .TP
 151 \fBENOMEM\fP
 152 十分なカーネルメモリーがない。
 153 .TP
 154 \fBENOTDIR\fP
 155 \fIpathname\fP のディレクトリ部分が、実際には、ディレクトリでない。
 156 .TP
 157 \fBEPERM\fP
 158 システムがディレクトリに対する unlink 操作を許可していない。 またはディレクトリに対する unlink 操作のために必要な特権を
 159 呼び出し元のプロセスが持っていない。 (これは POSIX で規定されているエラーの返し方である。 上述の通り、この場合には Linux は
 160 \fBEISDIR\fP を返す。)
 161 .TP
 162 \fBEPERM\fP (Linux のみ)
 163 ファイルシステムがファイルに対する unlink 操作を許していない。
 164 .TP
 165 \fBEPERM\fP または \fBEACCES\fP
 166 \fIpathname\fP を含んでいるディレクトリにスティッキービット (sticky\-bit)  (\fBS_ISVTX\fP)
 167 が設定されていて、プロセスの実効ユーザー ID が削除しようとするファイルの UID でもそれを含んでいるディレクトリのものでもなく、
 168 かつプロセスに特権がない (Linux では \fBCAP_FOWNER\fP ケーパビリティ (capability) がない)。
 169 .TP
 170 \fBEROFS\fP
 171 \fIpathname\fP が読み込み専用のファイルシステムのファイルを参照している。
 172 .PP
 173 \fBunlink\fP() と \fBrmdir\fP(2) で発生するのと同じエラーが \fBunlinkat\fP() でも起こる。 \fBunlinkat\fP()
 174 では以下のエラーも発生する。
 175 .TP
 176 \fBEBADF\fP
 177 \fIdirfd\fP が有効なファイルディスクリプタではない。
 178 .TP
 179 \fBEINVAL\fP
 180 無効なフラグ値が \fIflags\fP に指定された。
 181 .TP
 182 \fBEISDIR\fP
 183 \fIpathname\fP がディレクトリを参照していて、 \fIflags\fP に \fBAT_REMOVEDIR\fP がされていなかった。
 184 .TP
 185 \fBENOTDIR\fP
 186 \fIpathname\fP が相対パスで、 \fIdirfd\fP がディレクトリ以外のファイルを参照しているファイルディスクリプタである。
 187 .SH バージョン
 188 \fBunlinkat\fP()  はカーネル 2.6.16 で Linux に追加された。 ライブラリによるサポートはバージョン 2.4 で glibc
 189 に追加された。
 190 .SH 準拠
 191 .\" SVr4 documents additional error
 192 .\" conditions EINTR, EMULTIHOP, ETXTBSY, ENOLINK.
 193 \fBunlink\fP(): SVr4, 4.3BSD, POSIX.1\-2001, POSIX.1\-2008.
 194
 195 \fBunlinkat\fP(): POSIX.1\-2008.
 196 .SH バグ
 197 NFS プロトコルに内在する問題により、まだ使用中のファイルが想定外に消えてしまうことがありえる。
 198 .SH 関連項目
 199 \fBrm\fP(1), \fBchmod\fP(2), \fBlink\fP(2), \fBmknod\fP(2), \fBopen\fP(2), \fBrename\fP(2),
 200 \fBrmdir\fP(2), \fBmkfifo\fP(3), \fBremove\fP(3), \fBpath_resolution\fP(7),
 201 \fBsymlink\fP(7)
 202 .SH この文書について
 203 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.63 の一部
 204 である。プロジェクトの説明とバグ報告に関する情報は
 205 http://www.kernel.org/doc/man\-pages/ に書かれている。