lib/libc/sys/utimes.2

   1 .\"     $NetBSD: utimes.2,v 1.13 1999/03/22 19:45:11 garbled Exp $
   2 .\"
   3 .\" Copyright (c) 1990, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 4. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)utimes.2    8.1 (Berkeley) 6/4/93
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd July 3, 2014
  34 .Dt UTIMES 2
  35 .Os
  36 .Sh NAME
  37 .Nm utimes ,
  38 .Nm lutimes ,
  39 .Nm futimes ,
  40 .Nm futimesat
  41 .Nd set file access and modification times
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In sys/time.h
  46 .Ft int
  47 .Fn utimes "const char *path" "const struct timeval *times"
  48 .Ft int
  49 .Fn lutimes "const char *path" "const struct timeval *times"
  50 .Ft int
  51 .Fn futimes "int fd" "const struct timeval *times"
  52 .Ft int
  53 .Fn futimesat "int fd" "const char *path" "const struct timeval times[2]"
  54 .Sh DESCRIPTION
  55 The access and modification times of the file named by
  56 .Fa path
  57 or referenced by
  58 .Fa fd
  59 are changed as specified by the argument
  60 .Fa times .
  61 .Pp
  62 If
  63 .Fa times
  64 is
  65 .Dv NULL ,
  66 the access and modification times are set to the current time.
  67 The caller must be the owner of the file, have permission to
  68 write the file, or be the super-user.
  69 .Pp
  70 If
  71 .Fa times
  72 is
  73 .No non- Ns Dv NULL ,
  74 it is assumed to point to an array of two timeval structures.
  75 The access time is set to the value of the first element, and the
  76 modification time is set to the value of the second element.
  77 For file systems that support file birth (creation) times (such as
  78 .Dv UFS2 ) ,
  79 the birth time will be set to the value of the second element
  80 if the second element is older than the currently set birth time.
  81 To set both a birth time and a modification time,
  82 two calls are required; the first to set the birth time
  83 and the second to set the (presumably newer) modification time.
  84 Ideally a new system call will be added that allows the setting
  85 of all three times at once.
  86 The caller must be the owner of the file or be the super-user.
  87 .Pp
  88 In either case, the inode-change-time of the file is set to the current
  89 time.
  90 .Pp
  91 The
  92 .Fn lutimes
  93 system call
  94 is like
  95 .Fn utimes
  96 except in the case where the named file is a symbolic link,
  97 in which case
  98 .Fn lutimes
  99 changes the access and modification times of the link,
 100 while
 101 .Fn utimes
 102 changes the times of the file the link references.
 103 .Pp
 104 The
 105 .Fn futimesat
 106 system call is equivalent to
 107 .Fn utimes
 108 except in the case where
 109 .Fa path
 110 specifies a relative path.
 111 In this case the access and modification time
 112 is set to that of a file relative to the directory associated with the file
 113 descriptor
 114 .Fa fd
 115 instead of the current working directory.
 116 If
 117 .Fn futimesat
 118 is passed the special value
 119 .Dv AT_FDCWD
 120 in the
 121 .Fa fd
 122 parameter, the current working directory is used and the behavior
 123 is identical to a call to
 124 .Fn utimes .
 125 .Sh RETURN VALUES
 126 .Rv -std
 127 .Sh ERRORS
 128 All of the system call will fail if:
 129 .Bl -tag -width Er
 130 .It Bq Er EACCES
 131 Search permission is denied for a component of the path prefix.
 132 .It Bq Er EACCES
 133 The
 134 .Fa times
 135 argument is
 136 .Dv NULL
 137 and the effective user ID of the process does not
 138 match the owner of the file, and is not the super-user, and write
 139 access is denied.
 140 .It Bq Er EFAULT
 141 The
 142 .Fa path
 143 or
 144 .Fa times
 145 argument
 146 points outside the process's allocated address space.
 147 .It Bq Er EFAULT
 148 The
 149 .Fa times
 150 argument
 151 points outside the process's allocated address space.
 152 .It Bq Er EINVAL
 153 The
 154 .Va tv_usec
 155 component of at least one of the values specified by the
 156 .Fa times
 157 argument has a value less than 0 or greater than 999999.
 158 .It Bq Er EIO
 159 An I/O error occurred while reading or writing the affected inode.
 160 .It Bq Er ELOOP
 161 Too many symbolic links were encountered in translating the pathname.
 162 .It Bq Er ENAMETOOLONG
 163 A component of a pathname exceeded
 164 .Dv NAME_MAX
 165 characters, or an entire path name exceeded
 166 .Dv PATH_MAX
 167 characters.
 168 .It Bq Er ENOENT
 169 The named file does not exist.
 170 .It Bq Er ENOTDIR
 171 A component of the path prefix is not a directory.
 172 .It Bq Er EPERM
 173 The
 174 .Fa times
 175 argument is not
 176 .Dv NULL
 177 and the calling process's effective user ID
 178 does not match the owner of the file and is not the super-user.
 179 .It Bq Er EPERM
 180 The named file has its immutable or append-only flags set.
 181 See the
 182 .Xr chflags 2
 183 manual page for more information.
 184 .It Bq Er EROFS
 185 The file system containing the file is mounted read-only.
 186 .El
 187 .Pp
 188 The
 189 .Fn futimes
 190 system call
 191 will fail if:
 192 .Bl -tag -width Er
 193 .It Bq Er EBADF
 194 The
 195 .Fa fd
 196 argument
 197 does not refer to a valid descriptor.
 198 .El
 199 .Pp
 200 In addition to the errors returned by the
 201 .Fn utimes ,
 202 the
 203 .Fn futimesat
 204 may fail if:
 205 .Bl -tag -width Er
 206 .It Bq Er EBADF
 207 The
 208 .Fa path
 209 argument does not specify an absolute path and the
 210 .Fa fd
 211 argument is neither
 212 .Dv AT_FDCWD
 213 nor a valid file descriptor open for searching.
 214 .It Bq Er ENOTDIR
 215 The
 216 .Fa path
 217 argument is not an absolute path and
 218 .Fa fd
 219 is neither
 220 .Dv AT_FDCWD
 221 nor a file descriptor associated with a directory.
 222 .El
 223 .Sh SEE ALSO
 224 .Xr chflags 2 ,
 225 .Xr stat 2 ,
 226 .Xr utime 3
 227 .Sh STANDARDS
 228 The
 229 .Fn utimes
 230 function is expected to conform to
 231 .St -xpg4.2 .
 232 The
 233 .Fn futimesat
 234 system call follows The Open Group Extended API Set 2 specification.
 235 .Sh HISTORY
 236 The
 237 .Fn utimes
 238 system call appeared in
 239 .Bx 4.2 .
 240 The
 241 .Fn futimes
 242 and
 243 .Fn lutimes
 244 system calls first appeared in
 245 .Fx 3.0 .
 246 The
 247 .Fn futimesat
 248 system call appeared in
 249 .Fx 8.0 .