lib/libc/sys/utimes.2

   1 .\"     $NetBSD: utimes.2,v 1.26 2010/04/29 17:02:38 jruoho 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 .\"
  32 .Dd April 29, 2010
  33 .Dt UTIMES 2
  34 .Os
  35 .Sh NAME
  36 .Nm utimes ,
  37 .Nm lutimes ,
  38 .Nm futimes
  39 .Nd set file access and modification times
  40 .Sh LIBRARY
  41 .Lb libc
  42 .Sh SYNOPSIS
  43 .In sys/time.h
  44 .Ft int
  45 .Fn utimes "const char *path" "const struct timeval times[2]"
  46 .Ft int
  47 .Fn lutimes "const char *path" "const struct timeval times[2]"
  48 .Ft int
  49 .Fn futimes "int fd" "const struct timeval times[2]"
  50 .Sh DESCRIPTION
  51 The access and modification times of the file named by
  52 .Fa path
  53 or referenced by
  54 .Fa fd
  55 are changed as specified by the argument
  56 .Fa times .
  57 .Pp
  58 If
  59 .Fa times
  60 is
  61 .Dv NULL ,
  62 the access and modification times are set to the current time.
  63 The caller must be the owner of the file, have permission to
  64 write the file, or be the super-user.
  65 .Pp
  66 If
  67 .Fa times
  68 is
  69 .Pf non- Dv NULL ,
  70 it is assumed to point to an array of two timeval structures.
  71 The access time is set to the value of the first element, and the
  72 modification time is set to the value of the second element.
  73 For file systems that support file birth (creation) times (such as
  74 UFS2), the birth time will be set to the value of the second element
  75 if the second element is older than the currently set birth time.
  76 To set both a birth time and a modification time, two calls are
  77 required; the first to set the birth time and the second to set
  78 the (presumably newer) modification time.
  79 Ideally a new system call will be added that allows the setting of
  80 all three times at once.
  81 The caller must be the owner of the file or be the super-user.
  82 .Pp
  83 In either case, the inode-change-time of the file is set to the current
  84 time.
  85 .Pp
  86 .Fn lutimes
  87 is like
  88 .Fn utimes
  89 except in the case where the named file is a symbolic link,
  90 in which case
  91 .Fn lutimes
  92 changes the access and modification times of the link,
  93 while
  94 .Fn utimes
  95 changes the times of the file the link references.
  96 .Sh RETURN VALUES
  97 Upon successful completion, a value of 0 is returned.
  98 Otherwise, a value of \-1 is returned and
  99 .Va errno
 100 is set to indicate the error.
 101 .Sh ERRORS
 102 .Fn utimes
 103 and
 104 .Fn lutimes
 105 will fail if:
 106 .Bl -tag -width Er
 107 .It Bq Er EACCES
 108 Search permission is denied for a component of the path prefix;
 109 or the
 110 .Fa times
 111 argument is
 112 .Dv NULL
 113 and the effective user ID of the process does not
 114 match the owner of the file, and is not the super-user, and write
 115 access is denied.
 116 .It Bq Er EFAULT
 117 .Fa path
 118 or
 119 .Fa times
 120 points outside the process's allocated address space.
 121 .It Bq Er EIO
 122 An I/O error occurred while reading or writing the affected inode.
 123 .It Bq Er ELOOP
 124 Too many symbolic links were encountered in translating the pathname.
 125 .It Bq Er ENAMETOOLONG
 126 A component of a pathname exceeded
 127 .Brq Dv NAME_MAX
 128 characters, or an entire path name exceeded
 129 .Brq Dv PATH_MAX
 130 characters.
 131 .It Bq Er ENOENT
 132 The named file does not exist.
 133 .It Bq Er ENOTDIR
 134 A component of the path prefix is not a directory.
 135 .It Bq Er EPERM
 136 The
 137 .Fa times
 138 argument is not
 139 .Dv NULL
 140 and the calling process's effective user ID
 141 does not match the owner of the file and is not the super-user.
 142 .It Bq Er EROFS
 143 The file system containing the file is mounted read-only.
 144 .El
 145 .Pp
 146 .Fn futimes
 147 will fail if:
 148 .Bl -tag -width Er
 149 .It Bq Er EACCES
 150 The
 151 .Fa times
 152 argument is
 153 .Dv NULL
 154 and the effective user ID of the process does not
 155 match the owner of the file, and is not the super-user, and write
 156 access is denied.
 157 .It Bq Er EBADF
 158 .Fa fd
 159 does not refer to a valid descriptor.
 160 .It Bq Er EFAULT
 161 .Fa times
 162 points outside the process's allocated address space.
 163 .It Bq Er EIO
 164 An I/O error occurred while reading or writing the affected inode.
 165 .It Bq Er EPERM
 166 The
 167 .Fa times
 168 argument is not
 169 .Dv NULL
 170 and the calling process's effective user ID
 171 does not match the owner of the file and is not the super-user.
 172 .It Bq Er EROFS
 173 The file system containing the file is mounted read-only.
 174 .El
 175 .Sh SEE ALSO
 176 .Xr stat 2 ,
 177 .Xr utime 3 ,
 178 .Xr symlink 7
 179 .Sh STANDARDS
 180 The
 181 .Fn utimes
 182 function conforms to
 183 .St -p1003.1-2001 .
 184 It was however marked as legacy in the
 185 .St -p1003.1-2004
 186 revision.
 187 .Sh HISTORY
 188 The
 189 .Fn utimes
 190 function call appeared in
 191 .Bx 4.2 .
 192 The
 193 .Fn futimes
 194 function call appeared in
 195 .Nx 1.2 .
 196 The
 197 .Fn lutimes
 198 function call appeared in
 199 .Nx 1.3 .
 200 Birthtime setting support was added in
 201 .Nx 5.0 .