Function: Man-mode

Man-mode is an interactive and byte-compiled function defined in man.el.gz.

Signature

(Man-mode)

Documentation

A mode for browsing Un*x manual pages.

The following man commands are available in the buffer:
m (man) Prompt to retrieve a new manpage.
r (Man-follow-manual-reference) Retrieve reference in SEE ALSO section.
M-n (Man-next-manpage) Jump to next manpage in circular list.
M-p (Man-previous-manpage) Jump to previous manpage in circular list.
n (Man-next-section) Jump to next manpage section.
p (Man-previous-section) Jump to previous manpage section.
g (Man-goto-section) Go to a manpage section.
s (Man-goto-see-also-section) Jump to the SEE ALSO manpage section.
q (quit-window) Delete the manpage window, bury its buffer.
k (Man-kill) Delete the manpage window, kill its buffer.
h (describe-mode) Print this help text.

The following variables may be of some use:

Man-notify-method What happens when manpage is ready to display.
Man-downcase-section-letters-flag Force section letters to lower case.
Man-circular-pages-flag Treat multiple manpage list as circular.
Man-section-translations-alist List of section numbers and their Un*x equiv.
Man-filter-list Background manpage filter command.
Man-mode-map Keymap bindings for Man mode buffers.
Man-mode-hook Normal hook run on entry to Man mode.
Man-section-regexp Regexp describing manpage section letters.
Man-heading-regexp Regexp describing section headers.
Man-see-also-regexp Regexp for SEE ALSO section (or your equiv).
Man-first-heading-regexp Regexp for first heading on a manpage.
Man-reference-regexp Regexp matching a references in SEE ALSO.
Man-switches Background man command switches.

The following key bindings are currently in effect in the buffer:
- negative-argument
- negative-argument
. beginning-of-buffer
0 digit-argument
0 digit-argument
1 digit-argument
1 digit-argument
2 digit-argument
2 digit-argument
3 digit-argument
3 digit-argument
4 digit-argument
4 digit-argument
5 digit-argument
5 digit-argument
6 digit-argument
6 digit-argument
7 digit-argument
7 digit-argument
8 digit-argument
8 digit-argument
9 digit-argument
9 digit-argument
< beginning-of-buffer
<keymap> C-M-i backward-button
<keymap> TAB forward-button
> end-of-buffer
? describe-mode
DEL scroll-down-command
M-n Man-next-manpage
M-p Man-previous-manpage
RET man-follow
S-SPC scroll-down-command
SPC scroll-up-command
SPC..~ undefined
SPC..~ undefined
g Man-goto-section
g revert-buffer
h describe-mode
k Man-kill
m man
n Man-next-section
p Man-previous-section
q quit-window
r Man-follow-manual-reference
s Man-goto-see-also-section
u Man-update-manpage

Probably introduced at or before Emacs version 26.1.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/man.el.gz
(define-derived-mode Man-mode man-common "Man"
  "A mode for browsing Un*x manual pages.

The following man commands are available in the buffer:
\\<Man-mode-map>
\\[man]       Prompt to retrieve a new manpage.
\\[Man-follow-manual-reference]       Retrieve reference in SEE ALSO section.
\\[Man-next-manpage]     Jump to next manpage in circular list.
\\[Man-previous-manpage]     Jump to previous manpage in circular list.
\\[Man-next-section]       Jump to next manpage section.
\\[Man-previous-section]       Jump to previous manpage section.
\\[Man-goto-section]       Go to a manpage section.
\\[Man-goto-see-also-section]       Jump to the SEE ALSO manpage section.
\\[quit-window]       Delete the manpage window, bury its buffer.
\\[Man-kill]       Delete the manpage window, kill its buffer.
\\[describe-mode]       Print this help text.

The following variables may be of some use:

`Man-notify-method'		What happens when manpage is ready to display.
`Man-downcase-section-letters-flag' Force section letters to lower case.
`Man-circular-pages-flag'	Treat multiple manpage list as circular.
`Man-section-translations-alist' List of section numbers and their Un*x equiv.
`Man-filter-list'		Background manpage filter command.
`Man-mode-map'			Keymap bindings for Man mode buffers.
`Man-mode-hook'			Normal hook run on entry to Man mode.
`Man-section-regexp'		Regexp describing manpage section letters.
`Man-heading-regexp'		Regexp describing section headers.
`Man-see-also-regexp'		Regexp for SEE ALSO section (or your equiv).
`Man-first-heading-regexp'	Regexp for first heading on a manpage.
`Man-reference-regexp'		Regexp matching a references in SEE ALSO.
`Man-switches'			Background `man' command switches.

The following key bindings are currently in effect in the buffer:
\\{Man-mode-map}"
  (setq buffer-auto-save-file-name nil
	mode-line-buffer-identification
	(list (default-value 'mode-line-buffer-identification)
	      " {" 'Man-page-mode-string "}")
	truncate-lines t)
  (buffer-disable-undo)
  (auto-fill-mode -1)
  (setq imenu-generic-expression (list (list nil Man-heading-regexp 0)))
  (imenu-add-to-menubar man-imenu-title)
  (setq-local outline-regexp Man-heading-regexp)
  (setq-local outline-level (lambda () 1))
  (setq-local bookmark-make-record-function
              #'Man-bookmark-make-record)
  (add-hook 'window-state-change-functions #'Man--window-state-change nil t))