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