bin/date/date.1

   1 .\"     $NetBSD: date.1,v 1.42 2012/04/06 11:36:56 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1980, 1990, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to Berkeley by
   7 .\" the Institute of Electrical and Electronics Engineers, Inc.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 3. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\"
  33 .\"     @(#)date.1      8.3 (Berkeley) 4/28/95
  34 .\"
  35 .Dd November 15, 2006
  36 .Dt DATE 1
  37 .Os
  38 .Sh NAME
  39 .Nm date
  40 .Nd display or set date and time
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl ajnu
  44 .Op Fl d Ar date
  45 .Op Fl r Ar seconds
  46 .Op Cm + Ns Ar format
  47 .Sm off
  48 .Oo Oo Oo Oo Oo Oo
  49 .Ar CC Oc
  50 .Ar yy Oc
  51 .Ar mm Oc
  52 .Ar dd Oc
  53 .Ar HH Oc Ar MM Oo
  54 .Li \&. Ar SS Oc Oc
  55 .Sm on
  56 .Sh DESCRIPTION
  57 .Nm
  58 displays the current date and time when invoked without arguments.
  59 Providing arguments will format the date and time in a user-defined
  60 way or set the date.
  61 Only the superuser may set the date.
  62 .Pp
  63 The options are as follows:
  64 .Bl -tag -width Ds
  65 .It Fl a
  66 Use
  67 .Xr adjtime 2
  68 to change the local system time slowly,
  69 maintaining it as a monotonically increasing function.
  70 .Fl a
  71 implies
  72 .Fl n .
  73 .It Fl d Ar date
  74 Parse the provided human-described date and time and display the result without
  75 actually changing the system clock.
  76 (See
  77 .Xr parsedate 3
  78 for examples.)
  79 .It Fl j
  80 Parse the provided canonical representation of date and time (described below)
  81 and display the result without actually changing the system clock.
  82 .It Fl n
  83 The utility
  84 .Xr timed 8
  85 is used to synchronize the clocks on groups of machines.
  86 By default, if
  87 .Xr timed 8
  88 is running,
  89 .Nm
  90 will set the time on all of the machines in the local group.
  91 The
  92 .Fl n
  93 option stops
  94 .Nm
  95 from setting the time for other than the current machine.
  96 .It Fl r Ar seconds
  97 Print out the date and time that is
  98 .Ar seconds
  99 from the Epoch.
 100 .It Fl u
 101 Display or set the date in
 102 .Tn UTC
 103 (universal) time.
 104 .El
 105 .Pp
 106 An operand with a leading plus
 107 .Pq Cm +
 108 sign signals a user-defined format
 109 string which specifies the format in which to display the date and time.
 110 The format string may contain any of the conversion specifications described
 111 in the
 112 .Xr strftime 3
 113 manual page, as well as any arbitrary text.
 114 A \*[Lt]newline\*[Gt] character is always output after the characters
 115 specified by the format string.
 116 The format string for the default display is:
 117 .Bd -literal -offset indent
 118 %a %b %e %H:%M:%S %Z %Y
 119 .Ed
 120 .Pp
 121 If an operand does not have a leading plus sign, it is interpreted as
 122 a value for setting the system's notion of the current date and time.
 123 The canonical representation for setting the date and time is:
 124 .Pp
 125 .Bl -tag -width Ds -compact -offset indent
 126 .It Ar CC
 127 The first two digits of the year (the century).
 128 .It Ar yy
 129 The second two digits of the year.
 130 If
 131 .Ar yy
 132 is specified, but
 133 .Ar CC
 134 is not, a value for
 135 .Ar yy
 136 between 69 and 99 results in a
 137 .Ar CC
 138 value of 19.
 139 Otherwise, a
 140 .Ar CC
 141 value of 20 is used.
 142 .It Ar mm
 143 The month of the year, from 01 to 12.
 144 .It Ar dd
 145 The day of the month, from 01 to 31.
 146 .It Ar HH
 147 The hour of the day, from 00 to 23.
 148 .It Ar MM
 149 The minute of the hour, from 00 to 59.
 150 .It Ar SS
 151 The second of the minute, from 00 to 61.
 152 .El
 153 .Pp
 154 Everything but the minutes is optional.
 155 .Pp
 156 Time changes for Daylight Saving and Standard Time and leap seconds
 157 and years are handled automatically.
 158 .Sh ENVIRONMENT
 159 The following environment variables affect the execution of
 160 .Nm :
 161 .Bl -tag -width iTZ
 162 .It Ev TZ
 163 The timezone to use when displaying dates.
 164 See
 165 .Xr environ 7
 166 for more information.
 167 .El
 168 .Sh FILES
 169 .Bl -tag -width /var/log/messages -compact
 170 .It Pa /etc/localtime
 171 Symlink pointing to system's default timezone information file in
 172 .Pa /usr/share/zoneinfo
 173 directory.
 174 .It Pa /var/log/wtmp
 175 A record of date resets and time changes.
 176 .It Pa /var/log/messages
 177 A record of the user setting the time.
 178 .El
 179 .Sh EXAMPLES
 180 The command:
 181 .Bd -literal -offset indent
 182 date '+DATE: %m/%d/%y%nTIME: %H:%M:%S'
 183 .Ed
 184 .Pp
 185 will display:
 186 .Bd -literal -offset indent
 187 DATE: 11/21/87
 188 TIME: 13:36:16
 189 .Ed
 190 .Pp
 191 The command:
 192 .Bd -literal -offset indent
 193 date 8506131627
 194 .Ed
 195 .Pp
 196 sets the date to
 197 .Dq Li "June 13, 1985, 4:27 PM" .
 198 .Pp
 199 The command:
 200 .Bd -literal -offset indent
 201 date 1432
 202 .Ed
 203 .Pp
 204 sets the time to
 205 .Li "2:32 PM" ,
 206 without modifying the date.
 207 .Sh DIAGNOSTICS
 208 Exit status is 0 on success, 1 if unable to set the date, and 2
 209 if able to set the local date, but unable to set it globally.
 210 .Pp
 211 Occasionally, when
 212 .Xr timed 8
 213 synchronizes the time on many hosts, the setting of a new time value may
 214 require more than a few seconds.
 215 On these occasions,
 216 .Nm
 217 prints:
 218 .Ql Network time being set .
 219 The message
 220 .Ql Communication error with
 221 .Xr timed 8
 222 occurs when the communication
 223 between
 224 .Nm
 225 and
 226 .Xr timed 8
 227 fails.
 228 .Sh SEE ALSO
 229 .Xr adjtime 2 ,
 230 .Xr gettimeofday 2 ,
 231 .Xr settimeofday 2 ,
 232 .Xr parsedate 3 ,
 233 .Xr strftime 3 ,
 234 .Xr utmp 5 ,
 235 .Xr environ 7 ,
 236 .Xr timed 8
 237 .Rs
 238 .%T "TSP: The Time Synchronization Protocol for UNIX 4.3BSD"
 239 .%A R. Gusella
 240 .%A S. Zatti
 241 .Re
 242 .Sh STANDARDS
 243 The
 244 .Nm
 245 utility is expected to be compatible with
 246 .St -p1003.2 .