1XBIFF(1)                    General Commands Manual                   XBIFF(1)
2
3
4

NAME

6       xbiff - mailbox flag for X
7

SYNOPSIS

9       xbiff [ -toolkitoption ... ] [ -option ... ]
10

DESCRIPTION

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

OPTIONS

19       Xbiff  accepts all of the standard X Toolkit command line options along
20       with the additional options listed below:
21
22       -help   This option indicates that  a  brief  summary  of  the  allowed
23               options should be printed on the standard error.
24
25       -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
31       -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
39       -volume percentage
40               This option specifies how loud the bell should be rung when new
41               mail comes in.
42
43       -shape  This option indicates that the mailbox window should be  shaped
44               if masks for the empty or full images are given.
45
46       The  following  standard  X Toolkit command line arguments are commonly
47       used with xbiff:
48
49       -display display
50               This option specifies the X server to contact.
51
52       -geometry geometry
53               This option specifies the preferred size and  position  of  the
54               mailbox  window.   The  mailbox is 48 pixels wide and 48 pixels
55               high and will be centered in the window.
56
57       -bg color
58               This option specifies the color to use for  the  background  of
59               the window.
60
61       -bd color
62               This  option  specifies  the color to use for the border of the
63               window.
64
65       -bw number
66               This option specifies the width in pixels of  the  border  sur‐
67               rounding the window.
68
69       -fg color
70               This  option  specifies  the color to use for the foreground of
71               the window.
72
73       -rv     This option indicates that reverse video should be simulated by
74               swapping the foreground and background colors.
75
76       -xrm resourcestring
77               This  option  specifies  a resource string to be used.  This is
78               especially useful for setting resources that do not have  sepa‐
79               rate command line options.
80

X DEFAULTS

82       The  application  class  name  is XBiff.  This program uses the Mailbox
83       widget.  It understands all of the core resource names and  classes  as
84       well as:
85
86       checkCommand (class CheckCommand)
87               Specifies  a shell command to be executed to check for new mail
88               rather than examining the size of file.  The  specified  string
89               value  is  used  as  the  argument  to a system(3) call and may
90               therefore contain i/o redirection.  An exit status of  0  indi‐
91               cates that new mail is waiting, 1 indicates that there has been
92               no change in size, and 2  indicates  that  the  mail  has  been
93               cleared.  By default, no shell command is provided.
94
95       file (class File)
96               Specifies  the  name of the file to monitor.  The default is as
97               described above for the -file command line option.
98
99       onceOnly (class Boolean)
100               Specifies that the bell is only rung the first time new mail is
101               found  and  is  not  rung again until at least one interval has
102               passed with no mail waiting.  The window will continue to indi‐
103               cate the presence of new mail until it has been retrieved.  The
104               default is false.
105
106       width (class Width)
107               Specifies the width of the mailbox.
108
109       height (class Height)
110               Specifies the height of the mailbox.
111
112       update (class Interval)
113               Specifies the frequency in seconds at which the mail should  be
114               checked.  The default is 30.
115
116       volume (class Volume)
117               Specifies  how loud the bell should be rung.  The default is 33
118               percent.
119
120       foreground (class Foreground)
121               Specifies the color for the foreground.
122
123       reverseVideo (class ReverseVideo)
124               Specifies  that  the  foreground  and  background   should   be
125               reversed.
126
127       flip (class Flip)
128               Specifies  whether or not the image that is shown when mail has
129               arrived should be inverted.  The default is ``true.''
130
131       fullPixmap (class Pixmap)
132               Specifies a bitmap to be shown when new mail has arrived.   The
133               default is flagup.
134
135       emptyPixmap (class Pixmap)
136               Specifies  a  bitmap  to  be shown when no new mail is present.
137               The default is flagdown.
138
139       shapeWindow (class ShapeWindow)
140               Specifies whether or not the mailbox window should be shaped to
141               the  given  fullPixmapMask and emptyPixmapMask.  The default is
142               false.
143
144       fullPixmapMask (class PixmapMask)
145               Specifies a mask for the bitmap to be shown when new  mail  has
146               arrived.  The default is none.
147
148       emptyPixmapMask (class PixmapMask)
149               Specifies a mask for the bitmap to be shown when no new mail is
150               present.  The default is none.
151

ACTIONS

153       The Mailbox widget provides the following  actions  for  use  in  event
154       translations:
155
156       check() This action causes the widget to check for new mail and display
157               the flag appropriately.
158
159       unset() This action causes the widget to lower the flag until new  mail
160               comes in.
161
162       set()   This  action causes the widget to raise the flag until the user
163               resets it.
164
165       The default translation is
166
167               <ButtonPress>:  unset()
168
169

ENVIRONMENT

171       DISPLAY to get the default host and display number.
172
173       XENVIRONMENT
174               to get the name of a resource file that  overrides  the  global
175               resources stored in the RESOURCE_MANAGER property.
176

SEE ALSO

178       X(7), xrdb(1), stat(2)
179

BUGS

181       The mailbox bitmaps are ugly.
182

AUTHOR

184       Jim Fulton, MIT X Consortium
185       Additional hacks by Ralph Swick, DEC/MIT Project Athena
186
187
188
189X Version 11                      xbiff 1.0.1                         XBIFF(1)
Impressum