Annotation of src/lib/libc/gen/utime.3, Revision 1.4
1.1 cgd 1: .\" Copyright (c) 1980, 1991 Regents of the University of California.
2: .\" 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: .\"
1.3 jtc 32: .\" @(#)utime.3 6.3 (Berkeley) 4/19/91
1.1 cgd 33: .\"
1.3 jtc 34: .Dd August 13, 1993
1.1 cgd 35: .Dt UTIME 3
36: .Os BSD 4
37: .Sh NAME
38: .Nm utime
39: .Nd set file times
40: .Sh SYNOPSIS
41: .Fd #include <sys/types.h>
42: .Ft int
43: .Fn utime "const char *file" "const struct utimbuf *timep"
44: .Sh DESCRIPTION
45: The
46: .Fn utime
1.3 jtc 47: function sets the access and modification times of the named file.
48: .Pp
49: If
50: .Fa timep
51: is
52: .Dv NULL ,
53: the access and modification times are set to the current time.
54: The calling process must be the owner of the file or have permission to
55: write the file.
56: .Pp
57: If
58: .Fa timep
59: is
60: .Pf non- Dv NULL ,
61: .Fa time
62: is assumed to be a pointer to a utimbuf structure, as defined in
63: .Aq Pa utime.h :
64: .Bd -literal -offset indent
65: struct utimbuf {
66: time_t actime; /* Access time */
67: time_t modtime; /* Modification time */
68: } ;
69: .Ed
70: .Pp
71: The access time is set to the value of the actime member, and the modification
72: time is set to the value of the modtime member. The times are measured in
73: seconds since 0 hours, 0 minutes, 0 seconds, January 1, 1970, Coordinated
74: Universal Time.
75: The calling process must be the owner of the file or be the super-user.
1.1 cgd 76: .Pp
1.3 jtc 77: In either case, the inode-change-time of the file is set to the current
78: time.
1.4 ! jtc 79: .Sh RETURN VALUES
! 80: Upon successful completion, a value of 0 is returned.
! 81: Otherwise, a value of -1 is returned and
! 82: .Va errno
! 83: is set to indicate the error.
! 84: .Sh ERRORS
! 85: .Fn Utimes
! 86: will fail if:
! 87: .Bl -tag -width Er
! 88: .It Bq Er EACCES
! 89: Search permission is denied for a component of the path prefix;
! 90: or the
! 91: .Fa times
! 92: argument is
! 93: .Dv NULL
! 94: and the effective user ID of the process does not
! 95: match the owner of the file, and is not the super-user, and write
! 96: access is denied.
! 97: .It Bq Er EFAULT
! 98: .Xr File
! 99: or
! 100: .Fa times
! 101: points outside the process's allocated address space.
! 102: .It Bq Er EINVAL
! 103: The pathname contains a character with the high-order bit set.
! 104: .It Bq Er EIO
! 105: An I/O error occurred while reading or writing the affected inode.
! 106: .It Bq Er ELOOP
! 107: Too many symbolic links were encountered in translating the pathname.
! 108: .It Bq Er ENAMETOOLONG
! 109: A component of a pathname exceeded 255 characters,
! 110: or an entire path name exceeded 1023 characters.
! 111: .It Bq Er ENOENT
! 112: The named file does not exist.
! 113: .It Bq Er ENOTDIR
! 114: A component of the path prefix is not a directory.
! 115: .It Bq Er EPERM
! 116: The
! 117: .Fa times
! 118: argument is not
! 119: .Dv NULL
! 120: and the calling process's effective user ID
! 121: does not match the owner of the file and is not the super-user.
! 122: .It Bq Er EROFS
! 123: The file system containing the file is mounted read-only.
! 124: .El
1.1 cgd 125: .Sh SEE ALSO
1.3 jtc 126: .Xr stat 2 ,
127: .Xr utimes 2
1.1 cgd 128: .Sh HISTORY
129: A
130: .Fn utime
131: function appeared in
132: .At v7 .
CVSweb <webmaster@jp.NetBSD.org>