# $mode-line(5)

[Home] [Commands] [Variables] [Macro-Dev] [Glossary]

## NAME

$mode-line - Mode line format

## SYNOPSIS

$mode-line "string"; Default is "`%s%r%u me (%e) - %l %b (%f)` "

## DESCRIPTION

$mode-line defines the format of the mode line printed for every window, where the character following a percent ('`%`') has the following effect:-

`D` Prints the current day.
`M` Prints the current month.
`Y` Prints the current year (2 digits).
`y` Prints the current year (4 digits).
`b` Prints the current buffer's name.
`c` Prints the current buffer's column number.
`e` Prints the current buffer's editing modes.
`f` Prints the current buffer's file name.
`h` Prints the current hour of the day.
`k` Prints the current keyboard macro status.
`l` Prints the current buffer's line number.
`m` Prints the current minute of the hour.
`n` Prints the current buffer's total number of lines.
`r` Prints the current root user status (UNIX only).
`s` Prints the horizontal window split character.
`u` Prints the current buffer's (un)changed or view mode flag.
`%` Prints a percentage escape character.
`-` Prints a literal minus character ('`-`') - see NOTES.
`*` All other characters are printed literally.

## NOTES

- Refer to $window-chars(5) for the characters utilized in the mode line. Typically a the '`-`' character is changed to a '`=`' if it is the current window. If a '`-`' is always required, use "`%-`".
- A buffer can have its own mode-line, and be uneffected be the global mode line, see $buffer-mode-line(5).

## SEE ALSO

$buffer-mode-line(5), $mode-line-scheme(5), $window-chars(5).

(c) Copyright JASSPA 2009
Last Modified: 2009/08/29
Generated On: 2009/10/12

</HMTL>