bin/date/date.1

   1 .\" Copyright (c) 1980, 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" the Institute of Electrical and Electronics Engineers, Inc.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. All advertising materials mentioning features or use of this software
  16 .\"    must display the following acknowledgement:
  17 .\"     This product includes software developed by the University of
  18 .\"     California, Berkeley and its contributors.
  19 .\" 4. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\"     @(#)date.1      8.3 (Berkeley) 4/28/95
  36 .\" $FreeBSD: src/bin/date/date.1,v 1.34.2.15 2003/02/24 03:01:00 trhodes Exp $
  37 .\"
  38 .Dd November 17, 1993
  39 .Dt DATE 1
  40 .Os
  41 .Sh NAME
  42 .Nm date
  43 .Nd display or set date and time
  44 .Sh SYNOPSIS
  45 .Nm
  46 .Op Fl jnu
  47 .Op Fl d Ar dst
  48 .Op Fl r Ar seconds
  49 .Op Fl t Ar minutes_west
  50 .Oo
  51 .Fl v
  52 .Sm off
  53 .Op Cm + | -
  54 .Ar val Op Ar ymwdHMS
  55 .Sm on
  56 .Oc
  57 .Ar ...
  58 .Oo
  59 .Fl f
  60 .Ar fmt date |
  61 .Sm off
  62 .Op Oo Oo Oo Oo Ar cc Oc Ar yy Oc Ar mm Oc Ar dd Oc Ar HH
  63 .Ar MM Op Ar .ss
  64 .Sm on
  65 .Oc
  66 .Op Cm + Ns Ar format
  67 .Sh DESCRIPTION
  68 When invoked without arguments, the
  69 .Nm
  70 utility displays the current date and time.
  71 Otherwise, depending on the options specified,
  72 .Nm
  73 will set the date and time or print it in a user-defined way.
  74 .Pp
  75 The
  76 .Nm
  77 utility displays the date and time read from the kernel clock.
  78 When used to set the date and time,
  79 both the kernel clock and the hardware clock are updated.
  80 .Pp
  81 Only the superuser may set the date,
  82 and if the system securelevel (see
  83 .Xr securelevel 8 )
  84 is greater than 1,
  85 the time may not be changed by more than 1 second.
  86 .Pp
  87 The options are as follows:
  88 .Bl -tag -width Ds
  89 .It Fl d Ar dst
  90 Set the kernel's value for daylight saving time.
  91 If
  92 .Ar dst
  93 is non-zero, future calls
  94 to
  95 .Xr gettimeofday 2
  96 will return a non-zero for
  97 .Fa tz_dsttime  .
  98 .It Fl f
  99 Use
 100 .Ar fmt
 101 as the format string to parse the
 102 .Ar date
 103 provided rather than using the default
 104 .Sm off
 105 .Oo Oo Oo Oo Oo
 106 .Ar cc Oc
 107 .Ar yy Oc
 108 .Ar mm Oc
 109 .Ar dd Oc
 110 .Ar HH
 111 .Oc Ar MM Op Ar .ss
 112 .Sm on
 113 format.
 114 Parsing is done using
 115 .Xr strptime 3 .
 116 .It Fl j
 117 Do not try to set the date.
 118 This allows you to use the
 119 .Fl f
 120 flag in addition to the
 121 .Cm +
 122 option to convert one date format to another.
 123 .It Fl n
 124 By default, if the
 125 .Xr timed 8
 126 daemon is running,
 127 .Nm
 128 sets the time on all of the machines in the local group.
 129 The
 130 .Fl n
 131 option suppresses this behavior and causes the time to be set only on the
 132 current machine.
 133 .It Fl r Ar seconds
 134 Print the date and time represented by
 135 .Ar seconds ,
 136 where
 137 .Ar seconds
 138 is the number of seconds since the Epoch
 139 (00:00:00 UTC, January 1, 1970;
 140 see
 141 .Xr time 3 ) ,
 142 and can be specified in decimal, octal, or hex.
 143 .It Fl t Ar minutes_west
 144 Set the system's value for minutes west of
 145 .Tn GMT .
 146 .Ar minutes_west
 147 specifies the number of minutes returned in
 148 .Fa tz_minuteswest
 149 by future calls to
 150 .Xr gettimeofday 2 .
 151 .It Fl u
 152 Display or set the date in
 153 .Tn UTC
 154 (Coordinated Universal) time.
 155 .It Fl v
 156 Adjust (i.e., take the current date and display the result of the
 157 adjustment; not actually set the date) the second, minute, hour, month
 158 day, week day, month or year according to
 159 .Ar val .
 160 If
 161 .Ar val
 162 is preceded with a plus or minus sign,
 163 the date is adjusted forwards or backwards according to the remaining string,
 164 otherwise the relevant part of the date is set.
 165 The date can be adjusted as many times as required using these flags.
 166 Flags are processed in the order given.
 167 .Pp
 168 When setting values
 169 (rather than adjusting them),
 170 seconds are in the range 0-59, minutes are in the range 0-59, hours are
 171 in the range 0-23, month days are in the range 1-31, week days are in the
 172 range 0-6 (Sun-Sat),
 173 months are in the range 1-12 (Jan-Dec)
 174 and years are in the range 80-38 or 1980-2038.
 175 .Pp
 176 If
 177 .Ar val
 178 is numeric, one of either
 179 .Ar y ,
 180 .Ar m ,
 181 .Ar w ,
 182 .Ar d ,
 183 .Ar H ,
 184 .Ar M
 185 or
 186 .Ar S
 187 must be used to specify which part of the date is to be adjusted.
 188 .Pp
 189 The week day or month may be specified using a name rather than a
 190 number.
 191 If a name is used with the plus
 192 (or minus)
 193 sign, the date will be put forwards
 194 (or backwards)
 195 to the next
 196 (previous)
 197 date that matches the given week day or month.
 198 This will not adjust the date,
 199 if the given week day or month is the same as the current one.
 200 .Pp
 201 When a date is adjusted to a specific value or in units greater than hours,
 202 daylight savings time considerations are ignored.
 203 Adjustments in units of hours or less honor daylight saving time.
 204 So, assuming the current date is March 26, 0:30 and that the DST adjustment
 205 means that the clock goes forward at 01:00 to 02:00, using
 206 .Fl v No +1H
 207 will adjust the date to March 26, 2:30.
 208 Likewise, if the date is October 29, 0:30 and the DST adjustment means that
 209 the clock goes back at 02:00 to 01:00, using
 210 .Fl v No +3H
 211 will be necessary to reach October 29, 2:30.
 212 .Pp
 213 When the date is adjusted to a specific value that doesn't actually exist
 214 (for example March 26, 1:30 BST 2000 in the Europe/London timezone),
 215 the date will be silently adjusted forwards in units of one hour until it
 216 reaches a valid time.
 217 When the date is adjusted to a specific value that occurs twice
 218 (for example October 29, 1:30 2000),
 219 the resulting timezone will be set so that the date matches the earlier of
 220 the two times.
 221 .Pp
 222 Refer to the examples below for further details.
 223 .El
 224 .Pp
 225 An operand with a leading plus
 226 .Pq Sq +
 227 sign signals a user-defined format string
 228 which specifies the format in which to display the date and time.
 229 The format string may contain any of the conversion specifications
 230 described in the
 231 .Xr strftime 3
 232 manual page, as well as any arbitrary text.
 233 A newline
 234 .Pq Ql \en
 235 character is always output after the characters specified by
 236 the format string.
 237 The format string for the default display is
 238 .Dq +%+ .
 239 .Pp
 240 If an operand does not have a leading plus sign, it is interpreted as
 241 a value for setting the system's notion of the current date and time.
 242 The canonical representation for setting the date and time is:
 243 .Pp
 244 .Bl -tag -width Ds -compact -offset indent
 245 .It Ar cc
 246 Century
 247 (either 19 or 20)
 248 prepended to the abbreviated year.
 249 .It Ar yy
 250 Year in abbreviated form
 251 (e.g. 89 for 1989, 06 for 2006).
 252 .It Ar mm
 253 Numeric month, a number from 1 to 12.
 254 .It Ar dd
 255 Day, a number from 1 to 31.
 256 .It Ar HH
 257 Hour, a number from 0 to 23.
 258 .It Ar MM
 259 Minutes, a number from 0 to 59.
 260 .It Ar ss
 261 Seconds, a number from 0 to 61
 262 (59 plus a maximum of two leap seconds).
 263 .El
 264 .Pp
 265 Everything but the minutes is optional.
 266 .Pp
 267 Time changes for Daylight Saving Time, standard time, leap seconds,
 268 and leap years are handled automatically.
 269 .Sh EXAMPLES
 270 The command:
 271 .Pp
 272 .Dl "date ""+DATE: %Y-%m-%d%nTIME: %H:%M:%S"""
 273 .Pp
 274 will display:
 275 .Bd -literal -offset indent
 276 DATE: 1987-11-21
 277 TIME: 13:36:16
 278 .Ed
 279 .Pp
 280 In the Europe/London timezone, the command:
 281 .Pp
 282 .Dl "date -v1m -v+1y"
 283 .Pp
 284 will display:
 285 .Pp
 286 .Dl "Sun Jan  4 04:15:24 GMT 1998"
 287 .Pp
 288 where it is currently Mon Aug  4 04:15:24 BST 1997.
 289 .Pp
 290 The command:
 291 .Pp
 292 .Dl "date -v1d -v3m -v0y -v-1d"
 293 .Pp
 294 will display the last day of February in the year 2000:
 295 .Pp
 296 .Dl "Tue Feb 29 03:18:00 GMT 2000"
 297 .Pp
 298 The command:
 299 .Pp
 300 .Dl "date -v1d -v+1m -v-1d -v-fri"
 301 .Pp
 302 will display the last Friday of the month:
 303 .Pp
 304 .Dl "Fri Aug 29 04:31:11 BST 1997"
 305 .Pp
 306 where it is currently Mon Aug  4 04:31:11 BST 1997.
 307 .Pp
 308 The command:
 309 .Pp
 310 .Dl "date 8506131627"
 311 .Pp
 312 sets the date to
 313 .Dq Li "June 13, 1985, 4:27 PM" .
 314 .Pp
 315 .Dl "date ""+%Y%m%d%H%M.%S"""
 316 .Pp
 317 may be used on one machine to print out the date
 318 suitable for setting on another.
 319 .Pp
 320 The command:
 321 .Pp
 322 .Dl "date 1432"
 323 .Pp
 324 sets the time to
 325 .Li "2:32 PM" ,
 326 without modifying the date.
 327 .Sh ENVIRONMENT
 328 The following environment variables affect the execution of
 329 .Nm :
 330 .Bl -tag -width Ds
 331 .It Ev TZ
 332 The timezone to use when displaying dates.
 333 The normal format is a pathname relative to
 334 .Pa /usr/share/zoneinfo .
 335 For example, the command
 336 .Dq TZ=America/Los_Angeles date
 337 displays the current time in California.
 338 See
 339 .Xr environ 7
 340 for more information.
 341 .El
 342 .Sh FILES
 343 .Bl -tag -width /var/log/messages -compact
 344 .It Pa /var/log/wtmp
 345 record of date resets and time changes
 346 .It Pa /var/log/messages
 347 record of the user setting the time
 348 .El
 349 .Sh SEE ALSO
 350 .Xr gettimeofday 2 ,
 351 .Xr strftime 3 ,
 352 .Xr strptime 3 ,
 353 .Xr utmp 5 ,
 354 .Xr timed 8
 355 .Rs
 356 .%T "TSP: The Time Synchronization Protocol for UNIX 4.3BSD"
 357 .%A R. Gusella
 358 .%A S. Zatti
 359 .Re
 360 .Sh DIAGNOSTICS
 361 The
 362 .Nm
 363 utility exits 0 on success, 1 if unable to set the date, and 2
 364 if able to set the local date, but unable to set it globally.
 365 .Pp
 366 Occasionally, when
 367 .Xr timed 8
 368 synchronizes the time on many hosts, the setting of a new time value may
 369 require more than a few seconds.
 370 On these occasions,
 371 .Nm
 372 prints:
 373 .Ql Network time being set .
 374 The message
 375 .Ql Communication error with timed
 376 occurs when the communication
 377 between
 378 .Nm
 379 and
 380 .Xr timed 8
 381 fails.
 382 .Sh STANDARDS
 383 The
 384 .Nm
 385 utility is expected to be compatible with
 386 .St -p1003.2 .
 387 .Sh HISTORY
 388 A
 389 .Nm
 390 command appeared in
 391 .At v1 .