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 .\" 3. 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 March 30, 2020
  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 .Bf -symbolic
  56 These interfaces are obsoleted by
  57 .Xr futimens 2
  58 and
  59 .Xr utimensat 2
  60 because they are not accurate to nanoseconds.
  61 .Ef
  62 .Pp
  63 The access and modification times of the file named by
  64 .Fa path
  65 or referenced by
  66 .Fa fd
  67 are changed as specified by the argument
  68 .Fa times .
  69 .Pp
  70 If
  71 .Fa times
  72 is
  73 .Dv NULL ,
  74 the access and modification times are set to the current time.
  75 The caller must be the owner of the file, have permission to
  76 write the file, or be the super-user.
  77 .Pp
  78 If
  79 .Fa times
  80 is
  81 .No non- Ns Dv NULL ,
  82 it is assumed to point to an array of two timeval structures.
  83 The access time is set to the value of the first element, and the
  84 modification time is set to the value of the second element.
  85 For file systems that support file birth (creation) times (such as
  86 .Dv UFS2 ) ,
  87 the birth time will be set to the value of the second element
  88 if the second element is older than the currently set birth time.
  89 To set both a birth time and a modification time,
  90 two calls are required; the first to set the birth time
  91 and the second to set the (presumably newer) modification time.
  92 Ideally a new system call will be added that allows the setting
  93 of all three times at once.
  94 The caller must be the owner of the file or be the super-user.
  95 .Pp
  96 In either case, the inode-change-time of the file is set to the current
  97 time.
  98 .Pp
  99 The
 100 .Fn lutimes
 101 system call
 102 is like
 103 .Fn utimes
 104 except in the case where the named file is a symbolic link,
 105 in which case
 106 .Fn lutimes
 107 changes the access and modification times of the link,
 108 while
 109 .Fn utimes
 110 changes the times of the file the link references.
 111 .Pp
 112 The
 113 .Fn futimesat
 114 system call is equivalent to
 115 .Fn utimes
 116 except in the case where
 117 .Fa path
 118 specifies a relative path.
 119 In this case the access and modification time
 120 is set to that of a file relative to the directory associated with the file
 121 descriptor
 122 .Fa fd
 123 instead of the current working directory.
 124 If
 125 .Fn futimesat
 126 is passed the special value
 127 .Dv AT_FDCWD
 128 in the
 129 .Fa fd
 130 parameter, the current working directory is used and the behavior
 131 is identical to a call to
 132 .Fn utimes .
 133 .Sh RETURN VALUES
 134 .Rv -std
 135 .Sh ERRORS
 136 All of the system call will fail if:
 137 .Bl -tag -width Er
 138 .It Bq Er EACCES
 139 Search permission is denied for a component of the path prefix.
 140 .It Bq Er EACCES
 141 The
 142 .Fa times
 143 argument is
 144 .Dv NULL
 145 and the effective user ID of the process does not
 146 match the owner of the file, and is not the super-user, and write
 147 access is denied.
 148 .It Bq Er EFAULT
 149 The
 150 .Fa path
 151 or
 152 .Fa times
 153 argument
 154 points outside the process's allocated address space.
 155 .It Bq Er EFAULT
 156 The
 157 .Fa times
 158 argument
 159 points outside the process's allocated address space.
 160 .It Bq Er EINVAL
 161 The
 162 .Va tv_usec
 163 component of at least one of the values specified by the
 164 .Fa times
 165 argument has a value less than 0 or greater than 999999.
 166 .It Bq Er EIO
 167 An I/O error occurred while reading or writing the affected inode.
 168 .It Bq Er EINTEGRITY
 169 Corrupted data was detected while reading from the file system.
 170 .It Bq Er ELOOP
 171 Too many symbolic links were encountered in translating the pathname.
 172 .It Bq Er ENAMETOOLONG
 173 A component of a pathname exceeded
 174 .Dv NAME_MAX
 175 characters, or an entire path name exceeded
 176 .Dv PATH_MAX
 177 characters.
 178 .It Bq Er ENOENT
 179 The named file does not exist.
 180 .It Bq Er ENOTDIR
 181 A component of the path prefix is not a directory.
 182 .It Bq Er EPERM
 183 The
 184 .Fa times
 185 argument is not
 186 .Dv NULL
 187 and the calling process's effective user ID
 188 does not match the owner of the file and is not the super-user.
 189 .It Bq Er EPERM
 190 The named file has its immutable or append-only flags set.
 191 See the
 192 .Xr chflags 2
 193 manual page for more information.
 194 .It Bq Er EROFS
 195 The file system containing the file is mounted read-only.
 196 .El
 197 .Pp
 198 The
 199 .Fn futimes
 200 system call
 201 will fail if:
 202 .Bl -tag -width Er
 203 .It Bq Er EBADF
 204 The
 205 .Fa fd
 206 argument
 207 does not refer to a valid descriptor.
 208 .El
 209 .Pp
 210 In addition to the errors returned by the
 211 .Fn utimes ,
 212 the
 213 .Fn futimesat
 214 may fail if:
 215 .Bl -tag -width Er
 216 .It Bq Er EBADF
 217 The
 218 .Fa path
 219 argument does not specify an absolute path and the
 220 .Fa fd
 221 argument is neither
 222 .Dv AT_FDCWD
 223 nor a valid file descriptor open for searching.
 224 .It Bq Er ENOTDIR
 225 The
 226 .Fa path
 227 argument is not an absolute path and
 228 .Fa fd
 229 is neither
 230 .Dv AT_FDCWD
 231 nor a file descriptor associated with a directory.
 232 .El
 233 .Sh SEE ALSO
 234 .Xr chflags 2 ,
 235 .Xr stat 2 ,
 236 .Xr utimensat 2 ,
 237 .Xr utime 3
 238 .Sh STANDARDS
 239 The
 240 .Fn utimes
 241 function is expected to conform to
 242 .St -xpg4.2 .
 243 The
 244 .Fn futimesat
 245 system call follows The Open Group Extended API Set 2 specification
 246 but was replaced by
 247 .Fn utimensat
 248 in
 249 .St -p1003.1-2008 .
 250 .Sh HISTORY
 251 The
 252 .Fn utimes
 253 system call appeared in
 254 .Bx 4.2 .
 255 The
 256 .Fn futimes
 257 and
 258 .Fn lutimes
 259 system calls first appeared in
 260 .Fx 3.0 .
 261 The
 262 .Fn futimesat
 263 system call appeared in
 264 .Fx 8.0 .