1XBIFF(1) General Commands Manual XBIFF(1)
2
6 xbiff - mailbox flag for X
7
9 xbiff [ -toolkitoption ... ] [ -option ... ]
10
12 The xbiff program displays a little image of a mailbox. When there is
13 no mail, the flag on the mailbox is down. When mail arrives, the flag
14 goes up and the mailbox beeps. By default, pressing any mouse button
15 in the image forces xbiff to remember the current size of the mail file
16 as being the ``empty'' size and to lower the flag.
17
19 Xbiff accepts all of the standard X Toolkit command line options along
20 with the additional options listed below:
21 -help This option indicates that a brief summary of the allowed
23 options should be printed on the standard error.
24 -update seconds
26 This option specifies the frequency in seconds at which xbiff
27 should update its display. If the mailbox is obscured and then
28 exposed, it will be updated immediately. The default is 30
29 seconds.
30 -file filename
32 This option specifies the name of the file which should be mon‐
33 itored. By default it watches your inbox in the default loca‐
34 tion for your system (some examples are /var/mail/username,
35 /usr/spool/mail/username, /var/spool/mail/username (where user‐
36 name is your login name). If the MAIL environment variable is
37 set, the file specified by it will be monitored.
38 -volume percentage
40 This option specifies how loud the bell should be rung when new
41 mail comes in. The percentage is relative to the current vol‐
42 ume in xset. So 0 is normal volume, negative percentages are
43 towards minimum (-100 is silent), and positive percentages are
44 towards maximum volume (100 is loudest).
45 -shape This option indicates that the mailbox window should be shaped
47 if masks for the empty or full images are given.
48 The following standard X Toolkit command line arguments are commonly
50 used with xbiff:
51 -display display
53 This option specifies the X server to contact.
54 -geometry geometry
56 This option specifies the preferred size and position of the
57 mailbox window. The mailbox is 48 pixels wide and 48 pixels
58 high and will be centered in the window.
59 -bg color
61 This option specifies the color to use for the background of
62 the window.
63 -bd color
65 This option specifies the color to use for the border of the
66 window.
67 -bw number
69 This option specifies the width in pixels of the border sur‐
70 rounding the window.
71 -fg color
73 This option specifies the color to use for the foreground of
74 the window.
75 -rv This option indicates that reverse video should be simulated by
77 swapping the foreground and background colors.
78 -xrm resourcestring
80 This option specifies a resource string to be used. This is
81 especially useful for setting resources that do not have sepa‐
82 rate command line options.
83
85 The application class name is XBiff. This program uses the Mailbox
86 widget. It understands all of the core resource names and classes as
87 well as:
88 checkCommand (class CheckCommand)
90 Specifies a shell command to be executed to check for new mail
91 rather than examining the size of file. The specified string
92 value is used as the argument to a system(3) call and may
93 therefore contain i/o redirection. An exit status of 0 indi‐
94 cates that new mail is waiting, 1 indicates that there has been
95 no change in size, and 2 indicates that the mail has been
96 cleared. By default, no shell command is provided.
97 file (class File)
99 Specifies the name of the file to monitor. The default is as
100 described above for the -file command line option.
101 onceOnly (class Boolean)
103 Specifies that the bell is only rung the first time new mail is
104 found and is not rung again until at least one interval has
105 passed with no mail waiting. The window will continue to indi‐
106 cate the presence of new mail until it has been retrieved. The
107 default is false.
108 width (class Width)
110 Specifies the width of the mailbox.
111 height (class Height)
113 Specifies the height of the mailbox.
114 update (class Interval)
116 Specifies the frequency in seconds at which the mail should be
117 checked. The default is 30.
118 volume (class Volume)
120 Specifies how loud the bell should be rung. The default is 33
121 percent. Note that this is a percentage of the current xset
122 volume. To reduce the volume, specify a negative percentage.
123 foreground (class Foreground)
125 Specifies the color for the foreground.
126 reverseVideo (class ReverseVideo)
128 Specifies that the foreground and background should be
129 reversed.
130 flip (class Flip)
132 Specifies whether or not the image that is shown when mail has
133 arrived should be inverted. The default is ``true.''
134 fullPixmap (class Pixmap)
136 Specifies a bitmap to be shown when new mail has arrived. The
137 default is flagup.
138 emptyPixmap (class Pixmap)
140 Specifies a bitmap to be shown when no new mail is present.
141 The default is flagdown.
142 shapeWindow (class ShapeWindow)
144 Specifies whether or not the mailbox window should be shaped to
145 the given fullPixmapMask and emptyPixmapMask. The default is
146 false.
147 fullPixmapMask (class PixmapMask)
149 Specifies a mask for the bitmap to be shown when new mail has
150 arrived. The default is none.
151 emptyPixmapMask (class PixmapMask)
153 Specifies a mask for the bitmap to be shown when no new mail is
154 present. The default is none.
155
157 The Mailbox widget provides the following actions for use in event
158 translations:
159 check() This action causes the widget to check for new mail and display
161 the flag appropriately.
162 unset() This action causes the widget to lower the flag until new mail
164 comes in.
165 set() This action causes the widget to raise the flag until the user
167 resets it.
168 The default translation is
170 <ButtonPress>: unset()
172
175 DISPLAY to get the default host and display number.
176 XENVIRONMENT
178 to get the name of a resource file that overrides the global
179 resources stored in the RESOURCE_MANAGER property.
180
182 X(7), xrdb(1), stat(2)
183
185 The mailbox bitmaps are ugly.
186
188 Jim Fulton, MIT X Consortium
189 Additional hacks by Ralph Swick, DEC/MIT Project Athena
190X Version 11 xbiff 1.0.4 XBIFF(1)