diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/muttrc.man.head | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/muttrc.man.head b/doc/muttrc.man.head index 4470b219..bd5edc72 100644 --- a/doc/muttrc.man.head +++ b/doc/muttrc.man.head @@ -71,8 +71,11 @@ in backticks (\fB`\fP\fIcommand\fP\fB`\fP). UNIX environment variables can be accessed like the way it is done in shells like sh and bash: Prepend the name of the variable by a dollar (\(lq\fB\(Do\fP\(rq) sign. +. +. .PP .SH COMMANDS +. .PP .nf \fBalias\fP [\fB-group\fP \fIname\fP [...]] \fIkey\fP \fIaddress\fP [\fB,\fP \fIaddress\fP [ ... ]] @@ -87,6 +90,7 @@ Name)\(rq. all aliases when \(lq\fB*\fP\(rq is used as an argument. The optional \fB-group\fP argument to \fBalias\fP causes the aliased address(es) to be added to the named \fIgroup\fP. +. .PP .nf \fBgroup\fP [\fB-group\fP \fIname\fP] [\fB-rx\fP \fIEXPR\fP [ \fI...\fP ]] [\fB-addr\fP \fIaddress\fP [ \fI...\fP ]] @@ -109,6 +113,7 @@ 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 [ \fIregexp\fP [ ... ]] @@ -121,6 +126,7 @@ alternate addresses. This affects mutt's idea about messages from you, and messages addressed to you. \fBunalternates\fP removes a regular expression from the list of known alternates. The \fB-group\fP flag causes all of the subsequent regular expressions to be added to the named group. +. .PP .nf \fBalternative_order\fP \fItype\fP[\fB/\fP\fIsubtype\fP] [ ... ] @@ -134,6 +140,7 @@ A subtype of \(lq\fB*\fP\(rq matches any subtype, as does an empty subtype. \fBunalternative_order\fP removes entries from the ordered list or deletes the entire list when \(lq\fB*\fP\(rq is used as an argument. +. .PP .nf \fBauto_view\fP \fItype\fP[\fB/\fP\fIsubtype\fP] [ ... ] @@ -148,6 +155,7 @@ entry for the given MIME type with the .B copiousoutput flag set. A subtype of \(lq\fB*\fP\(rq matches any subtype, as does an empty subtype. +. .PP .nf \fBmime_lookup\fP \fItype\fP[\fB/\fP\fIsubtype\fP] [ ... ] @@ -160,6 +168,7 @@ the file name, and not use a .BR mailcap (5) entry given for the original MIME type. For instance, you may add the \fBapplication/octet-stream\fP MIME type to this list. +. .TP \fBbind\fP \fImap1,map2,...\fP \fIkey\fP \fIfunction\fP This command binds the given \fIkey\fP for the given \fImap\fP or maps @@ -176,15 +185,18 @@ Valid maps are: For more information on keys and functions, please consult the Mutt Manual. Note that the function name is to be specified without angle brackets. +. .TP \fBaccount-hook\fP [\fB!\fP]\fIregexp\fP \fIcommand\fP This hook is executed whenever you access a remote mailbox. Useful to adjust configuration settings to different IMAP or POP servers. +. .TP \fBcharset-hook\fP \fIalias\fP \fIcharset\fP This command defines an alias for a character set. This is useful to properly display messages which are tagged with a character set name not known to mutt. +. .TP \fBiconv-hook\fP \fIcharset\fP \fIlocal-charset\fP This command defines a system-specific name for a character set. @@ -198,6 +210,7 @@ character set names (such as In this specific case, you'd put this into your configuration file: .IP .B "iconv-hook iso-8859-1 8859-1" +. .TP \fBmessage-hook\fP [\fB!\fP]\fIpattern\fP \fIcommand\fP Before mutt displays (or formats for replying or forwarding) a @@ -206,6 +219,7 @@ preceded by an exclamation mark, does not match the \fIpattern\fP), the given \fIcommand\fP is executed. When multiple \fBmessage-hook\fPs match, they are executed in the order in which they occur in the configuration file. +. .TP \fBfolder-hook\fP [\fB!\fP]\fIregexp\fP \fIcommand\fP When mutt enters a folder which matches \fIregexp\fP (or, when @@ -214,6 +228,7 @@ When mutt enters a folder which matches \fIregexp\fP (or, when .IP When several \fBfolder-hook\fPs match a given mail folder, they are executed in the order given in the configuration file. +. .TP \fBmacro\fP \fImap\fP \fIkey\fP \fIsequence\fP [ \fIdescription\fP ] This command binds the given \fIsequence\fP of keys to the given @@ -255,6 +270,7 @@ Valid colors include: Valid attributes include: .BR none ", " bold ", " underline ", " .BR reverse ", and " standout . +. .PP .nf \fBmono\fP \fIobject\fP \fIattribute\fP [ \fIregexp\fP ] @@ -263,6 +279,7 @@ Valid attributes include: .IP For terminals which don't support color, you can still assign attributes to objects. +. .TP [\fBun\fP]\fBignore\fP \fIpattern\fP [ \fIpattern\fP ... ] The \fBignore\fP command permits you to specify header fields which @@ -271,6 +288,7 @@ you usually don't wish to see. Any header field whose tag .IP The \fBunignore\fP command permits you to define exceptions from the above mentioned list of ignored headers. +. .PP .nf \fBlists\fP [\fB-group\fP \fIname\fP] \fIregexp\fP [ \fIregexp\fP ... ] @@ -290,6 +308,7 @@ list from the lists of known and subscribed mailing lists. The and subscribed mailing lists. The \fBunsubscribe\fP command removes it from the list of subscribed mailing lists. The \fB-group\fP flag adds all of the subsequent regular expressions to the named group. +. .TP \fBmbox-hook\fP [\fB!\fP]\fIregexp\fP \fImailbox\fP When mutt changes to a mail folder which matches \fIregexp\fP, @@ -297,6 +316,7 @@ When mutt changes to a mail folder which matches \fIregexp\fP, messages will be moved to that folder when the mail folder is left. .IP The first matching \fBmbox-hook\fP applies. +. .PP .nf \fBmailboxes\fP [[\fB-poll\fP | \fB-nopoll\fP] [[\fB-label\fP \fIlabel\fP] | \fB-nolabel\fP] \fIfilename\fP] [ ... ] @@ -309,6 +329,7 @@ will cycle through folders with new mail. The \fBunmailboxes\fP command is used to remove a file name from the list of folders which can receive mail. If "\fB*\fP" is specified as the file name, the list is emptied. +. .PP .nf \fBmy_hdr\fP \fIstring\fP @@ -318,27 +339,33 @@ list is emptied. Using \fBmy_hdr\fP, you can define headers which will be added to the messages you compose. \fBunmy_hdr\fP will remove the given user-defined headers. +. .TP \fBhdr_order\fP \fIheader1\fP \fIheader2\fP [ ... ] With this command, you can specify an order in which mutt will attempt to present headers to you when viewing messages. +. .TP \fBsave-hook\fP [\fB!\fP]\fIpattern\fP \fIfilename\fP When a message matches \fIpattern\fP, the default file name when saving it will be the given \fIfilename\fP. +. .TP \fBfcc-hook\fP [\fB!\fP]\fIpattern\fP \fIfilename\fP When an outgoing message matches \fIpattern\fP, the default file name for storing a copy (fcc) will be the given \fIfilename\fP. +. .TP \fBfcc-save-hook\fP [\fB!\fP]\fIpattern\fP \fIfilename\fP This command is an abbreviation for identical \fBfcc-hook\fP and \fBsave-hook\fP commands. +. .TP \fBsend-hook\fP [\fB!\fP]\fIpattern\fP \fIcommand\fP When composing a message matching \fIpattern\fP, \fIcommand\fP is executed. When multiple \fBsend-hook\fPs match, they are executed in the order in which they occur in the configuration file. +. .TP \fBsend2-hook\fP [\fB!\fP]\fIpattern\fP \fIcommand\fP Whenever a message matching \fIpattern\fP is changed (either by @@ -350,6 +377,7 @@ message's from header is changed. .IP \fBsend2-hook\fP execution is not triggered by use of \fBenter-command\fP from the compose menu. +. .TP \fBreply-hook\fP [\fB!\fP]\fIpattern\fP \fIcommand\fP When replying to a message matching \fIpattern\fP, \fIcommand\fP is @@ -357,6 +385,7 @@ executed. When multiple \fBreply-hook\fPs match, they are executed in the order in which they occur in the configuration file, but all \fBreply-hook\fPs are matched and executed before \fBsend-hook\fPs, regardless of their order in the configuration file. +. .TP \fBcrypt-hook\fP \fIregexp\fP \fIkey-id\fP The crypt-hook command provides a method by which you can @@ -368,6 +397,7 @@ You may use multiple \fBcrypt-hook\fPs with the same \fIregexp\fP; multiple matching \fBcrypt-hook\fPs result in the use of multiple \fIkey-id\fPs for a recipient. +. .TP \fBindex-format-hook\fP \fIname\fP [\fB!\fP]\fIpattern\fP \fIformat-string\fP This command is used to inject format strings dynamically into @@ -378,6 +408,7 @@ the injection. Index-format-hooks with the same \fIname\fP are matched using \fIpattern\fP against the current message. Matching is done in the order specified in the .muttrc, with the first match being used. The hook's \fIformat-string\fP is then substituted and evaluated. +. .PP .nf \fBopen-hook\fP \fIregexp\fP "\fIcommand\fP" @@ -396,9 +427,11 @@ like format string, and it should accept two parameters: \fB%f\fP, which is replaced with the (compressed) folder name, and \fB%t\fP which is replaced with the name of the temporary folder to which to write. +. .TP \fBpush\fP \fIstring\fP This command adds the named \fIstring\fP to the keyboard buffer. +. .PP .nf \fBset\fP [\fBno\fP|\fBinv\fP|\fB&\fP|\fB?\fP]\fIvariable\fP[=\fIvalue\fP] [ ... ] @@ -432,9 +465,11 @@ default answer of \(lqno.\(rq The \fBreset\fP command resets all given variables to the compile time defaults. If you reset the special variable \fBall\fP, all variables will reset to their compile time defaults. +. .TP \fBsource\fP \fIfilename\fP The given file will be evaluated as a configuration file. +. .PP .nf \fBspam\fP \fIpattern\fP \fIformat\fP @@ -445,6 +480,7 @@ These commands define spam-detection patterns from external spam filters, so that mutt can sort, limit, and search on ``spam tags'' or ``spam attributes'', or display them in the index. See the Mutt manual for details. +. .PP .nf \fBsubjectrx\fP \fIpattern\fP \fIreplacement\fP @@ -466,11 +502,13 @@ subject, not just the match! \fBunsubjectrx\fP removes a given \fBsubjectrx\fP from the substitution list. If \fB*\fP is used as the pattern, all substitutions will be removed. +. .TP \fBunhook\fP [\fB * \fP | \fIhook-type\fP ] This command will remove all hooks of a given type, or all hooks when \(lq\fB*\fP\(rq is used as an argument. \fIhook-type\fP can be any of the \fB-hook\fP commands documented above. +. .PP .nf \fBmailto_allow\fP \fIheader-field\fP [ ... ] @@ -481,14 +519,18 @@ These commands allow the user to modify the list of allowed header fields in a \fImailto:\fP URL that Mutt will include in the the generated message. By default the list contains only \fBsubject\fP and \fBbody\fP, as specified by RFC2368. +. .TP \fBecho\fP \fImessage\fP Prints \fImessage\fP to the message window. After printing the message, echo will pause for the number of seconds specified by $sleep_time. +. .TP \fBcd\fP \fIdirectory\fP Changes the current working directory. +. +. .SH PATTERNS .PP In various places with mutt, including some of the above mentioned |