| 1 |
.\" $XConsortium: xbiff.man,v 1.22 94/04/17 20:43:28 gildea Exp $ |
| 2 |
.\" Copyright (c) 1988 X Consortium |
| 3 |
.\" |
| 4 |
.\" Permission is hereby granted, free of charge, to any person obtaining |
| 5 |
.\" a copy of this software and associated documentation files (the |
| 6 |
.\" "Software"), to deal in the Software without restriction, including |
| 7 |
.\" without limitation the rights to use, copy, modify, merge, publish, |
| 8 |
.\" distribute, sublicense, and/or sell copies of the Software, and to |
| 9 |
.\" permit persons to whom the Software is furnished to do so, subject to |
| 10 |
.\" the following conditions: |
| 11 |
.\" |
| 12 |
.\" The above copyright notice and this permission notice shall be included |
| 13 |
.\" in all copies or substantial portions of the Software. |
| 14 |
.\" |
| 15 |
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
| 16 |
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
| 17 |
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
| 18 |
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR |
| 19 |
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
| 20 |
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
| 21 |
.\" OTHER DEALINGS IN THE SOFTWARE. |
| 22 |
.\" |
| 23 |
.\" Except as contained in this notice, the name of the X Consortium shall |
| 24 |
.\" not be used in advertising or otherwise to promote the sale, use or |
| 25 |
.\" other dealings in this Software without prior written authorization |
| 26 |
.\" from the X Consortium. |
| 27 |
.\" |
| 28 |
.\" $XFree86: xc/programs/xbiff/xbiff.man,v 1.3 2001/01/27 18:21:08 dawes Exp $ |
| 29 |
.\" |
| 30 |
.TH XBIFF 1 "xbiff 1.0.4" "X Version 11" |
| 31 |
.SH NAME |
| 32 |
xbiff \- mailbox flag for X |
| 33 |
.SH SYNOPSIS |
| 34 |
.B xbiff |
| 35 |
[ \-\fItoolkitoption\fP ... ] [ \fI\-option\fP ... ] |
| 36 |
.SH DESCRIPTION |
| 37 |
The |
| 38 |
.I xbiff |
| 39 |
program displays a little image of a mailbox. When there is no mail, |
| 40 |
the flag on the mailbox is down. When mail arrives, the flag goes up |
| 41 |
and the mailbox beeps. By default, pressing any mouse button in the |
| 42 |
image forces \fIxbiff\fP to remember the current size of the mail file |
| 43 |
as being the ``empty'' size and to lower the flag. |
| 44 |
.SH OPTIONS |
| 45 |
.I Xbiff |
| 46 |
accepts all of the standard X Toolkit command line options along with the |
| 47 |
additional options listed below: |
| 48 |
.TP 8 |
| 49 |
.B \-help |
| 50 |
This option indicates that a brief summary of the allowed options should be |
| 51 |
printed on the standard error. |
| 52 |
.TP 8 |
| 53 |
.B \-update \fIseconds\fP |
| 54 |
This option specifies the frequency in seconds at which \fIxbiff\fP |
| 55 |
should update its display. If the mailbox is obscured and then exposed, |
| 56 |
it will be updated immediately. The default is 30 seconds. |
| 57 |
.TP 8 |
| 58 |
.B \-file \fIfilename\fP |
| 59 |
This option specifies the name of the file which should be monitored. By |
| 60 |
default it watches your inbox in the default location for your |
| 61 |
system (some examples are |
| 62 |
.RI /var/mail/ username , |
| 63 |
.RI /usr/spool/mail/ username , |
| 64 |
.RI /var/spool/mail/ username |
| 65 |
(where |
| 66 |
.I username |
| 67 |
is your login name). If the MAIL environment variable is set, |
| 68 |
the file specified by it will be monitored. |
| 69 |
.TP 8 |
| 70 |
.B \-volume \fIpercentage\fP |
| 71 |
This option specifies how loud the bell should be rung when new mail |
| 72 |
comes in. The percentage is relative to the current volume in \fIxset\fP. |
| 73 |
So 0 is normal volume, negative percentages are towards minimum (-100 |
| 74 |
is silent), and positive percentages are towards maximum volume (100 |
| 75 |
is loudest). |
| 76 |
.TP 8 |
| 77 |
.B \-shape |
| 78 |
This option indicates that the mailbox window should be shaped if masks for |
| 79 |
the empty or full images are given. |
| 80 |
.PP |
| 81 |
The following standard X Toolkit command line arguments are commonly used with |
| 82 |
.I xbiff: |
| 83 |
.TP 8 |
| 84 |
.B \-display \fIdisplay\fP |
| 85 |
This option specifies the X server to contact. |
| 86 |
.TP 8 |
| 87 |
.B \-geometry \fIgeometry\fP |
| 88 |
This option specifies the preferred size and position of the mailbox window. |
| 89 |
The mailbox is 48 pixels wide and 48 pixels high and will be centered in |
| 90 |
the window. |
| 91 |
.TP 8 |
| 92 |
.B \-bg \fIcolor\fP |
| 93 |
This option specifies the color to use for the background of the window. |
| 94 |
.TP 8 |
| 95 |
.B \-bd \fIcolor\fP |
| 96 |
This option specifies the color to use for the border of the window. |
| 97 |
.TP 8 |
| 98 |
.B \-bw \fInumber\fP |
| 99 |
This option specifies the width in pixels of the border surrounding the window. |
| 100 |
.TP 8 |
| 101 |
.B \-fg \fIcolor\fP |
| 102 |
This option specifies the color to use for the foreground of the window. |
| 103 |
.TP 8 |
| 104 |
.B \-rv |
| 105 |
This option indicates that reverse video should be simulated by swapping |
| 106 |
the foreground and background colors. |
| 107 |
.TP 8 |
| 108 |
.B \-xrm \fIresourcestring\fP |
| 109 |
This option specifies a resource string to be used. This is especially |
| 110 |
useful for setting resources that do not have separate command line options. |
| 111 |
.SH X DEFAULTS |
| 112 |
The application class name is XBiff. |
| 113 |
This program uses the |
| 114 |
.I Mailbox |
| 115 |
widget. |
| 116 |
It understands all of the core resource names and |
| 117 |
classes as well as: |
| 118 |
.PP |
| 119 |
.TP 8 |
| 120 |
.B checkCommand (\fPclass\fB CheckCommand) |
| 121 |
Specifies a shell command to be executed to check for new mail rather than |
| 122 |
examining the size of \fBfile\fP. The specified string value is used as the |
| 123 |
argument to a \fIsystem\fP(3) call and may therefore contain i/o redirection. |
| 124 |
An exit status of 0 indicates that new mail is waiting, 1 indicates that there |
| 125 |
has been no change in size, and 2 indicates that the mail has been cleared. |
| 126 |
By default, no shell command is provided. |
| 127 |
.TP 8 |
| 128 |
.B file (\fPclass\fB File) |
| 129 |
Specifies the name of the file to monitor. The default is as described |
| 130 |
above for the |
| 131 |
.B \-file |
| 132 |
command line option. |
| 133 |
.TP 8 |
| 134 |
.B onceOnly (\fPclass\fB Boolean) |
| 135 |
Specifies that the bell is only rung the first time new mail is found |
| 136 |
and is not rung again until at least one interval has passed with |
| 137 |
no mail waiting. The window will continue to indicate the presence |
| 138 |
of new mail until it has been retrieved. The default is false. |
| 139 |
.TP 8 |
| 140 |
.B width (\fPclass\fB Width) |
| 141 |
Specifies the width of the mailbox. |
| 142 |
.TP 8 |
| 143 |
.B height (\fPclass\fB Height) |
| 144 |
Specifies the height of the mailbox. |
| 145 |
.TP 8 |
| 146 |
.B update (\fPclass\fB Interval) |
| 147 |
Specifies the frequency in seconds at which the mail should be checked. |
| 148 |
The default is 30. |
| 149 |
.TP 8 |
| 150 |
.B volume (\fPclass\fB Volume) |
| 151 |
Specifies how loud the bell should be rung. The default is 33 percent. |
| 152 |
Note that this is a percentage of the current \fIxset\fP volume. |
| 153 |
To reduce the volume, specify a negative percentage. |
| 154 |
.TP 8 |
| 155 |
.B foreground (\fPclass\fB Foreground) |
| 156 |
Specifies the color for the foreground. |
| 157 |
.TP 8 |
| 158 |
.B reverseVideo (\fPclass\fB ReverseVideo) |
| 159 |
Specifies that the foreground and background should be reversed. |
| 160 |
.TP 8 |
| 161 |
.B flip (\fPclass\fB Flip) |
| 162 |
Specifies whether or not the image that is shown when mail has arrived |
| 163 |
should be inverted. The default is ``true.'' |
| 164 |
.TP 8 |
| 165 |
.B fullPixmap (\fPclass\fB Pixmap) |
| 166 |
Specifies a bitmap to be shown when new mail has arrived. |
| 167 |
The default is flagup. |
| 168 |
.TP 8 |
| 169 |
.B emptyPixmap (\fPclass\fB Pixmap) |
| 170 |
Specifies a bitmap to be shown when no new mail is present. |
| 171 |
The default is flagdown. |
| 172 |
.TP 8 |
| 173 |
.B shapeWindow (\fPclass\fB ShapeWindow) |
| 174 |
Specifies whether or not the mailbox window should be shaped to the |
| 175 |
given fullPixmapMask and emptyPixmapMask. The default is false. |
| 176 |
.TP 8 |
| 177 |
.B fullPixmapMask (\fPclass\fB PixmapMask) |
| 178 |
Specifies a mask for the bitmap to be shown when new mail has arrived. |
| 179 |
The default is none. |
| 180 |
.TP 8 |
| 181 |
.B emptyPixmapMask (\fPclass\fB PixmapMask) |
| 182 |
Specifies a mask for the bitmap to be shown when no new mail is present. |
| 183 |
The default is none. |
| 184 |
.SH ACTIONS |
| 185 |
The \fIMailbox\fP widget provides the following actions for use in event |
| 186 |
translations: |
| 187 |
.TP 8 |
| 188 |
.B check() |
| 189 |
This action causes the widget to check for new mail and display the flag |
| 190 |
appropriately. |
| 191 |
.TP 8 |
| 192 |
.B unset() |
| 193 |
This action causes the widget to lower the flag until new mail comes in. |
| 194 |
.TP 8 |
| 195 |
.B set() |
| 196 |
This action causes the widget to raise the flag until the user resets it. |
| 197 |
.PP |
| 198 |
The default translation is |
| 199 |
.sp |
| 200 |
.nf |
| 201 |
<ButtonPress>: unset() |
| 202 |
.fi |
| 203 |
.sp |
| 204 |
.SH ENVIRONMENT |
| 205 |
.PP |
| 206 |
.TP 8 |
| 207 |
.B DISPLAY |
| 208 |
to get the default host and display number. |
| 209 |
.TP 8 |
| 210 |
.B XENVIRONMENT |
| 211 |
to get the name of a resource file that overrides the global resources |
| 212 |
stored in the RESOURCE_MANAGER property. |
| 213 |
.SH "SEE ALSO" |
| 214 |
X(7), |
| 215 |
xrdb(1), |
| 216 |
stat(2) |
| 217 |
.SH BUGS |
| 218 |
The mailbox bitmaps are ugly. |
| 219 |
.SH AUTHOR |
| 220 |
Jim Fulton, MIT X Consortium |
| 221 |
.br |
| 222 |
Additional hacks by Ralph Swick, DEC/MIT Project Athena |