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