original/man2/futimesat.2

   1 .\" This manpage is Copyright (C) 2006, Michael Kerrisk
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .TH FUTIMESAT 2 2012-05-10 "Linux" "Linux Programmer's Manual"
  26 .SH NAME
  27 futimesat \- change timestamps of a file relative to a \
  28 directory file descriptor
  29 .SH SYNOPSIS
  30 .nf
  31 .B #include <fcntl.h>           /* Definition of AT_* constants */
  32 .B #include <sys/time.h>
  33 .sp
  34 .BI "int futimesat(int " dirfd ", const char *" pathname ,
  35 .BI "              const struct timeval " times [2]);
  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 futimesat ():
  44 _GNU_SOURCE
  45 .SH DESCRIPTION
  46 This system call is obsolete.
  47 Use
  48 .BR utimensat (2)
  49 instead.
  50
  51 The
  52 .BR futimesat ()
  53 system call operates in exactly the same way as
  54 .BR utimes (2),
  55 except for the differences described in this manual page.
  56
  57 If the pathname given in
  58 .I pathname
  59 is relative, then it is interpreted relative to the directory
  60 referred to by the file descriptor
  61 .I dirfd
  62 (rather than relative to the current working directory of
  63 the calling process, as is done by
  64 .BR utimes (2)
  65 for a relative pathname).
  66
  67 If
  68 .I pathname
  69 is relative and
  70 .I dirfd
  71 is the special value
  72 .BR AT_FDCWD ,
  73 then
  74 .I pathname
  75 is interpreted relative to the current working
  76 directory of the calling process (like
  77 .BR utimes (2)).
  78
  79 If
  80 .I pathname
  81 is absolute, then
  82 .I dirfd
  83 is ignored.
  84 .SH RETURN VALUE
  85 On success,
  86 .BR futimesat ()
  87 returns a 0.
  88 On error, \-1 is returned and
  89 .I errno
  90 is set to indicate the error.
  91 .SH ERRORS
  92 The same errors that occur for
  93 .BR utimes (2)
  94 can also occur for
  95 .BR futimesat ().
  96 The following additional errors can occur for
  97 .BR futimesat ():
  98 .TP
  99 .B EBADF
 100 .I dirfd
 101 is not a valid file descriptor.
 102 .TP
 103 .B ENOTDIR
 104 .I pathname
 105 is relative and
 106 .I dirfd
 107 is a file descriptor referring to a file other than a directory.
 108 .SH VERSIONS
 109 .BR futimesat ()
 110 was added to Linux in kernel 2.6.16;
 111 library support was added to glibc in version 2.4.
 112 .SH CONFORMING TO
 113 This system call is nonstandard.
 114 It was implemented from a specification that was proposed for POSIX.1,
 115 but that specification was replaced by the one for
 116 .BR utimensat (2).
 117
 118 A similar system call exists on Solaris.
 119 .SH NOTES
 120 .SS Glibc notes
 121 If
 122 .I pathname
 123 is NULL, then the glibc
 124 .BR futimesat ()
 125 wrapper function updates the times for the file referred to by
 126 .IR dirfd .
 127 .\" The Solaris futimesat() also has this strangeness.
 128 .SH SEE ALSO
 129 .BR stat (2),
 130 .BR utimensat (2),
 131 .BR utimes (2),
 132 .BR futimes (3),
 133 .BR path_resolution (7)
 134 .SH COLOPHON
 135 This page is part of release 3.79 of the Linux
 136 .I man-pages
 137 project.
 138 A description of the project,
 139 information about reporting bugs,
 140 and the latest version of this page,
 141 can be found at
 142 \%http://www.kernel.org/doc/man\-pages/.