manual/LDP_man-pages/draft/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 .\"O .SH NAME
  31 .SH Ì¾Á°
  32 .\"O symlinkat \- create a symbolic link relative to a directory file descriptor
  33 symlinkat \- ¥Ç¥£¥ì¥¯¥È¥ê¥Õ¥¡¥¤¥ë¥Ç¥£¥¹¥¯¥ê¥×¥¿¤«¤éÁêÂÐÅª¤Ê°ÌÃÖ¤Ë¥·¥ó¥Ü¥ê¥Ã¥¯¥ê¥ó¥¯¤òºîÀ®¤¹¤ë
  34 .\"O .SH SYNOPSIS
  35 .SH ½ñ¼°
  36 .nf
  37 .\"O .B #include <fcntl.h>           /* Definition of AT_* constants */
  38 .B #include <fcntl.h>           /* AT_* Äê¿ô¤ÎÄêµÁ */
  39 .B #include <stdio.h>
  40 .sp
  41 .BI "int symlinkat(const char *" oldpath ", int " newdirfd \
  42 ", const char *" newpath );
  43 .fi
  44 .sp
  45 .in -4n
  46 .\"O Feature Test Macro Requirements for glibc (see
  47 .\"O .BR feature_test_macros (7)):
  48 glibc ¸þ¤±¤Îµ¡Ç½¸¡ºº¥Þ¥¯¥í¤ÎÍ×·ï
  49 .RB ( feature_test_macros (7)
  50 »²¾È):
  51 .in
  52 .sp
  53 .BR symlinkat ():
  54 .br
  55 .\"O Since glibc 2.10: _XOPEN_SOURCE >= 700 || _POSIX_C_SOURCE >= 200809L
  56 glibc 2.10 °Ê¹ß: _XOPEN_SOURCE >= 700 || _POSIX_C_SOURCE >= 200809L
  57 .br
  58 .\"O Before glibc 2.10:
  59 glibc 2.10 ¤è¤êÁ°:
  60 _ATFILE_SOURCE
  61 .\"O .SH DESCRIPTION
  62 .SH ÀâÌÀ
  63 .\"O The
  64 .\"O .BR symlinkat ()
  65 .\"O system call operates in exactly the same way as
  66 .\"O .BR symlink (2),
  67 .\"O except for the differences described in this manual page.
  68 .BR symlinkat ()
  69 ¥·¥¹¥Æ¥à¥³¡¼¥ë¤Ï¡¢¤³¤Î man ¥Ú¡¼¥¸¤ÇÀâÌÀ¤·¤Æ¤¤¤ë°ã¤¤¤¬¤¢¤ë°Ê³°¤Ï¡¢
  70 .BR symlink (2)
  71 ¤ÈÁ´¤¯Æ±¤¸¤è¤¦¤ËÆ°ºî¤¹¤ë¡£
  72
  73 .\"O If the pathname given in
  74 .\"O .I newpath
  75 .\"O is relative, then it is interpreted relative to the directory
  76 .\"O referred to by the file descriptor
  77 .\"O .I newdirfd
  78 .\"O (rather than relative to the current working directory of
  79 .\"O the calling process, as is done by
  80 .\"O .BR symlink (2)
  81 .\"O for a relative pathname).
  82 .I newpath
  83 ¤Ç»ØÄê¤µ¤ì¤ë¥Ñ¥¹Ì¾¤¬ÁêÂÐ¥Ñ¥¹¤Ç¤¢¤ë¾ì¹ç¡¢
  84 ¥Õ¥¡¥¤¥ë¥Ç¥£¥¹¥¯¥ê¥×¥¿
  85 .I newdirfd
  86 ¤Ç»²¾È¤µ¤ì¤ë¥Ç¥£¥ì¥¯¥È¥ê¤«¤é¤ÎÁêÂÐ¥Ñ¥¹Ì¾¤È¤·¤Æ²ò¼á¤µ¤ì¤ë
  87 .RB ( symlink (2)
  88 ¤Ç¤Ï¡¢ÁêÂÐ¥Ñ¥¹¤Ï¸Æ¤Ó½Ð¤·¸µ¥×¥í¥»¥¹¤Î
  89 ¥«¥ì¥ó¥È¥ï¡¼¥¥ó¥°¥Ç¥£¥ì¥¯¥È¥ê¤«¤é¤ÎÁêÂÐ¥Ñ¥¹¤È¤Ê¤ë)¡£
  90
  91 .\"O If
  92 .\"O .I newpath
  93 .\"O is relative and
  94 .\"O .I newdirfd
  95 .\"O is the special value
  96 .\"O .BR AT_FDCWD ,
  97 .\"O then
  98 .\"O .I newpath
  99 .\"O is interpreted relative to the current working
 100 .\"O directory of the calling process (like
 101 .\"O .BR symlink (2)).
 102 .I newpath
 103 ¤¬ÁêÂÐ¥Ñ¥¹¤Ç¤¢¤ê¡¢¤«¤Ä
 104 .I newdirfd
 105 ¤¬ÆÃÊÌ¤ÊÃÍ
 106 .B AT_FDCWD
 107 ¤Ç¤¢¤ë¾ì¹ç¡¢
 108 .I newpath
 109 ¤Ï
 110 .RB ( symlink (2)
 111 ¤ÈÆ±¤¸¤è¤¦¤Ë) ¸Æ¤Ó½Ð¤·¸µ¥×¥í¥»¥¹¤Î
 112 ¥«¥ì¥ó¥È¥ï¡¼¥¥ó¥°¥Ç¥£¥ì¥¯¥È¥ê¤«¤é¤ÎÁêÂÐ¥Ñ¥¹Ì¾¤È¤·¤Æ²ò¼á¤µ¤ì¤ë¡£
 113
 114 .\"O If
 115 .\"O .I newpath
 116 .\"O is absolute, then
 117 .\"O .I newdirfd
 118 .\"O is ignored.
 119 .I newpath
 120 ¤¬ÀäÂÐ¥Ñ¥¹¤Ç¤¢¤ë¾ì¹ç¡¢
 121 .I newdirfd
 122 ¤ÏÌµ»ë¤µ¤ì¤ë¡£
 123 .\"O .SH "RETURN VALUE"
 124 .SH ÊÖ¤êÃÍ
 125 .\"O On success,
 126 .\"O .BR symlinkat ()
 127 .\"O returns 0.
 128 À®¸ù¤·¤¿¾ì¹ç¡¢
 129 .BR symlinkat ()
 130 ¤Ï 0 ¤òÊÖ¤¹¡£
 131 .\"O On error, \-1 is returned and
 132 .\"O .I errno
 133 .\"O is set to indicate the error.
 134 ¥¨¥é¡¼¤Î¾ì¹ç¡¢\-1 ¤¬ÊÖ¤µ¤ì¤Æ¡¢
 135 .I errno
 136 ¤Ë¤Ï¥¨¥é¡¼¤ò¼¨¤¹ÃÍ¤¬ÀßÄê¤µ¤ì¤ë¡£
 137 .\"O .SH ERRORS
 138 .SH ¥¨¥é¡¼
 139 .\"O The same errors that occur for
 140 .\"O .BR symlink (2)
 141 .\"O can also occur for
 142 .\"O .BR symlinkat ().
 143 .BR symlink (2)
 144 ¤ÈÆ±¤¸¥¨¥é¡¼¤¬
 145 .BR symlinkat ()
 146 ¤Ç¤âµ¯¤³¤ë¡£
 147 .\"O The following additional errors can occur for
 148 .\"O .BR symlinkat ():
 149 .BR symlinkat ()
 150 ¤Ç¤Ï¡¢¤½¤ÎÂ¾¤Ë°Ê²¼¤Î¥¨¥é¡¼¤¬µ¯¤³¤ë:
 151 .TP
 152 .B EBADF
 153 .\"O .I newdirfd
 154 .\"O is not a valid file descriptor.
 155 .I newdirfd
 156 ¤¬Í¸ú¤Ê¥Õ¥¡¥¤¥ë¥Ç¥£¥¹¥¯¥ê¥×¥¿¤Ç¤Ê¤¤¡£
 157 .TP
 158 .B ENOTDIR
 159 .\"O .I newpath
 160 .\"O is relative and
 161 .\"O .I newdirfd
 162 .\"O is a file descriptor referring to a file other than a directory.
 163 .I newpath
 164 ¤¬ÁêÂÐ¥Ñ¥¹¤Ç¡¢¤«¤Ä
 165 .I newdirfd
 166 ¤¬¥Ç¥£¥ì¥¯¥È¥ê°Ê³°¤Î¥Õ¥¡¥¤¥ë¤ò»²¾È¤¹¤ë¥Õ¥¡¥¤¥ë¥Ç¥£¥¹¥¯¥ê¥×¥¿¤Ç¤¢¤ë¡£
 167 .\"O .SH VERSIONS
 168 .SH ¥Ð¡¼¥¸¥ç¥ó
 169 .\"O .BR symlinkat ()
 170 .\"O was added to Linux in kernel 2.6.16.
 171 .BR symlinkat ()
 172 ¤Ï Linux ¥«¡¼¥Í¥ë 2.6.16 ¤ÇÄÉ²Ã¤µ¤ì¤¿¡£
 173 .\"O .SH "CONFORMING TO"
 174 .SH ½àµò
 175 POSIX.1-2008.
 176 .\"O .SH NOTES
 177 .SH Ãí°Õ
 178 .\"O See
 179 .\"O .BR openat (2)
 180 .\"O for an explanation of the need for
 181 .\"O .BR symlinkat ().
 182 .BR symlinkat ()
 183 ¤¬É¬Í×¤ÊÍýÍ³¤Ë¤Ä¤¤¤Æ¤Ï¡¢
 184 .BR openat (2)
 185 ¤ò»²¾È¤¹¤ë¤³¤È¡£
 186 .\"O .SH "SEE ALSO"
 187 .SH ´ØÏ¢¹àÌÜ
 188 .BR openat (2),
 189 .BR symlink (2),
 190 .BR path_resolution (7),
 191 .BR symlink (7)