From 5cf1ccd81a0a1778b4bc2f4be11c0511bfe95598 Mon Sep 17 00:00:00 2001 From: Rocco Rutte Date: Thu, 15 Mar 2007 08:48:04 -0700 Subject: [PATCH] Document pattern groups in the manual Sync with muttrc. Add some rationale for groups. Fix some style issues. Fix quoting issue with $smtp_authenticators. --- doc/manual.xml.head | 89 +++++++++++++++++++++++++++++++++++++++------ doc/muttrc.man.head | 32 ++++++++++------ init.h | 2 +- 3 files changed, 100 insertions(+), 23 deletions(-) diff --git a/doc/manual.xml.head b/doc/manual.xml.head index 5e6af5dd..c60f496e 100644 --- a/doc/manual.xml.head +++ b/doc/manual.xml.head @@ -1523,11 +1523,56 @@ For a complete list, see the command reference. + +Address groups + + +Usage: group [ -group name [ ... ] ] [ -rx EXPR [ ... ] ] [ -addr EXPR [ ... ] ] + + + +group is used to directly add either addresses or +regular expressions to the specified group or groups. The different +categories of arguments to the group command can be +in any order. The flags -rx and +-addr specify what the following strings (that cannot +begin with a hyphen) should be interpreted as: either a regular +expression or an email address, respectively. + + + +These address groups can also be created implicitely by the +alias, lists, +subscribe and +alternates commands by specifying the +optional -group option. + + + +Once defined, these address groups can be used in +patterns to search for and limit the +display to messages matching a group. + + + +Usage: ungroup [ -group name [ ... ] ] [ * | [ [ -rx EXPR [ ... ] ] [ -addr EXPR [ ... ] ] ] + + + +ungroup is used to remove addresses or regular +expressions from the specified group or groups. The syntax is similar to +the group command, however the special character +* can be used to empty a group of all of its +contents. + + + + Defining/Using aliases -Usage: alias key address [ , address, ... ] +Usage: alias [ -group name [ ... ] ] key address [ , address, ... ] @@ -1537,8 +1582,14 @@ a short string to a full address. -Note: if you want to create an alias for a group (by specifying more than -one address), you must separate the addresses with a comma (``,''). +Note: if you want to create an alias for more than +one address, you must separate the addresses with a comma (``,''). + + + +The optional -group argument to +alias causes the aliased address(es) to be added to +the named group. @@ -2286,7 +2337,7 @@ unignore posted-to: Alternative addresses -Usage: [un]alternates regexp [ regexp ... ] +Usage: [un]alternates [ -group name [ ... ] ] regexp [ regexp ... ] @@ -2308,6 +2359,11 @@ expressions, each of which can identify an address under which you receive e-mail. + +The -group flag causes all of the subsequent regular expressions +to be added to the named group. + + The unalternates command can be used to write exceptions to alternates patterns. If an address matches something in an @@ -2332,8 +2388,8 @@ is ``*'', all entries on alternates will -Usage: [un]lists regexp [ regexp ... ] -Usage: [un]subscribe regexp [ regexp ... ] +Usage: [un]lists [ -group name [ ... ] ] regexp [ regexp ... ] +Usage: [un]subscribe [ -group name [ ... ] ] regexp [ regexp ... ] @@ -2361,7 +2417,7 @@ command. To mark it as subscribed, use ``subscribe''. You can use regular expressions with both commands. To mark all messages sent to a specific bug report's address on mutt's bug tracking system as list mail, for instance, you could say -``subscribe [0-9]*@bugs.guug.de''. Often, it's sufficient to just +``subscribe [0-9]*@bugs.guug.de''. Often, it's sufficient to just give a portion of the list's e-mail address. @@ -2379,6 +2435,11 @@ or ``subscribe ^mutt-users@mutt\\.org$'' to match only mail from the actual list. + +The -group flag adds all of the subsequent regular expressions +to the named group. + + The ``unlists'' command is used to remove a token from the list of known and subscribed mailing-lists. Use ``unlists *'' to remove all @@ -3607,15 +3668,20 @@ messages: ~Aall messages ~b EXPRmessages which contain EXPR in the message body +=b STRINGmessages which contain STRING in the message body. If IMAP is enabled, searches for STRING on the server, rather than downloading each message and searching it locally. ~B EXPRmessages which contain EXPR in the whole message ~c EXPRmessages carbon-copied to EXPR +%c GROUPmessages carbon-copied to any member of GROUP ~C EXPRmessage is either to: or cc: EXPR +%C GROUPmessage is either to: or cc: to any member of GROUP ~d [MIN]-[MAX]messages with ``date-sent'' in a Date range ~Ddeleted messages ~e EXPRmessage which contains EXPR in the ``Sender'' field +%e GROUPmessage which contain a member of GROUP in the ``Sender'' field ~Eexpired messages ~Fflagged messages ~f EXPRmessages originating from EXPR +%f GROUPmessages originating from any member of GROUP ~gcryptographically signed messages ~Gcryptographically encrypted messages ~h EXPRmessages which contain EXPR in the message header @@ -3623,6 +3689,7 @@ messages: ~i EXPRmessage which match EXPR in the ``Message-ID'' field ~kmessage contains PGP key material ~L EXPRmessage is either originated or received by EXPR +%L GROUPmessage is either originated or received by any member of GROUP ~lmessage is addressed to a known mailing list ~m [MIN]-[MAX]message in the range MIN to MAX *) ~n [MIN]-[MAX]messages with a score in the range MIN to MAX *) @@ -5946,7 +6013,7 @@ The following are the commands understood by mutt. -alias key address [ , address, ... ] +alias [ -group name [ ... ] ] key address [ , address, ... ] @@ -5958,7 +6025,7 @@ The following are the commands understood by mutt. -alternates regexp [ regexp ... ] +alternates [ -group name [ ... ] ] regexp [ regexp ... ] @@ -6072,7 +6139,7 @@ The following are the commands understood by mutt. -lists regexp [ regexp ... ] +lists [ -group name [ ... ] ] regexp [ regexp ... ] @@ -6228,7 +6295,7 @@ The following are the commands understood by mutt. -subscribe regexp [ regexp ... ] +subscribe [ -group name [ ... ] ] regexp [ regexp ... ] diff --git a/doc/muttrc.man.head b/doc/muttrc.man.head index d709c478..d269a058 100644 --- a/doc/muttrc.man.head +++ b/doc/muttrc.man.head @@ -87,13 +87,20 @@ added to the named \fIgroup\fP. .IP \fBgroup\fP is used to directly add either addresses or regular expressions to the specified group or groups. The different categories of arguments to the -\fBgroup\fP command can be in any order. The flags \fB-rx\fP and \fB-addr\fP +\fBgroup\fP command can be in any order. The flags \fI-rx\fP and \fI-addr\fP specify what the following strings (that cannot begin with a hyphen) should be interpreted as: either a regular expression or an email address, respectively. \fBungroup\fP is used to remove addresses or regular expressions from the specified group or groups. The syntax is similar to the \fBgroup\fP command, however the special character \fB*\fP can be used to empty a group of all of its contents. +.IP +These address groups can also be created implicitely by the \fBalias\fP, \fBlists\fP, +\fBsubscribe\fP and \fBalternates\fP commands by specifying the optional \fI-group\fP +option. +.IP +Once defined, these address groups can be used in patterns to search for and limit the +display to messages matching a group. .PP .nf \fBalternates\fP [\fB-group\fP \fIname\fP] \fIregexp\fP [ \fB,\fP \fIregexp\fP [ ... ]] @@ -439,14 +446,14 @@ messages which contain \fIEXPR\fP in the whole message. ~c \fIEXPR\fP messages carbon-copied to \fIEXPR\fP .TP -%c \fIgroup\fP -messages carbon-copied to any member of \fIgroup\fP +%c \fIGROUP\fP +messages carbon-copied to any member of \fIGROUP\fP .TP ~C \fIEXPR\fP messages either to: or cc: \fIEXPR\fP .TP -%C \fIgroup\fP -messages either to: or cc: to any member of \fIgroup\fP +%C \fIGROUP\fP +messages either to: or cc: to any member of \fIGROUP\fP .TP ~d \fIMIN\fP-\fIMAX\fP messages with \(lqdate-sent\(rq in a Date range @@ -457,8 +464,8 @@ deleted messages ~e \fIEXPR\fP messages which contain \fIEXPR\fP in the \(lqSender\(rq field .TP -%e \fIgroup\fP -messages which contain a member of \fIgroup\fP in the \(lqSender\(rq field +%e \fIGROUP\fP +messages which contain a member of \fIGROUP\fP in the \(lqSender\(rq field .TP ~E expired messages @@ -466,8 +473,8 @@ expired messages ~f \fIEXPR\fP messages originating from \fIEXPR\fP .TP -%f \fIgroup\fP -messages originating form any member of \fIgroup\fP +%f \fIGROUP\fP +messages originating form any member of \fIGROUP\fP .TP ~F flagged messages @@ -496,8 +503,8 @@ messages addressed to a known mailing list (defined by either \fBsubscribe\fP or ~L \fIEXPR\fP messages either originated or received by \fIEXPR\fP .TP -%L \fIgroup\fP -messages either originated or received by any member of \fIgroup\fP +%L \fIGROUP\fP +messages either originated or received by any member of \fIGROUP\fP .TP ~m \fIMIN\fP-\fIMAX\fP message in the range \fIMIN\fP to \fIMAX\fP @@ -567,6 +574,9 @@ duplicated messages (see $duplicate_threads) .TP ~$ unreferenced message (requries threaded view) +.TP +~(PATTERN) +messages in threads containing messages matching a certain pattern, e.g. all threads containing messages from you: ~(~P) .PD 1 .DT .PP diff --git a/init.h b/init.h index 230479e1..3ef28e0e 100644 --- a/init.h +++ b/init.h @@ -2620,7 +2620,7 @@ struct option_t MuttVars[] = { ** This is a colon-delimited list of authentication methods mutt may ** attempt to use to log in to an SMTP server, in the order mutt should ** try them. Authentication methods are any SASL mechanism, eg - ** 'digest-md5', 'gssapi' or 'cram-md5'. + ** ``digest-md5'', ``gssapi'' or ``cram-md5''. ** This parameter is case-insensitive. If this parameter is unset ** (the default) mutt will try all available methods, in order from ** most-secure to least-secure. -- 2.40.0