- $word will be converted to a reference to word, where appropriate.
Note that $$word is possible as well.
-
- (Not yet implemented in makedoc, but please use it nevertheless
- when writing documentation!)
+ Use $$$ to get a literal $ without making a reference.
- '. ' in the beginning of a line expands to two space characters.
This is used to protect indentations in tables.
The <tt/score/ commands adds <em/value/ to a message's score if <em/pattern/
matches it. <em/pattern/ is a string in the format described in the <ref
-id="pattern" name="patterns"> section. <em/value/ is a positive or
+id="patterns" name="patterns"> section. <em/value/ is a positive or
negative integer. A message's final score is the sum total of all matching
<tt/score/ entries. However, you may optionally prefix <em/value/ with an
equal sign (=) to cause evaluation to stop at a particular entry if there is
<sect1>Regular Expressions<label id="regexp">
<p>
All string patterns in Mutt including those in more complex
-<ref id="pattern" name="patterns"> must be specified
+<ref id="patterns" name="patterns"> must be specified
using regular expressions (regexp) in the ``POSIX extended'' syntax (which
is more or less the syntax used by egrep and GNU awk). For your
convenience, we have included below a brief description of this syntax.
Please note however that these operators are not defined by POSIX, so
they may or may not be available in stock libraries on various systems.
-<sect1>Patterns<label id="pattern">
+<sect1>Patterns<label id="patterns">
<p>
Many of Mutt's commands allow you to specify a pattern to match
(limit, tag-pattern, delete-pattern, etc.). There are several ways to select
subject. To tag all messages matching a pattern, use the tag-pattern
function, which is bound to ``control-T'' by default. Or you can select
individual messages by hand using the ``tag-message'' function, which is
-bound to ``t'' by default. See <ref id="pattern" name="patterns"> for
+bound to ``t'' by default. See <ref id="patterns" name="patterns"> for
Mutt's pattern matching syntax.
Once you have tagged the desired messages, you can use the
you may wish to tailor your configuration based upon which mailbox you are
reading, or to whom you are sending mail. In the Mutt world, a <em/hook/
consists of a <ref id="regexp" name="regular expression"> or
-<ref id="pattern" name="pattern"> along with a
+<ref id="patterns" name="pattern"> along with a
configuration option/command. See
<itemize>
<item><ref id="folder-hook" name="folder-hook">
needed for matching since for different purposes you want to match
different criteria.
-Mutt allows the use of the <ref id="pattern" name="search pattern">
+Mutt allows the use of the <ref id="patterns" name="search pattern">
language for matching messages in hook commands. This works in exactly the
same way as it would when <em/limiting/ or <em/searching/ the mailbox,
except that you are restricted to those operators which match information
** Controls whether or not the \fIMail-Followup-To\fP header field is
** generated when sending mail. When \fIset\fP, Mutt will generate this
** field when you are replying to a known mailing list, specified with
- ** the ``$subscribe'' or ``$lists'' commands.
+ ** the ``subscribe'' or ``$lists'' commands.
** .pp
** This field has two purposes. First, preventing you from receiving
** duplicate copies of replies to messages which you send to mailing
{ "message_format", DT_STR, R_NONE, UL &MsgFmt, UL "%s" },
/*
** .pp
- ** This is the string displayed in the ``$attachment'' menu for
+ ** This is the string displayed in the ``attachment'' menu for
** attachments of type message/rfc822. For a full listing of defined
** escape sequences see the section on ``$$index_format''.
*/
** If your spool mailbox is in a non-default place where Mutt cannot find
** it, you can specify its location with this variable. Mutt will
** automatically set this variable to the value of the environment
- ** variable $MAIL if it is not set.
+ ** variable $$$MAIL if it is not set.
*/
{ "status_chars", DT_STR, R_BOTH, UL &StChars, UL "-*%A" },
/*
{ "status_on_top", DT_BOOL, R_BOTH, OPTSTATUSONTOP, 0 },
/*
** .pp
- ** Setting this variable causes the ``$status bar'' to be displayed on
+ ** Setting this variable causes the ``status bar'' to be displayed on
** the first line of the screen rather than near the bottom.
*/
{ "strict_threads", DT_BOOL, R_RESORT|R_INDEX, OPTSTRICTTHREADS, 0 },
/*
** .pp
** If set, threading will only make use of the ``In-Reply-To'' and
- ** ``References'' fields when ``$sorting'' by message threads. By
+ ** ``References'' fields when you ``$$sort'' by message threads. By
** default, messages with the same subject are grouped together in
** ``pseudo threads.'' This may not always be desirable, such as in a
** personal mailbox where you might have several unrelated messages with
** escape\fP, \fIpipe-message\fP, \fIpipe-entry\fP, \fIprint-message\fP,
** and \fIprint-entry\fP commands.
** .pp
- ** It is also used when viewing attachments with ``$autoview'', provided
+ ** It is also used when viewing attachments with ``$auto_view'', provided
** that the corresponding mailcap entry has a \fIneedsterminal\fP flag,
** and the external program is interactive.
** .pp
return docstat;
}
+void print_ref (FILE *out, int output_dollar, const char *ref)
+{
+ switch (OutputFormat)
+ {
+ case F_CONF:
+ case F_MAN:
+ if (output_dollar)
+ putc ('$', out);
+ fputs (ref, out);
+ break;
+
+ case F_SGML:
+ fprintf (out, "<ref id=\"%s\" name=\"", ref);
+ if (output_dollar)
+ fputs ("$", out);
+ sgml_fputs (ref, out);
+ fputs ("\">", out);
+ break;
+
+ default:
+ break;
+ }
+}
+
static int commit_buff (char *buff, char **d, FILE *out, int docstat)
{
if (*d > buff)
s += 3;
}
else if (*s == '$')
- /* add code for references here. */
- ;
+ {
+ int output_dollar = 0;
+ char *ref;
+ char save;
+
+ ++s;
+ if (*s == '$')
+ {
+ output_dollar = 1;
+ ++s;
+ }
+ if (*s == '$')
+ {
+ *d++ = '$';
+ }
+ else
+ {
+ ref = s;
+ while (isalnum (*s) || *s == '-' || *s == '_')
+ ++s;
+
+ docstat = commit_buff (buff, &d, out, docstat);
+ save = *s;
+ *s = 0;
+ print_ref (out, output_dollar, ref);
+ *s = save;
+ --s;
+ }
+ }
else
*d++ = *s;
}
projects / mutt / commitdiff