bin/date/date.1

   1 .\"-
   2 .\" Copyright (c) 1980, 1990, 1993
   3 .\"     The Regents of the University of California.  All rights reserved.
   4 .\"
   5 .\" This code is derived from software contributed to Berkeley by
   6 .\" the Institute of Electrical and Electronics Engineers, Inc.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)date.1      8.3 (Berkeley) 4/28/95
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd March 12, 2019
  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 jRu
  44 .Op Fl r Ar seconds | Ar filename
  45 .Oo
  46 .Fl v
  47 .Sm off
  48 .Op Cm + | -
  49 .Ar val Op Ar ymwdHMS
  50 .Sm on
  51 .Oc
  52 .Ar ...
  53 .Op Cm + Ns Ar output_fmt
  54 .Nm
  55 .Op Fl jnu
  56 .Sm off
  57 .Op Oo Oo Oo Oo Ar cc Oc Ar yy Oc Ar mm Oc Ar dd Oc Ar HH
  58 .Ar MM Op Ar .ss
  59 .Sm on
  60 .Nm
  61 .Op Fl jnRu
  62 .Fl f Ar input_fmt new_date
  63 .Op Cm + Ns Ar output_fmt
  64 .Nm
  65 .Op Fl jnu
  66 .Op Fl I Ns Op Ar FMT
  67 .Op Fl f Ar input_fmt
  68 .Op Fl r Ar ...
  69 .Op Fl v Ar ...
  70 .Op Ar new_date
  71 .Sh DESCRIPTION
  72 When invoked without arguments, the
  73 .Nm
  74 utility displays the current date and time.
  75 Otherwise, depending on the options specified,
  76 .Nm
  77 will set the date and time or print it in a user-defined way.
  78 .Pp
  79 The
  80 .Nm
  81 utility displays the date and time read from the kernel clock.
  82 When used to set the date and time,
  83 both the kernel clock and the hardware clock are updated.
  84 .Pp
  85 Only the superuser may set the date,
  86 and if the system securelevel (see
  87 .Xr securelevel 7 )
  88 is greater than 1,
  89 the time may not be changed by more than 1 second.
  90 .Pp
  91 The options are as follows:
  92 .Bl -tag -width Ds
  93 .It Fl f
  94 Use
  95 .Ar input_fmt
  96 as the format string to parse the
  97 .Ar new_date
  98 provided rather than using the default
  99 .Sm off
 100 .Oo Oo Oo Oo Oo
 101 .Ar cc Oc
 102 .Ar yy Oc
 103 .Ar mm Oc
 104 .Ar dd Oc
 105 .Ar HH
 106 .Oc Ar MM Op Ar .ss
 107 .Sm on
 108 format.
 109 Parsing is done using
 110 .Xr strptime 3 .
 111 .It Fl I Ns Op Ar FMT
 112 Use
 113 .St -iso8601
 114 output format.
 115 .Ar FMT
 116 may be omitted, in which case the default is
 117 .Sq date .
 118 Valid
 119 .Ar FMT
 120 values are
 121 .Sq date ,
 122 .Sq hours ,
 123 .Sq minutes ,
 124 and
 125 .Sq seconds .
 126 The date and time is formatted to the specified precision.
 127 When
 128 .Ar FMT
 129 is
 130 .Sq hours
 131 (or the more precise
 132 .Sq minutes
 133 or
 134 .Sq seconds ) ,
 135 the
 136 .St -iso8601
 137 format includes the timezone.
 138 .It Fl j
 139 Do not try to set the date.
 140 This allows you to use the
 141 .Fl f
 142 flag in addition to the
 143 .Cm +
 144 option to convert one date format to another.
 145 .It Fl n
 146 By default, if the
 147 .Xr timed 8
 148 daemon is running,
 149 .Nm
 150 sets the time on all of the machines in the local group.
 151 The
 152 .Fl n
 153 option suppresses this behavior and causes the time to be set only on the
 154 current machine.
 155 .It Fl R
 156 Use RFC 2822 date and time output format.
 157 This is equivalent to using
 158 .Dq Li %a, %d %b %Y \&%T %z
 159 as
 160 .Ar output_fmt
 161 while
 162 .Ev LC_TIME
 163 is set to the
 164 .Dq C
 165 locale .
 166 .It Fl r Ar seconds
 167 Print the date and time represented by
 168 .Ar seconds ,
 169 where
 170 .Ar seconds
 171 is the number of seconds since the Epoch
 172 (00:00:00 UTC, January 1, 1970;
 173 see
 174 .Xr time 3 ) ,
 175 and can be specified in decimal, octal, or hex.
 176 .It Fl r Ar filename
 177 Print the date and time of the last modification of
 178 .Ar filename .
 179 .It Fl u
 180 Display or set the date in
 181 .Tn UTC
 182 (Coordinated Universal) time.
 183 .It Fl v
 184 Adjust (i.e., take the current date and display the result of the
 185 adjustment; not actually set the date) the second, minute, hour, month
 186 day, week day, month or year according to
 187 .Ar val .
 188 If
 189 .Ar val
 190 is preceded with a plus or minus sign,
 191 the date is adjusted forwards or backwards according to the remaining string,
 192 otherwise the relevant part of the date is set.
 193 The date can be adjusted as many times as required using these flags.
 194 Flags are processed in the order given.
 195 .Pp
 196 When setting values
 197 (rather than adjusting them),
 198 seconds are in the range 0-59, minutes are in the range 0-59, hours are
 199 in the range 0-23, month days are in the range 1-31, week days are in the
 200 range 0-6 (Sun-Sat),
 201 months are in the range 1-12 (Jan-Dec)
 202 and years are in the range 80-38 or 1980-2038.
 203 .Pp
 204 If
 205 .Ar val
 206 is numeric, one of either
 207 .Ar y ,
 208 .Ar m ,
 209 .Ar w ,
 210 .Ar d ,
 211 .Ar H ,
 212 .Ar M
 213 or
 214 .Ar S
 215 must be used to specify which part of the date is to be adjusted.
 216 .Pp
 217 The week day or month may be specified using a name rather than a
 218 number.
 219 If a name is used with the plus
 220 (or minus)
 221 sign, the date will be put forwards
 222 (or backwards)
 223 to the next
 224 (previous)
 225 date that matches the given week day or month.
 226 This will not adjust the date,
 227 if the given week day or month is the same as the current one.
 228 .Pp
 229 When a date is adjusted to a specific value or in units greater than hours,
 230 daylight savings time considerations are ignored.
 231 Adjustments in units of hours or less honor daylight saving time.
 232 So, assuming the current date is March 26, 0:30 and that the DST adjustment
 233 means that the clock goes forward at 01:00 to 02:00, using
 234 .Fl v No +1H
 235 will adjust the date to March 26, 2:30.
 236 Likewise, if the date is October 29, 0:30 and the DST adjustment means that
 237 the clock goes back at 02:00 to 01:00, using
 238 .Fl v No +3H
 239 will be necessary to reach October 29, 2:30.
 240 .Pp
 241 When the date is adjusted to a specific value that does not actually exist
 242 (for example March 26, 1:30 BST 2000 in the Europe/London timezone),
 243 the date will be silently adjusted forwards in units of one hour until it
 244 reaches a valid time.
 245 When the date is adjusted to a specific value that occurs twice
 246 (for example October 29, 1:30 2000),
 247 the resulting timezone will be set so that the date matches the earlier of
 248 the two times.
 249 .Pp
 250 It is not possible to adjust a date to an invalid absolute day, so using
 251 the switches
 252 .Fl v No 31d Fl v No 12m
 253 will simply fail five months of the year.
 254 It is therefore usual to set the month before setting the day; using
 255 .Fl v No 12m Fl v No 31d
 256 always works.
 257 .Pp
 258 Adjusting the date by months is inherently ambiguous because
 259 a month is a unit of variable length depending on the current date.
 260 This kind of date adjustment is applied in the most intuitive way.
 261 First of all,
 262 .Nm
 263 tries to preserve the day of the month.
 264 If it is impossible because the target month is shorter than the present one,
 265 the last day of the target month will be the result.
 266 For example, using
 267 .Fl v No +1m
 268 on May 31 will adjust the date to June 30, while using the same option
 269 on January 30 will result in the date adjusted to the last day of February.
 270 This approach is also believed to make the most sense for shell scripting.
 271 Nevertheless, be aware that going forth and back by the same number of
 272 months may take you to a different date.
 273 .Pp
 274 Refer to the examples below for further details.
 275 .El
 276 .Pp
 277 An operand with a leading plus
 278 .Pq Sq +
 279 sign signals a user-defined format string
 280 which specifies the format in which to display the date and time.
 281 The format string may contain any of the conversion specifications
 282 described in the
 283 .Xr strftime 3
 284 manual page, as well as any arbitrary text.
 285 A newline
 286 .Pq Ql \en
 287 character is always output after the characters specified by
 288 the format string.
 289 The format string for the default display is
 290 .Dq +%+ .
 291 .Pp
 292 If an operand does not have a leading plus sign, it is interpreted as
 293 a value for setting the system's notion of the current date and time.
 294 The canonical representation for setting the date and time is:
 295 .Pp
 296 .Bl -tag -width Ds -compact -offset indent
 297 .It Ar cc
 298 Century
 299 (either 19 or 20)
 300 prepended to the abbreviated year.
 301 .It Ar yy
 302 Year in abbreviated form
 303 (e.g., 89 for 1989, 06 for 2006).
 304 .It Ar mm
 305 Numeric month, a number from 1 to 12.
 306 .It Ar dd
 307 Day, a number from 1 to 31.
 308 .It Ar HH
 309 Hour, a number from 0 to 23.
 310 .It Ar MM
 311 Minutes, a number from 0 to 59.
 312 .It Ar ss
 313 Seconds, a number from 0 to 60
 314 (59 plus a potential leap second).
 315 .El
 316 .Pp
 317 Everything but the minutes is optional.
 318 .Pp
 319 Time changes for Daylight Saving Time, standard time, leap seconds,
 320 and leap years are handled automatically.
 321 .Sh ENVIRONMENT
 322 The following environment variables affect the execution of
 323 .Nm :
 324 .Bl -tag -width Ds
 325 .It Ev TZ
 326 The timezone to use when displaying dates.
 327 The normal format is a pathname relative to
 328 .Pa /usr/share/zoneinfo .
 329 For example, the command
 330 .Dq TZ=America/Los_Angeles date
 331 displays the current time in California.
 332 See
 333 .Xr environ 7
 334 for more information.
 335 .El
 336 .Sh FILES
 337 .Bl -tag -width /var/log/messages -compact
 338 .It Pa /var/log/utx.log
 339 record of date resets and time changes
 340 .It Pa /var/log/messages
 341 record of the user setting the time
 342 .El
 343 .Sh EXIT STATUS
 344 The
 345 .Nm
 346 utility exits 0 on success, 1 if unable to set the date, and 2
 347 if able to set the local date, but unable to set it globally.
 348 .Sh EXAMPLES
 349 The command:
 350 .Pp
 351 .Dl "date ""+DATE: %Y-%m-%d%nTIME: %H:%M:%S"""
 352 .Pp
 353 will display:
 354 .Bd -literal -offset indent
 355 DATE: 1987-11-21
 356 TIME: 13:36:16
 357 .Ed
 358 .Pp
 359 In the Europe/London timezone, the command:
 360 .Pp
 361 .Dl "date -v1m -v+1y"
 362 .Pp
 363 will display:
 364 .Pp
 365 .Dl "Sun Jan  4 04:15:24 GMT 1998"
 366 .Pp
 367 where it is currently
 368 .Li "Mon Aug  4 04:15:24 BST 1997" .
 369 .Pp
 370 The command:
 371 .Pp
 372 .Dl "date -v1d -v3m -v0y -v-1d"
 373 .Pp
 374 will display the last day of February in the year 2000:
 375 .Pp
 376 .Dl "Tue Feb 29 03:18:00 GMT 2000"
 377 .Pp
 378 So will the command:
 379 .Pp
 380 .Dl "date -v3m -v30d -v0y -v-1m"
 381 .Pp
 382 because there is no such date as the 30th of February.
 383 .Pp
 384 The command:
 385 .Pp
 386 .Dl "date -v1d -v+1m -v-1d -v-fri"
 387 .Pp
 388 will display the last Friday of the month:
 389 .Pp
 390 .Dl "Fri Aug 29 04:31:11 BST 1997"
 391 .Pp
 392 where it is currently
 393 .Li "Mon Aug  4 04:31:11 BST 1997" .
 394 .Pp
 395 The command:
 396 .Pp
 397 .Dl "date 8506131627"
 398 .Pp
 399 sets the date to
 400 .Dq Li "June 13, 1985, 4:27 PM" .
 401 .Pp
 402 .Dl "date ""+%Y%m%d%H%M.%S"""
 403 .Pp
 404 may be used on one machine to print out the date
 405 suitable for setting on another.
 406 .Qq ( Li "+%m%d%H%M%Y.%S"
 407 for use on
 408 .Tn Linux . )
 409 .Pp
 410 The command:
 411 .Pp
 412 .Dl "date 1432"
 413 .Pp
 414 sets the time to
 415 .Li "2:32 PM" ,
 416 without modifying the date.
 417 .Pp
 418 The command
 419 .Pp
 420 .Dl "TZ=America/Los_Angeles date -Iseconds -r 1533415339"
 421 .Pp
 422 will display
 423 .Pp
 424 .Dl "2018-08-04T13:42:19-07:00"
 425 .Pp
 426 Finally the command:
 427 .Pp
 428 .Dl "date -j -f ""%a %b %d %T %Z %Y"" ""`date`"" ""+%s"""
 429 .Pp
 430 can be used to parse the output from
 431 .Nm
 432 and express it in Epoch time.
 433 .Sh DIAGNOSTICS
 434 Occasionally, when
 435 .Xr timed 8
 436 synchronizes the time on many hosts, the setting of a new time value may
 437 require more than a few seconds.
 438 On these occasions,
 439 .Nm
 440 prints:
 441 .Ql Network time being set .
 442 The message
 443 .Ql Communication error with timed
 444 occurs when the communication
 445 between
 446 .Nm
 447 and
 448 .Xr timed 8
 449 fails.
 450 .Pp
 451 It is invalid to combine the
 452 .Fl I
 453 flag with either
 454 .Fl R
 455 or an output format
 456 .Dq ( + Ns ... )
 457 operand.
 458 If this occurs,
 459 .Nm
 460 prints:
 461 .Ql multiple output formats specified
 462 and exits with an error status.
 463 .Sh SEE ALSO
 464 .Xr locale 1 ,
 465 .Xr gettimeofday 2 ,
 466 .Xr getutxent 3 ,
 467 .Xr strftime 3 ,
 468 .Xr strptime 3 ,
 469 .Xr timed 8
 470 .Rs
 471 .%T "TSP: The Time Synchronization Protocol for UNIX 4.3BSD"
 472 .%A R. Gusella
 473 .%A S. Zatti
 474 .Re
 475 .Sh STANDARDS
 476 The
 477 .Nm
 478 utility is expected to be compatible with
 479 .St -p1003.2 .
 480 The
 481 .Fl d , f , I , j , n , r , t ,
 482 and
 483 .Fl v
 484 options are all extensions to the standard.
 485 .Pp
 486 The format selected by the
 487 .Fl I
 488 flag is compatible with
 489 .St -iso8601 .
 490 .Sh HISTORY
 491 A
 492 .Nm
 493 command appeared in
 494 .At v1 .
 495 .Pp
 496 The
 497 .Fl I
 498 flag was added in
 499 .Fx 12.0 .