original/man2/futimesat.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 FUTIMESAT 2 2012-03-25 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 futimesat \- change timestamps of a file relative to a \
  29 directory file descriptor
  30 .SH SYNOPSIS
  31 .nf
  32 .B #include <fcntl.h>           /* Definition of AT_* constants */
  33 .B #include <sys/time.h>
  34 .sp
  35 .BI "int futimesat(int " dirfd ", const char *" pathname ,
  36 .BI "              const struct timeval " times [2]);
  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 futimesat ():
  45 _GNU_SOURCE
  46 .SH DESCRIPTION
  47 This system call is obsolete.
  48 Use
  49 .BR utimensat (2)
  50 instead.
  51
  52 The
  53 .BR futimesat ()
  54 system call operates in exactly the same way as
  55 .BR utimes (2),
  56 except for the differences described in this manual page.
  57
  58 If the pathname given in
  59 .I pathname
  60 is relative, then it is interpreted relative to the directory
  61 referred to by the file descriptor
  62 .I dirfd
  63 (rather than relative to the current working directory of
  64 the calling process, as is done by
  65 .BR utimes (2)
  66 for a relative pathname).
  67
  68 If
  69 .I pathname
  70 is relative and
  71 .I dirfd
  72 is the special value
  73 .BR AT_FDCWD ,
  74 then
  75 .I pathname
  76 is interpreted relative to the current working
  77 directory of the calling process (like
  78 .BR utimes (2)).
  79
  80 If
  81 .I pathname
  82 is absolute, then
  83 .I dirfd
  84 is ignored.
  85 .SH "RETURN VALUE"
  86 On success,
  87 .BR futimesat ()
  88 returns a 0.
  89 On error, \-1 is returned and
  90 .I errno
  91 is set to indicate the error.
  92 .SH ERRORS
  93 The same errors that occur for
  94 .BR utimes (2)
  95 can also occur for
  96 .BR futimesat ().
  97 The following additional errors can occur for
  98 .BR futimesat ():
  99 .TP
 100 .B EBADF
 101 .I dirfd
 102 is not a valid file descriptor.
 103 .TP
 104 .B ENOTDIR
 105 .I pathname
 106 is relative and
 107 .I dirfd
 108 is a file descriptor referring to a file other than a directory.
 109 .SH VERSIONS
 110 .BR futimesat ()
 111 was added to Linux in kernel 2.6.16.
 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)