XMAILBOX++(1) X Version 11 XMAILBOX++(1)
Release 5
NAME
xmailbox++ - mailbox checker for X using XPM icons
SYNOPSIS
xmailbox++ [-toolkitoption ...] [-option ...]
DESCRIPTION
The xmailbox++ program displays (by default) an image of a mailbox.
When there is no mail, the image shown is that of a mailbox with its
flag down. When mail arrives, the image changes to that of a mailbox
with the flag up, its door open and a letter visible inside. It can
also optionally play a sound through the SUN workstation's internal
speaker. The NCD audio server, the rplay sound package, and the
standard SUN audio driver are supported. By default, pressing any
mouse button in the image forces xmailbox++ to remember the current
size of the mail file as being the ``empty'' size and to change its
image accordingly. In addition, the user can optionally invoke
his/her favourite mail retrieving program.
This program is nothing more than a wrapper around the Mailbox++
widget included with the program's source distribution.
OPTIONS
xmailbox++ accepts all of the standard X Toolkit command line options
along with the additional options listed below:
-help This option indicates that a brief summary of the allowed
options should be printed on the standard error.
-update seconds
This option specifies the frequency in seconds at which
xmailbox++ should update its display. If the mailbox is
obscured and then exposed, it will be updated immediately.
The default is 30 seconds.
-file filename
This option specifies the name of the file which should be
monitored. By default, it watches /usr/spool/mail/username,
where username is your login name.
-volume percentage
This option specifies how loud the bell should be rung when
new mail comes in, or, if the sound option is used, how high
the playing volume should be. The default is 33 percent.
The following standard X Toolkit command line arguments are commonly
used with xmailbox++:
-display display
This option specifies the X server to contact.
- 1 - Formatted: April 24, 2024
XMAILBOX++(1) X Version 11 XMAILBOX++(1)
Release 5
-xrm resourcestring
This option specifies a resource string to be used. This is
especially useful for setting resources that do not have
separate command line options.
X DEFAULTS
The application class name is XMailbox. This program uses the
Mailbox++ widget. It understands all of the core resource names and
classes as well as:
checkCommand (class CheckCommand)
Specifies a shell command to be executed to check for new mail
rather than examining the size of file. The specified string
value is used as the argument to a system(3) call and may
therefore contain i/o redirection. An exit status of 0
indicates that new mail is waiting, 1 indicates that there has
been no change in size, and 2 indicates that the mail has been
cleared. By default, no shell command is provided.
file (class File)
Specifies the name of the file to monitor. The default is to
watch /usr/spool/mail/username, where username is your login
name.
onceOnly (class Boolean)
Specifies that the bell is only rung the first time new mail
is found and is not rung again until at least one interval has
passed with no mail waiting. The window will continue to
indicate the presence of new mail until it has been retrieved.
The default is false.
update (class Interval)
Specifies the frequency in seconds at which the mail should be
checked. The default is 30.
volume (class Volume)
Specifies how loud the bell should be rung, or, if the sound
option is used, how high the playing volume should be. The
default is 33 percent.
mailXpmFile (class MailXpmFile)
Specifies the XPM file used when mail exists in the mailbox.
nomailXpmFile (class NomailXpmFile)
Specifies the XPM file used when there is no mail (or no new
mail) in the mailbox.
mailSndFile (class MailSndFile)
Specifies the sound file used when mail exists in the mailbox.
If no file is specified, the standard X Window beep sound is
used.
- 2 - Formatted: April 24, 2024
XMAILBOX++(1) X Version 11 XMAILBOX++(1)
Release 5
mailapp (class MailApp)
Specifies the mail retrieving application to run when the user
clicks on the mailbox image. The specified string value is
used as the argument to a system(3) call.
The Mailbox++ widget provides the following actions for use in event
translations:
check() This action causes the widget to check for new mail and
display the flag appropriately.
unset() This action causes the widget to lower the flag until new mail
comes in.
set() This action causes the widget to raise the flag until the user
resets it.
The default translation is
<ButtonPress>: unset()
ENVIRONMENT
DISPLAY to get the default host and display number.
XENVIRONMENT
to get the name of a resource file that overrides the global
resources stored in the RESOURCE_MANAGER property.
SEE ALSO
X(1), xrdb(1), stat(2)
AUTHORS
Dimitrios P. Bouras
The first version of xmailbox++ was a hack based on the X11R5 XBiff
written by Jim Fulton, MIT X Consortium, and Ralph Swick, DEC/MIT
Project Athena.
William Cheung
Added optional sound output using the standard SUN audio driver, the
rplay sound package, or the NCD audio server, as well as optional mail
application execution upon clicking on the mail icon.
COPYRIGHT
Xbiff is Copyright 1988, Massachusetts Institute of Technology. See
X(1) for a full statement of rights and permissions.
- 3 - Formatted: April 24, 2024
