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 .br
  45 Since glibc 2.10: _XOPEN_SOURCE >= 700 || _POSIX_C_SOURCE >= 200809L
  46 .br
  47 Before glibc 2.10:
  48 _ATFILE_SOURCE
  49 .SH DESCRIPTION
  50 The
  51 .BR linkat ()
  52 system call operates in exactly the same way as
  53 .BR link (2),
  54 except for the differences described in this manual page.
  55
  56 If the pathname given in
  57 .I oldpath
  58 is relative, then it is interpreted relative to the directory
  59 referred to by the file descriptor
  60 .I olddirfd
  61 (rather than relative to the current working directory of
  62 the calling process, as is done by
  63 .BR link (2)
  64 for a relative pathname).
  65
  66 If
  67 .I oldpath
  68 is relative and
  69 .I olddirfd
  70 is the special value
  71 .BR AT_FDCWD ,
  72 then
  73 .I oldpath
  74 is interpreted relative to the current working
  75 directory of the calling process (like
  76 .BR link (2)).
  77
  78 If
  79 .I oldpath
  80 is absolute, then
  81 .I olddirfd
  82 is ignored.
  83
  84 The interpretation of
  85 .I newpath
  86 is as for
  87 .IR oldpath ,
  88 except that a relative pathname is interpreted relative
  89 to the directory referred to by the file descriptor
  90 .IR newdirfd .
  91
  92 By default,
  93 .BR linkat (),
  94 does not dereference
  95 .I oldpath
  96 if it is a symbolic link (like
  97 .BR link (2)).
  98 Since Linux 2.6.18, the flag
  99 .B AT_SYMLINK_FOLLOW
 100 can be specified in
 101 .I flags
 102 to cause
 103 .I oldpath
 104 to be dereferenced if it is a symbolic link.
 105 Before kernel 2.6.18, the
 106 .I flags
 107 argument was unused, and had to be specified as 0.
 108 .SH "RETURN VALUE"
 109 On success,
 110 .BR linkat ()
 111 returns 0.
 112 On error, \-1 is returned and
 113 .I errno
 114 is set to indicate the error.
 115 .SH ERRORS
 116 The same errors that occur for
 117 .BR link (2)
 118 can also occur for
 119 .BR linkat ().
 120 The following additional errors can occur for
 121 .BR linkat ():
 122 .TP
 123 .B EBADF
 124 .I olddirfd
 125 or
 126 .I newdirfd
 127 is not a valid file descriptor.
 128 .TP
 129 .B ENOTDIR
 130 .I oldpath
 131 is relative and
 132 .I olddirfd
 133 is a file descriptor referring to a file other than a directory;
 134 or similar for
 135 .I newpath
 136 and
 137 .I newdirfd
 138 .SH VERSIONS
 139 .BR linkat ()
 140 was added to Linux in kernel 2.6.16.
 141 .SH "CONFORMING TO"
 142 POSIX.1-2008.
 143 .SH NOTES
 144 See
 145 .BR openat (2)
 146 for an explanation of the need for
 147 .BR linkat ().
 148 .SH "SEE ALSO"
 149 .BR link (2),
 150 .BR openat (2),
 151 .BR path_resolution (7),
 152 .BR symlink (7)