[unix-history] / .ref-BSD-4_3_Net_2 / usr / src / lib / libc / sys / utimes.2

.\" Copyright (c) 1990 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.
.\"
.\"     @(#)utimes.2	6.7 (Berkeley) 4/19/91
.\"
.Dd April 19, 1991
.Dt UTIMES 2
.Os BSD 4
.Sh NAME
.Nm utimes
.Nd set file access and modification times
.Sh SYNOPSIS
.Fd #include <sys/time.h>
.Ft int
.Fn utimes "const char *file" "const struct timeval *times"
.Sh DESCRIPTION
The
.Fn utimes
function sets the access and modification times of the named file from
the structures in the argument array
.Fa times .
.Pp
The first structure is the access time, and the second is the modification
time.
.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 RETURN VALUES
Upon successful completion, a value of 0 is returned.
Otherwise, a value of -1 is returned and
.Va errno
is set to indicate the error.
.Sh ERRORS
.Fn Utimes
will fail if:
.Bl -tag -width Er
.It Bq Er EACCES
Search permission is denied for a component of the path prefix;
or the
.Fa times
argument is
.Dv NULL
and the effective user ID of the process does not
match the owner of the file, and is not the super-user, and write
access is denied.
.It Bq Er EFAULT
.Xr File
or
.Fa times
points outside the process's allocated address space.
.It Bq Er EINVAL
The pathname contains a character with the high-order bit set.
.It Bq Er EIO
An I/O error occurred while reading or writing the affected inode.
.It Bq Er ELOOP
Too many symbolic links were encountered in translating the pathname.
.It Bq Er ENAMETOOLONG
A component of a pathname exceeded 255 characters,
or an entire path name exceeded 1023 characters.
.It Bq Er ENOENT
The named file does not exist.
.It Bq Er ENOTDIR
A component of the path prefix is not a directory.
.It Bq Er EPERM
The
.Fa times
argument is not
.Dv NULL
and the calling process's effective user ID
does not match the owner of the file and is not the super-user.
.It Bq Er EROFS
The file system containing the file is mounted read-only.
.El
.Sh SEE ALSO
.Xr stat 2
.Sh HISTORY
The
.Nm
function call appeared in
.Bx 4.2 .
Commit	Line	Data
931b8415 CL	1	.\" Copyright (c) 1990 The Regents of the University of California.
931b8415 CL	2	.\" All rights reserved.
14d9e8bc	3	.\"
af359dea C	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.
14d9e8bc	19	.\"
af359dea C	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.
931b8415	31	.\"
af359dea C	32	.\" @(#)utimes.2 6.7 (Berkeley) 4/19/91
	33	.\"
	34	.Dd April 19, 1991
931b8415 CL	35	.Dt UTIMES 2
	36	.Os BSD 4
	37	.Sh NAME
	38	.Nm utimes
	39	.Nd set file access and modification times
	40	.Sh SYNOPSIS
	41	.Fd #include <sys/time.h>
	42	.Ft int
	43	.Fn utimes "const char file" "const struct timeval times"
	44	.Sh DESCRIPTION
14d9e8bc	45	The
931b8415 CL	46	.Fn utimes
	47	function sets the access and modification times of the named file from
	48	the structures in the argument array
	49	.Fa times .
	50	.Pp
	51	The first structure is the access time, and the second is the modification
	52	time.
	53	.Pp
	54	If the times are specified (the
	55	.Fa times
	56	argument is
af359dea C	57	.Pf non- Dv NULL )
af359dea C	58	the caller must be the owner of the file or be the super-user.
931b8415 CL	59	.Pp
	60	If the times are not specified (the
	61	.Fa times
	62	argument is
	63	.Dv NULL )
	64	the caller must be the owner of the file, have permission to
	65	write the file, or be the super-user.
	66	.Sh RETURN VALUES
481ecf6a	67	Upon successful completion, a value of 0 is returned.
931b8415 CL	68	Otherwise, a value of -1 is returned and
931b8415 CL	69	.Va errno
481ecf6a	70	is set to indicate the error.
931b8415 CL	71	.Sh ERRORS
	72	.Fn Utimes
	73	will fail if:
	74	.Bl -tag -width Er
	75	.It Bq Er EACCES
	76	Search permission is denied for a component of the path prefix;
	77	or the
	78	.Fa times
	79	argument is
	80	.Dv NULL
	81	and the effective user ID of the process does not
	82	match the owner of the file, and is not the super-user, and write
	83	access is denied.
	84	.It Bq Er EFAULT
	85	.Xr File
	86	or
	87	.Fa times
	88	points outside the process's allocated address space.
	89	.It Bq Er EINVAL
b5984ffe	90	The pathname contains a character with the high-order bit set.
931b8415 CL	91	.It Bq Er EIO
	92	An I/O error occurred while reading or writing the affected inode.
	93	.It Bq Er ELOOP
	94	Too many symbolic links were encountered in translating the pathname.
	95	.It Bq Er ENAMETOOLONG
b5984ffe KM	96	A component of a pathname exceeded 255 characters,
b5984ffe KM	97	or an entire path name exceeded 1023 characters.
931b8415	98	.It Bq Er ENOENT
481ecf6a	99	The named file does not exist.
931b8415 CL	100	.It Bq Er ENOTDIR
	101	A component of the path prefix is not a directory.
	102	.It Bq Er EPERM
	103	The
	104	.Fa times
	105	argument is not
	106	.Dv NULL
	107	and the calling process's effective user ID
	108	does not match the owner of the file and is not the super-user.
	109	.It Bq Er EROFS
481ecf6a	110	The file system containing the file is mounted read-only.
931b8415 CL	111	.El
	112	.Sh SEE ALSO
	113	.Xr stat 2
	114	.Sh HISTORY
	115	The
	116	.Nm
	117	function call appeared in
	118	.Bx 4.2 .