wmshutdown: Destroy dialog window before shutting down. This is especially useful...
[dockapps.git] / wmtz / wmtz / wmtz.1
blobe4ee5a34de1f5e3d5ba72e3b22b4c6c2b64d7cfd
1 .TH wmtz 1 "16 April 2001"
2 .SH NAME
3 WMTZ \- Window Make Time Zone dockapp
4 .SH SYNOPSIS
5 .B wmtz [-display <Display>] [-e <Editor>] [-geometry <+XPOS+YPOS>] [-jd] [-c <Filename>] [-h] [-v]
6 .SH DESCRIPTION
7 .PP
8 wmtz displays the time in different time zones and can also show Julian day
9 numbers, sidereal time, internet time (swatch beats) and local time, date
10 and weekday. wmtz can also convert between JD and Gregorian dates via a
11 command line interface. It is configured via a text configuration file,
12 usually ~/.wmtzrc. If wmtz is clicked on with the mouse it shows a menu
13 where the configuration can be changed and updated. wmtz can also be shut
14 down with this menu by clicking on QUIT.
15 .SH OPTIONS
16 .TP
17 .B \-display <Display>
18 Use an alternate X Display.
19 .TP
20 .B \-e <Editor>
21 Set preferred text editor to use when CONFIG on the menu is choosen. (E.g. xemacs or xjed)
22 .TP
23 .B \-geometry <+XPOS+YPOS>
24 Set position on X display.
25 .TP
26 .B \-jd
27 Invoke JD conversion utility.
28 .TP
29 .B \-c <Filename>
30 Use specified file as configuration file.
31 .TP
32 .B -m
33 Start monochrome version of wmtz. Use this when there isn't enough color cells.
34 .TP
35 .B -h
36 Display list of command line options.
37 .TP
38 .B -v
39 Print version number.
40 .SH CONFIGURATION
41 wmtz is configured with a configuration file, usually ~/.wmtzrc. In this
42 file several values must be given in order for wmtz to function properly.
43 It is recommended to use the configuration file that follows with the
44 distribution and modify it according to your needs. wmtz has five "timeslots"
45 that can show different times.
46 .br
47 What must be present in the file is the "time*=<string>" token for every
48 timeslot (1 to 5), followed by the "utdiff*=<integer>" for every timeslot
49 (1 to 5) even if it is to be ignored. "longitude=<longitude in decimal
50 degrees>" must also be given in the config file.
51 .br
52 The options available for "time*=" are the following:
53 .TP
54 .B ***
55 Three (or less) letter designation of timezone. utdiff for this timeslot is
56 subtracted from UT to give time in that timezone.
57 .TP
58 .B TZONE
59 Gives time in timezone described by TZ environment variable string in utdiff. See man page for tzset for a description of the TZ string.
60 .TP
61 .B JDN
62 Gives Julian Day Number. The value for utdiff for the timeslot is subtracted
63 from the current JD, which enables you to show JD from another epoch.
64 .TP
65 .B xxx
66 Gives a blank (empty) timeslot. utdiff for this timeslot is ignored.
67 .TP
68 .B @
69 Gives swatch beats. utdiff for this timeslot is ignored.
70 .TP
71 .B DATE
72 Gives local date. utdiff for this timeslot is ignored.
73 .TP
74 .B WDAY
75 Gives local weekday. utdiff for this timeslot is ignored.
76 .TP
77 .B LOCAL
78 Gives local time, automatically corrected for summer/winter time. utdiff for
79 this timeslot is ignored.
80 .SH ENVIRONMENT
81 .TP
82 .B XEDITOR
83 Can be used to specify which editor to use when clicking on "Config" in the
84 wmtz menu. See also the "-e <Editor>" option above.
85 .TP
86 .B HOME
87 Must be set for wmtz to find the users config file.
88 .PP
89 The config file is
90 searched for in the following order:
91 .br
92 1) User specified config file, if any.
93 .br
94 2) $HOME/.wmtzrc
95 .br
96 3) /etc/wmtzrc
97 .SH FILES
98 .nf
99 ~/.wmtzrc     Users personal configuration file
100 /etc/wmtzrc   Systems configuration file (usually just a fallback)
102 .SH BUGS
103 Doesn't handle errors in the configuration file very well. Be careful when
104 editing .wmtzrc.
105 .SH AUTHOR
106 Jan Lindblom <99jl@home.se>