[0m


XBIFF(1)	    UNIX Programmer's Manual		 XBIFF(1)



[1mNAME
     [0mxbiff - mailbox flag for X

[1mSYNOPSIS
     xbiff [0m[-_t_o_o_l_k_i_t_o_p_t_i_o_n ...] [-option ...]

[1mDESCRIPTION
     [0mThe _x_b_i_f_f program displays a little image of a mailbox.
     When there is no mail, the flag on the mailbox is down.
     When mail arrives, the flag goes up and the mailbox beeps.
     By default, pressing any mouse button in the image forces
     _x_b_i_f_f to remember the current size of the mail file as being
     the ``empty'' size and to lower the flag.

     This program is nothing more than a wrapper around the
     Athena _M_a_i_l_b_o_x widget.

[1mOPTIONS
     [0m_X_b_i_f_f accepts all of the standard X Toolkit command line
     options along with the additional options listed below:

     [1m-help   [0mThis option indicates that a brief summary of the
	     allowed options should be printed on the standard
	     error.

     [1m-update [0m_s_e_c_o_n_d_s
	     This option specifies the frequency in seconds at
	     which _x_b_i_f_f should update its display.  If the mail-
	     box is obscured and then exposed, it will be updated
	     immediately.  The default is 60 seconds.

     [1m-file [0m_f_i_l_e_n_a_m_e
	     This option specifies the name of the file which
	     should be monitored.  By default, it watches
	     /usr/spool/mail/_u_s_e_r_n_a_m_e, where _u_s_e_r_n_a_m_e is your
	     login name.

     [1m-volume [0m_p_e_r_c_e_n_t_a_g_e
	     This option specifies how loud the bell should be
	     rung when new mail comes in.

     [1m-shape  [0mThis option indicates that the mailbox window should
	     be shaped if masks for the empty or full images are
	     given.

     The following standard X Toolkit command line arguments are
     commonly used with _x_b_i_f_f:

     [1m-display [0m_d_i_s_p_l_a_y
	     This option specifies the X server to contact.

     [1m-geometry [0m_g_e_o_m_e_t_r_y



Printed 17/11/92	    Release 4				1






XBIFF(1)	    UNIX Programmer's Manual		 XBIFF(1)



	     This option specifies the prefered size and position
	     of the mailbox window.  The mailbox is 48 pixels
	     wide and 48 pixels high and will be centered in the
	     window.

     [1m-bg [0m_c_o_l_o_r
	     This option specifies the color to use for the back-
	     ground of the window. The default is ``white.''

     [1m-bd [0m_c_o_l_o_r
	     This option specifies the color to use for the
	     border of the window.  The default is ``black.''

     [1m-bw [0m_n_u_m_b_e_r
	     This option specifies the width in pixels of the
	     border surrounding the window.

     [1m-fg [0m_c_o_l_o_r
	     This option specifies the color to use for the fore-
	     ground of the window.  The default is ``black.''

     [1m-rv     [0mThis option indicates that reverse video should be
	     simulated by swapping the foreground and background
	     colors.

     [1m-xrm [0m_r_e_s_o_u_r_c_e_s_t_r_i_n_g
	     This option specifies a resource string to be used.
	     This is especially useful for setting resources that
	     do not have separate command line options.

[1mX DEFAULTS
     [0mThis program uses the _M_a_i_l_b_o_x widget in the X Toolkit.  It
     understands all of the core resource names and classes as
     well as:

     [1mcheckCommand ([0mclass [1mCheckCommand)
	     [0mSpecifies a shell command to be executed to check
	     for new mail rather than examining the size of [1mfile[0m.
	     The specified string value is used as the argument
	     to a _s_y_s_t_e_m(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.

     [1mfile ([0mclass [1mFile)
	     [0mSpecifies the name of the file to monitor.  The
	     default is to watch /usr/spool/mail/_u_s_e_r_n_a_m_e, where
	     _u_s_e_r_n_a_m_e is your login name.

     [1monceOnly ([0mclass [1mBoolean)
	     [0mSpecifies that the bell is only rung the first time



Printed 17/11/92	    Release 4				2






XBIFF(1)	    UNIX Programmer's Manual		 XBIFF(1)



	     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.

     [1mwidth ([0mclass [1mWidth)
	     [0mSpecifies the width of the mailbox.

     [1mheight ([0mclass [1mHeight)
	     [0mSpecifies the height of the mailbox.

     [1mupdate ([0mclass [1mInterval)
	     [0mSpecifies the frequency in seconds at which the mail
	     should be checked.

     [1mvolume ([0mclass [1mVolume)
	     [0mSpecifies how load the bell should be rung.  The
	     default is 33 percent.

     [1mforeground ([0mclass [1mForeground)
	     [0mSpecifies the color for the foreground.  The default
	     is ``black'' since the core default for background
	     is ``white.''

     [1mreverseVideo ([0mclass [1mReverseVideo)
	     [0mSpecifies that the foreground and background should
	     be reversed.

     [1mflip ([0mclass [1mFlip)
	     [0mSpecifies whether or not the image that is shown
	     when mail has arrived should be inverted.	The
	     default is ``true.''

     [1mfullPixmap ([0mclass [1mPixmap)
	     [0mSpecifies a bitmap to be shown when new mail has
	     arrived.

     [1memptyPixmap ([0mclass [1mPixmap)
	     [0mSpecifies a bitmap to be shown when no new mail is
	     present.

     [1mshapeWindow ([0mclass [1mShapeWindow)
	     [0mSpecifies whether or not the mailbox window should
	     be shaped to the given fullPixmapMask and emptyPix-
	     mapMask.

     [1mfullPixmapMask ([0mclass [1mPixmapMask)
	     [0mSpecifies a mask for the bitmap to be shown when new
	     mail has arrived.

     [1memptyPixmapMask ([0mclass [1mPixmapMask)
	     [0mSpecifies a mask for the bitmap to be shown when no



Printed 17/11/92	    Release 4				3






XBIFF(1)	    UNIX Programmer's Manual		 XBIFF(1)



	     new mail is present.

[1mACTIONS
     [0mThe _M_a_i_l_b_o_x widget provides the following actions for use in
     event translations:

     [1mcheck() [0mThis action causes the widget to check for new mail
	     and display the flag appropriately.

     [1munset() [0mThis action causes the widget to lower the flag
	     until new mail comes in.

     [1mset()   [0mThis action causes the widget to raise the flag
	     until the user resets it.

     The default translation is

	     <ButtonPress>:  unset()


[1mENVIRONMENT
     DISPLAY [0mto get the default host and display number.

     [1mXENVIRONMENT
	     [0mto get the name of a resource file that overrides
	     the global resources stored in the RESOURCE_MANAGER
	     property.

[1mSEE ALSO
     [0mX(1), xrdb(1), stat(2)

[1mBUGS
     [0mThe mailbox bitmaps are ugly.

[1mCOPYRIGHT
     [0mCopyright 1988, Massachusetts Institute of Technology.
     See _X(_1) for a full statement of rights and permissions.

[1mAUTHOR
     [0mJim Fulton, MIT X Consortium
     Additional hacks by Ralph Swick, DEC/MIT Project Athena














Printed 17/11/92	    Release 4				4



[0m