xref: /freebsd/lib/libc/gen/utime.3 (revision 4b9d6057)
1.\" Copyright (c) 1980, 1991, 1993
2.\"	The Regents of the University of California.  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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd June 9, 2016
29.Dt UTIME 3
30.Os
31.Sh NAME
32.Nm utime
33.Nd set file times
34.Sh LIBRARY
35.Lb libc
36.Sh SYNOPSIS
37.In utime.h
38.Ft int
39.Fn utime "const char *file" "const struct utimbuf *timep"
40.Sh DESCRIPTION
41.Bf -symbolic
42This interface is obsoleted by
43.Xr utimensat 2
44because it is not accurate to fractions of a second.
45.Ef
46.Pp
47The
48.Fn utime
49function sets the access and modification times of the named file from
50the
51.Va actime
52and
53.Va modtime
54fields of the
55.Vt "struct utimbuf"
56pointed at by
57.Fa timep .
58.Pp
59If the times are specified (the
60.Fa timep
61argument is
62.Pf non- Dv NULL )
63the caller must be the owner of the file or be the super-user.
64.Pp
65If the times are not specified (the
66.Fa timep
67argument is
68.Dv NULL )
69the caller must be the owner of the file, have permission to write
70the file, or be the super-user.
71.Sh ERRORS
72The
73.Fn utime
74function may fail and set
75.Va errno
76for any of the errors specified for the library function
77.Xr utimes 2 .
78.Sh SEE ALSO
79.Xr stat 2 ,
80.Xr utimensat 2 ,
81.Xr utimes 2
82.Sh STANDARDS
83The
84.Fn utime
85function conforms to
86.St -p1003.1-88 .
87.Sh HISTORY
88A
89.Fn utime
90function appeared in
91.At v7 .
92