File: view.el.html

This package provides the view minor mode documented in the Emacs user's manual.

View mode entry and exit is done through the functions view-mode-enter and view-mode-exit. Use these functions to enter or exit view-mode(var)/view-mode(fun) from Emacs Lisp programs.

We use both view- and View- as prefix for symbols. View- is used as prefix for commands that have a key binding. view- is used for commands without key binding. The purpose of this is to make it easier for a user to use command name completion.

Defined variables (13)

view-exit-actionIf non-nil, a function called when finished viewing.
view-exits-all-viewing-windowsNon-nil means restore all windows used to view buffer.
view-half-page-sizeDefault number of lines to scroll by View half page commands.
view-highlight-faceThe face used for highlighting the match found by View mode search.
view-inhibit-help-messageNon-nil inhibits the help message shown upon entering View mode.
view-modeNon-nil if View mode is enabled.
view-mode-hookNormal hook run when starting to view a buffer or file.
view-mode-mapKeymap for ‘view-mode’.
view-no-disable-on-exitIf non-nil, View mode "exit" commands don’t actually disable View mode.
view-overlayOverlay used to display where a search operation found its match.
view-page-sizeDefault number of lines to scroll by View page commands.
view-scroll-auto-exitNon-nil means scrolling past the end of buffer exits View mode.
view-try-extend-at-buffer-endNon-nil means try to load more of file when reaching end of buffer.

Defined functions (42)

View-back-to-mark(&optional IGNORE)
View-exit()
View-exit-and-edit()
View-goto-line(&optional LINE)
View-goto-percent(&optional PERCENT)
View-kill-and-leave()
View-leave()
View-quit()
View-quit-all()
View-revert-buffer-scroll-page-forward(&optional LINES)
View-scroll-half-page-backward(&optional LINES)
View-scroll-half-page-forward(&optional LINES)
View-scroll-line-backward(&optional LINES)
View-scroll-line-forward(&optional LINES)
View-scroll-page-backward(&optional LINES)
View-scroll-page-backward-set-page-size(&optional LINES)
View-scroll-page-forward(&optional LINES)
View-scroll-page-forward-set-page-size(&optional LINES)
View-scroll-to-buffer-end()
View-search-last-regexp-backward(N)
View-search-last-regexp-forward(N)
View-search-regexp-backward(N REGEXP)
View-search-regexp-forward(N REGEXP)
kill-buffer-if-not-modified(BUF)
view-buffer(BUFFER &optional EXIT-ACTION)
view-buffer-other-frame(BUFFER &optional NOT-RETURN EXIT-ACTION)
view-buffer-other-window(BUFFER &optional NOT-RETURN EXIT-ACTION)
view-end-message()
view-file(FILE)
view-file-other-frame(FILE)
view-file-other-window(FILE)
view-mode(&optional ARG)
view-mode-disable()
view-mode-enable(&optional ARG)
view-mode-enter(&optional QUIT-RESTORE EXIT-ACTION)
view-mode-exit(&optional EXIT-ONLY EXIT-ACTION ALL-WINDOWS)
view-page-size-default(LINES)
view-really-at-end()
view-scroll-lines(LINES BACKWARD DEFAULT MAXDEFAULT)
view-search(TIMES REGEXP)
view-search-no-match-lines(TIMES REGEXP)
view-set-half-page-size-default(LINES)

Defined faces (0)