annotate zotnet/tws/phoon/libtws.man @ 0:bce86c4163a3

Initial revision
author kono
date Mon, 18 Apr 2005 23:46:02 +0900
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bce86c4163a3 Initial revision
kono
parents:
diff changeset
1 .TH libtws 3 "08 November 1986"
bce86c4163a3 Initial revision
kono
parents:
diff changeset
2 .SH NAME
bce86c4163a3 Initial revision
kono
parents:
diff changeset
3 libtws \- alternate date and time routines including parsing
bce86c4163a3 Initial revision
kono
parents:
diff changeset
4 .SH SYNOPSIS
bce86c4163a3 Initial revision
kono
parents:
diff changeset
5 .nf
bce86c4163a3 Initial revision
kono
parents:
diff changeset
6 .fc ^ ~
bce86c4163a3 Initial revision
kono
parents:
diff changeset
7 .ta \w'char *dtimezone( offset, flags ); 'u
bce86c4163a3 Initial revision
kono
parents:
diff changeset
8 include "tws.h"
bce86c4163a3 Initial revision
kono
parents:
diff changeset
9 .PP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
10 ^struct tws *dlocaltime( clock );~^/* local clock into tws */
bce86c4163a3 Initial revision
kono
parents:
diff changeset
11 long *clock;
bce86c4163a3 Initial revision
kono
parents:
diff changeset
12 .PP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
13 ^struct tws *gmtime( clock );~^/* GMT clock into tws */
bce86c4163a3 Initial revision
kono
parents:
diff changeset
14 long *clock;
bce86c4163a3 Initial revision
kono
parents:
diff changeset
15 .PP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
16 ^char *dtime( clock );~^/* clock into string */
bce86c4163a3 Initial revision
kono
parents:
diff changeset
17 long *clock;
bce86c4163a3 Initial revision
kono
parents:
diff changeset
18 .PP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
19 ^long twclock( t );~^/* tws into clock */
bce86c4163a3 Initial revision
kono
parents:
diff changeset
20 struct tws *t;
bce86c4163a3 Initial revision
kono
parents:
diff changeset
21 .PP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
22 ^long twjuliandate( t );~^/* tws into Julian day number */
bce86c4163a3 Initial revision
kono
parents:
diff changeset
23 struct tws *t;
bce86c4163a3 Initial revision
kono
parents:
diff changeset
24 .PP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
25 ^struct tws *dparsetime( str );~^/* string into tws */
bce86c4163a3 Initial revision
kono
parents:
diff changeset
26 char *str;
bce86c4163a3 Initial revision
kono
parents:
diff changeset
27 .PP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
28 ^char *dctime( t );~^/* tws into string */
bce86c4163a3 Initial revision
kono
parents:
diff changeset
29 struct tws *t;
bce86c4163a3 Initial revision
kono
parents:
diff changeset
30 .PP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
31 ^char *dasctime( t, flags );~^/* tws into string */
bce86c4163a3 Initial revision
kono
parents:
diff changeset
32 struct tws *t;
bce86c4163a3 Initial revision
kono
parents:
diff changeset
33 int flags;
bce86c4163a3 Initial revision
kono
parents:
diff changeset
34 .PP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
35 ^char *dtimezone( offset, flags );~^/* timezone into string */
bce86c4163a3 Initial revision
kono
parents:
diff changeset
36 int offset, flags;
bce86c4163a3 Initial revision
kono
parents:
diff changeset
37 .PP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
38 ^char *dtwszone( t );~^/* tws's timezone into string */
bce86c4163a3 Initial revision
kono
parents:
diff changeset
39 struct tws *t;
bce86c4163a3 Initial revision
kono
parents:
diff changeset
40 .PP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
41 ^char *dtimemow( );~^/* current time into string */
bce86c4163a3 Initial revision
kono
parents:
diff changeset
42 .PP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
43 ^struct tws *dtwstime( );~^/* current time into tws */
bce86c4163a3 Initial revision
kono
parents:
diff changeset
44 .PP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
45 ^void twscopy( tot, fromt );~^/* copy a tws */
bce86c4163a3 Initial revision
kono
parents:
diff changeset
46 struct tws *tot, *fromt;
bce86c4163a3 Initial revision
kono
parents:
diff changeset
47 .PP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
48 ^int twsort( t1, t2 );~^/* compare two tws's */
bce86c4163a3 Initial revision
kono
parents:
diff changeset
49 struct tws *t1, *t2;
bce86c4163a3 Initial revision
kono
parents:
diff changeset
50 .PP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
51 ^long twsubtract( t1, t2 );~^/* seconds between t2 and t1 */
bce86c4163a3 Initial revision
kono
parents:
diff changeset
52 struct tws *t1, *t2;
bce86c4163a3 Initial revision
kono
parents:
diff changeset
53 .fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
54 .SH DESCRIPTION
bce86c4163a3 Initial revision
kono
parents:
diff changeset
55 .I Libtws
bce86c4163a3 Initial revision
kono
parents:
diff changeset
56 is a fairly complete date/time library.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
57 Unlike the standard Unix date/time routines,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
58 .I libtws
bce86c4163a3 Initial revision
kono
parents:
diff changeset
59 will parse date/time strings into internal form.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
60 The format for specifying date/time strings is pretty loose - basically
bce86c4163a3 Initial revision
kono
parents:
diff changeset
61 the same as the format for date/times in network mail.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
62 .PP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
63 Most of the routines do not use the Unix(R) "clock" time
bce86c4163a3 Initial revision
kono
parents:
diff changeset
64 format, and therefore are not limited to dates after 01 January 1970.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
65 In particular, twsubtract() lets you subtract two dates without
bce86c4163a3 Initial revision
kono
parents:
diff changeset
66 converting them to "clock" form.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
67 .SH "SEE\ ALSO"
bce86c4163a3 Initial revision
kono
parents:
diff changeset
68 .IR ctime(3),
bce86c4163a3 Initial revision
kono
parents:
diff changeset
69 .IR time(3)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
70 .SH AUTHOR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
71 Most of
bce86c4163a3 Initial revision
kono
parents:
diff changeset
72 .I libtws
bce86c4163a3 Initial revision
kono
parents:
diff changeset
73 came from version 6.5 of the MH message
bce86c4163a3 Initial revision
kono
parents:
diff changeset
74 handling system, courtesy of Marshall Rose.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
75 Some improvements (?) were added by Jef Poskanzer.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
76 .SH BUGS
bce86c4163a3 Initial revision
kono
parents:
diff changeset
77 The return values point to static data whose contents are overwritten
bce86c4163a3 Initial revision
kono
parents:
diff changeset
78 by the next call.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
79 .PP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
80 The basic Unix time format (clock) only goes back to 1970, limiting
bce86c4163a3 Initial revision
kono
parents:
diff changeset
81 applications somewhat.