


XMAILBOX++(1)					    XMAILBOX++(1)


NNAAMMEE
       xmailbox - mailbox checker for X using XPM icons

SSYYNNOOPPSSIISS
       xxmmaaiillbbooxx [-_t_o_o_l_k_i_t_o_p_t_i_o_n ...] [-option ...]

DDEESSCCRRIIPPTTIIOONN
       The  _x_m_a_i_l_b_o_x  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
       _x_m_a_i_l_b_o_x to remember the current size of the mail file  as
       being  the  ``empty'' size and to change its image accord-
       ingly.	In  addition,  the  user  can  optionally  invoke
       his/her favourite mail retrieving program.

       This  program  is  nothing  more than a wrapper around the
       _M_a_i_l_b_o_x_+_+ widget included with the program's  source  dis-
       tribution.

OOPPTTIIOONNSS
       _x_m_a_i_l_b_o_x	 accepts  all  of  the standard X Toolkit command
       line options along  with	 the  additional  options  listed
       below:

       --hheellpp   This  option indicates that a brief summary of the
	       allowed options should be printed on the	 standard
	       error.

       --uuppddaattee _s_e_c_o_n_d_s
	       This  option specifies the frequency in seconds at
	       which _x_m_a_i_l_b_o_x should update its display.  If  the
	       mailbox	is  obscured and then exposed, it will be
	       updated immediately.  The default is 30 seconds.

       --ffiillee _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.

       --vvoolluummee _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,  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 _x_m_a_i_l_b_o_x_:



X Version 11		    Release 5				1





XMAILBOX++(1)					    XMAILBOX++(1)


       --ddiissppllaayy _d_i_s_p_l_a_y
	       This option specifies the X server to contact.

       --xxrrmm _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.

XX DDEEFFAAUULLTTSS
       The application class name is XMailbox.	This program uses
       the  _M_a_i_l_b_o_x_+_+  widget.	 It  understands  all of the core
       resource names and classes as well as:


       cchheecckkCCoommmmaanndd ((class CChheecckkCCoommmmaanndd))
	       Specifies a shell command to be executed to  check
	       for  new	 mail  rather  than examining the size of
	       ffiillee.  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 indi-
	       cates that the mail has been cleared.  By default,
	       no shell command is provided.

       ffiillee ((class FFiillee))
	       Specifies 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.

       oonncceeOOnnllyy ((class BBoooolleeaann))
	       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.

       uuppddaattee ((class IInntteerrvvaall))
	       Specifies  the  frequency  in seconds at which the
	       mail should be checked.	The default is 30.

       vvoolluummee ((class VVoolluummee))
	       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.

       mmaaiillXXppmmFFiillee ((class MMaaiillXXppmmFFiillee))
	       Specifies the XPM file used when	 mail  exists  in
	       the mailbox.

       nnoommaaiillXXppmmFFiillee ((class NNoommaaiillXXppmmFFiillee))
	       Specifies  the XPM file used when there is no mail



X Version 11		    Release 5				2





XMAILBOX++(1)					    XMAILBOX++(1)


	       (or no new mail) in the mailbox.

       mmaaiillSSnnddFFiillee ((class MMaaiillSSnnddFFiillee))
	       Specifies the sound file used when mail exists  in
	       the mailbox. If no file is specified, the standard
	       X Window beep sound is used.

       mmaaiillaapppp ((class MMaaiillAApppp))
	       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 _s_y_s_t_e_m(3) call.


       AACCTTIIOONNSS
	      The _M_a_i_l_b_o_x_+_+ widget provides the following actions
	      for use in event translations:

       cchheecckk(()) This action causes the widget  to  check	 for  new
	       mail and display the flag appropriately.

       uunnsseett(()) This  action  causes  the widget to lower the flag
	       until new mail comes in.

       sseett(())   This action causes the widget to	 raise	the  flag
	       until the user resets it.

       The default translation is

	       <ButtonPress>:  unset()


EENNVVIIRROONNMMEENNTT
       DDIISSPPLLAAYY to get the default host and display number.

       XXEENNVVIIRROONNMMEENNTT
	       to  get the name of a resource file that overrides
	       the    global	resources    stored    in     the
	       RESOURCE_MANAGER property.

SSEEEE AALLSSOO
       X(1), xrdb(1), stat(2)

AAUUTTHHOORRSS
       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 K. W. 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 click-
       ing on the mail icon.



X Version 11		    Release 5				3





XMAILBOX++(1)					    XMAILBOX++(1)


CCOOPPYYRRIIGGHHTT
       Xbiff is Copyright 1988, Massachusetts Institute of  Tech-
       nology.	 See _X_(_1_) for a full statement of rights and per-
       missions.





















































X Version 11		    Release 5				4


