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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)utime.3     8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd June 9, 2016
  32 .Dt UTIME 3
  33 .Os
  34 .Sh NAME
  35 .Nm utime
  36 .Nd set file times
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In utime.h
  41 .Ft int
  42 .Fn utime "const char *file" "const struct utimbuf *timep"
  43 .Sh DESCRIPTION
  44 .Bf -symbolic
  45 This interface is obsoleted by
  46 .Xr utimensat 2
  47 because it is not accurate to fractions of a second.
  48 .Ef
  49 .Pp
  50 The
  51 .Fn utime
  52 function sets the access and modification times of the named file from
  53 the
  54 .Va actime
  55 and
  56 .Va modtime
  57 fields of the
  58 .Vt "struct utimbuf"
  59 pointed at by
  60 .Fa timep .
  61 .Pp
  62 If the times are specified (the
  63 .Fa timep
  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 timep
  70 argument is
  71 .Dv NULL )
  72 the caller must be the owner of the file, have permission to write
  73 the file, or be the super-user.
  74 .Sh ERRORS
  75 The
  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 utimensat 2 ,
  84 .Xr utimes 2
  85 .Sh STANDARDS
  86 The
  87 .Fn utime
  88 function conforms to
  89 .St -p1003.1-88 .
  90 .Sh HISTORY
  91 A
  92 .Fn utime
  93 function appeared in
  94 .At v7 .