Return to utime.3 CVS log

Up to [cvs.NetBSD.org] / src / lib / libc / gen

Annotation of src/lib/libc/gen/utime.3, Revision 1.19

1.19    ! agc         1: .\"    $NetBSD: utime.3,v 1.18 2003/04/16 13:34:40 wiz Exp $
1.7       cgd         2: .\"
                      3: .\" Copyright (c) 1980, 1991, 1993
                      4: .\"    The Regents of the University of California.  All rights reserved.
1.1       cgd         5: .\"
                      6: .\" Redistribution and use in source and binary forms, with or without
                      7: .\" modification, are permitted provided that the following conditions
                      8: .\" are met:
                      9: .\" 1. Redistributions of source code must retain the above copyright
                     10: .\"    notice, this list of conditions and the following disclaimer.
                     11: .\" 2. Redistributions in binary form must reproduce the above copyright
                     12: .\"    notice, this list of conditions and the following disclaimer in the
                     13: .\"    documentation and/or other materials provided with the distribution.
1.19    ! agc        14: .\" 3. Neither the name of the University nor the names of its contributors
1.1       cgd        15: .\"    may be used to endorse or promote products derived from this software
                     16: .\"    without specific prior written permission.
                     17: .\"
                     18: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     19: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     20: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     21: .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     22: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     23: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     24: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     25: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     26: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     27: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     28: .\" SUCH DAMAGE.
                     29: .\"
1.7       cgd        30: .\"     @(#)utime.3    8.1 (Berkeley) 6/4/93
1.1       cgd        31: .\"
1.3       jtc        32: .Dd August 13, 1993
1.1       cgd        33: .Dt UTIME 3
1.14      garbled    34: .Os
1.1       cgd        35: .Sh NAME
                     36: .Nm utime
                     37: .Nd set file times
1.10      perry      38: .Sh LIBRARY
                     39: .Lb libc
1.1       cgd        40: .Sh SYNOPSIS
1.18      wiz        41: .In utime.h
1.1       cgd        42: .Ft int
                     43: .Fn utime "const char *file" "const struct utimbuf *timep"
                     44: .Sh DESCRIPTION
1.7       cgd        45: .Bf -symbolic
1.11      fair       46: This interface is obsoleted by
                     47: .Xr utimes 2 .
1.7       cgd        48: .Ef
                     49: .Pp
1.1       cgd        50: The
                     51: .Fn utime
1.3       jtc        52: function sets the access and modification times of the named file.
                     53: .Pp
                     54: If
                     55: .Fa timep
                     56: is
                     57: .Dv NULL ,
                     58: the access and modification times are set to the current time.
1.12      fair       59: The calling process must be the owner of the file or have permission to
1.3       jtc        60: write the file.
                     61: .Pp
1.12      fair       62: If
1.3       jtc        63: .Fa timep
1.12      fair       64: is
1.3       jtc        65: .Pf non- Dv NULL ,
1.12      fair       66: .Fa time
                     67: is assumed to be a pointer to a utimbuf structure, as defined in
1.3       jtc        68: .Aq Pa utime.h :
                     69: .Bd -literal -offset indent
                     70: struct utimbuf {
                     71:        time_t actime;          /* Access time */
                     72:        time_t modtime;         /* Modification time */
1.12      fair       73: };
1.3       jtc        74: .Ed
                     75: .Pp
1.12      fair       76: The access time is set to the value of the actime member, and the
                     77: modification time is set to the value of the modtime member.
                     78: The times are measured in seconds since 0 hours, 0 minutes, 0
                     79: seconds, January 1, 1970 Coordinated Universal Time (UTC).
1.3       jtc        80: The calling process must be the owner of the file or be the super-user.
1.1       cgd        81: .Pp
1.12      fair       82: In either case, the inode-change-time of the file is set to the current
1.3       jtc        83: time.
1.4       jtc        84: .Sh RETURN VALUES
                     85: Upon successful completion, a value of 0 is returned.
1.17      wiz        86: Otherwise, a value of \-1 is returned and
1.4       jtc        87: .Va errno
                     88: is set to indicate the error.
                     89: .Sh ERRORS
1.13      lukem      90: .Fn utime
1.4       jtc        91: will fail if:
                     92: .Bl -tag -width Er
                     93: .It Bq Er EACCES
                     94: Search permission is denied for a component of the path prefix;
                     95: or the
                     96: .Fa times
                     97: argument is
                     98: .Dv NULL
                     99: and the effective user ID of the process does not
                    100: match the owner of the file, and is not the super-user, and write
                    101: access is denied.
                    102: .It Bq Er EFAULT
1.12      fair      103: .Fa file
1.4       jtc       104: or
                    105: .Fa times
                    106: points outside the process's allocated address space.
                    107: .It Bq Er EINVAL
                    108: The pathname contains a character with the high-order bit set.
                    109: .It Bq Er EIO
                    110: An I/O error occurred while reading or writing the affected inode.
                    111: .It Bq Er ELOOP
                    112: Too many symbolic links were encountered in translating the pathname.
                    113: .It Bq Er ENAMETOOLONG
                    114: A component of a pathname exceeded 255 characters,
                    115: or an entire path name exceeded 1023 characters.
                    116: .It Bq Er ENOENT
                    117: The named file does not exist.
                    118: .It Bq Er ENOTDIR
                    119: A component of the path prefix is not a directory.
                    120: .It Bq Er EPERM
                    121: The
                    122: .Fa times
                    123: argument is not
                    124: .Dv NULL
                    125: and the calling process's effective user ID
                    126: does not match the owner of the file and is not the super-user.
                    127: .It Bq Er EROFS
                    128: The file system containing the file is mounted read-only.
                    129: .El
1.1       cgd       130: .Sh SEE ALSO
1.3       jtc       131: .Xr stat 2 ,
                    132: .Xr utimes 2
1.9       jtc       133: .Sh STANDARDS
                    134: The
                    135: .Fn utime
                    136: function conforms to
                    137: .St -p1003.1-90 .
1.7       cgd       138: .Sh HISTORY
                    139: A
                    140: .Fn utime
                    141: function appeared in
                    142: .At v7 .