wmtime - increase version number to 1.1
[dockapps.git] / wmtime / wmtime / wmtime.1
blob08dbd3520d90ad3aa16f18f97a0c66c3dd75197d
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
18 .\"
19 .TH WMTIME 1 "October 2013" "WMTIME 1.1"
21 .SH NAME
22 wmtime \- Window Maker dockapp that displays the time and date
24 .SH SYNOPSIS
26 .B wmtime
28 .I OPTION
31 .SH DESCRIPTION
33 .B WMTime
34 displays the time and date and gives you some nice additional
35 features too. It is intended for docking in Window Maker.
37 It currently provides:
39 .IP \(bu 4
40 the time and date;
42 .IP \(bu
43 a realtime morphing interface (analog <> digital mode);
44 .IP \(bu
45 auto\-scaled and anti\-aliased hands;
46 .IP \(bu
47 localization, displaying the day and date in various languages;
48 .IP \(bu
49 three user\-defined commands to launch.
51 .SH OPTIONS
53 .TP
54 .BR \-d , \ \-digital
55 Display the digital clock on startup, instead of the analog clock.
57 .TP
58 .BI \-display \ display
59 This option specifies the X server to contact; see
60 .IR X(7x) .
62 .TP
63 .BI \-geometry \ geometry
64 This option specifies the preferred position of clock; see
65 .IR X(7x) .
67 .TP
68 .BR \-n , \ \-noseconds
69 Disables the second hand.
71 .TP
72 .B \-h
73 Show help information.
75 .TP
76 .B \-v
77 Print the version number.
79 .SH USAGE
80 The
81 .B WMTime
82 window is separated into top and bottom sections.  The top section
83 contains a clock and the bottom section contains the date.
85 The clock can be toggled between analog and digital modes.  To do this,
86 click in the bottom section of the window.
88 WMTime can also be used to launch programs.  You may click either left,
89 middle, or right mouse buttons in the top section of the window.  The
90 pre\-configured program will be launched according to the mouse button
91 clicked.  (see
92 .B CONFIGURATION FILE
93 below.)
95 In order to move
96 .BR WMTime ,
97 drag on the outer edges.  These are not sensitive to mouse clicks.
99 .SH "DOCKING IN WINDOW MANAGERS"
102 Window Maker
104 Window Maker users should drag and drop the
105 .B WMTime
106 window on the Dock.  Then, right\-click on the border of the window and
107 select \*(lqSettings...\*(rq.  Check \*(lqStart when Window Maker
108 is started\*(rq.
111 AfterStep
113 AfterStep users should put the following in their
114 .I $HOME/.steprc
116 .RS 16
117 Wharf wmtime \- MaxSwallow "wmtime" wmtime &
121 Other window managers
123 .B WMTime
124 runs nicely as a 64x64 shaped icon on your desktop.
126 .SH "CONFIGURATION FILE"
128 .B WMTime
129 can launch three user\-defined commands, triggered by left, middle and
130 right mouse button clicks.  You can define the commands to launch in
131 .I $HOME/.wmtimerc
134 .PD 0
135 left: xterm
137 middle: xload
139 right: xcalc
141 .PD 
145 .B WMTime
146 detects a
147 .I $HOME/.wmtimerc
148 file, it will launch the appropriate command when you click on the clock.
150 The system administrator can define default commands in
151 .IR /etc/wmtimerc .
152 The administrator may also choose to \*(lqfix\*(rq particular commands,
153 making it impossible for users to change.  These commands can be defined in
154 .IR /etc/wmtimerc.fixed ,
155 although this isn't a nice thing to do.
157 .SH FILES
159 .I /etc/wmtimerc
161 .I $HOME/.wmtimerc
163 .I /etc/wmtimerc.fixed
165 .SH AUTHORS
167 .B WMTime
168 was written by Martijn Pieterse and Antoine Nulle.
170 This manual page was written by Simon Law <sfllaw@debian.org> for the
171 .B Debian
172 system (but may be used by others). It is based on the documentation provided
173 by the original program.
175 This manual is free software; you can redistribute it and/or modify
176 it under the terms of the GNU General Public License as published by
177 the Free Software Foundation; either version 2 of the License, or (at
178 your option) any later version.