chiark / gitweb /
option for no inotify; manpage fix
[innduct.git] / doc / man / convdate.1
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70 .    \" fudge factors for nroff and troff
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 .    \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "CONVDATE 1"
132 .TH CONVDATE 1 "2008-04-06" "INN 2.4.5" "InterNetNews Documentation"
133 .SH "NAME"
134 convdate \- Convert time/date strings and numbers
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 \&\fBconvdate\fR [\fB\-dhl\fR] [\fB\-c\fR | \fB\-n\fR | \fB\-s\fR] [\fIdate\fR ...]
138 .SH "DESCRIPTION"
139 .IX Header "DESCRIPTION"
140 \&\fBconvdate\fR translates the date/time strings given on the command line,
141 outputting the results one to a line.  The input can either be a date in
142 some format that \fIparsedate\fR\|(3) can parse or the number of seconds since
143 epoch (if \fB\-c\fR is given).  The output is either \fIctime\fR\|(3) results, the
144 number of seconds since epoch, or a Usenet Date: header, depending on the
145 options given.
146 .SH "OPTIONS"
147 .IX Header "OPTIONS"
148 .IP "\fB\-c\fR" 4
149 .IX Item "-c"
150 Each argument is taken to be the number of seconds since epoch (a time_t)
151 rather than a date.
152 .IP "\fB\-d\fR" 4
153 .IX Item "-d"
154 Output a valid Usenet Date: header instead of the results of \fIctime\fR\|(3) for
155 each date given on the command line.  This is useful for testing the
156 algorithm used to generate Date: headers for local posts.  Normally, the
157 date will be in \s-1UTC\s0, but see the \fB\-l\fR option.
158 .IP "\fB\-h\fR" 4
159 .IX Item "-h"
160 Print usage information and exit.
161 .IP "\fB\-l\fR" 4
162 .IX Item "-l"
163 Only makes sense in combination with \fB\-d\fR.  If given, Date: headers
164 generated will use the local time zone instead of \s-1UTC\s0.
165 .IP "\fB\-n\fR" 4
166 .IX Item "-n"
167 Rather than outputting the results of \fIctime\fR\|(3) or a Date: header, output
168 each date given as the number of seconds since epoch (a time_t).  This
169 option doesn't make sense in combination with \fB\-d\fR.
170 .IP "\fB\-s\fR" 4
171 .IX Item "-s"
172 Pass each given date to \fIparsedate\fR\|(3) and print the results of \fIctime\fR\|(3) (or
173 a Date: header if \fB\-d\fR is given).  This is the default behavior.
174 .SH "EXAMPLES"
175 .IX Header "EXAMPLES"
176 Note that relative times or times with partial information use the current
177 time to fill in the rest of the date, so dates like \*(L"12pm\*(R" are taken to be
178 12pm of the day when convdate is run.  This is a property of \fIparsedate\fR\|(3);
179 see the man page for more information.  Most of these examples are from
180 the original man page dating from 1991 and were run in the \-0400 time
181 zone.
182 .PP
183 .Vb 2
184 \&    % convdate 'feb 10 10am'
185 \&    Sun Feb 10 10:00:00 1991
186 .Ve
187 .PP
188 .Vb 3
189 \&    % convdate 12pm 5/4/90
190 \&    Fri Dec 13 00:00:00 1991
191 \&    Fri May  4 00:00:00 1990
192 .Ve
193 .PP
194 Note that 12pm and 5/4/90 are two *separate* arguments and therefore
195 result in two results.  Note also that a date with no time is taken to be
196 at midnight.
197 .PP
198 .Vb 3
199 \&    % convdate \-n 'feb 10 10am' '12pm 5/4/90'
200 \&    666198000
201 \&    641880000
202 .Ve
203 .PP
204 .Vb 2
205 \&    % convdate \-c 666198000
206 \&    Sun Feb 10 10:00:00 1991
207 .Ve
208 .PP
209 \&\fIctime\fR\|(3) results are in the local time zone.  Compare to:
210 .PP
211 .Vb 2
212 \&    % convdate \-dc 666198000
213 \&    Sun, 10 Feb 1991 15:00:00 +0000 (UTC)
214 .Ve
215 .PP
216 .Vb 2
217 \&    % env TZ=PST8PDT convdate \-dlc 666198000
218 \&    Sun, 10 Feb 1991 07:00:00 \-0800 (PST)
219 .Ve
220 .PP
221 .Vb 2
222 \&    % env TZ=EST5EDT convdate \-dlc 666198000
223 \&    Sun, 10 Feb 1991 10:00:00 \-0500 (EST)
224 .Ve
225 .PP
226 The system library functions generally use the environment variable \s-1TZ\s0 to
227 determine (or at least override) the local time zone.
228 .SH "HISTORY"
229 .IX Header "HISTORY"
230 Written by Rich \f(CW$alz\fR <rsalz@uunet.uu.net>, rewritten and updated by Russ
231 Allbery <rra@stanford.edu> for the \fB\-d\fR and \fB\-l\fR flags.
232 .PP
233 $Id: convdate.1 7880 2008-06-16 20:37:13Z iulius $
234 .SH "SEE ALSO"
235 .IX Header "SEE ALSO"
236 \&\fIparsedate\fR\|(3).