]> granicus.if.org Git - neomutt/commitdiff
doc/neomuttrc.man.head: Small tidying
authorFloyd Anderson <f.a@31c0.net>
Tue, 20 Mar 2018 16:11:48 +0000 (17:11 +0100)
committerRichard Russon <rich@flatcap.org>
Wed, 25 Apr 2018 02:02:17 +0000 (03:02 +0100)
doc/neomuttrc.man.head

index c1430242f16157b2cd8cb0b0a34122bc590b9b62..e9403147906186e5d5f181a3aacf5bcf908a4a6a 100644 (file)
@@ -31,7 +31,7 @@
 neomuttrc \- Configuration file for the NeoMutt Mail User Agent
 .SH DESCRIPTION
 .PP
-A neomutt configuration file consists of a series of \(lqcommands\(rq.
+A NeoMutt configuration file consists of a series of \(lqcommands\(rq.
 Each line of the file may contain one or more commands.  When
 multiple commands are used, they must be separated by a semicolon
 (\(lq\fB;\fP\(rq).
@@ -83,7 +83,7 @@ to adjust configuration settings to different IMAP or POP servers.
 .PP
 .nf
 \fBalias\fP [\fB-group\fP \fIname\fP [...]] \fIkey\fP \fIaddress\fP [\fB,\fP \fIaddress\fP [ ... ]]
-\fBunalias\fP [\fB * \fP | \fIkey\fP ]
+\fBunalias\fP [ \fB*\fP | \fIkey\fP ]
 .fi
 .IP
 \fBalias\fP defines an alias \fIkey\fP for the given addresses. Each
@@ -97,23 +97,23 @@ added to the named \fIgroup\fP.
 .PP
 .nf
 \fBalternates\fP [\fB-group\fP \fIname\fP] \fIregex\fP [ \fIregex\fP [ ... ]]
-\fBunalternates\fP [\fB * \fP | \fIregex\fP [ \fIregex\fP [ ... ]] ]
+\fBunalternates\fP [ \fB*\fP | \fIregex\fP [ \fIregex\fP [ ... ]] ]
 .fi
 .IP
-\fBalternates\fP is used to inform neomutt about alternate addresses
+\fBalternates\fP is used to inform NeoMutt about alternate addresses
 where you receive mail; you can use regular expressions to specify
-alternate addresses.  This affects neomutt's idea about messages
+alternate addresses.  This affects NeoMutt'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] [ ... ]
-\fBunalternative_order\fP [\fB * \fP | \fItype\fP/\fIsubtype\fP] [...]
+\fBunalternative_order\fP [ \fB*\fP | \fItype\fP/\fIsubtype\fP] [...]
 .fi
 .IP
 \fBalternative_order\fP command permits you to define an order of preference which is
-used by neomutt to determine which part of a
+used by NeoMutt to determine which part of a
 \fBmultipart/alternative\fP body to display.
 A subtype of \(lq\fB*\fP\(rq matches any subtype, as does an empty
 subtype.   \fBunalternative_order\fP removes entries from the
@@ -139,8 +139,8 @@ which is replaced with the name of the temporary folder to which to
 write.
 .PP
 .nf
-\fBattachments\fP [\fB + \fP | \fB-\fP ]\fIdisposition\fP \fImime-type\fP
-\fBunattachments\fP [\fB + \fP | \fB-\fP ]\fIdisposition\fP \fImime-type\fP
+\fBattachments\fP [ \fB+\fP | \fB-\fP ]\fIdisposition\fP \fImime-type\fP
+\fBunattachments\fP [ \fB+\fP | \fB-\fP ]\fIdisposition\fP \fImime-type\fP
 .fi
 .IP
 You can make your message index display the number of qualifying attachments in
@@ -162,7 +162,7 @@ matches any MIME type.)
 \fBunauto_view\fP \fItype\fP[\fB/\fP\fIsubtype\fP] [ ... ]
 .fi
 .IP
-This commands permits you to specify that neomutt should automatically
+This commands permits you to specify that NeoMutt should automatically
 convert the given MIME types to text/plain when displaying messages.
 For this to work, there must be a
 .BR mailcap (5)
@@ -172,11 +172,11 @@ flag set.  A subtype of \(lq\fB*\fP\(rq
 matches any subtype, as does an empty subtype.
 .PP
 .nf
-\fBbind\fP \fImap1,map2,...\fP \fIkey\fP \fIfunction\fP
+\fBbind\fP \fImenu1,menu2,...\fP \fIkey\fP \fIfunction\fP
 .fi
 .IP
-This command binds the given \fIkey\fP for the given \fImap\fP or maps
-to the given \fIfunction\fP. Multiple maps may be specified by
+This command binds the given \fIkey\fP for the given \fImenu\fP or \fImenu\fPs
+to the given \fIfunction\fP. Multiple menus may be specified by
 separating them with commas (no whitespace is allowed).
 .IP
 Valid maps are:
@@ -196,7 +196,7 @@ angle brackets.
 .IP
 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 neomutt.
+name not known to NeoMutt.
 .PP
 .nf
 \fBcolor\fP \fIobject\fP \fIforeground\fP \fIbackground\fP [ \fIregex\fP ]
@@ -231,8 +231,8 @@ Valid colors include:
 .IP
 The crypt-hook command provides a method by which you can
 specify the ID of the public key to be used when encrypting messages
-to a certain recipient.  The meaning of "key ID" is to be taken
-broadly: This can be a different e-mail address, a numerical key ID,
+to a certain recipient.  The meaning of \fIkey-id\fP is to be taken
+broadly: This can be a different e-mail address, a numerical \fIkey-id\fP,
 or even just an arbitrary search string.
 You may use multiple
 \fBcrypt-hook\fPs with the same \fIregex\fP; multiple matching
@@ -267,7 +267,7 @@ saving it will be the given \fIfilename\fP.
 \fBfolder-hook\fP [\fB!\fP]\fIregex\fP \fIcommand\fP
 .fi
 .IP
-When neomutt enters a folder which matches \fIregex\fP (or, when
+When NeoMutt enters a folder which matches \fIregex\fP (or, when
 \fIregex\fP is preceded by an exclamation mark, does not match
 \fIregex\fP), the given \fIcommand\fP is executed.
 .IP
@@ -286,8 +286,8 @@ 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.
+however the special character \(lq\fB*\fP\(rq can be used to empty a group of
+all of its contents.
 .IP
 These address groups can also be created implicitly by the \fBalias\fP, \fBlists\fP,
 \fBsubscribe\fP and \fBalternates\fP commands by specifying the optional \fI-group\fP
@@ -410,7 +410,7 @@ mailto links from mailing lists.
 \fBmbox-hook\fP [\fB!\fP]\fIregex\fP \fImailbox\fP
 .fi
 .IP
-When neomutt changes to a mail folder which matches \fIregex\fP,
+When NeoMutt changes to a mail folder which matches \fIregex\fP,
 \fImailbox\fP will be used as the \(lqmbox\(rq folder, i.e., read
 messages will be moved to that folder when the mail folder is left.
 .IP
@@ -420,7 +420,7 @@ The first matching \fBmbox-hook\fP applies.
 \fBmessage-hook\fP [\fB!\fP]\fIpattern\fP \fIcommand\fP
 .fi
 .IP
-Before neomutt displays (or formats for replying or forwarding) a
+Before NeoMutt displays (or formats for replying or forwarding) a
 message which matches the given \fIpattern\fP (or, when it is
 preceded by an exclamation mark, does not match the \fIpattern\fP),
 the given \fIcommand\fP is executed.  When multiple
@@ -433,7 +433,7 @@ which they occur in the configuration file.
 .fi
 .IP
 This command permits you to define a list of \(lqdata\(rq MIME content
-types for which neomutt will try to determine the actual file type from
+types for which NeoMutt will try to determine the actual file type from
 the file name, and not use a
 .BR mailcap (5)
 entry given for the original MIME type.  For instance, you may add
@@ -560,7 +560,7 @@ You can also query current environment \fIvalue\fPs by prefixing a
 \fBshutdown-hook\fP \fIcommand\fP
 .fi
 .IP
-Before neomutt is about to exit, and before the mailbox is closed, neomutt will run
+Before NeoMutt is about to exit, and before the mailbox is closed, NeoMutt will run
 the shutdown hook for the given \fIcommand\fP.
 .PP
 .nf
@@ -588,7 +588,7 @@ The given file will be evaluated as a configuration file.
 .fi
 .IP
 These commands define spam-detection patterns from external spam
-filters, so that neomutt can
+filters, so that NeoMutt can
 .BR sort ", " limit ", and " search
 on \(lqspam tags\(rq or \(lqspam attributes\(rq, or \fBdisplay\fP them
 in the index. See the NeoMutt manual for details.
@@ -597,7 +597,7 @@ in the index. See the NeoMutt manual for details.
 \fBstartup-hook\fP \fIcommand\fP
 .fi
 .IP
-Before neomutt opens the first mailbox when first starting, neomutt will run the
+Before NeoMutt opens the first mailbox when first starting, NeoMutt will run the
 startup hook for the given \fIcommand\fP.
 .PP
 .nf
@@ -618,7 +618,7 @@ Note this well: the \fIreplacement\fP value replaces the entire
 subject, not just the match!
 .IP
 \fBunsubjectrx\fP removes a given \fBsubjectrx\fP from the
-substitution list. If \fB*\fP is used as the pattern, all
+substitution list. If \(lq\fB*\fP\(rq is used as the pattern, all
 substitutions will be removed.
 .PP
 .nf
@@ -629,7 +629,7 @@ Run a command periodically when NeoMutt checks for new mail.
 This hook is called every $timeout seconds.
 .PP
 .nf
-\fBunhook\fP [\fB * \fP | \fIhook-type\fP ]
+\fBunhook\fP [ \fB*\fP | \fIhook-type\fP ]
 .fi
 .IP
 This command will remove all hooks of a given type, or all hooks
@@ -638,13 +638,13 @@ can be any of the \fB-hook\fP commands documented above.
 .PP
 .SH PATTERNS
 .PP
-In various places with neomutt, including some of the above mentioned
+In various places with NeoMutt, including some of the above mentioned
 \fBhook\fP commands, you can specify patterns to match messages.
 .SS Constructing Patterns
 .PP
 A simple pattern consists of an operator of the form
 \(lq\fB~\fP\fIcharacter\fP\(rq, possibly followed by a parameter
-against which neomutt is supposed to match the object specified by
+against which NeoMutt is supposed to match the object specified by
 this operator.  For some \fIcharacter\fPs, the \fB~\fP may be
 replaced by another character to alter the behavior of the match.
 These are described in the list of operators, below.
@@ -844,12 +844,12 @@ followed by a year specifications.  Omitted fields default to the
 current month and year.
 .PP
 NeoMutt understands either two or four digit year specifications.  When
-given a two-digit year, neomutt will interpret values less than 70 as
+given a two-digit year, NeoMutt will interpret values less than 70 as
 lying in the 21st century (i.e., \(lq38\(rq means 2038 and not 1938,
 and \(lq00\(rq is interpreted as 2000), and values
 greater than or equal to 70 as lying in the 20th century.
 .PP
-Note that this behavior \fIis\fP Y2K compliant, but that neomutt
+Note that this behavior \fIis\fP Y2K compliant, but that NeoMutt
 \fIdoes\fP have a Y2.07K problem.
 .PP
 If a date range consists of a single date, the operator in question