X-Git-Url: http://git.marmaro.de/?a=blobdiff_plain;f=man%2Fmh-profile.man;h=a586eefb8d08f8301ef1fd58692d327ec04eab96;hb=5e5e8b753acc7ff1e16c7fca172a2151a6c01353;hp=40b56c778f3db0e22c43b7eae8af7fad496f8cc4;hpb=220dcd2dda3136cefd20951e34e963f37f8e2132;p=mmh diff --git a/man/mh-profile.man b/man/mh-profile.man index 40b56c7..a586eef 100644 --- a/man/mh-profile.man +++ b/man/mh-profile.man @@ -1,7 +1,7 @@ +.TH MH-PROFILE %manext5% "November 6, 2012" "%nmhversion%" .\" .\" %nmhwarning% .\" -.TH MH-PROFILE %manext5% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME mh-profile \- user profile customization for nmh message handler .SH SYNOPSIS @@ -22,7 +22,18 @@ 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. +The shell quoting conventions are not available in the +.IR \&.mh\(ruprofile ; +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 @@ -31,7 +42,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 @@ -79,7 +92,7 @@ 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 -.BR mh\-sequence (5) +.IR mh\-sequence (5) man page for the details about this sequence. (profile, no default) .RE .PP @@ -89,7 +102,7 @@ not 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 -.BR mh\-sequence (5) +.IR mh\-sequence (5) man page for the details. (profile, no default) .RE .PP @@ -107,7 +120,7 @@ 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 -.BR mh\-sequence (5) +.IR mh\-sequence (5) man page for the details about this sequence. (profile, no default) .RE @@ -126,7 +139,7 @@ entry blank. (profile, default: \&.mh\(rusequences) Keeps track of the private sequence called \*(lqseq\*(rq in the specified folder. Private sequences are generally used for read\-only folders. See the -.BR mh\-sequence (5) +.IR mh\-sequence (5) man page for details about private sequences. (context, no default) .RE @@ -154,21 +167,22 @@ 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) +.IR chmod (1) +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 -.BR chmod (1) +.IR chmod (1) for an explanation of the octal number. (profile, default: 700) .RE @@ -206,14 +220,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,19 +229,20 @@ command. (context, no default) .RE .PP -.BR mhe : +.BR Local\-Mailbox : +Your Username .RS 5 -If present, tells -.B inc -to compose an -.I MHE -auditfile in addition to its other tasks. -.I MHE -is Brian Reid's -.B emacs -front-end for -.BR nmh . -(profile, no default) +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 : @@ -283,10 +290,11 @@ Indicates a default draft folder for .BR comp , .BR dist , .BR forw , +.BR refile , and .BR repl . Read the -.BR mh\-draft (5) +.IR mh\-draft (5) man page for details. (profile, no default) .RE .PP @@ -324,24 +332,24 @@ 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" The following profile elements are used whenever an .B nmh @@ -381,6 +389,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 +.IR mhl (5) +for more information. +.RE +.PP .BR incproc : %bindir%/inc .RS 5 @@ -412,6 +430,9 @@ also used by the draft folder facility in and .B repl to display the draft message. +(Note that +.B $PAGER +supersedes the default built-in pager command.) .RE .PP .BR mailproc : @@ -471,6 +492,9 @@ formatted message when displaying to a terminal. It is also the default program used by .B mhshow to display message bodies (or message parts) of type text/plain. +(Note that +.B $PAGER +supersedes the default built-in pager command.) .RE .PP .BR mshproc : @@ -516,12 +540,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 @@ -565,7 +583,6 @@ This is the program used by .B whatnow to determine to whom a message would be sent. .RE - .SS "Environment Variables" The operation of .B nmh @@ -591,24 +608,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 @@ -641,6 +640,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 @@ -690,13 +724,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 @@ -706,13 +764,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 @@ -733,6 +784,61 @@ 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 $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. @@ -764,16 +870,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 @@ -787,6 +883,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 @@ -847,28 +964,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 ^ ~ .nf @@ -879,10 +974,10 @@ for use by ^or $MHCONTEXT~^Rather than the standard context ^/\&.mh\(rusequences~^Public sequences for .fi - .SH "SEE ALSO" -nmh(1), environ(5), mh-sequence(5) - +.IR environ (5), +.IR mh-sequence (5), +.IR nmh (7) .SH HISTORY The .I \&.mh\(ruprofile @@ -911,12 +1006,7 @@ lower-case). If the entry is not absolute (does not start with a .B nmh directory. As a result, you can actually have more than one set of private sequences by using different context files. - .SH BUGS -The shell quoting conventions are not available in the -.IR \&.mh\(ruprofile . -Each token is separated by whitespace. -.PP 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