v13i052: xmail, Part10/11

[Michael Wagnitz]

Submitted-by: stratus!voder!nsc!berlioz.nsc.com!michael at uunet.UU.NET (Michael Wagnitz)
Posting-number: Volume 13, Issue 52
Archive-name: xmail/part10

#! /bin/sh
# This is a shell archive.  Remove anything before this line, then unpack
# it by saving it into a file and typing "sh file".  To overwrite existing
# files, type "sh file -c".  You can also feed this as standard input via
# unshar, or by typing "sh <file", e.g..  If this archive is complete, you
# will see the following message at the end:
#		"End of archive 10 (of 11)."
# Contents:  xmail.man
# Wrapped by michael at harley on Fri May  3 13:35:54 1991
PATH=/bin:/usr/bin:/usr/ucb ; export PATH
if test -f 'xmail.man' -a "${1}" != "-c" ; then 
  echo shar: Will not clobber existing file \"'xmail.man'\"
else
echo shar: Extracting \"'xmail.man'\" \(40275 characters\)
sed "s/^X//" >'xmail.man' <<'END_OF_FILE'
X.\"
X.\" @(#)xmail.l 1.3 91/04/29 NSC;
X.\"
X.\" Copyright 1990,1991 by National Semiconductor Corporation.
X.\"
X.\" Permission to use, copy, modify, and distribute this software and its
X.\" documentation for any purpose is hereby granted without fee, provided that
X.\" the above copyright notice appear in all copies and that both that
X.\" copyright notice and this permission notice appear in supporting
X.\" documentation, and that the name of National Semiconductor Corporation not
X.\" be used in advertising or publicity pertaining to distribution of the
X.\" software without specific, written prior permission.  National Semiconductor
X.\" Corporation makes no representations about the suitability of this software
X.\" for any purpose. It is provided "as is" without express or implied warranty.
X.\"
X.\" NATIONAL SEMICONDUCTOR CORPORATION DISCLAIMS ALL WARRANTIES WITH REGARD TO
X.\" THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
X.\" FITNESS, IN NO EVENT SHALL NATIONAL SEMICONDUCTOR CORPORATION BE LIABLE FOR
X.\" ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
X.\" RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
X.\" CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
X.\" CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
X.\"
X.\" Author:  Michael C. Wagnitz - National Semiconductor Corporation
X.\"
X.ds nS National Semiconductor Corporation
X.ds xM xmail
X.if n .ds Q \&"
X.if n .ds U \&"
X.if t .ds Q ``
X.if t .ds U ''
X..
X.\"
X.TH XMAIL 1 "April 29, 1991" "NSC"
X.SH NAME
Xxmail \- X11 visual interface to the mail program
X.SH SYNOPSIS
X.B \*(xM
X.RB "[\|" \-\fItoolkitoptions\fP "\|]"
X.RB "[\|" \-\fIxmailoptions\fP "\|]"
X.SH DESCRIPTION
X.B \*(xM
Xis an X11 window based visual interface to the
X.B Mail
Xprogram.  It offers functionality similar to the SunView mailtool, but with
Xsome differences. 
X
XUsers may use mouse button actions in the index window to select a message for
Xfurther processing (by pressing the left mouse button), or automatically read
Xthe selected message (by pressing the right mouse button).
X
XFolder specification is aided by a selection menu which can walk down through
Xthe user's folder directory hierarchy. 
X
XMessage composition and modification is provided by the user's preferred
Xeditor (/usr/ucb/vi by default).  Editor preference may be specified using
Xeither the user's process or Mail environment variable
X.SB VISUAL, 
Xor the xmail \fBeditorCommand\fR command line or application resource.
X
XA short description of the command button action is presented in the
Xstatus window whenever the cursor enters any of the xmail command button
Xwindows.  Additional help information is presented for any command button or
Xother part of xmail, by pressing the middle mouse button on the window or
Xcommand button while holding down either Shift key.
X
XSupport is also provided for displaying the content of an X-Face mail header,
Xand for adding your own X-Face header to outgoing mail if present.
X.SH OPTIONS
XAn unrecognized or illegal command line option specification will cause
Xdisplay of a usage statement and termination of \*(xM.
X.TP
X\fB\-toolkitoptions\fR
XAll standard X11 toolkit options are accepted on the command line.
X.TP
X\fB\-xmailoptions\fR
X\*(xM also accepts the following additional options:
X.RS
X.TP
X\fB\-buttonfont \fIfontname\fR
Xspecifies the font to use when creating command buttons.  This option overrides
Xthe \*(xM resource specification \*Q\fB*buttonFont: \fIfontname\fR\*U.
X.TP
X\fB\-e\fR
XSets the \*(xM resource specification \*Q\fB*expert: \fITrue\fR\*U.  This
Xresource determines whether \*Q\fBconfirm\fR\*U popups will be presented
Xwhen committing changes to a folder or deleting a new message composition.
XBy default the resource is False, which means confirm popups will be used.
X.TP
X\fB\-editorCommand \fI<quoted command string>\fR
XSpecifies the editor resource that \*(xM should use when editing a message
Xcomposition.  The quoted command must be an \fIsprintf\fR\-able format string
Xcontaining two string declarations.  The first of these declarations will be
Xreplaced with the name of the display connection for the xmail process, to
Xallow the edit window to appear on the correct display screen.  The second
Xdeclaration will be replaced with the name of the file to be edited.
XIf \*(xM cannot locate the two separate string declarations in the command,
Xthe command will be rejected and processing will default to the older
X.SM VISUAL
Xmethodology.
X.TP
X\fB\-f\ \fI+foldername\fR
Xtells Mail to start by processing the specified folder.
XThis is also a Mail program option, passed to it during startup.
XThe option can also be specified as an \*(xM resource
Xusing the specification \*Q\fB*MFileName: \fI+foldername\fR\*U.
X.TP
X\fB\-fn \fIfontname\fR
Xspecifies the font to use when displaying message and index text.
XThis option overrides the \*(xM resource specification
X\*Q\fB*Font: \fIfontname\fR\*U.
X.TP
X\fB\-helpfont \fIfontname\fR
Xspecifies the font to use when displaying help text.  This option overrides
Xthe \*(xM resource specification \*Q\fB*helpFont: \fIfontname\fR\*U.
X.TP
X\fB-iconGeometry \fI[+-]XOff[+-]YOff\fR
Xprovides a command line option for specifying the preferred geometry
Xlocation for the \*(xM icon window.  This overrides any \*(xM resource
Xspecification for \*Q\fB*iconGeometry: \fI[+-]XOff[+-]YOff\fR\*U.
X.TP
X\fB\-ls\fR
Xtells \*(xM to \fBnot\fR show the last message of a folder by default.  This
Xoption is equivalent to setting the \*(xM resource \fB*Show_Last\fR to
X\fIFalse\fR.  If disabled, \*(xM (actually Mail) will display the default
X(usually first) message of a folder when switching to or re-reading a folder.
XBy default, \*(xM attempts to read the latest (or last) message of a folder.
X.TP
X\fB\-m\fR
Xtells \*(xM to include the mail host name in the icon window when displaying
Xthe icon.  The option can also be specified as an \*(xM resource
Xusing the specification \*Q\fB*icon*useHost: \fITrue\fR\*U.
X.TP
X\fB\-n\fR
Xtells Mail to \fBnot\fR initialize from the system default Mail.rc file.
XThis option is actually a Mail program option, which is passed on to it during
Xstartup from \*(xM.
XThe option can also be specified as an \*(xM resource
Xusing the specification \*Q\fB*mailopt_n: \fITrue\fR\*U.
X.TP
X\fB\-nb\fR
Xtells \*(xM to \fBnot\fR ring the terminal bell when issuing status and
Xerror messages.  This is equivalent to the \*(xM resource specification
X\*Q\fB*bellRing: \fIFalse\fR\*U.
X.TP
X\fB\-noinfo\fR
Xtells \*(xM to \fBnot\fR display info messages when entering or leaving a
Xcommand button window with the mouse cursor.  Normally, the enter/leave
Xwindow events will change the text displayed in the status window, to show
Xinformation about the command button currently under the mouse cursor.  This
Xoption allows you to disable this new feature, if desired.
XThis is equivalent to setting the \*(xM resource specification
X\*Q\fB*show_Info: \fIFalse\fR\*U.
X.TP
X\fB\-rv\fR
Xtells \*(xM to reverse the foreground and background colors of the icon
Xwindow when displaying the icon.  The option can also be specified as an
X\*(xM resource using the specification \*Q\fB*icon*reverseVideo: \fITrue\fR\*U.
X.TP
X\fB\-u\fR
Xtells \*(xM to include the user login name in the icon window when displaying
Xthe icon.  The option can also be specified as an \*(xM resource
Xusing the specification \*Q\fB*icon*useName: \fITrue\fR\*U.
X.TP
X\fB\-U\fR
Xtells Mail to convert internet style addresses into uucp format.
XThis option also is a Mail option, passed on to it during startup.
XThe option can also be specified as an \*(xM resource
Xusing the specification \*Q\fB*mailopt_U: \fITrue\fR\*U.
X.RE
X.SH USAGE
XThe \*(xM shell appearance is similar in layout to mailtool.
XA title bar decorates the top of the shell, and carries the name and
Xversion of the program, as well as information about the current mail folder
Xand its content.
X
XImmediately below the title bar, an index window displays header information
Xfor the current mail folder.
XMessage selection is indicated by a \fBgreater-than '>'\fR symbol located at
Xthe beginning of the header line for the particular message.
XNew and unread messages are indicated by '\fBN\fR' and '\fBU\fR' characters
Xrespectively, preceding the message number.
XDeleted messages not yet removed from the index list have the letter '\fBD\fR'
Xpreceding the message number.
XSaved messages are now marked with the letter '\fBS\fR', to denote that the
Xmessage would normally disappear from your system folder when you finally
Xcommit the changes.
XMessages that are marked for preservation in the system folder are now marked
Xwith the letter '\fBP\fR' until the folder changes are committed.
XKeyboard keys can be used to scroll the index window,
Xin addition to the more traditional mouse on scrollbar mechanism.
X
XBelow the index
Xwindow, the status window displays information, status, and error messages.
XAs the cursor is moved between the various command button windows in the xmail
Xprogram, a short description of the particular button's action(s) is displayed
Xin the status window.  Leaving the command button window restores the default
Xinformation about obtaining help on any part of xmail.
XError and status messages are also displayed in this same status window.
XThe terminal bell is usually rung to draw attention to these messages.
XThe status bell can be disabled from the command line or user resource file.
X
XImmediately below the status window and attached to it, the xmail
Xshell displays a panel with a selection of commonly used Mail commands.
XPressing and then releasing (\fIalso known as \*Q\fBclicking\fP\*U)\fR
Xthe \fBleft\fR mouse button while the cursor is within a
Xparticular command button box invokes that Mail command.
X
XA grip along the right edge of the command panel allows the user to slide the
Xstatus window/command panel combination up and down in the \*(xM shell, to
Xaccommodate those times when the user is reviewing a short list of longer than
Xaverage messages, or a longer list of relatively short messages.
X
XEach button in the command panel also offers an expanded menu of choices.
XPressing the \fBright\fR mouse button presents the user with the
Xexpanded menu.  \fBDragging\fR the cursor over one of these selections
X\fIwhile still holding down the right button\fR causes the particular
Xselection to highlight.  A description of the highlighted command's action is
Xalso displayed in the status window.  \fBReleasing\fR the right button while a
Xselection is highlighted invokes that particular command action.
X
XKeyboard accelerators for these actions are indicated by appropriate entries
Xin the command menus.  Users may take advantage of these accelerators by
Xholding down the Shift and/or Control key(s) prior to clicking the left mouse
Xbutton on the desired command, in lieu of raising the command popup menu.
X
XMessage text is displayed in the bottom window of the \*(xM shell.
XLike the index window above, scroll bars provide easy access to any portion of
Xthe text.  Keyboard keys can also be used to scroll the text window.  If the
Xdisplayed message contains an X-Face header string, the content of that string
Xis displayed as a bitmap in the upper right-hand corner of the text window.
X(\fIThis feature is a compile time option, and requires the existance of the
X\fBcompface\fP library routines, which are not supplied with the xmail sources.
XSee the section on \s-1X-FACE HEADERS\s+1 for details on acquiring
Xthis library.\fR)
X
XIn addition, both the text window and index window have duplicate keyboard
Xdefinitions to supplant using the
Xmouse on the command buttons for normal \*(xM command operation.  Like many of
Xthe resources for xmail, these key bindings are now declared in the application
Xresource file, to allow the use to modify them as desired.
X
XA modified mailWatch widget (ala xwatch) is used as the \*(xM icon
Xwindow.  The mailbox flag will be raised and mail shown inside the box,
Xwhenever new mail arrives.
XIn the non-iconic state, the \fBNewmail\fR command button is highlighted
Xto signal new mail arrival.  Clicking on the Newmail button will
Xreset the flag and highlighting, and deliver the new mail to your display.
X
XPressing the \fBmiddle\fR mouse button on any window or command button of
Xthe \*(xM shell while holding down either \fBShift\fR key will cause help
Xinformation relating to that window (or button) to be displayed in
Xthe text (\fIbottom\fR) window.
XReleasing the mouse button will cause that help information to be removed.
XPressing the '\fB?\fR' key in the text window will cause a second page
Xof help information, relating to the default bindings for the keyboard keys,
Xto appear.
XPressing the '\fBLineFeed\fR' key will cause that second help window
Xto be removed.
X
XDuring command execution, the cursor is changed to a watch face
Xto indicate that \*(xM is busy.  Upon completion of the activity, the
Xcursor is restored to its previous value.
X.\"
X.SH "ENVIRONMENT"
XSeveral process environment variables are of a special interest to \*(xM.
X.sp
X.RS
X.TP 3
X\fBDEAD\fR
XNormally specified in the user's \&.mailrc file,
Xthis variable indicates the name of the file to use when storing dead or
Xcanceled letters.
XIf unspecified, it defaults to \*Qdead.letter\*U in the user's HOME directory.
X.TP 3
X\fBHOME\fR
XDefines the path to the user's home directory, and is used in determining
Xthe complete path for mail folder and dead letter files.
X.TP 3
X\fBMAILRC\fR
XIf defined, denotes the full name of the user preferred Mail program startup
Xfile, used to define various mail state variables.  By default, Mail (and
X\*(xM) will look for the file \&.mailrc, in your home directory.
X.TP 3
X\fBMBOX\fR
XNormally specified in the user's \&.mailrc file,
Xthis variable denotes the preferred file to use when storing letters that are
Xno longer to be preserved in the system mail folder, and letters copied or
Xsaved to no other specific file.
X.TP 3
X\fBUSER\fR
XDefines the login name of the current user, and is used in determining the
Xname of the author of any message compositions.
X.TP 3
X\fBVISUAL\fR
XNormally specified in the user's \&.mailrc file,
Xthis variable denotes the preferred editor to use when composing messages in
X\*(xM.
X.TP 3
X\fBXMAILER\fR
XIf defined, points to the particular executable to be used as the Mail
Xprogram.  Normally, \*(xM establishes connections with Mail in the default
Xpath of the process (assumed to be at least \*Q/bin /usr/bin /usr/ucb\*U).
XIf need be, the XMAILER
Xenvironment variable can be used to provide a specific path to the Mail
Xprogram.  Note: \*(xM may not work correctly with any mail program
Xother than the intended Berkeley Mail program.
X.RE
X.\"
X.SH FOLDERS
XIf the \fBright\fR mouse button is pressed while the cursor is within the
Xcommand panel \fBFolder\fR button, \*(xM will display a menu of available
Xmail folders.  (\fIIf the user has not set their mail \fRfolders\fP variable,
Xa message will be displayed instead.\fR)
XDragging the cursor while still holding the right mouse button down will allow
Xthe user to highlight a particular folder name.  Releasing the right button
Xwhile a name is highlighted causes a copy of that name to be written in
Xthe command panel file window.  The menu list is then unmapped.
XReleasing the right button while outside
Xany folder selection causes the folder menu list to disappear.
X
XFolders which are actually directories (that might possibly contain additional
Xfolder files)
Xare displayed with a trailing slash character.  Clicking the \fBleft\fR mouse
Xbutton within a directory folder while still holding down the right
Xmouse button (\fIalso known as 'expanding'\fR) causes \*(xM to expand that
Xdirectory and display (on a new menu level) any files found there.  Dragging
Xthe cursor over
Xone of these selections and releasing the right mouse button copies the
Xcomplete folder path name to the file window.  This nesting of folder names
Xmay be repeated as often as there are legitimate folder directories.  Clicking
Xthe left mouse button on an empty folder directory rings the terminal bell.
XDragging the cursor beyond one of these nested menu levels causes that menu to
Xdisappear, without making a selection.  Re-clicking the left mouse button on
Xthe directory folder redisplays the nested menu.
X
XThe first request for the folder menu extracts (from Mail or the system) the
Xnecessary information to create the menu.  Subsequent requests simply redisplay
Xthat menu.  To force \*(xM to recalculate the folder menu content, use the
X\fBNewmail\fR button option which causes \*(xM to destroy the current folder
Xmenu.  This provides for access to folders created since the startup of \*(xM.
XPressing the right mouse button
Xon the Newmail command box will present the Newmail command menu, which has a
Xchoice to drop the current folder list.  This same option is also available
Xusing the accelerator key and the left mouse button on the Newmail command box.
X.\"
X.SH FONTS
XSeparate fonts may now be specified for mail message (and index) text, help
Xmessage text, and for the command buttons.
XPrevious restrictions against the use of proportional width fonts have now
Xbeen hopefully resolved.  Although the result of choosing such a font may still
Xproduce less than optimal results, the window shell should be of a reasonable
Xsize, and the support menu entries should now be readable.  Of course, no
Xamount of coding can overcome inappropriate font selections.
X.\"
X.SH ICONIFICATION
X\*(xM establishes access to a dummy mail folder whenever the application is
Xin the iconified state.
XThis is done to prevent potential corruption of a real mail folder, should the
Xuser choose to read their mail from another process while \*(xM is running.
XBecause of this action, iconifying \*(xM \fBalways\fR
X.SB COMMITS
Xchanges made to the current folder, prior to switching to the dummy folder.  No
Xconfirmation for committing folder changes will occur when iconifying \*(xM.
X
XThe original folder being read by the user will be 
Xautomatically reinstated as current whenever \*(xM is again de-iconified.
XThis action will flush any deleted messages from the index headers and renumber
Xthe remaining messages in the folder.  The last message in the folder will then
Xbecome the current message displayed (unless \*(xM was started with the
X\fB*Show_Last\fR resource option disabled, in which case the first message
Xwould be made current).
X
XIf the \*Qcurrent\*U folder was the user's system folder, any new mail
Xreceived since the iconification would be automatically included by the
Xre-access.  If some other folder were current (\fIor no folder, due to initial
Xconditions of no mail for the user\fR), de-iconification would not cause the
Xreading of any new mail.  Under those circumstances the user must press the
X\fBNewmail\fR command button to change to the system mail folder (\fIand read
Xthe new mail\fR).
X
XThe icon window also supports an auxiliary identification mechanism,
Xfor users that might have more than one account, possibly on more than
Xone machine, and that wish to be able to identify otherwise duplicate \*(xM
Xicons.  Pressing the '\fBh\fR' key while the mouse cursor is within the icon
Xwindow will cause the icon to be tagged with the mail host name.
XPressing the '\fBu\fR' key will cause the mail user name to be displayed.
XPressing the '\fBspace\fR' bar will clear the icon window of either name.
XChanging the tag space content of the icon will also change the title of the
Xapplication for window managers.  This allows the user to distinguish between
Xseveral xmail invocations from the window (or icon) selection menus of the
Xvarious window managers.
XEither the mail host or user name may also be pre-selected using either
Xcommand line options or resource declarations if desired.
X
XIconification is typically promoted by user definable button events which are
Xparticular to the window manager in use at the time.  Pressing the \*(nS logo
Xdisplayed at the left of the title bar will also cause xmail to issue a window
Xmanager request for iconification.  ICCCM compliant window managers should
Xhonor that request by iconify the xmail application.
X.\"
X.SH "KEYBOARD ACCELERATORS"
XThe index and text windows support two methods of scrolling displayable
Xtext.  The use of the mouse buttons in the scrollbar region is standard.
XIn addition, keyboard keys have been defined in keeping with conventions
Xused in text display programs such as \*Qmore\*U and \*Qless\*U.
X
XThe following table lists the key definitions and their respective actions.
XThe abbreviation \*QCtrl\*U means to press down and hold the \fBControl\fR
Xkey while pressing the specified letter key.  \*QMeta\*U likewise refers
Xto the \fBmeta\fR keys (\fIlabeled \*QLeft\*U and \*QRight\*U on some
XSun keyboards\fR).
X.sp
X.RS
X.nf
XKey Name 		Action Taken
X--------		-----------------------------
X Ctrl V 		move to the next page
X space  		move to the next page
X Meta V 		move to the previous page
X   b    		move to the previous page
X Ctrl Z 		scroll one line up
X Return 		scroll one line up
X   j    		scroll one line up
X Meta Z 		scroll one line down
X   k    		scroll one line down
X   -    		scroll one line down
X   \'    		move to the beginning of file
X Meta < 		move to the beginning of file
X Meta > 		move to the end of file
XShift G 		move to the end of file
X.fi
X.RE
X.sp
X.LP
XIn addition to the scroll key definitions, both windows also support
Xkeyboard accelerators for most of the command buttons.  Where possible,
Xthese keyboard keys replicate the actual commands that would be typed
Xif the user were running the native mail program.  Thus, to begin
Xsending a mail message to some recipient, the user could press the \*Qm\*U key,
Xand to delete a current message, the user could press the \*Qd\*U key.
X.sp
X.RS
X.nf
XKey Name 		Command Action Taken
X--------		-----------------------------
XShift A 		reply to all, include the current message
XShift C 		copy the message to the author's name
XShift F 		forward the current mail message
XShift M 		reply to a mail message
XShift N 		bring new mail into your system folder
XShift P 		send the current message to the printer
XShift R 		include the current message in a reply
XShift S 		save the message to the author's name
X   a    		reply to all recipients of a message
X   c    		copy the message to the indicated folder
X   d    		delete the current message
X   f    		read the full header of the message
X   i    		incorporate new mail without commit
X   m    		mail (compose) a new mail message
X   n    		read the next mail message
X   p    		read the previous mail message
X   q    		quit xmail, committing any changes
X   r    		read the current mail message
X   s    		save current message in specified folder
X   u    		undelete the most recently deleted message
X   w    		writes the message to the indicated file
X   x    		exit xmail, without committing changes
X   ?    		displays help for these key definitions
X <LF>   		removes help for these key definitions
X.fi
X.RE
X.\"
X.SH RESOURCES
X\*(xM recognizes resource definitions for each of its component windows and
Xcommand buttons.  Most of the application resources for the \*(xM program
Xhave been moved from the program to the defaults file, to allow greater
Xflexibility on the part of the user.  Wherever possible, button resources
Xhave been named for the
Xlabel (or first word in the label) of the command button.  (\fIThe exception
Xis the preserve \*Qset\*U menu, whose resources are identified by the second
Xword in each label.\fR)
XThus :
X.RS
X.TP 3
X\fB*read\fR
Xspecifies resources for the \fIread\fR command button
X.TP 3
X\fB*save\fR
Xspecifies resources for the \fIsave\fR command button
X.TP 3
X\fB*autoprint\fR
Xspecifies resources for the \fIset autoprint\fR command button, and
X.TP 3
X\fB*noautoprint\fR
Xspecifies resources for the \fIset noautoprint\fR command button.
X.RE
X.LP
XColor may be added (on a color display device) to enhance
Xthe appearance of \*(xM.  Resources in the application defaults file may be
Xoverridden by designations in the user's \&.Xdefaults file, or (\fIin some
Xcases\fR) by command line options.
XResources specified in the user's \&.Xdefaults file should be preceded with
Xeither the \fB\*(xM\fR application or \fBXMail\fR Class resource identifier.
X
XIn addition to those resources named for a particular \*(xM command button,
Xthe following additional resource names are recognized:
X.sp
X.RS
X.TP 3
X\fB*Bcc\fR
Xcontrols resources for the \fIBcc:\fR entry window
X.TP 3
X\fB*bellRing: \fI<boolean>\fR
XNormally true, this boolean enables ringing of the terminal bell during
Xstatus and error message display.
X.TP 3
X\fB*Cc\fR
Xcontrols resources for the \fICc:\fR entry window
X.TP 3
X\fB*commandPanel\fR
Xcontrols resources for the \fIcommand panel\fR
X.TP 3
X\fB*editorCommand: \fI<quoted command string>\fR
XSpecifies the editor resource that \*(xM should use when editing a message
Xcomposition.  The quoted command must be an \fIsprintf\fR\-able format
Xcontaining two string declarations.  The first of these declarations will be
Xreplaced with the name of the display connection for the xmail process, to
Xallow the edit window to appear on the correct display screen.  The second
Xdeclaration will be replaced with the name of the file to be edited.
XIf \*(xM cannot locate the two separate string declarations in the command,
Xthe command will be rejected and processing will default to the older
X.SM VISUAL
Xmethodology.
X.TP 3
X\fB*expert: \fI<boolean>\fR
XThis boolean defines whether the \*(xM user requires confirmation of
Xfolder commits or composed message deletions.  Whenever an action
Xwould make a permanent un-recoverable change to the \*(xM environment, a
Xpopup confirmation window will be presented for the user, to assure that
Xthe action should take place.  These confirmations include changing a
Xfolder when deletions have occurred, or deleting the text of a newly
Xcomposed message instead of sending it.  Setting this resource to True
Xeliminates those confirmation popups.
X.TP 3
X\fB*fileWindow\fR
Xcontrols resources for the \fIfile window\fR within the command panel
X.TP 3
X\fB\&.geometry: \fI[+-]XOff[+-]YOff\fR
XThis resource defines the initial startup location for the \*(xM window.
XNote the dot (.) just in front of the geometry resource name.
XUsers are cautioned to \fBnot\fR specify this resource with the
Xwildcard (*) designation, as this would force all popup windows (help, menus,
Xand send/reply) to orient to that same starting location, rather than be
Xanchored to the intended window.
X.TP 3
X\fB*helpFont: \fI<fontname>\fR
Xdenotes a preferred font to use when displaying help information.
X.TP 3
X\fB*icon\fR
Xcontrols resources for the \fIicon\fR window.  In addition to 
Xspecifications of foreground and background colors, it is also possible
Xto specify the following mailWatch widget resources :
X.RS
X.TP 3
X\fB*icon*useHost: \fI<Boolean>\fR
XIf set to true, tells \*(xM to include the mail host name in the icon window
Xwhen displaying the icon.  This option is now alterable at runtime by keypress
Xin the icon window.  \*Q\fBh\fR\*U sets the host name, \*Q\fBu\fR\*U sets the
Xuser name, and \*Q\fBspace\fR\*U clears either entry.
X.TP 3
X\fB*icon*useName: \fI<Boolean>\fR
XIf set to true, tells \*(xM to include the user login name in the icon window
Xwhen displaying the icon.
X.TP 3
X\fB*icon*reverseVideo: \fI<boolean>\fR
XIf set to true, reverses the foreground and background colors for the icon.
X.TP 3
X\fB*icon*update: \fI<seconds>\fR
XSpecifies the update interval for checking new mail (default is 30 seconds).
X.TP 3
X\fB*icon*bell: \fI<boolean>\fR
XIf set to False, prevents the mailWatch widget from ringing the bell when
Xnew mail arrives.  See also the \&.mailrc variable setting for \fIbell\fR.
X.RE
X.TP 3
X\fB*iconic: \fI<boolean>\fR
XThis boolean defines whether the \*(xM application should be started in
Xiconic state or not.  It is highly recommended that only the application
Xresource identifier be used if specifying this resource.
XUse of the \fBXMail\fR Class identifier would also constrain any
Xmessage entry windows to be started iconic, which could prove confusing
Xto the unaware user.
X.TP 3
X\fB*iconGeometry: \fI[+-]XOff[+-]YOff\fR
XThis resource defines an initial location for the icon, whenever the
X\*(xM application is iconified.
X.TP 3
X\fB*indexWindow\fR
Xcontrols resources for the \fIindex\fR window
X.TP 3
X\fB*list\fR
Xcontrols resources for the \fIfolder list\fR popup window
X.TP 3
X\fB*mailopt_n: \fI<boolean>\fR
XNormally false, this resource
Xduplicates the effect of the \fI-n\fR command line option.
X.TP 3
X\fB*mailopt_U: \fI<boolean>\fR
XNormally false, this resource
Xduplicates the effect of the \fI-U\fR command line option.
X.TP 3
X\fB*menu\fR
Xcontrols resources for all of the command button popup menus
X.TP 3
X\fB*MFileName: \fI<foldername>\fR
XNormally null, this resource
Xduplicates the effect of the \fI-f folder\fR command line option.
X.TP 3
X\fB*Show_Info: \fI<boolean>\fR
XNormally true, this boolean enables display of command button information
Xmessages in the status window, whenever the mouse cursor enters or leaves one of
Xthe command button windows.  Information messages are also displayed for each
Xof the popup sub-menus as well.  Setting this resource to false prevents these
Xinformation messages from being displayed.
X.TP 3
X\fB*Show_Last: \fI<boolean>\fR
XNormally true, this boolean enables display of the last message in a folder,
Xproviding no other is newer or unread.  Setting this resource to false causes
Xfolder displays to start with the first (or new or unread) message.
X.TP 3
X\fB*statusWindow\fR
Xcontrols resources for the \fIstatus\fR window
X.TP 3
X\fB*Subject\fR
Xcontrols resources for the \fISubject:\fR entry window
X.TP 3
X\fB*textWindow\fR
Xcontrols resources for the \fItext\fR window
X.TP 3
X\fB*titleBar\fR
Xcontrols resources for the \fItitleBar\fR window
X.TP 3
X\fB*To\fR
Xcontrols resources for the \fITo:\fR entry window
X.RE
X
XA set of default resource definitions are provided in the
Xfile \fB/usr/lib/X11/app-defaults/XMail\fR.  User's may wish to include
Xappropriate alternate definitions in their ~/.Xdefaults file, to tailor
Xpreferences for colors and/or fonts.
X.\"
X.SH "SENDING MESSAGES"
XAll send and reply operations invoke the user's preferred editor to create or
Xmodify the message.  The editor preference may be specified using either the
X.SB VISUAL
X\&.mailrc environment specification, or the newer \fBeditorCommand\fR resource
Xspecification (\fIor \-editorCommand command line option\fR).
X
XThe editorCommand resource must define a string with two \fBsprintf\fR\-able
Xformat declarations, one for the name of the X11 server display connection,
Xand one for the name of the file to be edited.  The editorCommand specification
Xmust also ensure the proper creation of an appropriate X11 window for
Xcompleting the desired editing session.
X
XThe resource may be specified on the command line, either as an option, or as
Xa resource manager string.  It may also be specified in the user's applications
Xdefault file as an xmail resource.  Examples of editorCommand specification
Xstrings include:
X
X.RS
X.nf
X\fBxmail\ \-editorCommand\ 'emacs\ \-display\ %s\ \-name\ XMail\ %s'
X.sp
X\fBxmail\ \-xrm\ '*editorCommand:\ xterm\ \-display\ %s\ \-e\ vi\ %s'
X.sp
Xxmail.editorCommand:\ \ xedit\ -name XMail_Edits \-display\ %s\ %s
X.sp
Xxmail.editorCommand:\ \ emacs\ \-display\ %s\ %s
X.sp
Xxmail.editorCommand:\ \ xterm\ \-display\ %s\ -name XMail -e vi %s
X.fi
X.RE
X
XIf the editorCommand resource fails to provide the required string declarations
Xfor the display and file names, or it is not defined, \*(xM will default to
Xthe older method of utilizing the information in the user or Mail process
X.SB VISUAL
Xenvironment variable.
XThe \fIdefault\fR editor will be \fBvi\fR, if no
X.SM VISUAL
X(\fImailrc or process\fR) environment variable definition exists.
X
XUpon completion of the send/reply editing session, a popup window will be
Xdisplayed containing \fITo:\fR, \fISubject:\fR, \fICc:\fR, and \fIBcc:\fR
Xfields for the current message composition.  Help is available for each of
Xthese fields, as it is for all of \*(xM.
X
XA menu of mail aliases (\fIextracted from the user's .mailrc file\fR) is
Xavailable for access from any of the To:, Cc:, or Bcc: windows.  Pressing the
Xright mouse button while the mouse
Xcursor is in any of these input fields causes the alias names menu to be
Xdisplayed.  If the user has not defined any mail aliases, the terminal bell
Xwill be rung instead, to indicate that no alias names menu is available.
X
XLike the \fIFile:\fR window used to enter file and mail folder names, the
Xcontent of the send window popup fields may be modified by the user as needed.  
XBackspace and delete keys remove the previous character, control_W
Xdeletes the previous word, and control_U deletes the entire
Xline of information.  Pressing the Return key in any of these four
Xfields causes the cursor to automatically warp to the next field.
X
XUsers may append their \fISign\fP or \fIsign\fP autograph (see \fBMail(1)\fR)
Xonce only to the end of the composed message text.
XPressing the \fIRe-Edit\fR button allows the message to be re-edited,
Xwhile the \fICancel\fR button terminates delivery but saves any partial
Xcomposition in your dead.letter file.
XPressing the \fIAbort\fR button cancels delivery but does not save the
Xcomposition, while the
X\fIDeliver\fR button causes the message to be delivered to the sendmail daemon.
X
XMail forwarded to another user will be bracketed by a \*Q\fIBegin Forwarded
XMessage/End Forwarded Message\fR\*U string
Xpair when using the \*Q\fIforward message\fR\*U Send command menu option.  Also 
Xincluded will be a \*Q\fIForwarded: Mail from ...\fR\*U line in the mail header.
X
XReply messages will include a \*Q\fIIn-Reply-To: Mail from ...\fR\*U string
Xin the mail
Xheader.  Like the \*Q\fIForwarded:\fR\*U header described above, it will include
Xthe name of the original sender, as well as the date the original message was
Xreceived.
X
XIf an X-Face header exists for the user, it will be inserted in the mail header
Xsection of the outgoing message.  This header must be stored in the file
X\fB\&.face\fR located in the user's home directory.
X.\"
X.SS "X-FACE HEADERS"
XX-Face headers are compressed bitmap images, typically of the face of the
Xperson owning such a header.  The compressed header contains only printable
Xcharacters, which allows it to be included in a mail message.
XThe \s-1USENIX\s+1 (\fI\s-1UNIX\s+1 Users Association\fR)
XFaceSaver project is the typical
Xsource for these bitmaps, which are compressed into X-Face header
Xformat using the \fBcompface\fR software tools written and distributed by
XJames Ashton <jaa at cs.su.oz.au>.  The compface library is also included with the
Xdistribution of the \fBfaces\fR software, written and distributed by Rich
XBurridge, and is available from the
XRich Burridge Archive Service <rb-archive-server at Aus.Sun.COM>.
X.\"
X.SS "EDITING RESOURCES"
XThe editing session invoked within \*(xM runs as a child process of the
X\*(xM application.  As such, it does not use those resources that were declared
Xfor the \*(xm process.  Resources for the editing session should be tied to the
Xuse of the \fB\-name\fR toolkit option in the editorCommand specification.
X
XThe default
X.SM VISUAL
Xmechanism invokes the vi editor in an xterm window, using the \*(xM Class
Xresource as it's name identifier.  This allows message composition window
Xresources to be declared
Xusing the \*(xM Class resource name followed by the xterm terminal resources
Xidentifier \*Qvt100\*U, as in \*Q\fBXMail*vt100.\fI<resource: value>\fR\*U.
X
XFor example, the author uses the following resource definitions in his
X\&.Xdefaults file, to control the size and placement of message composition
Xwindows.
X.sp
X.RS
X.nf
XXMail*vt100.geometry:           80x27+30+100
XXMail*vt100.font:               fg-22
XXMail*vt100.foreground:         white
XXMail*vt100.background:         blue
XXMail*vt100.mouse:              white
X.fi
X.RE
X.\"
X.SH "VARIABLES"
X\*(xM also uses the existence and value of several Mail environment
Xvariables (\fIdefined in the user's \&.mailrc file\fR) to aid in controlling
Xit's operation.
X.sp
X.RS
X.TP 3
X\fBalwaysignore\fR
XIf set, causes \*(xM to ignore those header fields specified with the
X\fIignore\fR \&.mailrc environment variable, when printing messages 
Xor when including message text in a send/reply composition.  This variable
Xcan be altered during the execution of \*(xM.  (See the section below
Xon \fIChanging Variables\fR.)
X.TP 3
X\fBautoprint\fR
XIf enabled, causes the current message text to be displayed when deleting or
Xundeleting messages.  If \fInot\fR enabled, users must select or read the
Xdesired
Xmessage.  This variable can also be altered within the current \*(xM execution.
X.TP 3
X\fBbell=\fIvalue\fR
XIf defined, determines the number of times the terminal bell would be rung to
Xindicate the arrival of new mail.  A minimum of once and a maximum of five
Xtimes is the permissible range.  Whether the terminal bell rings at all when
Xnew mail arrives is controlled by the \*Q\fB*icon*bell: \fI<boolean>\fR\*U
Xresource (\fIor \fB\-nb\fP command line option\fR) described above.
X.TP 3
X\fBhold\fR
XLike mailtool, \*(xM sets \*Qhold\*U on the user's system mail folder,
Xunless \*Qnohold\*U has been \fIexplicitly\fR specified in the user's
X\&.mailrc file.  This variable can also be altered during \*(xM execution.
X.TP 3
X\fBprintmail=\fIprinter command\fR
XThis variable, originally created for the Sunview mailtool, allows the user
Xto specify a preferred command to use when printing messages.  The default
Xcommand is \*Qlpr -p\*U.
X.TP 3
X\fBsendmail=\fIshell-command\fR
XIf set, specifies an alternate procedure to use in lieu of the default
X\&/usr/lib/sendmail for delivering mail. User supplied procedures must be
Xprepared to search the message file for recipients and ignore or process
Xunexpected options (which ultimately must be passed on to the real sendmail
Xprogram).
X.RE
X.LP
XSome Mail variables have no effect on \*(xM operation, and are in fact ignored
Xif found to be set.
X.RS
X.TP 3
X\fBreplyall\fR
Xhas no effect on the meaning of commands within \*(xM.  This prevents confusion
Xdue to a difference between how a command is labeled, and how it reacts in use.
X.TP 3
X\fBcrt=\fI<value>\fR
Xis ignored, and always defaults to \fBnocrt\fR.  This prevents user specified
Xpaging mechanisms from interfering with full message delivery to \*(xM.
X.TP 3
X\fBscreen=\fI<value>\fR
XThe current release of \*(xM can safely handle up to a
Xmaximum of 10,000 mail message in any one mail folder.  Users with more than
X10,000 messages in any one folder should seriously consider either creating
Xsome additional sub-folders, or at least deleting older messages.
X.\"
X.SS "CHANGING VARIABLES"
X\*(xM provides a mechanism for altering the values of four of the Mail
Xenvironment variables used to control \*(xM (and Mail) operations.
XThe states of \fBalwaysignore, autoprint, hold,\fR and
X\fBexpert\fR can now be \*Qtoggled\*U from a special menu attached to the
X\fBpreserve\fR command button.
X.LP
XPressing the right mouse button while the
Xmouse pointer is within the preserve command button box presents a
Xmenu of \*Qset\*U
Xcommands which indicate the state the environment variables would be changed
Xto,
Xif the mouse button were released while one of these commands was highlighted.
X.LP
XChanging the state of the variable alters the next presentation of the menu,
Xsuch that the opposite state will always be presented as the command option.
X.RE
X.\"
X.SH "SEE ALSO"
XMail(1)
X.\"
X.SH BUGS
XRepeated pressings of a command button prior to its completion of an
Xoperation may cause \*(xM to crash.  Users are cautioned against imposing too
Xmany requests too quickly when using \*(xM.
X
XMoving the mouse cursor between command windows during the time that an error
Xor status message is being delivered can sometimes cause the message to be
Xobscured before the user has the opportunity to read it.  To redisplay such a
Xmessage, reissue the errored command while avoiding excessive mouse motion.
X.\"
X.SH AUTHOR
X.ce 3
XCopyright 1989, 1990, 1991 - \*(nS
XALL RIGHTS RESERVED
X
XMichael Wagnitz, \*(nS, Santa Clara, CA
X.LP
XMuch of the original design and insight for \*(xM was provided by
Xcontributions from the following authors:
X
XThe xdbx contribution by Po Cheung (po at volta.ece.utexas.edu)
X.RS
XCopyright 1989 The University of Texas at Austin
X.RE
X
XThe mailWatch widget by Dan Heller (argv at sun.com)
X.RS
Xused as the \*(xM icon window.
X.RE
END_OF_FILE
if test 40275 -ne `wc -c <'xmail.man'`; then
    echo shar: \"'xmail.man'\" unpacked with wrong size!
fi
# end of 'xmail.man'
fi
echo shar: End of archive 10 \(of 11\).
cp /dev/null ark10isdone
MISSING=""
for I in 1 2 3 4 5 6 7 8 9 10 11 ; do
    if test ! -f ark${I}isdone ; then
	MISSING="${MISSING} ${I}"
    fi
done
if test "${MISSING}" = "" ; then
    echo You have unpacked all 11 archives.
    rm -f ark[1-9]isdone ark[1-9][0-9]isdone
else
    echo You still need to unpack the following archives:
    echo "        " ${MISSING}
fi
##  End of shell archive.
exit 0

--
Dan Heller
O'Reilly && Associates       Z-Code Software    Comp-sources-x:
Senior Writer                President          comp-sources-x at uunet.uu.net
argv at ora.com                 argv at zipcode.com