Remove trailing whitespace.
[dockapps.git] / wmtime / wmtime / wmtime.1
blob8b51e57a5ecff58a5282467b85b8bc449f01078f
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 "October 2013" "WMTIME 1.1"
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 .B \-h
74 Show help information.
76 .TP
77 .B \-v
78 Print the version number.
80 .SH USAGE
81 The
82 .B WMTime
83 window is separated into top and bottom sections.  The top section
84 contains a clock and the bottom section contains the date.
86 The clock can be toggled between analog and digital modes.  To do this,
87 click in the bottom section of the window.
89 WMTime can also be used to launch programs.  You may click either left,
90 middle, or right mouse buttons in the top section of the window.  The
91 pre\-configured program will be launched according to the mouse button
92 clicked.  (see
93 .B CONFIGURATION FILE
94 below.)
96 In order to move
97 .BR WMTime ,
98 drag on the outer edges.  These are not sensitive to mouse clicks.
100 .SH "DOCKING IN WINDOW MANAGERS"
103 Window Maker
105 Window Maker users should drag and drop the
106 .B WMTime
107 window on the Dock.  Then, right\-click on the border of the window and
108 select \*(lqSettings...\*(rq.  Check \*(lqStart when Window Maker
109 is started\*(rq.
112 AfterStep
114 AfterStep users should put the following in their
115 .I $HOME/.steprc
117 .RS 16
118 Wharf wmtime \- MaxSwallow "wmtime" wmtime &
122 Other window managers
124 .B WMTime
125 runs nicely as a 64x64 shaped icon on your desktop.
127 .SH "CONFIGURATION FILE"
129 .B WMTime
130 can launch three user\-defined commands, triggered by left, middle and
131 right mouse button clicks.  You can define the commands to launch in
132 .I $HOME/.wmtimerc
135 .PD 0
136 left: xterm
138 middle: xload
140 right: xcalc
146 .B WMTime
147 detects a
148 .I $HOME/.wmtimerc
149 file, it will launch the appropriate command when you click on the clock.
151 The system administrator can define default commands in
152 .IR /etc/wmtimerc .
153 The administrator may also choose to \*(lqfix\*(rq particular commands,
154 making it impossible for users to change.  These commands can be defined in
155 .IR /etc/wmtimerc.fixed ,
156 although this isn't a nice thing to do.
158 .SH FILES
160 .I /etc/wmtimerc
162 .I $HOME/.wmtimerc
164 .I /etc/wmtimerc.fixed
166 .SH AUTHORS
168 .B WMTime
169 was written by Martijn Pieterse and Antoine Nulle.
171 This manual page was written by Simon Law <sfllaw@debian.org> for the
172 .B Debian
173 system (but may be used by others). It is based on the documentation provided
174 by the original program.
176 This manual is free software; you can redistribute it and/or modify
177 it under the terms of the GNU General Public License as published by
178 the Free Software Foundation; either version 2 of the License, or (at
179 your option) any later version.