release/man2/symlinkat.2

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" This manpage is Copyright (C) 2006, Michael Kerrisk
   4 .\"
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .\" Japanese Version Copyright (c) 2006 Yuichi SATO
  26 .\"         all rights reserved.
  27 .\" Translated 2006-08-29 by Yuichi SATO <ysato444@yahoo.co.jp>, LDP v2.39
  28 .\"
  29 .TH SYMLINKAT 2 2009-12-13 "Linux" "Linux Programmer's Manual"
  30 .SH 名前
  31 symlinkat \- ディレクトリファイルディスクリプタから相対的な位置にシンボリックリンクを作成する
  32 .SH 書式
  33 .nf
  34 .B #include <fcntl.h>           /* AT_* 定数の定義 */
  35 .B #include <stdio.h>
  36 .sp
  37 .BI "int symlinkat(const char *" oldpath ", int " newdirfd \
  38 ", const char *" newpath );
  39 .fi
  40 .sp
  41 .in -4n
  42 glibc 向けの機能検査マクロの要件
  43 .RB ( feature_test_macros (7)
  44 参照):
  45 .in
  46 .sp
  47 .BR symlinkat ():
  48 .PD 0
  49 .ad l
  50 .RS 4
  51 .TP 4
  52 Since glibc 2.10 以降:
  53 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  54 .TP
  55 glibc 2.10 より前:
  56 _ATFILE_SOURCE
  57 .RE
  58 .ad
  59 .PD
  60 .SH 説明
  61 .BR symlinkat ()
  62 システムコールは、この man ページで説明している違いがある以外は、
  63 .BR symlink (2)
  64 と全く同じように動作する。
  65
  66 .I newpath
  67 で指定されるパス名が相対パスである場合、
  68 ファイルディスクリプタ
  69 .I newdirfd
  70 で参照されるディレクトリからの相対パス名として解釈される
  71 .RB ( symlink (2)
  72 では、相対パスは呼び出し元プロセスの
  73 カレントワーキングディレクトリからの相対パスとなる)。
  74
  75 .I newpath
  76 が相対パスであり、かつ
  77 .I newdirfd
  78 が特別な値
  79 .B AT_FDCWD
  80 である場合、
  81 .I newpath
  82 は
  83 .RB ( symlink (2)
  84 と同じように) 呼び出し元プロセスの
  85 カレントワーキングディレクトリからの相対パス名として解釈される。
  86
  87 .I newpath
  88 が絶対パスである場合、
  89 .I newdirfd
  90 は無視される。
  91 .SH 返り値
  92 成功した場合、
  93 .BR symlinkat ()
  94 は 0 を返す。
  95 エラーの場合、\-1 が返されて、
  96 .I errno
  97 にはエラーを示す値が設定される。
  98 .SH エラー
  99 .BR symlink (2)
 100 と同じエラーが
 101 .BR symlinkat ()
 102 でも起こる。
 103 .BR symlinkat ()
 104 では、その他に以下のエラーが起こる:
 105 .TP
 106 .B EBADF
 107 .I newdirfd
 108 が有効なファイルディスクリプタでない。
 109 .TP
 110 .B ENOTDIR
 111 .I newpath
 112 が相対パスで、かつ
 113 .I newdirfd
 114 がディレクトリ以外のファイルを参照するファイルディスクリプタである。
 115 .SH バージョン
 116 .BR symlinkat ()
 117 は Linux カーネル 2.6.16 で追加された。
 118 .SH 準拠
 119 POSIX.1-2008.
 120 .SH 注意
 121 .BR symlinkat ()
 122 が必要な理由については、
 123 .BR openat (2)
 124 を参照すること。
 125 .SH 関連項目
 126 .BR openat (2),
 127 .BR symlink (2),
 128 .BR path_resolution (7),
 129 .BR symlink (7)