wmweather+: Remove from repository.
[dockapps.git] / wmtime / wmtime.1
blob686c1515d2bb9a1ac0c21d82ef396497f9caba29
1 '\" t
2 .\" Man page for wmtime
3 .\" Copyright (c) 2003  Software in the Public Interest, Inc.
4 .\"
5 .\" This program is free software; you can redistribute it and/or modify
6 .\" it under the terms of the GNU General Public License as published by
7 .\" the Free Software Foundation; either version 2 of the License, or (at
8 .\" your option) any later version.
9 .\"
10 .\" This program is distributed in the hope that it will be useful, but
11 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13 .\" General Public License for more details.
14 .\"
15 .\" You should have received a copy of the GNU General Public License
16 .\" along with this program; if not, write to the Free Software
17 .\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
18 .\" USA.
19 .\"
20 .TH WMTIME 1 "January 2015" "WMTIME"
22 .SH NAME
23 wmtime \- Window Maker dockapp that displays the time and date
25 .SH SYNOPSIS
27 .B wmtime
29 .I OPTION
32 .SH DESCRIPTION
34 .B WMTime
35 displays the time and date and gives you some nice additional
36 features too. It is intended for docking in Window Maker.
38 It currently provides:
40 .IP \(bu 4
41 the time and date;
43 .IP \(bu
44 a realtime morphing interface (analog <> digital mode);
45 .IP \(bu
46 auto\-scaled and anti\-aliased hands;
47 .IP \(bu
48 localization, displaying the day and date in various languages;
49 .IP \(bu
50 three user\-defined commands to launch.
52 .SH OPTIONS
54 .TP
55 .BR \-d , \ \-digital
56 Display the digital clock on startup, instead of the analog clock.
58 .TP
59 .BI \-display \ display
60 This option specifies the X server to contact; see
61 .IR X(7x) .
63 .TP
64 .BI \-geometry \ geometry
65 This option specifies the preferred position of clock; see
66 .IR X(7x) .
68 .TP
69 .BR \-n , \ \-noseconds
70 Disables the second hand.
72 .TP
73 .BI \-l \ locale
74 Specify locale.
76 .TP
77 .B \-h
78 Show help information.
80 .TP
81 .B \-v
82 Print the version number.
84 .SH USAGE
85 The
86 .B WMTime
87 window is separated into top and bottom sections.  The top section
88 contains a clock and the bottom section contains the date.
90 The clock can be toggled between analog and digital modes.  To do this,
91 click in the bottom section of the window.
93 WMTime can also be used to launch programs.  You may click either left,
94 middle, or right mouse buttons in the top section of the window.  The
95 pre\-configured program will be launched according to the mouse button
96 clicked.  (see
97 .B CONFIGURATION FILE
98 below.)
100 In order to move
101 .BR WMTime ,
102 drag on the outer edges.  These are not sensitive to mouse clicks.
104 .SH "DOCKING IN WINDOW MANAGERS"
107 Window Maker
109 Window Maker users should drag and drop the
110 .B WMTime
111 window on the Dock.  Then, right\-click on the border of the window and
112 select \*(lqSettings...\*(rq.  Check \*(lqStart when Window Maker
113 is started\*(rq.
116 AfterStep
118 AfterStep users should put the following in their
119 .I $HOME/.steprc
121 .RS 16
122 Wharf wmtime \- MaxSwallow "wmtime" wmtime &
126 Other window managers
128 .B WMTime
129 runs nicely as a 64x64 shaped icon on your desktop.
131 .SH "CONFIGURATION FILE"
133 .B WMTime
134 can launch three user\-defined commands, triggered by left, middle and
135 right mouse button clicks.  You can define the commands to launch in
136 .I $HOME/.wmtimerc
139 .PD 0
140 left: xterm
142 middle: xload
144 right: xcalc
150 .B WMTime
151 detects a
152 .I $HOME/.wmtimerc
153 file, it will launch the appropriate command when you click on the clock.
155 The system administrator can define default commands in
156 .IR /etc/wmtimerc .
157 The administrator may also choose to \*(lqfix\*(rq particular commands,
158 making it impossible for users to change.  These commands can be defined in
159 .IR /etc/wmtimerc.fixed ,
160 although this isn't a nice thing to do.
162 .SH FILES
164 .I /etc/wmtimerc
166 .I $HOME/.wmtimerc
168 .I /etc/wmtimerc.fixed
170 .SH AUTHORS
172 .B WMTime
173 was written by Martijn Pieterse and Antoine Nulle.
175 This manual page was written by Simon Law <sfllaw@debian.org> for the
176 .B Debian
177 system (but may be used by others). It is based on the documentation provided
178 by the original program.
180 This manual is free software; you can redistribute it and/or modify
181 it under the terms of the GNU General Public License as published by
182 the Free Software Foundation; either version 2 of the License, or (at
183 your option) any later version.