From 2793dbafc546ab90800df3591cb63f4747e3374d Mon Sep 17 00:00:00 2001 From: David Levine Date: Tue, 14 Feb 2012 20:47:06 -0600 Subject: [PATCH] Updated documentation of environment variables in mh-profile man page. --- docs/pending-release-notes | 6 ++ man/mh-profile.man | 207 +++++++++++++++++++++++++++++++++++--------- 2 files changed, 174 insertions(+), 39 deletions(-) diff --git a/docs/pending-release-notes b/docs/pending-release-notes index 3ea4f76..2483b75 100644 --- a/docs/pending-release-notes +++ b/docs/pending-release-notes @@ -22,3 +22,9 @@ Things to add to the release notes for the next full release: See mhl(1), specifically the "format" keyword and "formatproc" in mh-profile(5). - The test suite has been integrated into the Makefile via "make check". +- The following environment variables are obsolete. Support for them + will be removed from the next nmh release: + MHPOPDEBUG (use -snoop command line switch instead) + MM_NOASK (use -nolist and -nopause command line switches instead) + NOMHNPROC (use -nocheckmime command line switch instead) + FACEPROC (undocumented faceproc feature to be removed) diff --git a/man/mh-profile.man b/man/mh-profile.man index f71c6f1..ac10b26 100644 --- a/man/mh-profile.man +++ b/man/mh-profile.man @@ -360,7 +360,7 @@ directive at the \*(lqWhat now?\*(rq prompt. Program called by .B mhl to filter a component when it is tagged with the \*(lqformat\*(rq variable -in the mhl filter. See +in the mhl filter. See .BR mhl (5) for more information. .RE @@ -625,6 +625,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 @@ -667,6 +702,18 @@ the environment variable to iso_8859_1). .RE .PP +.B $NOMHNPROC +.RS 5 +If this variable is set, +.B show +will next test for MIME messages. This mechanism is obsolete; +use the +.B \-nocheckmime +switch to +.B show +instead. +.RE +.PP .B $MAILDROP .RS 5 This variable tells @@ -674,6 +721,20 @@ 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 @@ -683,6 +744,15 @@ and your mail signature. This supersedes the \*(lqSignature\*(rq profile entry. .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 .RS 5 This variable tells all @@ -690,13 +760,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 @@ -717,6 +780,82 @@ 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 $MM_NOASK +.RS 5 +Setting this variable is set to 1 has the same effect as specifying +the +.B \-nolist +and +.B \-nopause +switches to +.BR mhbuild , +.BR mhn , +and +.BR mhshow . +OBSOLETE: will be removed in a future version of nmh. +.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 $MHPOPDEBUG +.RS 5 +If this variable is set to a non-null value, +.B msgchck +and +.B inc +will display their interaction with the POP server. +This mechanism is obsolete; use the +.B \-snoop +switch instead. +.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. @@ -748,16 +887,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 @@ -771,6 +900,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 @@ -831,27 +981,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 ^ ~ -- 1.7.10.4