The Helm Manual

Table of Contents

The Helm Manual

— The Detailed Node Listing —

Quick Start Guide

Installation

Helm Generic Help

Helm sources

Matching in Helm

Helm mode

Global commands

Package: helm

Library: helm

Library: helm-adaptive

Library: helm-bookmark

Library: helm-buffers

Library: helm-color

Library: helm-comint

Library: helm-command

Library: helm-dabbrev

Library: helm-elisp

Library: helm-elisp-package

Library: helm-epa

Library: helm-eshell

Library: helm-eval

Library: helm-external

Library: helm-fd

Library: helm-files

Library: helm-find

Library: helm-font

Library: helm-for-files

Library: helm-global-bindings

Library: helm-grep

Library: helm-help

Library: helm-id-utils

Library: helm-imenu

Library: helm-info

Library: helm-lib

Library: helm-locate

Library: helm-man

Library: helm-misc

Library: helm-mode

Library: helm-multi-match

Library: helm-net

Library: helm-occur

Library: helm-regexp

Library: helm-ring

Library: helm-semantic

Library: helm-shell

Library: helm-sys

Library: helm-tags

Library: helm-types

Library: helm-utils

Library: helm-x-files

1 Introduction

People often think helm is just something like ido((Ido)Top) but displaying completion in a vertical layout instead of an horizontal one, it is not, helm is much more powerful than that.

• Helm is able to complete multiple lists dispatched in different sources against a pattern.
• Helm allows executing an unlimited number of actions on candidates.
• Helm allows marking candidates to execute chosen action against this set of candidates.
• Helm can display its completion buffer in different window layouts and in separate frame.

2 Quick Start Guide

2.1 Requirements

Helm 3.6.2 and later require

• ‘Emacs’ version >= 25.1
• ‘emacs-async’¹
• ‘popup-el’²

2.2 Download

Home Page

https://github.com/emacs-helm/helm

Git Url

https://github.com/emacs-helm/helm.git

git@github.com:emacs-helm/helm.git

Tagged Releases

https://github.com/emacs-helm/helm/tags

2.3 Installation

2.3.1 Minimal setup using ‘straight.el’

‘straight.el’³

Add this to your init file,

(straight-use-package 'helm)

or

(use-package helm :straight t)

For further information, see ‘straight.el’’s user manual.

To upgrade ‘helm’, do M-x straight-pull-package and restart Emacs. ‘straight.el’ will rebuild helm for you.

2.3.2 Minimal setup using source

1. Install the pre-requisites

   Install ‘emacs-async’⁴ and ‘popup-el’⁵. Ensure that they are available in load-path.

2. Download, compile and install the sources

   If you are using ‘git’,

   git clone https://github.com/emacs-helm/helm
   cd helm
   make
   sudo make install
   

   If you have a tarball⁶, say for version ‘v3.7.1.tar.gz’, then you can do

   wget https://github.com/emacs-helm/helm/archive/refs/tags/v3.7.1.tar.gz
   tar zxvf v3.7.1.tar.gz
   cd helm-3.7.1/
   make
   sudo make install
   

   Above steps⁸

   • installs ‘helm’ in ‘/usr/local/share/emacs/site-lisp/helm/’
   • creates an executable called ‘/usr/local/bin/helm’. This file is in fact a symbolic link to to the script ‘emacs-helm.sh’.
3. Load ‘helm-config’ during Emacs startup

   Now, add one of the following to your init file, and restart Emacs. These lines load ‘helm-autoloads.el’, and ensure that ‘helm’ commands are available for use after the restart.

   (add-to-list 'load-path "/path/to/helm/directory")
   (require 'helm-config)
   

   or

   (add-to-list 'load-path "/path/to/helm/directory")
   (use-package helm :config (require 'helm-config))
   

2.3.3 Minimal setup using the Package Manager

Helm is available on MELPA.⁹

Release version of Helm is available in the stable repository while development version is available in it’s sister repo.

Assuming that you have setup package-archives to include the MELPA, you can install ‘Helm’ with M-x package-install RET helm RET.

To upgrade ‘Helm’, use helm-list-elisp-packages. This command is the Helm equivalent of Emacs’ ‘list-packages’. Using helm-list-elisp-packages, ensures that ‘helm’ is compiled in a clean environment.¹⁰

2.4 Configuration

Helm comes with a shell script called ‘emacs-helm.sh’. This script is a thin wrapper around ‘emacs -Q’ with barest of Helm configuration. Use this script to reproduce and report Helm bugs.

It is desirable that you put this script in your PATH for easy access.

If you have installed ‘Helm’ from Git or release tarball, no additional step is required. ‘emacs-helm.sh’ is made available under ‘/usr/local/share/emacs/site-lisp/helm/’, and can be conveniently launched with the command ‘helm’.

If you have used a package manager for installing ‘helm’, it is available in ‘~/.emacs.d/elpa/helm-<VERSION>/emacs-helm.sh’. Run the below shell command, to launch a minimal Helm.

ln -s ~/src/helm/emacs-helm.sh  ~/bin/helm

2.5 Quick Try with ‘emacs-helm.sh’

;; This Emacs is Powered by ‘HELM’ using
;; emacs program "emacs".
;; This is a minimal ‘helm’ configuration to discover ‘helm’ or debug it.
;; You can retrieve this minimal configuration in "/tmp/helm-cfg.el".

;; Some original Emacs commands are replaced by their ‘helm’ counterparts:

;; - ‘find-file’(C-x C-f)            =>‘helm-find-files’
;; - ‘occur’(M-s o)                  =>‘helm-occur’
;; - ‘list-buffers’(C-x C-b)         =>‘helm-buffers-list’
;; - ‘completion-at-point’(M-tab)    =>‘helm-lisp-completion-at-point’[1]
;; - ‘apropos-command’(C-h a)        =>‘helm-apropos’
;; - ‘dabbrev-expand’(M-/)           =>‘helm-dabbrev’
;; - ‘execute-extended-command’(M-x) =>‘helm-M-x’

;; Some other Emacs commands are "helmized" by ‘helm-mode’.
;; [1] Coming with emacs-24.4, ‘completion-at-point’ is "helmized" by ‘helm-mode’

;; which provides Helm completion in many places like ‘shell-mode’.
;; Find context help for most Helm commands with ‘C-h m’.

(require 'helm-config)
(helm-mode 1)
(define-key global-map [remap find-file] 'helm-find-files)
(define-key global-map [remap occur] 'helm-occur)
(define-key global-map [remap list-buffers] 'helm-buffers-list)
(define-key global-map [remap dabbrev-expand] 'helm-dabbrev)
(define-key global-map [remap execute-extended-command] 'helm-M-x)
(define-key global-map [remap apropos-command] 'helm-apropos)
(unless (boundp 'completion-in-region-function)
  (define-key lisp-interaction-mode-map [remap completion-at-point] 'helm-lisp-completion-at-point)
  (define-key emacs-lisp-mode-map       [remap completion-at-point] 'helm-lisp-completion-at-point))

~/.emacs.d/elpa/helm-<VERSION>/emacs-helm.sh

Figure: A typical helm-M-x with

Invoke M-x helm-M-x RET and type ‘helm’ to discover Helm commands. The ‘Menu Bar -> Helm’ menu item is another way to discover helm commands.

2.6 How to report Helm Bugs

You can report Helm bug at https://github.com/emacs-helm/helm/issues.

Before you report an issue, ensure that you can reproduce it issue with ‘emacs-helm.sh’ script. Also, remember to report the version of Helm and your Emacs.

If you cannot run the ‘emacs-helm.sh’ script, be sure to reproduce the problem with ‘emacs -Q’, then installing Helm as described in the Install section.

2.7 Getting Help

• Helm on GitHub
• Tuhdo’s Helm tutorial
• Helm mailing list

2.8 A word of advice for experienced Emacs Users

Helm Completion v.s. Emacs Completion

Differences between the two often trip up new users.

Emacs completion is based on the minibuffer. Helm completion is based on the completion window.^{11 12 13}

In standard Emacs, interactivity happens in the minibuffer.

• Typing new characters filters candidates in the minibuffer. <tab> may try to complete the typed characters with a valid candidate.
• Hitting RET selects the current candidate from the minibuffer.

In Helm, interactivity happens in the completion window, not the minibuffer

• Typing new characters filters candidates in the completion window. Keep typing until the desired candidate is highlighted, or navigate to it using C-n.
• Hitting RET selects the currently highlighted item in the completion window.

Helm interaction model

Helm’s interactivity makes the <tab> key redundant for completion because the selection candidates are already made visible in the Helm completion window. So, tab completion is not supported. In Helm, <tab> is used to view available actions to be taken on a candidate.

Because the <tab> key is so ingrained in the muscle memory of long-time Emacs users, transition to Helm’s interactive model requires:

• A conscious visual adjustment to look at the completion window, and
• A conscious mental adjustment to avoid using the <tab> key for completion and go straight to RET key to select a candidate. Helm’s approach to completion provides better visual cues, takes fewer keystrokes, and is much faster.

3 Helm Generic Help

3.1 Basics

Helm narrows down the list of candidates as you type a filter pattern. See Matching in Helm.

Helm accepts multiple space-separated patterns, each pattern can be negated with ‘!’.

Helm also supports fuzzy matching in some places when specified, you will find several variables to enable fuzzy matching in diverse sources.

Helm generally uses familiar Emacs keys to navigate the list. Here follow some of the less obvious bindings:

• RET selects the candidate from the list, executes the default action upon exiting the Helm session.
• C-j executes the default action but without exiting the Helm session. Not all sources support this.
• TAB displays a list of actions available on current candidate or all marked candidates. The default binding <tab> is ordinarily used for completion, but that would be redundant since Helm completes upon every character entered in the prompt.

Note: In addition to the default actions list, additional actions appear depending on the type of the selected candidate(s). They are called filtered actions.

Additional Readings:

Fuzzy Matching

https://github.com/emacs-helm/helm/wiki/Fuzzy-matching

Helm Completion vs Emacs Completion

https://github.com/emacs-helm/helm/wiki#helm-completion-vs-emacs-completion

3.2 Helm sources

Helm uses what’s called sources to provide different kinds of completions. Each Helm session can handle one or more source. A source is an alist object which is build from various classes, see here.

Additional Readings:

Creating a Helm source

https://github.com/emacs-helm/helm/wiki/Developing#creating-a-source

3.2.1 Configure sources

You will find in Helm sources already built and bound to a variable called generally helm-source-<something>. In this case it is an alist and you can change the attributes (keys) values using helm-set-attr function in your configuration. Of course you have to ensure before calling helm-set-attr that the file containing source is loaded, e.g. with with-eval-after-load. Of course you can also completely redefine the source but this is generally not elegant as it duplicate for its most part code already defined in Helm.

You will find also sources that are not built and even not bound to any variables because they are rebuilded at each start of a Helm session. In this case you can add a defmethod called helm-setup-user-source to your config:

(cl-defmethod helm-setup-user-source ((source helm-moccur-class))
  (setf (slot-value source ’follow) -1))

Additional Readings:

Helm FAQ: Why is a customizable helm source nil

https://github.com/emacs-helm/helm/wiki/FAQ#why-is-a-customizable-helm-source-nil

Complex Examples Of Configuration

https://github.com/thierryvolpiatto/emacs-tv-config/blob/master/init-helm.el#L340

3.3 Modify keybindings in Helm

Helm main keymap is helm-map, all keys bound in this map apply to all Helm sources. However, most sources have their own keymap, with each binding overriding its counterpart in helm-map, you can see all bindings in effect in the Commands section (available only if the source has its own keymap and documentation of course).

3.4 Matching in Helm

All that you write in minibuffer is interpreted as a regexp or multiple regexps if separated by a space. This is true for most sources unless the developer of the source has disabled it or have choosen to use fuzzy matching. Even if a source has fuzzy matching enabled, Helm will switch to multi match as soon as it detects a space in the pattern. It may also switch to multi match as well if pattern starts with a ‘^’ beginning of line sign. In those cases each pattern separated with space should be a regexp and not a fuzzy pattern. When using multi match patterns, each pattern starting with ‘!’ is interpreted as a negation i.e. match everything but this.

3.4.1 Completion-styles

Helm generally fetches its candidates with the :candidates function up to helm-candidate-number-limit and then applies match functions to these candidates according to helm-pattern. But Helm allows matching candidates directly from the :candidates function using its own completion-styles. Helm provides ’helm completion style but also ’helm-flex completion style for Emacs<27 that don’t have ’flex completion style, otherwise (emacs-27) ’flex completion style is used to provide fuzzy aka flex completion. By default, like in Emacs vanilla, all completion commands (e.g., completion-at-point) using completion-in-region or completing-read use completion-styles. Some Helm native commands like helm-M-x do use completion-styles. Any Helm sources can use completion-styles by using :match-dynamic slot and building their :candidates function with helm-dynamic-completion.

Example:

(helm :sources (helm-build-sync-source "test"
                 :candidates (helm-dynamic-completion
                              ’(foo bar baz foab)
                              ’symbolp)
                 :match-dynamic t)
      :buffer "*helm test*")

By default Helm sets up completion-styles and always adds ’helm to it. However the flex completion styles are not added. This is up to the user if she wants to have such completion to enable this. As specified above use ’flex for emacs-27 and ’helm-flex for emacs-26. Anyway, ’helm-flex is not provided in completion-styles-alist if ’flex is present.

Finally Helm provides two user variables to control completion-styles usage: helm-completion-style and helm-completion-syles-alist. Both variables are customizable. The former allows retrieving previous Helm behavior if needed, by setting it to helm or helm-fuzzy, default being emacs which allows dynamic completion and usage of completion-styles. The second allows setting helm-completion-style per mode and also specifying completion-styles per mode (see its docstring). Note that these two variables take effect only in helm-mode i.e. in all that uses completion-read or completion-in-region, IOW all helmized commands. File completion in read-file-name family doesn’t obey completion-styles and has its own file completion implementation. Native Helm commands using completion-styles doesn’t obey helm-completion-style and helm-completion-syles-alist (e.g., helm-M-x).

Also for a better control of styles in native Helm sources (not helmized by helm-mode) using :match-dynamic, helm-dynamic-completion provides a STYLES argument that allows specifying explicitely styles for this source.

Note: Some old completion styles are not working fine with Helm and are disabled by default in helm-blacklist-completion-styles. They are anyway not useful in Helm because ’helm style supersedes these styles.

3.5 Helm mode

helm-mode toggles Helm completion in native Emacs functions, so when you turn helm-mode on, commands like switch-to-buffer will use Helm completion instead of the usual Emacs completion buffer.

3.5.1 What gets or does not get ‘helmized’ when helm-mode is enabled?

Helm provides generic completion on all Emacs functions using completing-read, completion-in-region and their derivatives, e.g. read-file-name. Helm exposes a user variable to control which function to use for a specific Emacs command: helm-completing-read-handlers-alist. If the function for a specific command is nil, it turns off Helm completion. See the variable documentation for more infos.

3.5.2 Helm functions vs helmized Emacs functions

While there are Helm functions that perform the same completion as other helmized Emacs functions, e.g. switch-to-buffer and helm-buffers-list, the native Helm functions like helm-buffers-list can receive new features that allow marking candidates, have several actions, etc. Whereas the helmized Emacs functions only have Helm completion, Emacs can provide no more than one action for this function. This is the intended behavior.

Generally you are better off using the native Helm command than the helmized Emacs equivalent.

3.5.3 Completion behavior with Helm and completion-at-point

Helm is NOT completing dynamically. That means that when you are completing some text at point, completion is done against this text and subsequent characters you add AFTER this text. This allows you to use matching methods provided by Helm, that is multi matching or fuzzy matching (see Matching in Helm).

Completion is not done dynamically (against helm-pattern) because backend functions (i.e. competion-at-point-functions) are not aware of Helm matching methods.

By behaving like this, the benefit is that you can fully use Helm matching methods but you can’t start a full completion against a prefix different than the initial text you have at point. Helm warns you against this by colorizing the initial input and sends a user-error message when trying to delete backward text beyond this limit at first hit on DEL. A second hit on DEL within a short delay (1s) quits Helm and delete-backward char in current-buffer.

3.6 Helm help

C-x c h h: Show all Helm documentations concatenated in one org file.

From a Helm session, just hit C-h m to have the documentation for the current source followed by the global Helm documentation.

While in the help buffer, most of the Emacs regular key bindings are available; the most important ones are shown in minibuffer. However, due to implementation restrictions, no regular Emacs keymap is used (it runs in a loop when reading the help buffer). Only simple bindings are available and they are defined in helm-help-hkmap, which is a simple alist of (key . function). You can define or redefine bindings in help with helm-help-define-key or by adding/removing entries directly in helm-help-hkmap. See helm-help-hkmap for restrictions on bindings and functions.

The documentation of default bindings are:

3.7 Customize Helm

Helm provides a lot of user variables for extensive customization. From any Helm session, type C-h c to jump to the current source custom group. Helm also has a special group for faces you can access via M-x customize-group RET helm-faces.

Note: Some sources may not have their group set and default to the helm group.

3.8 Display Helm in windows and frames

You can display the Helm completion buffer in many different window configurations, see the custom interface to discover the different windows configurations available (See Customize Helm to jump to custom interface). When using Emacs in a graphic display (i.e. not in a terminal) you can as well display your Helm buffers in separated frames globally for all Helm commands or separately for specific Helm commands. See helm-display-function and helm-commands-using-frame.

There is a variable to allow reusing frame instead of deleting and creating a new one at each session, see helm-display-buffer-reuse-frame. Normally you don’t have to use this, it have been made to workaround slow frame popup in Emacs-26, to workaround this slowness in Emacs-26 use instead

(when (= emacs-major-version 26)
  (setq x-wait-for-event-timeout nil))

Additional Readings:

• https://github.com/emacs-helm/helm/wiki/frame

Warning: There is a package called posframe and also one called helm-posframe, you DO NOT need these packages to display helm buffers in frames.

3.9 Helm’s basic operations and default key bindings

Note: Any of these bindings are from helm-map and may be overriten by the map specific to the current source in use (each source can have its own keymap).

3.10 The actions menu

You can display the action menu in the same window as helm candidates (default) or in a side window according to helm-show-action-window-other-window value.

When the action menu popup, the helm prompt is used to narrow down this menu, no more candidates.

When helm-allow-mouse is non nil, you can use as well mouse-3 (right click) in the candidate zone to select actions with the mouse once your candidate is selected.

3.11 Action transformers

You may be surprized to see your actions list changing depending on the context. This happen when a source has an action transformer function which checks the current selected candidate and adds specific actions for this candidate.

3.12 Shortcuts for n-th first actions

<f1>…<f12>: Execute n-th action where n is 1 to 12.

3.13 Shortcuts for executing the default action on the n-th candidate

Helm does not display line numbers by default, with Emacs-26+ you can enable it permanently in all helm buffers with:

(add-hook ’helm-after-initialize-hook ’helm-init-relative-display-line-numbers)

You can also toggle line numbers with C-c l in current Helm buffer.

Of course when enabling global-display-line-numbers-mode Helm buffers will have line numbers as well. (Don’t forget to customize display-line-numbers-type to relative).

In Emacs versions < to 26 you will have to use linum-relative¹⁶ package and helm-linum-relative-mode.

Then when line numbers are enabled with one of the methods above the following keys are available¹⁷:

C-x <n>: Execute default action on the n-th candidate before currently selected candidate.

C-c <n>: Execute default action on the n-th candidate after current selected candidate.

‘n’ is limited to 1-9. For larger jumps use other navigation keys.

3.14 Mouse control in Helm

A basic support for the mouse is provided when the user sets helm-allow-mouse to non-nil.

• mouse-1 selects the candidate.
• mouse-2 executes the default action on selected candidate.
• mouse-3 pops up the action menu.

Note: When mouse control is enabled in Helm, it also lets you click around and lose the minibuffer focus: you’ll have to click on the Helm buffer or the minibuffer to retrieve control of your Helm session.

3.15 Marked candidates

You can mark candidates to execute an action on all of them instead of the current selected candidate only. (See bindings below.) Most Helm actions operate on marked candidates unless candidate-marking is explicitely forbidden for a specific source.

• To mark/unmark a candidate, use C-@. (See bindings below.) With a numeric prefix arg mark ARG candidates forward, if ARG is negative mark ARG candidates backward.
• To mark all visible unmarked candidates at once in current source use M-a. With a prefix argument, mark all candidates in all sources.
• To unmark all visible marked candidates at once use M-U.
• To mark/unmark all candidates at once use M-m. With a prefix argument, mark/unmark all candidates in all sources.

Note: When multiple candidates are selected across different sources, only the candidates of the current source will be used when executing most actions (as different sources can have different actions). Some actions support multi-source marking however.

3.16 Follow candidates

When helm-follow-mode is on (C-c C-f to toggle it), moving up and down Helm session or updating the list of candidates will automatically execute the persistent-action as specified for the current source.

If helm-follow-mode-persistent is non-nil, the state of the mode will be restored for the following Helm sessions.

If you just want to follow candidates occasionally without enabling helm-follow-mode, you can use C-<down> or C-<up> instead. Conversely, when helm-follow-mode is enabled, those commands go to previous/next line without executing the persistent action.

3.17 Frequently Used Commands

3.18 Special yes, no or yes for all answers

You may be prompted in the minibuffer to answer by [y,n,!,q] in some places for confirmation.

• y mean yes
• no mean no
• ! mean yes for all
• q mean quit or abort current operation.

When using ! you will not be prompted for the same thing in current operation any more, e.g. file deletion, file copy etc…

3.19 Moving in helm-buffer

You can move in helm-buffer with the usual commands used in Emacs: (C-n, C-p, etc. See above basic commands. When helm-buffer contains more than one source, change source with C-o and M-o.

Note: When reaching the end of a source, C-n will not go to the next source when variable helm-move-to-line-cycle-in-source is non-nil, so you will have to use C-o and M-o.

3.20 Resume previous session from current Helm session

You can use C-c n (helm-run-cycle-resume) to cycle in resumables sources. C-c n is a special key set with helm-define-key-with-subkeys which, after pressing it, allows you to keep cycling with further n.

Tip: You can bound the same key in global-map to helm-cycle-resume with helm-define-key-with-subkeys to let you transparently cycle sessions, Helm fired up or not. You can also bind the cycling commands to single key presses (e.g., S-<f1>) this time with a simple define-key. (Note that S-<f1> is not available in terminals.)

Note: helm-define-key-with-subkeys is available only once Helm is loaded.

You can also use C-x b to resume the previous session, or C-x C-b to have completion on all resumable buffers.

3.21 Global commands

3.21.1 Resume Helm session from outside Helm

C-x c b revives the last Helm session. Binding a key to this command will greatly improve Helm interactivity, e.g. when quitting Helm accidentally.

You can call C-x c b with a prefix argument to choose (with completion!) which session you’d like to resume. You can also cycle in these sources with helm-cycle-resume (see above).

3.22 Debugging Helm

Helm exposes the special variable helm-debug: setting it to non-nil will enable Helm logging in a special outline-mode buffer. Helm resets the variable to nil at the end of each session.

For convenience, C-h C-d allows you to turn on debugging for this session only. To avoid accumulating log entries while you are typing patterns, you can use C-! to turn off updating. When you are ready turn it on again to resume logging.

Once you exit your Helm session you can access the debug buffer with helm-debug-open-last-log. It is possible to save logs to dated files when helm-debug-root-directory is set to a valid directory.

Note: Be aware that Helm log buffers grow really fast, so use helm-debug only when needed.

3.23 Writing your own Helm sources

Writing simple sources for your own usage is easy. When calling the helm function, the sources are added the :sources slot which can be a symbol or a list of sources. Sources can be built with different EIEIO classes depending on what you want to do. To simplify this, several helm-build-* macros are provided. Below there are simple examples to start with.

;; Candidates are stored in a list.
(helm :sources (helm-build-sync-source "test"
                 ;; A function can be used as well
                 ;; to provide candidates.
                 :candidates ’("foo" "bar" "baz"))
      :buffer "*helm test*")

;; Candidates are stored in a buffer.
;; Generally faster but doesn’t allow a dynamic updating
;; of the candidates list i.e the list is fixed on start.
(helm :sources (helm-build-in-buffer-source "test"
                 :data ’("foo" "bar" "baz"))
      :buffer "*helm test*")

Additional Readings:

For source code and complex examples

https://github.com/emacs-helm/helm/wiki/Developing

3.24 Helm Map

4 Package: helm

4.1 Library: helm

4.1.1 Modes in library helm

other-mode-p

helm-major-mode

[INTERNAL] Provide major-mode name in Helm buffers. Unuseful when used outside Helm, don’t use it.

This mode runs the hook helm-major-mode-hook, as the final or penultimate step during initialization.

\{helm-major-mode-map}

minor-mode-p

helm--minor-mode

(helm–minor-mode &optional ARG)

[INTERNAL] Enable keymap in Helm minibuffer. Since this mode has no effect when run outside of Helm context, please don’t use it outside of Helm.

If called interactively, toggle Helm- minor mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

The mode’s hook is called both when the mode is enabled and when it is disabled.

\{helm-map}

helm--remap-mouse-mode

(helm–remap-mouse-mode &optional ARG)

[INTERNAL] Prevent escaping helm minibuffer with mouse clicks. Do nothing when used outside of helm context.

If called interactively, toggle Helm--Remap-Mouse mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

The mode’s hook is called both when the mode is enabled and when it is disabled.

WARNING: Do not use this mode yourself, it is internal to Helm.

helm-autoresize-mode

(helm-autoresize-mode &optional ARG)

Auto resize helm window when enabled. Helm window is re-sized according to helm-autoresize-max-height and helm-autoresize-min-height. Note that when this mode is enabled, Helm behaves as if helm-always-two-windows is enabled.

If called interactively, toggle Helm-Autoresize mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

The mode’s hook is called both when the mode is enabled and when it is disabled.

See fit-window-to-buffer for more infos.

4.1.2 Commands in keymap helm-map

Most Important

C-g (helm-keyboard-quit)

Quit minibuffer in helm. If action buffer is displayed, kill it.

RET (helm-maybe-exit-minibuffer)

C-j (helm-execute-persistent-action)

(helm-execute-persistent-action &optional ATTR SPLIT)

Perform the associated action ATTR without quitting helm.

Arg ATTR default will be persistent-action or persistent-action-if if unspecified depending on what’s found in source, but it can be anything else. In this case you have to add this new attribute to your source. See persistent-action and persistent-action-if slot documentation in helm-source.

When helm-full-frame is non-nil, and helm-buffer is displayed in only one window, the helm window is split to display helm-select-persistent-action-window in other window to maintain visibility. The argument SPLIT can be used to force splitting inconditionally, it is unused actually.

TAB (helm-select-action)

Select an action for the currently selected candidate. If action buffer is selected, back to the Helm buffer.

C-x 1 (helm-execute-selection-action-at-nth-+1)

C-c 1 (helm-execute-selection-action-at-nth-+1)

C-x 2 (helm-execute-selection-action-at-nth-+2)

C-c 2 (helm-execute-selection-action-at-nth-+2)

C-x 3 (helm-execute-selection-action-at-nth-+3)

C-c 3 (helm-execute-selection-action-at-nth-+3)

C-x 4 (helm-execute-selection-action-at-nth-+4)

C-c 4 (helm-execute-selection-action-at-nth-+4)

C-x 5 (helm-execute-selection-action-at-nth-+5)

C-c 5 (helm-execute-selection-action-at-nth-+5)

C-x 6 (helm-execute-selection-action-at-nth-+6)

C-c 6 (helm-execute-selection-action-at-nth-+6)

C-x 7 (helm-execute-selection-action-at-nth-+7)

C-c 7 (helm-execute-selection-action-at-nth-+7)

C-x 8 (helm-execute-selection-action-at-nth-+8)

C-c 8 (helm-execute-selection-action-at-nth-+8)

C-x 9 (helm-execute-selection-action-at-nth-+9)

C-c 9 (helm-execute-selection-action-at-nth-+9)

C-<tab>

C-s

C-h h

C-h C-h

M-s (undefined)

Beep to tell the user this binding is undefined.

C-k (helm-delete-minibuffer-contents)

(helm-delete-minibuffer-contents &optional ARG)

Delete minibuffer contents. When helm-delete-minibuffer-contents-from-point is non-nil, delete minibuffer contents from point instead of deleting all. With a prefix arg reverse this behaviour. When at the end of minibuffer, delete all.

<help> m

C-h m

C-c ? (helm-help)

Generate Helm’s help according to help-message attribute.

If helm-buffer is empty, provide completions on helm-sources to choose its local documentation. If source doesn’t have any help-message attribute, a generic message explaining this is added instead. The global helm-help-message is always added after this local help.

C-h c (helm-customize-group)

Jump to customization group of current source.

Default to Helm group when group is not defined in source.

Minor Modes

C-c l (helm-display-line-numbers-mode)

(helm-display-line-numbers-mode &optional ARG)

Toggle display of line numbers in current Helm buffer.

If called interactively, toggle Helm-Display-Line-Numbers mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

The mode’s hook is called both when the mode is enabled and when it is disabled.

C-c C-f (helm-follow-mode)

(helm-follow-mode &optional ARG)

Execute persistent action every time the cursor is moved.

This mode is source local, i.e. It applies on current source only. \<helm-map> This mode can be enabled or disabled interactively at anytime during a helm session with \[helm-follow-mode].

When enabling interactively helm-follow-mode in a source, you can keep it enabled for next Emacs sessions by setting helm-follow-mode-persistent to a non-nil value.

When helm-follow-mode is called with a prefix arg and helm-follow-mode-persistent is non-nil helm-follow-mode will be persistent only for this Emacs session, but not for the next Emacs sessions, i.e. the current source will not be saved to helm-source-names-using-follow.

A prefix arg with helm-follow-mode already enabled will have no effect.

Note that you can use instead of this mode the commands helm-follow-action-forward and helm-follow-action-backward at anytime in all Helm sessions.

They are bound by default to \[helm-follow-action-forward] and \[helm-follow-action-backward].

Control what is displayed

C-c > (helm-toggle-truncate-line)

Toggle truncate-lines value in helm-buffer

C-M-e (helm-display-all-sources)

Display all sources previously hidden by helm-set-source-filter.

C-M-a (helm-show-all-candidates-in-source)

(helm-show-all-candidates-in-source ARG)

Toggle all or only candidate-number-limit cands in current source. With a numeric prefix arg show only the ARG number of candidates. The prefix arg has no effect when toggling to only candidate-number-limit.

Control the layout

C-c % (helm-exchange-minibuffer-and-header-line)

Display minibuffer in header-line and vice versa for current Helm session.

This is a toggle command.

C-{ (helm-enlarge-window)

Enlarge helm window.

C-} (helm-narrow-window)

Narrow helm window.

C-c - (helm-swap-windows)

Swap window holding helm-buffer with other window.

C-c _ (helm-toggle-full-frame)

(helm-toggle-full-frame &optional ARG)

Toggle helm-buffer full-frame view.

C-t (helm-toggle-resplit-and-swap-windows)

Multi key command to re-split and swap Helm window. First call runs helm-toggle-resplit-window, and second call within 1s runs helm-swap-windows.

Act on Other Window

C-l (helm-recenter-top-bottom-other-window)

(helm-recenter-top-bottom-other-window &optional ARG)

Run recenter-top-bottom in other window. Meaning of prefix ARG is the same as in recenter-top-bottom.

C-M-l (helm-reposition-window-other-window)

(helm-reposition-window-other-window &optional ARG)

Run reposition-window in other window. Meaning of prefix ARG is the same as in reposition-window.

C-M-<down>

M-<next>

C-M-v (helm-scroll-other-window)

(helm-scroll-other-window &optional ARG)

Scroll other window upward ARG many lines. When arg is not provided scroll helm-scroll-amount lines. See scroll-other-window.

C-M-<up>

M-<prior>

C-M-S-v

C-M-y (helm-scroll-other-window-down)

(helm-scroll-other-window-down &optional ARG)

Scroll other window downward ARG many lines. When arg is not provided scroll helm-scroll-amount lines. See scroll-other-window-down.

Navigate

• Move by line

  C-p

  <up> (helm-previous-line)

  (helm-previous-line &optional ARG)

  Move selection to the ARG previous line(s). Same behavior as helm-next-line when called with a numeric prefix arg.

  C-n

  <down> (helm-next-line)

  (helm-next-line &optional ARG)

  Move selection to the next ARG line(s). When numeric prefix arg is > than the number of candidates, then move to the last candidate of current source (i.e. don’t move to next source).

• Move by page

  <prior>

  M-v (helm-previous-page)

  Move selection back with a pageful.

  C-v

  <next> (helm-next-page)

  Move selection forward with a pageful.

• Move by source

  <left>

  M-o (helm-previous-source)

  Move selection to the previous source.

  <right>

  C-o (helm-next-source)

  Move selection to the next source.

• Move to beginning or end of buffer

  M-< (helm-beginning-of-buffer)

  Move selection at the top.

  M-> (helm-end-of-buffer)

  Move selection at the bottom.

• Move by mark

  M-( (helm-prev-visible-mark)

  Move previous helm visible mark.

  M-) (helm-next-visible-mark)

  (helm-next-visible-mark &optional PREV)

  Move next Helm visible mark. If PREV is non-nil move to precedent.

Mark

M-a (helm-mark-all)

(helm-mark-all &optional ALL)

Mark all visible unmarked candidates in current source.

With a prefix arg mark all visible unmarked candidates in all sources.

M-U (helm-unmark-all)

Unmark all candidates in all sources of current helm session.

C-@ (helm-toggle-visible-mark)

(helm-toggle-visible-mark ARG)

Toggle Helm visible mark at point ARG times. If ARG is negative toggle backward.

M-m (helm-toggle-all-marks)

(helm-toggle-all-marks &optional ALL)

Toggle all marks.

Mark all visible candidates of current source or unmark all candidates visible or invisible in all sources of current Helm session.

With a prefix argument mark all candidates in all sources.

M-SPC (helm-toggle-visible-mark-backward)

C-SPC (helm-toggle-visible-mark-forward)

Act on Selected Candidates

C-c TAB (helm-copy-to-buffer)

Copy selection or marked candidates to helm-current-buffer. Note that the real values of candidates are copied and not the display values.

C-c C-k (helm-kill-selection-and-quit)

(helm-kill-selection-and-quit ARG)

Store display value of current selection to kill ring. With a prefix arg use real value of current selection. Display value is shown in helm-buffer and real value is used to perform actions.

C-c C-y (helm-yank-selection)

(helm-yank-selection ARG)

Set minibuffer contents to current display selection. With a prefix arg set to real value of current selection.

Move and Act

C-<up> (helm-follow-action-backward)

Go to previous line and execute persistent action.

C-<down> (helm-follow-action-forward)

Go to next line and execute persistent action.

Resume Previous Session (after quitting)

C-x b (helm-resume-previous-session-after-quit)

Resume previous Helm session within a running Helm.

Suspend Update of Candidates

C-! (helm-toggle-suspend-update)

Enable or disable display update in helm. This can be useful for example for quietly writing a complex regexp without Helm constantly updating.

Helm Refresh

C-c C-u (helm-refresh)

Force recalculation and update of candidates.

Find file after Quit

C-x C-f (helm-quit-and-find-file)

Drop into helm-find-files from helm. If current selection is a buffer or a file, helm-find-files from its directory.

List Buffers after Quitting

C-x C-b (helm-resume-list-buffers-after-quit)

List Helm buffers that can be resumed within a running Helm.

Debug Helm

C-h C-d (helm-enable-or-switch-to-debug)

First hit enable helm debugging, second hit switch to debug buffer.

4.1.3 Commands in library helm (excludes keymaps)

Debug

helm-debug-open-last-log

Open Helm log file or buffer of last Helm session.

helm-debug-output

Show all Helm-related variables at this time.

Select

helm-menu-select-action

(helm-menu-select-action EVENT)

Popup action menu from mouse-3.

helm-mouse-select-candidate

(helm-mouse-select-candidate EVENT)

Resume

helm-cycle-resume

Cycle in helm-buffers list and resume when waiting more than 1.2s.

C-x c b (helm-resume)

(helm-resume ARG)

Resume a previous Helm session. Call with a prefix arg to choose among existing Helm buffers (sessions). When calling from Lisp, specify a buffer-name as a string with ARG.

helm-run-cycle-resume

Same as helm-cycle-resume but intended to be called only from Helm.

uncategorized

helm-configuration

Customize Helm.

helm-confirm-and-exit-minibuffer

Maybe ask for confirmation when exiting helm. It is similar to minibuffer-complete-and-exit adapted to Helm. If minibuffer-completion-confirm value is ’confirm, send minibuffer confirm message and exit on next hit. If minibuffer-completion-confirm value is t, don’t exit and send message ’no match’.

helm-delete-backward-no-update

(helm-delete-backward-no-update ARG)

Disable update and delete ARG chars backward. Update is reenabled when idle 1s.

helm-toggle-resplit-window

Toggle resplit helm window, vertically or horizontally.

4.1.4 Options in library ‘helm’

Min

helm-tramp-connection-min-time-diff

Standard Value: 5

Value of tramp-connection-min-time-diff for Helm remote processes. If set to zero Helm remote processes are not delayed.

Setting this to a value less than 5 or disabling it with a zero value is risky, however on Emacs versions starting at 24.5 it seems it is now possible to disable it.

Anyway at any time in Helm you can suspend your processes while typing by hitting C-!.

Only async sources than use a sentinel calling helm-process-deferred-sentinel-hook are affected by this.

Windows

helm-always-two-windows

Standard Value: nil

When non-nil Helm uses two windows in this frame.

I.e. helm-buffer in one window and helm-current-buffer in the other.

Note: this has no effect when helm-split-window-inside-p is non-nil, or when helm-split-window-default-side is set to ’same.

When helm-autoresize-mode is enabled, setting this to nil will have no effect.

Also when non-nil it overrides the effect of helm-split-window-default-side set to other.

Functions

helm-save-configuration-functions

Standard Value:

(set-window-configuration . current-window-configuration)

Functions used to restore or save configurations for frames and windows. Specified as a pair of functions, where car is the restore function and cdr is the save function.

To save and restore frame configuration, set this variable to ’(set-frame-configuration . current-frame-configuration)

NOTE: This may not work properly with own-frame minibuffer settings. Older versions saves/restores frame configuration, but the default has changed now to avoid flickering.

Candidate

helm-candidate-number-limit

Standard Value: 100

Global limit for number of candidates displayed. When the pattern is empty, the number of candidates shown will be as set here instead of the entire list, which may be hundreds or thousands. Since narrowing and filtering rapidly reduces available candidates, having a small list will keep the interface responsive.

Set this value to nil for no limit.

helm-candidate-separator

Standard Value: ――――――――――――――――――――――――――――――――――――――

Candidates separator of multiline source.

Minibuffer

helm-delete-minibuffer-contents-from-point

Standard Value: t

When non-nil, helm-delete-minibuffer-contents deletes region from point. Otherwise it deletes minibuffer-contents. See documentation for helm-delete-minibuffer-contents.

helm-prevent-escaping-from-minibuffer

Standard Value: t

Prevent escaping from minibuffer with other-window during the Helm session.

Width

helm-left-margin-width

Standard Value: 0

left-margin-width value for the helm-buffer.

Delay

helm-cycle-resume-delay

Standard Value: 1.0

Delay used before resuming in helm-run-cycle-resume.

helm-exit-idle-delay

Standard Value: 0

Idle time before exiting minibuffer while Helm is updating. Has no affect when helm-buffer is up to date (i.e. exit without delay in this condition).

Mouse

helm-allow-mouse

Standard Value: nil

Allow mouse usage during the Helm session when non-nil.

Note that this also allows moving out of minibuffer when clicking outside of helm-buffer, so it is up to you to get back to Helm by clicking back in helm-buffer or minibuffer.

Source

helm-source-names-using-follow

Standard Value: nil

A list of source names to have follow enabled. This list of source names will be used only when helm-follow-mode-persistent is non-nil.

You don’t have to customize this yourself unless you really want and know what you are doing, instead just set helm-follow-mode-persistent to non-nil and as soon as you turn on or off helm-follow-mode (C-c C-f) in a source, Helm will save or remove source name in this variable.

Search

helm-case-fold-search

Standard Value: smart

Adds ’smart’ option to case-fold-search. Smart option ignores case for searches as long as there are no upper case characters in the pattern.

Use nil or t to turn off smart behavior and use case-fold-search behavior.

Default is smart.

NOTE: Case fold search has no effect when searching asynchronous sources, which relies on customized features implemented directly into their execution process. See helm-grep.el for an example.

helm-file-name-case-fold-search

Standard Value: smart

Local setting of helm-case-fold-search for reading filenames.

See helm-case-fold-search for more info.

Action

helm-action-at-nth-negative-prefix-key

Standard Value: C-x %d

The prefix key to execute default action on nth <-n> candidate.

This is a format spec where %d will be replaced by the candidate number.

NOTE: setq have no effect until you restart Emacs, use customize for immediate effect.

helm-action-at-nth-positive-prefix-key

Standard Value: C-c %d

The prefix key to execute default action on nth <+n> candidate.

This is a format spec where %d will be replaced by the candidate number.

NOTE: setq have no effect until you restart Emacs, use customize for immediate effect.

Fuzzy

helm-fuzzy-match-fn

Standard Value: helm-fuzzy-match

The function for fuzzy matching in helm-source-sync based sources.

helm-fuzzy-matching-highlight-fn

Standard Value: helm-fuzzy-default-highlight-match

The function to highlight fuzzy matches.

helm-fuzzy-search-fn

Standard Value: helm-fuzzy-search

The function for fuzzy matching in helm-source-in-buffer based sources.

helm-fuzzy-sort-fn

Standard Value: helm-fuzzy-matching-default-sort-fn

The sort transformer function used in fuzzy matching.

Autoresize

helm-autoresize-max-height

Standard Value: 40

Specify maximum height and defaults to percent of Helm window’s frame height.

See fit-window-to-buffer for more infos.

helm-autoresize-min-height

Standard Value: 10

Specify minimum height and defaults to percent of Helm window’s frame height.

If nil, window-min-height is used. See fit-window-to-buffer for details.

Line

helm-header-line-space-before-prompt

Standard Value: left-fringe

Specify the space before prompt in header-line.

This will be used when helm-echo-input-in-header-line is non-nil.

Value can be one of the symbols ’left-fringe or ’left-margin or an integer specifying the number of spaces before prompt. Note that on input longer that window-width the continuation string will be shown on left side of window without taking care of this.

helm-move-to-line-cycle-in-source

Standard Value: nil

Cycle to the beginning or end of the list after reaching the bottom or top. This applies when using helm-next/previous-line.

Input

helm-echo-input-in-header-line

Standard Value: nil

Send current input to header-line when non-nil.

helm-inherit-input-method

Standard Value: t

Inherit current-input-method from current-buffer when non-nil. The default is to enable this by default and then toggle toggle-input-method.

helm-input-idle-delay

Standard Value: 0.01

Idle time before updating, specified in seconds.

helm-input-method-verbose-flag

Standard Value: nil

The default value for input-method-verbose-flag used in Helm minibuffer. It is nil by default, which does not turn off input method. Helm updates and exits without interruption – necessary for complex methods.

If set to any other value as per input-method-verbose-flag, then use C-\ to disable the current-input-method to exit or update Helm.

Mode

helm--minor-mode-hook

Standard Value: nil

Hook run after entering or leaving helm--minor-mode. No problems result if this variable is not bound. add-hook automatically binds it. (This is true for all hook variables.)

helm--remap-mouse-mode-hook

Standard Value: nil

Hook run after entering or leaving helm--remap-mouse-mode. No problems result if this variable is not bound. add-hook automatically binds it. (This is true for all hook variables.)

helm-autoresize-mode-hook

Standard Value: nil

Hook run after entering or leaving helm-autoresize-mode. No problems result if this variable is not bound. add-hook automatically binds it. (This is true for all hook variables.)

helm-follow-mode-persistent

Standard Value: nil

When non-nil, save last state of helm-follow-mode for the next Emacs sessions.

Each time you turn on or off helm-follow-mode, the current source name will be stored or removed from helm-source-names-using-follow.

Note that this may be disabled in some places where it is unsafe to use because persistent action is changing according to context.

Default

helm-sources-using-default-as-input

Standard Value:

(helm-source-imenu helm-source-imenu-all helm-source-info-elisp helm-source-etags-select helm-source-man-pages helm-source-occur helm-source-moccur helm-source-grep-ag helm-source-grep-git helm-source-grep)

List of Helm sources that need to use helm-maybe-use-default-as-input. When a source is a member of this list, default thing-at-point will be used as input.

Frame Use

helm-use-frame-when-more-than-two-windows

Standard Value: nil

Display Helm buffer in frame when more than two windows.

helm-use-undecorated-frame-option

Standard Value: t

Display Helm frame undecorated when non nil.

This option has no effect with Emacs versions lower than 26.

Frame Color

helm-frame-background-color

Standard Value: nil

Background color for Helm frames, a string. Fallback to default face background when nil.

helm-frame-foreground-color

Standard Value: nil

Foreground color for Helm frames, a string. Fallback to default face foreground when nil

Frame uncategorized

helm-actions-inherit-frame-settings

Standard Value: t

Actions inherit Helm frame settings of initial command when non nil.

helm-commands-using-frame

Standard Value: nil

A list of commands where helm-buffer is displayed in a frame.

helm-frame-alpha

Standard Value: nil

Alpha parameter for Helm frames, an integer. Fallback to 100 when nil.

helm-full-frame

Standard Value: nil

Use current window for showing candidates. If t, then Helm does not pop-up a new window.

Window When

helm-use-frame-when-dedicated-window

Standard Value: nil

Display Helm buffer in frame when Helm is started from a dedicated window.

Window Other

helm-show-action-window-other-window

Standard Value: nil

Show action buffer beside helm-buffer when non-nil.

If nil don’t split and replace helm-buffer by the action buffer in same window. If left display the action buffer at the left of helm-buffer. If right or any other value, split at right.

Note that this may not fit well with some Helm window configurations, so it have only effect when helm-always-two-windows is non-nil.

Window Split

helm-reuse-last-window-split-state

Standard Value: nil

Use the same state of window split, vertical or horizontal. helm-toggle-resplit-window for the next helm session will use the same window scheme as the previous session unless helm-split-window-default-side is ’same or ’other.

helm-split-window-default-side

Standard Value: below

The default side to display helm-buffer. Must be one acceptable arg for split-window SIDE, that is below, above, left or right.

Other acceptable values are same which always displays helm-buffer in current window and other that displays helm-buffer below if only one window or in other-window-for-scrolling when available.

A nil value has same effect as below. If helm-full-frame is non-nil, it take precedence over this setting.

See also helm-split-window-inside-p and helm-always-two-windows that take precedence over this.

NOTE: this has no effect if helm-split-window-preferred-function is not helm-split-window-default-fn unless this new function can handle this.

helm-split-window-in-side-p

Standard Value: nil

Force split inside selected window when non-nil. See also helm-split-window-default-side.

NOTE: this has no effect if helm-split-window-preferred-function is not helm-split-window-default-fn unless this new function can handle this.

helm-split-window-inside-p

Standard Value: nil

Force split inside selected window when non-nil. See also helm-split-window-default-side.

NOTE: this has no effect if helm-split-window-preferred-function is not helm-split-window-default-fn unless this new function can handle this.

helm-split-window-other-side-when-one-window

Standard Value: below

The default side to display helm-buffer when (1) helm-split-window-default-side is ’other and (2) the current frame only has one window. Possible values are acceptable args for split-window SIDE, that is below, above, left or right.

If helm-full-frame is non-nil, it takes precedence over this setting.

See also helm-split-window-inside-p and helm-always-two-windows that takes precedence over this.

NOTE: this has no effect if helm-split-window-preferred-function is not helm-split-window-default-fn unless this new function can handle this.

helm-split-window-preferred-function

Standard Value: helm-split-window-default-fn

Default function used for splitting window.

Window uncategorized

helm-completion-window-scroll-margin

Standard Value: 5

scroll-margin to use for Helm completion window. Set to 0 to disable. NOTE: This has no effect when helm-display-source-at-screen-top id is non-nil.

Display Line

helm-display-header-line

Standard Value: t

Display header-line when non nil.

helm-display-line-numbers-mode-hook

Standard Value: nil

Hook run after entering or leaving helm-display-line-numbers-mode. No problems result if this variable is not bound. add-hook automatically binds it. (This is true for all hook variables.)

Display Function

helm-display-function

Standard Value: helm-default-display-buffer

Function used to display helm-buffer.

Local value in helm-buffer will take precedence on this default value. Commands that are in helm-commands-using-frame will have helm-buffer displayed in frame, helm-display-function being ignored. If no local value is found and current command is not one of helm-commands-using-frame use this default value. The function in charge of deciding which value use is helm-resolve-display-function.

To set it locally to helm-buffer in Helm sources use helm-set-local-variable in init function or use :display-function slot in helm call.

Display Default

helm-default-prompt-display-function

Standard Value: helm-set-default-prompt-display

The function to use to set face of fake cursor in header-line.

Display Buffer Width

helm-display-buffer-width

Standard Value: 72

Frame width when displaying helm-buffer in own frame.

Display Buffer Height

helm-display-buffer-height

Standard Value: 20

Frame height when displaying helm-buffer in own frame.

Display Buffer Default

helm-default-display-buffer-alist

Standard Value: nil

Additional alist to pass to display-buffer action. See (info “(elisp) Action Alists for Buffer Display”).

It has no effect when helm-always-two-windows is non-nil and may override other settings like helm-split-window-inside-p. Note that window-height and window-width have to be configured in helm-display-buffer-height and helm-display-buffer-width.

helm-default-display-buffer-functions

Standard Value: nil

Action functions to pass to display-buffer. See (info “(elisp) Action Functions for Buffer Display”).

It has no effect when helm-always-two-windows is non-nil and may override other settings like helm-split-window-inside-p.

helm-display-buffer-default-height

Standard Value: nil

Initial height of helm-buffer, specified as an integer or a function.

The function should take one arg and be responsible for re-sizing the window; function’s return value is ignored. Note that this has no effect when the split is vertical. See display-buffer for more info.

helm-display-buffer-default-width

Standard Value: nil

Initial width of helm-buffer, specified as an integer or a function.

The function should take one arg and be responsible for re-sizing the window; function’s return value is ignored. Note that this have no effect when the split is horizontal. See display-buffer for more info.

Display Buffer uncategorized

helm-display-buffer-reuse-frame

Standard Value: nil

When non nil Helm frame is not deleted and reused in next sessions.

This was used to workaround a bug in Emacs where frames where popping up slowly, now that the bug have been fixed upstream (emacs-27) probably you don’t want to use this any more. On emacs-26 set x-wait-for-event-timeout to nil to have your frames popping up fast.

Display uncategorized

helm-display-source-at-screen-top

Standard Value: t

Display candidates at the top of screen. This happens with helm-next-source and helm-previous-source. NOTE: When non-nil (default), disable helm-completion-window-scroll-margin.

minor-mode-p

helm--remap-mouse-mode

Standard Value: nil

(helm–remap-mouse-mode &optional ARG)

[INTERNAL] Prevent escaping helm minibuffer with mouse clicks. Do nothing when used outside of helm context.

If called interactively, toggle Helm--Remap-Mouse mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

The mode’s hook is called both when the mode is enabled and when it is disabled.

WARNING: Do not use this mode yourself, it is internal to Helm.

helm-autoresize-mode

Standard Value: nil

(helm-autoresize-mode &optional ARG)

Auto resize helm window when enabled. Helm window is re-sized according to helm-autoresize-max-height and helm-autoresize-min-height. Note that when this mode is enabled, Helm behaves as if helm-always-two-windows is enabled.

If called interactively, toggle Helm-Autoresize mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

The mode’s hook is called both when the mode is enabled and when it is disabled.

See fit-window-to-buffer for more infos.

uncategorized

helm-debug-root-directory

Standard Value: nil

When non-nil, save Helm log messages to a file in this directory. When nil log messages are saved to a buffer instead. Log message are saved only when helm-debug is non-nil, so setting this doesn’t enable debugging by itself.

See helm-log-save-maybe for more info.

helm-samewindow

Standard Value: nil

Use current window for showing candidates. If t, then Helm does not pop-up a new window.

helm-truncate-lines

Standard Value: nil

The value of truncate-lines when Helm starts. You can toggle later truncate-lines with C-c >.

4.1.5 Hooks in library ‘helm’

Run

helm-log-run-hook

Standard Value:

Exit

helm-confirm-and-exit-hook

Standard Value:

Temp

with-helm-temp-hook

Standard Value:

Hooks

helm--run-init-hooks

Standard Value:

helm--temp-hooks

Standard Value:

((helm--hook94 . helm-after-update-hook))

Store temporary hooks added by with-helm-temp-hook.

Minibuffer

helm-exit-minibuffer-hook

Standard Value:

(helm-files-save-file-name-history)

Runs just before exiting the minibuffer.

This hook runs when Helm exits the minibuffer normally (e.g., via candidate selection), but does NOT run if Helm exits the minibuffer abnormally (e.g. via helm-keyboard-quit).

helm-minibuffer-set-up-hook

Standard Value: nil

Hook that runs at minibuffer initialization. A hook useful for modifying minibuffer settings in Helm.

An example that hides the minibuffer when using helm-echo-input-in-header-line:

(add-hook ’helm-minibuffer-set-up-hook #’helm-hide-minibuffer-maybe)

Note that we check helm-echo-input-in-header-line value from helm-buffer which allows detecting possible local value of this var.

Autoresize

helm--autoresize-hook

Standard Value:

Before

helm-before-initialize-hook

Standard Value: nil

Runs before Helm initialization. This hook runs before init functions in helm-sources, which is before creation of helm-buffer. Set local variables for helm-buffer that need a value from current-buffer with helm-set-local-variable.

helm-move-selection-before-hook

Standard Value: nil

Runs before moving selection in helm-buffer.

Update

helm-before-update-hook

Standard Value: nil

Runs before updating the Helm buffer with the new input pattern.

helm-update-hook

Standard Value:

(helm--maybe-update-keymap helm-match-line-cleanup-maybe helm-revive-visible-mark helm-confirm-and-exit-hook)

Runs after updating the Helm buffer with the new input pattern.

Action

helm-before-action-hook

Standard Value:

(helm-ff-before-action-hook-fn)

Runs before executing action. Unlike helm-cleanup-hook, this hook runs before Helm closes the minibuffer and also before performing an action.

helm-select-action-hook

Standard Value: nil

Runs when opening the action buffer.

Mode

helm--minor-mode-hook

Standard Value: nil

Hook run after entering or leaving helm--minor-mode. No problems result if this variable is not bound. add-hook automatically binds it. (This is true for all hook variables.)

helm--remap-mouse-mode-hook

Standard Value: nil

Hook run after entering or leaving helm--remap-mouse-mode. No problems result if this variable is not bound. add-hook automatically binds it. (This is true for all hook variables.)

helm-autoresize-mode-hook

Standard Value: nil

Hook run after entering or leaving helm-autoresize-mode. No problems result if this variable is not bound. add-hook automatically binds it. (This is true for all hook variables.)

helm-display-line-numbers-mode-hook

Standard Value: nil

Hook run after entering or leaving helm-display-line-numbers-mode. No problems result if this variable is not bound. add-hook automatically binds it. (This is true for all hook variables.)

helm-major-mode-hook

Standard Value: nil

Hook run after entering Hmm mode. No problems result if this variable is not bound. add-hook automatically binds it. (This is true for all hook variables.)

After Action

helm-after-action-hook

Standard Value:

(helm-match-line-cleanup-pulse)

Runs after executing action.

helm-after-persistent-action-hook

Standard Value:

(helm-find-files--reset-level-tree helm-match-line-update helm-persistent-autoresize-hook)

Runs after executing persistent action.

After Update

helm-after-update-hook

Standard Value:

(helm--maybe-update-keymap helm-match-line-cleanup-maybe helm-revive-visible-mark helm-confirm-and-exit-hook)

Runs after updating the Helm buffer with the new input pattern.

with-helm-after-update-hook

Standard Value:

After uncategorized

helm-after-initialize-hook

Standard Value:

(helm-reset-yank-point)

Runs after Helm initialization. This hook runs after helm-buffer is created but not from helm-buffer. The hook needs to specify in which buffer to run.

helm-after-preselection-hook

Standard Value: nil

Runs after pre-selection in helm-buffer.

helm-move-selection-after-hook

Standard Value: nil

Runs after moving selection in helm-buffer.

helm-resume-after-hook

Standard Value:

(helm-ff--update-resume-after-hook)

A hook that runs after resuming a Helm session. The hook should takes one arg SOURCES.

uncategorized

helm-async-outer-limit-hook

Standard Value: nil

A hook that runs in async sources when process output comes out of candidate-number-limit. Should be set locally to helm-buffer with helm-set-local-variable.

helm-cleanup-hook

Standard Value:

(helm-ff-save-history helm-find-files--reset-level-tree helm-match-line-cleanup helm-handle-winner-boring-buffers helm-reset-yank-point)

Runs after exiting the minibuffer and before performing an action.

This hook runs even if Helm exits the minibuffer abnormally (e.g. via helm-keyboard-quit).

helm-process-deferred-sentinel-hook

Standard Value:

helm-quit-hook

Standard Value: nil

A hook that runs when quitting Helm.

helm-window-configuration-hook

Standard Value: nil

Runs when switching to and from the action buffer. Should run also at end of helm-display-function.

4.2 Library: helm-adaptive

4.2.1 Modes in library helm-adaptive

minor-mode-p

helm-adaptive-mode

(helm-adaptive-mode &optional ARG)

Toggle adaptive sorting in all sources.

If called interactively, toggle Helm-Adaptive mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

The mode’s hook is called both when the mode is enabled and when it is disabled.

4.2.2 Commands in library helm-adaptive (excludes keymaps)

History

helm-adaptive-save-history

(helm-adaptive-save-history &optional ARG)

Save history information to the file given by helm-adaptive-history-file.

helm-reset-adaptive-history

Delete all helm-adaptive-history and his file. Useful when you have a old or corrupted helm-adaptive-history-file.

minor-mode-p

helm-adaptive-mode

(helm-adaptive-mode &optional ARG)

Toggle adaptive sorting in all sources.

If called interactively, toggle Helm-Adaptive mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

The mode’s hook is called both when the mode is enabled and when it is disabled.

4.2.3 Options in library ‘helm-adaptive’

Mode

helm-adaptive-mode-hook

Standard Value: nil

Hook run after entering or leaving helm-adaptive-mode. No problems result if this variable is not bound. add-hook automatically binds it. (This is true for all hook variables.)

History

helm-adaptive-history-file

Standard Value: ~/.emacs.d/helm-adaptive-history

Path of file where history information is stored. When nil history is not saved nor restored after Emacs restart unless you save/restore helm-adaptive-history with something else like psession or desktop.

helm-adaptive-history-length

Standard Value: 50

Maximum number of candidates stored for a source.

minor-mode-p

helm-adaptive-mode

Standard Value: nil

(helm-adaptive-mode &optional ARG)

Toggle adaptive sorting in all sources.

If called interactively, toggle Helm-Adaptive mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

The mode’s hook is called both when the mode is enabled and when it is disabled.

uncategorized

helm-adaptive-sort-by-frequent-recent-usage

Standard Value: t

Try to sort on an average of frequent and recent usage when non-nil.

When nil sort on frequency usage only.

Only frequency: When candidate have low frequency, you have to hit on it many times to make it going up on top.

Frequency+recent: Even with a low frequency, candidate go up on top. If a candidate have a high frequency but it is not used since some time, it goes down slowly, but as soon you reuse it it go up on top quickly.

4.2.4 Hooks in library ‘helm-adaptive’

uncategorized

helm-adaptive-mode-hook

Standard Value: nil

Hook run after entering or leaving helm-adaptive-mode. No problems result if this variable is not bound. add-hook automatically binds it. (This is true for all hook variables.)

4.3 Library: helm-bookmark

4.3.1 Commands in keymap helm-bookmark-find-files-map

uncategorized

C-x C-d (helm-bookmark-run-browse-project)

Run helm-bookmark-browse-project from keyboard.

4.3.2 Commands in keymap helm-bookmark-map

uncategorized

C-d (helm-bookmark-run-delete)

Delete bookmark from keyboard.

M-e (helm-bookmark-run-edit)

Run helm-bookmark-edit-bookmark from keyboard.

C-c C-o (helm-bookmark-run-jump-other-frame)

Jump to bookmark other frame from keyboard.

C-c o (helm-bookmark-run-jump-other-window)

Jump to bookmark from keyboard.

C-] (helm-bookmark-toggle-filename)

Toggle bookmark location visibility.

4.3.3 Commands in library helm-bookmark (excludes keymaps)

Bookmarks

helm-bookmarks

Preconfigured helm for bookmarks.

C-x c C-x r b (helm-filtered-bookmarks)

Preconfigured helm for bookmarks (filtered by category). Optional source helm-source-bookmark-addressbook is loaded only if external addressbook-bookmark package is installed.

uncategorized

helm-bookmark-rename

(helm-bookmark-rename OLD &optional NEW BATCH)

Change bookmark’s name from OLD to NEW. Interactively: If called from the keyboard, then prompt for OLD. If called from the menubar, select OLD from a menu. If NEW is nil, then prompt for its string value.

If BATCH is non-nil, then do not rebuild the menu list.

While the user enters the new name, repeated C-w inserts consecutive words from the buffer into the new bookmark name.

4.3.4 Options in library ‘helm-bookmark’

uncategorized

helm-bookmark-default-filtered-sources

Standard Value:

(helm-source-bookmark-org helm-source-bookmark-files&dirs helm-source-bookmark-helm-find-files helm-source-bookmark-info helm-source-bookmark-gnus helm-source-bookmark-man helm-source-bookmark-images helm-source-bookmark-w3m helm-source-bookmark-uncategorized helm-source-bookmark-set)

List of sources to use in helm-filtered-bookmarks.

helm-bookmark-show-location

Standard Value: nil

Show location of bookmark on display.

4.4 Library: helm-buffers

4.4.1 Commands in keymap helm-buffer-map

Control what you see

C-c a (helm-buffers-toggle-show-hidden-buffers)

C-] (helm-toggle-buffers-details)

Browse Project

C-x C-d (helm-buffers-run-browse-project)

Run helm-buffers-browse-project from key.

Switch to Buffer in other frame, window or tab

C-c C-o (helm-buffer-switch-other-frame)

Run switch to other frame action from helm-source-buffers-list.

C-c o (helm-buffer-switch-other-window)

Run switch to other window action from helm-source-buffers-list.

C-c C-t (helm-buffers-switch-to-buffer-new-tab)

Run switch to buffer in other tab action from helm-source-buffers-list.

Run Occur

C-s (helm-buffers-run-occur)

Run helm-multi-occur-as-action by key.

Query Replace on Buffers’ contents

M-% (helm-buffer-run-query-replace)

Run Query replace action from helm-source-buffers-list.

C-M-% (helm-buffer-run-query-replace-regexp)

Run Query replace regexp action from helm-source-buffers-list.

Mark similar Buffers

C-M-SPC (helm-buffers-mark-similar-buffers)

Mark All buffers that have same property type than current. I.e. same color.

Save Buffer

C-x C-s (helm-buffer-save-persistent)

Save buffer without quitting Helm.

C-x s (helm-buffer-run-save-some-buffers)

Save unsaved file buffers without quitting Helm.

Run Diff and friends

C-= (helm-buffer-diff-persistent)

Toggle diff buffer without quitting helm.

C-c = (helm-buffer-run-ediff)

Run ediff action from helm-source-buffers-list.

M-= (helm-buffer-run-ediff-merge)

Run ediff action from helm-source-buffers-list.

Kill Buffers

C-c d (helm-buffer-run-kill-persistent)

Kill buffer without quitting Helm.

M-D (helm-buffer-run-kill-buffers)

Run kill buffer action from helm-source-buffers-list.

Rename Buffer

M-R (helm-buffer-run-rename-buffer)

Run rename buffer action from helm-source-buffers-list.

Revert Buffer

M-G (helm-buffer-revert-persistent)

Revert buffer without quitting helm.

Goto line

M-g M-g (helm-buffer-run-goto-line)

Switch to buffer at line number.

Run ZGrep

M-g s (helm-buffer-run-zgrep)

Run Grep action from helm-source-buffers-list.

4.4.2 Commands in keymap helm-buffer-not-found-map

Create new Buffers in other frame or window

C-c C-o (helm-buffers-not-found-run-switch-of)

Run create new buffer other frame action from keymap.

C-c o (helm-buffers-not-found-run-switch-ow)

Run create new buffer other window action from keymap.

4.4.3 Commands in library helm-buffers (excludes keymaps)

Mini

helm-mini

Preconfigured helm displaying helm-mini-default-sources.

helm-quit-and-helm-mini

Drop into helm-mini from helm.

uncategorized

helm-buffer-run-grep

Run Grep action from helm-source-buffers-list.

C-x c C-x C-b

C-x C-b (helm-buffers-list)

Preconfigured helm to list buffers.

4.4.4 Options in library ‘helm-buffers’

Buffer List

helm-boring-buffer-regexp-list

Standard Value:

("\\` " "\\`\\*helm" "\\`\\*Echo Area" "\\`\\*Minibuf")

The regexp list that match boring buffers. Buffer candidates matching these regular expression will be filtered from the list of candidates if the helm-skip-boring-buffers candidate transformer is used.

helm-buffer-list-reorder-fn

Standard Value: helm-buffers-reorder-buffer-list

A function in charge of ordering the initial buffer list. It takes two arguments VISIBLES buffers and OTHERS buffers. Arg VISIBLES handles the buffers visibles in this frame. Arg OTHERS handles all the other buffers. You can write a function that reorder VISIBLES and OTHERS as you want. Default function returns OTHERS buffers on top and VISIBLES buffer at the end. See helm-buffers-reorder-buffer-list.

helm-white-buffer-regexp-list

Standard Value: nil

The regexp list of not boring buffers. These buffers will be displayed even if they match one of helm-boring-buffer-regexp-list.

Buffer uncategorized

helm-buffer--pretty-names

Standard Value:

((dired-mode . "Dired")
 (lisp-interaction-mode . "Lisp Inter"))

An alist specifying pretty names for modes. Most of the time buffer’s mode-name is a string so no need to add it here as there is no need to compute it, but sometimes it may be a mode-line specification which may be costly to compute, in this case add here the pretty name as a string to avoid this costly computation. Also if some pretty names are too long you can add your own abbreviation here.

helm-buffer-details-flag

Standard Value: t

Always show details in buffer list when non-nil.

helm-buffer-max-length

Standard Value: 20

Max length of buffer names before truncate. When disabled (nil) use the longest buffer-name length found.

helm-buffer-skip-remote-checking

Standard Value: nil

Ignore checking for file-exists-p on remote files.

Buffers uncategorized uncategorized uncategorized

helm-buffers-column-separator

Standard Value:

Separator for columns in buffer listing.

helm-buffers-end-truncated-string

Standard Value: …

The string to display at end of truncated buffer names.

helm-buffers-favorite-modes

Standard Value:

(lisp-interaction-mode emacs-lisp-mode text-mode org-mode)

List of preferred mode to open new buffers with.

helm-buffers-fuzzy-matching

Standard Value: nil

Fuzzy matching buffer names when non-nil. Only buffer names are fuzzy matched when this is enabled, major-mode matching is not affected by this.

helm-buffers-left-margin-width

Standard Value: 0

left-margin-width value for helm-mini and helm-buffers-list.

helm-buffers-maybe-switch-to-tab

Standard Value: nil

Switch to buffer in its tab when non nil. This has no effect when tab-bar-mode is not available.

helm-buffers-sort-fn

Standard Value: helm-fuzzy-matching-default-sort-fn

The sort function to use in helm-buffers-list.

Default to helm-fuzzy-sort-fn you can use helm-fuzzy-matching-sort-fn-preserve-ties-order as alternative if you want to keep the recentest order when narrowing candidates.

helm-buffers-truncate-lines

Standard Value: t

Truncate lines in helm-buffers-list when non-nil.

uncategorized

helm-mini-default-sources

Standard Value:

(helm-source-buffers-list helm-source-recentf helm-source-buffer-not-found)

Default sources list used in helm-mini.

When adding a source here it is up to you to ensure the library of this source is accessible and properly loaded.

4.5 Library: helm-color

4.5.1 Commands in keymap helm-color-map

uncategorized

C-c n (helm-color-run-insert-name)

Insert name of color from helm-source-colors.

C-c r (helm-color-run-insert-rgb)

Insert RGB of color from helm-source-colors.

C-c N (helm-color-run-kill-name)

Kill name of color from helm-source-colors.

C-c R (helm-color-run-kill-rgb)

Kill RGB of color from helm-source-colors.

4.5.2 Commands in library helm-color (excludes keymaps)

uncategorized

C-x c c (helm-colors)

Preconfigured helm for color.

4.6 Library: helm-comint

4.6.1 Commands in keymap helm-comint-prompts-keymap

uncategorized

C-c C-o (helm-comint-prompts-other-frame)

C-c o (helm-comint-prompts-other-window)

4.6.2 Commands in library helm-comint (excludes keymaps)

Prompts

helm-comint-prompts

Pre-configured helm to browse the prompts of the current comint buffer.

helm-comint-prompts-all

Pre-configured helm to browse the prompts of all comint sessions.

uncategorized

helm-comint-input-ring

Preconfigured helm that provide completion of comint history.

4.6.3 Options in library ‘helm-comint’

uncategorized

helm-comint-max-offset

Standard Value: 400

Max number of chars displayed per candidate in comint-input-ring browser. When t, don’t truncate candidate, show all. By default it is approximatively the number of bits contained in five lines of 80 chars each i.e 80*5. Note that if you set this to nil multiline will be disabled, i.e you will not have anymore separators between candidates.

helm-comint-mode-list

Standard Value:

(comint-mode slime-repl-mode sly-mrepl-mode sql-interactive-mode)

Supported modes for prompt navigation. Derived modes (e.g., Geiser’s REPL) are automatically supported.

helm-comint-next-prompt-function

Standard Value:

((sly-mrepl-mode lambda nil
                 (sly-mrepl-next-prompt)
                 (point)))

Alist of (MODE . NEXT-PROMPT-FUNCTION) to use. If the current major mode is a key in this list, the associated function will be used to navigate the prompts. The function must return the point after the prompt. Otherwise (comint-next-prompt 1) will be used.

helm-comint-prompts-promptidx-p

Standard Value: t

Show prompt number.

4.7 Library: helm-command

4.7.1 Commands in keymap helm-M-x-map

uncategorized

C-u (helm-M-x-universal-argument)

Same as universal-argument but for helm-M-x.

4.7.2 Commands in library helm-command (excludes keymaps)

uncategorized

C-x c M-x

<execute>

<menu>

M-x (helm-M-x)

(helm-M-x ARG)

Preconfigured helm for Emacs commands. It is helm replacement of regular M-x execute-extended-command.

Unlike regular M-x Emacs vanilla execute-extended-command command, the prefix args if needed, can be passed AFTER starting helm-M-x. When a prefix arg is passed BEFORE starting helm-M-x, the first C-u while in helm-M-x session will disable it.

You can get help on each command by persistent action.

4.7.3 Options in library ‘helm-command’

X

helm-M-x-always-save-history

Standard Value: nil

helm-M-x save command in extended-command-history even when it fails.

helm-M-x-reverse-history

Standard Value: nil

The history source of helm-M-x appear in second position when non-nil.

helm-M-x-use-completion-styles

Standard Value: nil

Use completion-styles and dynamic completion when non nil. It is disable by default as it is a regression starting from Emacs-27.

minor-mode-p

helm-mode

Standard Value: t

(helm-mode &optional ARG)

Toggle generic helm completion.

If called interactively, toggle Helm mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

The mode’s hook is called both when the mode is enabled and when it is disabled.

All functions in Emacs that use completing-read, read-file-name, completion-in-region and friends will use helm interface when this mode is turned on.

However you can modify this behavior for functions of your choice with helm-completing-read-handlers-alist.

Called with a positive arg, turn on unconditionally, with a negative arg turn off. You can toggle it with M-x helm-mode.

About ido-mode: DO NOT enable ido-everywhere when using helm-mode. Instead of using ido-mode, add the commands where you want to use ido to helm-completing-read-handlers-alist with ido as value.

Note: This mode is incompatible with Emacs23.

4.7.4 Hooks in library ‘helm-command’

uncategorized

helm-M-x--before-action-hook

Standard Value:

helm-M-x--move-selection-after-hook

Standard Value:

4.8 Library: helm-config

4.9 Library: helm-dabbrev

4.9.1 Commands in library helm-dabbrev (excludes keymaps)

uncategorized

M-/ (helm-dabbrev)

Preconfigured helm for dynamic abbreviations.

4.9.2 Options in library ‘helm-dabbrev’

Search

helm-dabbrev-always-search-all

Standard Value: t

Always search in all buffers when non–nil. Note that even if nil, a search in all buffers will occur if the length of candidates is <= than helm-dabbrev-max-length-result.

helm-dabbrev-case-fold-search

Standard Value: smart

Set case-fold-search in helm-dabbrev. Same as helm-case-fold-search but for helm-dabbrev. Note that this is not affecting searching in Helm buffer, but the initial search for all candidates in buffer(s).

uncategorized

helm-dabbrev-candidates-number-limit

Standard Value: 1000

Maximum number of candidates to collect.

The higher this number is, the slower the computation of candidates will be. You can use safely a higher value with emacs-26+. Note that this have nothing to do with helm-candidate-number-limit, this means that computation of candidates stop when this value is reached but only helm-candidate-number-limit candidates are displayed in the Helm buffer.

helm-dabbrev-cycle-threshold

Standard Value: 5

Number of time helm-dabbrev cycle before displaying helm completion. When nil or 0 disable cycling.

helm-dabbrev-ignored-buffers-regexps

Standard Value:

("\\*helm" "\\*Messages" "\\*Echo Area" "\\*Buffer List")

List of regexps matching names of buffers that helm-dabbrev should not check.

helm-dabbrev-lineno-around

Standard Value: 30

Search first in this number of lines before and after point.

helm-dabbrev-major-mode-assoc

Standard Value: nil

Major mode association alist.

This allow helm-dabbrev searching in buffers with the associated major-mode. E.g. (emacs-lisp-mode . lisp-interaction-mode)

will allow searching in the lisp-interaction-mode buffer when current-buffer is an emacs-lisp-mode buffer and vice versa i.e. no need to provide (lisp-interaction-mode . emacs-lisp-mode) association.

When nil check is the searched buffer has same major-mode than the current-buffer.

This has no effect when helm-dabbrev-related-buffer-fn is nil or of course bound to a function that doesn’t handle this var.

helm-dabbrev-related-buffer-fn

Standard Value: helm-dabbrev–same-major-mode-p

A function that decide if a buffer to search in its related to current-buffer.

This is actually determined by comparing major-mode of the buffer to search and the current-buffer.

The function take one arg, the buffer which is current, look at helm-dabbrev--same-major-mode-p for an example.

When nil all buffers are considered related to current-buffer.

4.10 Library: helm-easymenu

4.11 Library: helm-elisp

4.11.1 Commands in library helm-elisp (excludes keymaps)

Lisp

helm-lisp-indent

Point

helm-complete-file-name-at-point

(helm-complete-file-name-at-point &optional FORCE)

Preconfigured Helm to complete file name at point.

C-x c <tab> (helm-lisp-completion-at-point)

Preconfigured Helm for Lisp symbol completion at point.

helm-lisp-completion-or-file-name-at-point

Preconfigured Helm to complete Lisp symbol or filename at point. Filename completion happens if string start after or between a double quote.

uncategorized

C-x c a

C-h a

<f1> a

<help> a (helm-apropos)

(helm-apropos DEFAULT)

Preconfigured Helm to describe commands, functions, variables and faces. In non interactives calls DEFAULT argument should be provided as a string, i.e. the symbol-name of any existing symbol.

helm-complex-command-history

Preconfigured helm for complex command history.

helm-locate-library

Preconfigured helm to locate elisp libraries.

helm-manage-advice

Preconfigured helm to disable/enable function advices.

helm-sexp-eval-1

helm-timers

Preconfigured helm for timers.

4.11.2 Options in library ‘helm-elisp’

Fuzzy

helm-locate-library-fuzzy-match

Standard Value: t

Enable fuzzy-matching in helm-locate-library when non–nil.

Apropos

helm-apropos-defaut-info-lookup-sources

Standard Value:

(helm-source-info-elisp helm-source-info-cl helm-source-info-eieio)

A list of sources to look into when searching info page of a symbol.

helm-apropos-fuzzy-match

Standard Value: nil

Enable fuzzy matching for helm-apropos when non-nil.

Completion

helm-lisp-fuzzy-completion

Standard Value: nil

Enable fuzzy matching in emacs-lisp completion when non-nil. NOTE: This enables fuzzy matching in Helm native implementation of elisp completion, but not on helmized elisp completion, i.e. fuzzy completion is not available in completion-at-point.

helm-show-completion-min-window-height

Standard Value: 7

Minimum completion window height used in show completion. This is used in macro with-helm-show-completion.

helm-turn-on-show-completion

Standard Value: t

Display candidate in current-buffer while moving selection when non–nil.