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