X-Git-Url: http://git.marmaro.de/?p=mmh;a=blobdiff_plain;f=man%2Fmh-profile.man;h=43c3f2ed039f8110c17cef6eb8213e4291f19dcf;hp=48e4b6b39bc31957ad389e9fc79a738cf86ece54;hb=363190329760d38060e89956206583831b0d084d;hpb=849bead2b2f3f202280353636716ec7e83fc5645 diff --git a/man/mh-profile.man b/man/mh-profile.man index 48e4b6b..43c3f2e 100644 --- a/man/mh-profile.man +++ b/man/mh-profile.man @@ -3,21 +3,23 @@ .\" .TH MH-PROFILE %manext5% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME -mh-profile \- user profile customization for nmh message handler +mh-profile \- user profile customization for mmh message handler .SH SYNOPSIS -.I $HOME/.mh\(ruprofile +.I $HOME/.mmh/profile +.br +.I $HOME/.mmh/context .SH DESCRIPTION Each user of -.B nmh +.B mmh is expected to have a file named -.I \&.mh\(ruprofile +.I $HOME/.mmh/profile in his or her home directory. This file contains a set of user parameters used by some or all of the -.B nmh +.B mmh 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 @@ -28,31 +30,29 @@ The possible profile components are exemplified below. The only mandatory entry is `Path:'. The others are optional; some have default values if they are not present. In the notation used below, (profile, default) indicates whether the information is kept in the user's -.B nmh +.B mmh profile or -.B nmh +.B mmh context, and indicates what the default value is. .PP .BR Path : Mail .RS 5 -Locates -.B nmh -transactions in directory \*(lqMail\*(rq. This is the +Sets the user's mail storage to \*(lqMail\*(rq. This is the only mandatory profile entry. (profile, no default) .RE .PP -.BR context : +.BR Context : context .RS 5 Declares the location of the -.B nmh +.B mmh context file. This is overridden by the environment variable -.BR $MHCONTEXT . +.BR $MMHC . See the .B HISTORY section below. -(profile, default: /context) +(profile, default: $HOME/.mmh/context) .RE .PP .BR Current\-Folder : @@ -74,7 +74,7 @@ Defines the name of your default inbox. .RS 5 Names the sequence or sequences which should be defined as the `msgs' or `msg' argument given to any -.B nmh +.B mmh 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. @@ -112,12 +112,12 @@ man page for the details about this sequence. (profile, no default) .RE .PP -.BR mh\-sequences : -\&.mh\(rusequences +.BR Mh\-Sequences : +\&.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 : @@ -158,7 +158,7 @@ to send mail. , .RS 5 The prefix that is prepended to the name of message files when they -are "removed" by rmm. This should typically be `,' or `#'. +are ``removed'' by rmm. This should typically be `,' or `#'. (profile, default: `,') .RE .PP @@ -203,7 +203,7 @@ for an explanation of the octal number. .IR program : .I default switches .RS 5 -Sets default switches to be used whenever the mh program +Sets default switches to be used whenever the mmh program .I program is invoked. For example, one could override the \*(lqEditor:\*(rq profile component when replying to messages by adding a component such as: @@ -253,7 +253,7 @@ auditfile in addition to its other tasks. is Brian Reid's .B emacs front-end for -.BR nmh . +.BR mmh . (profile, no default) .RE .PP @@ -297,15 +297,9 @@ switch. (profile, no default) .BR Draft\-Folder : drafts .RS 5 -Indicates a default draft folder for -.BR comp , -.BR dist , -.BR forw , -and -.BR repl . -Read the +Changes the default draft folder. Read the .BR mh\-draft (5) -man page for details. (profile, no default) +man page for details. (profile, default: +drafts) .RE .PP .BI digest\-issue\- list : @@ -365,9 +359,7 @@ The following profile elements are used whenever an .B nmh program invokes some other program such as .BR more . -The -.I \&.mh\(ruprofile -can be used to select alternate programs if the +The profile can be used to select alternate programs if the user wishes. The default values are given in the examples. .RE .PP @@ -409,11 +401,11 @@ is invoked with no arguments. .RE .PP .BR installproc : -%libdir%/install\-mh +mmh .RS 5 This program is called to initialize the environment for new users of -.BR nmh . +.BR mmh . .RE .PP .BR lproc : @@ -570,7 +562,7 @@ to query about the disposition of a composed draft message. .SS "Environment Variables" The operation of -.B nmh +.B mmh and its commands it also controlled by the presence of certain environment variables. .PP @@ -578,9 +570,9 @@ Many of these environment variables are used internally by the \*(lqWhat now?\*(rq interface. It's amazing all the information that has to get passed via environment variables to make the \*(lqWhat now?\*(rq interface look squeaky clean to the -.B nmh +.B mmh user, isn't it? The reason for all this is that the -.B nmh +.B mmh user can select .B any @@ -590,13 +582,13 @@ 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 +whose names are lower-case only are used internally by mmh and should not generally be set by the user. .PP If the .B WHATNOW option was set during -.B nmh +.B mmh configuration, and if this environment variable is set, then if the commands .BR refile\ , @@ -610,36 +602,38 @@ This is useful for getting the default behavior supplied by the default .IR whatnowproc . .PP -.B $MH +.B $MMH +.RS 5 +With this environment variable, you can specify an alternative +mmh directory. Personal mmh configuration files are located relative to +the mmh directory. +Non-absolute values are relative to the home directory. +This is one of the very few exceptions in +.B mmh +where non-absolute pathnames are not considered relative to the user's +mmh directory. +.RE +.PP +.B $MMHP .RS 5 With this environment variable, you can specify a profile other than -.I \&.mh\(ruprofile +.I $HOME/.mmh/profile to be read by the -.B nmh +.B mmh 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 -.B nmh -where non-absolute pathnames are not considered relative to the user's -.B nmh -directory. +.B $MMHP +is not absolute, it will be presumed to start from the mmh directory. .RE .PP -.B $MHCONTEXT +.B $MMHC .RS 5 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 -.B nmh -directory. +the profile). As always, unless the value of +.B $MMHC +is absolute, it will be presumed to start from your mmh directory. .RE .PP .B $MM_CHARSET @@ -675,7 +669,7 @@ to decide what character set to specify in the charset parameter of text contents containing 8\-bit characters. .PP When decoding text in such an alternate character set, -.B nmh +.B mmh must be able to determine which characters are alphabetic, which are control characters, etc. For many operating systems, this will require enabling the support for locales (such as setting @@ -703,7 +697,7 @@ your mail signature. This supersedes the \*(lqSignature\*(rq profile entry. .B $HOME .RS 5 This variable tells all -.B nmh +.B mmh programs your home directory .RE .PP @@ -717,7 +711,7 @@ the default shell to run .B $TERM .RS 5 This variable tells -.B nmh +.B mmh your terminal type. .PP The environment variable @@ -875,11 +869,13 @@ for use by .fc ^ ~ .nf .ta \w'%etcdir%/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 +^$HOME/.mmh~^The user's mmh directory +^or $MMH~^Rather than the standard mmh directory +^$HOME/.mmh/profile~^The user's profile +^or $MMHP~^Rather than the standard profile +^$HOME/.mmh/context~^The user's context +^or $MMHC~^Rather than the standard context +^/.mh_sequences~^Public sequences for .fi .SH "SEE ALSO" @@ -887,42 +883,34 @@ nmh(1), environ(5), mh-sequence(5) .SH HISTORY The -.I \&.mh\(ruprofile +.I $HOME/.mmh/profile contains only static information, which -.B nmh +.B mmh programs will .B NOT update. Changes in context are made to the -.I context -file kept in the users -.B nmh -directory. +.I $HOME/.mmh/context +file. 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 +kept in each folder in the file determined by the \*(lqMh\-Sequences\*(rq profile entry (default is -.IR \&.mh\(rusequences ). +.IR \&.mh_sequences ). .PP -The -.I \&.mh\(ruprofile -may override the path of the +The 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 +file, by specifying a \*(lqContext\*(rq entry. +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 . +The shell quoting conventions are not available in the profile. 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 -.B nmh +.B mmh programs: conflicting switches (e.g. .B \-header @@ -936,22 +924,22 @@ 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 +.B mmh 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 +.B mmh 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 +.B mmh command. Similarly, you could create a small shell script which called the -.B nmh +.B mmh program of your choice with an alternate set of invocation line switches (using links and an alternate profile entry is preferable to this solution). @@ -966,9 +954,9 @@ alias cmd 'cmd arg1 arg2 ...' .PP In this way, the user can avoid lengthy type-in to the shell, and still give -.B nmh +.B mmh commands safely. (Recall that some -.B nmh +.B mmh commands invoke others, and that in all cases, the profile is read, meaning that aliases are disregarded beyond an initial command invocation)