~ubuntu-branches/ubuntu/oneiric/wmail/oneiric

« back to all changes in this revision

Viewing changes to debian/wmail.1

  • Committer: Bazaar Package Importer
  • Author(s): Julien Danjou
  • Date: 2006-08-25 15:01:14 UTC
  • mfrom: (2.1.1 edgy)
  • Revision ID: james.westby@ubuntu.com-20060825150114-aw11ud1rzvih7mup
Tags: 2.0-3
Add manpage (Closes: #380038)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH WMAIL "1" "wmail v2.0 (C) 2000~2002 Sven Geisenhainer" "July 2006" "User Commands"
 
2
.SH NAME
 
3
wmail \- watches your inbox
 
4
.SH SYNOPSIS
 
5
.B wmail
 
6
[\fIOPTIONS\fR]
 
7
.SH DESCRIPTION
 
8
wmail is a Window Maker docklet watching your inbox, which is either a ordinary
 
9
mbox or a directory conforming to qmails Maildir format. It provides a nice
 
10
little GUI displaying some useful pieces of information about your inbox.
 
11
.TP
 
12
\fB\-display\fR <string>
 
13
display to use
 
14
.TP
 
15
\fB\-c\fR, \fB\-\-command\fR <string>
 
16
command to run on button\-click ("xterm \fB\-e\fR mail" is default)
 
17
.TP
 
18
\fB\-i\fR, \fB\-\-intervall\fR <number>
 
19
number of seconds between mail\-status updates (1 is default)
 
20
.TP
 
21
\fB\-f\fR, \fB\-\-familyname\fR
 
22
tickers the family\-name if available
 
23
.TP
 
24
\fB\-fps\fR, \fB\-\-frames\fR <number>
 
25
ticker frames per second
 
26
.TP
 
27
\fB\-s\fR, \fB\-\-shortname\fR
 
28
tickers the nickname (all before the '@')
 
29
.TP
 
30
\fB\-sc\fR, \fB\-\-symbolcolor\fR <string>
 
31
symbol color\-name
 
32
.TP
 
33
\fB\-fc\fR, \fB\-\-fontcolor\fR <string>
 
34
ticker\-font color\-name
 
35
.TP
 
36
\fB\-bc\fR, \fB\-\-backcolor\fR <string>
 
37
backlight color\-name
 
38
.TP
 
39
\fB\-oc\fR, \fB\-\-offcolor\fR <string>
 
40
off\-light color\-name
 
41
.TP
 
42
\fB\-bg\fR, \fB\-\-background\fR <string>
 
43
frame\-background for non\-shaped window
 
44
.TP
 
45
\fB\-ns\fR, \fB\-\-noshape\fR
 
46
make the dockapp non\-shaped (combine with \fB\-w\fR)
 
47
.TP
 
48
\fB\-n\fR, \fB\-\-new\fR
 
49
forces wmail to show new mail exclusively
 
50
.TP
 
51
\fB\-mb\fR, \fB\-\-mailbox\fR <string>
 
52
specify another mailbox ($MAIL is default)
 
53
.TP
 
54
\fB\-e\fR, \fB\-\-execute\fR <string>
 
55
command to execute when receiving a new mail
 
56
.TP
 
57
\fB\-sf\fR, \fB\-\-statusfield\fR
 
58
consider the status\-field of the mail header to distinguish unread mails
 
59
.TP
 
60
\fB\-rs\fR, \fB\-\-readstatus\fR <string>
 
61
status field content that your client uses to mark read mails
 
62
.TP
 
63
\fB\-fn\fR, \fB\-\-tickerfont\fR <string>
 
64
use specified X11 font to draw the ticker
 
65
.TP
 
66
\fB\-h\fR, \fB\-\-help\fR
 
67
shows this help text and exit
 
68
.TP
 
69
\fB\-v\fR, \fB\-\-version\fR
 
70
shows program version and exit
 
71
.TP
 
72
\fB\-w\fR, \fB\-\-windowed\fR
 
73
runs the application in windowed mode
 
74
.SH ENVIRONMENT
 
75
.B wmail
 
76
recognizes the following environment variables:
 
77
.TP
 
78
$MAIL
 
79
.TP 
 
80
.PP
 
81
The location of the inbox you are using
 
82
.SH NOTES
 
83
Other mailing mechanisms like POP or IMAP are not supported. Use a tool like
 
84
fetchmail to retrieve POP or IMAP based mail.
 
85
.SH AUTHORS
 
86
.B wmail
 
87
was written by Sven Geisenhainer. This man page was written by Felipe Augusto van de Wiel.
 
88
.SH SEE ALSO
 
89
.BR fetchmail (1).