[apple/libc.git] / gen / utime.3

.\" Copyright (c) 1980, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)utime.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD: src/lib/libc/gen/utime.3,v 1.11 2002/08/24 00:39:43 mike Exp $
.\"
.Dd June 4, 1993
.Dt UTIME 3
.Os
.Sh NAME
.Nm utime
.Nd set file times
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In utime.h
.Ft int
.Fo utime
.Fa "const char *path"
.Fa "const struct utimbuf *times"
.Fc
.Sh DESCRIPTION
.Bf -symbolic
This interface is obsoleted by
.Xr utimes 2 .
.Ef
.Pp
The
.Fn utime
function sets the access and modification times of the named file,
based on the structures in the argument array
.Fa times .
.Pp
If the times are specified (the
.Fa times
argument is
.Pf non- Dv NULL ) ,
the caller must be the owner of the file or be the super-user.
.Pp
If the times are not specified (the
.Fa times
argument is
.Dv NULL ) ,
the caller must be the owner of the file,
have permission to write the file, or be the super-user.
.Sh ERRORS
The
.Fn utime
function may fail and set
.Va errno
for any of the errors specified for the library function
.Xr utimes 2 .
.Sh SEE ALSO
.Xr stat 2 ,
.Xr utimes 2
.Sh HISTORY
A
.Fn utime
function appeared in
.At v7 .
.Sh STANDARDS
The
.Fn utime
function conforms to
.St -p1003.1-88 .
Commit	Line	Data
5b2abdfb	1	.\" Copyright (c) 1980, 1991, 1993
e9ce8d39 A	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	.\"
224c7076 A	32	.\" @(#)utime.3 8.1 (Berkeley) 6/4/93
224c7076 A	33	.\" $FreeBSD: src/lib/libc/gen/utime.3,v 1.11 2002/08/24 00:39:43 mike Exp $
e9ce8d39	34	.\"
5b2abdfb	35	.Dd June 4, 1993
224c7076	36	.Dt UTIME 3
e9ce8d39 A	37	.Os
e9ce8d39 A	38	.Sh NAME
224c7076 A	39	.Nm utime
224c7076 A	40	.Nd set file times
e9ce8d39 A	41	.Sh LIBRARY
	42	.Lb libc
	43	.Sh SYNOPSIS
224c7076 A	44	.In utime.h
	45	.Ft int
	46	.Fo utime
	47	.Fa "const char *path"
	48	.Fa "const struct utimbuf *times"
	49	.Fc
e9ce8d39	50	.Sh DESCRIPTION
5b2abdfb	51	.Bf -symbolic
224c7076 A	52	This interface is obsoleted by
	53	.Xr utimes 2 .
	54	.Ef
	55	.Pp
e9ce8d39	56	The
224c7076 A	57	.Fn utime
	58	function sets the access and modification times of the named file,
	59	based on the structures in the argument array
	60	.Fa times .
	61	.Pp
	62	If the times are specified (the
	63	.Fa times
	64	argument is
	65	.Pf non- Dv NULL ) ,
	66	the caller must be the owner of the file or be the super-user.
	67	.Pp
	68	If the times are not specified (the
	69	.Fa times
	70	argument is
	71	.Dv NULL ) ,
	72	the caller must be the owner of the file,
	73	have permission to write the file, or be the super-user.
	74	.Sh ERRORS
5b2abdfb	75	The
224c7076 A	76	.Fn utime
	77	function may fail and set
	78	.Va errno
	79	for any of the errors specified for the library function
	80	.Xr utimes 2 .
	81	.Sh SEE ALSO
	82	.Xr stat 2 ,
	83	.Xr utimes 2
e9ce8d39	84	.Sh HISTORY
5b2abdfb	85	A
224c7076 A	86	.Fn utime
	87	function appeared in
	88	.At v7 .
	89	.Sh STANDARDS
	90	The
	91	.Fn utime
	92	function conforms to
	93	.St -p1003.1-88 .