release/man2/link.2

   1 .\" This manpage is Copyright (C) 1992 Drew Eckhardt;
   2 .\"             and Copyright (C) 1993 Michael Haardt, 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-23 by Rik Faith <faith@cs.unc.edu>
  28 .\" Modified 1994-08-21 by Michael Haardt
  29 .\" Modified 2004-06-23 by Michael Kerrisk <mtk.manpages@gmail.com>
  30 .\" Modified 2005-04-04, as per suggestion by Michael Hardt for rename.2
  31 .\"
  32 .\"*******************************************************************
  33 .\"
  34 .\" This file was generated with po4a. Translate the source file.
  35 .\"
  36 .\"*******************************************************************
  37 .\"
  38 .\" Japanese Version Copyright (c) 1997 HANATAKA Shinya
  39 .\"         all rights reserved.
  40 .\" Translated Thu Dec 11 23:47:55 JST 1997
  41 .\"         by HANATAKA Shinya <hanataka@abyss.rim.or.jp>
  42 .\" Updated & Modified Tue Feb  8 06:36:08 JST 2005
  43 .\"         by Yuichi SATO <ysato444@yahoo.co.jp>
  44 .\" Updated & Modified Fri Apr 22 02:05:00 JST 2005 by Yuichi SATO
  45 .\" Updated 2008-09-07, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v3.08
  46 .\" Updated 2013-05-06, Akihiro MOTOKI <amotoki@gmail.com>
  47 .\"
  48 .TH LINK 2 2014\-08\-19 Linux "Linux Programmer's Manual"
  49 .SH 名前
  50 link, linkat \- ファイルの新しい名前を作成する
  51 .SH 書式
  52 .nf
  53 \fB#include <unistd.h>\fP
  54 .sp
  55 \fBint link(const char *\fP\fIoldpath\fP\fB, const char *\fP\fInewpath\fP\fB);\fP
  56 .sp
  57 \fB#include <fcntl.h>           \fP/* AT_* 定数の定義 */
  58 \fB#include <unistd.h>\fP
  59 .sp
  60 \fBint linkat(int \fP\fIolddirfd\fP\fB, const char *\fP\fIoldpath\fP\fB,\fP
  61 \fB           int \fP\fInewdirfd\fP\fB, const char *\fP\fInewpath\fP\fB, int \fP\fIflags\fP\fB);\fP
  62 .fi
  63 .sp
  64 .in -4n
  65 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  66 .in
  67 .sp
  68 \fBlinkat\fP():
  69 .PD 0
  70 .ad l
  71 .RS 4
  72 .TP  4
  73 glibc 2.10 以降:
  74 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  75 .TP
  76 glibc 2.10 より前:
  77 _ATFILE_SOURCE
  78 .RE
  79 .ad
  80 .PD
  81 .SH 説明
  82 \fBlink\fP()  は存在するファイルへの新しいリンク (link)  (ハードリンク (hard link) ともいう) を作成する。
  83
  84 \fInewpath\fP が存在する場合には、上書きは\fIされない\fP。
  85
  86 この新しい名前は全ての操作において古い名前と完全に同じように使用される; 両方の名前は同じファイルを参照しており (それで同じ許可
  87 (permission) や所有者 (ownership) となるので)、 どちらの名前が本来のものであるか判別できない。
  88 .SS linkat()
  89 \fBlinkat\fP() システムコールは \fBlink\fP() と全く同様に動作するが、以下で説明する点が異なる。
  90
  91 \fIoldpath\fP で指定されたパス名が相対パスの場合、このパス名はファイルディスクリプター \fIolddirfd\fP
  92 が参照するディレクトリに対する相対パスと解釈される (\fBlink\fP(2)
  93 に相対パス名を渡した場合のように、呼び出したプロセスのカレントワーキングディレクトリに対する相対パスではない)。
  94
  95 \fIoldpath\fP で指定されたパス名が相対パスで、 \fIolddirfd\fP が特別な値 \fBAT_FDCWD\fP の場合、 (\fBlink\fP(2)
  96 と同様に) \fIoldpath\fP は呼び出したプロセスのカレントワーキングディレクトリに対する相対パスと解釈される。
  97
  98 \fIoldpath\fP で指定されたパス名が絶対パスの場合、 \fIolddirfd\fP は無視される。
  99
 100 \fInewpath\fP の解釈は \fIoldpath\fP と同じである。 相対パスのパス名がファイルディスクリプター \fInewdirfd\fP
 101 が参照するディレクトリと解釈される点だけが異なる。
 102
 103 以下の値のビット単位の論理和を \fIflags\fP に指定できる。
 104 .TP
 105 \fBAT_EMPTY_PATH\fP (Linux 2.6.39 以降)
 106 .\" commit 11a7b371b64ef39fc5fb1b6f2218eef7c4d035e3
 107 .\" Before glibc 2.16, defining _ATFILE_SOURCE sufficed
 108 \fIoldpath\fP が空文字列の場合、 \fIolddirfd\fP が参照するファイルへのリンクを作成する (\fIolddirfd\fP は
 109 \fBopen\fP(2) の \fBO_PATH\fP フラグを使って取得する)。 この場合、 \fIolddirfd\fP
 110 はディレクトリ以外の任意の型のファイルを参照することができる。 一般的には、 ファイルのリンクカウントが 0 の場合は、この操作は成功しない (ただし、
 111 \fBO_TMPFILE\fP が指定され \fBO_EXCL\fP を指定せずに作成されたファイルは例外である)。 このフラグを使用するためには、 呼び出し元は
 112 \fBCAP_DAC_READ_SEARCH\fP ケーパビリティを持っていなければならない。 このフラグは Linux 固有で、 この定義を得るには
 113 \fB_GNU_SOURCE\fP を定義すること。
 114 .TP
 115 \fBAT_SYMLINK_FOLLOW\fP (Linux 2.6.18 以降)
 116 \fBlinkat\fP() は (\fBlink\fP() 同様) デフォルトでは \fIoldpath\fP がシンボリックリンクの場合リンクの展開を行わない。
 117 フラグ \fBAT_SYMLINK_FOLLOW\fP を \fIflags\fP に指定することができ、指定した場合 \fIoldpath\fP
 118 がシンボリックリンクの場合リンクの展開が行われる。 procfs がマウントされている場合、これは \fBAT_EMPTY_PATH\fP
 119 の代替として以下のように使うことができる。
 120
 121 .nf
 122 .in +4n
 123 linkat(AT_FDCWD, "/proc/self/fd/<fd>", newdirfd,
 124        newname, AT_SYMLINK_FOLLOW);
 125 .in
 126 .fi
 127 .PP
 128 カーネル 2.6.18 より前では、 \fIflags\fP 引き数は未使用で、 0 を指定しなければならなかった。
 129 .PP
 130 \fBlinkat\fP() の必要性についての説明については \fBopenat\fP(2) を参照。
 131 .SH 返り値
 132 成功した場合は 0 が返される。エラーの場合は \-1 が返され、 \fIerrno\fP が適切に設定される。
 133 .SH エラー
 134 .TP
 135 \fBEACCES\fP
 136 \fInewpath\fP を含んでいるディレクトリへの書き込みが許されていないか、 \fIoldpath\fP または \fInewpath\fP
 137 へのディレクトリのどれかに検索許可がない (\fBpath_resolution\fP(7)  を参照)。
 138 .TP
 139 \fBEDQUOT\fP
 140 ディスクブロックか inode がそのファイルシステムのユーザクォータに達していた。
 141 .TP
 142 \fBEEXIST\fP
 143 \fInewpath\fP が既に存在する。
 144 .TP
 145 \fBEFAULT\fP
 146 \fIoldpath\fP や \fInewpath\fP がアクセス可能なアドレス空間の外を指している。
 147 .TP
 148 \fBEIO\fP
 149 I/O エラーが発生した。
 150 .TP
 151 \fBELOOP\fP
 152 \fIoldpath\fP または \fInewpath\fP を解決する際に遭遇したシンボリックリンクが多過ぎる。
 153 .TP
 154 \fBEMLINK\fP
 155 \fIoldpath\fP によって参照されるファイルは 既に最大数までのリンクを持っている。
 156 .TP
 157 \fBENAMETOOLONG\fP
 158 \fIoldpath\fP または \fInewpath\fP が長過ぎる。
 159 .TP
 160 \fBENOENT\fP
 161 \fIoldpath\fP または \fInewpath\fP のディレクトリ部分が存在しないか、 壊れた(dangling)シンボリックリンクである。
 162 .TP
 163 \fBENOMEM\fP
 164 十分なカーネルメモリーがない。
 165 .TP
 166 \fBENOSPC\fP
 167 そのファイルを含んでいるデバイスに新しいディレクトリエントリを 作成するための空きがない。
 168 .TP
 169 \fBENOTDIR\fP
 170 \fIoldpath\fP または \fInewpath\fP のディレクトリ部分が、実際には、ディレクトリでない。
 171 .TP
 172 \fBEPERM\fP
 173 \fIoldpath\fP がディレクトリである。
 174 .TP
 175 \fBEPERM\fP
 176 \fIoldpath\fP と \fInewpath\fP を含んでいるファイルシステムがハードリンクをサポートしていない。
 177 .TP
 178 \fBEPERM\fP (Linux 3.6 以降)
 179 呼び出し元にこのファイルへのハードリンクを作成する許可がなかった (\fBproc\fP(5) の
 180 \fI/proc/sys/fs/protected_hardlinks\fP の説明を参照)。
 181 .TP
 182 \fBEROFS\fP
 183 ファイルが読み込み専用のファイルシステムに存在する。
 184 .TP
 185 \fBEXDEV\fP
 186 \fIoldpath\fP と \fInewpath\fP が同じマウントされたファイルシステムに存在しない。 (Linux は 1
 187 つのファイルシステムを複数のマウント位置に マウントすることを許可している。 しかし \fBlink\fP()  は、たとえ同じファイルシステムであっても、
 188 別々のマウント位置を跨いでは動作しない。)
 189 .PP
 190 \fBlinkat\fP() では以下のエラーも発生する。
 191 .TP
 192 \fBEBADF\fP
 193 \fIolddirfd\fP か \fInewdirfd\fP が有効なファイルディスクリプタでない。
 194 .TP
 195 \fBEINVAL\fP
 196 無効なフラグ値が \fIflags\fP に指定された。
 197 .TP
 198 \fBENOENT\fP
 199 \fBAT_EMPTY_PATH\fP が \fIflags\fP に指定されたが、呼び出し元が \fBCAP_DAC_READ_SEARCH\fP
 200 ケーパビリティを持っていなかった。
 201 .TP
 202 \fBENOENT\fP
 203 以下の呼び出しで作成されたファイルディスクリプターに対応する \fI/proc/self/fd/NN\fP ファイルに対してリンクを行おおうとした。
 204
 205     open(path, O_TMPFILE | O_EXCL, mode);
 206
 207 \fBopen\fP(2) 参照。
 208 .TP
 209 \fBENOENT\fP
 210 \fIoldpath\fP が相対パス名で、 \fIolddirfd\fP が削除されたディレクトリを参照している。 または、 \fInewpath\fP
 211 が相対パス名で、 \fInewdirfd\fP が削除されたディレクトリを参照している。
 212 .TP
 213 \fBENOTDIR\fP
 214 \fIoldpath\fP が相対パスで、 \fIolddirfd\fP がディレクトリ以外のファイルを参照している。または \fInewpath\fP と
 215 \fInewdirfd\fP に関して同じ状況である。
 216 .TP
 217 \fBEPERM\fP
 218 \fIflags\fP に \fBAT_EMPTY_PATH\fP が指定され、 \fIoldpath\fP が空文字列で、 \fIolddirfd\fP
 219 がディレクトリを参照している。
 220 .SH バージョン
 221 \fBlinkat\fP()  はカーネル 2.6.16 で Linux に追加された。 ライブラリによるサポートはバージョン 2.4 で glibc
 222 に追加された。
 223 .SH 準拠
 224 .\" SVr4 documents additional ENOLINK and
 225 .\" EMULTIHOP error conditions; POSIX.1 does not document ELOOP.
 226 .\" X/OPEN does not document EFAULT, ENOMEM or EIO.
 227 \fBlink\fP(): SVr4, 4.3BSD, POSIX.1\-2001 (但し「注意」を参照), POSIX.1\-2008.
 228
 229 \fBlinkat\fP(): POSIX.1\-2008.
 230 .SH 注意
 231 \fBlink\fP()  でファイルシステムを超えてハードリンクを作成することはできない。 このような場合は \fBsymlink\fP(2)  を使用すること。
 232
 233 .\" more precisely: since kernel 1.3.56
 234 .\" For example, the default Solaris compilation environment
 235 .\" behaves like Linux, and contributors to a March 2005
 236 .\" thread in the Austin mailing list reported that some
 237 .\" other (System V) implementations did/do the same -- MTK, Apr 05
 238 POSIX.1\-2001 では、 \fIoldpath\fP がシンボリックリンクである場合、 \fBlink\fP()  は \fIoldpath\fP
 239 の参照を解決すべきであると記述されている。 しかし、カーネル 2.0 以降の Linux ではそのようになっていない。 \fIoldpath\fP
 240 がシンボリックリンクである場合、 \fInewpath\fP は同じシンボリックリンクファイルへの (ハード) リンクとして作成される (つまり
 241 \fInewpath\fP は \fIoldpath\fP が参照していた同じファイルへのシンボリックリンクになる)。 他のいくつかの実装でも Linux
 242 と同じように動作する。 POSIX.1\-2008 では \fBlink\fP()  の仕様が変更され、 \fIoldpath\fP
 243 がシンボリックリンクの場合にシンボリックリンクの参照を 解決するかどうかは実装依存となった。
 244 リンク作成時のシンボリックリンクの扱いについての詳細な制御を行う場合には \fBlinkat\fP(2) を使用すること。
 245 .SS "glibc での注意"
 246 \fBlinkat\fP() が利用できない古いカーネルでは、 \fBAT_SYMLINK_FOLLOW\fP が指定されていない場合、 glibc ラッパー関数は
 247 \fBlink\fP() を使用するモードにフォールバックする。 \fIoldpath\fP と \fInewpath\fP が相対パスの場合、 glibc は
 248 \fIolddirfd\fP と \fInewdirfd\fP 引き数に対応する \fI/proc/self/fd\fP
 249 のシンボリックリンクに基づいてそれぞれパス名を構成する。
 250 .SH バグ
 251 NFS ファイルシステムでは、NFS サーバーがリンクを作成した後に、 それを伝える前に死んだ場合には返り値が不正な場合がある。
 252 リンクが作成できたかどうか見つけるためには \fBstat\fP(2)  を使用すること。
 253 .SH 関連項目
 254 \fBln\fP(1), \fBopen\fP(2), \fBrename\fP(2), \fBstat\fP(2), \fBsymlink\fP(2), \fBunlink\fP(2),
 255 \fBpath_resolution\fP(7), \fBsymlink\fP(7)
 256 .SH この文書について
 257 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.76 の一部
 258 である。プロジェクトの説明とバグ報告に関する情報は
 259 http://www.kernel.org/doc/man\-pages/ に書かれている。