xref: /freebsd/lib/libc/gen/utime.3 (revision 8fc257994d0ce2396196d7a06d50d20c8015f4b7)
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.\" 4. 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.\"     @(#)utime.3	8.1 (Berkeley) 6/4/93
29.\" $FreeBSD$
30.\"
31.Dd June 4, 1993
32.Dt UTIME 3
33.Os
34.Sh NAME
35.Nm utime
36.Nd set file times
37.Sh LIBRARY
38.Lb libc
39.Sh SYNOPSIS
40.In utime.h
41.Ft int
42.Fn utime "const char *file" "const struct utimbuf *timep"
43.Sh DESCRIPTION
44.Bf -symbolic
45This interface is obsoleted by
46.Xr utimes 2 .
47.Ef
48.Pp
49The
50.Fn utime
51function sets the access and modification times of the named file from
52the
53.Va actime
54and
55.Va modtime
56fields of the
57.Vt "struct utimbuf"
58pointed at by
59.Fa timep .
60.Pp
61If the times are specified (the
62.Fa timep
63argument is
64.Pf non- Dv NULL )
65the caller must be the owner of the file or be the super-user.
66.Pp
67If the times are not specified (the
68.Fa timep
69argument is
70.Dv NULL )
71the caller must be the owner of the file, have permission to write
72the file, or be the super-user.
73.Sh ERRORS
74The
75.Fn utime
76function may fail and set
77.Va errno
78for any of the errors specified for the library function
79.Xr utimes 2 .
80.Sh SEE ALSO
81.Xr stat 2 ,
82.Xr utimes 2
83.Sh STANDARDS
84The
85.Fn utime
86function conforms to
87.St -p1003.1-88 .
88.Sh HISTORY
89A
90.Fn utime
91function appeared in
92.At v7 .
93