8815 mega_sas: variable set but not used
[unleashed.git] / usr / src / man / man1 / date.1
blobb99617447247d53e34cfbe647bdd3273376a739e
1 '\" te
2 .\" Copyright 2011 Nexenta Systems, Inc.  All rights reserved.
3 .\" Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved
4 .\" Copyright 1989 AT&T
5 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
6 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
7 .\" http://www.opengroup.org/bookstore/.
8 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
9 .\"  This notice shall appear on any product containing this material.
10 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
11 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
12 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
13 .TH DATE 1 "May 1, 2011"
14 .SH NAME
15 date \- write the date and time
16 .SH SYNOPSIS
17 .LP
18 .nf
19 \fB/usr/bin/date\fR [\fB-u\fR] [\fB-R\fR] [+\fIformat\fR]
20 .fi
22 .LP
23 .nf
24 \fB/usr/bin/date\fR [\fB-a\fR [-]\fIsss.fff\fR]
25 .fi
27 .LP
28 .nf
29 \fB/usr/bin/date\fR [\fB-u\fR] [ [\fImmdd\fR] \fIHHMM\fR | \fImmddHHMM\fR [\fIcc\fR] \fIyy\fR] [\fI\&.SS\fR]
30 .fi
32 .LP
33 .nf
34 \fB/usr/xpg4/bin/date\fR [\fB-u\fR] [\fB-R\fR] [+\fIformat\fR]
35 .fi
37 .LP
38 .nf
39 \fB/usr/xpg4/bin/date\fR [\fB-a\fR [-]\fIsss.fff\fR]
40 .fi
42 .LP
43 .nf
44 \fB/usr/xpg4/bin/date\fR [\fB-u\fR]
45      [ [\fImmdd\fR] \fIHHMM\fR | \fImmddHHMM\fR [\fIcc\fR] \fIyy\fR] [\fI\&.SS\fR]
46 .fi
48 .SH DESCRIPTION
49 .sp
50 .LP
51 The \fBdate\fR utility writes the date and time to standard output or attempts
52 to set the system date and time. By default, the current date and time is
53 written.
54 .sp
55 .LP
56 Specifications of native language translations of month and weekday names are
57 supported. The month and weekday names used for a language are based on the
58 locale specified by the environment variable \fBLC_TIME\fR. See
59 \fBenviron\fR(5).
60 .sp
61 .LP
62 The following is the default form for the "C" locale:
63 .sp
64 .in +2
65 .nf
66 \fI%a %b %e %T %Z %Y\fR
67 .fi
68 .in -2
70 .sp
71 .LP
72 For example,
73 .sp
74 .in +2
75 .nf
76 Fri Dec 23 10:10:42 EST 1988
77 .fi
78 .in -2
79 .sp
81 .SH OPTIONS
82 .sp
83 .LP
84 The following options are supported:
85 .sp
86 .ne 2
87 .na
88 \fB\fB-a\fR [\|\fB-\fR\|]\|\fIsss.fff\fR \fR
89 .ad
90 .RS 24n
91 Slowly adjust the time by \fIsss\fR.\fIfff\fR seconds (\fIfff\fR represents
92 fractions of a second). This adjustment can be positive or negative. The
93 system's clock is sped up or slowed down until it has drifted by the number of
94 seconds specified. Only the super-user may adjust the time.
95 .RE
97 .sp
98 .ne 2
99 .na
100 \fB\fB-u\fR \fR
102 .RS 24n
103 Display (or set) the date in Greenwich Mean Time (GMT\(emuniversal time),
104 bypassing the normal conversion to (or from) local time.
108 .ne 2
110 \fB-R\fR
112 .RS 24n
113 Change the default format to the format used for mail message headers
114 (similar to RFC 822 format).  The default format becomes
116 .in +2
118 \fI%a, %d %h %Y %H:%M:%S %z\fR
120 .in -2
123 .SH OPERANDS
126 The following operands are supported:
128 .ne 2
130 \fB\fB+\fR\fIformat\fR \fR
132 .RS 12n
133 If the argument begins with \fB+\fR, the output of \fBdate\fR is the result of
134 passing \fIformat\fR and the current time to \fBstrftime()\fR. \fBdate\fR uses
135 the conversion specifications listed on the \fBstrftime\fR(3C) manual page,
136 with the conversion specification for \fB%C\fR determined by whether
137 \fB/usr/bin/date\fR or \fB/usr/xpg4/bin/date\fR is used:
139 .ne 2
141 \fB\fB/usr/bin/date\fR \fR
143 .RS 23n
144 Locale's date and time representation. This is the default output for
145 \fBdate\fR.
149 .ne 2
151 \fB\fB/usr/xpg4/bin/date\fR \fR
153 .RS 23n
154 Century (a year divided by 100 and truncated to an integer) as a decimal number
155 [00-99].
158 In addition, the nonstandard conversion specification \fB%N\fR is also
159 supported, and is converted to the zero-padded number of nanoseconds since the
160 last second.  Note that the actual resolution of this number is limited to the
161 resolution of the system's \fBCLOCK_REALTIME\fR clock.  See
162 \fBclock_gettime\fR(3C).
164 The string is always terminated with a NEWLINE. An argument containing blanks
165 must be quoted; see the EXAMPLES section.
169 .ne 2
171 \fB\fImm\fR \fR
173 .RS 12n
174 Month number
178 .ne 2
180 \fB\fIdd\fR \fR
182 .RS 12n
183 Day number in the month
187 .ne 2
189 \fB\fIHH\fR \fR
191 .RS 12n
192 Hour number (24 hour system)
196 .ne 2
198 \fB\fIMM\fR \fR
200 .RS 12n
201 Minute number
205 .ne 2
207 \fB\fISS\fR \fR
209 .RS 12n
210 Second number
214 .ne 2
216 \fB\fIcc\fR \fR
218 .RS 12n
219 Century (a year divided by 100 and truncated to an integer) as a decimal number
220 [00-99]. For example, \fIcc\fR is \fB19\fR for the year 1988 and \fB20\fR for
221 the year 2007.
225 .ne 2
227 \fB\fIyy\fR \fR
229 .RS 12n
230 Last two digits of the year number. If century (\fIcc\fR) is not specified,
231 then values in the range \fB69-99\fR shall refer to years 1969 to 1999
232 inclusive, and values in the range \fB00-68\fR shall refer to years 2000 to
233 2068, inclusive.
238 The month, day, year number, and century may be omitted; the current values are
239 applied as defaults. For example, the following entry:
241 .in +2
243 example% \fBdate 10080045\fR
245 .in -2
250 sets the date to Oct 8, 12:45 a.m. The current year is the default because no
251 year is supplied. The system operates in GMT. \fBdate\fR takes care of the
252 conversion to and from local standard and daylight time. Only the super-user
253 may change the date. After successfully setting the date and time, \fBdate\fR
254 displays the new date according to the default format. The \fBdate\fR command
255 uses \fBTZ\fR to determine the correct time zone information; see
256 \fBenviron\fR(5).
257 .SH EXAMPLES
259 \fBExample 1 \fRGenerating Output
262 The following command:
265 .in +2
267 example% \fBdate '+DATE: %m/%d/%y%nTIME:%H:%M:%S'\fR
269 .in -2
274 generates as output
277 .in +2
279 DATE: 08/01/76
281 TIME: 14:45:05
283 .in -2
287 \fBExample 2 \fRSetting the Current Time
290 The following command sets the current time to \fB12:34:56\fR:
293 .in +2
295 example# \fBdate 1234.56\fR
297 .in -2
301 \fBExample 3 \fRSetting Another Time and Date in Greenwich Mean Time
304 The following command sets the date to January 1st, 12:30 am, 2000:
307 .in +2
309 example# \fBdate -u 010100302000\fR
311 .in -2
316 This is displayed as:
319 .in +2
321 Thu Jan 01 00:30:00 GMT 2000
323 .in -2
326 .SH ENVIRONMENT VARIABLES
329 See \fBenviron\fR(5) for descriptions of the following environment variables
330 that affect the execution of \fBdate\fR: \fBLANG\fR, \fBLC_ALL\fR,
331 \fBLC_CTYPE\fR, \fBLC_TIME\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
333 .ne 2
335 \fB\fBTZ\fR \fR
337 .RS 7n
338 Determine the timezone in which the time and date are written, unless the
339 \fB-u\fR option is specified. If the \fBTZ\fR variable is not set and the
340 \fB-u\fR is not specified, the system default timezone is used.
343 .SH EXIT STATUS
346 The following exit values are returned:
348 .ne 2
350 \fB\fB0\fR \fR
352 .RS 7n
353 Successful completion.
357 .ne 2
359 \fB\fB>0\fR \fR
361 .RS 7n
362 An error occurred.
365 .SH ATTRIBUTES
368 See \fBattributes\fR(5) for descriptions of the following attributes:
369 .SS "/usr/bin/date"
374 box;
375 c | c
376 l | l .
377 ATTRIBUTE TYPE  ATTRIBUTE VALUE
379 CSI     enabled
382 .SS "/usr/xpg4/bin/date"
387 box;
388 c | c
389 l | l .
390 ATTRIBUTE TYPE  ATTRIBUTE VALUE
392 CSI     enabled
394 Interface Stability     Standard
397 .SH SEE ALSO
400 \fBstrftime\fR(3C), \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5)
401 .SH DIAGNOSTICS
403 .ne 2
405 \fB\fBno permission\fR \fR
407 .RS 19n
408 You are not the super-user and you tried to change the date.
412 .ne 2
414 \fB\fBbad conversion\fR \fR
416 .RS 19n
417 The date set is syntactically incorrect.
420 .SH NOTES
423 If you attempt to set the current date to one of the dates that the standard
424 and alternate time zones change (for example, the date that daylight time is
425 starting or ending), and you attempt to set the time to a time in the interval
426 between the end of standard time and the beginning of the alternate time (or
427 the end of the alternate time and the beginning of standard time), the results
428 are unpredictable.
431 Using the \fBdate\fR command from within windowing environments to change the
432 date can lead to unpredictable results and is unsafe. It can also be unsafe in
433 the multi-user mode, that is, outside of a windowing system, if the date is
434 changed rapidly back and forth. The recommended method of changing the date
435 is '\fBdate\fR \fB-a\fR'.
438 Setting the system time or allowing the system time to progress beyond
439 \fB03:14:07 UTC Jan 19, 2038\fR is not supported on Solaris.