original/man2/linkat.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 .\" FIXME: Linux 2.6.39 added AT_EMPTY_PATH
  26 .\"
  27 .TH LINKAT 2 2009-12-13 "Linux" "Linux Programmer's Manual"
  28 .SH NAME
  29 linkat \- create a file link relative to directory file descriptors
  30 .SH SYNOPSIS
  31 .nf
  32 .B #include <fcntl.h>           /* Definition of AT_* constants */
  33 .B #include <unistd.h>
  34 .sp
  35 .BI "int linkat(int " olddirfd ", const char *" oldpath ,
  36 .BI "           int " newdirfd ", const char *" newpath ", int " flags );
  37 .fi
  38 .sp
  39 .in -4n
  40 Feature Test Macro Requirements for glibc (see
  41 .BR feature_test_macros (7)):
  42 .in
  43 .sp
  44 .BR linkat ():
  45 .PD 0
  46 .ad l
  47 .RS 4
  48 .TP 4
  49 Since glibc 2.10:
  50 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  51 .TP
  52 Before glibc 2.10:
  53 _ATFILE_SOURCE
  54 .RE
  55 .ad
  56 .PD
  57 .SH DESCRIPTION
  58 The
  59 .BR linkat ()
  60 system call operates in exactly the same way as
  61 .BR link (2),
  62 except for the differences described in this manual page.
  63
  64 If the pathname given in
  65 .I oldpath
  66 is relative, then it is interpreted relative to the directory
  67 referred to by the file descriptor
  68 .I olddirfd
  69 (rather than relative to the current working directory of
  70 the calling process, as is done by
  71 .BR link (2)
  72 for a relative pathname).
  73
  74 If
  75 .I oldpath
  76 is relative and
  77 .I olddirfd
  78 is the special value
  79 .BR AT_FDCWD ,
  80 then
  81 .I oldpath
  82 is interpreted relative to the current working
  83 directory of the calling process (like
  84 .BR link (2)).
  85
  86 If
  87 .I oldpath
  88 is absolute, then
  89 .I olddirfd
  90 is ignored.
  91
  92 The interpretation of
  93 .I newpath
  94 is as for
  95 .IR oldpath ,
  96 except that a relative pathname is interpreted relative
  97 to the directory referred to by the file descriptor
  98 .IR newdirfd .
  99
 100 By default,
 101 .BR linkat (),
 102 does not dereference
 103 .I oldpath
 104 if it is a symbolic link (like
 105 .BR link (2)).
 106 Since Linux 2.6.18, the flag
 107 .B AT_SYMLINK_FOLLOW
 108 can be specified in
 109 .I flags
 110 to cause
 111 .I oldpath
 112 to be dereferenced if it is a symbolic link.
 113 Before kernel 2.6.18, the
 114 .I flags
 115 argument was unused, and had to be specified as 0.
 116 .SH "RETURN VALUE"
 117 On success,
 118 .BR linkat ()
 119 returns 0.
 120 On error, \-1 is returned and
 121 .I errno
 122 is set to indicate the error.
 123 .SH ERRORS
 124 The same errors that occur for
 125 .BR link (2)
 126 can also occur for
 127 .BR linkat ().
 128 The following additional errors can occur for
 129 .BR linkat ():
 130 .TP
 131 .B EBADF
 132 .I olddirfd
 133 or
 134 .I newdirfd
 135 is not a valid file descriptor.
 136 .TP
 137 .B ENOTDIR
 138 .I oldpath
 139 is relative and
 140 .I olddirfd
 141 is a file descriptor referring to a file other than a directory;
 142 or similar for
 143 .I newpath
 144 and
 145 .I newdirfd
 146 .SH VERSIONS
 147 .BR linkat ()
 148 was added to Linux in kernel 2.6.16.
 149 .SH "CONFORMING TO"
 150 POSIX.1-2008.
 151 .SH NOTES
 152 See
 153 .BR openat (2)
 154 for an explanation of the need for
 155 .BR linkat ().
 156 .SH "SEE ALSO"
 157 .BR link (2),
 158 .BR openat (2),
 159 .BR path_resolution (7),
 160 .BR symlink (7)