← Back to branch summary

~ubuntu-branches/ubuntu/maverick/xwrits/maverick

« back to all changes in this revision

Viewing changes to .pc/debian-changes-2.21-6.1/xwrits.1

  • Committer: Bazaar Package Importer
  • Author(s): Jari Aalto, Jari Aalto
  • Date: 2010-05-04 21:39:32 UTC
  • Revision ID: james.westby@ubuntu.com-20100504213932-xr0zn8k1xe99bx54
Tags: 2.21-6.1
http://bugs.debian.org/579038
[ Jari Aalto ]
* Non-maintainer upload.
  - Move to packaging format "3.0 (quilt)".
* debian/clean
  - Mew file.
* debian/compat
  - New file.
* debian/control
  - (Build-Depends): update obsolete xutils to xutils-dev.
    (important; Closes: #579038). Remove *-1 version suffix
    from texinfo dependency. Update to debhelper 7.1.
  - (Depends): add ${misc:Depends}.
  - (Homepage): New field.
  - (Standards-Version): update to 3.8.4.
* debian/copyright
  - Update layout and point to GPL-2.
* debian/rules
  - Delete EOL whitespaces.
  - (DH_COMPAT): Remove.
  - (install): Update dh_clean to dh_prep.
  - (clean): Fix lintian debian-rules-ignores-make-clean-error.
* debian/source/format
  - New file.
* debian/watch
  - New file.
* xwrits.1
  - Fix hyphens.

Show diffs side-by-side

added added

removed removed

Lines of Context:
.pc/debian-changes-2.21-6.1/xwrits.1
 
1
.\" -*- mode: nroff -*-
 
2
.ds V 2.21
 
3
.ds E " \-\- 
 
4
.if t .ds E \(em
 
5
'
 
6
.TH XWRITS 1 "8 Feb 2002" "Version \*V"
 
7
.SH NAME
 
8
xwrits \- reminds you to take wrist breaks
 
9
.SH SYNOPSIS
 
10
.B xwrits
 
11
\%[\-display \fIdisplay\fP]
 
12
\%[typetime=\fItime\fP]
 
13
\%[breaktime=\fItime\fP]
 
14
\%[other options]
 
15
.SH DESCRIPTION
 
16
\fBXwrits\fP reminds you to take wrist breaks for prevention or management
 
17
of repetitive stress injuries. When you should take a break, it pops up an
 
18
X window, the warning window. You click on the warning window, then take a
 
19
break. The window changes appearance while you take the break. It changes
 
20
again when your break is over. Then you just resume typing. Xwrits hides
 
21
itself until you should take another break.
 
22
.PP
 
23
The \fBtypetime\fP option changes the amount of time between breaks, and
 
24
the \fBbreaktime\fP option changes the length of a break. The defaults are
 
25
55 minutes and 5 minutes, respectively.
 
26
.PP
 
27
Xwrits's graphics are brightly colored pictures of a wrist and hand. The
 
28
hand clenches and spreads ``as if in pain'' on the warning window, slumps
 
29
relaxed during the break, and points forward valiantly when the break is
 
30
over. It is trapped behind bars while the keyboard is locked. Other
 
31
gestures are included (see the \fB+finger\fP option). You can also use your
 
32
own pictures: see the \fBwarning-picture\fP, \fBrest-picture\fP, and
 
33
\fBready-picture\fP options.
 
34
.PP
 
35
Normally, xwrits works through annoyance\*Eit flashes until you stop
 
36
typing. However, an option makes it actively prevent you from typing by
 
37
locking the screen. See \fB+lock\fP below.
 
38
.PP
 
39
Xwrits notices when you leave your workstation idle, and treats a long idle
 
40
period as if you took a break. You can turn this off with the \fB-idle\fP
 
41
option. With the \fB+mouse\fP option, it will also monitor your mouse
 
42
movements\*Eyou won't be able to move the mouse during a break without
 
43
aborting the break.
 
44
.PP
 
45
Each wrist break normally lasts the same amount of time. This is what
 
46
doctors suggest, but, if you'd like, the \fB+quota\fP option will reward
 
47
you for taking small breaks by reducing the length of the next official
 
48
break.
 
49
.PP
 
50
Some doctors recommend taking a short ``microbreak'' every five minutes, as
 
51
well as a longer break every hour. To use xwrits this way, just run two
 
52
xwrits processes, one for the microbreaks and one for the longer breaks.
 
53
'
 
54
.SH ESCALATION
 
55
It is easy to put the warning window aside ``for 5 minutes'' and ignore it
 
56
for fifty. The \fBafter\fP=\fIdelay\fP option causes xwrits to escalate its
 
57
activity over time, making it harder to ignore.
 
58
.PP
 
59
Options following \fBafter\fP come into effect after you have ignored the
 
60
warning window for \fIdelay\fP. In other words, xwrits's behavior escalates
 
61
after \fIdelay\fP. For instance, with this command line,
 
62
.nf
 
63
        xwrits flashtime=:2 after=10 flashtime=:.03
 
64
.fi
 
65
the warning window will begin flashing very quickly if it is ignored
 
66
for 10 minutes.
 
67
.PP
 
68
Any options preceding an \fBafter\fP option also apply following it, unless
 
69
you explicitly cancel them. For example:
 
70
.nf
 
71
        xwrits +finger after=10 -finger
 
72
.fi
 
73
.PP
 
74
Multiple \fBafter\fP options create a series of escalations. \fIDelay\fP
 
75
arguments are cumulative, so ``after=10 after=10'' means the same as
 
76
``after=20''.
 
77
.PP
 
78
One interesting use for \fBafter\fP is to make a break's length depend on
 
79
how long you waited to take it. For example:
 
80
.nf
 
81
        xwrits break=5 after=10 break=7
 
82
.fi
 
83
Here, a wrist break normally takes 5 minutes. However, if you ignore the
 
84
warning window for 10 minutes or more before taking a break, the wrist
 
85
break will last 7 minutes.
 
86
'
 
87
.SH OPTIONS
 
88
All options may be abbreviated to their unique prefixes. Some may be
 
89
abbreviated further, in which case the smallest legal abbreviation is shown
 
90
in brackets. Options are processed from left to right.
 
91
.PP
 
92
Options listed as ``\fB+option\fP (\fB\-option\fP)'' are toggles, which can
 
93
be on or off. A + turns the option on; \- turns it off. Off is the default
 
94
for most toggle options, and only the on behavior is described. You can
 
95
leave off the + sign if you like: ``xwrits +finger'' and ``xwrits finger''
 
96
are equivalent. Or you can say ``\-no\-finger'' instead of ``\-finger''.
 
97
.PP
 
98
Many options take arguments. You can give these after an equal sign, as in
 
99
``xwrits breaktime=2''. Non-optional arguments can also be given
 
100
separately, as in ``xwrits breaktime 2''.
 
101
.PP
 
102
Time arguments are expressed in minutes. For example, ``2'' is 2 minutes,
 
103
``2.5'' is 2 minutes 30 seconds. Use a colon to specify seconds: ``2:05.4''
 
104
is 2 minutes 5.4 seconds, and ``:5'' is 5 seconds.
 
105
 
 
106
.TP 5
 
107
\fB\-display\fP \fIdisplay\fP
 
108
'
 
109
Specify the X display. Xwrits monitors this display for keystrokes and
 
110
mouse movements, and displays windows on it. You can simultaneously monitor
 
111
more than one display by giving this option multiple times; for example,
 
112
``xwrits display :0.0 display fun-orgy:0.0''.
 
113
'
 
114
.TP 5
 
115
\fB+multiscreen\fP (\fB\-multiscreen\fP)
 
116
'
 
117
When this option is on, xwrits will open every available screen on each
 
118
specified
 
119
.IR display .
 
120
Useful for multihead displays.
 
121
'
 
122
.TP 5
 
123
\fBtypetime\fP=\fItime\fP [\fBt\fP]
 
124
Allow typing for \fItime\fP between breaks. Default is 55 minutes.
 
125
'
 
126
.TP 5
 
127
\fBbreaktime\fP=\fItime\fP [\fBb\fP]
 
128
The amount of time a break lasts. Default is 5 minutes. This option can be
 
129
supplied multiple times; see 
 
130
.SB ESCALATION
 
131
above.
 
132
'
 
133
.TP 5
 
134
\fBafter\fP=\fIdelay-time\fP
 
135
See
 
136
.SB ESCALATION
 
137
above.
 
138
'
 
139
.TP 5
 
140
\fBbars-picture\fP=\fIfile\fP [\fBbp\fP=\fIfile\fP]
 
141
Sets the background GIF image that appears while the screen is locked. By
 
142
default, this is an image of bars designed to work with the usual
 
143
\fBlock-picture\fP. If you specify your own \fBlock-picture\fP, however,
 
144
\fBbars-picture\fP defaults to a black screen. (Say
 
145
``bars-picture="&bars"'' to keep the bars.) Animations are not acceptable.
 
146
'
 
147
.TP 5
 
148
\fB+beep\fP (\fB\-beep\fP)
 
149
Xwrits will beep when the break should begin and again when it is
 
150
over.
 
151
'
 
152
.TP 5
 
153
\fB+breakclock\fP (\fB\-breakclock\fP) [\fBbc\fP]
 
154
A clock will appear in the resting window showing how many minutes
 
155
remain in the wrist break.
 
156
'
 
157
.TP 5
 
158
\fBcanceltime\fP=\fItime\fP [\fBct\fP]
 
159
'
 
160
Allow typing for \fItime\fP after a break is cancelled. You cancel a break
 
161
by deleting all xwrits windows with your window manager. This time should
 
162
probably be less than the regular type time. Default is 10 minutes.
 
163
'
 
164
.TP 5
 
165
\fB+cheat\fP[=\fInum\fP] (\fB\-cheat\fP)
 
166
Allows you to cheat during a break. You can type \fInum\fP keystrokes
 
167
before xwrits cancels the break. Default for \fInum\fP is 5. (If you're
 
168
using \fB+mouse\fP, mouse movements also count as keystrokes.)
 
169
'
 
170
.TP 5
 
171
\fB+clock\fP (\fB\-clock\fP) [\fBc\fP]
 
172
A clock will appear in the warning window showing how many minutes
 
173
you've put off the wrist break.
 
174
'
 
175
.TP 5
 
176
\fB+finger\fP (\fB\-finger\fP) [\fBf\fP]
 
177
The warning window will be rude to you.
 
178
'
 
179
.TP 5
 
180
\fB+finger\fP=\fIculture\fP
 
181
The warning window will be rude to you, according to \fIculture\fP's idea
 
182
of rudeness. Possible values for \fIculture\fP are `american' (the default),
 
183
`korean' (synonyms `japanese' and `russian'), and `german'.
 
184
'
 
185
.TP 5
 
186
\fBflashtime\fP=\fItime\fP
 
187
The amount of time between flashes of the warning window. Default is 2
 
188
seconds.
 
189
'
 
190
.TP 5
 
191
\fB+flipoff\fP (\fB\-flipoff\fP)
 
192
Synonym for \fB+finger\fP.
 
193
'
 
194
.TP 5
 
195
\fB+iconified\fP (\fB\-iconified\fP)
 
196
The warning window will initially appear as an icon.
 
197
'
 
198
.TP 5
 
199
\fB+idle\fP[=\fIidletime\fP] (\fB\-idle\fP) [\fBi\fP]
 
200
If you leave your workstation idle for \fIidletime\fP or longer, xwrits
 
201
will behave as if you took a break. The default for \fIidletime\fP is the
 
202
break length (see \fBbreaktime\fP above). \fBidle\fP is on by default.
 
203
'
 
204
.TP 5
 
205
\fB+lock\fP[=\fIjump-time\fP] (\fB\-lock\fP)
 
206
Xwrits will lock your screen until your break is
 
207
over. You can prematurely disable the lock and get a normal warning
 
208
window by typing your password (see \fBpassword\fP below). The
 
209
\fIjump-time\fP argument specifies how fast the screensaver will move;
 
210
default is 4 seconds. If the keyboard has been grabbed by another
 
211
application when the lock is attempted, the lock fails and a
 
212
normal warning window appears instead.
 
213
'
 
214
.TP 5
 
215
\fBlock-picture\fP=\fIfile\fP [\fBlp\fP=\fIfile\fP]
 
216
Sets the GIF image that appears while the screen is locked.
 
217
Animations are acceptable. See also \fBbars-picture\fP.
 
218
'
 
219
.TP 5
 
220
\fBmaxhands\fP=\fInum\fP
 
221
No more than \fInum\fP warning windows will appear on your screen
 
222
simultaneously. Normally, there will be only one warning window, but
 
223
see \fB+multiply\fP below. \fINum\fP cannot be less than 1, or more
 
224
than 137. Default is 25.
 
225
'
 
226
.TP 5
 
227
\fBminbreaktime\fP=\fItime\fP
 
228
Sets the minimum break length to \fItime\fP. This option is meaningful
 
229
when \fB+quota\fP is on (see below); no matter how many short breaks you
 
230
take, the break length will not be shortened below \fItime\fP. It defaults
 
231
to half the break time or the quota time, whichever is larger.
 
232
'
 
233
.TP 5
 
234
\fBmono\fP (\fB\-mono\fP)
 
235
Xwrits will display its graphics in black and white. This may be useful if
 
236
you live in a world with a limited colormap.
 
237
'
 
238
.TP 5
 
239
\fB+mouse\fP[=\fIsensitivity\fP] (\fB\-mouse\fP)
 
240
Xwrits will monitor your mouse movements. Every couple seconds, it checks
 
241
whether the mouse has moved. Movements of more than \fIsensitivity\fP
 
242
pixels in any direction are treated like key presses. Default for
 
243
\fIsensitivity\fP is 15 pixels.
 
244
'
 
245
.TP 5
 
246
\fB+multiply\fP[=\fIbreed-time\fP] (\fB\-multiply\fP) [\fBm\fP]
 
247
A new warning window will be created every \fIbreed-time\fP. Default for
 
248
\fIbreed-time\fP is 2.3 seconds.
 
249
'
 
250
.TP 5
 
251
\fB+noiconify\fP (\fB\-noiconify\fP)
 
252
The warning window will not allow itself to be iconified.
 
253
'
 
254
.TP 5
 
255
\fBpassword\fP=\fIpassword\fP
 
256
The password you type to unlock a locked screen (see \fB+lock\fP above).
 
257
Xwrits does not protect this password from intruders.
 
258
Therefore, do not use your login password or any other password you must
 
259
keep secure. Default is ``quit''.
 
260
'
 
261
.TP 5
 
262
\fB+quota\fP[=\fItime\fP] (\fB\-quota\fP)
 
263
If you leave your workstation idle for more than \fItime\fP, the idle time
 
264
is deducted from the length of your next break. This option turns the break
 
265
length into a break quota\*Einstead of resting for \fIbreaktime\fP
 
266
consecutive minutes every \fItypetime\fP, you must rest for a total of
 
267
\fIbreaktime\fP minutes per \fItypetime\fP. Default for \fItime\fP is 1
 
268
minute. See also \fBminbreaktime\fP.
 
269
'
 
270
.TP 5
 
271
\fBready-picture\fP=\fIfile\fP [\fBokp\fP=\fIfile\fP]
 
272
Sets the image that appears when your break is over to an arbitrary GIF.
 
273
Animations are acceptable.
 
274
'
 
275
.TP 5
 
276
\fBrest-picture\fP=\fIfile\fP [\fBrp\fP=\fIfile\fP]
 
277
Sets the image that appears during your break to an arbitrary GIF.
 
278
Animations are acceptable.
 
279
'
 
280
.TP 5
 
281
\fBtitle\fP=\fItext\fP
 
282
Xwrits windows will have \fItext\fP for their title, instead of the default
 
283
``xwrits''.
 
284
'
 
285
.TP 5
 
286
\fB+top\fP (\fB\-top\fP)
 
287
The warning window will try to keep itself above all other windows on the
 
288
desktop. (Note: it can be fooled into staying only partially visible.)
 
289
'
 
290
.TP 5
 
291
\fB+verbose\fP (\fB\-verbose\fP)
 
292
Xwrits will print a lot of information about the windows on which it is
 
293
listening for keystrokes. This is mostly useful for debugging.
 
294
'
 
295
.TP 5
 
296
\fBversion\fP
 
297
Prints the version number and some quickie warranty information and exits.
 
298
'
 
299
.TP 5
 
300
\fBwarning-picture\fP=\fIfile\fP [\fBwp\fP=\fIfile\fP]
 
301
Sets the image that appears on the warning window to an arbitrary GIF.
 
302
Animations are acceptable.
 
303
'
 
304
.SH EXAMPLES
 
305
Here is the way I run xwrits:
 
306
.nf
 
307
        xwrits typetime=40 finger after 15 clock multiply=5:1.4
 
308
.fi
 
309
This looks pretty spectacular:
 
310
.nf
 
311
        xwrits t=0 b=:2 f fla=:.5 m=:.31 max=100 -i
 
312
.fi
 
313
Whee!!
 
314
'
 
315
.SH AUTHOR
 
316
Eddie Kohler, kohler@icir.org
 
317
.br
 
318
http://www.icir.org/kohler/
 
319
.PP
 
320
http://www.lcdf.org/xwrits/
 
321
.br
 
322
The \fBxwrits\fP home page (for distributions and so forth).
 
323
.PP
 
324
Idea for idle processing code from
 
325
.BR xautolock (1)
 
326
by Stefan De Troch and Michel Eyckmans
 
327
'
 
328
.SH BUGS
 
329
Xwrits does not use the X resource database at all.
 
330
.PP
 
331
More options might be nice. So might more careful screen locking and
 
332
password protection. I would like to include rude finger gestures from
 
333
other cultures (see the GESTURES file in the distribution for gestures I
 
334
know about so far).
 
335
.PP
 
336
Please send any bugs, comments, or suggestions to me.
 
337
.PP
 
338
Yes the misspelling is intentional.
 
339
.PP
 
340
Yes it's my left wrist.