Removed nmh-from condition from rcvdistcomps.
[mmh] / man / mh-profile.man
index e5a7b52..949cf97 100644 (file)
@@ -22,6 +22,15 @@ family of programs.  Each entry in the file is of the format
 .PP
 If the text of profile entry is long, you may extend it across several
 real lines by indenting the continuation lines with leading spaces or tabs.
+Comments may be introduced by a line starting with `#:':
+.PP
+.RS 5
+.IR # ": "
+This is a comment.
+.RE
+.PP
+Blank lines are not permitted in
+.IR \&.mh\(ruprofile.
 
 .SS "Standard Profile Entries"
 The possible profile components are exemplified below.  The only mandatory
@@ -31,7 +40,9 @@ indicates whether the information is kept in the user's
 .B nmh
 profile or
 .B nmh
-context, and indicates what the default value is.
+context, and indicates what the default value is.  Note that a profile
+component can only appear once.  Multiple appearances with trigger a
+warning that all appearances after the first are ignored.
 .PP
 .BR Path :
 Mail
@@ -154,17 +165,18 @@ composition draft before it is sent.
 .RE
 .PP
 .BR Msg\-Protect :
-644
+600
 .RS 5
 An octal number which defines the permission bits for new message files.
 See
 .BR chmod (1)
-for an explanation of the octal number.
-(profile, default: 0644)
+for an explanation of the octal number.  Note that some filesystems,
+such as FAT32, do not support removal of read file permissions.
+(profile, default: 0600)
 .RE
 .PP
 .BR Folder\-Protect :
-750
+700
 .RS 5
 An octal number which defines the permission bits for new folder
 directories.  See
@@ -206,14 +218,6 @@ arguments to \*(lqWhat now?\*(rq, then \*(lqnexteditor\*(rq is used.
 (profile, no default)
 .RE
 .PP
-.BR bboards :
-system
-.RS 5
-Tells
-.B bbc
-which BBoards you are interested in.  (profile, default: system)
-.RE
-.PP
 .BR Folder\-Stack :
 .I folders
 .RS 5
@@ -223,6 +227,22 @@ command.
 (context, no default)
 .RE
 .PP
+.BR Local\-Mailbox :
+Your Username <user@some.host>
+.RS 5
+Tells the various MH tools what your local mailbox is.  If set, will be used
+by the default component files by tools like
+.B comp
+and
+.B repl
+to construct your default \*(lqFrom\*(rq header.  The text used here will
+be copied exactly to your From: header, so it should already be RFC-822
+compliant.  If this is set, the
+.B Signature
+profile entry is NOT used, so it should include a signature as well.  (profile,
+default: userid@local.hostname)
+.RE
+.PP
 .BR Alternate\-Mailboxes :
 mh@uci\-750a, bug-mh*
 .RS 5
@@ -268,6 +288,7 @@ Indicates a default draft folder for
 .BR comp ,
 .BR dist ,
 .BR forw ,
+.BR refile ,
 and
 .BR repl .
 Read the
@@ -309,22 +330,23 @@ superseded by the environment variable
 .BR Signature :
 RAND MH System (agent: Marshall Rose)
 .RS 5
-Tells
-.B send
+Tells front-end programs such as
+.BR comp,
+.BR forw,
+and
+.B repl
 your mail signature.  This is superseded by the
 environment variable
 .BR $SIGNATURE .
 If
 .B $SIGNATURE
 is not set and this profile entry is not present, the \*(lqgcos\*(rq field of
-the \fI/etc/passwd\fP file will be used; otherwise, on hosts where
-.B nmh
-was configured with the UCI option, the file
-.I $HOME/.signature
-is consulted.  Your signature will be added to the address
+the \fI/etc/passwd\fP file will be used.
+Your signature will be added to the address
 .B send
 puts in the \*(lqFrom:\*(rq header; do not include an address in the
-signature text.  (profile, no default)
+signature text.  The \*(lqLocal\-Mailbox\*(rq profile component
+supersedes all of this.  (profile, no default)
 .RE
 
 .SS "Process Profile Entries"
@@ -351,7 +373,7 @@ to process drafts which are MIME composition files.
 .RS 5
 This program is used to refile or link a message to another folder.
 It is used by
-.B post
+.B send
 to file a copy of a message into a folder given
 by a \*(lqFcc:\*(rq field.  It is used by the draft folder facility in
 .BR comp ,
@@ -366,6 +388,16 @@ response to the
 directive at the \*(lqWhat now?\*(rq prompt.
 .RE
 .PP
+.BR formatproc :
+.RS 5
+Program called by
+.B mhl
+to filter a component when it is tagged with the \*(lqformat\*(rq variable
+in the mhl filter.  See
+.BR mhl (5)
+for more information.
+.RE
+.PP
 .BR incproc :
 %bindir%/inc
 .RS 5
@@ -438,14 +470,10 @@ message that you are forwarding, or to which you are replying.
 When the
 .B \-filter
 option is given to
-.B send
-or
-.BR post ,
+.BR send ,
 the
 .I mhlproc
-is used by
-.B post
-to filter the copy of the message
+is used to filter the copy of the message
 that is sent to \*(lqBcc:\*(rq recipients.
 .RE
 .PP
@@ -505,12 +533,6 @@ and
 to delete a message from a folder.
 .RE
 .PP
-.BR rmfproc :
-%bindir%/rmf
-.RS 5
-Currently not used.
-.RE
-.PP
 .BR sendproc :
 %bindir%/send
 .RS 5
@@ -580,24 +602,6 @@ variables whose names are all upper-case are user-settable; those
 whose names are lower-case only are used internally by nmh and should
 not generally be set by the user.
 .PP
-If the
-.B WHATNOW
-option was set during
-.B nmh
-configuration, and
-if this environment variable is set, then if the commands
-.BR refile\ ,
-.BR send ,
-.BR show ,
-or
-.B whom
-are not given any `msgs'
-arguments, then they will default to using the file indicated by
-.BR mh\-draft (5).
-This is useful for getting the default behavior
-supplied by the default
-.IR whatnowproc .
-.PP
 .B $MH
 .RS 5
 With this environment variable, you can specify a profile
@@ -630,6 +634,41 @@ is absolute, it will be presumed to start from your
 directory.
 .RE
 .PP
+.B $MHBUILD
+.RS 5
+With this environment variable, you can specify an
+additional user profile (file) to be read by
+.BR mhbuild ,
+in addition to the mhn.defaults profile.
+.RE
+.PP
+.B $MHN
+.RS 5
+With this environment variable, you can specify an
+additional user profile (file) to be read by
+.BR mhn ,
+in addition to the mhn.defaults profile.
+.B mhn
+is deprecated, so this support for this variable will
+be removed from a future nmh release.
+.RE
+.PP
+.B $MHSHOW
+.RS 5
+With this environment variable, you can specify an
+additional user profile (file) to be read by
+.BR mhshow ,
+in addition to the mhn.defaults profile.
+.RE
+.PP
+.B $MHSTORE
+.RS 5
+With this environment variable, you can specify an
+additional user profile (file) to be read by
+.BR mhstore ,
+in addition to the mhn.defaults profile.
+.RE
+.PP
 .B $MM_CHARSET
 .RS 5
 With this environment variable, you can specify
@@ -679,13 +718,37 @@ This variable tells
 the default maildrop. This supersedes the \*(lqMailDrop\*(rq profile entry.
 .RE
 .PP
+.B $MAILHOST
+.RS 5
+This variable tells
+.B inc
+the POP host to query for mail to incorporate.  See the
+inc(1) man page for more information.
+.RE
+.PP
+.B $USERNAME_EXTENSION
+.RS 5
+This variable is for use with username_extension masquerading.  See the
+mh-tailor(5) man page.
+.RE
+.PP
 .B $SIGNATURE
 .RS 5
 This variable tells
 .B send
 and
 .B post
-your mail signature. This supersedes the \*(lqSignature\*(rq profile entry.
+your mail signature. This supersedes the \*(lqSignature\*(rq profile entry,
+and is not used when the \*(lqLocal\-Mailbox\*(rq profile component is set.
+.RE
+.PP
+.B $USER
+.RS 5
+This variable tells
+.B repl
+your user name and
+.B inc
+your default maildrop:  see the \*(lqMailDrop\*(rq profile entry.
 .RE
 .PP
 .B $HOME
@@ -695,13 +758,6 @@ This variable tells all
 programs your home directory
 .RE
 .PP
-.B $SHELL
-.RS 5
-This variable tells
-.B bbl
-the default shell to run
-.RE
-.PP
 .B $TERM
 .RS 5
 This variable tells
@@ -722,6 +778,55 @@ how many
 lines long your terminal screen is.
 .RE
 .PP
+.B $MHMTSCONF
+.RS 5
+If this variable is set to a non-null value, it specifies the
+name of the mail transport configuration file to use by
+.BR post ,
+.BR inc ,
+and other programs that interact with the mail transport system,
+instead of the default.  See mh-tailor(5).
+.RE
+.PP
+.B $MHMTSUSERCONF
+.RS 5
+If this variable is set to a non-null value, it specifies the name of
+a mail transport configuration file to be read in addition to the
+default.  See mh-tailor(5).
+.RE
+.PP
+.B $MHTMPDIR
+.B $TMPDIR
+.B $TMP
+.RS 5
+These variables are searched, in order, for the directory in which to
+create some temporary files.
+.RE
+.PP
+.B $MHLDEBUG
+.RS 5
+If this variable is set to a non-null value,
+.B mhl
+will emit debugging information.
+.RE
+.PP
+.B $MHPDEBUG
+.RS 5
+If this variable is set to a non-null value,
+.B pick
+will emit a representation of the search pattern.
+.RE
+.PP
+.B $MHWDEBUG
+.RS 5
+If this variable is set to a non-null value,
+.B nmh
+commands that use the
+.BR Alternate\-Mailboxes
+profile entry will display debugging information
+about the values in that entry.
+.RE
+.PP
 .B $editalt
 .RS 5
 This is the alternate message.
@@ -753,16 +858,6 @@ which file to ask \*(lqWhat now?\*(rq
 questions about.
 .RE
 .PP
-.B $mhfolder
-.RS 5
-This is set by
-.BR dist ,
-.BR forw ,
-and
-.BR repl ,
-if appropriate.
-.RE
-.PP
 .B $mhaltmsg
 .RS 5
 .B dist
@@ -776,6 +871,27 @@ about an alternate message associated with the
 draft (the message being distributed or replied to).
 .RE
 .PP
+.B $mhfolder
+.RS 5
+This is the folder containing the alternate message.
+.PP
+This is set by
+.B dist
+and
+.B repl
+during edit sessions so you
+can peruse other messages in the current folder besides the one being
+distributed or replied to.  The environment variable
+.B $mhfolder
+is also set by
+.BR show ,
+.BR prev ,
+and
+.B next
+for use by
+.BR mhl .
+.RE
+.PP
 .B $mhdist
 .RS 5
 .B dist
@@ -836,27 +952,6 @@ and
 .B repl
 if annotations are to occur.
 .RE
-.PP
-.B $mhfolder
-.RS 5
-This is the folder containing the alternate message.
-.PP
-This is set by
-.B dist
-and
-.B repl
-during edit sessions so you
-can peruse other messages in the current folder besides the one being
-distributed or replied to.  The environment variable
-.B $mhfolder
-is also set by
-.BR show ,
-.BR prev ,
-and
-.B next
-for use by
-.BR mhl .
-.RE
 
 .SH FILES
 .fc ^ ~
@@ -870,7 +965,7 @@ for use by
 .fi
 
 .SH "SEE ALSO"
-nmh(1), environ(5), mh-sequence(5)
+nmh(7), environ(5), mh-sequence(5)
 
 .SH HISTORY
 The