Next: %-Constructs, Previous: Mode Line Top, Up: Mode Line Format
This section describes variables incorporated by the standard value
of mode-line-format into the text of the mode line. There is
nothing inherently special about these variables; any other variables
could have the same effects on the mode line if
mode-line-format's value were changed to use them. However,
various parts of Emacs set these variables on the understanding that
they will control parts of the mode line; therefore, practically
speaking, it is essential for the mode line to use them.
This variable holds the value of the mode-line construct that displays information about the language environment, buffer coding system, and current input method. See Non-ASCII Characters.
This variable holds the value of the mode-line construct that displays whether the current buffer is modified.
The default value of
mode-line-modifiedis("%1*%1+"). This means that the mode line displays `**' if the buffer is modified, `--' if the buffer is not modified, `%%' if the buffer is read only, and `%*' if the buffer is read only and modified.Changing this variable does not force an update of the mode line.
This variable identifies the current frame. The default value is
" "if you are using a window system which can show multiple frames, or"-%F "on an ordinary terminal which shows only one frame at a time.
This variable identifies the buffer being displayed in the window. Its default value is
("%12b"), which displays the buffer name, padded with spaces to at least 12 columns.
This variable indicates the position in the buffer. Here is a simplified version of its default value. The actual default value also specifies addition of the
help-echotext property.((-3 "%p") (size-indication-mode (8 " of %I")) (line-number-mode ((column-number-mode (10 " (%l,%c)") (6 " L%l"))) ((column-number-mode (5 " C%c")))))This means that
mode-line-positiondisplays at least the buffer percentage and possibly the buffer size, the line number and the column number.
The variable
vc-mode, buffer-local in each buffer, records whether the buffer's visited file is maintained with version control, and, if so, which kind. Its value is a string that appears in the mode line, ornilfor no version control.
This variable displays the buffer's major and minor modes. Here is a simplified version of its default value. The real default value also specifies addition of text properties.
("%[(" mode-name mode-line-process minor-mode-alist "%n" ")%]--")So
mode-line-modesnormally also displays the recursive editing level, information on the process status and whether narrowing is in effect.
The following three variables are used in mode-line-modes:
This buffer-local variable holds the “pretty” name of the current buffer's major mode. Each major mode should set this variable so that the mode name will appear in the mode line.
This buffer-local variable contains the mode-line information on process status in modes used for communicating with subprocesses. It is displayed immediately following the major mode name, with no intervening space. For example, its value in the `*shell*' buffer is
(":%s"), which allows the shell to display its status along with the major mode as: `(Shell:run)'. Normally this variable isnil.
This variable holds an association list whose elements specify how the mode line should indicate that a minor mode is active. Each element of the
minor-mode-alistshould be a two-element list:(minor-mode-variable mode-line-string)More generally, mode-line-string can be any mode-line spec. It appears in the mode line when the value of minor-mode-variable is non-
nil, and not otherwise. These strings should begin with spaces so that they don't run together. Conventionally, the minor-mode-variable for a specific mode is set to a non-nilvalue when that minor mode is activated.
minor-mode-alistitself is not buffer-local. Each variable mentioned in the alist should be buffer-local if its minor mode can be enabled separately in each buffer.
This variable holds a mode-line spec that, by default, appears in the mode line just after the
which-func-modeminor mode if set, else aftermode-line-modes. The commanddisplay-timesetsglobal-mode-stringto refer to the variabledisplay-time-string, which holds a string containing the time and load information.The `%M' construct substitutes the value of
global-mode-string, but that is obsolete, since the variable is included in the mode line frommode-line-format.
The variable default-mode-line-format is where
mode-line-format usually gets its value:
This variable holds the default
mode-line-formatfor buffers that do not override it. This is the same as(default-value 'mode-line-format).Here is a simplified version of the default value of
default-mode-line-format. The real default value also specifies addition of text properties.("-" mode-line-mule-info mode-line-modified mode-line-frame-identification mode-line-buffer-identification " " mode-line-position (vc-mode vc-mode) " " mode-line-modes (which-func-mode ("" which-func-format "--")) (global-mode-string ("--" global-mode-string)) "-%-")
