- Qnil,
- "Template for displaying mode line for current buffer.\n\
-Each buffer has its own value of this variable.\n\
-Value may be nil, a string, a symbol or a list or cons cell.\n\
-A value of nil means don't display a mode line.\n\
-For a symbol, its value is used (but it is ignored if t or nil).\n\
- A string appearing directly as the value of a symbol is processed verbatim\n\
- in that the %-constructs below are not recognized.\n\
-For a list of the form `(:eval FORM)', FORM is evaluated and the result\n\
- is used as a mode line element.\n\
-For a list whose car is a symbol, the symbol's value is taken,\n\
- and if that is non-nil, the cadr of the list is processed recursively.\n\
- Otherwise, the caddr of the list (if there is one) is processed.\n\
-For a list whose car is a string or list, each element is processed\n\
- recursively and the results are effectively concatenated.\n\
-For a list whose car is an integer, the cdr of the list is processed\n\
- and padded (if the number is positive) or truncated (if negative)\n\
- to the width specified by that number.\n\
-A string is printed verbatim in the mode line except for %-constructs:\n\
- (%-constructs are allowed when the string is the entire mode-line-format\n\
- or when it is found in a cons-cell or a list)\n\
- %b -- print buffer name. %f -- print visited file name.\n\
- %F -- print frame name.\n\
- %* -- print %, * or hyphen. %+ -- print *, % or hyphen.\n\
- %& is like %*, but ignore read-only-ness.\n\
- % means buffer is read-only and * means it is modified.\n\
- For a modified read-only buffer, %* gives % and %+ gives *.\n\
- %s -- print process status. %l -- print the current line number.\n\
- %c -- print the current column number (this makes editing slower).\n\
- To make the column number update correctly in all cases,\n\
- `column-number-mode' must be non-nil.\n\
- %p -- print percent of buffer above top of window, or Top, Bot or All.\n\
- %P -- print percent of buffer above bottom of window, perhaps plus Top,\n\
- or print Bottom or All.\n\
- %m -- print the mode name.\n\
- %n -- print Narrow if appropriate.\n\
- %z -- print mnemonics of buffer, terminal, and keyboard coding systems.\n\
- %Z -- like %z, but including the end-of-line format.\n\
- %[ -- print one [ for each recursive editing level. %] similar.\n\
- %% -- print %. %- -- print infinitely many dashes.\n\
-Decimal digits after the % specify field width to which to pad.");
-*/
+ Qnil,
+ doc: /* Template for displaying mode line for current buffer.
+Each buffer has its own value of this variable.
+Value may be nil, a string, a symbol or a list or cons cell.
+A value of nil means don't display a mode line.
+For a symbol, its value is used (but it is ignored if t or nil).
+ A string appearing directly as the value of a symbol is processed verbatim
+ in that the %-constructs below are not recognized.
+ Note that unless the symbol is marked as a `risky-local-variable', all
+ properties in any strings, as well as all :eval and :propertize forms
+ in the value of that symbol will be ignored.
+For a list of the form `(:eval FORM)', FORM is evaluated and the result
+ is used as a mode line element. Be careful--FORM should not load any files,
+ because that can cause an infinite recursion.
+For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
+ with the specified properties PROPS applied.
+For a list whose car is a symbol, the symbol's value is taken,
+ and if that is non-nil, the cadr of the list is processed recursively.
+ Otherwise, the caddr of the list (if there is one) is processed.
+For a list whose car is a string or list, each element is processed
+ recursively and the results are effectively concatenated.
+For a list whose car is an integer, the cdr of the list is processed
+ and padded (if the number is positive) or truncated (if negative)
+ to the width specified by that number.
+A string is printed verbatim in the mode line except for %-constructs:
+ (%-constructs are allowed when the string is the entire mode-line-format
+ or when it is found in a cons-cell or a list)
+ %b -- print buffer name. %f -- print visited file name.
+ %F -- print frame name.
+ %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
+ %& is like %*, but ignore read-only-ness.
+ % means buffer is read-only and * means it is modified.
+ For a modified read-only buffer, %* gives % and %+ gives *.
+ %s -- print process status. %l -- print the current line number.
+ %c -- print the current column number (this makes editing slower).
+ To make the column number update correctly in all cases,
+ `column-number-mode' must be non-nil.
+ %p -- print percent of buffer above top of window, or Top, Bot or All.
+ %P -- print percent of buffer above bottom of window, perhaps plus Top,
+ or print Bottom or All.
+ %m -- print the mode name.
+ %n -- print Narrow if appropriate.
+ %z -- print mnemonics of buffer, terminal, and keyboard coding systems.
+ %Z -- like %z, but including the end-of-line format.
+ %[ -- print one [ for each recursive editing level. %] similar.
+ %% -- print %. %- -- print infinitely many dashes.
+Decimal digits after the % specify field width to which to pad. */);