From 55c80a0ae8453ef6c3e0fcd0fac30644945d0ef2 Mon Sep 17 00:00:00 2001 From: Shantonu Sen Date: Mon, 1 Jan 2001 10:19:00 +0000 Subject: [PATCH] Updating ali-mh_alias --- man/ali.man | 16 ++- man/anno.man | 7 +- man/ap.man | 5 +- man/burst.man | 5 +- man/comp.man | 8 +- man/conflict.man | 6 +- man/dist.man | 8 +- man/dp.man | 6 +- man/flist.man | 6 +- man/fmtdump.man | 2 + man/folder.man | 7 +- man/forw.man | 5 +- man/inc.man | 6 +- man/install-mh.man | 106 +++++++++++------ man/mark.man | 225 +++++++++++++++++++++++------------- man/mh-alias.man | 319 +++++++++++++++++++++++++++++++++------------------- 16 files changed, 481 insertions(+), 256 deletions(-) diff --git a/man/ali.man b/man/ali.man index 1d22034..49a0a88 100644 --- a/man/ali.man +++ b/man/ali.man @@ -48,10 +48,11 @@ switch is given, will try to track down the official hostname of the address. .PP -The files specified by the profile entry \*(lqAliasfile:\*(rq and any -additional alias files given by the -.RB ` \-alias -.IR aliasfile ' +The files specified by the profile entry +.RI \*(lq Aliasfile \*(rq +and any additional alias files given by the +.B \-alias +.I aliasfile switch will be read. Each .I alias is processed as described in @@ -64,6 +65,7 @@ is processed as described in ^$HOME/\&.mh\(ruprofile~^The user profile ^/etc/passwd~^List of users ^/etc/group~^List of groups +.fi .SH "PROFILE COMPONENTS" .fc ^ ~ @@ -72,16 +74,18 @@ is processed as described in .ta \w'ExtraBigProfileName 'u ^Path:~^To determine the user's nmh directory ^Aliasfile:~^For a default alias file +.fi .SH "SEE ALSO" mh\-alias(5) -.SH "DEFAULTS" +.SH DEFAULTS .nf -.RB ` \-alias " %etcdir%/MailAliases'" +.RB ` aliasfiles "' defaults to %etcdir%/MailAliases" .RB ` \-nolist ' .RB ` \-nonormalize ' .RB ` \-nouser ' +.fi .SH CONTEXT None diff --git a/man/anno.man b/man/anno.man index 76b71e4..5069362 100644 --- a/man/anno.man +++ b/man/anno.man @@ -45,7 +45,7 @@ The .B \-nodate switch inhibits the date annotation, leaving only the body annotation. - +.PP If a .B \-component .I field @@ -71,6 +71,7 @@ switch. .nf .ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile +.fi .SH "PROFILE COMPONENTS" .fc ^ ~ @@ -79,16 +80,18 @@ switch. .ta \w'ExtraBigProfileName 'u ^Path:~^To determine the user's nmh directory ^Current\-Folder:~^To find the default current folder +.fi .SH "SEE ALSO" dist(1), forw(1), repl(1) -.SH "DEFAULTS" +.SH DEFAULTS .nf .RI ` +folder "' defaults to the current folder" .RI ` msgs "' defaults to cur" .RB ` \-inplace ' .RB ` \-date ' +.fi .SH CONTEXT If a folder is given, it will become the current folder. The first diff --git a/man/ap.man b/man/ap.man index dcbe70a..8958135 100644 --- a/man/ap.man +++ b/man/ap.man @@ -52,7 +52,6 @@ In addition to the standard escapes, also recognizes the following additional escape: .PP .RS 5 -.fc ^ ~ .nf .ta \w'Escape 'u +\w'Returns 'u .I Escape Returns Description @@ -84,6 +83,7 @@ the address. .ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile ^%etcdir%/mts.conf~^nmh mts configuration file +.fi .SH "PROFILE COMPONENTS" None @@ -93,11 +93,12 @@ dp(8), .I "Standard for the Format of ARPA Internet Text Messages" (RFC\-822) -.SH "DEFAULTS" +.SH DEFAULTS .nf .RB ` \-format "' defaults as described above" .RB ` \-normalize ' .RB ` \-width "' defaults to the width of the terminal" +.fi .SH CONTEXT None diff --git a/man/burst.man b/man/burst.man index 8537092..4d0eb96 100644 --- a/man/burst.man +++ b/man/burst.man @@ -63,6 +63,7 @@ or .nf .ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile +.fi .SH "PROFILE COMPONENTS" .fc ^ ~ @@ -72,19 +73,21 @@ or ^Path:~^To determine the user's nmh directory ^Current\-Folder:~^To find the default current folder ^Msg\-Protect:~^To set mode when creating a new message +.fi .SH "SEE ALSO" inc(1), msh(1), pack(1), .I "Proposed Standard for Message Encapsulation" (RFC\-934) -.SH "DEFAULTS" +.SH DEFAULTS .nf .RB ` +folder "' defaults to the current folder" .RB ` msgs "' defaults to cur" .RB ` \-noinplace ' .RB ` \-noquiet ' .RB ` \-noverbose ' +.fi .SH CONTEXT If a folder is given, it will become the current folder. If diff --git a/man/comp.man b/man/comp.man index 610e93b..ca11dfb 100644 --- a/man/comp.man +++ b/man/comp.man @@ -34,8 +34,7 @@ is used to create a new message to be mailed. It copies a message form to the draft being composed and then invokes an editor on the draft (unless .B \-noedit -is given, in which case the initial edit -is suppressed). +is given, in which case the initial edit is suppressed). .PP The default message form contains the following elements: .PP @@ -162,6 +161,7 @@ will prevent any edit from occurring.) ^or /components~^Rather than the standard skeleton ^$HOME/\&.mh\(ruprofile~^The user profile ^/draft~^The draft file +.fi .SH "PROFILE COMPONENTS" .fc ^ ~ @@ -174,16 +174,18 @@ will prevent any edit from occurring.) ^Msg\-Protect:~^To set mode when creating a new message (draft) ^fileproc:~^Program to refile the message ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions +.fi .SH "SEE ALSO" dist(1), forw(1), repl(1), send(1), whatnow(1), mh-profile(5) -.SH "DEFAULTS" +.SH DEFAULTS .nf .RB ` +folder "' defaults to the current folder" .RB ` msg "' defaults to the current message" .RB ` \-nodraftfolder ' .RB ` \-nouse ' +.fi .SH CONTEXT None diff --git a/man/conflict.man b/man/conflict.man index 3bb683a..2be7dab 100644 --- a/man/conflict.man +++ b/man/conflict.man @@ -12,10 +12,10 @@ conflict \- search for alias/password conflicts .IR directory ] .RB [ \-mail .IR name ] -.RI [ aliasfiles -\&...] .RB [ \-version ] .RB [ \-help ] +.RI [ aliasfiles +\&...] .SH DESCRIPTION .B Conflict is a program that checks to see if the interface between @@ -66,6 +66,7 @@ or whenever system accounting takes place. ^/etc/group~^List of groups ^%bindir%/mhmail~^Program to send mail ^%mailspool%/~^Directory of mail drop +.fi .SH "PROFILE COMPONENTS" None @@ -76,6 +77,7 @@ mh\-alias(5) .SH "DEFAULTS" .nf .RB ` aliasfiles "' defaults to %etcdir%/MailAliases" +.fi .SH CONTEXT None diff --git a/man/dist.man b/man/dist.man index 1e43712..2e65aaf 100644 --- a/man/dist.man +++ b/man/dist.man @@ -86,8 +86,8 @@ If the switch is given, the message being distributed will be annotated with the lines: - Resent: date - Resent: addrs + Resent:\ date + Resent:\ addrs where each address list contains as many lines as required. This annotation will be done only if the message is sent directly from @@ -155,6 +155,7 @@ will prevent any edit from occurring.) ^or /distcomps~^Rather than the standard skeleton ^$HOME/\&.mh\(ruprofile~^The user profile ^/draft~^The draft file +.fi .SH "PROFILE COMPONENTS" .fc ^ ~ @@ -167,16 +168,19 @@ will prevent any edit from occurring.) ^Editor:~^To override the default editor ^fileproc:~^Program to refile the message ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions +.fi .SH "SEE ALSO" comp(1), forw(1), repl(1), send(1), whatnow(1) .SH DEFAULTS +.nf .RB ` +folder "' defaults to the current folder" .RB ` msg "' defaults to cur" .RB ` \-noannotate ' .RB ` \-nodraftfolder ' .RB ` \-inplace ' +.fi .SH CONTEXT If a folder is given, it will become the current folder. The message diff --git a/man/dp.man b/man/dp.man index ce237b0..15522de 100644 --- a/man/dp.man +++ b/man/dp.man @@ -54,9 +54,7 @@ Here is the default format string used by .BR dp : .PP .RS 5 -.nf %<(nodate{text})error: %{text}%|%(putstr(pretty{text}))%> -.fi .RE .PP which says that if an error was detected, print the error, a `:', @@ -68,6 +66,7 @@ Otherwise, output the 822\-proper format of the date. .nf .ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile +.fi .SH "PROFILE COMPONENTS" None @@ -77,10 +76,11 @@ ap(8), .I "Standard for the Format of ARPA Internet Text Messages" (RFC\-822) -.SH "DEFAULTS" +.SH DEFAULTS .nf .RB ` \-format "' default as described above" .RB ` \-width "' default to the width of the terminal" +.fi .SH CONTEXT None diff --git a/man/flist.man b/man/flist.man index b3449ac..a263a6a 100644 --- a/man/flist.man +++ b/man/flist.man @@ -23,7 +23,6 @@ flist, flists \- list the number of messages in given sequence(s) .RB [ \-fast " | " \-nofast ] .RB [ \-version ] .RB [ \-help ] - .PP .HP 5 .B flists @@ -181,6 +180,7 @@ puts everything else in the middle in alphabetical order. .nf .ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile +.fi .SH "PROFILE COMPONENTS" .fc ^ ~ @@ -191,11 +191,12 @@ puts everything else in the middle in alphabetical order. ^mh-sequences:~^File that contains public sequences ^Unseen-Sequence:~^The name of the unseen message sequence ^Flist-Order:~^To sort folders by priority +.fi .SH "SEE ALSO" folder(1), rcvstore(1), slocal(1), mh\-sequence(5) -.SH "DEFAULTS" +.SH DEFAULTS .nf .RB ` -sequence "' defaults to Unseen-Sequence profile entry" .RB ` \-showzero ' @@ -203,6 +204,7 @@ folder(1), rcvstore(1), slocal(1), mh\-sequence(5) .RB ` \-norecurse ' .RB ` \-noalpha ' .RB ` \-nofast ' +.fi .SH CONTEXT If diff --git a/man/fmtdump.man b/man/fmtdump.man index d30098e..5a66785 100644 --- a/man/fmtdump.man +++ b/man/fmtdump.man @@ -41,6 +41,7 @@ for the details. .ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile ^%etcdir%/scan.default~^The default format file +.fi .SH "PROFILE COMPONENTS" .fc ^ ~ @@ -48,6 +49,7 @@ for the details. .ta 2.4i .ta \w'ExtraBigProfileName 'u ^Path:~^To determine the user's nmh directory +.fi .SH "SEE ALSO" mh-format(5), mh-sequences(8) diff --git a/man/folder.man b/man/folder.man index 5444581..8fd456d 100644 --- a/man/folder.man +++ b/man/folder.man @@ -24,7 +24,7 @@ folder, folders \- set/list current folder/message .RB [ \-version ] .RB [ \-help ] .PP -.HP +.HP 5 .B folders is equivalent to .B folder @@ -261,6 +261,7 @@ switches turn off .nf .ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile +.fi .SH "PROFILE COMPONENTS" .fc ^ ~ @@ -272,11 +273,12 @@ switches turn off ^Folder\-Protect:~^To set mode when creating a new folder ^Folder\-Stack:~^To determine the folder stack .\" ^lsproc:~^Program to list the contents of a folder +.fi .SH "SEE ALSO" refile(1), mhpath(1) -.SH "DEFAULTS" +.SH DEFAULTS .nf .RB ` +folder "' defaults to the current folder" .RB ` msg "' defaults to none" @@ -288,6 +290,7 @@ refile(1), mhpath(1) .RB ` \-noverbose ' .RB ` \-print "' is the default if no " \-list ", " \-push ", or " \-pop " is specified" .RB ` \-list "' is the default if " \-push ", or " \-pop " is specified" +.fi .SH CONTEXT If diff --git a/man/forw.man b/man/forw.man index e0651b5..8561d93 100644 --- a/man/forw.man +++ b/man/forw.man @@ -339,6 +339,7 @@ User's Manual for more information on making digests. ^or /mhl.forward~^Rather than the standard filter ^$HOME/\&.mh\(ruprofile~^The user profile ^/draft~^The draft file +.fi .SH "PROFILE COMPONENTS" .fc ^ ~ @@ -353,13 +354,14 @@ User's Manual for more information on making digests. ^fileproc:~^Program to refile the message ^mhlproc:~^Program to filter messages being forwarded ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions +.fi .SH "SEE ALSO" mhbuild(1), comp(1), repl(1), send(1), whatnow(1), mh\-format(5), .I "Proposed Standard for Message Encapsulation" (RFC\-934) -.SH "DEFAULTS" +.SH DEFAULTS .nf .RB ` +folder "' defaults to the current folder" .RB ` msgs "' defaults to cur" @@ -369,6 +371,7 @@ mhbuild(1), comp(1), repl(1), send(1), whatnow(1), mh\-format(5), .RB ` \-inplace ' .RB ` \-dashstuffing ' .RB ` \-nomime ' +.fi .SH CONTEXT If a folder is given, it will become the current folder. diff --git a/man/inc.man b/man/inc.man index a450a93..54ace52 100644 --- a/man/inc.man +++ b/man/inc.man @@ -305,7 +305,6 @@ when viewing the POP transaction with the switch. %nmhendpop% - .SH FILES .fc ^ ~ .nf @@ -313,6 +312,7 @@ switch. ^$HOME/\&.mh\(ruprofile~^The user profile ^%etcdir%/mts.conf~^nmh mts configuration file ^%mailspool%/$USER~^Location of mail drop +.fi .SH "PROFILE COMPONENTS" .fc ^ ~ @@ -325,11 +325,12 @@ switch. ^Folder\-Protect:~^To set mode when creating a new folder ^Msg\-Protect:~^To set mode when creating a new message and audit\-file ^Unseen\-Sequence:~^To name sequences denoting unseen messages +.fi .SH "SEE ALSO" mhmail(1), scan(1), mh\-mail(5), post(8) -.SH "DEFAULTS" +.SH DEFAULTS .nf .RB ` +folder "' defaulted by \*(lqInbox\*(rq above" .RB ` \-noaudit ' @@ -341,6 +342,7 @@ mhmail(1), scan(1), mh\-mail(5), post(8) %nmhbeginpop% .RB ` \-nopack ' %nmhendpop% +.fi .SH CONTEXT The folder into which messages are being incorporated will become the diff --git a/man/install-mh.man b/man/install-mh.man index 72c6275..b3b3785 100644 --- a/man/install-mh.man +++ b/man/install-mh.man @@ -2,48 +2,86 @@ .\" %nmhwarning% .\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" .TH INSTALL-MH %manext8% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME install-mh \- initialize the nmh environment .SH SYNOPSIS -.in +.5i -.ti -.5i -%libdir%/install\-mh -\%[\-auto] -.br -\%[\-version] -\%[\-help] -.in -.5i +.HP 5 +.B %libdir%/install\-mh +.RB [ \-auto ] +.RB [ \-version ] +.RB [ \-help ] .SH DESCRIPTION -\fIInstall\-mh\fR is the \fInmh\fR program to create the initial setup -for a first\-time \fInmh\fR user. It is typically invoked by other -\fInmh\fR commands, and should NOT be directly invoked by the user. - -When a user runs any \fInmh\fR program for the first time, the program -will invoke \fIinstall\-mh\fR (with the `\-auto' switch) to query -the user for the initial \fInmh\fR environment. The user is asked +.B Install\-mh +is the +.B nmh +program to create the initial setup +for a first\-time +.B nmh +user. It is typically invoked by other +.B nmh +commands, and should NOT be directly invoked by the user. +.PP +When a user runs any +.B nmh +program for the first time, the program will invoke +.B install\-mh +(with the `\-auto' switch) to query the user for the initial +.B nmh +environment. The user is asked for the name of the directory that will be designated as the user's -\fInmh\fR directory. If this directory does not exist, the user is +.B nmh +directory. If this directory does not exist, the user is asked if it should be created. Normally, this directory should be -under the user's home directory, and has the default name of Mail/. -After \fIinstall\-mh\fR has written the initial \&.mh\(ruprofile for -the user, control returns to the original \fInmh\fR program. - -As with all \fInmh\fR commands, \fIinstall\-mh\fR first consults the -\fB$HOME\fR environment variable to determine the user's home directory. -If \fB$HOME\fR is not set, then the \fI/etc/passwd\fR file is consulted. +under the user's home directory, and has the default name of +.RI \*(lq Mail/ \*(rq. +After +.B install\-mh +has written the initial +.I \&.mh\(ruprofile +for the user, control returns to the original +.B nmh +program. +.PP +As with all +.B nmh +commands, +.B install\-mh +first consults the +.B $HOME +environment variable to determine the user's home directory. +If +.B $HOME +is not set, then the +.I /etc/passwd +file is consulted. +.PP +When creating the users initial +.IR \&.mh\(ruprofile , +.B install\-mh +will check for the existence of a global profile +.IR %etcdir%/mh.profile . +If found, this will be used to initialize the new +.IR \&.mh\(ruprofile . -When creating the users initial \&.mh\(ruprofile, \fIinstall\-mh\fR will -check for the existence of a global profile %etcdir%/mh.profile. If -found, this will be used to initialize the new \&.mh\(ruprofile. -.Fi +.SH FILES +.fc ^ ~ +.nf +.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile ^%etcdir%/mh.profile~^Used to initialize user profile -.Pr +.fi + +.SH "PROFILE COMPONENTS" +.fc ^ ~ +.nf +.ta 2.4i +.ta \w'ExtraBigProfileName 'u ^Path:~^To set the user's nmh directory -.Co -With `\-auto', the current folder is changed to \*(lqinbox\*(rq. -.En +.fi + +.SH CONTEXT +With +.BR \-auto , +the current folder is changed to +.RI \*(lq inbox \*(rq. diff --git a/man/mark.man b/man/mark.man index 31e4805..128e77d 100644 --- a/man/mark.man +++ b/man/mark.man @@ -2,127 +2,200 @@ .\" %nmhwarning% .\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" .TH MARK %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME mark \- manipulate message sequences .SH SYNOPSIS -.in +.5i -.ti -.5i -mark -\%[+folder] \%[msgs] -\%[\-sequence\ name\ ...] -\%[\-add] -.br -\%[\-delete] \%[\-list] -\%[\-public] \%[\-nopublic] -\%[\-zero] -.br -\%[\-nozero] -\%[\-version] -\%[\-help] -.in -.5i +.HP 5 +.B mark +.RI [ +folder ] +.RI [ msgs ] +.RB [ \-sequence +.I name +\&...] +.RB [ \-add " | " \-delete ] +.RB [ \-list ] +.RB [ \-public " | " \-nopublic ] +.RB [ \-zero " | " \-nozero ] +.RB [ \-version ] +.RB [ \-help ] .SH DESCRIPTION -The \fImark\fR command manipulates message sequences by adding or deleting +The +.B mark +command manipulates message sequences by adding or deleting message numbers from folder\-specific message sequences, or by listing those sequences and messages. - +.PP A message sequence is a keyword, just like one of the \*(lqreserved\*(rq message names, such as \*(lqfirst\*(rq or \*(lqnext\*(rq. Unlike the \*(lqreserved\*(rq message names, which have a fixed semantics on a per\-folder basis, the semantics of a message sequence may be defined, modified, and removed by the user. Message sequences are folder\-specific, e.g., the sequence name \*(lqseen\*(rq in the context -of folder \*(lq+inbox\*(rq need not have any relation whatsoever to the +of folder +.RI \*(lq +inbox \*(rq +need not have any relation whatsoever to the sequence of the same name in a folder of a different name. - -Three action switches direct the operation of \fImark\fR. These switches +.PP +Three action switches direct the operation of +.BR mark . +These switches are mutually exclusive: the last occurrence of any of them overrides any previous occurrence of the other two. - -The `\-add' switch tells \fImark\fR to add messages to sequences or to -create a new sequence. For each sequence named via the `\-sequence\ name' -argument (which must occur at least once) the messages named via `msgs' -(which defaults to \*(lqcur\*(rq if no `msgs' are given), are added to the +.PP +The +.B \-add +switch tells +.B mark +to add messages to sequences or to +create a new sequence. For each sequence named via the +.B \-sequence +.I name +argument (which must occur at least once) the messages named via +.I msgs +(which defaults to \*(lqcur\*(rq if no +.I msgs +are given), are added to the sequence. The messages to be added need not be absent from the sequence. -If the `\-zero' switch is specified, the sequence will be emptied prior -to adding the messages. Hence, `\-add\ \-zero' means that each sequence -should be initialized to the indicated messages, while `\-add\ \-nozero' +If the +.B \-zero +switch is specified, the sequence will be emptied prior +to adding the messages. Hence, +.B \-add +.B \-zero +means that each sequence +should be initialized to the indicated messages, while +.B \-add +.B \-nozero means that each sequence should be appended to by the indicated messages. - -The `\-delete' switch tells \fImark\fR to delete messages from sequences, -and is the dual of `\-add'. For each of the named sequences, the +.PP +The +.B \-delete +switch tells +.B mark +to delete messages from sequences, and is the dual of +.BR \-add . +For each of the named sequences, the named messages are removed from the sequence. These messages need -not be already present in the sequence. If the `\-zero' switch is +not be already present in the sequence. If the +.B \-zero +switch is specified, then all messages in the folder are added to the sequence (first creating the sequence, if necessary) before removing the messages. -Hence, `\-delete\ \-zero' means that each sequence should contain -all messages except those indicated, while `\-delete\ \-nozero' means +Hence, +.B \-delete +.B \-zero +means that each sequence should contain +all messages except those indicated, while +.B \-delete +.B \-nozero +means that only the indicated messages should be removed from each sequence. -As expected, the command `mark\0\-sequence\0foo\0\-delete\0all' deletes -the sequence \*(lqfoo\*(rq from the current folder. - +As expected, the command +.RB \*(lq mark +.B \-sequence +.I foo +.B \-delete +.BR \-all \*(rq +deletes the sequence \*(lqfoo\*(rq from the current folder. +.PP When creating or modifying sequences, you can specify the switches -`\-public' or `\-nopublic' to force the new or modified sequences to be -\*(lqpublic\*(rq or \*(lqprivate\*(rq. The switch `\-public' indicates +.B \-public +or +.B \-nopublic +to force the new or modified sequences to be +\*(lqpublic\*(rq or \*(lqprivate\*(rq. The switch +.B \-public +indicates that the sequences should be made \*(lqpublic\*(rq. These sequences -will then be readable by all \fInmh\fR users with permission to read the -relevant folders. In contrast, the `\-nopublic' switch indicates that the +will then be readable by all +.B nmh +users with permission to read the relevant folders. In contrast, the +.B \-nopublic +switch indicates that the sequences should be made \*(lqprivate\*(rq, and will only be accessible by you. If neither of these switches is specified, then existing sequences will maintain their current status, and new sequences will default to \*(lqpublic\*(rq if you have write permission for the relevant folder. -Check the mh\-sequence(5) man page for more details about the difference +Check the +.BR mh\-sequence (5) +man page for more details about the difference between \*(lqpublic\*(rq and \*(lqprivate\*(rq sequences. - -The `\-list' switch tells \fImark\fR to list both the sequences defined +.PP +The +.B \-list +switch tells +.B mark +to list both the sequences defined for the folder and the messages associated with those sequences. -\fIMark\fR will list the name of each sequence given by -`\-sequence\ name' and the messages associated with that sequence. If the +.B Mark +will list the name of each sequence given by +.B \-sequence +.I name +and the messages associated with that sequence. If the sequence is private, this will also be indicated. If no sequence is -specified by the `\-sequence' switch, then all sequences for this folder -will be listed. The `\-zero' switch does not affect the operation of -`\-list'. - +specified by the +.B \-sequence +switch, then all sequences for this folder +will be listed. The +.B \-zero +switch does not affect the operation of +.BR \-list . +.PP The current restrictions on sequences are: - -.in +.25i +.PP +.IP \(bu 2 The name used to denote a message sequence must consist of an alphabetic character followed by zero or more alphanumeric characters, and cannot be one of the (reserved) message names \*(lqnew\*(rq, \*(lqfirst\*(rq, \*(lqlast\*(rq, \*(lqall\*(rq, \*(lqnext\*(rq, or \*(lqprev\*(rq. - +.PP +.IP \(bu 2 Only a certain number of sequences may be defined for a given folder. This number is usually limited to 26 (10 on small systems). - +.PP +.IP \(bu 2 Message ranges with user\-defined sequence names are restricted to the form \*(lqname:n\*(rq, \*(lqname:+n\*(rq, or \*(lqname:-n\*(rq, and refer to the first or last `n' messages of the sequence `name', respectively. Constructs of the form \*(lqname1\-name2\*(rq are forbidden for user defined sequences. -.in -.25i -.Fi + +.SH FILES +.fc ^ ~ +.nf +.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile -.Pr +.fi + +.SH "PROFILE COMPONENTS" +.fc ^ ~ +.nf +.ta 2.4i +.ta \w'ExtraBigProfileName 'u ^Path:~^To determine the user's nmh directory -.Ps ^Current\-Folder:~^To find the default current folder -.Sa +.fi + +.SH "SEE ALSO" flist(1), pick(1), mh-sequence(5) -.De -`+folder' defaults to the current folder -.Ds -`\-add' if `\-sequence' is specified, `\-list' otherwise -.Ds -`msgs' defaults to cur (or all if `\-list' is specified) -.Ds -`\-nozero' -.Co + +.SH DEFAULTS +.nf +.RB ` +folder "' defaults to the current folder" +.RB ` \-add "' if " \-sequence " is specified, " \-list " otherwise" +.RB ` msgs "' defaults to cur (or all if " \-list " is specified)" +.RB ` \-nozero ' + +.SH CONTEXT If a folder is given, it will become the current folder. -.Hh -Use \*(lqflist\*(rq to find folders with a given sequence, and -\*(lqpick sequence \-list\*(rq to enumerate those messages in -the sequence (such as for use by a shell script). -.En + +.SH "HELPFUL HINTS" +Use +.B flist +to find folders with a given sequence, and +.RB \*(lq pick +.I sequence +.BR \-list \*(rq +to enumerate those messages in the sequence (such as for +use by a shell script). diff --git a/man/mh-alias.man b/man/mh-alias.man index 0ee7cd4..aa3c3f1 100644 --- a/man/mh-alias.man +++ b/man/mh-alias.man @@ -2,120 +2,158 @@ .\" %nmhwarning% .\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" .TH MH-ALIAS %manext5% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME mh-alias \- alias file for nmh message system .SH SYNOPSIS -.in +.5i -.ti -.5i -any \fInmh\fR command -.in -.5i +any +.B nmh +command .SH DESCRIPTION -This describes both \fInmh\fR personal alias files and -the global alias file for nmh mail delivery, the file - - %etcdir%/MailAliases - -It does \fBnot\fR describe aliases files used by the message transport system. +This describes both +.B nmh +personal alias files and +the global alias file for +.B nmh +mail delivery, the file +.PP +.RS 5 +%etcdir%/MailAliases +.RE +.PP +It does +.B not +describe aliases files used by the message transport system. Each line of the alias file has the format: - - alias : address\-group -.br +.PP +.RS 5 +.I alias +.B : +.I address\-group +.RE or -.br - alias ; address\-group -.br +.RS 5 +.I alias +.B ; +.I address\-group +.RE or -.br - < alias\-file -.br +.RS 5 +.B < +.I alias\-file +.RE or -.br - ; comment -.br - +.RS 5 +.B ; +.I comment +.RE +.PP where: +.PP +.RS 5 +.nf +.IR address\-group " := " address\-list +.RI " | < " file +.RI " | = " UNIX\-group +.RI " | + " UNIX\-group + | * - address\-group := address\-list -.br - | \*(lq<\*(rq file -.br - | \*(lq=\*(rq UNIX\-group -.br - | \*(lq+\*(rq UNIX\-group -.br - | \*(lq*\*(rq - -.br - address\-list := address -.br - | address\-list, address -.br - +.IR address\-list " := " address +.RI " | " address\-list ", " address +.fi +.RE +.PP Continuation lines in alias files end with `\\' followed by the newline character. - -Alias\-file and file are UNIX file names. UNIX\-group is a group name -(or number) from \fI/etc/group\fR. An address is a \*(lqsimple\*(rq +.PP +.RI \*(lq Alias\-file \*(rq +and +.RI \*(lq file \*(rq +are UNIX file names. +.I UNIX\-group +is a group name (or number) from +.IR /etc/group . +An address is a \*(lqsimple\*(rq Internet\-style address. Througout this file, case is ignored, except -for alias\-file names. - +for file names. +.PP If the line starts with a `<', then the file named after the `<' is read for more alias definitions. The reading is done recursively, so a `<' may occur in the beginning of an alias file with the expected results. - -If the address\-group starts with a `<', then the file named after the -`<' is read and its contents are added to the address\-list for the alias. - -If the address\-group starts with an `=', then the file \fI/etc/group\fR +.PP +If the +.I address\-group +starts with a `<', then the file named after the +`<' is read and its contents are added to the +.I address\-list +for the alias. +.PP +If the +.I address\-group +starts with an `=', then the file +.I /etc/group is consulted for the UNIX\-group named after the `='. Each login name -occurring as a member of the group is added to the address\-list for -the alias. - -In contrast, if the address\-group starts with a `+', then the file -\fI/etc/group\fR is consulted to determine the group\-id of the +occurring as a member of the group is added to the +.I address\-list +for the alias. +.PP +In contrast, if the +.I address\-group +starts with a `+', then the file +.I /etc/group +is consulted to determine the group\-id of the UNIX\-group named after the `+'. Each login name occurring in the -\fI/etc/passwd\fR file whose group\-id is indicated by this group is -added to the address\-list for the alias. - -If the address\-group is simply `*', then the file \fI/etc/passwd\fR is -consulted and all login names with a userid greater than some magic number -(usually 200) are added to the address\-list for the alias. - -In match, a trailing * on an alias will match just about anything +.I /etc/passwd +file whose group\-id is indicated by this group is +added to the +.I address\-list +for the alias. +.PP +If the +.I address\-group +is simply `*', then the file +.I /etc/passwd +is consulted and all login names with a userid +greater than some magic number (usually 200) are added to the +.I address\-list +for the alias. +.PP +In match, a trailing \*(lq*\*(rq on an alias will match just about anything appropriate. (See example below.) - +.PP An approximation of the way aliases are resolved at posting time is (it's not really done this way): - -.in +.5i -1) Build a list of all addresses from the message to be delivered, +.PP +.RS 2 +.IP 1) 3 +Build a list of all addresses from the message to be delivered, eliminating duplicate addresses. - -2) If this draft originated on the local host, then for those addresses in +.PP +.IP 2) 3 +If this draft originated on the local host, then for those addresses in the message that have no host specified, perform alias resolution. - -3) For each line in the alias file, compare \*(lqalias\*(rq against all of +.PP +.IP 3) 3 +For each line in the alias file, compare \*(lqalias\*(rq against all of the existing addresses. If a match, remove the matched \*(lqalias\*(rq from the address list, and add each new address in the address\-group to the address list if it is not already on the list. The alias itself is not usually output, rather the address\-group that the alias maps to is output instead. If \*(lqalias\*(rq is terminated with a `;' instead of a `:', then both the \*(lqalias\*(rq and the address are output in the -correct format. (This makes replies possible since \fInmh\fR aliases +correct format. (This makes replies possible since +.B nmh +aliases and personal aliases are unknown to the mail transport system.) -.in -.5i - +.RE +.PP Since the alias file is read line by line, forward references work, but backward references are not recognized, thus, there is no recursion. - -.ne 10 -\fBExample:\fR +.PP +Example Alias File: +.PP +.RS 5 .nf -.in +.5i <%etcdir%/BBoardAliases sgroup: fred, fear, freida b-people: Blind List: bill, betty; @@ -125,74 +163,119 @@ staff: =staff wheels: +wheel everyone: * news.*: news -.in -.5i .fi - +.RE +.PP The first line says that more aliases should immediately be read from -the file \fI%etcdir%/BBoardAliases\fR. Following this, \*(lqfred\*(rq +the file +.IR %etcdir%/BBoardAliases . +Following this, \*(lqfred\*(rq is defined as an alias for \*(lqfrated@UCI\*(rq, and \*(lqsgroup\*(rq is defined as an alias for the three names \*(lqfrated@UCI\*(rq, \*(rqfear\*(rq, and \*(rqfreida\*(rq. -.sp +.PP The alias \*(lqb-people\*(rq is a blind list which includes the addresses \*(lqbill\*(rq and \*(lqbetty\*(rq; the message will be delieved to those addresses, but the message header will show only \*(lqBlind List: ;\*(rq (not the addresses). -.sp +.PP Next, the definition of \*(lqUNIX\-committee\*(rq is given by -reading the file \fIunix.aliases\fR in the users \fInmh\fR directory, +reading the file +.I unix.aliases +in the users +.B nmh +directory, \*(lqstaff\*(rq is defined as all users who are listed as members of the -group \*(lqstaff\*(rq in the \fI/etc/group\fR file, and \*(lqwheels\*(rq -is defined as all users whose group\-id in \fI/etc/passwd\fR is equivalent -to the \*(lqwheel\*(rq group. -.sp +group \*(lqstaff\*(rq in the +.I /etc/group +file, and \*(lqwheels\*(rq +is defined as all users whose group\-id in +.I /etc/passwd +is equivalent to the \*(lqwheel\*(rq group. +.PP Finally, \*(lqeveryone\*(rq is defined as all users with a user\-id -in \fI/etc/passwd\fR greater than 200, and all aliases of the form +in +.I /etc/passwd +greater than 200, and all aliases of the form \*(lqnews.\*(rq are defined to be \*(lqnews\*(rq. - -The key thing to understand about aliasing in \fInmh\fR is that aliases -in \fInmh\fR alias files are expanded into the headers of messages posted. +.PP +The key thing to understand about aliasing in +.B nmh +is that aliases in +/B nmh +lias files are expanded into the headers of messages posted. This aliasing occurs first, at posting time, without the knowledge of the message transport system. In contrast, once the message transport system is given a message to deliver to a list of addresses, for each address that appears to be local, a system\-wide alias file is consulted. These -aliases are \fBNOT\fR expanded into the headers of messages delivered. -.Hh -To use aliasing in \fInmh\fR quickly, do the following: - -.in +.5i -First, in your \fI\&.mh\(ruprofile\fR, choose a name for your alias -file, say \*(lqaliases\*(rq, and add the line: +aliases are +.B NOT +expanded into the headers of messages delivered. +.SH "HELPFUL HINTS" +To use aliasing in +.B nmh +quickly, do the following: +.PP +.RS 2 +.IP 1) 3 +In your +.IR \&.mh\(ruprofile , +choose a name for your alias file, say +.RI \*(lq aliases \*(rq, +and add the line: +.PP +.RS 5 .nf -.in +.5i Aliasfile: aliases .\" ali: \-alias aliases .\" send: \-alias aliases .\" whom: \-alias aliases -.in -.5i .fi +.RE +.PP +.IP 2) 3 +Create the file +.RI \*(lq aliases \*(rq +in your +.B nmh +directory. +.PP +.IP 3) 3 +Start adding aliases to your +.RI \*(lq aliases \*(rq +file as appropriate. +.RE -Second, create the file \*(lqaliases\*(rq in your \fInmh\fR directory. - -Third, start adding aliases to your \*(lqaliases\*(rq file as appropriate. -.in -.5i -.Fi +.SH FILES +.fc ^ ~ +.nf +.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^%etcdir%/MailAliases~^global nmh alias file -.Pr +.fi + +.SH "PROFILE COMPONENTS" +.fc ^ ~ +.nf +.ta 2.4i +.ta \w'ExtraBigProfileName 'u ^Aliasfile:~^For a default alias file -.Sa +.fi + +.SH "SEE ALSO" ali(1), send(1), whom(1), group(5), passwd(5), conflict(8), post(8) -.De -None -.Co + +.SH CONTEXT None -.Bu -Although the forward-referencing semantics of \fImh\-alias\fR files -prevent recursion, the \*(lq<\ alias\-file\*(rq command may defeat this. + +.SH BUGS +Although the forward-referencing semantics of +.B mh\-alias +files prevent recursion, the +.RI \*(lq< " alias\-file" \*(rq +command may defeat this. Since the number of file descriptors is finite (and very limited), such infinite recursion will terminate with a meaningless diagnostic when all the fds are used up. -.sp +.PP Forward references do not work correctly inside blind lists. -.En -- 1.7.10.4