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