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