X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/46f35e659f3bc3e808a70263bea0ec72624c8a08..c576ad2674c37a1c63f004c71049998f38854c64:/man/mh-profile.man diff --git a/man/mh-profile.man b/man/mh-profile.man index 81e2ccbe..3b9bdcb4 100644 --- a/man/mh-profile.man +++ b/man/mh-profile.man @@ -1,24 +1,24 @@ -.TH MH-PROFILE %manext5% "April 18, 2014" "%nmhversion%" -.\" +.TH MH-PROFILE %manext5% 2016-10-19 "%nmhversion%" +. .\" %nmhwarning% -.\" +. .SH NAME -mh-profile \- user profile customization for nmh message handler +mh-profile \- user customization for nmh message handler .SH DESCRIPTION Each user of .B nmh is expected to have a file named -.I \&.mh\(ruprofile -in his or her home directory. This file contains -a set of user parameters used by some or all of the +.I \&.mh\-profile +in their home directory. This file contains +a set of user parameters used by the .B nmh family of programs. Each entry in the file is of the format .PP .RS 5 -.IR profile\-component ": " value +.IR profile-component ": " value .RE .PP -If the text of profile entry is long, you may extend it across several +If the text of a 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 @@ -28,10 +28,9 @@ This is a comment. .RE .PP Blank lines are not permitted in -.IR \&.mh\(ruprofile. -The shell quoting conventions are not available in the -.IR \&.mh\(ruprofile ; -each token is separated by whitespace. +.IR \&.mh\-profile . +Shell quoting conventions are not available; each token is separated +by whitespace. .SS "Standard Profile Entries" The possible profile components are exemplified below. The only mandatory entry is `Path:'. The others are optional; some have default values if @@ -41,9 +40,18 @@ indicates whether the information is kept in the user's profile or .B nmh context, and indicates what the default value is. Note that a profile -component can only appear once. Multiple appearances with trigger a +component can only appear once. Multiple appearances will trigger a warning that all appearances after the first are ignored. .PP +Some MH programs, including +.BR mhbuild , +.BR mhshow , +and +.BR mhstore , +have specific profile components that are described in their respective +man pages. Each component name specific to these programs begins with +the name of the program and is followed by a dash. +.PP .BR Path : Mail .RS 5 @@ -53,17 +61,32 @@ transactions in directory \*(lqMail\*(rq. This is the only mandatory profile entry. (profile, no default) .RE .PP +.BR locale : +locale +.RS 5 +Set the locale for all +.B nmh +programs except +.BR post , +.BR install-mh , +and +.BR slocal . +See the LC_ALL, LC_CTYPE, and LANG variables in the "ENVIRONMENT" +section below for a reference on how the locale is set if this profile +component is not used. +.RE +.PP .BR context : context .RS 5 Declares the location of the .B nmh -context file. This is overridden by the environment variable -.BR $MHCONTEXT . +context file. This can be overridden by the environment variable +MHCONTEXT. See the .B HISTORY section below. -(profile, default: /context) +(profile, default: /context) .RE .PP .BR Current\-Folder : @@ -76,7 +99,7 @@ Keeps track of the current open folder. .BR Inbox : inbox .RS 5 -Defines the name of your default inbox. +Defines the name of the default inbox. (profile, default: inbox) .RE .PP @@ -88,10 +111,10 @@ Names the sequence or sequences which should be defined as the `msgs' or .B nmh command. If not present or empty, no such sequences are defined. Otherwise, for each name given, the -sequence is first zero'd and then each message is added to the sequence. -Read the +sequence is first zeroed and then each message is added to the sequence. +Read .IR mh\-sequence (5) -man page for the details about this sequence. (profile, no default) +for the details about this sequence. (profile, no default) .RE .PP .BR Sequence\-Negation : @@ -99,9 +122,9 @@ not .RS 5 Defines the string which, when prefixed to a sequence name, negates that sequence. Hence, \*(lqnotseen\*(rq means all those messages that -are not a member of the sequence \*(lqseen\*(rq. Read the +are not a member of the sequence \*(lqseen\*(rq. Read .IR mh\-sequence (5) -man page for the details. (profile, no default) +for the details. (profile, no default) .RE .PP .BR Unseen\-Sequence : @@ -117,28 +140,28 @@ and will add or remove messages from these sequences when they are incorporated or read. If not present or empty, no such sequences are defined. Otherwise, each message is -added to, or removed from, each sequence name given. Read the +added to, or removed from, each sequence name given. Read .IR mh\-sequence (5) -man page for the details about this sequence. +for the details about this sequence. (profile, no default) .RE .PP .BR mh\-sequences : -\&.mh\(rusequences +\&.mh\-sequences .RS 5 The name of the file in each folder which defines public sequences. To disable the use of public sequences, leave the value portion of this -entry blank. (profile, default: \&.mh\(rusequences) +entry blank. (profile, default: \&.mh\-sequences) .RE .PP .BI atr\- seq \- folder : 172\0178\-181\0212 .RS 5 Keeps track of the private sequence called \*(lqseq\*(rq in the specified -folder. Private sequences are generally used for read\-only folders. -See the +folder. Private sequences are generally used for read-only folders. +See .IR mh\-sequence (5) -man page for details about private sequences. +for details about private sequences. (context, no default) .RE .PP @@ -151,9 +174,8 @@ Defines the editor to be used by the commands .BR forw , and .BR repl . -If not set in profile the value will be taken from the VISUAL and -EDITOR environment variables. -(profile, default: vi) +If not set, the value will be taken from the VISUAL and EDITOR environment +variables. (profile, default: vi) .RE .PP .BR Msg\-Protect : @@ -182,7 +204,7 @@ fcntl .RS 5 The locking algorithm used to lock changes to any .B nmh -data files, such as sequences or the context. The locking algorithm is +data files, such as sequences or context. The locking algorithm is any one of the following entries: .PP .RS 5 @@ -191,9 +213,8 @@ any one of the following entries: .fi .RE .PP -Available locking algorithms can vary depending on what is supported by -the operating system. Note: currently transactional locking is only -supported on public sequences; see +Available locking algorithms can vary depending on the operating system. +Note: currently, transactional locking is only supported on public sequences; see .IR mh\-sequence (5) for more information. (profile, default: fcntl) @@ -218,17 +239,16 @@ repl: \-editor /bin/ed .I nexteditor .RS 5 Names \*(lqnexteditor\*(rq to be the default editor after using -\*(lqlasteditor\*(rq. This takes effect at \*(lqWhat now?\*(rq prompt +\*(lqlasteditor\*(rq. This takes effect at the \*(lqWhat now?\*(rq prompt in .BR comp , .BR dist , .BR forw , and .BR repl . -After editing -the draft with \*(lqlasteditor\*(rq, the default editor is set to be -\*(lqnexteditor\*(rq. If the user types \*(lqedit\*(rq without any -arguments to \*(lqWhat now?\*(rq, then \*(lqnexteditor\*(rq is used. +After editing the draft with \*(lqlasteditor\*(rq, the default editor is +set to be \*(lqnexteditor\*(rq. If the user types \*(lqedit\*(rq without +any arguments to \*(lqWhat now?\*(rq, then \*(lqnexteditor\*(rq is used. (profile, no default) .RE .PP @@ -244,16 +264,18 @@ command. .BR Local\-Mailbox : Your Username .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 +Tells the MH programs what your local mailbox is. If set, it will be used +by the default component files by programs 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 +to construct your default \*(lqFrom:\*(rq header. The text used here will +be copied exactly to your \*(lqFrom:\*(rq 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, +profile entry is +.I not +used, so it should include a signature as well. (profile, default: userid@local.hostname) .RE .PP @@ -264,27 +286,24 @@ Tells .B repl and .B scan -which addresses are really yours. -In this way, +which additional addresses are yours. In this way, .B repl -knows which addresses should be included in the -reply, and -scan -knows if the message really originated from you. -Addresses must be separated by a comma, and the hostnames listed should -be the \*(lqofficial\*(rq hostnames for the mailboxes you indicate, as -local nicknames for hosts are not replaced with their official site names. -For each address, if a host is not given, then that address on any host is -considered to be you. In addition, an asterisk (`*') may appear at either -or both ends of the mailbox and host to indicate wild-card matching. -(profile, default: your user-id) +knows which addresses should be included in the reply, and +.B scan +knows if a message originated from you. Addresses must be separated by a comma, +and the hostnames listed should be the \*(lqofficial\*(rq hostnames for the +mailboxes you indicate, as local nicknames for hosts are not replaced with +their official site names. For each address, if a host is not given, then +that address on any host is considered to be you. In addition, an asterisk +(`*') may appear at either or both ends of the mailbox and host to indicate +wild-card matching. (profile, default: your user-id) .RE .PP .BR Aliasfile : aliases -.I other-alias +.I other-aliases .RS 5 -Indicates aliases files for +Indicates alias files for .BR ali , .BR whom , and @@ -305,9 +324,9 @@ Indicates a default draft folder for .BR refile , and .BR repl . -Read the +Read .IR mh\-draft (5) -man page for details. (profile, no default) +for details. (profile, no default) .RE .PP .BI digest\-issue\- list : @@ -335,9 +354,8 @@ the last volume sent for the digest .RS 5 Tells .B inc -your maildrop, if different from the default. This is -superseded by the environment variable -.BR $MAILDROP . +your mail drop, if different from the default. This is +superseded by the environment variable MAILDROP. (profile, default: %mailspool%/$USER) .RE .PP @@ -345,18 +363,15 @@ superseded by the environment variable RAND MH System (agent: Marshall Rose) .RS 5 Tells front-end programs such as -.BR comp, -.BR forw, +.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. -Your signature will be added to the address +your mail signature. (This is not to be confused with a .signature +that might be appended to mails.) This is superseded by the environment +variable SIGNATURE. If 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. 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. The \*(lqLocal\-Mailbox\*(rq profile component @@ -364,37 +379,46 @@ supersedes all of this. (profile, no default) .RE .PP .BR credentials : -\&legacy +legacy .RS 5 Indicates how the username and password credentials will be retrieved for access to external servers, such as those that provide SMTP or POP -service. The supported entry values are \*(lqlegacy\*(rq and -.RI \*(lqfile: netrc \*(rq. +service. The supported entry values are \*(lqlegacy\*(rq, +.RI \*(lqfile: netrc \*(rq, +and +.RI \*(lqfile\-nopermcheck: netrc \*(rq. With \*(lqlegacy\*(rq, or if there is no credentials entry, the username is the first of: -.PP .RS 5 +.TP 5 +.PD 0 1) .B \-user switch to -.BR send , -.BR post , -.BR whom , .BR inc , +.BR msgchk , +.BR post , +.BR send , or -.B msgchk +.B whom program -.br -2) the login name on the local machine +.TP +2) +the login name on the local machine +.PD .RE .PP The password for SMTP services is the first of: -.PP .RS 5 -1) password value from matching entry in file named \*(lq.netrc\*(rq +.TP 5 +.PD 0 +1) +password value from matching entry in file named \*(lq.netrc\*(rq in the user's home directory -.br -2) password obtained by interactively prompting the user +.TP +2) +password obtained by interactively prompting the user +.PD .RE .PP The password for POP service when the @@ -406,17 +430,21 @@ With a .RI \*(lqfile: netrc \*(rq .B credentials entry, the username is the first of: -.PP .RS 5 +.PD 0 +.TP 5 1) .B \-user switch to program -.br -2) login name from matching entry in +.TP 5 +2) +login name from matching entry in .I netrc file -.br -3) value provided by user in response to interactive query +.TP 5 +3) +value provided by user in response to interactive query +.PD .RE .PP Similarly, the password is provided either in the @@ -427,12 +455,12 @@ can be any valid filename, either absolute or relative to Path or $HOME. The .I netrc file contains authentication information, for each server, -using a line of the following form. Replace the words +using a line of the following form. (Replace .IR myserver , .IR mylogin , and .I mypassword -with your own account information: +with your own account information.) .PP .RS 5 .B machine @@ -446,17 +474,51 @@ with your own account information: This .I netrc file must be owned and readable only by you. +.PP +The +.RI \*(lqfile\-nopermcheck: netrc \*(rq +.B credentials +entry is identical in behavior to the \*(lqfile\*(rq entry, with the +exception that the permission checks done by +\*(lqfile\*(rq are not performed. This entry should be used with +caution and only when absolutely necessary. (profile, default: legacy) .RE +.PP +.BR Welcome : +disable +.RS 5 +If the Welcome component is not present, or its value is not +.RI \*(lq disable \*(rq, +a welcome message will be displayed the first time that an interactive +.B nmh +program is run after updating the +.B nmh +installation. +The user must press the Enter key to continue. +.PP +If the MHCONTEXT environment variable is set and non-empty (and +the Welcome component is not +.RI \*(lq disable \*(rq), +the welcome message is only displayed if the context file contains a version +reference, and that reference is older than the installed +.B nmh +version. The version reference is of the form: +.PP +.RS 5 +.nf +Version: %nmhversion% +.fi +.RE .SS "Process Profile Entries" The following profile elements are used whenever an .B nmh -program invokes some other program such as +program invokes some other program, such as .BR more . The -.I \&.mh\(ruprofile -can be used to select alternate programs if the -user wishes. The default values are given in the examples. +.I \&.mh\-profile +can be used to select alternate programs if the user wishes. +The default values are given in the examples. .PP If the profile element contains spaces, the element is split at spaces into tokens and each token is given as a separate argument to the @@ -464,7 +526,6 @@ into tokens and each token is given as a separate argument to the system call. If the element contains shell metacharacters then the entire element is executed using .BR /bin/sh . -.RE .PP .BR buildmimeproc : %bindir%/mhbuild @@ -528,7 +589,7 @@ and .B repl to display the draft message. (Note that -.B $PAGER +the environment variable PAGER supersedes the default built-in pager command.) .RE .PP @@ -586,7 +647,7 @@ program used by .B mhshow to display message bodies (or message parts) of type text/plain. (Note that -.B $PAGER +the environment variable PAGER supersedes the default built-in pager command.) .RE .PP @@ -631,7 +692,7 @@ to delete a message from a folder. .BR sendproc : %bindir%/send .RS 5 -This is the program to use by +This is the program used by .B whatnow to actually send the message .RE @@ -657,8 +718,8 @@ to filter and display text (non-MIME) messages. .RS 5 This is the program invoked by .BR comp , -.BR forw , .BR dist , +.BR forw , and .B repl to query about the disposition of a composed draft message. @@ -672,18 +733,49 @@ This is the program used by to determine to whom a message would be sent. .RE .SS "Profile Lookup" -After consulting .mh_profile, -some programs read an optional profile specified by a -program-specific environment variable, -and then the system-wide profile %nmhetcdir%/mhn.defaults. -These programs are mhbuild, mhshow, mhstore, and mhn. -mhfixmsg is similar, but has no optional profile. - -The first occurrence of a component is used, -e.g.\& .mh_profile's trumps $MHSHOW's. -A component with no value still stops further occurrences being used, -but is considered absent. -.SS "Environment Variables" +After consulting .mh_profile, some programs read an optional profile +specified by a program-specific environment variable, and then the +system-wide profile %nmhetcdir%/mhn.defaults. +These programs are +.BR mhbuild , +.BR mhshow , +.BR mhstore , +and +.BR mhn . +.B mhfixmsg +is similar, but has no optional profile. +.PP +The first occurrence of a component is used, e.g.\& .mh_profile's +trumps $MHSHOW's. A component with no value still stops further +occurrences being used, but is considered absent. +.PP +The +.I \&.mh\-profile +contains only static information, which +.B nmh +programs will +.I not +update. Changes in context are made to the +.I context +file kept in the users +.B nmh +directory. This includes, but is not limited to: the +\*(lqCurrent\-Folder\*(rq entry and all private sequence information. +Public sequence information is kept in each folder in the file +determined by the \*(lqmh\-sequences\*(rq profile entry (default is +.IR \&.mh\-sequences ). +.PP +The +.I \&.mh\-profile +may override the path of the +.I context +file, by specifying a \*(lqcontext\*(rq entry (this must be in +lower-case). If the entry is not absolute (does not start with a +\*(lq/\*(rq), then it is interpreted relative to the user's +.B nmh +directory. As a result, you can actually have more than one set of +private sequences by using different context files. +.SH ENVIRONMENT The operation of .B nmh and its commands it also controlled by the @@ -696,294 +788,186 @@ that has to get passed via environment variables to make the .B nmh user, isn't it? The reason for all this is that the .B nmh -user -can select -.B any -program as the +user can select any program as the .IR whatnowproc , -including -one of the standard shells. As a result, it's not possible to pass -information via an argument list. The convention is that environment -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 -.B $MH -.RS 5 +including one of the standard shells. As a result, it's not possible +to pass information via an argument list. The convention is that +environment 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. +.TP +LC_ALL, LC_CTYPE, and LANG +These variables are used to set the locale, see locale(1). +The \*(lqlocale\*(rq profile entry supersedes these. +.TP +MAILDROP +This variable tells +.B inc +the default mail drop. This supersedes the \*(lqMailDrop\*(rq +profile entry. +.TP +MAILHOST +This variable tells +.B inc +the POP host to query for mail to incorporate. See +.IR inc (1) +for more information. +.TP +MH With this environment variable, you can specify a profile other than -.I \&.mh\(ruprofile +.I \&.mh\-profile to be read by the .B nmh -programs -that you invoke. If the value of -.B $MH -is not absolute, (i.e., does -not begin with a \*(lq/\*(rq), it will be presumed to start from the current -working directory. This is one of the very few exceptions in +programs that you invoke. If the value of MH is not absolute, +(i.e., does not begin with a \*(lq/\*(rq), it will be presumed +to start from the current working directory. This is one of the +very few exceptions in .B nmh where non-absolute pathnames are not considered relative to the user's .B nmh directory. -.RE -.PP -.B $MHCONTEXT -.RS 5 -With this environment variable, you can specify a -context other than the normal context file (as specified in -the +.TP +MHBUILD +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. +.TP +MHCONTEXT +With this environment variable, you can specify a context other than the +normal context file (as specified in the .B nmh -profile). As always, unless the value of -.B $MHCONTEXT -is absolute, it will be presumed to start from your +profile). As usual, unless the value of MHCONTEXT is absolute, it will +be presumed to start from your .B nmh 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 +.TP +MHLDEBUG +If this variable is set to a non-null value, +.B mhl +will emit debugging information. +.TP +MHMTSCONF +If this variable is set to a non-null value, it specifies the +name of the mail transport configuration file to use by +.BR inc , +.BR post , +and other programs that interact with the mail transport system, +instead of the default. See +.IR mh-tailor (5). +.TP +MHMTSUSERCONF +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 +.IR mh-tailor (5). +.TP +MHN +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 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 +is deprecated, so support for this variable will be removed from a +future nmh release. +.TP +MHSHOW +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 +.TP +MHSTORE +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 $MAILDROP -.RS 5 -This variable tells -.B inc -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 +.TP +MHTMPDIR, TMPDIR +These variables are searched, in order, for the directory in which to +create some temporary files. +MHTMPDIR is deprecated and will be removed in a future release of nmh. +.TP +MHWDEBUG +If this variable is set to a non-null value, +.B nmh +commands that use the +.B Alternate\-Mailboxes +profile entry will display debugging information about the values in +that entry. +.TP +PAGER +If set to a non-null value, this supersedes the value of the default +built-in pager command. +.TP +SIGNATURE 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 +.TP +USER This variable tells .B repl your user name and .B inc -your default maildrop: see the \*(lqMailDrop\*(rq profile entry. -.RE -.PP -.B $HOME -.RS 5 -This variable tells all -.B nmh -programs your home directory -.RE -.PP -.B $TERM -.RS 5 -This variable tells -.B nmh -your terminal type. -.PP -The environment variable -.B $TERMCAP -is also consulted. In particular, -these tell -.B scan -and -.B mhl -how to clear your terminal, and how -many columns wide your terminal is. They also tell -.B mhl -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 -.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. -.B $MHPDEBUG -is deprecated, so support for this variable will -be removed from a future nmh release. Instead, -.B pick -now supports a -.B \-debug -switch. -.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 $PAGER -.RS 5 -If set to a non-null value, this supersedes the value of -the default built-in pager command. -.RE -.PP -.B $editalt -.RS 5 -This is the alternate message. -.PP -This is set by +your default mail drop: see the \*(lqMailDrop\*(rq profile entry. +.TP +USERNAME_EXTENSION +This variable is for use with username_extension masquerading. See +.IR mh-tailor (5). +.TP +editalt +This is the alternate message. This is set by .B dist and .B repl -during edit sessions so you can -peruse the message being distributed or replied to. The message is also -available, when the +during edit sessions so you can peruse the message being distributed or +replied to. The message is also available, when the .B \-atfile -switch is used, -through a link called \*(lq@\*(rq in the current directory if -your current working directory and the folder the message lives in are -on the same UNIX filesystem, and if your current working directory is +switch is used, through a link called \*(lq@\*(rq in the current directory +if your current working directory and the folder the message lives in are +on the same Unix filesystem, and if your current working directory is writable. -.RE -.PP -.B $mhdraft -.RS 5 -This is the path to the working draft. -.PP -This is set by -.BR comp , -.BR dist , -.BR forw , -and -.B repl -to tell the -.I whatnowproc -which file to ask \*(lqWhat now?\*(rq -questions about. -.RE -.PP -.B $mhaltmsg -.RS 5 +.TP +mhaltmsg .B dist and .B repl -set -.B $mhaltmsg -to tell the +set mhaltmsg to tell the .I whatnowproc 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 +.TP +mhannotate This is set by -.B dist +.BR dist , +.BR forw , 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 +if annotations are to occur. +.TP +mhdist .B dist -sets -.B $mhdist -to tell the +sets mhdist to tell the .I whatnowproc that message re-distribution is occurring. -.RE -.PP -.B $mheditor -.RS 5 +.TP +mhdraft +This is the path to the working draft. It is set by +.BR comp , +.BR dist , +.BR forw , +and +.B repl +to tell the +.I whatnowproc +which file to ask \*(lqWhat now?\*(rq questions about. +.TP +mheditor This is set by .BR comp , .BR repl , @@ -992,116 +976,87 @@ and .B dist to tell the .I whatnowproc -the user's choice of -editor (unless overridden by +the user's choice of editor (unless overridden by .BR \-noedit ). -.RE -.PP -.B $mhuse -.RS 5 -This may be set by -.BR comp . -.RE -.PP -.B $mhmessages -.RS 5 -This is set by -.BR dist , -.BR forw , +.TP +mhfolder +This is the folder containing the alternate message. +It is set by +.B dist and .B repl -if annotations are to occur. -.RE -.PP -.B $mhannotate -.RS 5 +during edit sessions so you can peruse other messages in the current +folder besides the one being distributed or replied to. +The environment variable mhfolder is also set by +.BR next , +.BR prev , +and +.B show +for use by +.BR mhl . +.TP +mhinplace This is set by .BR dist , .BR forw , and .B repl if annotations are to occur. -.RE -.PP -.B $mhinplace -.RS 5 +.TP +mhmessages This is set by .BR dist , .BR forw , and .B repl if annotations are to occur. -.RE +.TP +mhuse +This may be set by +.BR comp . .SH FILES -.fc ^ ~ -.nf -.ta \w'%nmhetcdir%/ExtraBigFileName 'u -^$HOME/\&.mh\(ruprofile~^The user profile -^or $MH~^Rather than the standard profile -^/context~^The user context -^or $MHCONTEXT~^Rather than the standard context -^/\&.mh\(rusequences~^Public sequences for -.fi +.PD 0 +.TP 20 +$HOME/.mh\-profile +The user's profile. +.TP +/context +The user's context +.TP +/.mh\-sequences +Public sequences for . +.PD .SH "SEE ALSO" -.IR environ (5), +.IR mhbuild (1), +.IR mhshow (1), +.IR mhstore (1), .IR mh-sequence (5), .IR nmh (7) -.SH HISTORY -The -.I \&.mh\(ruprofile -contains only static information, which -.B nmh -programs will -.B NOT -update. Changes in context are made to the -.I context -file kept in the users -.B nmh -directory. -This includes, but is not limited to: the \*(lqCurrent\-Folder\*(rq entry -and all private sequence information. Public sequence information is -kept in each folder in the file determined by the \*(lqmh\-sequences\*(rq -profile entry (default is -.IR \&.mh\(rusequences ). -.PP -The -.I \&.mh\(ruprofile -may override the path of the -.I context -file, by specifying a \*(lqcontext\*(rq entry (this must be in -lower-case). If the entry is not absolute (does not start with a -\*(lq/\*(rq), then it is interpreted relative to the user's -.B nmh -directory. As a result, you can actually have more than one set of -private sequences by using different context files. .SH BUGS There is some question as to what kind of arguments should be placed in the profile as options. In order to provide a clear answer, recall -command line semantics of all +the command line semantics of all .B nmh programs: conflicting switches (e.g. .B \-header and .BR \-noheader ) -may occur more than one time on the -command line, with the last switch taking effect. Other arguments, such -as message sequences, filenames and folders, are always remembered on -the invocation line and are not superseded by following arguments of -the same type. Hence, it is safe to place only switches (and their -arguments) in the profile. +may occur more than one time on the command line, with the last switch +taking effect. Other arguments, such as message sequences, filenames +and folders, are always remembered on the invocation line and are not +superseded by following arguments of the same type. +Hence, it is safe to place only switches (and their arguments) in the profile. .PP If one finds that an .B nmh -program is being invoked again and again -with the same arguments, and those arguments aren't switches, then there -are a few possible solutions to this problem. The first is to create a -(soft) link in your +program is being invoked again and again with the same arguments, and those +arguments aren't switches, then there are a few possible solutions to this +problem. The first is to create a (soft) link in your .I $HOME/bin directory to the .B nmh -program -of your choice. By giving this link a different name, you can create +program of your choice. By giving this link a different name, you can create a new entry in your profile and use an alternate set of defaults for the .B nmh