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