1 .TH MH-PROFILE %manext5% "April 14, 2013" "%nmhversion%"
6 mh-profile \- user profile customization for nmh message handler
10 is expected to have a file named
12 in his or her home directory. This file contains
13 a set of user parameters used by some or all of the
15 family of programs. Each entry in the file is of the format
18 .IR profile\-component ": " value
21 If the text of profile entry is long, you may extend it across several
22 real lines by indenting the continuation lines with leading spaces or tabs.
23 Comments may be introduced by a line starting with `#:':
30 Blank lines are not permitted in
32 The shell quoting conventions are not available in the
33 .IR \&.mh\(ruprofile ;
34 each token is separated by whitespace.
35 .SS "Standard Profile Entries"
36 The possible profile components are exemplified below. The only mandatory
37 entry is `Path:'. The others are optional; some have default values if
38 they are not present. In the notation used below, (profile, default)
39 indicates whether the information is kept in the user's
43 context, and indicates what the default value is. Note that a profile
44 component can only appear once. Multiple appearances with trigger a
45 warning that all appearances after the first are ignored.
52 transactions in directory \*(lqMail\*(rq. This is the
53 only mandatory profile entry. (profile, no default)
59 Declares the location of the
61 context file. This is overridden by the environment variable
66 (profile, default: <nmh\-dir>/context)
72 Keeps track of the current open folder.
73 (context, default: folder specified by \*(lqInbox\*(rq)
79 Defines the name of your default inbox.
80 (profile, default: inbox)
83 .BR Previous\-Sequence :
86 Names the sequence or sequences which should be defined as the `msgs' or
87 `msg' argument given to any
89 command. If not present or empty,
90 no such sequences are defined. Otherwise, for each name given, the
91 sequence is first zero'd and then each message is added to the sequence.
94 man page for the details about this sequence. (profile, no default)
97 .BR Sequence\-Negation :
100 Defines the string which, when prefixed to a sequence name, negates
101 that sequence. Hence, \*(lqnotseen\*(rq means all those messages that
102 are not a member of the sequence \*(lqseen\*(rq. Read the
104 man page for the details. (profile, no default)
107 .BR Unseen\-Sequence :
110 Names the sequence or sequences which should be defined as those
111 messages which are unread. The commands
117 will add or remove messages from these
118 sequences when they are incorporated or read. If not present or
119 empty, no such sequences are defined. Otherwise, each message is
120 added to, or removed from, each sequence name given. Read the
122 man page for the details about this sequence.
123 (profile, no default)
129 The name of the file in each folder which defines public sequences.
130 To disable the use of public sequences, leave the value portion of this
131 entry blank. (profile, default: \&.mh\(rusequences)
134 .BI atr\- seq \- folder :
137 Keeps track of the private sequence called \*(lqseq\*(rq in the specified
138 folder. Private sequences are generally used for read\-only folders.
141 man page for details about private sequences.
142 (context, no default)
148 Defines the editor to be used by the commands
154 If not set in profile the value will be taken from the VISUAL and
155 EDITOR environment variables.
156 (profile, default: vi)
161 If defined and set to 1, then the
163 program will automatically
164 invoke the buildmimeproc (discussed below) to process each message as a MIME
165 composition draft before it is sent.
166 (profile, no default)
172 An octal number which defines the permission bits for new message files.
175 for an explanation of the octal number. Note that some filesystems,
176 such as FAT32, do not support removal of read file permissions.
177 (profile, default: 0600)
180 .BR Folder\-Protect :
183 An octal number which defines the permission bits for new folder
186 for an explanation of the octal number.
187 (profile, default: 700)
193 The locking algorithm used to lock changes to any
195 data files, such as sequences or the context. The locking algorithm is
196 any one of the following entries:
204 Available locking algorithms can vary depending on what is supported by
205 the operating system. Note: currently transactional locking is only
206 supported on public sequences; see
208 for more information.
209 (profile, default: fcntl)
215 Sets default switches to be used whenever the mh program
217 is invoked. For example, one could override the \*(lqEditor:\*(rq profile
218 component when replying to messages by adding a component such as:
221 repl: \-editor /bin/ed
224 (profile, no defaults)
227 .IB lasteditor "-next:"
230 Names \*(lqnexteditor\*(rq to be the default editor after using
231 \*(lqlasteditor\*(rq. This takes effect at \*(lqWhat now?\*(rq prompt
239 the draft with \*(lqlasteditor\*(rq, the default editor is set to be
240 \*(lqnexteditor\*(rq. If the user types \*(lqedit\*(rq without any
241 arguments to \*(lqWhat now?\*(rq, then \*(lqnexteditor\*(rq is used.
242 (profile, no default)
248 The contents of the folder-stack for the
251 (context, no default)
255 Your Username <user@some.host>
257 Tells the various MH tools what your local mailbox is. If set, will be used
258 by the default component files by tools like
262 to construct your default \*(lqFrom\*(rq header. The text used here will
263 be copied exactly to your From: header, so it should already be RFC 822
264 compliant. If this is set, the
266 profile entry is NOT used, so it should include a signature as well. (profile,
267 default: userid@local.hostname)
270 .BR Alternate\-Mailboxes :
271 mh@uci\-750a, bug-mh*
277 which addresses are really yours.
280 knows which addresses should be included in the
283 knows if the message really originated from you.
284 Addresses must be separated by a comma, and the hostnames listed should
285 be the \*(lqofficial\*(rq hostnames for the mailboxes you indicate, as
286 local nicknames for hosts are not replaced with their official site names.
287 For each address, if a host is not given, then that address on any host is
288 considered to be you. In addition, an asterisk (`*') may appear at either
289 or both ends of the mailbox and host to indicate wild-card matching.
290 (profile, default: your user-id)
297 Indicates aliases files for
302 This may be used instead of the
305 switch. (profile, no default)
311 Indicates a default draft folder for
320 man page for details. (profile, no default)
323 .BI digest\-issue\- list :
328 the last issue of the last volume sent for the digest
330 (context, no default)
333 .BI digest\-volume\- list :
338 the last volume sent for the digest
340 (context, no default)
348 your maildrop, if different from the default. This is
349 superseded by the environment variable
351 (profile, default: %mailspool%/$USER)
355 RAND MH System (agent: Marshall Rose)
357 Tells front-end programs such as
362 your mail signature. This is superseded by the
367 is not set and this profile entry is not present, the \*(lqgcos\*(rq field of
368 the \fI/etc/passwd\fP file will be used.
369 Your signature will be added to the address
371 puts in the \*(lqFrom:\*(rq header; do not include an address in the
372 signature text. The \*(lqLocal\-Mailbox\*(rq profile component
373 supersedes all of this. (profile, no default)
379 Indicates how the username and password credentials will be retrieved
380 for access to external servers, such as those that provide SMTP or POP
381 service. The supported entry values are \*(lqlegacy\*(rq and
382 .RI \*(lqfile: netrc \*(rq.
383 With \*(lqlegacy\*(rq, or if there is no credentials entry, the
384 username is the first of:
398 2) the login name on the local machine
401 The password for SMTP services is the first of:
404 1) password value from matching entry in file named \*(lq.netrc\*(rq
405 in the user's home directory
407 2) password obtained by interactively prompting the user
410 The password for POP service when the
412 switch is used with one of these programs is the login name on the
416 .RI \*(lqfile: netrc \*(rq
418 entry, the username is the first of:
425 2) login name from matching entry in
429 3) value provided by user in response to interactive query
432 Similarly, the password is provided either in the
434 file or interactively.
436 can be any valid filename, either absolute or relative to Path or
439 file contains authentication information, for each server,
440 using a line of the following form. Replace the words
445 with your own account information:
458 file must be owned and readable only by you.
459 (profile, default: legacy)
461 .SS "Process Profile Entries"
462 The following profile elements are used whenever an
464 program invokes some other program such as
468 can be used to select alternate programs if the
469 user wishes. The default values are given in the examples.
471 If the profile element contains spaces, the element is split at spaces
472 into tokens and each token is given as a seperate argument to the
474 system call. If the element contains shell metacharacters then the entire
475 element is executed using
482 This is the program used by
484 to process drafts which are MIME composition files.
490 This program is used to refile or link a message to another folder.
493 to file a copy of a message into a folder given
494 by a \*(lqFcc:\*(rq field. It is used by the draft folder facility in
501 message into another folder. It is used to refile a draft message in
504 directive at the \*(lqWhat now?\*(rq prompt.
511 to filter a component when it is tagged with the \*(lqformat\*(rq variable
512 in the mhl filter. See
514 for more information.
522 to incorporate new mail when it
523 is invoked with no arguments.
529 This program is used to list the contents of a message in response
532 directive at the \*(lqWhat now?\*(rq prompt. It is
533 also used by the draft folder facility in
539 to display the draft message.
542 supersedes the default built-in pager command.)
548 This is the program used to automatically mail various messages
549 and notifications. It is used by
553 option. It is used by
555 to post failure notices.
556 It is used to retrieve an external-body with access-type `mail-server'
557 (such as when storing the body with
564 This is the program used to filter messages in various ways. It
567 to filter and display the message headers
568 of MIME messages. When the
579 is used to filter the
580 message that you are forwarding, or to which you are replying.
587 is used to filter the copy of the message
588 that is sent to \*(lqBcc:\*(rq recipients.
594 This is the program used by
598 formatted message when displaying to a terminal. It is also the default
601 to display message bodies (or message parts) of type text/plain.
604 supersedes the default built-in pager command.)
622 This is the program used by
631 post a message to the mail transport system. It is also called by
633 (called with the switches
637 to do address verification.
643 This is the program used by
648 to delete a message from a folder.
654 This is the program to use by
656 to actually send the message
662 This is the program used by
664 to process and display non-text (MIME) messages.
670 This is the program used by
672 to filter and display text (non-MIME) messages.
678 This is the program invoked by
684 to query about the disposition of a composed draft message.
690 This is the program used by
692 to determine to whom a message would be sent.
694 .SS "Environment Variables"
697 and its commands it also controlled by the
698 presence of certain environment variables.
700 Many of these environment variables are used internally by the
701 \*(lqWhat now?\*(rq interface. It's amazing all the information
702 that has to get passed via environment variables to make the
703 \*(lqWhat now?\*(rq interface look squeaky clean to the
705 user, isn't it? The reason for all this is that the
713 one of the standard shells. As a result, it's not possible to pass
714 information via an argument list. The convention is that environment
715 variables whose names are all upper-case are user-settable; those
716 whose names are lower-case only are used internally by nmh and should
717 not generally be set by the user.
721 With this environment variable, you can specify a profile
727 that you invoke. If the value of
729 is not absolute, (i.e., does
730 not begin with a \*(lq/\*(rq), it will be presumed to start from the current
731 working directory. This is one of the very few exceptions in
733 where non-absolute pathnames are not considered relative to the user's
740 With this environment variable, you can specify a
741 context other than the normal context file (as specified in
744 profile). As always, unless the value of
746 is absolute, it will be presumed to start from your
753 With this environment variable, you can specify an
754 additional user profile (file) to be read by
756 in addition to the mhn.defaults profile.
761 With this environment variable, you can specify an
762 additional user profile (file) to be read by
764 in addition to the mhn.defaults profile.
766 is deprecated, so this support for this variable will
767 be removed from a future nmh release.
772 With this environment variable, you can specify an
773 additional user profile (file) to be read by
775 in addition to the mhn.defaults profile.
780 With this environment variable, you can specify an
781 additional user profile (file) to be read by
783 in addition to the mhn.defaults profile.
788 With this environment variable, you can specify
789 the native character set you are using. You must be able to display
790 this character set on your terminal.
792 This variable is checked to see if a RFC 2047 header field should be
805 be called, since showmimeproc will be called if a text message uses
806 a character set that doesn't match
811 for matches against the charset parameter
812 of text contents to decide it the text content can be displayed
813 without modifications to your terminal. This variable is checked by
815 to decide what character set to specify in the charset
816 parameter of text contents containing 8\-bit characters.
818 When decoding text in such an alternate character set,
820 must be able to determine which characters are alphabetic, which
821 are control characters, etc. For many operating systems, this
822 will require enabling the support for locales (such as setting
823 the environment variable
832 the default maildrop. This supersedes the \*(lqMailDrop\*(rq profile entry.
839 the POP host to query for mail to incorporate. See the
840 inc(1) man page for more information.
843 .B $USERNAME_EXTENSION
845 This variable is for use with username_extension masquerading. See the
846 mh-tailor(5) man page.
855 your mail signature. This supersedes the \*(lqSignature\*(rq profile entry,
856 and is not used when the \*(lqLocal\-Mailbox\*(rq profile component is set.
865 your default maildrop: see the \*(lqMailDrop\*(rq profile entry.
870 This variable tells all
872 programs your home directory
881 The environment variable
883 is also consulted. In particular,
888 how to clear your terminal, and how
889 many columns wide your terminal is. They also tell
892 lines long your terminal screen is.
897 If this variable is set to a non-null value, it specifies the
898 name of the mail transport configuration file to use by
901 and other programs that interact with the mail transport system,
902 instead of the default. See mh-tailor(5).
907 If this variable is set to a non-null value, it specifies the name of
908 a mail transport configuration file to be read in addition to the
909 default. See mh-tailor(5).
916 These variables are searched, in order, for the directory in which to
917 create some temporary files.
922 If this variable is set to a non-null value,
924 will emit debugging information.
929 If this variable is set to a non-null value,
931 will emit a representation of the search pattern.
936 If this variable is set to a non-null value,
938 commands that use the
939 .BR Alternate\-Mailboxes
940 profile entry will display debugging information
941 about the values in that entry.
946 If set to a non-null value, this supersedes the value of
947 the default built-in pager command.
952 This is the alternate message.
958 during edit sessions so you can
959 peruse the message being distributed or replied to. The message is also
963 through a link called \*(lq@\*(rq in the current directory if
964 your current working directory and the folder the message lives in are
965 on the same UNIX filesystem, and if your current working directory is
971 This is the path to the working draft.
981 which file to ask \*(lqWhat now?\*(rq
994 about an alternate message associated with the
995 draft (the message being distributed or replied to).
1000 This is the folder containing the alternate message.
1006 during edit sessions so you
1007 can peruse other messages in the current folder besides the one being
1008 distributed or replied to. The environment variable
1026 that message re-distribution is occurring.
1039 the user's choice of
1040 editor (unless overridden by
1057 if annotations are to occur.
1067 if annotations are to occur.
1077 if annotations are to occur.
1082 .ta \w'%etcdir%/ExtraBigFileName 'u
1083 ^$HOME/\&.mh\(ruprofile~^The user profile
1084 ^or $MH~^Rather than the standard profile
1085 ^<mh\-dir>/context~^The user context
1086 ^or $MHCONTEXT~^Rather than the standard context
1087 ^<folder>/\&.mh\(rusequences~^Public sequences for <folder>
1091 .IR mh-sequence (5),
1096 contains only static information, which
1100 update. Changes in context are made to the
1102 file kept in the users
1105 This includes, but is not limited to: the \*(lqCurrent\-Folder\*(rq entry
1106 and all private sequence information. Public sequence information is
1107 kept in each folder in the file determined by the \*(lqmh\-sequences\*(rq
1108 profile entry (default is
1109 .IR \&.mh\(rusequences ).
1113 may override the path of the
1115 file, by specifying a \*(lqcontext\*(rq entry (this must be in
1116 lower-case). If the entry is not absolute (does not start with a
1117 \*(lq/\*(rq), then it is interpreted relative to the user's
1119 directory. As a result, you can actually have more than one set of
1120 private sequences by using different context files.
1122 There is some question as to what kind of arguments should be placed
1123 in the profile as options. In order to provide a clear answer, recall
1124 command line semantics of all
1126 programs: conflicting switches
1131 may occur more than one time on the
1132 command line, with the last switch taking effect. Other arguments, such
1133 as message sequences, filenames and folders, are always remembered on
1134 the invocation line and are not superseded by following arguments of
1135 the same type. Hence, it is safe to place only switches (and their
1136 arguments) in the profile.
1138 If one finds that an
1140 program is being invoked again and again
1141 with the same arguments, and those arguments aren't switches, then there
1142 are a few possible solutions to this problem. The first is to create a
1148 of your choice. By giving this link a different name, you can create
1149 a new entry in your profile and use an alternate set of defaults for
1152 command. Similarly, you could create a small shell script
1155 program of your choice with an alternate set
1156 of invocation line switches (using links and an alternate profile entry
1157 is preferable to this solution).
1161 user could create an alias for the command of the form:
1164 alias cmd 'cmd arg1 arg2 ...'
1167 In this way, the user can avoid lengthy type-in to the shell, and still
1170 commands safely. (Recall that some
1173 invoke others, and that in all cases, the profile is read, meaning that
1174 aliases are disregarded beyond an initial command invocation)
projects / nmh / blob