... | ... | @@ -42,7 +42,7 @@ documentation: |
|
|
* doc/muttrc.man.{head,tail} contain an abridged version of The Manual in nroff format (see man(7)), which deals with configuration file commands.
|
|
|
|
|
|
Configuration **variables** are documented directly in \`init.h\`. Note
|
|
|
that this includes documentation for possibly added format flags\!
|
|
|
that this includes documentation for possibly added format flags!
|
|
|
|
|
|
The parts of The Manual and the muttrc manual page dealing with these
|
|
|
variables, and the global Muttrc, are generated automatically from that
|
... | ... | @@ -53,13 +53,13 @@ Note that you may have to update the makedoc utility (makedoc.c) when |
|
|
adding new data types to \`init.h\`.
|
|
|
|
|
|
More precisely, variable name, type, and default value are directly
|
|
|
extracted from the initializer for the \!MuttVars array. Documentation
|
|
|
extracted from the initializer for the !MuttVars array. Documentation
|
|
|
is expected in special comments which **follow** the initializer. For a
|
|
|
line to be included with the documentation, it must (after, possibly,
|
|
|
some white space) begin with either "/\*\*" or "\*\*". Any following
|
|
|
white space is ignored. The rest of the line is expected to be plain
|
|
|
text, with some formatting instructions roughly similar to
|
|
|
\!\[ntg\]roff:
|
|
|
!\[ntg\]roff:
|
|
|
|
|
|
* \fI switches to italics
|
|
|
* \fB switches to boldface
|
... | ... | @@ -76,4 +76,4 @@ text, with some formatting instructions roughly similar to |
|
|
* $word will be converted to a reference to word, where appropriate. Note that $$word is possible as well. 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.
|
|
|
|
|
|
Do **not** use any other SGML or nroff formatting instructions here\! |
|
|
Do **not** use any other SGML or nroff formatting instructions here! |