8 date 96.02.08.18.06.13; author jromine; state Exp;
13 date 93.08.19.23.43.36; author jromine; state Exp;
18 date 92.12.02.22.13.41; author jromine; state Exp;
23 date 92.12.02.22.12.10; author jromine; state Exp;
28 date 92.12.02.21.47.22; author jromine; state Exp;
33 date 92.12.02.21.41.38; author jromine; state Exp;
38 date 92.10.29.22.23.58; author jromine; state Exp;
43 date 92.10.26.17.05.09; author jromine; state Exp;
48 date 92.10.20.19.34.57; author jromine; state Exp;
53 date 92.05.12.22.23.34; author jromine; state Exp;
58 date 92.02.11.00.47.53; author jromine; state Exp;
63 date 92.02.10.20.28.34; author jromine; state Exp;
68 date 92.02.04.00.04.47; author jromine; state Exp;
73 date 90.12.18.12.49.13; author mh; state Exp;
78 date 90.04.05.15.09.46; author sources; state Exp;
83 date 90.04.02.14.29.06; author sources; state Exp;
88 date 90.03.22.11.31.20; author sources; state Exp;
93 date 90.03.20.19.41.59; author sources; state Exp;
98 date 90.03.20.17.36.15; author sources; state Exp;
103 date 90.03.16.15.40.28; author sources; state Exp;
108 date 90.03.16.15.29.23; author sources; state Exp;
119 @note continuation line format
123 .\" @@(#)$Id: mh-profile.rf,v 1.20 1993/08/19 23:43:36 jromine Exp jromine $
126 mh-profile \- user profile customization for MH message handler
128 \&\fI.mh\(ruprofile\fP
130 Each user of \fIMH\fR is expected to have a file named \fI\&.mh\(ruprofile\fR
131 in his or her home directory. This file contains a set of
132 user parameters used by some or all of the \fIMH\fR
133 family of programs. Each entry in the file is of the format
135 \fIprofile\-component\fR: \fIvalue\fR
137 If the text of an entry extends across several
138 real lines, the continuation lines are indicated by leading
140 The possible profile components are exemplified below.
141 Only `Path:' is mandatory.
142 The others are optional;
143 some have default values if they are not present.
144 In the notation used below,
145 (profile, default) indicates whether the information is kept in the user's
146 \fIMH\fR profile or \fIMH\fR context,
147 and indicates what the default value is.
153 Locates \fIMH\fR transactions in directory \*(lqMail\*(rq.
154 (profile, no default)
159 Declares the location of the \fIMH\fR context file,
160 see the \fBHISTORY\fR section below.
161 (profile, default: <mh\-dir>/context)
164 Current\-Folder:\ inbox
166 Keeps track of the current open folder.
167 (context, default: folder specified by \*(lqInbox\*(rq)
172 Defines the name of your inbox.
173 (profile, default: inbox)
176 Previous\-Sequence:\ pseq
178 Names the sequences which should be defined as the `msgs' or `msg'
179 argument given to the program.
180 If not present, or empty, no sequences are defined.
183 the sequence is first zero'd and then each message is added to the sequence.
184 (profile, no default)
187 Sequence\-Negation:\ not
189 Defines the string which, when prefixed to a sequence name,
190 negates that sequence.
192 \*(lqnotseen\*(rq means all those messages that are not a member of
193 the sequence \*(lqseen\*(rq.
194 (profile, no default)
197 Unseen\-Sequence:\ unseen
199 Names the sequences which should be defined as those messages recently
200 incorporated by \fIinc\fR.
201 \fIShow\fR knows to remove messages from this sequence once it thinks they
203 If not present, or empty, no sequences are defined.
205 each message is added to each sequence name given.
206 (profile, no default)
209 mh\-sequences:\ \&.mh\(rusequences
211 The name of the file in each folder which defines public sequences.
212 To disable the use of public sequences,
213 leave the value portion of this entry blank.
214 (profile, default: \&.mh\(rusequences)
217 atr\-\fIseq\fR\-\fIfolder\fR:\ 172\0178\-181\0212
219 Keeps track of the private sequence called \fIseq\fR in the specified folder.
220 (context, no default)
225 Defines editor to be used by
226 \fIcomp\fR\0(1), \fIdist\fR\0(1), \fIforw\fR\0(1), and \fIrepl\fR\0(1).
227 (profile, default: @@(MHEDITOR))
232 Defines octal protection bits for message files.
233 See \fIchmod\fR\0(1) for an explanation of the octal number.
234 (profile, default: 0644)
237 Folder\-Protect:\ 711
239 Defines protection bits for folder directories.
240 (profile, default: 0711)
243 \fIprogram\fR:\ default switches
245 Sets default switches to be used whenever the mh program
246 \fIprogram\fR is invoked.
247 For example, one could override the \fIEditor\fR:
248 profile component when replying to messages by adding a
251 repl: \-editor /bin/ed
253 (profile, no defaults)
256 \fIlasteditor\fR\-next:\ nexteditor
258 Names \*(lqnexteditor\*(rq to be the default editor after using \*(lqlasteditor\*(rq.
259 This takes effect at \*(lqWhat now?\*(rq level in
260 \fIcomp\fR, \fIdist\fR, \fIforw\fR, and \fIrepl\fR.
261 After editing the draft with \*(lqlasteditor\*(rq,
262 the default editor is set to be \*(lqnexteditor\*(rq.
263 If the user types \*(lqedit\*(rq without any arguments to \*(lqWhat now?\*(rq,
264 then \*(lqnexteditor\*(rq is used.
265 (profile, no default)
270 Tells \fIbbc\fR which BBoards you are interested in.
271 (profile, default: system)
274 Folder\-Stack: \fIfolders\fR
276 The contents of the folder-stack for the \fIfolder\fR command.
277 (context, no default)
282 If present, tells \fIinc\fR to compose an \fIMHE\fR auditfile in addition to
284 \fIMHE\fR is Brian Reid's \fIEmacs\fR front-end for \fIMH\fR.
285 An early version is supplied with the \fImh.6\fR distribution.
286 (profile, no default)
289 Alternate\-Mailboxes: mh@@uci\-750a, bug-mh*
291 Tells \fIrepl\fR and \fIscan\fR which addresses are really yours.
292 In this way, \fIrepl\fR knows which addresses should be included in the reply,
293 and \fIscan\fR knows if the message really originated from you.
294 Addresses must be separated by a comma,
295 and the hostnames listed should be the \*(lqofficial\*(rq hostnames for the
296 mailboxes you indicate,
297 as local nicknames for hosts are not replaced with their official site names.
299 if a host is not given,
300 then that address on any host is considered to be you.
302 an asterisk (`*') may appear at either or both ends of the mailbox and host
303 to indicate wild-card matching.
304 (profile, default: your user-id)
307 Aliasfile: aliases other-alias
309 Indicates aliases files for \fIali\fR, \fIwhom\fR, and \fIsend\fR.
310 This may be used instead of the `\-alias file' switch.
311 (profile, no default)
314 Draft\-Folder: drafts
316 Indicates a default draft folder for \fIcomp\fR, \fIdist\fR, \fIforw\fR,
318 (profile, no default)
321 digest\-issue\-\fIlist\fR:\ 1
323 Tells \fIforw\fR the last issue of the last volume sent for the digest
325 (context, no default)
328 digest\-volume\-\fIlist\fR:\ 1
330 Tells \fIforw\fR the last volume sent for the digest \fIlist\fR.
331 (context, no default)
336 Tells \fIinc\fR your maildrop, if different from the default.
337 This is superceded by the \fBMAILDROP\fR envariable.
338 (profile, default: @@(MHDROPLOC))
341 Signature: RAND MH System (agent: Marshall Rose)
343 Tells \fIsend\fR your mail signature.
344 This is superceded by the \fBSIGNATURE\fR envariable.
345 If \fBSIGNATURE\fR is not set and this profile entry is not present,
346 the \*(lqgcos\*(rq field of the \fI/etc/passwd\fP file will be used;
348 on hosts where \fIMH\fR was configured with the UCI option,
349 the file $HOME/.signature is consulted.
350 Your signature will be added to the address \fIsend\fP
351 puts in the \*(lqFrom:\*(rq header;
352 do not include an address in the signature text.
353 (profile, no default)
356 The following profile elements are used whenever an \fIMH\fR program
357 invokes some other program such as \fImore\fR\0(1).
358 The \fI\&.mh\(ruprofile\fR can be used to select alternate
359 programs if the user wishes. The default values are given in
364 .ta \w'whatnowproc: 'u
365 ^fileproc:~^@@(MHBINPATH)/refile
366 ^incproc:~^@@(MHBINPATH)/inc
367 ^installproc:~^@@(MHETCPATH)/install\-mh
368 ^lproc:~^/usr/ucb/more
369 ^mailproc:~^@@(MHBINPATH)/mhmail
370 ^mhlproc:~^@@(MHETCPATH)/mhl
371 ^moreproc:~^/usr/ucb/more
372 ^mshproc:~^@@(MHBINPATH)/msh
373 ^packproc:~^@@(MHBINPATH)/packf
374 ^postproc:~^@@(MHETCPATH)/post
376 ^rmfproc:~^@@(MHBINPATH)/rmf
377 ^sendproc:~^@@(MHBINPATH)/send
378 ^showproc:~^/usr/ucb/more
379 ^whatnowproc:~^@@(MHBINPATH)/whatnow
380 ^whomproc:~^@@(MHBINPATH)/whom
385 If you define the envariable \fBMH\fR,
386 you can specify a profile other than \fI\&.mh\(ruprofile\fR to be read
387 by the \fIMH\fR programs that you invoke.
388 If the value of \fBMH\fR is not absolute,
389 (i.e., does not begin with a \fB/\fR\0),
390 it will be presumed to start from the current working directory.
391 This is one of the very few exceptions in \fIMH\fR where non-absolute
392 pathnames are not considered relative to the user's \fIMH\fR directory.
395 if you define the envariable \fBMHCONTEXT\fR,
396 you can specify a context other than the normal context file
397 (as specified in the \fIMH\fR profile).
399 unless the value of \fBMHCONTEXT\fR is absolute,
400 it will be presumed to start from your \fIMH\fR directory.
402 \fIMH\fR programs also support other envariables:
406 \fBMAILDROP\fR\0: tells \fIinc\fR the default maildrop
408 This supercedes the \*(lqMailDrop:\*(rq profile entry.
411 \fBSIGNATURE\fR\0: tells \fIsend\fR and \fIpost\fR your mail signature
413 This supercedes the \*(lqSignature:\*(rq profile entry.
416 \fBHOME\fR\0: tells all \fIMH\fR programs your home directory
419 \fBSHELL\fR\0: tells \fIbbl\fR the default shell to run
422 \fBTERM\fR\0: tells \fIMH\fR your terminal type
424 The \fBTERMCAP\fR envariable is also consulted.
426 these tell \fIscan\fR and \fImhl\fR how to clear your terminal,
427 and how many columns wide your terminal is.
428 They also tell \fImhl\fR how many lines long your terminal screen is.
431 \fBeditalt\fR\0: the alternate message
433 This is set by \fIdist\fR and \fIrepl\fR during edit sessions
434 so you can peruse the message being distributed or replied to.
435 The message is also available through a link called \*(lq@@\*(rq
436 in the current directory if your current working directory and
437 the folder the message lives in are on the same UNIX filesystem.
440 \fBmhdraft\fR\0: the path to the working draft
442 This is set by \fIcomp\fR, \fIdist\fR, \fIforw\fR, and \fIrepl\fR
443 to tell the \fIwhatnowproc\fR which file to ask \*(lqWhat now?\*(rq questions
446 \fIdist\fR, \fIforw\fR, and \fIrepl\fR set \fBmhfolder\fR if appropriate.
448 \fIdist\fR and \fIrepl\fR set \fBmhaltmsg\fR to tell the
449 \fIwhatnowproc\fR about an alternate message associated with the draft
450 (the message being distributed or replied to),
452 \fIdist\fR sets \fBmhdist\fR to tell the \fIwhatnowproc\fR that
453 message re-distribution is occurring.
455 \fBmheditor\fR is set to tell the \fIwhatnowproc\fR the user's choice of
456 editor (unless overridden by `\-noedit').
458 \fBmhuse\fR may be set by \fIcomp\fR.
460 \fBmhmessages\fR is set by \fIdist\fR, \fIforw\fR, and \fIrepl\fR
461 if annotations are to occur
462 (along with \fBmhannotate\fR, and \fBmhinplace\fR).
463 It's amazing all the information that has to get passed via envariables to
464 make the \*(lqWhat now?\*(rq interface look squeaky clean to the \fIMH\fR
466 The reason for all this
467 is that the \fIMH\fR user can select \fIany\fR program as the
468 \fIwhatnowproc\fR, including one of the standard shells.
469 As a result, it's not possible to pass information via an argument list.
471 If the WHATNOW option was set during \fIMH\fR configuration
472 (type `\-help' to an \fIMH\fR command to find out),
473 and if this envariable is set,
474 if the commands \fIrefile\fR, \fIsend\fR, \fIshow\fR, or \fIwhom\fR
475 are not given any `msgs' arguments,
476 then they will default to using the file indicated by \fBmhdraft\fR.
477 This is useful for getting the default behavior supplied by the default
481 \fBmhfolder\fR\0: the folder containing the alternate message
483 This is set by \fIdist\fR and \fIrepl\fR during edit sessions
484 so you can peruse other messages in the current folder
485 besides the one being distributed or replied to.
486 The \fBmhfolder\fR envariable is also
487 set by \fIshow\fR, \fIprev\fR, and \fInext\fR
488 for use by \fImhl\fR.
493 If you define the envariable \fBMHBBRC\fR,
494 you can specify a BBoards information file other than \fI\&.bbrc\fR to be
496 If the value of \fBMHBBRC\fR is not absolute,
497 (i.e., does not begin with a \fB/\fR\0),
498 it will be presumed to start from the current working directory.
503 If the OVERHEAD option was set during \fIMH\fR configuration
504 (type `\-help' to an \fIMH\fR command to find out),
505 then if this envariable is set,
506 \fIMH\fR considers it to be the number of a file descriptor which is opened,
507 read-only to the \fIMH\fR profile.
509 if the envariable \fBMHCONTEXTFD\fR is set,
510 this is the number of a file descriptor which is opened read-only
511 to the \fIMH\fR context.
512 This feature of \fIMH\fR is experimental,
513 and is used to examine possible speed improvements for \fIMH\fR startup.
514 Note that these envariables must be set and non-empty to enable this feature.
516 if OVERHEAD is enabled during \fIMH\fR configuration,
517 then when \fIMH\fR programs call other \fIMH\fR programs,
519 These file descriptors are not closed throughout the execution of the
521 so children may take advantage of this.
522 This approach is thought to be completely safe and does result in some
523 performance enhancements.
527 ^$HOME/\&.mh\(ruprofile~^The user profile
528 ^or $MH~^Rather than the standard profile
529 ^<mh\-dir>/context~^The user context
530 ^or $CONTEXT~^Rather than the standard context
531 ^<folder>/\&.mh\(rusequences~^Public sequences for <folder>
535 mh(1), environ(5), mh-sequence(5)
541 In previous versions of \fIMH\fR,
542 the current-message value of a writable folder was kept in a file
543 called \*(lqcur\*(rq in the folder itself.
545 the \fI\&.mh\(ruprofile\fR contained the current-message values for
546 all folders, regardless of their writability.
548 In all versions of \fIMH\fR since \fImh.4\fR,
549 the \fI\&.mh\(ruprofile\fR contains only static information,
550 which \fIMH\fR programs will \fBNOT\fR update.
551 Changes in context are made to the \fIcontext\fR file kept in the users MH
553 This includes, but is not limited to:
554 the \*(lqCurrent\-Folder\*(rq entry and all private sequence information.
555 Public sequence information is kept in a file called \fI\&.mh\(rusequences\fR
558 To convert from the format used in releases of \fIMH\fR prior
559 to the format used in the \fImh.4\fR release,
560 \fIinstall\-mh\fR should be invoked with the `\-compat' switch.
561 This generally happens automatically on \fIMH\fR systems generated with the
562 \*(lqCOMPAT\*(rq option during \fIMH\fR configuration.
564 The \fI\&.mh\(ruprofile\fR may override the path of the \fIcontext\fR file,
565 by specifying a \*(lqcontext\*(rq entry (this must be in lower-case).
566 If the entry is not absolute (does not start with a \fB/\fR\0),
567 then it is interpreted relative to the user's \fIMH\fR directory.
569 you can actually have more than one set of private sequences by using
570 different context files.
572 The shell quoting conventions are not available in the \&.mh\(ruprofile.
573 Each token is separated by whitespace.
575 There is some question as to what kind of arguments should be placed in
576 the profile as options.
577 In order to provide a clear answer,
578 recall command line semantics of all \fIMH\fR programs:
579 conflicting switches (e.g., `\-header and `\-noheader')
580 may occur more than one time on the command line,
581 with the last switch taking effect.
583 such as message sequences, filenames and folders,
584 are always remembered on the invocation line and are not superseded by
585 following arguments of the same type.
586 Hence, it is safe to place only switches (and their arguments)
589 If one finds that an \fIMH\fR
590 program is being invoked again and again with the same arguments,
591 and those arguments aren't switches,
592 then there are a few possible solutions to this problem.
593 The first is to create a (soft) link in your \fI$HOME/bin\fR directory
594 to the \fIMH\fR program of your choice.
595 By giving this link a different name,
596 you can create a new entry in your profile
597 and use an alternate set of defaults for the \fIMH\fR command.
598 Similarly, you could create a small shell script which called the
599 \fIMH\fR program of your choice with an alternate set of invocation
600 line switches (using links and an alternate profile entry is preferable
603 Finally, the \fIcsh\fR user could create an alias for the command of the form:
606 alias cmd 'cmd arg1 arg2 ...'
608 In this way, the user can avoid lengthy type-in to the shell,
609 and still give \fIMH\fR commands safely. (Recall that some \fIMH\fR
610 commands invoke others, and that in all cases, the profile is read,
611 meaning that aliases are disregarded beyond an initial command invocation)
618 @note use of gcos field for signature
623 .\" @@(#)$Id: mh-profile.rf,v 1.19 1992/12/02 22:13:41 jromine Exp jromine $
626 family of programs. Each line of the file is of the format
638 .\" @@(#)$Id: mh-profile.rf,v 1.18 1992/12/02 22:12:10 jromine Exp jromine $
641 On hosts where \fIMH\fR was configured with the UCI option,
642 if \fBSIGNATURE\fR is not set and this profile entry is not present,
653 .\" @@(#)$Id: mh-profile.rf,v 1.17 1992/12/02 21:47:22 jromine Exp jromine $
656 mh-profile \- user customization for MH message handler
667 .\" @@(#)$Id: mh-profile.rf,v 1.16 1992/12/02 21:41:38 jromine Exp jromine $
670 mh-profile \- MH user profile
681 .\" @@(#)$Id: mh-profile.rf,v 1.15 1992/10/29 22:23:58 jromine Exp jromine $
684 mh-profile \- user profile customization for MH message system
695 .\" @@(#)$Id: mh-profile.rf,v 1.14 1992/10/26 17:05:09 jromine Exp jromine $
698 \&.mh\(ruprofile \- user profile customization for MH message system
704 The contents of the folder\-stack for the \fIfolder\fR command.
707 \fIMHE\fR is Brian Reid's \fIEmacs\fR front\-end for \fIMH\fR.
710 to indicate wild\-card matching.
713 This is one of the very few exceptions in \fIMH\fR where non\-absolute
716 so you can peruse the message being distributed or replied-to.
719 (the message being distributed or replied\-to),
722 message re\-distribution is occurring.
725 besides the one being distributed or replied-to.
728 \fIMH\fR considers it to be the number of a file\-descriptor which is opened,
729 read\-only to the \fIMH\fR profile.
732 this is the number of a file\-descriptor which is opened read\-only
735 Note that these envariables must be set and non\-empty to enable this feature.
738 These file\-descriptors are not closed throughout the execution of the
741 the current\-message value of a writable folder was kept in a file
744 the \fI\&.mh\(ruprofile\fR contained the current\-message values for
747 In this way, the user can avoid lengthy type\-in to the shell,
753 @fixes from Jerry Peek; don't put '$' in front of envar names
758 .\" @@(#)$Id: mh-profile.rf,v 1.13 1992/10/20 19:34:57 jromine Exp jromine $
772 .\" @@(#)$Id: mh-profile.rf,v 1.12 1992/05/12 22:23:34 jromine Exp jromine $
776 the sequence is first zero'd and then each message is added to the sequence.
779 This is superceded by the \fB$MAILDROP\fR envariable.
782 This is superceded by the \fB$SIGNATURE\fR envariable.
785 if \fB$SIGNATURE\fR is not set and this profile entry is not present,
788 If you define the envariable \fB$MH\fR,
791 If the value of \fB$MH\fR is not absolute,
794 if you define the envariable \fB$MHCONTEXT\fR,
797 unless the value of \fB$MHCONTEXT\fR is absolute,
800 \fB$MAILDROP\fR\0: tells \fIinc\fR the default maildrop
803 \fB$SIGNATURE\fR\0: tells \fIsend\fR and \fIpost\fR your mail signature
806 \fB$HOME\fR\0: tells all \fIMH\fR programs your home directory
809 \fB$SHELL\fR\0: tells \fIbbl\fR the default shell to run
812 \fB$TERM\fR\0: tells \fIMH\fR your terminal type
815 The \fB$TERMCAP\fR envariable is also consulted.
818 \fB$editalt\fR\0: the alternate message
821 \fB$mhdraft\fR\0: the path to the working draft
824 \fIdist\fR, \fIforw\fR, and \fIrepl\fR set \fB$mhfolder\fR if appropriate.
827 \fIdist\fR and \fIrepl\fR set \fB$mhaltmsg\fR to tell the
830 \fIdist\fR sets \fB$mhdist\fR to tell the \fIwhatnowproc\fR that
833 \fB$mheditor\fR is set to tell the \fIwhatnowproc\fR the user's choice of
836 \fB$mhuse\fR may be set by \fIcomp\fR.
839 \fB$mhmessages\fR is set by \fIdist\fR, \fIforw\fR, and \fIrepl\fR
842 (along with \fB$mhannotate\fR, and \fB$mhinplace\fR).
845 then they will default to using the file indicated by \fB$mhdraft\fR.
848 \fB$mhfolder\fR\0: the folder containing the alternate message
851 The \fB$mhfolder\fR envariable is also
857 If you define the envariable \fB$MHBBRC\fR,
860 If the value of \fB$MHBBRC\fR is not absolute,
866 if the envariable \fB$MHCONTEXTFD\fR is set,
872 @fixup for nroff problems
877 .\" @@(#)$Id: mh-profile.rf,v 1.11 1992/02/11 00:47:53 jromine Exp jromine $
880 these tells \fIscan\fR and \fImhl\fR how to clear your terminal,
886 @document Aliasfile may be more than one file
891 .\" @@(#)$Id: mh-profile.rf,v 1.10 1992/02/10 20:28:34 jromine Exp jromine $
895 \&.mh\(ruprofile \- user customization for MH message system
906 .\" @@(#)$Id: mh-profile.rf,v 1.9 1992/02/04 00:04:47 jromine Exp jromine $
912 Indicates a default aliases file for \fIali\fR, \fIwhom\fR, and \fIsend\fR.
923 .\" @@(#)$Id: mh-profile.rf,v 1.8 1990/12/18 12:49:13 mh Exp jromine $
932 @do not add <user@@host> to signature
938 .\" @@(#)$Id: mh-profile.rf,v 1.7 90/04/05 15:09:46 sources Exp Locker: mh $
941 (context, default: +inbox)
968 @put things back, do .NA stuff another way
973 Signature: Rand MH System (agent: Marshall Rose)
984 .TH MH\-PROFILE 5 @@(MHCENTERFOOT) @@(MHLEFTFOOT)
994 @fixup for makewhatis
999 .TH MH\-PROFILE 5 [mh.6] MH
1005 @document Aliasfile: profile entry