1 .TH MH-PROFILE %manext5% "October 15, 2012" "%nmhversion%"
6 mh-profile \- user profile customization for nmh message handler
8 .I $HOME/.mh\(ruprofile
12 is expected to have a file named
14 in his or her home directory. This file contains
15 a set of user parameters used by some or all of the
17 family of programs. Each entry in the file is of the format
20 .IR profile\-component ": " value
23 If the text of profile entry is long, you may extend it across several
24 real lines by indenting the continuation lines with leading spaces or tabs.
25 Comments may be introduced by a line starting with `#:':
32 Blank lines are not permitted in
34 .SS "Standard Profile Entries"
35 The possible profile components are exemplified below. The only mandatory
36 entry is `Path:'. The others are optional; some have default values if
37 they are not present. In the notation used below, (profile, default)
38 indicates whether the information is kept in the user's
42 context, and indicates what the default value is. Note that a profile
43 component can only appear once. Multiple appearances with trigger a
44 warning that all appearances after the first are ignored.
51 transactions in directory \*(lqMail\*(rq. This is the
52 only mandatory profile entry. (profile, no default)
58 Declares the location of the
60 context file. This is overridden by the environment variable
65 (profile, default: <nmh\-dir>/context)
71 Keeps track of the current open folder.
72 (context, default: folder specified by \*(lqInbox\*(rq)
78 Defines the name of your default inbox.
79 (profile, default: inbox)
82 .BR Previous\-Sequence :
85 Names the sequence or sequences which should be defined as the `msgs' or
86 `msg' argument given to any
88 command. If not present or empty,
89 no such sequences are defined. Otherwise, for each name given, the
90 sequence is first zero'd and then each message is added to the sequence.
93 man page for the details about this sequence. (profile, no default)
96 .BR Sequence\-Negation :
99 Defines the string which, when prefixed to a sequence name, negates
100 that sequence. Hence, \*(lqnotseen\*(rq means all those messages that
101 are not a member of the sequence \*(lqseen\*(rq. Read the
103 man page for the details. (profile, no default)
106 .BR Unseen\-Sequence :
109 Names the sequence or sequences which should be defined as those
110 messages which are unread. The commands
116 will add or remove messages from these
117 sequences when they are incorporated or read. If not present or
118 empty, no such sequences are defined. Otherwise, each message is
119 added to, or removed from, each sequence name given. Read the
121 man page for the details about this sequence.
122 (profile, no default)
128 The name of the file in each folder which defines public sequences.
129 To disable the use of public sequences, leave the value portion of this
130 entry blank. (profile, default: \&.mh\(rusequences)
133 .BI atr\- seq \- folder :
136 Keeps track of the private sequence called \*(lqseq\*(rq in the specified
137 folder. Private sequences are generally used for read\-only folders.
140 man page for details about private sequences.
141 (context, no default)
147 Defines the editor to be used by the commands
153 (profile, default: %default_editor%)
158 If defined and set to 1, then the
160 program will automatically
161 invoke the buildmimeproc (discussed below) to process each message as a MIME
162 composition draft before it is sent.
163 (profile, no default)
169 An octal number which defines the permission bits for new message files.
172 for an explanation of the octal number. Note that some filesystems,
173 such as FAT32, do not support removal of read file permissions.
174 (profile, default: 0600)
177 .BR Folder\-Protect :
180 An octal number which defines the permission bits for new folder
183 for an explanation of the octal number.
184 (profile, default: 700)
190 Sets default switches to be used whenever the mh program
192 is invoked. For example, one could override the \*(lqEditor:\*(rq profile
193 component when replying to messages by adding a component such as:
196 repl: \-editor /bin/ed
199 (profile, no defaults)
202 .IB lasteditor "-next:"
205 Names \*(lqnexteditor\*(rq to be the default editor after using
206 \*(lqlasteditor\*(rq. This takes effect at \*(lqWhat now?\*(rq prompt
214 the draft with \*(lqlasteditor\*(rq, the default editor is set to be
215 \*(lqnexteditor\*(rq. If the user types \*(lqedit\*(rq without any
216 arguments to \*(lqWhat now?\*(rq, then \*(lqnexteditor\*(rq is used.
217 (profile, no default)
223 The contents of the folder-stack for the
226 (context, no default)
230 Your Username <user@some.host>
232 Tells the various MH tools what your local mailbox is. If set, will be used
233 by the default component files by tools like
237 to construct your default \*(lqFrom\*(rq header. The text used here will
238 be copied exactly to your From: header, so it should already be RFC-822
239 compliant. If this is set, the
241 profile entry is NOT used, so it should include a signature as well. (profile,
242 default: userid@local.hostname)
245 .BR Alternate\-Mailboxes :
246 mh@uci\-750a, bug-mh*
252 which addresses are really yours.
255 knows which addresses should be included in the
258 knows if the message really originated from you.
259 Addresses must be separated by a comma, and the hostnames listed should
260 be the \*(lqofficial\*(rq hostnames for the mailboxes you indicate, as
261 local nicknames for hosts are not replaced with their official site names.
262 For each address, if a host is not given, then that address on any host is
263 considered to be you. In addition, an asterisk (`*') may appear at either
264 or both ends of the mailbox and host to indicate wild-card matching.
265 (profile, default: your user-id)
272 Indicates aliases files for
277 This may be used instead of the
280 switch. (profile, no default)
286 Indicates a default draft folder for
295 man page for details. (profile, no default)
298 .BI digest\-issue\- list :
303 the last issue of the last volume sent for the digest
305 (context, no default)
308 .BI digest\-volume\- list :
313 the last volume sent for the digest
315 (context, no default)
323 your maildrop, if different from the default. This is
324 superseded by the environment variable
326 (profile, default: %mailspool%/$USER)
330 RAND MH System (agent: Marshall Rose)
332 Tells front-end programs such as
337 your mail signature. This is superseded by the
342 is not set and this profile entry is not present, the \*(lqgcos\*(rq field of
343 the \fI/etc/passwd\fP file will be used.
344 Your signature will be added to the address
346 puts in the \*(lqFrom:\*(rq header; do not include an address in the
347 signature text. The \*(lqLocal\-Mailbox\*(rq profile component
348 supersedes all of this. (profile, no default)
350 .SS "Process Profile Entries"
351 The following profile elements are used whenever an
353 program invokes some other program such as
357 can be used to select alternate programs if the
358 user wishes. The default values are given in the examples.
364 This is the program used by
366 to process drafts which are MIME composition files.
372 This program is used to refile or link a message to another folder.
375 to file a copy of a message into a folder given
376 by a \*(lqFcc:\*(rq field. It is used by the draft folder facility in
383 message into another folder. It is used to refile a draft message in
386 directive at the \*(lqWhat now?\*(rq prompt.
393 to filter a component when it is tagged with the \*(lqformat\*(rq variable
394 in the mhl filter. See
396 for more information.
404 to incorporate new mail when it
405 is invoked with no arguments.
411 This program is called to initialize the environment for
419 This program is used to list the contents of a message in response
422 directive at the \*(lqWhat now?\*(rq prompt. It is
423 also used by the draft folder facility in
429 to display the draft message.
432 supersedes the default built-in pager command.)
438 This is the program used to automatically mail various messages
439 and notifications. It is used by
443 option. It is used by
445 to post failure notices.
446 It is used to retrieve an external-body with access-type `mail-server'
447 (such as when storing the body with
454 This is the program used to filter messages in various ways. It
457 to filter and display the message headers
458 of MIME messages. When the
469 is used to filter the
470 message that you are forwarding, or to which you are replying.
477 is used to filter the copy of the message
478 that is sent to \*(lqBcc:\*(rq recipients.
484 This is the program used by
488 formatted message when displaying to a terminal. It is also the default
491 to display message bodies (or message parts) of type text/plain.
494 supersedes the default built-in pager command.)
512 This is the program used by
521 post a message to the mail transport system. It is also called by
523 (called with the switches
527 to do address verification.
533 This is the program used by
537 to delete a message from a folder.
543 This is the program to use by
545 to actually send the message
551 This is the program used by
553 to process and display non-text (MIME) messages.
559 This is the program used by
561 to filter and display text (non-MIME) messages.
567 This is the program invoked by
573 to query about the disposition of a composed draft message.
579 This is the program used by
581 to determine to whom a message would be sent.
583 .SS "Environment Variables"
586 and its commands it also controlled by the
587 presence of certain environment variables.
589 Many of these environment variables are used internally by the
590 \*(lqWhat now?\*(rq interface. It's amazing all the information
591 that has to get passed via environment variables to make the
592 \*(lqWhat now?\*(rq interface look squeaky clean to the
594 user, isn't it? The reason for all this is that the
602 one of the standard shells. As a result, it's not possible to pass
603 information via an argument list. The convention is that environment
604 variables whose names are all upper-case are user-settable; those
605 whose names are lower-case only are used internally by nmh and should
606 not generally be set by the user.
610 With this environment variable, you can specify a profile
616 that you invoke. If the value of
618 is not absolute, (i.e., does
619 not begin with a \*(lq/\*(rq), it will be presumed to start from the current
620 working directory. This is one of the very few exceptions in
622 where non-absolute pathnames are not considered relative to the user's
629 With this environment variable, you can specify a
630 context other than the normal context file (as specified in
633 profile). As always, unless the value of
635 is absolute, it will be presumed to start from your
642 With this environment variable, you can specify an
643 additional user profile (file) to be read by
645 in addition to the mhn.defaults profile.
650 With this environment variable, you can specify an
651 additional user profile (file) to be read by
653 in addition to the mhn.defaults profile.
655 is deprecated, so this support for this variable will
656 be removed from a future nmh release.
661 With this environment variable, you can specify an
662 additional user profile (file) to be read by
664 in addition to the mhn.defaults profile.
669 With this environment variable, you can specify an
670 additional user profile (file) to be read by
672 in addition to the mhn.defaults profile.
677 With this environment variable, you can specify
678 the native character set you are using. You must be able to display
679 this character set on your terminal.
681 This variable is checked to see if a RFC-2047 header field should be
694 be called, since showmimeproc will be called if a text message uses
695 a character set that doesn't match
700 for matches against the charset parameter
701 of text contents to decide it the text content can be displayed
702 without modifications to your terminal. This variable is checked by
704 to decide what character set to specify in the charset
705 parameter of text contents containing 8\-bit characters.
707 When decoding text in such an alternate character set,
709 must be able to determine which characters are alphabetic, which
710 are control characters, etc. For many operating systems, this
711 will require enabling the support for locales (such as setting
712 the environment variable
721 the default maildrop. This supersedes the \*(lqMailDrop\*(rq profile entry.
728 the POP host to query for mail to incorporate. See the
729 inc(1) man page for more information.
732 .B $USERNAME_EXTENSION
734 This variable is for use with username_extension masquerading. See the
735 mh-tailor(5) man page.
744 your mail signature. This supersedes the \*(lqSignature\*(rq profile entry,
745 and is not used when the \*(lqLocal\-Mailbox\*(rq profile component is set.
754 your default maildrop: see the \*(lqMailDrop\*(rq profile entry.
759 This variable tells all
761 programs your home directory
770 The environment variable
772 is also consulted. In particular,
777 how to clear your terminal, and how
778 many columns wide your terminal is. They also tell
781 lines long your terminal screen is.
786 If this variable is set to a non-null value, it specifies the
787 name of the mail transport configuration file to use by
790 and other programs that interact with the mail transport system,
791 instead of the default. See mh-tailor(5).
796 If this variable is set to a non-null value, it specifies the name of
797 a mail transport configuration file to be read in addition to the
798 default. See mh-tailor(5).
805 These variables are searched, in order, for the directory in which to
806 create some temporary files.
811 If this variable is set to a non-null value,
813 will emit debugging information.
818 If this variable is set to a non-null value,
820 will emit a representation of the search pattern.
825 If this variable is set to a non-null value,
827 commands that use the
828 .BR Alternate\-Mailboxes
829 profile entry will display debugging information
830 about the values in that entry.
835 If set to a non-null value, this supersedes the value of
836 the default built-in pager command.
841 This is the alternate message.
847 during edit sessions so you can
848 peruse the message being distributed or replied to. The message is also
849 available through a link called \*(lq@\*(rq in the current directory if
850 your current working directory and the folder the message lives in are
851 on the same UNIX filesystem.
856 This is the path to the working draft.
866 which file to ask \*(lqWhat now?\*(rq
879 about an alternate message associated with the
880 draft (the message being distributed or replied to).
885 This is the folder containing the alternate message.
891 during edit sessions so you
892 can peruse other messages in the current folder besides the one being
893 distributed or replied to. The environment variable
911 that message re-distribution is occurring.
925 editor (unless overridden by
942 if annotations are to occur.
952 if annotations are to occur.
962 if annotations are to occur.
967 .ta \w'%etcdir%/ExtraBigFileName 'u
968 ^$HOME/\&.mh\(ruprofile~^The user profile
969 ^or $MH~^Rather than the standard profile
970 ^<mh\-dir>/context~^The user context
971 ^or $MHCONTEXT~^Rather than the standard context
972 ^<folder>/\&.mh\(rusequences~^Public sequences for <folder>
981 contains only static information, which
985 update. Changes in context are made to the
987 file kept in the users
990 This includes, but is not limited to: the \*(lqCurrent\-Folder\*(rq entry
991 and all private sequence information. Public sequence information is
992 kept in each folder in the file determined by the \*(lqmh\-sequences\*(rq
993 profile entry (default is
994 .IR \&.mh\(rusequences ).
998 may override the path of the
1000 file, by specifying a \*(lqcontext\*(rq entry (this must be in
1001 lower-case). If the entry is not absolute (does not start with a
1002 \*(lq/\*(rq), then it is interpreted relative to the user's
1004 directory. As a result, you can actually have more than one set of
1005 private sequences by using different context files.
1007 The shell quoting conventions are not available in the
1008 .IR \&.mh\(ruprofile .
1009 Each token is separated by whitespace.
1011 There is some question as to what kind of arguments should be placed
1012 in the profile as options. In order to provide a clear answer, recall
1013 command line semantics of all
1015 programs: conflicting switches
1020 may occur more than one time on the
1021 command line, with the last switch taking effect. Other arguments, such
1022 as message sequences, filenames and folders, are always remembered on
1023 the invocation line and are not superseded by following arguments of
1024 the same type. Hence, it is safe to place only switches (and their
1025 arguments) in the profile.
1027 If one finds that an
1029 program is being invoked again and again
1030 with the same arguments, and those arguments aren't switches, then there
1031 are a few possible solutions to this problem. The first is to create a
1037 of your choice. By giving this link a different name, you can create
1038 a new entry in your profile and use an alternate set of defaults for
1041 command. Similarly, you could create a small shell script
1044 program of your choice with an alternate set
1045 of invocation line switches (using links and an alternate profile entry
1046 is preferable to this solution).
1050 user could create an alias for the command of the form:
1053 alias cmd 'cmd arg1 arg2 ...'
1056 In this way, the user can avoid lengthy type-in to the shell, and still
1059 commands safely. (Recall that some
1062 invoke others, and that in all cases, the profile is read, meaning that
1063 aliases are disregarded beyond an initial command invocation)
projects / mmh / blob