Merge from vendor branch LIBARCHIVE:
[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 .\" $DragonFly: src/lib/libc/gen/utime.3,v 1.3 2006/02/17 19:35:06 swildner Exp $
35 .\"
36 .Dd June 4, 1993
37 .Dt UTIME 3
38 .Os
39 .Sh NAME
40 .Nm utime
41 .Nd set file times
42 .Sh LIBRARY
43 .Lb libc
44 .Sh SYNOPSIS
45 .In sys/types.h
46 .In utime.h
47 .Ft int
48 .Fn utime "const char *file" "const struct utimbuf *timep"
49 .Sh DESCRIPTION
50 .Bf -symbolic
51 This interface is obsoleted by
52 .Xr utimes 2 .
53 .Ef
54 .Pp
55 The
56 .Fn utime
57 function sets the access and modification times of the named file from
58 the structures in the argument array
59 .Fa timep .
60 .Pp
61 If the times are specified (the
62 .Fa timep
63 argument is
64 .Pf non- Dv NULL )
65 the caller must be the owner of the file or be the super-user.
66 .Pp
67 If the times are not specified (the
68 .Fa timep
69 argument is
70 .Dv NULL )
71 the caller must be the owner of the file, have permission to write
72 the file, or be the super-user.
73 .Sh ERRORS
74 The
75 .Fn utime
76 function may fail and set
77 .Va errno
78 for 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
84 The
85 .Fn utime
86 function conforms to
87 .St -p1003.1-88 .
88 .Sh HISTORY
89 A
90 .Fn utime
91 function appeared in
92 .At v7 .