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 20, 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 ju
  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 jRu
  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 R
 146 Use RFC 2822 date and time output format.
 147 This is equivalent to using
 148 .Dq Li %a, %d %b %Y \&%T %z
 149 as
 150 .Ar output_fmt
 151 while
 152 .Ev LC_TIME
 153 is set to the
 154 .Dq C
 155 locale .
 156 .It Fl r Ar seconds
 157 Print the date and time represented by
 158 .Ar seconds ,
 159 where
 160 .Ar seconds
 161 is the number of seconds since the Epoch
 162 (00:00:00 UTC, January 1, 1970;
 163 see
 164 .Xr time 3 ) ,
 165 and can be specified in decimal, octal, or hex.
 166 .It Fl r Ar filename
 167 Print the date and time of the last modification of
 168 .Ar filename .
 169 .It Fl u
 170 Display or set the date in
 171 .Tn UTC
 172 (Coordinated Universal) time.
 173 .It Fl v
 174 Adjust (i.e., take the current date and display the result of the
 175 adjustment; not actually set the date) the second, minute, hour, month
 176 day, week day, month or year according to
 177 .Ar val .
 178 If
 179 .Ar val
 180 is preceded with a plus or minus sign,
 181 the date is adjusted forwards or backwards according to the remaining string,
 182 otherwise the relevant part of the date is set.
 183 The date can be adjusted as many times as required using these flags.
 184 Flags are processed in the order given.
 185 .Pp
 186 When setting values
 187 (rather than adjusting them),
 188 seconds are in the range 0-59, minutes are in the range 0-59, hours are
 189 in the range 0-23, month days are in the range 1-31, week days are in the
 190 range 0-6 (Sun-Sat),
 191 months are in the range 1-12 (Jan-Dec)
 192 and years are in the range 80-38 or 1980-2038.
 193 .Pp
 194 If
 195 .Ar val
 196 is numeric, one of either
 197 .Ar y ,
 198 .Ar m ,
 199 .Ar w ,
 200 .Ar d ,
 201 .Ar H ,
 202 .Ar M
 203 or
 204 .Ar S
 205 must be used to specify which part of the date is to be adjusted.
 206 .Pp
 207 The week day or month may be specified using a name rather than a
 208 number.
 209 If a name is used with the plus
 210 (or minus)
 211 sign, the date will be put forwards
 212 (or backwards)
 213 to the next
 214 (previous)
 215 date that matches the given week day or month.
 216 This will not adjust the date,
 217 if the given week day or month is the same as the current one.
 218 .Pp
 219 When a date is adjusted to a specific value or in units greater than hours,
 220 daylight savings time considerations are ignored.
 221 Adjustments in units of hours or less honor daylight saving time.
 222 So, assuming the current date is March 26, 0:30 and that the DST adjustment
 223 means that the clock goes forward at 01:00 to 02:00, using
 224 .Fl v No +1H
 225 will adjust the date to March 26, 2:30.
 226 Likewise, if the date is October 29, 0:30 and the DST adjustment means that
 227 the clock goes back at 02:00 to 01:00, using
 228 .Fl v No +3H
 229 will be necessary to reach October 29, 2:30.
 230 .Pp
 231 When the date is adjusted to a specific value that does not actually exist
 232 (for example March 26, 1:30 BST 2000 in the Europe/London timezone),
 233 the date will be silently adjusted forwards in units of one hour until it
 234 reaches a valid time.
 235 When the date is adjusted to a specific value that occurs twice
 236 (for example October 29, 1:30 2000),
 237 the resulting timezone will be set so that the date matches the earlier of
 238 the two times.
 239 .Pp
 240 It is not possible to adjust a date to an invalid absolute day, so using
 241 the switches
 242 .Fl v No 31d Fl v No 12m
 243 will simply fail five months of the year.
 244 It is therefore usual to set the month before setting the day; using
 245 .Fl v No 12m Fl v No 31d
 246 always works.
 247 .Pp
 248 Adjusting the date by months is inherently ambiguous because
 249 a month is a unit of variable length depending on the current date.
 250 This kind of date adjustment is applied in the most intuitive way.
 251 First of all,
 252 .Nm
 253 tries to preserve the day of the month.
 254 If it is impossible because the target month is shorter than the present one,
 255 the last day of the target month will be the result.
 256 For example, using
 257 .Fl v No +1m
 258 on May 31 will adjust the date to June 30, while using the same option
 259 on January 30 will result in the date adjusted to the last day of February.
 260 This approach is also believed to make the most sense for shell scripting.
 261 Nevertheless, be aware that going forth and back by the same number of
 262 months may take you to a different date.
 263 .Pp
 264 Refer to the examples below for further details.
 265 .El
 266 .Pp
 267 An operand with a leading plus
 268 .Pq Sq +
 269 sign signals a user-defined format string
 270 which specifies the format in which to display the date and time.
 271 The format string may contain any of the conversion specifications
 272 described in the
 273 .Xr strftime 3
 274 manual page, as well as any arbitrary text.
 275 A newline
 276 .Pq Ql \en
 277 character is always output after the characters specified by
 278 the format string.
 279 The format string for the default display is
 280 .Dq +%+ .
 281 .Pp
 282 If an operand does not have a leading plus sign, it is interpreted as
 283 a value for setting the system's notion of the current date and time.
 284 The canonical representation for setting the date and time is:
 285 .Pp
 286 .Bl -tag -width Ds -compact -offset indent
 287 .It Ar cc
 288 Century
 289 (either 19 or 20)
 290 prepended to the abbreviated year.
 291 .It Ar yy
 292 Year in abbreviated form
 293 (e.g., 89 for 1989, 06 for 2006).
 294 .It Ar mm
 295 Numeric month, a number from 1 to 12.
 296 .It Ar dd
 297 Day, a number from 1 to 31.
 298 .It Ar HH
 299 Hour, a number from 0 to 23.
 300 .It Ar MM
 301 Minutes, a number from 0 to 59.
 302 .It Ar ss
 303 Seconds, a number from 0 to 60
 304 (59 plus a potential leap second).
 305 .El
 306 .Pp
 307 Everything but the minutes is optional.
 308 .Pp
 309 Time changes for Daylight Saving Time, standard time, leap seconds,
 310 and leap years are handled automatically.
 311 .Sh ENVIRONMENT
 312 The following environment variables affect the execution of
 313 .Nm :
 314 .Bl -tag -width Ds
 315 .It Ev TZ
 316 The timezone to use when displaying dates.
 317 The normal format is a pathname relative to
 318 .Pa /usr/share/zoneinfo .
 319 For example, the command
 320 .Dq TZ=America/Los_Angeles date
 321 displays the current time in California.
 322 See
 323 .Xr environ 7
 324 for more information.
 325 .El
 326 .Sh FILES
 327 .Bl -tag -width /var/log/messages -compact
 328 .It Pa /var/log/utx.log
 329 record of date resets and time changes
 330 .It Pa /var/log/messages
 331 record of the user setting the time
 332 .El
 333 .Sh EXIT STATUS
 334 The
 335 .Nm
 336 utility exits 0 on success, 1 if unable to set the date, and 2
 337 if able to set the local date, but unable to set it globally.
 338 .Sh EXAMPLES
 339 The command:
 340 .Pp
 341 .Dl "date ""+DATE: %Y-%m-%d%nTIME: %H:%M:%S"""
 342 .Pp
 343 will display:
 344 .Bd -literal -offset indent
 345 DATE: 1987-11-21
 346 TIME: 13:36:16
 347 .Ed
 348 .Pp
 349 In the Europe/London timezone, the command:
 350 .Pp
 351 .Dl "date -v1m -v+1y"
 352 .Pp
 353 will display:
 354 .Pp
 355 .Dl "Sun Jan  4 04:15:24 GMT 1998"
 356 .Pp
 357 where it is currently
 358 .Li "Mon Aug  4 04:15:24 BST 1997" .
 359 .Pp
 360 The command:
 361 .Pp
 362 .Dl "date -v1d -v3m -v0y -v-1d"
 363 .Pp
 364 will display the last day of February in the year 2000:
 365 .Pp
 366 .Dl "Tue Feb 29 03:18:00 GMT 2000"
 367 .Pp
 368 So will the command:
 369 .Pp
 370 .Dl "date -v3m -v30d -v0y -v-1m"
 371 .Pp
 372 because there is no such date as the 30th of February.
 373 .Pp
 374 The command:
 375 .Pp
 376 .Dl "date -v1d -v+1m -v-1d -v-fri"
 377 .Pp
 378 will display the last Friday of the month:
 379 .Pp
 380 .Dl "Fri Aug 29 04:31:11 BST 1997"
 381 .Pp
 382 where it is currently
 383 .Li "Mon Aug  4 04:31:11 BST 1997" .
 384 .Pp
 385 The command:
 386 .Pp
 387 .Dl "date 8506131627"
 388 .Pp
 389 sets the date to
 390 .Dq Li "June 13, 1985, 4:27 PM" .
 391 .Pp
 392 .Dl "date ""+%Y%m%d%H%M.%S"""
 393 .Pp
 394 may be used on one machine to print out the date
 395 suitable for setting on another.
 396 .Qq ( Li "+%m%d%H%M%Y.%S"
 397 for use on
 398 .Tn Linux . )
 399 .Pp
 400 The command:
 401 .Pp
 402 .Dl "date 1432"
 403 .Pp
 404 sets the time to
 405 .Li "2:32 PM" ,
 406 without modifying the date.
 407 .Pp
 408 The command
 409 .Pp
 410 .Dl "TZ=America/Los_Angeles date -Iseconds -r 1533415339"
 411 .Pp
 412 will display
 413 .Pp
 414 .Dl "2018-08-04T13:42:19-07:00"
 415 .Pp
 416 Finally the command:
 417 .Pp
 418 .Dl "date -j -f ""%a %b %d %T %Z %Y"" ""`date`"" ""+%s"""
 419 .Pp
 420 can be used to parse the output from
 421 .Nm
 422 and express it in Epoch time.
 423 .Sh DIAGNOSTICS
 424 It is invalid to combine the
 425 .Fl I
 426 flag with either
 427 .Fl R
 428 or an output format
 429 .Dq ( + Ns ... )
 430 operand.
 431 If this occurs,
 432 .Nm
 433 prints:
 434 .Ql multiple output formats specified
 435 and exits with an error status.
 436 .Sh SEE ALSO
 437 .Xr locale 1 ,
 438 .Xr gettimeofday 2 ,
 439 .Xr getutxent 3 ,
 440 .Xr strftime 3 ,
 441 .Xr strptime 3
 442 .Rs
 443 .%T "TSP: The Time Synchronization Protocol for UNIX 4.3BSD"
 444 .%A R. Gusella
 445 .%A S. Zatti
 446 .Re
 447 .Sh STANDARDS
 448 The
 449 .Nm
 450 utility is expected to be compatible with
 451 .St -p1003.2 .
 452 The
 453 .Fl d , f , I , j , r , t ,
 454 and
 455 .Fl v
 456 options are all extensions to the standard.
 457 .Pp
 458 The format selected by the
 459 .Fl I
 460 flag is compatible with
 461 .St -iso8601 .
 462 .Sh HISTORY
 463 A
 464 .Nm
 465 command appeared in
 466 .At v1 .
 467 .Pp
 468 The
 469 .Fl I
 470 flag was added in
 471 .Fx 12.0 .