File: bookmark.el.html

This package is for setting "bookmarks" in files. A bookmark associates a string with a location in a certain file. Thus, you can navigate your way to that location by providing the string.

Type M-x customize-group RET bookmark RET for user options.

Defined variables (53)

bookmark--annotation-from-bookmark-listIf non-nil, ‘bookmark-edit-annotation-mode’ should return to bookmark list.
bookmark--watch-already-asked-mtimeMtime for which we already queried about reloading.
bookmark-after-jump-hookHook run after ‘bookmark-jump’ jumps to a bookmark.
bookmark-alistAssociation list of bookmark names and their parameters.
bookmark-alist-modification-countNumber of modifications to bookmark list since it was last saved.
bookmark-annotation-nameName of bookmark under edit in ‘bookmark-edit-annotation-mode’.
bookmark-automatically-show-annotationsNon-nil means show annotations when jumping to a bookmark.
bookmark-bmenu-bufferName of buffer used for Bookmark List.
bookmark-bmenu-file-columnColumn at which to display filenames in a buffer listing bookmarks.
bookmark-bmenu-inline-header-heightNumber of lines used for the *Bookmark List* header.
bookmark-bmenu-marks-widthNumber of columns (chars) used for the *Bookmark List* marks column.
bookmark-bmenu-mode-abbrev-tableAbbrev table for ‘bookmark-bmenu-mode’.
bookmark-bmenu-mode-hookHook run after entering ‘bookmark-bmenu-mode’.
bookmark-bmenu-mode-mapKeymap for ‘bookmark-bmenu-mode’.
bookmark-bmenu-mode-syntax-tableSyntax table for ‘bookmark-bmenu-mode’.
bookmark-bmenu-toggle-filenamesNon-nil means show filenames when listing bookmarks.
bookmark-bmenu-use-header-lineNon-nil means to use an immovable header line.
bookmark-bookmarks-timestampTimestamp of current default bookmark file.
bookmark-completion-ignore-caseNon-nil means bookmark functions ignore case in completion.
bookmark-current-bookmarkName of bookmark most recently used in the current file.
bookmark-current-bufferThe buffer in which a bookmark is currently being set or renamed.
bookmark-default-fileFile in which to save bookmarks by default.
bookmark-edit-annotation-mode-abbrev-tableAbbrev table for ‘bookmark-edit-annotation-mode’.
bookmark-edit-annotation-mode-hookHook run after entering ‘bookmark-edit-annotation-mode’.
bookmark-edit-annotation-mode-mapKeymap for editing an annotation of a bookmark.
bookmark-edit-annotation-mode-syntax-tableSyntax table for ‘bookmark-edit-annotation-mode’.
bookmark-edit-annotation-text-funcFunction to return default text to use for a bookmark annotation.
bookmark-end-of-version-stamp-markerThis string marks the end of the version stamp in a bookmark file.
bookmark-exit-hookHook run when Emacs exits.
bookmark-fileFile in which to save bookmarks by default.
bookmark-file-coding-systemThe coding-system of the last loaded or saved bookmark file.
bookmark-file-format-versionThe current version of the format used by bookmark files.
bookmark-fringe-markThe fringe bitmap to mark bookmarked lines with.
bookmark-historyThe history list for bookmark functions.
bookmark-inhibit-context-functionsList of functions to call before making a bookmark record.
bookmark-load-hookHook run at the end of loading library ‘bookmark.el’.
bookmark-make-record-functionA function that should be called to create a bookmark record.
bookmark-mapKeymap containing bindings to bookmark functions.
bookmark-menuMenu for ‘bookmark-bmenu’.
bookmark-menu-confirm-deletionNon-nil means confirm before deleting bookmarks in a bookmark menu buffer.
bookmark-menu-lengthMaximum length of a bookmark name displayed on a popup menu.
bookmark-old-default-fileFile in which to save bookmarks by default.
bookmark-quit-flagNon-nil means ‘bookmark-bmenu-search’ quits immediately.
bookmark-save-flagControls when Emacs saves bookmarks to a file.
bookmark-search-delayTime before ‘bookmark-bmenu-search’ updates the display.
bookmark-search-sizeLength of the context strings recorded on either side of a bookmark.
bookmark-set-fringe-markThe fringe bitmap to mark bookmarked lines with.
bookmark-sort-flagThis controls the bookmark display sorting.
bookmark-use-annotationsIf non-nil, setting a bookmark queries for an annotation in a buffer.
bookmark-version-controlWhether or not to make numbered backups of the bookmark file.
bookmark-watch-bookmark-fileIf non-nil reload the default bookmark file if it was changed.
bookmark-yank-pointThe next point from which to pull source text for ‘bookmark-yank-word’.
bookmarks-already-loadedTimestamp of current default bookmark file.

Defined functions (126)

bookmark--jump-via(BOOKMARK-NAME-OR-RECORD DISPLAY-FUNCTION)
bookmark--remove-fringe-mark(BM)
bookmark--set-fringe-mark()
bookmark--watch-file-already-queried-p(NEW-MTIME)
bookmark-alist-from-buffer()
bookmark-all-names()
bookmark-bmenu--file-predicate(A B)
bookmark-bmenu--name-predicate(A B)
bookmark-bmenu--revert()
bookmark-bmenu--type-predicate(A B)
bookmark-bmenu-1-window()
bookmark-bmenu-2-window()
bookmark-bmenu-any-marks()
bookmark-bmenu-backup-unmark()
bookmark-bmenu-bookmark()
bookmark-bmenu-delete()
bookmark-bmenu-delete-all()
bookmark-bmenu-delete-backwards()
bookmark-bmenu-edit-annotation()
bookmark-bmenu-ensure-position()
bookmark-bmenu-execute-deletions()
bookmark-bmenu-filter-alist-by-regexp(REGEXP)
bookmark-bmenu-get-buffer()
bookmark-bmenu-goto-bookmark(NAME)
bookmark-bmenu-hide-filenames(&optional _)
bookmark-bmenu-list()
bookmark-bmenu-load()
bookmark-bmenu-locate()
bookmark-bmenu-mark()
bookmark-bmenu-mark-all()
bookmark-bmenu-mode()
bookmark-bmenu-other-frame()
bookmark-bmenu-other-window()
bookmark-bmenu-other-window-with-mouse(EVENT)
bookmark-bmenu-relocate()
bookmark-bmenu-rename()
bookmark-bmenu-save()
bookmark-bmenu-search()
bookmark-bmenu-select()
bookmark-bmenu-set-header()
bookmark-bmenu-show-all-annotations()
bookmark-bmenu-show-annotation()
bookmark-bmenu-show-filenames(&optional _)
bookmark-bmenu-surreptitiously-rebuild-list()
bookmark-bmenu-switch-other-window()
bookmark-bmenu-this-window()
bookmark-bmenu-toggle-filenames(&optional SHOW)
bookmark-bmenu-unmark(&optional BACKUP)
bookmark-bmenu-unmark-all()
bookmark-buffer-file-name()
bookmark-buffer-name()
bookmark-completing-read(PROMPT &optional DEFAULT)
bookmark-default-annotation-text(BOOKMARK-NAME)
bookmark-default-handler(BMK-RECORD)
bookmark-delete(BOOKMARK-NAME &optional BATCH)
bookmark-delete-all(&optional NO-CONFIRM)
bookmark-edit-annotation(BOOKMARK-NAME-OR-RECORD &optional FROM-BOOKMARK-LIST)
bookmark-edit-annotation--maybe-display-list(&rest BODY)
bookmark-edit-annotation-cancel()
bookmark-edit-annotation-confirm()
bookmark-edit-annotation-mode()
bookmark-exit-hook-internal()
bookmark-get-annotation(BOOKMARK-NAME-OR-RECORD)
bookmark-get-bookmark(BOOKMARK-NAME-OR-RECORD &optional NOERROR)
bookmark-get-bookmark-record(BOOKMARK-NAME-OR-RECORD)
bookmark-get-filename(BOOKMARK-NAME-OR-RECORD)
bookmark-get-front-context-string(BOOKMARK-NAME-OR-RECORD)
bookmark-get-handler(BOOKMARK-NAME-OR-RECORD)
bookmark-get-last-modified(BOOKMARK-NAME-OR-RECORD)
bookmark-get-position(BOOKMARK-NAME-OR-RECORD)
bookmark-get-rear-context-string(BOOKMARK-NAME-OR-RECORD)
bookmark-grok-file-format-version()
bookmark-handle-bookmark(BOOKMARK-NAME-OR-RECORD)
bookmark-import-new-list(NEW-LIST)
bookmark-insert(BOOKMARK-NAME)
bookmark-insert-annotation(BOOKMARK-NAME-OR-RECORD)
bookmark-insert-file-format-version-stamp(CODING)
bookmark-insert-location(BOOKMARK-NAME &optional NO-HISTORY)
bookmark-jump(BOOKMARK &optional DISPLAY-FUNC)
bookmark-jump-other-frame(BOOKMARK)
bookmark-jump-other-window(BOOKMARK)
bookmark-kill-line(&optional NEWLINE-TOO)
bookmark-load(FILE &optional OVERWRITE NO-MSG DEFAULT)
bookmark-locate(BOOKMARK-NAME &optional NO-HISTORY)
bookmark-location(BOOKMARK-NAME-OR-RECORD)
bookmark-make-record()
bookmark-make-record-default(&optional NO-FILE NO-CONTEXT POSN)
bookmark-maybe-historicize-string(STRING)
bookmark-maybe-load-default-file()
bookmark-maybe-message(FORMAT-STRING &rest ARGS)
bookmark-maybe-rename(FULL-RECORD NAMES)
bookmark-maybe-sort-alist()
bookmark-maybe-upgrade-file-format()
bookmark-menu(ARG1)
bookmark-menu-popup-paned-menu(EVENT NAME ENTRIES)
bookmark-name-from-full-record(BOOKMARK-RECORD)
bookmark-prop-get(BOOKMARK-NAME-OR-RECORD PROP)
bookmark-prop-set(BOOKMARK-NAME-OR-RECORD PROP VAL)
bookmark-relocate(BOOKMARK-NAME)
bookmark-rename(OLD-NAME &optional NEW-NAME)
bookmark-save(&optional PARG FILE MAKE-DEFAULT)
bookmark-send-edited-annotation()
bookmark-set(&optional NAME NO-OVERWRITE)
bookmark-set-annotation(BOOKMARK-NAME-OR-RECORD ANN)
bookmark-set-filename(BOOKMARK-NAME-OR-RECORD FILENAME)
bookmark-set-front-context-string(BOOKMARK-NAME-OR-RECORD STRING)
bookmark-set-internal(PROMPT NAME OVERWRITE-OR-PUSH)
bookmark-set-name(BOOKMARK-NAME-OR-RECORD NEWNAME)
bookmark-set-no-overwrite(&optional NAME PUSH-BOOKMARK)
bookmark-set-position(BOOKMARK-NAME-OR-RECORD POSITION)
bookmark-set-rear-context-string(BOOKMARK-NAME-OR-RECORD STRING)
bookmark-show-all-annotations()
bookmark-show-annotation(BOOKMARK-NAME-OR-RECORD)
bookmark-store(NAME ALIST NO-OVERWRITE)
bookmark-time-to-save-p(&optional FINAL-TIME)
bookmark-type-from-full-record(BOOKMARK-RECORD)
bookmark-unload-function()
bookmark-update-last-modified(BOOKMARK-NAME-OR-RECORD)
bookmark-upgrade-file-format-from-0()
bookmark-upgrade-version-0-alist(OLD-LIST)
bookmark-write()
bookmark-write-file(FILE)
bookmark-yank-word()
edit-bookmarks()
list-bookmarks()
with-buffer-modified-unmodified(&rest BODY)

Defined faces (2)

bookmark-faceFace used to highlight current line.
bookmark-menu-bookmarkFace used to highlight bookmark names in bookmark menu buffers.