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: src/lib/libc/sys/utimes.2,v 1.8.2.4 2001/12/14 18:34:02 ru Exp $
  32 .\" $DragonFly: src/lib/libc/sys/utimes.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  33 .\"
  34 .Dd June 4, 1993
  35 .Dt UTIMES 2
  36 .Os
  37 .Sh NAME
  38 .Nm utimes ,
  39 .Nm lutimes ,
  40 .Nm futimes
  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 .Sh DESCRIPTION
  53 The access and modification times of the file named by
  54 .Fa path
  55 or referenced by
  56 .Fa fd
  57 are changed as specified by the argument
  58 .Fa times .
  59 .Pp
  60 If
  61 .Fa times
  62 is
  63 .Dv NULL ,
  64 the access and modification times are set to the current time.
  65 The caller must be the owner of the file, have permission to
  66 write the file, or be the super-user.
  67 .Pp
  68 If
  69 .Fa times
  70 is
  71 .Pf non- Dv NULL ,
  72 it is assumed to point to an array of two timeval structures.
  73 The access time is set to the value of the first element, and the
  74 modification time is set to the value of the second element.
  75 The caller must be the owner of the file or be the super-user.
  76 .Pp
  77 In either case, the inode-change-time of the file is set to the current
  78 time.
  79 .Pp
  80 .Fn lutimes
  81 is like
  82 .Fn utimes
  83 except in the case where the named file is a symbolic link,
  84 in which case
  85 .Fn lutimes
  86 changes the access and modification times of the link,
  87 while
  88 .Fn utimes
  89 changes the times of the file the link references.
  90 .Sh RETURN VALUES
  91 .Rv -std
  92 .Sh ERRORS
  93 .Fn utimes
  94 and
  95 .Fn lutimes
  96 will fail if:
  97 .Bl -tag -width Er
  98 .It Bq Er EACCES
  99 Search permission is denied for a component of the path prefix;
 100 or the
 101 .Fa times
 102 argument is
 103 .Dv NULL
 104 and the effective user ID of the process does not
 105 match the owner of the file, and is not the super-user, and write
 106 access is denied.
 107 .It Bq Er EFAULT
 108 .Fa path
 109 or
 110 .Fa times
 111 points outside the process's allocated address space.
 112 .It Bq Er EIO
 113 An I/O error occurred while reading or writing the affected inode.
 114 .It Bq Er ELOOP
 115 Too many symbolic links were encountered in translating the pathname.
 116 .It Bq Er ENAMETOOLONG
 117 A component of a pathname exceeded
 118 .Dv NAME_MAX
 119 characters, or an entire path name exceeded
 120 .Dv PATH_MAX
 121 characters.
 122 .It Bq Er ENOENT
 123 The named file does not exist.
 124 .It Bq Er ENOTDIR
 125 A component of the path prefix is not a directory.
 126 .It Bq Er EPERM
 127 The
 128 .Fa times
 129 argument is not
 130 .Dv NULL
 131 and the calling process's effective user ID
 132 does not match the owner of the file and is not the super-user.
 133 .It Bq Er EROFS
 134 The file system containing the file is mounted read-only.
 135 .El
 136 .Pp
 137 .Fn futimes
 138 will fail if:
 139 .Bl -tag -width Er
 140 .It Bq Er EBADF
 141 .Fa fd
 142 does not refer to a valid descriptor.
 143 .El
 144 .Pp
 145 All of the functions will fail if:
 146 .Bl -tag -width Er
 147 .It Bq Er EACCES
 148 The
 149 .Fa times
 150 argument is
 151 .Dv NULL
 152 and the effective user ID of the process does not
 153 match the owner of the file, and is not the super-user, and write
 154 access is denied.
 155 .It Bq Er EFAULT
 156 .Fa times
 157 points outside the process's allocated address space.
 158 .It Bq Er EIO
 159 An I/O error occurred while reading or writing the affected inode.
 160 .It Bq Er EPERM
 161 The
 162 .Fa times
 163 argument is not
 164 .Dv NULL
 165 and the calling process's effective user ID
 166 does not match the owner of the file and is not the super-user.
 167 .It Bq Er EROFS
 168 The file system containing the file is mounted read-only.
 169 .El
 170 .Sh SEE ALSO
 171 .Xr stat 2 ,
 172 .Xr utime 3
 173 .Sh HISTORY
 174 The
 175 .Fn utimes
 176 function call appeared in
 177 .Bx 4.2 .
 178 The
 179 .Fn futimes
 180 and
 181 .Fn lutimes
 182 function calls first appeared in
 183 .Fx 3.0 .