xref: /netbsd-src/lib/libc/sys/utimes.2 (revision ae9172d6cd9432a6a1a56760d86b32c57a66c39c)
1.\" Copyright (c) 1990 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)utimes.2	6.7 (Berkeley) 4/19/91
33.\"
34.Dd April 19, 1991
35.Dt UTIMES 2
36.Os BSD 4
37.Sh NAME
38.Nm utimes
39.Nd set file access and modification times
40.Sh SYNOPSIS
41.Fd #include <sys/time.h>
42.Ft int
43.Fn utimes "const char *file" "const struct timeval *times"
44.Sh DESCRIPTION
45The
46.Fn utimes
47function sets the access and modification times of the named.
48.Pp
49If
50.Fa times
51is
52.Dv NULL ,
53the access and modification times are set to the current time.
54The caller must be the owner of the file, have permission to
55write the file, or be the super-user.
56.Pp
57If
58.Fa times
59is
60.Pf non- Dv NULL ,
61it is assumed to point to an array of two timeval structures.
62The access time is set to the value of the first element, and the
63modification time is set to the value of the second element.
64The caller must be the owner of the file or be the super-user.
65.Pp
66In either case, the inode-change-time of the file is set to the current
67time.
68.Sh RETURN VALUES
69Upon successful completion, a value of 0 is returned.
70Otherwise, a value of -1 is returned and
71.Va errno
72is set to indicate the error.
73.Sh ERRORS
74.Fn Utimes
75will fail if:
76.Bl -tag -width Er
77.It Bq Er EACCES
78Search permission is denied for a component of the path prefix;
79or the
80.Fa times
81argument is
82.Dv NULL
83and the effective user ID of the process does not
84match the owner of the file, and is not the super-user, and write
85access is denied.
86.It Bq Er EFAULT
87.Xr File
88or
89.Fa times
90points outside the process's allocated address space.
91.It Bq Er EIO
92An I/O error occurred while reading or writing the affected inode.
93.It Bq Er ELOOP
94Too many symbolic links were encountered in translating the pathname.
95.It Bq Er ENAMETOOLONG
96A component of a pathname exceeded
97.Dv {NAME_MAX}
98characters, or an entire path name exceeded
99.Dv {PATH_MAX}
100characters.
101.It Bq Er ENOENT
102The named file does not exist.
103.It Bq Er ENOTDIR
104A component of the path prefix is not a directory.
105.It Bq Er EPERM
106The
107.Fa times
108argument is not
109.Dv NULL
110and the calling process's effective user ID
111does not match the owner of the file and is not the super-user.
112.It Bq Er EROFS
113The file system containing the file is mounted read-only.
114.El
115.Sh SEE ALSO
116.Xr stat 2 ,
117.Xr utime 3
118.Sh HISTORY
119The
120.Fn utimes
121function call appeared in
122.Bx 4.2 .
123