File: mailleds.1

package info (click to toggle)
mailleds 0.93-5
  • links: PTS
  • area: main
  • in suites: potato
  • size: 152 kB
  • ctags: 109
  • sloc: ansic: 821; makefile: 107; sh: 17
file content (144 lines) | stat: -rw-r--r-- 3,446 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
.TH MAILLEDS 1 "27 Mar 1996" Linux "New Mail Notifiers"
.SH NAME
mailleds \- blink keyboard LED lights when mail arrives
.SH SYNOPSIS
.ll +8
.B mailleds
.RB [ " \-ahkqtx "
.RB ]
.RB [ " \-l "
.RB [ 
\fIcnsp\fP\fBX\fP
.RB "] ]"
.RB [ " \-d "
.I dpyname
.RB ]
.RB [ " \-m "
.I filename
.RB ]
.RB [ " \-u "
.I user
.RB ]
.ll -8
.SH DESCRIPTION
.B mailleds
is an unobtrusive mail notifier daemon.
.B mailleds
runs in the background and monitors your mailbox.  If the mailbox file
does not exist, 
.B mailleds
will wait until it does. (Some programs,
such as mailx, remove the mailbox when it is empty) When new mail
arrives, it will flash LED lights, which can be any of the three
standard LEDs on a keyboard, or LEDs hooked up to a parallel port as
outlined in led-stat.txt.  The LEDs blink until you read your
mail. 
.B mailleds
does not interfere with the current status of the keyboard settings:
though the Num Lock LED may blink, the actual state of Num Lock will
remain whatever it was.
.PP
Due to limitations of the ioctl system call, 
.B mailleds must 
be run setuid root.
.SH OPTIONS
.TP
.B \-a, \-\-answering-machine
Runs
.B mailleds
in `answering-machine' mode, which, instead of blinking the 
scroll lock LED off and on, blinks out the number of new
messages, pauses, and repeats.
.TP
.B \-d, \-\-display \fIdpyname\fP
Specifies the name of an X display whose leds are to be flashed.
Implies -x.
.TP
.B \-l, \-\-leds \fP[ \fIcnsp\fP\fBX\fP ]
Specifies which LEDs to blink.  \fIcnsp\fP\fBX\fP is a string
consisting of any combination of \fIc\fP, \fIn\fP, \fIs\fP, and
\fIp\fP\fBX\fP.  \fIc\fP, \fIn\fP and \fIs\fP indicate that caps lock,
num lock and scroll lock, respectively, are to be blinked.
\fIp\fP\fBX\fP indicates a led hooked up to a parallel port to be
blinked, where \fBX\fP is a number from 1 to 8 that indicates the led
to be blinked.  For more information on this type of led, see
led-stat.txt in 
.B mailleds 
source directory.
.TP
.B \-h, \-\-help
Displays a synopsis of options.
.TP
.B \-k, \-\-kill
Kills off the currently running
.B mailleds
daemon.
.TP
.B \-q, \-\-quiet
Makes
.B mailleds
die silently when there is already a mailleds process running for the
user.  This is useful for running
.B mailleds
out of .profile, .cshrc, etc.
.TP
\fB\-m, \-\-mailbox\fP \fIfilename\fP
Uses 
.I filename
as the user's mailbox.
.TP
.B \-t, \-\-ttys   
Specifies that 
.B mailleds 
is to blink virtual console leds.  mailleds reads login information
from utmp to figure out which vt's must be blinked.
This is the default option.
.TP
\fB\-u, \-\-user\fP \fIuser\fP
Runs mailleds "as if you were" \fIuser\fP.  This option causes 
.B mailleds
to ignore the environment variable "MAIL".  
.B Mailleds
will never exit of its own accord when this option is specified, and
is therefore useful for running
.B mailleds
from /etc/rc.d/rc.local.  You must be the superuser to specify this
option.
.TP
.B -x
Tells mailleds to latch on to the current X display and flash those keyboard
leds.  This is the same as calling mailleds as "xmailleds".

.SH ENVIRONMENT
.IP MAIL
specifies a default mailbox.
.SH BUGS
mailleds shouldn't interfere with screen blanking.

.B xmailleds 
and
.B mailleds 
will interfere with each other (if the X server is run from the console via
.BR xinit (1x)
or similar.)

.SH AUTHOR
Benjamin Osheroff (mtr@ratbert.bagel.org)
.SH SEE ALSO
.BR setleds (1),
.BR newmail (1),
.BR tty (4),
.BR portato (1)