File: marginalia.el.html

Enrich existing commands with completion annotations. The information associated with the completion candidates is shown in the minibuffer or the
*Completions* buffer. For files the owner and permissions are shown, for
buffers the major mode and modification status and for functions or commands the docstring is shown.

Defined variables (23)

marginalia--advice-regexpRegexp to match lines about advice in function documentation strings.
marginalia--base-positionLast completion base position saved to get full file paths.
marginalia--bookmark-type-transformsList of bookmark type transformers.
marginalia--cacheThe cache, pair of list and hashtable.
marginalia--cache-sizeSize of the cache, set to 0 to disable the cache.
marginalia--cand-width-maxMaximum width of candidates.
marginalia--cand-width-stepRound candidate width.
marginalia--commandLast command symbol saved in order to allow annotations.
marginalia--fontified-file-modesList of fontified file modes.
marginalia--metadataCompletion metadata from the current completion.
marginalia-alignAlignment of the annotations.
marginalia-align-offsetAdditional offset added to the alignment.
marginalia-annotatorsAnnotator function registry.
marginalia-censor-variablesThe value of variables matching any of these regular expressions is not shown.
marginalia-classifiersList of functions to determine current completion category.
marginalia-command-categoriesAssociate commands with a completion category.
marginalia-field-widthMaximum truncation width of annotation fields.
marginalia-max-relative-ageMaximum relative age in seconds displayed by the file annotator.
marginalia-modeNon-nil if Marginalia mode is enabled.
marginalia-mode-hookHook run after entering or leaving ‘marginalia-mode’.
marginalia-prompt-categoriesAssociates regexps to match against minibuffer prompts with categories.
marginalia-remote-file-regexpsList of remote file regexps where the files should not be annotated.
marginalia-separatorAnnotation field separator.

Defined functions (66)

marginalia--abbreviate-file-name(FILE)
marginalia--advised(FUN)
marginalia--affixate(METADATA ANNOTATOR CANDS)
marginalia--align(CANDS)
marginalia--annotate-local-file(CAND)
marginalia--annotator(CAT)
marginalia--base-position(COMPLETIONS)
marginalia--bookmark-type(BM)
marginalia--buffer-file(BUFFER)
marginalia--buffer-status(BUFFER)
marginalia--builtin-annotator-p(MD)
marginalia--cache-reset(&rest _)
marginalia--cached(CACHE FUN KEY)
marginalia--completion-metadata-get(METADATA PROP)
marginalia--context-menu(MENU EVENT)
marginalia--definition-prefix(SYM)
marginalia--documentation(STR)
marginalia--ellipsis()
marginalia--field
marginalia--fields(&rest FIELDS)
marginalia--file-modes(ATTRS)
marginalia--file-owner(ATTRS)
marginalia--file-size(ATTRS)
marginalia--full-candidate(CAND)
marginalia--function-args(SYM)
marginalia--function-doc(SYM)
marginalia--in-minibuffer(&rest BODY)
marginalia--library-cache()
marginalia--library-doc(FILE)
marginalia--minibuffer-setup()
marginalia--orig-completion-metadata-get(ARG1 ARG2)
marginalia--remote-file-p(FILE)
marginalia--symbol-class(S)
marginalia--time(TIME)
marginalia--time-absolute(TIME)
marginalia--truncate(STR WIDTH)
marginalia--variable-value(SYM)
marginalia-annotate-binding(CAND)
marginalia-annotate-bookmark(CAND)
marginalia-annotate-buffer(CAND)
marginalia-annotate-char(CAND)
marginalia-annotate-charset(CAND)
marginalia-annotate-coding-system(CAND)
marginalia-annotate-color(CAND)
marginalia-annotate-command(CAND)
marginalia-annotate-customize-group(CAND)
marginalia-annotate-embark-keybinding(CAND)
marginalia-annotate-environment-variable(CAND)
marginalia-annotate-face(CAND)
marginalia-annotate-file(CAND)
marginalia-annotate-frame(CAND)
marginalia-annotate-function(CAND)
marginalia-annotate-imenu(CAND)
marginalia-annotate-input-method(CAND)
marginalia-annotate-library(CAND)
marginalia-annotate-minor-mode(CAND)
marginalia-annotate-multi-category(CAND)
marginalia-annotate-symbol(CAND)
marginalia-annotate-tab(CAND)
marginalia-annotate-theme(CAND)
marginalia-annotate-variable(CAND)
marginalia-classify-by-command-name()
marginalia-classify-by-prompt()
marginalia-classify-symbol()
marginalia-cycle()
marginalia-mode(&optional ARG)

Defined faces (32)

marginalia-archiveFace used to highlight package archives.
marginalia-charFace used to highlight character annotations.
marginalia-dateFace used to highlight dates.
marginalia-documentationFace used to highlight documentation strings.
marginalia-file-nameFace used to highlight file names.
marginalia-file-ownerFace used to highlight file owner and group names.
marginalia-file-priv-dirFace used to highlight the dir file privilege attribute.
marginalia-file-priv-execFace used to highlight the exec file privilege attribute.
marginalia-file-priv-linkFace used to highlight the link file privilege attribute.
marginalia-file-priv-noFace used to highlight the no file privilege attribute.
marginalia-file-priv-otherFace used to highlight some other file privilege attribute.
marginalia-file-priv-rareFace used to highlight a rare file privilege attribute.
marginalia-file-priv-readFace used to highlight the read file privilege attribute.
marginalia-file-priv-writeFace used to highlight the write file privilege attribute.
marginalia-functionFace used to highlight function symbols.
marginalia-installedFace used to highlight the status of packages.
marginalia-keyFace used to highlight keys.
marginalia-lighterFace used to highlight minor mode lighters.
marginalia-listFace used to highlight list expressions.
marginalia-modeFace used to highlight buffer major modes.
marginalia-modifiedFace used to highlight buffer modification indicators.
marginalia-nullFace used to highlight null or unbound variable values.
marginalia-numberFace used to highlight numeric values.
marginalia-offFace used to signal disabled modes.
marginalia-onFace used to signal enabled modes.
marginalia-sizeFace used to highlight sizes.
marginalia-stringFace used to highlight string values.
marginalia-symbolFace used to highlight general symbols.
marginalia-trueFace used to highlight true variable values.
marginalia-typeFace used to highlight types.
marginalia-valueFace used to highlight general variable values.
marginalia-versionFace used to highlight package versions.