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. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"     This product includes software developed by the University of
  17 .\"     California, Berkeley and its contributors.
  18 .\" 4. Neither the name of the University nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\"     @(#)utimes.2    8.1 (Berkeley) 6/4/93
  35 .\" $FreeBSD$
  36 .\"
  37 .Dd June 4, 1993
  38 .Dt UTIMES 2
  39 .Os
  40 .Sh NAME
  41 .Nm utimes ,
  42 .Nm lutimes ,
  43 .Nm futimes
  44 .Nd set file access and modification times
  45 .Sh SYNOPSIS
  46 .Fd #include <sys/time.h>
  47 .Ft int
  48 .Fn utimes "const char *path" "const struct timeval *times"
  49 .Ft int
  50 .Fn lutimes "const char *path" "const struct timeval *times"
  51 .Ft int
  52 .Fn futimes "int fd" "const struct timeval *times"
  53 .Sh DESCRIPTION
  54 The access and modification times of the file named by
  55 .Fa path
  56 or referenced by
  57 .Fa fd
  58 are changed as specified by the argument
  59 .Fa times .
  60 .Pp
  61 If
  62 .Fa times
  63 is
  64 .Dv NULL ,
  65 the access and modification times are set to the current time.
  66 The caller must be the owner of the file, have permission to
  67 write the file, or be the super-user.
  68 .Pp
  69 If
  70 .Fa times
  71 is
  72 .Pf non- Dv NULL ,
  73 it is assumed to point to an array of two timeval structures.
  74 The access time is set to the value of the first element, and the
  75 modification time is set to the value of the second element.
  76 The caller must be the owner of the file or be the super-user.
  77 .Pp
  78 In either case, the inode-change-time of the file is set to the current
  79 time.
  80 .Pp
  81 .Fn lutimes
  82 is like
  83 .Fn utimes
  84 except in the case where the named file is a symbolic link,
  85 in which case
  86 .Fn lutimes
  87 changes the access and modification times of the link,
  88 while
  89 .Fn utimes
  90 changes the times of the file the link references.
  91 .Sh RETURN VALUES
  92 Upon successful completion, a value of 0 is returned.
  93 Otherwise, a value of -1 is returned and
  94 .Va errno
  95 is set to indicate the error.
  96 .Sh ERRORS
  97 .Fn utimes
  98 and
  99 .Fn lutimes
 100 will fail if:
 101 .Bl -tag -width Er
 102 .It Bq Er EACCES
 103 Search permission is denied for a component of the path prefix;
 104 or the
 105 .Fa times
 106 argument is
 107 .Dv NULL
 108 and the effective user ID of the process does not
 109 match the owner of the file, and is not the super-user, and write
 110 access is denied.
 111 .It Bq Er EFAULT
 112 .Fa path
 113 or
 114 .Fa times
 115 points outside the process's allocated address space.
 116 .It Bq Er EIO
 117 An I/O error occurred while reading or writing the affected inode.
 118 .It Bq Er ELOOP
 119 Too many symbolic links were encountered in translating the pathname.
 120 .It Bq Er ENAMETOOLONG
 121 A component of a pathname exceeded
 122 .Dv NAME_MAX
 123 characters, or an entire path name exceeded
 124 .Dv PATH_MAX
 125 characters.
 126 .It Bq Er ENOENT
 127 The named file does not exist.
 128 .It Bq Er ENOTDIR
 129 A component of the path prefix is not a directory.
 130 .It Bq Er EPERM
 131 The
 132 .Fa times
 133 argument is not
 134 .Dv NULL
 135 and the calling process's effective user ID
 136 does not match the owner of the file and is not the super-user.
 137 .It Bq Er EROFS
 138 The file system containing the file is mounted read-only.
 139 .El
 140 .Pp
 141 .Fn futimes
 142 will fail if:
 143 .Bl -tag -width Er
 144 .It Bq Er EBADF
 145 .Fa fd
 146 does not refer to a valid descriptor.
 147 .El
 148 .Pp
 149 All of the functions will fail if:
 150 .Bl -tag -width Er
 151 .It Bq Er EACCES
 152 The
 153 .Fa times
 154 argument is
 155 .Dv NULL
 156 and the effective user ID of the process does not
 157 match the owner of the file, and is not the super-user, and write
 158 access is denied.
 159 .It Bq Er EFAULT
 160 .Fa times
 161 points outside the process's allocated address space.
 162 .It Bq Er EIO
 163 An I/O error occurred while reading or writing the affected inode.
 164 .It Bq Er EPERM
 165 The
 166 .Fa times
 167 argument is not
 168 .Dv NULL
 169 and the calling process's effective user ID
 170 does not match the owner of the file and is not the super-user.
 171 .It Bq Er EROFS
 172 The file system containing the file is mounted read-only.
 173 .El
 174 .Sh SEE ALSO
 175 .Xr stat 2 ,
 176 .Xr utime 3
 177 .Sh HISTORY
 178 The
 179 .Fn utimes
 180 function call appeared in
 181 .Bx 4.2 .
 182 The
 183 .Fn futimes
 184 and
 185 .Fn lutimes
 186 function calls first appeared in
 187 .Fx 3.0 .