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