Next: Introduction [Contents][Index]
helm-buffer
helm-files
helm-browse-project-map
helm-file-name-history-map
helm-find-files-map
helm-read-file-map
helm-files
(excludes keymaps)Next: Quick Start Guide, Previous: The Helm Manual, Up: The Helm Manual [Contents][Index]
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.
Next: Helm Generic Help, Previous: Introduction, Up: The Helm Manual [Contents][Index]
Next: Download, Up: Quick Start Guide [Contents][Index]
Helm 3.6.2 and later require
Next: Installation, Previous: Requirements, Up: Quick Start Guide [Contents][Index]
https://github.com/emacs-helm/helm.git
git@github.com:emacs-helm/helm.git
Next: Configuration, Previous: Download, Up: Quick Start Guide [Contents][Index]
Next: Minimal setup using source, Up: Installation [Contents][Index]
‘straight.el’3
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.
Next: Minimal setup using the Package Manager, Previous: Minimal setup using ‘straight.el’, Up: Installation [Contents][Index]
Install ‘emacs-async’4 and ‘popup-el’5. Ensure that they
are available in load-path
.
If you are using ‘git’,
git clone https://github.com/emacs-helm/helm cd helm make sudo make install
If you have a tarball6, 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 steps8
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))
Previous: Minimal setup using source, Up: Installation [Contents][Index]
Helm is available on MELPA.9
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.10
Next: Quick Try with ‘emacs-helm.sh’, Previous: Installation, Up: Quick Start Guide [Contents][Index]
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
Next: How to report Helm Bugs, Previous: Configuration, Up: Quick Start Guide [Contents][Index]
;; 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.
Next: Getting Help, Previous: Quick Try with ‘emacs-helm.sh’, Up: Quick Start Guide [Contents][Index]
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.
Next: A word of advice for experienced Emacs Users, Previous: How to report Helm Bugs, Up: Quick Start Guide [Contents][Index]
Previous: Getting Help, Up: Quick Start Guide [Contents][Index]
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.
In Helm, interactivity happens in the completion window, not the minibuffer
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:
Next: Package: helm, Previous: Quick Start Guide, Up: The Helm Manual [Contents][Index]
helm-buffer
Next: Helm sources, Up: Helm Generic Help [Contents][Index]
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:
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:
https://github.com/emacs-helm/helm/wiki#helm-completion-vs-emacs-completion
Next: Modify keybindings in Helm, Previous: Basics, Up: Helm Generic Help [Contents][Index]
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:
https://github.com/emacs-helm/helm/wiki/Developing#creating-a-source
Up: Helm sources [Contents][Index]
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:
https://github.com/emacs-helm/helm/wiki/FAQ#why-is-a-customizable-helm-source-nil
https://github.com/thierryvolpiatto/emacs-tv-config/blob/master/init-helm.el#L340
Next: Matching in Helm, Previous: Helm sources, Up: Helm Generic Help [Contents][Index]
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).
Next: Helm mode, Previous: Modify keybindings in Helm, Up: Helm Generic Help [Contents][Index]
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.
Up: Matching in Helm [Contents][Index]
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.
Next: Helm help, Previous: Matching in Helm, Up: Helm Generic Help [Contents][Index]
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.
helm-mode
is enabled?Next: Helm functions vs helmized Emacs functions, Up: Helm mode [Contents][Index]
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.
Next: Completion behavior with Helm and completion-at-point, Previous: What gets or does not get ‘helmized’ when helm-mode
is enabled?, Up: Helm mode [Contents][Index]
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.
Previous: Helm functions vs helmized Emacs functions, Up: Helm mode [Contents][Index]
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.
Next: Customize Helm, Previous: Helm mode, Up: Helm Generic Help [Contents][Index]
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:
Key | Alternative keys | Command |
---|---|---|
C-v | Space next | Scroll up |
M-v | b prior | Scroll down |
C-s | Isearch forward | |
C-r | Isearch backward | |
C-a | Beginning of line | |
C-e | End of line | |
C-f | right | Forward char |
C-b | left | Backward char |
C-n | down | Next line |
C-p | up | Previous line |
M-a | Backward sentence | |
M-e | Forward sentence | |
M-f | Forward word | |
M-b | Backward word | |
M-> | End of buffer | |
M-< | Beginning of buffer | |
C-<SPACE> | Toggle mark | |
C-M-SPACE | Mark sexp | |
RET | Follow org link | |
C-% | Push org mark | |
C-& | Goto org mark-ring | |
TAB | Org cycle | |
M-<TAB> | Toggle visibility | |
M-w | Copy region | |
q | Quit |
Next: Display Helm in windows and frames, Previous: Helm help, Up: Helm Generic Help [Contents][Index]
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.
Next: Helm’s basic operations and default key bindings, Previous: Customize Helm, Up: Helm Generic Help [Contents][Index]
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:
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.
Next: The actions menu, Previous: Display Helm in windows and frames, Up: Helm Generic Help [Contents][Index]
Key | Alternative Keys | Command |
---|---|---|
C-p | Up | Previous line |
C-n | Down | Next line |
M-v | prior | Previous page |
C-v | next | Next page |
Enter14 | Execute first (default) action / Select [1] | |
M-< | First line | |
M-> | Last line | |
C-M-S-v | M-prior, C-M-y | Previous page (other-window) |
C-M-v | M-next | Next page (other-window) |
Tab | C-i | Show action list |
M-o | left | Previous source |
C-o | right | Next source |
C-k15 | Delete pattern (with prefix arg delete from point to end or all [2]) | |
C-j | Persistent action (Execute and keep Helm session) |
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).
Next: Shortcuts for n-th first actions, Previous: The actions menu, Up: Helm Generic Help [Contents][Index]
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.
Next: Shortcuts for executing the default action on the n-th candidate, Previous: Action transformers, Up: Helm Generic Help [Contents][Index]
<f1>…<f12>: Execute n-th action where n is 1 to 12.
Next: Mouse control in Helm, Previous: Shortcuts for n-th first actions, Up: Helm Generic Help [Contents][Index]
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-relative16
package and helm-linum-relative-mode
.
Then when line numbers are enabled with one of the methods above the following keys are available17:
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.
Next: Marked candidates, Previous: Shortcuts for executing the default action on the n-th candidate, Up: Helm Generic Help [Contents][Index]
A basic support for the mouse is provided when the user sets
helm-allow-mouse
to non-nil.
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.
Next: Follow candidates, Previous: Mouse control in Helm, Up: Helm Generic Help [Contents][Index]
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.
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.
Next: Frequently Used Commands, Previous: Marked candidates, Up: Helm Generic Help [Contents][Index]
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.
Next: Special yes, no or yes for all answers, Previous: Follow candidates, Up: Helm Generic Help [Contents][Index]
Keys | Description |
---|---|
C-t | Toggle vertical/horizontal split on first hit and swap Helm window on second hit. |
C-c % | Exchange minibuffer and header-line. |
C-x C-f | Drop into ‘helm-find-files’. |
C-c C-k | Kill display value of candidate and quit (with prefix arg, kill the real value). |
C-c C-y | Yank current selection into pattern. |
C-c TAB | Copy selected candidate at point in current buffer. |
C-c C-f | Toggle automatic execution of persistent action. |
C-<down> | Run persistent action then select next line. |
C-<up> | Run persistent action then select previous line. |
C-c C-u | Recalculate and redisplay candidates. |
C-! | Toggle candidate updates. |
Next: Moving in helm-buffer
, Previous: Frequently Used Commands, Up: Helm Generic Help [Contents][Index]
You may be prompted in the minibuffer to answer by [y,n,!,q] in some places for confirmation.
When using ! you will not be prompted for the same thing in current operation any more, e.g. file deletion, file copy etc…
Next: Resume previous session from current Helm session, Previous: Special yes, no or yes for all answers, Up: Helm Generic Help [Contents][Index]
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.
Next: Global commands, Previous: Moving in helm-buffer
, Up: Helm Generic Help [Contents][Index]
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.
Next: Debugging Helm, Previous: Resume previous session from current Helm session, Up: Helm Generic Help [Contents][Index]
Up: Global commands [Contents][Index]
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).
Next: Writing your own Helm sources, Previous: Global commands, Up: Helm Generic Help [Contents][Index]
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.
Next: Helm Map, Previous: Debugging Helm, Up: Helm Generic Help [Contents][Index]
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:
Previous: Writing your own Helm sources, Up: Helm Generic Help [Contents][Index]
Key | Binding | Comments |
---|---|---|
C-@ | helm-toggle-visible-mark | |
C-c | Prefix Command | |
C-g | helm-keyboard-quit | |
C-h | Prefix Command | |
TAB | helm-select-action | |
C-j | helm-execute-persistent-action | |
C-k | helm-delete-minibuffer-contents | |
C-l | helm-recenter-top-bottom-other-window | |
RET | helm-maybe-exit-minibuffer | |
C-n | helm-next-line | |
C-o | helm-next-source | |
C-p | helm-previous-line | |
C-t | helm-toggle-resplit-and-swap-windows | |
C-v | helm-next-page | |
C-w | ?? | |
C-x | Prefix Command | |
ESC | Prefix Command | |
C-SPC | helm-toggle-visible-mark-forward | |
C-! | helm-toggle-suspend-update | |
C-{ | helm-enlarge-window | |
C-} | helm-narrow-window | |
C-M-<down> | helm-scroll-other-window | |
C-M-<up> | helm-scroll-other-window-down | |
C-<down> | helm-follow-action-forward | |
C-<up> | helm-follow-action-backward | |
M-<next> | helm-scroll-other-window | |
M-<prior> | helm-scroll-other-window-down | |
<XF86Back> | previous-history-element | |
<XF86Forward> | next-history-element | |
<down> | helm-next-line | |
<f1> | ?? | |
<f2> | ?? | |
<f3> | ?? | |
<f4> | ?? | |
<f5> | ?? | |
<f6> | ?? | |
<f7> | ?? | |
<f8> | ?? | |
<f9> | ?? | |
<f10> | ?? | |
<f11> | ?? | |
<f12> | ?? | |
<f13> | ?? | |
<help> | Prefix Command | |
<left> | helm-previous-source | |
<next> | helm-next-page | |
<prior> | helm-previous-page | |
<right> | helm-next-source | |
<tab> | helm-execute-persistent-action | |
<up> | helm-previous-line | |
<help> m | helm-help | |
C-h C-d | helm-enable-or-switch-to-debug | |
C-h c | helm-customize-group | |
C-h m | helm-help | |
C-c C-f | helm-follow-mode | |
C-c TAB | helm-copy-to-buffer | |
C-c C-k | helm-kill-selection-and-quit | |
C-c C-u | helm-refresh | |
C-c C-y | helm-yank-selection | |
C-c % | helm-exchange-minibuffer-and-header-line | |
C-c - | helm-swap-windows | |
C-c 1 | helm-execute-selection-action-at-nth-+1 | |
C-c 2 | helm-execute-selection-action-at-nth-+2 | |
C-c 3 | helm-execute-selection-action-at-nth-+3 | |
C-c 4 | helm-execute-selection-action-at-nth-+4 | |
C-c 5 | helm-execute-selection-action-at-nth-+5 | |
C-c 6 | helm-execute-selection-action-at-nth-+6 | |
C-c 7 | helm-execute-selection-action-at-nth-+7 | |
C-c 8 | helm-execute-selection-action-at-nth-+8 | |
C-c 9 | helm-execute-selection-action-at-nth-+9 | |
C-c > | helm-toggle-truncate-line | |
C-c ? | helm-help | |
C-c _ | helm-toggle-full-frame | |
C-c l | helm-display-line-numbers-mode | |
C-c n | ?? | |
C-x C-b | helm-resume-list-buffers-after-quit | |
C-x C-f | helm-quit-and-find-file | |
C-x 1 | helm-execute-selection-action-at-nth-+1 | |
C-x 2 | helm-execute-selection-action-at-nth-+2 | |
C-x 3 | helm-execute-selection-action-at-nth-+3 | |
C-x 4 | helm-execute-selection-action-at-nth-+4 | |
C-x 5 | helm-execute-selection-action-at-nth-+5 | |
C-x 6 | helm-execute-selection-action-at-nth-+6 | |
C-x 7 | helm-execute-selection-action-at-nth-+7 | |
C-x 8 | helm-execute-selection-action-at-nth-+8 | |
C-x 9 | helm-execute-selection-action-at-nth-+9 | |
C-x b | helm-resume-previous-session-after-quit | |
C-M-a | helm-show-all-candidates-in-source | |
C-M-e | helm-display-all-sources | |
C-M-l | helm-reposition-window-other-window | |
C-M-v | helm-scroll-other-window | |
C-M-y | helm-scroll-other-window-down | |
M-SPC | helm-toggle-visible-mark-backward | |
M-( | helm-prev-visible-mark | |
M-) | helm-next-visible-mark | |
M-< | helm-beginning-of-buffer | |
M-> | helm-end-of-buffer | |
M-U | helm-unmark-all | |
M-a | helm-mark-all | |
M-g | Prefix Command | |
M-m | helm-toggle-all-marks | |
M-n | next-history-element | |
M-o | helm-previous-source | |
M-p | previous-history-element | |
M-v | helm-previous-page | |
C-M-S-v | helm-scroll-other-window-down | |
M-g ESC | Prefix Command | |
M-< | minibuffer-beginning-of-buffer | (this binding is currently shadowed) |
M-g | Prefix Command | |
M-r | previous-matching-history-element | |
M-s | next-matching-history-element | (this binding is currently shadowed) |
M-g ESC | Prefix Command | |
M-g M-c | helm-comint-input-ring | |
M-g M-h | helm-minibuffer-history |
Next: Main Index, Previous: Helm Generic Help, Up: The Helm Manual [Contents][Index]
Next: Library: helm-adaptive, Up: Package: helm [Contents][Index]
helm
helm-map
helm
(excludes keymaps)
Next: Commands in keymap helm-map
, Up: Library: helm [Contents][Index]
helm
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}
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.
Next: Commands in library helm
(excludes keymaps), Previous: Modes in library helm
, Up: Library: helm [Contents][Index]
helm-map
helm-keyboard-quit
) ¶Quit minibuffer in helm. If action buffer is displayed, kill it.
helm-maybe-exit-minibuffer
) ¶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.
helm-select-action
) ¶Select an action for the currently selected candidate. If action buffer is selected, back to the Helm buffer.
helm-execute-selection-action-at-nth-+1
) ¶helm-execute-selection-action-at-nth-+1
) ¶helm-execute-selection-action-at-nth-+2
) ¶helm-execute-selection-action-at-nth-+2
) ¶helm-execute-selection-action-at-nth-+3
) ¶helm-execute-selection-action-at-nth-+3
) ¶helm-execute-selection-action-at-nth-+4
) ¶helm-execute-selection-action-at-nth-+4
) ¶helm-execute-selection-action-at-nth-+5
) ¶helm-execute-selection-action-at-nth-+5
) ¶helm-execute-selection-action-at-nth-+6
) ¶helm-execute-selection-action-at-nth-+6
) ¶helm-execute-selection-action-at-nth-+7
) ¶helm-execute-selection-action-at-nth-+7
) ¶helm-execute-selection-action-at-nth-+8
) ¶helm-execute-selection-action-at-nth-+8
) ¶helm-execute-selection-action-at-nth-+9
) ¶helm-execute-selection-action-at-nth-+9
) ¶undefined
) ¶Beep to tell the user this binding is undefined.
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.
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.
helm-customize-group
) ¶Jump to customization group of current source.
Default to Helm group when group is not defined in source.
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.
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].
helm-toggle-truncate-line
) ¶Toggle truncate-lines
value in helm-buffer
helm-display-all-sources
) ¶Display all sources previously hidden by helm-set-source-filter
.
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.
helm-exchange-minibuffer-and-header-line
) ¶Display minibuffer in header-line and vice versa for current Helm session.
This is a toggle command.
helm-enlarge-window
) ¶Enlarge helm window.
helm-narrow-window
) ¶Narrow helm window.
helm-swap-windows
) ¶Swap window holding helm-buffer
with other window.
helm-toggle-full-frame
) ¶(helm-toggle-full-frame &optional ARG)
Toggle helm-buffer
full-frame view.
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
.
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
.
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
.
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
.
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
.
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.
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).
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.
helm-unmark-all
) ¶Unmark all candidates in all sources of current helm session.
helm-toggle-visible-mark
) ¶(helm-toggle-visible-mark ARG)
Toggle Helm visible mark at point ARG times. If ARG is negative toggle backward.
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.
helm-toggle-visible-mark-backward
) ¶helm-toggle-visible-mark-forward
) ¶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.
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.
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.
helm-follow-action-backward
) ¶Go to previous line and execute persistent action.
helm-follow-action-forward
) ¶Go to next line and execute persistent action.
helm-resume-previous-session-after-quit
) ¶Resume previous Helm session within a running Helm.
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
) ¶Force recalculation and update of candidates.
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.
helm-resume-list-buffers-after-quit
) ¶List Helm buffers that can be resumed within a running Helm.
helm-enable-or-switch-to-debug
) ¶First hit enable helm debugging, second hit switch to debug buffer.
Next: Options in library ‘helm’, Previous: Commands in keymap helm-map
, Up: Library: helm [Contents][Index]
helm
(excludes keymaps)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.
(helm-menu-select-action EVENT)
Popup action menu from mouse-3.
helm-mouse-select-candidate
¶(helm-mouse-select-candidate EVENT)
helm-cycle-resume
¶Cycle in helm-buffers
list and resume when waiting more than 1.2s.
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.
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.
Next: Hooks in library ‘helm’, Previous: Commands in library helm
(excludes keymaps), Up: Library: helm [Contents][Index]
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.
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
.
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.
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.
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.
helm-left-margin-width
¶Standard Value: 0
left-margin-width
value for the helm-buffer
.
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).
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.
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.
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.
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.
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.
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.
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
.
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.
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.
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.
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.
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
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.
helm-use-frame-when-dedicated-window
¶Standard Value: nil
Display Helm buffer in frame when Helm is started from a dedicated window.
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.
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.
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.
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.)
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.
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.
helm-display-buffer-width
¶Standard Value: 72
Frame width when displaying helm-buffer in own frame.
helm-display-buffer-height
¶Standard Value: 20
Frame height when displaying helm-buffer in own frame.
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.
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.
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
.
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.
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 >.
Previous: Options in library ‘helm’, Up: Library: helm [Contents][Index]
helm-log-run-hook
¶Standard Value:
helm-confirm-and-exit-hook
¶Standard Value:
with-helm-temp-hook
¶Standard Value:
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
.
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.
helm--autoresize-hook
¶Standard Value:
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
.
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.
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.
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.)
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.
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:
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.
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
.
Next: Library: helm-bookmark, Previous: Library: helm, Up: Package: helm [Contents][Index]
helm-adaptive
helm-adaptive
(excludes keymaps)
Next: Commands in library helm-adaptive
(excludes keymaps), Up: Library: helm-adaptive [Contents][Index]
helm-adaptive
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.
Next: Options in library ‘helm-adaptive’, Previous: Modes in library helm-adaptive
, Up: Library: helm-adaptive [Contents][Index]
helm-adaptive
(excludes keymaps)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
.
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.
Next: Hooks in library ‘helm-adaptive’, Previous: Commands in library helm-adaptive
(excludes keymaps), Up: Library: helm-adaptive [Contents][Index]
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.)
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.
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.
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.
Previous: Options in library ‘helm-adaptive’, Up: Library: helm-adaptive [Contents][Index]
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.)
Next: Library: helm-buffers, Previous: Library: helm-adaptive, Up: Package: helm [Contents][Index]
helm-bookmark-find-files-map
helm-bookmark-map
helm-bookmark
(excludes keymaps)helm-bookmark-find-files-map
helm-bookmark-run-browse-project
) ¶Run helm-bookmark-browse-project
from keyboard.
Next: Commands in library helm-bookmark
(excludes keymaps), Previous: Commands in keymap helm-bookmark-find-files-map
, Up: Library: helm-bookmark [Contents][Index]
helm-bookmark-map
helm-bookmark-run-delete
) ¶Delete bookmark from keyboard.
helm-bookmark-run-edit
) ¶Run helm-bookmark-edit-bookmark
from keyboard.
helm-bookmark-run-jump-other-frame
) ¶Jump to bookmark other frame from keyboard.
helm-bookmark-run-jump-other-window
) ¶Jump to bookmark from keyboard.
helm-bookmark-toggle-filename
) ¶Toggle bookmark location visibility.
Next: Options in library ‘helm-bookmark’, Previous: Commands in keymap helm-bookmark-map
, Up: Library: helm-bookmark [Contents][Index]
helm-bookmark
(excludes keymaps)helm-bookmarks
¶Preconfigured helm
for bookmarks.
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.
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.
Previous: Commands in library helm-bookmark
(excludes keymaps), Up: Library: helm-bookmark [Contents][Index]
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.
Next: Library: helm-color, Previous: Library: helm-bookmark, Up: Package: helm [Contents][Index]
helm-buffer-map
helm-buffer-not-found-map
helm-buffers
(excludes keymaps)helm-buffer-map
helm-toggle-buffers-details
) ¶helm-buffers-run-browse-project
) ¶Run helm-buffers-browse-project
from key.
helm-buffer-switch-other-frame
) ¶Run switch to other frame action from helm-source-buffers-list
.
helm-buffer-switch-other-window
) ¶Run switch to other window action from helm-source-buffers-list
.
helm-buffers-switch-to-buffer-new-tab
) ¶Run switch to buffer in other tab action from helm-source-buffers-list
.
helm-buffers-run-occur
) ¶Run helm-multi-occur-as-action
by key.
helm-buffer-run-query-replace
) ¶Run Query replace action from helm-source-buffers-list
.
helm-buffer-run-query-replace-regexp
) ¶Run Query replace regexp action from helm-source-buffers-list
.
helm-buffers-mark-similar-buffers
) ¶Mark All buffers that have same property type
than current.
I.e. same color.
helm-buffer-save-persistent
) ¶Save buffer without quitting Helm.
helm-buffer-run-save-some-buffers
) ¶Save unsaved file buffers without quitting Helm.
helm-buffer-diff-persistent
) ¶Toggle diff buffer without quitting helm.
helm-buffer-run-ediff
) ¶Run ediff action from helm-source-buffers-list
.
helm-buffer-run-ediff-merge
) ¶Run ediff action from helm-source-buffers-list
.
helm-buffer-run-kill-persistent
) ¶Kill buffer without quitting Helm.
helm-buffer-run-kill-buffers
) ¶Run kill buffer action from helm-source-buffers-list
.
helm-buffer-run-rename-buffer
) ¶Run rename buffer action from helm-source-buffers-list
.
helm-buffer-revert-persistent
) ¶Revert buffer without quitting helm.
helm-buffer-run-goto-line
) ¶Switch to buffer at line number.
helm-buffer-run-zgrep
) ¶Run Grep action from helm-source-buffers-list
.
Next: Commands in library helm-buffers
(excludes keymaps), Previous: Commands in keymap helm-buffer-map
, Up: Library: helm-buffers [Contents][Index]
helm-buffer-not-found-map
helm-buffers-not-found-run-switch-of
) ¶Run create new buffer other frame action from keymap.
helm-buffers-not-found-run-switch-ow
) ¶Run create new buffer other window action from keymap.
Next: Options in library ‘helm-buffers’, Previous: Commands in keymap helm-buffer-not-found-map
, Up: Library: helm-buffers [Contents][Index]
helm-buffers
(excludes keymaps)helm-mini
¶Preconfigured helm
displaying helm-mini-default-sources
.
helm-quit-and-helm-mini
¶Drop into helm-mini
from helm
.
helm-buffer-run-grep
¶Run Grep action from helm-source-buffers-list
.
helm-buffers-list
) ¶Preconfigured helm
to list buffers.
Previous: Commands in library helm-buffers
(excludes keymaps), Up: Library: helm-buffers [Contents][Index]
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
.
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.
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.
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.
Next: Library: helm-comint, Previous: Library: helm-buffers, Up: Package: helm [Contents][Index]
helm-color-map
helm-color-run-insert-name
) ¶Insert name of color from helm-source-colors
.
helm-color-run-insert-rgb
) ¶Insert RGB of color from helm-source-colors
.
helm-color-run-kill-name
) ¶Kill name of color from helm-source-colors
.
helm-color-run-kill-rgb
) ¶Kill RGB of color from helm-source-colors
.
Previous: Commands in keymap helm-color-map
, Up: Library: helm-color [Contents][Index]
helm-color
(excludes keymaps)helm-colors
) ¶Preconfigured helm
for color.
Next: Library: helm-command, Previous: Library: helm-color, Up: Package: helm [Contents][Index]
helm-comint-prompts-keymap
helm-comint
(excludes keymaps)
Next: Commands in library helm-comint
(excludes keymaps), Up: Library: helm-comint [Contents][Index]
helm-comint-prompts-keymap
Next: Options in library ‘helm-comint’, Previous: Commands in keymap helm-comint-prompts-keymap
, Up: Library: helm-comint [Contents][Index]
helm-comint
(excludes keymaps)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.
helm-comint-input-ring
¶Preconfigured helm
that provide completion of comint
history.
Previous: Commands in library helm-comint
(excludes keymaps), Up: Library: helm-comint [Contents][Index]
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.
Next: Library: helm-config, Previous: Library: helm-comint, Up: Package: helm [Contents][Index]
helm-M-x-map
helm-command
(excludes keymaps)
Next: Commands in library helm-command
(excludes keymaps), Up: Library: helm-command [Contents][Index]
helm-M-x-map
helm-M-x-universal-argument
) ¶Same as universal-argument
but for helm-M-x
.
Next: Options in library ‘helm-command’, Previous: Commands in keymap helm-M-x-map
, Up: Library: helm-command [Contents][Index]
helm-command
(excludes keymaps)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.
Next: Hooks in library ‘helm-command’, Previous: Commands in library helm-command
(excludes keymaps), Up: Library: helm-command [Contents][Index]
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.
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.
Previous: Options in library ‘helm-command’, Up: Library: helm-command [Contents][Index]
helm-M-x--before-action-hook
¶Standard Value:
helm-M-x--move-selection-after-hook
¶Standard Value:
Next: Library: helm-dabbrev, Previous: Library: helm-command, Up: Package: helm [Contents][Index]
Next: Library: helm-easymenu, Previous: Library: helm-config, Up: Package: helm [Contents][Index]
Next: Options in library ‘helm-dabbrev’, Up: Library: helm-dabbrev [Contents][Index]
helm-dabbrev
(excludes keymaps)helm-dabbrev
) ¶Preconfigured helm for dynamic abbreviations.
Previous: Commands in library helm-dabbrev
(excludes keymaps), Up: Library: helm-dabbrev [Contents][Index]
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).
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.
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
.
Next: Library: helm-elisp-package, Previous: Library: helm-easymenu, Up: Package: helm [Contents][Index]
Next: Options in library ‘helm-elisp’, Up: Library: helm-elisp [Contents][Index]
helm-elisp
(excludes keymaps)helm-lisp-indent
¶helm-complete-file-name-at-point
¶(helm-complete-file-name-at-point &optional FORCE)
Preconfigured Helm to complete file name at point.
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.
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.
Previous: Commands in library helm-elisp
(excludes keymaps), Up: Library: helm-elisp [Contents][Index]
helm-locate-library-fuzzy-match
¶Standard Value: t
Enable fuzzy-matching in helm-locate-library
when non–nil.
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.
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.
helm-apropos-function-list
¶Standard Value:
(helm-def-source--emacs-commands helm-def-source--emacs-functions helm-def-source--eieio-classes helm-def-source--eieio-generic helm-def-source--emacs-variables helm-def-source--emacs-faces)
A list of functions that build helm sources to use in helm-apropos
.
helm-elisp-help-function
¶Standard Value: helm-elisp-show-help
Function for displaying help for Lisp symbols.
helm-lisp-quoted-function-list
¶Standard Value:
(funcall apply mapc cl-mapc mapcar cl-mapcar callf callf2 cl-callf cl-callf2 fset fboundp fmakunbound symbol-function)
List of function where quoted function completion happen. E.g. give only function names after (funcall ’.
helm-lisp-unquoted-function-list
¶Standard Value:
#'defadvice
List of function where unquoted function completion happen. E.g. give only function names after (function .
helm-show-completion-display-function
¶Standard Value: helm-display-buffer-in-own-frame
The function used to display helm completion buffer.
This function is used by with-helm-show-completion
, when nil
fallback to helm-default-display-buffer
.
Default is to use a separate frame on graphic display and
helm-show-completion-default-display-function
on non graphic
display.
Next: Library: helm-epa, Previous: Library: helm-elisp, Up: Package: helm [Contents][Index]
helm-el-package-map
helm-elisp-package
(excludes keymaps)
Next: Commands in library helm-elisp-package
(excludes keymaps), Up: Library: helm-elisp-package [Contents][Index]
helm-el-package-map
helm-el-run-visit-homepage
) ¶helm-el-run-package-install
) ¶helm-el-run-package-reinstall
) ¶helm-el-run-package-uninstall
) ¶helm-el-run-package-upgrade
) ¶helm-el-run-package-upgrade-all
) ¶helm-el-package-show-all
) ¶helm-el-package-show-built-in
) ¶helm-el-package-show-installed
) ¶helm-el-package-show-uninstalled
) ¶helm-el-package-show-upgrade
) ¶
Next: Options in library ‘helm-elisp-package’, Previous: Commands in keymap helm-el-package-map
, Up: Library: helm-elisp-package [Contents][Index]
helm-elisp-package
(excludes keymaps)helm-list-elisp-packages
) ¶(helm-list-elisp-packages ARG)
Preconfigured helm
for listing and handling Emacs packages.
helm-list-elisp-packages-no-fetch
¶(helm-list-elisp-packages-no-fetch ARG)
Preconfigured Helm for Emacs packages.
Same as helm-list-elisp-packages
but don’t fetch packages on
remote. Called with a prefix ARG always fetch packages on
remote.
Previous: Commands in library helm-elisp-package
(excludes keymaps), Up: Library: helm-elisp-package [Contents][Index]
helm-el-package-autoremove-on-start
¶Standard Value: nil
Try to autoremove no more needed packages on startup.
See package-autoremove
.
helm-el-package-initial-filter
¶Standard Value: all
Show only installed, upgraded or all packages at startup.
helm-el-package-upgrade-on-start
¶Standard Value: nil
Show package upgrades on startup when non nil.
helm-el-truncate-lines
¶Standard Value: t
Truncate lines in helm-buffer
when non-nil.
Next: Library: helm-eshell, Previous: Library: helm-elisp-package, Up: Package: helm [Contents][Index]
helm-epa
helm-epa
(excludes keymaps)helm-epa
helm-epa-mode
¶(helm-epa-mode &optional ARG)
Enable helm completion on gpg keys in epa functions.
If called interactively, toggle Helm-Epa 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.
Next: Options in library ‘helm-epa’, Previous: Modes in library helm-epa
, Up: Library: helm-epa [Contents][Index]
helm-epa
(excludes keymaps)helm-epa-mode
¶(helm-epa-mode &optional ARG)
Enable helm completion on gpg keys in epa functions.
If called interactively, toggle Helm-Epa 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-epa-list-keys
¶List all gpg keys.
This is the helm interface for epa-list-keys
.
Next: Hooks in library ‘helm-epa’, Previous: Commands in library helm-epa
(excludes keymaps), Up: Library: helm-epa [Contents][Index]
helm-epa-mode-hook
¶Standard Value: nil
Hook run after entering or leaving helm-epa-mode
.
No problems result if this variable is not bound.
add-hook
automatically binds it. (This is true for all hook variables.)
helm-epa-mode
¶Standard Value: nil
(helm-epa-mode &optional ARG)
Enable helm completion on gpg keys in epa functions.
If called interactively, toggle Helm-Epa 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-epa-actions
¶Standard Value:
(("Show key" . epa--show-key) ("encrypt file with key" . helm-epa-encrypt-file) ("Copy keys to kill ring" . helm-epa-kill-keys-armor) ("Delete keys" . helm-epa-delete-keys))
Actions for helm-epa-list-keys
.
Previous: Options in library ‘helm-epa’, Up: Library: helm-epa [Contents][Index]
helm-epa-mode-hook
¶Standard Value: nil
Hook run after entering or leaving helm-epa-mode
.
No problems result if this variable is not bound.
add-hook
automatically binds it. (This is true for all hook variables.)
Next: Library: helm-eval, Previous: Library: helm-epa, Up: Package: helm [Contents][Index]
helm-eshell-prompts-keymap
helm-eshell
(excludes keymaps)
Next: Commands in library helm-eshell
(excludes keymaps), Up: Library: helm-eshell [Contents][Index]
helm-eshell-prompts-keymap
Next: Options in library ‘helm-eshell’, Previous: Commands in keymap helm-eshell-prompts-keymap
, Up: Library: helm-eshell [Contents][Index]
helm-eshell
(excludes keymaps)helm-eshell-history
¶Preconfigured Helm for Eshell history.
helm-eshell-prompts
¶Pre-configured helm
to browse the prompts of the current Eshell.
helm-eshell-prompts-all
¶Pre-configured helm
to browse the prompts of all Eshell sessions.
helm-esh-pcomplete
¶Preconfigured helm
to provide Helm completion in Eshell.
Next: Hooks in library ‘helm-eshell’, Previous: Commands in library helm-eshell
(excludes keymaps), Up: Library: helm-eshell [Contents][Index]
helm-eshell-fuzzy-match
¶Standard Value: nil
Enable fuzzy matching in helm-esh-pcomplete
when non-nil.
helm-eshell-prompts-promptidx-p
¶Standard Value: t
Show prompt number.
Previous: Options in library ‘helm-eshell’, Up: Library: helm-eshell [Contents][Index]
helm-eshell--quit-hook-fn
¶Standard Value:
Next: Library: helm-external, Previous: Library: helm-eshell, Up: Package: helm [Contents][Index]
helm-eval-expression-map
helm-eval
(excludes keymaps)helm-eval-expression-map
helm-lisp-completion-at-point
) ¶Preconfigured Helm for Lisp symbol completion at point.
backward-char
) ¶(backward-char &optional N)
Move point N characters backward (forward if N is negative). On attempt to pass beginning or end of buffer, stop and signal error. Interactively, N is the numeric prefix argument. If N is omitted or nil, move point 1 character backward.
Depending on the bidirectional context, the movement may be to the right or to the left on the screen. This is in contrast with \[left-char], which see.
forward-char
) ¶(forward-char &optional N)
Move point N characters forward (backward if N is negative). On reaching end or beginning of buffer, stop and signal error. Interactively, N is the numeric prefix argument. If N is omitted or nil, move point 1 character forward.
Depending on the bidirectional context, the movement may be to the right or to the left on the screen. This is in contrast with \[right-char], which see.
helm-eval-new-line-and-indent
) ¶lisp-indent-line
) ¶(lisp-indent-line &optional INDENT)
Indent current line as Lisp code.
next-line
) ¶(next-line &optional ARG TRY-VSCROLL)
Move cursor vertically down ARG lines.
Interactively, vscroll tall lines if auto-window-vscroll
is enabled.
Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
lines: if either auto-window-vscroll
or TRY-VSCROLL is nil, this
function will not vscroll.
ARG defaults to 1.
If there is no character in the target line exactly under the current column,
the cursor is positioned after the character in that line that spans this
column, or at the end of the line if it is not long enough.
If there is no line in the buffer after this one, behavior depends on the
value of next-line-add-newlines
. If non-nil, it inserts a newline character
to create a line, and moves the cursor to that line. Otherwise it moves the
cursor to the end of the buffer.
If the variable line-move-visual
is non-nil, this command moves
by display lines. Otherwise, it moves by buffer lines, without
taking variable-width characters or continued lines into account.
See \[next-logical-line] for a command that always moves by buffer lines.
The command \[set-goal-column] can be used to create
a semipermanent goal column for this command.
Then instead of trying to move exactly vertically (or as close as possible),
this command moves to the specified goal column (or as close as possible).
The goal column is stored in the variable goal-column
, which is nil
when there is no goal column. Note that setting goal-column
overrides line-move-visual
and causes this command to move by buffer
lines rather than by display lines.
previous-line
) ¶(previous-line &optional ARG TRY-VSCROLL)
Move cursor vertically up ARG lines.
Interactively, vscroll tall lines if auto-window-vscroll
is enabled.
Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
lines: if either auto-window-vscroll
or TRY-VSCROLL is nil, this
function will not vscroll.
ARG defaults to 1.
If there is no character in the target line exactly over the current column, the cursor is positioned after the character in that line that spans this column, or at the end of the line if it is not long enough.
If the variable line-move-visual
is non-nil, this command moves
by display lines. Otherwise, it moves by buffer lines, without
taking variable-width characters or continued lines into account.
See \[previous-logical-line] for a command that always moves by buffer lines.
The command \[set-goal-column] can be used to create
a semipermanent goal column for this command.
Then instead of trying to move exactly vertically (or as close as possible),
this command moves to the specified goal column (or as close as possible).
The goal column is stored in the variable goal-column
, which is nil
when there is no goal column. Note that setting goal-column
overrides line-move-visual
and causes this command to move by buffer
lines rather than by display lines.
Next: Options in library ‘helm-eval’, Previous: Commands in keymap helm-eval-expression-map
, Up: Library: helm-eval [Contents][Index]
helm-eval
(excludes keymaps)helm-eval-expression
¶(helm-eval-expression ARG)
Preconfigured helm
for helm-source-evaluation-result
.
helm-eval-expression-with-eldoc
) ¶Preconfigured helm
for helm-source-evaluation-result
with eldoc
support.
helm-calcul-expression
) ¶Preconfigured helm
for helm-source-calculation-result
.
Previous: Commands in library helm-eval
(excludes keymaps), Up: Library: helm-eval [Contents][Index]
helm-eldoc-in-minibuffer-show-fn
¶Standard Value: helm-show-info-in-mode-line
A function to display eldoc info. Should take one arg: the string to display.
helm-show-info-in-mode-line-delay
¶Standard Value: 12
Eldoc will show info in mode-line during this delay if user is idle.
Next: Library: helm-fd, Previous: Library: helm-eval, Up: Package: helm [Contents][Index]
helm-external
(excludes keymaps)helm-run-external-command
) ¶(helm-run-external-command PROGRAM)
Preconfigured helm
to run External PROGRAM asyncronously from Emacs.
If program is already running exit with error.
You can set your own list of commands with
helm-external-commands-list
.
Previous: Commands in library helm-external
(excludes keymaps), Up: Library: helm-external [Contents][Index]
helm-default-external-file-browser
¶Standard Value: nautilus
Default external file browser for your system.
Directories will be opened externally with it when opening file
externally in helm-find-files
.
Set to nil if you do not have an external file browser or do not
want to use it.
Windows users should set that to “explorer.exe”.
helm-external-programs-associations
¶Standard Value: nil
Alist to store externals programs associated with file extension. This variable overhide setting in .mailcap file. E.g.: ’((“jpg” . “gqview”) (“pdf” . “xpdf”))
helm-raise-command
¶Standard Value: nil
A shell command to jump to a window running specific program.
Need external program wmctrl.
This will be use with format
, so use something like “wmctrl -xa %s”.
Next: Library: helm-files, Previous: Library: helm-external, Up: Package: helm [Contents][Index]
Next: Options in library ‘helm-fd’, Up: Library: helm-fd [Contents][Index]
helm-fd-map
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-fd-next-directory
) ¶Move to next directory in a helm-fd source.
helm-fd-previous-directory
) ¶Move to previous directory in a helm-fd source.
Previous: Commands in keymap helm-fd-map
, Up: Library: helm-fd [Contents][Index]
helm-fd-switches
¶Standard Value:
("--hidden" "--type" "f" "--type" "d" "--color" "always")
A list of options to pass to fd shell command.
Next: Library: helm-find, Previous: Library: helm-fd, Up: Package: helm [Contents][Index]
helm-files
helm-browse-project-map
helm-file-name-history-map
helm-find-files-map
helm-read-file-map
helm-files
(excludes keymaps)helm-files
helm-ff--delete-async-modeline-mode
¶(helm-ff–delete-async-modeline-mode &optional ARG)
Notify mode-line that an async process run.
If called interactively, toggle ‘Helm-Ff–Delete-Async-Modeline 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.
Next: Commands in keymap helm-file-name-history-map
, Previous: Modes in library helm-files
, Up: Library: helm-files [Contents][Index]
helm-browse-project-map
helm-browse-project-run-ag
) ¶Run helm-grep
AG from helm-browse-project
.
Next: Commands in keymap helm-find-files-map
, Previous: Commands in keymap helm-browse-project-map
, Up: Library: helm-files [Contents][Index]
helm-file-name-history-map
helm-ff-file-name-history-run-ff
) ¶Switch back to current HFF session with selection as preselect.
helm-file-name-history-show-or-hide-deleted
) ¶
Next: Commands in keymap helm-read-file-map
, Previous: Commands in keymap helm-file-name-history-map
, Up: Library: helm-files [Contents][Index]
helm-find-files-map
helm-ff-undo
) ¶Undo minibuffer in helm-find-files
.
Ensure disabling helm-ff-auto-update-flag
before undoing.
helm-ff-run-toggle-auto-update
) ¶helm-ff-RET
) ¶Default action for RET in helm-find-files
.
Behave differently depending on helm-selection
:
helm-find-files-up-one-level
) ¶(helm-find-files-up-one-level ARG)
Go up one level like unix command cd ..
.
If prefix numeric arg is given go ARG level up.
helm-find-files-down-last-level
) ¶Retrieve previous paths reached by C-l
in helm-find-files.
helm-ff-toggle-dirs-only
) ¶Show only directories in helm-find-files.
helm-ff-toggle-files-only
) ¶Show only files in helm-find-files.
helm-ff-run-toggle-basename
) ¶helm-ff-run-switch-other-frame
) ¶Run switch to other frame action from helm-source-find-files
.
helm-ff-run-switch-other-window
) ¶Run switch to other window action from helm-source-find-files
.
When a prefix arg is provided, split is done vertically.
helm-ff-find-file-other-tab
) ¶Run find file in other tab action from helm-source-buffers-list
.
helm-ff-run-find-file-as-root
) ¶helm-ff-run-kill-buffer-persistent
) ¶Execute helm-ff-kill-buffer-fname
without quitting.
helm-ff-run-find-alternate-file
) ¶helm-ff-run-open-file-externally
) ¶Run open file externally command action from helm-source-find-files
.
helm-ff-run-open-file-with-default-tool
) ¶Run open file externally command action from helm-source-find-files
.
helm-ff-run-preview-file-externally
) ¶helm-ff-run-copy-file
) ¶Run Copy file action from helm-source-find-files
.
helm-ff-run-rsync-file
) ¶Run Rsync file action from helm-source-find-files
.
helm-ff-run-query-replace-fnames-on-marked
) ¶helm-ff-run-rename-file
) ¶Run Rename file action from helm-source-find-files
.
helm-ff-run-touch-files
) ¶Used to interactively run touch file action from keyboard.
helm-ff-run-delete-file
) ¶Run Delete file action from helm-source-find-files
.
helm-ff-persistent-delete
) ¶Delete current candidate without quitting.
helm-ff-decrease-image-size-persistent
) ¶Decrease image size without quitting helm.
helm-ff-increase-image-size-persistent
) ¶Increase image size without quitting helm.
helm-ff-rotate-left-persistent
) ¶Rotate image left without quitting helm.
helm-ff-rotate-right-persistent
) ¶Rotate image right without quitting helm.
helm-ff-run-git-grep
) ¶Run git-grep action from helm-source-find-files
.
helm-ff-run-grep
) ¶Run Grep action from helm-source-find-files
.
helm-ff-run-grep-ag
) ¶helm-ff-run-gid
) ¶helm-ff-run-pdfgrep
) ¶Run Pdfgrep action from helm-source-find-files
.
helm-ff-run-zgrep
) ¶Run Grep action from helm-source-find-files
.
helm-ff-run-find-sh-command
) ¶Run find shell command action with key from helm-find-files
.
helm-ff-run-locate
) ¶Run locate action from helm-source-find-files
.
helm-ff-run-fd
) ¶Run fd shell command action with key from helm-find-files
.
helm-ff-properties-persistent
) ¶Show properties without quitting helm.
helm-ff-file-name-history
) ¶Switch to file-name-history
without quitting helm-find-files
.
helm-find-files-history
) ¶(helm-find-files-history ARG &key (COMP-READ t))
The helm-find-files
history.
Show the first helm-ff-history-max-length
elements of
helm-ff-history
in an helm-comp-read
.
helm-ff-run-mail-attach-files
) ¶Run mail attach files command action from helm-source-find-files
.
helm-ff-run-marked-files-in-dired
) ¶Execute helm-marked-files-in-dired
interactively.
helm-ff-run-byte-compile-file
) ¶Run Byte compile file action from helm-source-find-files
.
helm-ff-run-load-file
) ¶Run Load file action from helm-source-find-files
.
helm-ff-run-ediff-file
) ¶Run Ediff file action from helm-source-find-files
.
helm-ff-run-ediff-merge-file
) ¶Run Ediff merge file action from helm-source-find-files
.
helm-ff-run-print-file
) ¶Run Print file action from helm-source-find-files
.
helm-ff-run-hardlink-file
) ¶Run Hardlink file action from helm-source-find-files
.
helm-ff-run-relsymlink-file
) ¶Run Symlink file action from helm-source-find-files
.
helm-ff-run-symlink-file
) ¶Run Symlink file action from helm-source-find-files
.
helm-ff-run-browse-project
) ¶helm-ff-run-complete-fn-at-point
) ¶Run complete file name action from helm-source-find-files
.
Run Etags command action from helm-source-find-files
.
helm-ff-run-insert-org-link
) ¶helm-ff-bookmark-set
) ¶Record helm-find-files
session in bookmarks.
helm-find-files-switch-to-bookmark
) ¶Switch to helm-bookmark for helm-find-files
from helm-find-files.
helm-ff-run-switch-to-shell
) ¶Run switch to eshell action from helm-source-find-files
.
helm-ff-run-eshell-command-on-file
) ¶Run eshell command on file action from helm-source-find-files
.
Next: Commands in library helm-files
(excludes keymaps), Previous: Commands in keymap helm-find-files-map
, Up: Library: helm-files [Contents][Index]
helm-read-file-map
helm-ff-run-toggle-basename
) ¶helm-ff-RET
) ¶Default action for RET in helm-find-files
.
Behave differently depending on helm-selection
:
helm-cr-empty-string
) ¶Return empty string.
helm-ff-undo
) ¶Undo minibuffer in helm-find-files
.
Ensure disabling helm-ff-auto-update-flag
before undoing.
helm-find-files-down-last-level
) ¶Retrieve previous paths reached by C-l
in helm-find-files.
helm-find-files-up-one-level
) ¶(helm-find-files-up-one-level ARG)
Go up one level like unix command cd ..
.
If prefix numeric arg is given go ARG level up.
helm-ff-file-name-history
) ¶Switch to file-name-history
without quitting helm-find-files
.
helm-ff-run-toggle-auto-update
) ¶
Next: Options in library ‘helm-files’, Previous: Commands in keymap helm-read-file-map
, Up: Library: helm-files [Contents][Index]
helm-files
(excludes keymaps)helm-delete-tramp-connection
¶Allow deleting tramp connection or marked tramp connections at once.
This replace tramp-cleanup-connection
which is partially broken
in Emacs < to 25.1.50.1 (See Emacs bug http://debbugs.gnu.org/cgi/bugreport.cgi?bug=24432).
It allows additionally to delete more than one connection at once.
helm-ff-RET-must-match
¶Same as helm-ff-RET
but used in must-match map.
helm-ff-TAB
¶(helm-ff-TAB ARG)
Default action for TAB in helm-find-files
.
Behave differently depending on helm-selection
:
Called with a prefix arg open menu unconditionally.
helm-ff-delete-char-backward
¶Go up one level or disable HFF auto update and delete char backward.
Going up one level works only when pattern is a directory endings with “/”, otherwise this command deletes char backward.
Going up one level can be disabled if necessary by deleting “/” at end of pattern using \<helm-map>\[backward-char] and \[helm-delete-minibuffer-contents].
helm-ff-kill-rsync-process
¶(helm-ff-kill-rsync-process PROCESS)
Kill rsync process PROCESS.
When called interactively prompt user with completion when more than one process.
helm-ff--delete-async-modeline-mode
¶(helm-ff–delete-async-modeline-mode &optional ARG)
Notify mode-line that an async process run.
If called interactively, toggle ‘Helm-Ff–Delete-Async-Modeline 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-browse-project
¶(helm-browse-project ARG)
Preconfigured helm to browse projects.
Browse files and see status of project with its VCS.
Only HG and GIT are supported for now.
Fall back to helm-browse-project-find-files
if current
directory is not under control of one of those VCS.
With a prefix ARG browse files recursively, with two prefix ARG
rebuild the cache.
If the current directory is found in the cache, start
helm-browse-project-find-files
even with no prefix ARG.
NOTE: The prefix ARG have no effect on the VCS controlled
directories.
Needed dependencies for VCS: https://github.com/emacs-helm/helm-ls-git and https://github.com/emacs-helm/helm-ls-hg.
helm-find-files
) ¶(helm-find-files ARG)
Preconfigured helm
for helm implementation of find-file
.
Called with a prefix arg show history if some.
Don’t call it from programs, use helm-find-files-1
instead.
This is the starting point for nearly all actions you can do on
files.
helm-projects-history
¶(helm-projects-history ARG)
Next: Hooks in library ‘helm-files’, Previous: Commands in library helm-files
(excludes keymaps), Up: Library: helm-files [Contents][Index]
helm-substitute-in-filename-stay-on-remote
¶Standard Value: nil
Don’t switch back to local filesystem when expanding pattern with / or ~/.
helm-list-directory-function
¶Standard Value: helm-list-dir-external
The function used in helm-find-files
to list remote directories.
Actually Helm provides two functions to do this:
helm-list-dir-lisp
and helm-list-dir-external
.
Using helm-list-dir-external
will provide a similar display to
what is provided with local files i.e. colorized symlinks,
executables files etc., whereas using helm-list-dir-lisp
will
allow colorizing only directories but it is more portable.
NOTE: helm-list-dir-external
needs ls and awk as dependencies.
Also the ls version installed on the remote side should support
the same arguments as the GNU/ls version, which are -A -1 -F -b
and -Q. So even if you are using a GNU/ls version locally and you
want to connect e.g. on a Freebsd server, you may have failures
due to the incompatible ls version installed on remote server. In
such case use helm-list-dir-lisp
which works everywhere but is
slower and less featured (only directories colorized).
helm-rsync-percent-sign
¶Standard Value: %
Percentage unicode sign to use in Rsync reporter.
helm-rsync-switches
¶Standard Value:
("-a" "-z" "-h" "-s" "--info=all2")
Rsync options to use with HFF Rsync action. Note: Using “–info=all2” allows having the name of the file currently transfered in an help-echo in mode-line, if you use “–info=progress2” you will not have this information.
helm-rsync-no-mode-line-update
¶Standard Value: nil
When non nil don’t update mode-line when rsync is running. This is useful if you display the progress bar somewhere else, e.g. with minibuffer-line in minibuffer, in this case updating mode-line may create flickering in other frame’s mode-line.
helm-browse-project-default-find-files-fn
¶Standard Value: helm-browse-project-fd-find-files
The default function to retrieve files in a non-vc directory.
A function that takes a directory name as only arg.
helm-find-files-actions
¶Standard Value:
(("Find File" . helm-find-file-or-marked) ("Find file in Dired" . helm-point-file-in-dired) ("View file" . view-file) ("Query replace fnames on marked ~M-@~" . helm-ff-query-replace-fnames-on-marked) ("Marked files in dired ~C-x C-q, C-u wdired~" . helm-marked-files-in-dired) ("Query replace contents on marked ~M-%~" . helm-ff-query-replace) ("Query replace regexp contents on marked ~C-M-%~" . helm-ff-query-replace-regexp) ("Attach file(s) to mail buffer ~C-c C-a~" . helm-ff-mail-attach-files) ("Serial rename files" . helm-ff-serial-rename) ("Serial rename by symlinking files" . helm-ff-serial-rename-by-symlink) ("Serial rename by copying files" . helm-ff-serial-rename-by-copying) ("Open file with default tool" . helm-open-file-with-default-tool) ("Find file in hex dump" . hexl-find-file) ("Browse project ~C-x C-d~" . helm-ff-browse-project) ("Complete at point ~C-c i~" . helm-insert-file-name-completion-at-point) ("Insert as org link ~C-c @~" . helm-files-insert-as-org-link) ("Find shell command ~C-c /~" . helm-ff-find-sh-command) ("Fd shell command (C-/)" . helm-ff-fd) ("Add marked files to file-cache" . helm-ff-cache-add-file) ("Open file externally ~C-c C-x, C-u to choose~" . helm-open-file-externally) ("Grep File(s) ~C-s, C-u Recurse~" . helm-find-files-grep) ("Grep current directory with AG ~M-g a, C-u select type~" . helm-find-files-ag) ("Git grep ~M-g g, C-u from root~" . helm-ff-git-grep) ("Zgrep File(s) ~M-g z, C-u Recurse~" . helm-ff-zgrep) ("Pdf Grep File(s)" . helm-ff-pdfgrep) ("Gid ~M-g i~" . helm-ff-gid) ("Switch to Eshell ~M-e~" . helm-ff-switch-to-shell) ("Etags ~M-., C-u reload tag file~" . helm-ff-etags-select) ("Eshell command on file(s) ~M-!, C-u take all marked as arguments.~" . helm-find-files-eshell-command-on-file) ("Find file as root ~C-c r~" . helm-find-file-as-root) ("Find alternate file ~C-x C-v~" . find-alternate-file) ("Ediff File ~C-c =~" . helm-find-files-ediff-files) ("Ediff Merge File ~M-=~" . helm-find-files-ediff-merge-files) ("Delete File(s) ~M-D~ (C-u reverse trash)" . helm-ff-delete-files) ("Touch File(s) ~M-T~" . helm-ff-touch-files) ("Copy file(s) ~M-C, C-u to follow~" . helm-find-files-copy) ("Rsync file(s) ~M-V~ (C-u edit command)" . helm-find-files-rsync) ("Rename file(s) ~M-R, C-u to follow~" . helm-find-files-rename) ("Backup files" . helm-find-files-backup) ("Symlink files(s) ~M-S, C-u to follow~" . helm-find-files-symlink) ("Relsymlink file(s) ~M-Y, C-u to follow~" . helm-find-files-relsymlink) ("Hardlink file(s) ~M-H, C-u to follow~" . helm-find-files-hardlink) ("Find file other window ~C-c o~" . helm-find-files-other-window) ("Find file other frame ~C-c C-o~" . find-file-other-frame) ("Find file other tab ~C-c C-t~" . find-file-other-tab) ("Print File ~C-c p, C-u to refresh~" . helm-ff-print) ("Locate ~C-x C-f, C-u to specify locate db~" . helm-ff-locate))
Actions for helm-find-files
.
helm-find-files-after-init-hook
¶Standard Value: nil
Hook that run after initialization of helm-find-files
.
helm-find-files-before-init-hook
¶Standard Value: nil
Hook that run before initialization of helm-find-files
.
helm-find-files-bookmark-prefix
¶Standard Value: Helm-find-files:
bookmark name prefix of helm-find-files
sessions.
helm-find-files-ignore-thing-at-point
¶Standard Value: nil
Use only default-directory
as default input in helm-find-files
.
I.e. text under cursor in current-buffer
is ignored.
Note that when non-nil you will be unable to complete filename at
point in current-buffer
.
helm-files-save-history-extra-sources
¶Standard Value:
("Find" "Locate" "Recentf" "Files from Current Directory" "File Cache")
Extras source that save candidate to file-name-history
.
helm-trash-remote-files
¶Standard Value: nil
Allow trashing remote files when non-nil.
Trashing remote files with tramp doesn’t work out of the box unless the ’trash-cli’ package is installed. This is why trashing remote files from Helm is disabled by default.
Tramp is using external ’trash’ command in its delete-file
and
delete-directory
handlers when using
delete-by-moving-to-trash
, which is documented nowhere in
Emacs.
If you want to enable this you will have to install the ’trash’ command on remote (and/or locally if you want to trash as root). On Ubuntu-based distributions it is ’trash-cli’.
helm-ff-preferred-shell-mode
¶Standard Value: eshell-mode
Shell to use to switch to a shell buffer from helm-find-files
.
Possible values are shell-mode
, eshell-mode
and term-mode
.
This affects M-e
keybinding.
helm-ff-printer-list
¶Standard Value: nil
A list of available printers on your system.
When non-nil let you choose a printer to print file.
Otherwise when nil the variable printer-name
will be used.
On Unix based systems (lpstat command needed) you don’t need to
set this, helm-ff-find-printers
will find a list of available
printers for you.
helm-ff-allow-recursive-deletes
¶Standard Value: nil
When ’always don’t prompt for recursive deletion of directories. When nil, will ask for recursive deletion. Note that when deleting multiple directories you can answer ! when prompted to avoid being asked for next directories, so it is probably better to not modify this variable.
helm-ff-guess-ffap-filenames
¶Standard Value: nil
Use ffap to guess local filenames at point in helm-find-files
.
This doesn’t disable url or mail at point, see
helm-ff-guess-ffap-urls
for this.
helm-ff-guess-ffap-urls
¶Standard Value: t
Use ffap to guess local urls at point in helm-find-files
.
This doesn’t disable guessing filenames at point, see
helm-ff-guess-ffap-filenames
for this.
See also ffap-url-unwrap-remote
that may override this
variable.
helm-ff-DEL-up-one-level-maybe
¶Standard Value: nil
Use DEL to maybe go up one level when non nil.
Going up one level works only when pattern is a directory endings with “/”, otherwise this command deletes char backward.
When nil always delete char backward.
helm-ff--delete-async-modeline-mode-hook
¶Standard Value: nil
Hook run after entering or leaving helm-ff--delete-async-modeline-mode
.
No problems result if this variable is not bound.
add-hook
automatically binds it. (This is true for all hook variables.)
helm-ff-reset-filters-on-update
¶Standard Value: t
Reset filter variables when changing directory. When filtering directories/files only, switch back to a “show all” view when moving out of directory when non nil.
helm-ff-history-max-length
¶Standard Value: 100
Number of elements shown in helm-find-files
history.
helm-ff-auto-update-initial-value
¶Standard Value: nil
Auto update when only one candidate directory is matched.
Default value when starting helm-find-files
is nil to not
confuse new users.
For a better experience with helm-find-files
set this to
non-nil and use C-<backspace> to toggle it.
helm-ff-initial-sort-method
¶Standard Value: nil
Sort method to use when initially listing a directory. Note that this doesn’t affect the listing when matching inside the directory (i.e. filenames).
helm-ff-no-preselect
¶Standard Value: nil
When non-nil helm-find-files
starts at root of current directory.
helm-ff-up-one-level-preselect
¶Standard Value: t
Always preselect previous directory when going one level up.
When non-nil candidate-number-limit
source value is modified
dynamically when going one level up if the position of previous
candidate in its directory is > to
helm-ff-candidate-number-limit
.
It can be helpful to disable this and reduce
helm-ff-candidate-number-limit
if you often navigate across
very large directories.
helm-ff-allow-non-existing-file-at-point
¶Standard Value: nil
Use non existing file-at-point as initial input in helm-find-files
.
helm-ff-file-compressed-list
¶Standard Value:
("gz" "bz2" "zip" "7z")
Minimal list of compressed files extension.
helm-ff-file-name-history-use-recentf
¶Standard Value: nil
Use recentf-list
instead of file-name-history
in helm-find-files
.
helm-ff-display-image-native
¶Standard Value: nil
Use native image-mode
when non nil.
You should use this only with Emacs>= 27 and image-auto-resize
enabled to have images resized properly. When this is enabled,
you have new commands to zoom in/out images. See
image-transform-resize
and image-auto-resize
. Otherwise,
when nil image-dired
is used, using imagemagick as backend.
NOTE: If you see image-mode is eating too much memory, you better have
to set this to nil (default).
helm-ff-rotate-image-switch
¶Standard Value:
("-i")
Options used with helm-ff-rotate-image-program
.
If you are using Mogrify or Jpegtran mandatory option is
“-rotate”, with Exiftran mandatory option is “-i”.
helm-ff-exif-data-program
¶Standard Value: exiftran
Program used to extract exif data of an image file.
helm-ff-exif-data-program-args
¶Standard Value: -d
Arguments used for helm-ff-exif-data-program
.
helm-ff-rotate-image-program
¶Standard Value: exiftran
External program used to rotate images.
When nil and helm-ff-display-image-native
is enabled, fallback to
image-rotate
without modification of exif data i.e. rotation is not
persistent otherwise an error is returned when not using
helm-ff-display-image-native
i.e. using image-dired.
helm-ff-delete-files-function
¶Standard Value: helm-delete-marked-files
The function to use by default to delete files.
Default is to delete files synchronously, other choice is to delete files asynchronously.
BE AWARE that when deleting async you will not be warned about recursive deletion of directories, IOW non-empty directories will be deleted with no warnings in background!!!
It is the function that will be used when using
M-D
from
helm-find-files
.
helm-ff-signal-error-on-dot-files
¶Standard Value: t
Signal error when file is .
or ..
on file deletion when non-nil.
Default is non-nil.
WARNING: Setting this to nil is unsafe and can cause deletion of
a whole tree.
helm-ff-skip-boring-files
¶Standard Value: nil
Non-nil to skip boring files.
I.e. the files matching regexps in helm-boring-file-regexp-list
.
This takes effect in helm-find-files
and file completion used by
helm-mode
i.e. helm-read-file-name
.
Note that when non-nil this will slow down slightly helm-find-files
.
helm-ff-skip-git-ignored-files
¶Standard Value: nil
Non-nil to skip git ignored files.
This take effect only in helm-find-files
.
Check is not done on remote files.
Note that when non-nil this will slow down slightly
helm-find-files
.
helm-ff-avfs-directory
¶Standard Value: ~/.avfs
The default avfs directory, usually ’~/.avfs’.
When this is set you will be able to expand archive filenames
with C-j
inside an avfs directory mounted with mountavfs.
See http://sourceforge.net/projects/avf/.
helm-ff-candidate-number-limit
¶Standard Value: 5000
The helm-candidate-number-limit
for helm-find-files
and friends.
Note that when going one level up with
C-l
the
length of directory will be used instead if it is higher than
this value. This is to avoid failing to preselect the previous
directory/file if this one is situated lower than
helm-ff-candidate-number-limit
num candidate.
helm-ff-fuzzy-matching
¶Standard Value: t
Enable fuzzy matching for helm-find-files
when non–nil.
See helm-ff--transform-pattern-for-completion
for more info.
helm-ff-goto-first-real-dired-exceptions
¶Standard Value:
(dired-goto-file)
Dired commands that are allowed moving to first real candidate.
helm-ff-kill-or-find-buffer-fname-fn
¶Standard Value: helm-ff-kill-or-find-buffer-fname
Default function used to expand non-directory filenames in helm-find-files
.
This variable will take effect only in helm-find-files
. It
affects the behavior of persistent-action on filenames and
non-existing filenames.
The default is to expand filename on first hit on C-j, pop buffer in other window on second hit and finally kill this buffer on third hit. This is very handy to create several new buffers, or when navigating, show quickly the buffer of file to see its contents briefly before killing it and continue navigating.
However some users may not want this, so to disable this behaviour
just set this to ignore
function.
Of course you can also write your own function to do something else.
helm-ff-lynx-style-map
¶Standard Value: t
Use arrow keys to navigate with helm-find-files
.
Note that if you define this variable with setq
your change
will have no effect, use customize instead.
helm-ff-newfile-prompt-p
¶Standard Value: t
Whether Prompt or not when creating new file.
This set ffap-newfile-prompt
.
helm-ff-search-library-in-sexp
¶Standard Value: nil
Search for library in require
and declare-function
sexp.
helm-ff-transformer-show-only-basename
¶Standard Value: t
Show only basename of candidates in helm-find-files
.
This can be toggled at anytime from helm-find-files
with C-].
helm-ff--delete-async-modeline-mode
¶Standard Value: nil
(helm-ff–delete-async-modeline-mode &optional ARG)
Notify mode-line that an async process run.
If called interactively, toggle ‘Helm-Ff–Delete-Async-Modeline 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-dwim-target
¶Standard Value: nil
Default target directory for file actions.
Define the directory where you want to start navigating for the
target directory when copying, renaming, etc.. You can use the
default-directory
of next-window
, the current
default-directory
or have completion on all the directories
belonging to each window.
helm-modes-using-escaped-strings
¶Standard Value:
(eshell-mode shell-mode term-mode)
Modes that requires string’s insertion to be escaped.
helm-mounted-network-directories
¶Standard Value: nil
A list of directories used for mounting remotes filesystem.
When nil helm-file-on-mounted-network-p
always return nil
otherwise check if a file is in one of these directories.
Remote filesystem are generally mounted with sshfs.
helm-tooltip-hide-delay
¶Standard Value: 25
Hide tooltips automatically after this many seconds.
helm-tramp-verbose
¶Standard Value: 0
Just like tramp-verbose
but specific to Helm.
When set to 0 don’t show tramp messages in Helm.
If you want to have the default tramp messages set it to 3.
Previous: Options in library ‘helm-files’, Up: Library: helm-files [Contents][Index]
helm-find-files-after-init-hook
¶Standard Value: nil
Hook that run after initialization of helm-find-files
.
helm-find-files-before-init-hook
¶Standard Value: nil
Hook that run before initialization of helm-find-files
.
helm-ff--delete-async-modeline-mode-hook
¶Standard Value: nil
Hook run after entering or leaving helm-ff--delete-async-modeline-mode
.
No problems result if this variable is not bound.
add-hook
automatically binds it. (This is true for all hook variables.)
helm-ff--update-resume-after-hook
¶Standard Value:
helm-ff-before-action-hook-fn
¶Standard Value:
helm-ff-setup-update-hook
¶Standard Value:
Next: Library: helm-font, Previous: Library: helm-files, Up: Package: helm [Contents][Index]
helm-find-map
helm-find
(excludes keymaps)helm-find-map
helm-delete-backward-no-update
) ¶(helm-delete-backward-no-update ARG)
Disable update and delete ARG chars backward. Update is reenabled when idle 1s.
Next: Options in library ‘helm-find’, Previous: Commands in keymap helm-find-map
, Up: Library: helm-find [Contents][Index]
helm-find
(excludes keymaps)helm-find
) ¶(helm-find ARG)
Preconfigured helm
for the find shell command.
Recursively find files whose names are matched by all specified
globbing PATTERNs under the current directory using the external
program specified in find-program
(usually “find”). Every
input PATTERN is silently wrapped into two stars: PATTERN.
With prefix argument, prompt for a directory to search.
When user option helm-findutils-search-full-path
is non-nil,
match against complete paths, otherwise, against file names
without directory part.
The (possibly empty) list of globbing PATTERNs can be followed by the separator “*” plus any number of additional arguments that are passed to “find” literally.
Previous: Commands in library helm-find
(excludes keymaps), Up: Library: helm-find [Contents][Index]
helm-findutils-search-full-path
¶Standard Value: nil
Search in full path with shell command find when non-nil. I.e. use the -path/ipath arguments of find instead of -name/iname.
helm-findutils-skip-boring-files
¶Standard Value: t
Ignore boring files in find command results.
helm-find-noerrors
¶Standard Value: nil
Prevent showing error messages in helm buffer when non nil.
Next: Library: helm-for-files, Previous: Library: helm-find, Up: Package: helm [Contents][Index]
helm-ucs-map
helm-font
(excludes keymaps)helm-ucs-map
helm-ucs-persistent-backward
) ¶helm-ucs-persistent-delete
) ¶helm-ucs-persistent-forward
) ¶helm-ucs-persistent-insert-space
) ¶
Next: Options in library ‘helm-font’, Previous: Commands in keymap helm-ucs-map
, Up: Library: helm-font [Contents][Index]
helm-font
(excludes keymaps)helm-select-xfont
) ¶Preconfigured helm
to select Xfont.
helm-ucs
) ¶(helm-ucs ARG)
Preconfigured helm
for ucs-names
.
Called with a prefix arg force reloading cache.
Previous: Commands in library helm-font
(excludes keymaps), Up: Library: helm-font [Contents][Index]
helm-ucs-actions
¶Standard Value:
(("Insert character" . helm-ucs-insert-char) ("Insert character name" . helm-ucs-insert-name) ("Insert character code in hex" . helm-ucs-insert-code) ("Kill marked characters" . helm-ucs-kill-char) ("Kill name" . helm-ucs-kill-name) ("Kill code" . helm-ucs-kill-code))
Actions for helm-source-ucs
.
helm-ucs-recent-size
¶Standard Value: 10
Number of recent chars to keep.
Next: Library: helm-global-bindings, Previous: Library: helm-font, Up: Package: helm [Contents][Index]
helm-for-files
(excludes keymaps)helm-for-files
¶Preconfigured helm
for opening files.
Run all sources defined in helm-for-files-preferred-list
.
helm-multi-files
) ¶Preconfigured helm like helm-for-files
but running locate only on demand.
Allow toggling back and forth from locate to others sources with
helm-multi-files-toggle-locate-binding
key.
This avoids launching locate needlessly when what you are
searching for is already found.
helm-multi-files-toggle-to-locate
¶helm-recentf
) ¶Preconfigured helm
for recentf
.
Previous: Commands in library helm-for-files
(excludes keymaps), Up: Library: helm-for-files [Contents][Index]
helm-file-cache-fuzzy-match
¶Standard Value: nil
Enable fuzzy matching in helm-source-file-cache
when non–nil.
helm-recentf-fuzzy-match
¶Standard Value: nil
Enable fuzzy matching in helm-source-recentf
when non-nil.
helm-turn-on-recentf
¶Standard Value: t
Automatically turn on recentf-mode
when non-nil.
helm-for-files-preferred-list
¶Standard Value:
(helm-source-buffers-list helm-source-recentf helm-source-bookmarks helm-source-file-cache helm-source-files-in-current-dir helm-source-locate)
Your preferred sources for helm-for-files
and helm-multi-files
.
When adding a source here it is up to you to ensure the library of this source is accessible and properly loaded.
helm-for-files-tramp-not-fancy
¶Standard Value: t
Colorize remote files when non nil.
Be aware that a nil value will make tramp display very slow.
helm-multi-files-toggle-locate-binding
¶Standard Value: C-c p
Default binding to switch back and forth locate in helm-multi-files
.
Next: Library: helm-grep, Previous: Library: helm-for-files, Up: Package: helm [Contents][Index]
Next: Options in library ‘helm-global-bindings’, Up: Library: helm-global-bindings [Contents][Index]
helm-command-map
helm-documentation
) ¶Preconfigured helm
for Helm documentation.
With a prefix arg refresh the documentation.
Find here the documentation of all documented sources.
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.
helm-find-files
) ¶(helm-find-files ARG)
Preconfigured helm
for helm implementation of find-file
.
Called with a prefix arg show history if some.
Don’t call it from programs, use helm-find-files-1
instead.
This is the starting point for nearly all actions you can do on
files.
helm-multi-files
) ¶Preconfigured helm like helm-for-files
but running locate only on demand.
Allow toggling back and forth from locate to others sources with
helm-multi-files-toggle-locate-binding
key.
This avoids launching locate needlessly when what you are
searching for is already found.
helm-recentf
) ¶Preconfigured helm
for recentf
.
helm-find
) ¶(helm-find ARG)
Preconfigured helm
for the find shell command.
Recursively find files whose names are matched by all specified
globbing PATTERNs under the current directory using the external
program specified in find-program
(usually “find”). Every
input PATTERN is silently wrapped into two stars: PATTERN.
With prefix argument, prompt for a directory to search.
When user option helm-findutils-search-full-path
is non-nil,
match against complete paths, otherwise, against file names
without directory part.
The (possibly empty) list of globbing PATTERNs can be followed by the separator “*” plus any number of additional arguments that are passed to “find” literally.
helm-locate
) ¶(helm-locate ARG)
Preconfigured helm
for Locate.
Note: you can add locate options after entering pattern.
See ’man locate’ for valid options and also helm-locate-command
.
You can specify a local database with prefix argument ARG. With two prefix arg, refresh the current local db or create it if it doesn’t exists.
To create a user specific db, use
“updatedb -l 0 -o db_path -U directory”.
Where db_path is a filename matched by
helm-locate-db-file-regexp
.
helm-buffers-list
) ¶Preconfigured helm
to list buffers.
helm-show-kill-ring
) ¶Preconfigured helm
for kill-ring
.
It is drop-in replacement of yank-pop
.
First call open the kill-ring browser, next calls move to next line.
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.
helm-register
) ¶Preconfigured helm
for Emacs registers.
helm-all-mark-rings
) ¶Preconfigured helm
for helm-source-global-mark-ring
and helm-source-mark-ring
.
helm-occur
) ¶Preconfigured helm for searching lines matching pattern in current-buffer
.
When helm-source-occur
is member of
helm-sources-using-default-as-input
which is the default,
symbol at point is searched at startup.
When a region is marked search only in this region by narrowing.
To search in multiples buffers start from one of the commands listing
buffers (i.e. a helm command using helm-source-buffers-list
like
helm-mini
) and use the multi occur buffers action.
This is the helm implementation that collect lines matching pattern
like vanilla Emacs occur
but have nothing to do with it, the search
engine beeing completely different and also much faster.
helm-do-grep-ag
) ¶(helm-do-grep-ag ARG)
Preconfigured helm
for grepping with AG in default-directory
.
With prefix arg prompt for type if available with your AG
version.
helm-gid
) ¶Preconfigured helm
for gid
command line of ID-Utils
.
Need A database created with the command mkid
above
default-directory
.
Need id-utils as dependency which provide mkid
, gid
etc..
See https://www.gnu.org/software/idutils/.
(helm-etags-select REINIT)
Preconfigured helm for etags. If called with a prefix argument REINIT or if any of the tag files have been modified, reinitialize cache.
This function aggregates three sources of tag files:
helm-etags-get-tag-file
.
tags-file-name
, which is commonly set by find-tag
command.
tags-table-list
which is commonly set by visit-tags-table
command.
Preconfigured helm
for imenu
.
Preconfigured helm
for fetching imenu entries in all buffers with similar mode as current.
A mode is similar as current if it is the same, it is derived
i.e. derived-mode-p
or it have an association in
helm-imenu-all-buffer-assoc
.
helm-lisp-completion-at-point
) ¶Preconfigured Helm for Lisp symbol completion at point.
helm-calcul-expression
) ¶Preconfigured helm
for helm-source-calculation-result
.
helm-eval-expression-with-eldoc
) ¶Preconfigured helm
for helm-source-evaluation-result
with eldoc
support.
helm-regexp
) ¶Preconfigured helm to build regexps.
query-replace-regexp
can be run from there against found regexp.
helm-info-at-point
) ¶Preconfigured helm
for searching info at point.
helm-info-emacs
) ¶Predefined helm for emacs info.
helm-info-gnus
) ¶Predefined helm for gnus info.
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-man-woman
) ¶(helm-man-woman ARG)
Preconfigured helm
for Man and Woman pages.
With a prefix arg reinitialize the cache.
helm-list-emacs-process
) ¶Preconfigured helm
for Emacs process.
helm-list-elisp-packages
) ¶(helm-list-elisp-packages ARG)
Preconfigured helm
for listing and handling Emacs packages.
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-external-command
) ¶(helm-run-external-command PROGRAM)
Preconfigured helm
to run External PROGRAM asyncronously from Emacs.
If program is already running exit with error.
You can set your own list of commands with
helm-external-commands-list
.
helm-google-suggest
) ¶Preconfigured helm
for Google search with Google suggest.
helm-surfraw
) ¶(helm-surfraw PATTERN ENGINE)
Preconfigured helm
to search PATTERN with search ENGINE.
helm-top
) ¶Preconfigured helm
for top command.
helm-ucs
) ¶(helm-ucs ARG)
Preconfigured helm
for ucs-names
.
Called with a prefix arg force reloading cache.
helm-select-xfont
) ¶Preconfigured helm
to select Xfont.
helm-colors
) ¶Preconfigured helm
for color.
Previous: Commands in keymap helm-command-map
, Up: Library: helm-global-bindings [Contents][Index]
helm-command-prefix-key
¶Standard Value: C-x c
The key helm-command-prefix
is bound to in the global map.
helm-minibuffer-history-key
¶Standard Value: C-r
The key helm-minibuffer-history
is bound to in minibuffer local maps.
Next: Library: helm-help, Previous: Library: helm-global-bindings, Up: Package: helm [Contents][Index]
helm-grep
helm-grep-map
helm-grep-mode-map
helm-pdfgrep-map
helm-grep
(excludes keymaps)
Next: Commands in keymap helm-grep-map
, Up: Library: helm-grep [Contents][Index]
helm-grep
helm-grep-mode
¶Major mode to provide actions in helm grep saved buffer.
Special commands: \{helm-grep-mode-map}
In addition to any hooks its parent mode special-mode
might have
run, this mode runs the hook helm-grep-mode-hook
, as the final or
penultimate step during initialization.
Next: Commands in keymap helm-grep-mode-map
, Previous: Modes in library helm-grep
, Up: Library: helm-grep [Contents][Index]
helm-grep-map
helm-goto-next-file
) ¶Go to previous file in Helm grep/etags buffers.
helm-goto-precedent-file
) ¶Go to previous file in Helm grep/etags buffers.
helm-grep-run-default-action
) ¶Run grep default action from helm-do-grep-1
.
helm-grep-run-other-frame-action
) ¶Run grep goto other frame action from helm-do-grep-1
.
helm-grep-run-other-window-action
) ¶Run grep goto other window action from helm-do-grep-1
.
helm-grep-run-save-buffer
) ¶Run grep save results action from helm-do-grep-1
.
helm-delete-backward-no-update
) ¶(helm-delete-backward-no-update ARG)
Disable update and delete ARG chars backward. Update is reenabled when idle 1s.
Next: Commands in keymap helm-pdfgrep-map
, Previous: Commands in keymap helm-grep-map
, Up: Library: helm-grep [Contents][Index]
helm-grep-mode-map
helm-gm-next-file
) ¶helm-gm-precedent-file
) ¶helm-grep-mode-jump
) ¶helm-grep-mode-jump-other-window
) ¶helm-grep-mode-jump-other-window-backward
) ¶(helm-grep-mode-jump-other-window-backward ARG)
helm-grep-mode-jump-other-window-forward
) ¶(helm-grep-mode-jump-other-window-forward ARG)
Next: Commands in library helm-grep
(excludes keymaps), Previous: Commands in keymap helm-grep-mode-map
, Up: Library: helm-grep [Contents][Index]
helm-pdfgrep-map
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-goto-next-file
) ¶Go to previous file in Helm grep/etags buffers.
helm-goto-precedent-file
) ¶Go to previous file in Helm grep/etags buffers.
Next: Options in library ‘helm-grep’, Previous: Commands in keymap helm-pdfgrep-map
, Up: Library: helm-grep [Contents][Index]
helm-grep
(excludes keymaps)helm-do-grep-ag
) ¶(helm-do-grep-ag ARG)
Preconfigured helm
for grepping with AG in default-directory
.
With prefix arg prompt for type if available with your AG
version.
helm-grep-do-git-grep
¶(helm-grep-do-git-grep ARG)
Preconfigured helm
for git-grepping default-directory
.
With a prefix arg ARG git-grep the whole repository.
helm-grep-mode-mouse-jump
¶(helm-grep-mode-mouse-jump EVENT)
helm-grep-mode
¶Major mode to provide actions in helm grep saved buffer.
Special commands: \{helm-grep-mode-map}
In addition to any hooks its parent mode special-mode
might have
run, this mode runs the hook helm-grep-mode-hook
, as the final or
penultimate step during initialization.
Next: Hooks in library ‘helm-grep’, Previous: Commands in library helm-grep
(excludes keymaps), Up: Library: helm-grep [Contents][Index]
helm-grep-file-path-style
¶Standard Value: basename
File path display style when grep results are displayed. Possible value are: basename: displays only the filename, none of the directory path absolute: displays absolute path relative: displays relative path from root grep directory.
helm-grep-use-ioccur-style-keys
¶Standard Value: t
Use Arrow keys to jump to occurences.
Note that if you define this variable with setq
your change
will have no effect, use customize instead.
helm-zgrep-file-extension-regexp
¶Standard Value: .*$
Default file extensions zgrep will search in.
helm-grep-ignored-directories
¶Standard Value:
("SCCS/" "RCS/" "CVS/" "MCVS/" ".svn/" ".git/" ".hg/" ".bzr/" "_MTN/" "_darcs/" "{arch}/" ".gvfs/")
List of names of sub-directories which helm-grep
shall not recurse into.
helm-grep-ignored-files
¶Standard Value:
(".#*" "*.o" "*~" "*.bin" "*.lbin" "*.so" "*.a" "*.ln" "*.blg" "*.bbl" "*.elc" "*.lof" "*.glo" "*.idx" "*.lot" "*.fmt" "*.tfm" "*.class" "*.fas" "*.lib" "*.mem" "*.x86f" "*.sparcf" "*.dfsl" "*.pfsl" "*.d64fsl" "*.p64fsl" "*.lx64fsl" "*.lx32fsl" "*.dx64fsl" "*.dx32fsl" "*.fx64fsl" "*.fx32fsl" "*.sx64fsl" "*.sx32fsl" "*.wx64fsl" "*.wx32fsl" "*.fasl" "*.ufsl" "*.fsl" "*.dxl" "*.lo" "*.la" "*.gmo" "*.mo" "*.toc" "*.aux" "*.cp" "*.fn" "*.ky" "*.pg" "*.tp" "*.vr" "*.cps" "*.fns" "*.kys" "*.pgs" "*.tps" "*.vrs" "*.pyc" "*.pyo")
List of file names which helm-grep
shall exclude.
helm-grep-ag-pipe-cmd-switches
¶Standard Value: nil
A list of additional parameters to pass to grep-ag pipe command. Use parameters compatibles with the backend you are using (i.e. AG for AG, PT for PT or RG for RG)
You probably don’t need to use this unless you know what you are doing.
helm-grep-pipe-cmd-switches
¶Standard Value: nil
A list of additional parameters to pass to grep pipe command. This will be used to pipe command for multiple pattern matching for grep, zgrep ack-grep and git-grep backends. If you add extra args for ack-grep, use ack-grep options, for others (grep, zgrep and git-grep) use grep options. Here are the commands where you may want to add switches:
grep –color=always ack-grep –smart-case –color
You probably don’t need to use this unless you know what you are doing.
helm-default-zgrep-command
¶Standard Value: zgrep –color=always -a -n%cH -e %p %f
Default command for Zgrep.
See helm-grep-default-command
for infos on format specs.
Option –color=always is supported and can be used safely to
replace the Helm internal match highlighting. See
helm-grep-default-command
for more infos.
helm-grep-default-command
¶Standard Value: grep –color=always -a -d skip %e -n%cH -e %p %f
Default grep format command for helm-do-grep-1
.
Where:
’%e’ format spec is for –exclude or –include grep options or
ack-grep –type option. (Not mandatory)
’%c’ format spec is for case-fold-search, whether to use the -i option of grep. (Not mandatory) When you specify this spec, helm grep will use smartcase that is when a upcase character is found in pattern case will be respected and no ’-i’ option will be used, otherwise, when no upcase character is found in pattern always use ’-i’. If you don’t want this behavior, don’t use this spec and specify or not the ’-i’ option. Note that with ack-grep this is not needed, just specify the ’–smart-case’ option.
’%p’ format spec is for pattern. (Mandatory)
’%f’ format spec is for filenames. (Mandatory)
If your grep version doesn’t support the –exclude/include args don’t specify the ’%e’ format spec.
Helm also support ack-grep and git-grep. The following is a default command example for ack-grep:
(setq helm-grep-default-command “ack-grep -Hn –color –smart-case –no-group %e %p %f” helm-grep-default-recurse-command “ack-grep -H –color –smart-case –no-group %e %p %f”)
You can ommit the %e spec if you don’t want to be prompted for types.
NOTE: Helm for ack-grep support ANSI sequences, so you can remove the “–no-color” option safely (recommended). However you should specify –color to enable multi matches highlighting because ack disable it when output is piped.
Same for grep you can use safely the option “–color=always” (default). You can customize the color of matches using GREP_COLORS env var. e.g: (setenv “GREP_COLORS” “ms=30;43:mc=30;43:sl=01;37:cx=:fn=35:ln=32:bn=32:se=36”)
To enable ANSI color in git-grep just add “–color=always”. To customize the ANSI color in git-grep, GREP_COLORS have no effect, you will have to setup this in your .gitconfig:
[color “grep”] match = black yellow
Where “black” is the foreground and “yellow” the background. See the git documentation for more infos.
helm-grep-default-command
and
helm-grep-default-recurse-command
are independent, so you can
enable helm-grep-default-command
with ack-grep and
helm-grep-default-recurse-command
with grep if you want to be
faster on recursive grep.
NOTE: Remote grepping is not available with ack-grep, and badly supported with grep because tramp handles badly repeated remote processes in a short delay (< to 5s).
helm-grep-default-recurse-command
¶Standard Value: grep –color=always -a -d recurse %e -n%cH -e %p %f
Default recursive grep format command for helm-do-grep-1
.
See helm-grep-default-command
for format specs and infos about
ack-grep.
helm-pdfgrep-default-command
¶Standard Value: pdfgrep –color always -niH %s %s
Default command for pdfgrep. Option “–color always” is supported starting Helm version 1.7.8. When used matches will be highlighted according to GREP_COLORS env var.
helm-pdfgrep-default-read-command
¶Standard Value: nil
Default command to read pdf files from pdfgrep. Where ’%f’ format spec is filename and ’%p’ is page number. E.g. In Ubuntu you can set it to:
“evince –page-label=%p ’%f’”
If set to nil either doc-view-mode
or pdf-view-mode
will be
used instead of an external command.
helm-pdfgrep-default-recurse-command
¶Standard Value: pdfgrep –color always -rniH %s %s
Default recurse command for pdfgrep. Option “–color always” is supported starting Helm version 1.7.8. When used matches will be highlighted according to GREP_COLORS env var.
helm-grep-ag-command
¶Standard Value: ag –line-numbers -S –color –nogroup %s %s %s
The default command for AG, PT or RG.
Takes three format specs, the first for type(s), the second for pattern and the third for directory.
You can use safely “–color” (used by default) with AG RG and PT.
NOTE: Usage of “–color=never” is discouraged as it uses Elisp to colorize matched items which is slower than using the native colorization of backend, however it is still supported.
For ripgrep here is the command line to use:
rg –color=always –smart-case –no-heading –line-number %s %s %s
And to customize colors (always for ripgrep) use something like this:
rg –color=always –colors ’match:bg:yellow’ –colors ’match:fg:black’ –smart-case –no-heading –line-number %s %s %s
This will change color for matched items from foreground red (the default) to a yellow background with a black foreground. Note that your color settings for RG will not work properly with multiples pattern if you have configured colors in rg config file instead of command line. For more enhanced settings of ansi colors see https://github.com/emacs-helm/helm/issues/2313
You must use an output format that fit with helm grep, that is:
“filename:line-number:string”
The option “–nogroup” allow this. The option “–line-numbers” is also mandatory except with PT (not supported). For RG the options “–no-heading” and “–line-number” are the ones to use.
When modifying the default colors of matches with e.g.
“–color-match” option of AG or “–colors” option of ripgrep
you may want to modify as well helm-grep-ag-pipe-cmd-switches
to have all matches colorized with the same color in multi
match.
Of course you can use several other options, see the man page of the backend you are using.
helm-grep-git-grep-command
¶Standard Value: git –no-pager grep -n%cH –color=always –full-name -e %p – %f
The git grep default command line.
The option “–color=always” can be used safely.
The color of matched items can be customized in your .gitconfig
See helm-grep-default-command
for more infos.
The “–exclude-standard” and “–no-index” switches allow skipping unwanted files specified in ~/.gitignore_global and searching files not already staged (not enabled by default).
You have also to enable this in global “.gitconfig” with “git config –global core.excludesfile ~/.gitignore_global”.
helm-grep-actions
¶Standard Value:
(("Find File" . helm-grep-action) ("Find file other frame" . helm-grep-other-frame) ("Save results in grep buffer" . helm-grep-save-results) ("Find file other window (C-u vertically)" . helm-grep-other-window))
Actions for helm grep.
helm-grep-input-idle-delay
¶Standard Value: 0.1
Idle time before updating, specified in seconds. A lower value (default) means Helm will display the results faster. Increasing it to a higher value (e.g. 0.6) prevents the buffer from flickering when updating.
helm-grep-max-length-history
¶Standard Value: 100
Max number of elements to save in helm-grep-history
.
helm-grep-preferred-ext
¶Standard Value: nil
This file extension will be preselected for grep.
helm-grep-save-buffer-name-no-confirm
¶Standard Value: nil
When hgrep already exists, auto append suffix.
helm-grep-truncate-lines
¶Standard Value: t
When nil the grep line that appears will not be truncated.
Previous: Options in library ‘helm-grep’, Up: Library: helm-grep [Contents][Index]
helm-grep-after-init-hook
¶Standard Value: nil
Hook that runs after initialization of the Helm buffer.
helm-grep-before-init-hook
¶Standard Value: nil
Hook that runs before initialization of the Helm buffer.
helm-grep-mode-hook
¶Standard Value: nil
Hook run after entering helm-grep mode.
No problems result if this variable is not bound.
add-hook
automatically binds it. (This is true for all hook variables.)
Next: Library: helm-id-utils, Previous: Library: helm-grep, Up: Package: helm [Contents][Index]
Up: Library: helm-help [Contents][Index]
helm-help
(excludes keymaps)helm-documentation
) ¶Preconfigured helm
for Helm documentation.
With a prefix arg refresh the documentation.
Find here the documentation of all documented sources.
Next: Library: helm-imenu, Previous: Library: helm-help, Up: Package: helm [Contents][Index]
helm-id-utils
(excludes keymaps)helm-gid
) ¶Preconfigured helm
for gid
command line of ID-Utils
.
Need A database created with the command mkid
above
default-directory
.
Need id-utils as dependency which provide mkid
, gid
etc..
See https://www.gnu.org/software/idutils/.
Previous: Commands in library helm-id-utils
(excludes keymaps), Up: Library: helm-id-utils [Contents][Index]
helm-gid-db-file-name
¶Standard Value: ID
Name of a database file created by mkid
command from ID-utils
.
helm-gid-program
¶Standard Value: gid
Name of gid command (usually gid
).
For Mac OS X users, if you install GNU coreutils, the name gid
might be occupied by id
from GNU coreutils, and you should set
it to correct name (or absolute path). For example, if using
MacPorts to install id-utils, it should be gid32
.
Next: Library: helm-lib, Previous: Library: helm-imenu, Up: Package: helm [Contents][Index]
helm-info
helm-info
(excludes keymaps)helm-info
helm-info-nxml-mode
¶Predefined helm for nxml-mode info.
helm-info-octave-mode
¶Predefined helm for octave-mode info.
helm-info-todo-mode
¶Predefined helm for todo-mode info.
helm-info-vhdl-mode
¶Predefined helm for vhdl-mode info.
Next: Options in library ‘helm-info’, Previous: Modes in library helm-info
, Up: Library: helm-info [Contents][Index]
helm-info
(excludes keymaps)helm-info-grub
¶Predefined helm for grub info.
helm-info-grub-dev
¶Predefined helm for grub-dev info.
helm-info-find
¶Predefined helm for find info.
helm-info-find-maint
¶Predefined helm for find-maint info.
helm-info-helm-manual
¶Predefined helm for helm-manual info.
helm-info-helm-manual-1
¶Predefined helm for helm-manual-1 info.
helm-info-automake-1
¶Predefined helm for automake-1 info.
helm-info-automake-history
¶Predefined helm for automake-history info.
helm-info-lzip
¶Predefined helm for lzip info.
helm-info-lzip-compressor
¶Predefined helm for lzip-compressor info.
helm-info-lzip-decompressor
¶Predefined helm for lzip-decompressor info.
helm-info-emacs
) ¶Predefined helm for emacs info.
helm-info-emacs-gnutls
¶Predefined helm for emacs-gnutls info.
helm-info-emacs-mime
¶Predefined helm for emacs-mime info.
helm-info-R-FAQ
¶Predefined helm for R-FAQ info.
helm-info-R-admin
¶Predefined helm for R-admin info.
helm-info-R-data
¶Predefined helm for R-data info.
helm-info-R-exts
¶Predefined helm for R-exts info.
helm-info-R-intro
¶Predefined helm for R-intro info.
helm-info-R-ints
¶Predefined helm for R-ints info.
helm-info-R-lang
¶Predefined helm for R-lang info.
helm-info-nxml-mode
¶Predefined helm for nxml-mode info.
helm-info-octave-mode
¶Predefined helm for octave-mode info.
helm-info-todo-mode
¶Predefined helm for todo-mode info.
helm-info-vhdl-mode
¶Predefined helm for vhdl-mode info.
helm-info
¶(helm-info &optional REFRESH)
Preconfigured helm
for searching Info files’ indices.
With a prefix argument \[universal-argument], set REFRESH to non-nil.
Optional parameter REFRESH, when non-nil, re-evaluates
helm-default-info-index-list
. If the variable has been
customized, set it to its saved value. If not, set it to its
standard value. See custom-reevaluate-setting
for more.
REFRESH is useful when new Info files are installed. If
helm-default-info-index-list
has not been customized, the new
Info files are made available.
helm-info-at-point
) ¶Preconfigured helm
for searching info at point.
helm-info-auth
¶Predefined helm for auth info.
helm-info-autosprintf
¶Predefined helm for autosprintf info.
helm-info-autotype
¶Predefined helm for autotype info.
helm-info-bc
¶Predefined helm for bc info.
helm-info-bovine
¶Predefined helm for bovine info.
helm-info-bzip2
¶Predefined helm for bzip2 info.
helm-info-calc
¶Predefined helm for calc info.
helm-info-ccmode
¶Predefined helm for ccmode info.
helm-info-cl
¶Predefined helm for cl info.
helm-info-com_err
¶Predefined helm for com_err info.
helm-info-coreutils
¶Predefined helm for coreutils info.
helm-info-cvsclient
¶Predefined helm for cvsclient info.
helm-info-dbus
¶Predefined helm for dbus info.
helm-info-dc
¶Predefined helm for dc info.
helm-info-diffutils
¶Predefined helm for diffutils info.
helm-info-dired-x
¶Predefined helm for dired-x info.
helm-info-dvipng
¶Predefined helm for dvipng info.
helm-info-dvips
¶Predefined helm for dvips info.
helm-info-ebrowse
¶Predefined helm for ebrowse info.
helm-info-ed
¶Predefined helm for ed info.
helm-info-ede
¶Predefined helm for ede info.
helm-info-ediff
¶Predefined helm for ediff info.
helm-info-edt
¶Predefined helm for edt info.
helm-info-eieio
¶Predefined helm for eieio info.
helm-info-eintr
¶Predefined helm for eintr info.
helm-info-elisp
¶Predefined helm for elisp info.
helm-info-emms
¶Predefined helm for emms info.
helm-info-epa
¶Predefined helm for epa info.
helm-info-erc
¶Predefined helm for erc info.
helm-info-ert
¶Predefined helm for ert info.
helm-info-eshell
¶Predefined helm for eshell info.
helm-info-eudc
¶Predefined helm for eudc info.
helm-info-eww
¶Predefined helm for eww info.
helm-info-fastjar
¶Predefined helm for fastjar info.
helm-info-flex
¶Predefined helm for flex info.
helm-info-flymake
¶Predefined helm for flymake info.
helm-info-fontname
¶Predefined helm for fontname info.
helm-info-forms
¶Predefined helm for forms info.
helm-info-gettext
¶Predefined helm for gettext info.
helm-info-global
¶Predefined helm for global info.
helm-info-gnupg
¶Predefined helm for gnupg info.
helm-info-gnus
) ¶Predefined helm for gnus info.
helm-info-gpm
¶Predefined helm for gpm info.
helm-info-grep
¶Predefined helm for grep info.
helm-info-gzip
¶Predefined helm for gzip info.
helm-info-helm
¶Predefined helm for helm info.
helm-info-helm-bugs
¶Predefined helm for helm-bugs info.
helm-info-helm-devel
¶Predefined helm for helm-devel info.
helm-info-htmlfontify
¶Predefined helm for htmlfontify info.
helm-info-idlwave
¶Predefined helm for idlwave info.
helm-info-ido
¶Predefined helm for ido info.
helm-info-idutils
¶Predefined helm for idutils info.
helm-info-info
¶Predefined helm for info info.
helm-info-info-stnd
¶Predefined helm for info-stnd info.
helm-info-kpathsea
¶Predefined helm for kpathsea info.
helm-info-latex2man
¶Predefined helm for latex2man info.
helm-info-libffi
¶Predefined helm for libffi info.
helm-info-m4
¶Predefined helm for m4 info.
helm-info-mairix-el
¶Predefined helm for mairix-el info.
helm-info-message
¶Predefined helm for message info.
helm-info-mh-e
¶Predefined helm for mh-e info.
helm-info-nano
¶Predefined helm for nano info.
helm-info-nettle
¶Predefined helm for nettle info.
helm-info-newsticker
¶Predefined helm for newsticker info.
helm-info-org
¶Predefined helm for org info.
helm-info-pgg
¶Predefined helm for pgg info.
helm-info-rcirc
¶Predefined helm for rcirc info.
helm-info-rcs
¶Predefined helm for rcs info.
helm-info-reftex
¶Predefined helm for reftex info.
helm-info-remember
¶Predefined helm for remember info.
helm-info-rluserman
¶Predefined helm for rluserman info.
helm-info-sasl
¶Predefined helm for sasl info.
helm-info-sc
¶Predefined helm for sc info.
helm-info-sed
¶Predefined helm for sed info.
helm-info-semantic
¶Predefined helm for semantic info.
helm-info-ses
¶Predefined helm for ses info.
helm-info-sharutils
¶Predefined helm for sharutils info.
helm-info-sieve
¶Predefined helm for sieve info.
helm-info-smtpmail
¶Predefined helm for smtpmail info.
helm-info-spd-say
¶Predefined helm for spd-say info.
helm-info-speech-dispatcher
¶Predefined helm for speech-dispatcher info.
helm-info-speedbar
¶Predefined helm for speedbar info.
helm-info-srecode
¶Predefined helm for srecode info.
helm-info-ssip
¶Predefined helm for ssip info.
helm-info-tds
¶Predefined helm for tds info.
helm-info-texi2html
¶Predefined helm for texi2html info.
helm-info-texinfo
¶Predefined helm for texinfo info.
helm-info-time
¶Predefined helm for time info.
helm-info-tlbuild
¶Predefined helm for tlbuild info.
helm-info-tramp
¶Predefined helm for tramp info.
helm-info-url
¶Predefined helm for url info.
helm-info-vip
¶Predefined helm for vip info.
helm-info-viper
¶Predefined helm for viper info.
helm-info-wdiff
¶Predefined helm for wdiff info.
helm-info-web2c
¶Predefined helm for web2c info.
helm-info-wget
¶Predefined helm for wget info.
helm-info-widget
¶Predefined helm for widget info.
helm-info-wisent
¶Predefined helm for wisent info.
helm-info-woman
¶Predefined helm for woman info.
helm-info-xboard
¶Predefined helm for xboard info.
Previous: Commands in library helm-info
(excludes keymaps), Up: Library: helm-info [Contents][Index]
helm-default-info-index-list
¶Standard Value:
("helm-bugs" "helm-devel" "helm-manual-1" "helm-manual" "helm" "emms" "R-FAQ" "R-admin" "R-data" "R-exts" "R-intro" "R-ints" "R-lang" "auth" "automake-1" "automake-history" "autosprintf" "autotype" "bc" "bovine" "bzip2" "calc" "ccmode" "cl" "com_err" "coreutils" "cvs" "cvsclient" "dbus" "dc" "diffutils" "dired-x" "dvipng" "dvips" "ebrowse" "ed" "ede" "ediff" "edt" "eieio" "eintr" "elisp" "emacs-gnutls" "emacs-mime" "emacs" "epa" "erc" "ert" "eshell" "eudc" "eww" "fastjar" "find-maint" "find" "flex" "flymake" "fontname" "forms" "gettext" "global" "gnupg" "gnus" "gpm" "grep" "grub-dev" "grub" "gzip" "htmlfontify" "idlwave" "ido" "idutils" "info-stnd" "info" "kpathsea" "latex2man" "libffi" "lzip-compressor" "lzip-decompressor" "lzip" "m4" "mairix-el" "message" "mh-e" "nano" "nettle" "newsticker" "nxml-mode" "octave-mode" "org" "pcl-cvs" "pgg" "rcirc" "rcs" "reftex" "remember" "rluserman" "sasl" "sc" "sed" "semantic" "ses" "sharutils" "sieve" "smtpmail" "spd-say" "speech-dispatcher" "speedbar" "srecode" "ssip" "tds" "texi2html" "texinfo" "time" "tlbuild" "todo-mode" "tramp" "url" "vhdl-mode" "vip" "viper" "wdiff" "web2c" "wget" "widget" "wisent" "woman" "xboard")
Info files to search in with helm-info
.
helm-info-default-sources
¶Standard Value:
(helm-source-info-elisp helm-source-info-cl helm-source-info-eieio helm-source-info-pages)
Default sources to use for looking up symbols at point in Info
files with helm-info-at-point
.
Next: Library: helm-locate, Previous: Library: helm-info, Up: Package: helm [Contents][Index]
helm-lib
(excludes keymaps)Next: Options in library ‘helm-lib’, Up: Library: helm-lib [Contents][Index]
helm-lib
(excludes keymaps)helm-undo-yank-text-at-point
¶Undo last entry added by helm-yank-text-at-point
.
helm-yank-text-at-point
¶(helm-yank-text-at-point ARG)
Yank text at point in helm-current-buffer
into minibuffer.
helm--advice-wdired-finish-edit
¶
Next: Hooks in library ‘helm-lib’, Previous: Commands in library helm-lib
(excludes keymaps), Up: Library: helm-lib [Contents][Index]
helm-boring-file-regexp-list
¶Standard Value:
("\\.o$" "~$" "\\.bin$" "\\.lbin$" "\\.so$" "\\.a$" "\\.ln$" "\\.blg$" "\\.bbl$" "\\.elc$" "\\.lof$" "\\.glo$" "\\.idx$" "\\.lot$" "\\.svn\\(/\\|$\\)" "\\.hg\\(/\\|$\\)" "\\.git\\(/\\|$\\)" "\\.bzr\\(/\\|$\\)" "CVS\\(/\\|$\\)" "_darcs\\(/\\|$\\)" "_MTN\\(/\\|$\\)" "\\.fmt$" "\\.tfm$" "\\.class$" "\\.fas$" "\\.lib$" "\\.mem$" "\\.x86f$" "\\.sparcf$" "\\.dfsl$" "\\.pfsl$" "\\.d64fsl$" "\\.p64fsl$" "\\.lx64fsl$" "\\.lx32fsl$" "\\.dx64fsl$" "\\.dx32fsl$" "\\.fx64fsl$" "\\.fx32fsl$" "\\.sx64fsl$" "\\.sx32fsl$" "\\.wx64fsl$" "\\.wx32fsl$" "\\.fasl$" "\\.ufsl$" "\\.fsl$" "\\.dxl$" "\\.lo$" "\\.la$" "\\.gmo$" "\\.mo$" "\\.toc$" "\\.aux$" "\\.cp$" "\\.fn$" "\\.ky$" "\\.pg$" "\\.tp$" "\\.vr$" "\\.cps$" "\\.fns$" "\\.kys$" "\\.pgs$" "\\.tps$" "\\.vrs$" "\\.pyc$" "\\.pyo$")
A list of regexps matching boring files.
This list is build by default on completion-ignored-extensions
.
The directory names should end with “?“ e.g. ”\.git?” and
the file names should end with “”.
These regexps may be used to match the entire path, not just the file name, so for example to ignore files with a prefix “.bak.”, use “\.bak\..*$” as the regexp.
NOTE: When modifying this, be sure to use customize interface or
the customize functions e.g. customize-set-variable
and NOT
setq
.
helm-file-globstar
¶Standard Value: t
Same as globstar bash shopt option. When non-nil a pattern beginning with two stars will expand recursively. Directories expansion is not supported yet.
helm-help-default-prompt
¶Standard Value: [SPC,C-v,next:ScrollUp b,M-v,prior:ScrollDown TAB:Cycle M-TAB:All C-s/r:Isearch q:Quit]
The prompt used in helm-help
.
helm-help-full-frame
¶Standard Value: t
Display help window in full frame when non nil.
Even when nil probably the same result (full frame) can be
reached by tweaking display-buffer-alist
, but it is much more
convenient to use a simple boolean value here.
helm-help-hkmap
¶Standard Value:
(("C-v" . helm-help-scroll-up) ("SPC" . helm-help-scroll-up) ("<next>" . helm-help-scroll-up) ("M-v" . helm-help-scroll-down) ("b" . helm-help-scroll-down) ("<prior>" . helm-help-scroll-down) ("C-s" . isearch-forward) ("C-r" . isearch-backward) ("C-a" . move-beginning-of-line) ("C-e" . move-end-of-line) ("C-f" . forward-char) ("<right>" . forward-char) ("C-b" . backward-char) ("<left>" . backward-char) ("C-n" . helm-help-next-line) ("C-p" . helm-help-previous-line) ("<down>" . helm-help-next-line) ("<up>" . helm-help-previous-line) ("M-a" . backward-sentence) ("M-e" . forward-sentence) ("M-f" . forward-word) ("M-b" . backward-word) ("M->" . end-of-buffer) ("M-<" . beginning-of-buffer) ("C-SPC" . helm-help-toggle-mark) ("C-M-SPC" . mark-sexp) ("TAB" . org-cycle) ("C-m" . helm-help-org-open-at-point) ("C-&" . helm-help-org-mark-ring-goto) ("C-%" . org-mark-ring-push) ("M-TAB" . helm-help-org-cycle) ("M-w" . helm-help-copy-region-as-kill) ("q" . helm-help-quit))
Alist of (KEY . FUNCTION) for helm-help
.
This is not a standard keymap, just an alist where it is possible to
define a simple KEY (a string with no spaces) associated with a
FUNCTION. More complex key like “C-x C-x” are not supported.
Interactive functions will be called interactively whereas other
functions will be called with funcall except commands that are in
helm-help-not-interactive-command
.
For convenience you can add bindings here with helm-help-define-key
.
helm-describe-function-function
¶Standard Value: describe-function
Function used to describe functions in Helm.
helm-describe-variable-function
¶Standard Value: describe-variable
Function used to describe variables in Helm.
helm-yank-text-at-point-function
¶Standard Value: nil
The function used to forward point with helm-yank-text-at-point
.
With a nil value, fallback to default forward-word
.
The function should take one arg, an integer like forward-word
.
NOTE: Using forward-symbol
here is not very useful as it is
already provided by M-n.
helm-advice-push-mark
¶Standard Value: t
Override push-mark
with a version avoiding duplicates when non-nil.
helm-scroll-amount
¶Standard Value: nil
Scroll amount when scrolling other window in a helm session.
It is used by helm-scroll-other-window
and helm-scroll-other-window-down
.
If you prefer scrolling line by line, set this value to 1.
Previous: Options in library ‘helm-lib’, Up: Library: helm-lib [Contents][Index]
helm-help-mode-after-hook
¶Standard Value: nil
A hook that runs when helm-help exits.
helm-help-mode-before-hook
¶Standard Value: nil
A hook that runs before helm-help starts.
Next: Library: helm-man, Previous: Library: helm-lib, Up: Package: helm [Contents][Index]
helm-locate-map
helm-locate
(excludes keymaps)
Next: Commands in library helm-locate
(excludes keymaps), Up: Library: helm-locate [Contents][Index]
helm-locate-map
helm-delete-backward-no-update
) ¶(helm-delete-backward-no-update ARG)
Disable update and delete ARG chars backward. Update is reenabled when idle 1s.
Next: Options in library ‘helm-locate’, Previous: Commands in keymap helm-locate-map
, Up: Library: helm-locate [Contents][Index]
helm-locate
(excludes keymaps)helm-locate
) ¶(helm-locate ARG)
Preconfigured helm
for Locate.
Note: you can add locate options after entering pattern.
See ’man locate’ for valid options and also helm-locate-command
.
You can specify a local database with prefix argument ARG. With two prefix arg, refresh the current local db or create it if it doesn’t exists.
To create a user specific db, use
“updatedb -l 0 -o db_path -U directory”.
Where db_path is a filename matched by
helm-locate-db-file-regexp
.
helm-projects-find-files
¶(helm-projects-find-files UPDATE)
Find files with locate in helm-locate-project-list
.
With a prefix arg refresh the database in each project.
Previous: Commands in library helm-locate
(excludes keymaps), Up: Library: helm-locate [Contents][Index]
helm-locate-fuzzy-match
¶Standard Value: nil
Enable fuzzy matching in helm-locate
.
Note that when this is enabled searching is done on basename.
helm-locate-fuzzy-sort-fn
¶Standard Value: helm-locate-default-fuzzy-sort-fn
Default fuzzy matching sort function for locate.
helm-ff-locate-db-filename
¶Standard Value: locate.db
The basename of the locatedb file you use locally in your directories. When this is set and Helm finds such a file in the directory from where you launch locate, it will use this file and will not prompt you for a db file. Note that this happen only when locate is launched with a prefix arg.
helm-locate-db-file-regexp
¶Standard Value: m?locate.db$
Default regexp to match locate database. If nil Search in all files.
helm-locate-command
¶Standard Value: nil
A list of arguments for locate program.
Helm will calculate a default value for your system on startup
unless helm-locate-command
is non-nil.
Here are the default values it will use according to your system:
Gnu/linux: “locate %s -e -A –regex %s” berkeley-unix: “locate %s %s” windows-nt: “es %s %s” Others: “locate %s %s”
This string will be passed to format so it should end with %s
.
The first format spec is used for the “-i” value of locate/es,
so don’t set it directly but use helm-locate-case-fold-search
for this.
The last option must be the one preceding pattern i.e “-r” or “–regex”.
You will be able to pass other options such as “-b” or “l” during Helm invocation after entering pattern only when multi matching, not when fuzzy matching.
Note that the “-b” option is added automatically by Helm when
var helm-locate-fuzzy-match
is non-nil and switching back from
multimatch to fuzzy matching (this is done automatically when a
space is detected in pattern).
helm-locate-create-db-command
¶Standard Value: updatedb -l 0 -o ’%s’ -U ’%s’
Command used to create a locale locate db file.
helm-locate-recursive-dirs-command
¶Standard Value: locate -i -e -A –regex ’^%s’ ’%s.*$’
Command used for recursive directories completion in helm-find-files
.
For Windows and es
use something like “es -r ^%s.*%s.*$”
The two format specs are mandatory.
If for some reasons you can’t use locate because your filesystem
doesn’t have a database, you can use find command from findutils
but be aware that it will be much slower. See helm-find-files
embedded help for more infos.
helm-locate-case-fold-search
¶Standard Value: smart
It have the same meaning as helm-case-fold-search
.
The -i option of locate will be used depending of value of
helm-pattern
when this is set to ’smart.
When nil “-i” will not be used at all and when non-nil it will
always be used.
NOTE: the -i option of the “es” command used on windows does
the opposite of “locate” command.
helm-locate-project-list
¶Standard Value: nil
A list of directories, your projects.
When set, allow browsing recursively files in all directories of
this list with helm-projects-find-files
.
Next: Library: helm-misc, Previous: Library: helm-locate, Up: Package: helm [Contents][Index]
Next: Options in library ‘helm-man’, Up: Library: helm-man [Contents][Index]
helm-man
(excludes keymaps)helm-man-woman
) ¶(helm-man-woman ARG)
Preconfigured helm
for Man and Woman pages.
With a prefix arg reinitialize the cache.
Previous: Commands in library helm-man
(excludes keymaps), Up: Library: helm-man [Contents][Index]
helm-man-format-switches
¶Standard Value: -l %s
Arguments to pass to the manual-entry
function.
Arguments are passed to manual-entry
with format.
helm-man-or-woman-function
¶Standard Value: Man-getpage-in-background
Default command to display a man page.
Next: Library: helm-mode, Previous: Library: helm-man, Up: Package: helm [Contents][Index]
Next: Options in library ‘helm-misc’, Up: Library: helm-misc [Contents][Index]
helm-misc
(excludes keymaps)helm-ratpoison-commands
¶Preconfigured helm
to execute ratpoison commands.
helm-stumpwm-commands
¶Preconfigured helm for stumpwm commands.
helm-insert-latex-math
¶Preconfigured helm for latex math symbols completion.
helm-world-time
¶Preconfigured helm
to show world time.
Default action change TZ environment variable locally to emacs.
Previous: Commands in library helm-misc
(excludes keymaps), Up: Library: helm-misc [Contents][Index]
helm-minibuffer-history-must-match
¶Standard Value: t
Allow inserting non matching elements when nil or ’confirm.
helm-time-zone-home-location
¶Standard Value: Paris
The time zone of your home.
helm-timezone-actions
¶Standard Value:
(("Set timezone env (TZ)" lambda (candidate) (setenv "TZ" candidate)))
Actions for helm-timezone.
Next: Library: helm-multi-match, Previous: Library: helm-misc, Up: Package: helm [Contents][Index]
helm-mode
helm-comp-read-map
helm-mode
(excludes keymaps)
Next: Commands in keymap helm-comp-read-map
, Up: Library: helm-mode [Contents][Index]
helm-mode
helm-mode
¶(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.
Next: Commands in library helm-mode
(excludes keymaps), Previous: Modes in library helm-mode
, Up: Library: helm-mode [Contents][Index]
helm-comp-read-map
helm-cr-empty-string
) ¶Return empty string.
helm-mode-delete-char-backward-maybe
) ¶Delete char backward when text is not the prefix helm is completing against. First call warns user about deleting prefix completion. Second call deletes backward char in current-buffer and quits helm completion, letting the user start a new completion with a new prefix.
Next: Options in library ‘helm-mode’, Previous: Commands in keymap helm-comp-read-map
, Up: Library: helm-mode [Contents][Index]
helm-mode
(excludes keymaps)helm-mode
¶(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.
Next: Hooks in library ‘helm-mode’, Previous: Commands in library helm-mode
(excludes keymaps), Up: Library: helm-mode [Contents][Index]
helm-comp-read-case-fold-search
¶Standard Value: smart
Default Local setting of helm-case-fold-search
for helm-comp-read
.
See helm-case-fold-search
for more info.
helm-completing-read-handlers-alist
¶Standard Value:
((find-tag . helm-completing-read-default-find-tag) (xref-find-definitions . helm-completing-read-default-find-tag) (xref-find-references . helm-completing-read-default-find-tag) (ggtags-find-tag-dwim . helm-completing-read-default-find-tag) (tmm-menubar) (find-file) (execute-extended-command) (dired-do-rename . helm-read-file-name-handler-1) (dired-do-copy . helm-read-file-name-handler-1) (dired-do-symlink . helm-read-file-name-handler-1) (dired-do-relsymlink . helm-read-file-name-handler-1) (dired-do-hardlink . helm-read-file-name-handler-1) (basic-save-buffer . helm-read-file-name-handler-1) (write-file . helm-read-file-name-handler-1) (write-region . helm-read-file-name-handler-1))
Completing read functions for specific Emacs commands.
By default helm-mode
use helm-completing-read-default-handler
to
provide helm completion in each completing-read
or read-file-name
found, but other functions can be specified here for specific
commands. This also allows disabling helm completion for some commands
when needed.
Each entry is a cons cell like (EMACS_COMMAND . COMPLETING-READ_HANDLER) where key and value are symbols.
Each key is an Emacs command that use originaly completing-read
.
Each value maybe a helm function that takes same arguments as
completing-read
plus NAME and BUFFER, where NAME is the name of the new
helm source and BUFFER the name of the buffer we will use, but it can
be also a function not using helm, in this case the function should
take the same args as completing-read
and not be prefixed by “helm-”.
helm
will use the name of the command calling completing-read
as
NAME and BUFFER will be computed as well with NAME but prefixed with
“*helm-mode-”.
This function prefix name must start by “helm-” when it uses helm,
otherwise helm
assumes the function is not a helm function and
expects the same args as completing-read
, this allows you to define a
handler not using helm completion.
Example:
(defun foo/test () (interactive) (message “%S” (completing-read “test: ” ’(a b c d e))))
(defun helm-foo/test-completing-read-handler (prompt collection predicate require-match initial-input hist def inherit-input-method name buffer) (helm-comp-read prompt collection :marked-candidates t :name name :buffer buffer))
(add-to-list ’helm-completing-read-handlers-alist ’(foo/test . helm-foo/test-completing-read-handler))
We want here to make the regular completing-read
in foo/test
return a list of candidate(s) instead of a single candidate.
Note that this function will be reused for ALL the completing-read
of this command, so it should handle all cases. E.g.,
if first completing-read
completes against symbols and
second completing-read
should handle only buffer,
your specialized function should handle both.
If the value of an entry is nil completion will fall back to Emacs vanilla behaviour. Example:
If you want to disable helm completion for describe-function
, use:
(describe-function . nil)
Ido is also supported, you can use ido-completing-read
and
ido-read-file-name
as value of an entry or just ’ido.
Example:
Enable ido completion for find-file
:
(find-file . ido)
same as
(find-file . ido-read-file-name)
Note that you don’t need to enable ido-mode
for this to work, see
helm-mode
documentation.
helm-mode-fuzzy-match
¶Standard Value: nil
Enable fuzzy matching in helm-mode
globally.
This is deprecated, use instead helm-fuzzy as helm-completion-style
or
even better ’emacs as helm-completion-style
and add ’flex to
completion-styles
(emacs-27) or ’helm-flex if ’flex is not available
in completion-styles-alist
(emacs-26).
helm-mode-hook
¶Standard Value: nil
Hook run after entering or leaving helm-mode
.
No problems result if this variable is not bound.
add-hook
automatically binds it. (This is true for all hook variables.)
helm-mode-reverse-history
¶Standard Value: t
Display history source after current source when non nil.
Apply only in helm-mode
handled commands.
helm-completion-in-region-default-sort-fn
¶Standard Value: helm-completion-in-region-sort-fn
The default sort function to sort candidates in completion-in-region.
When nil no sorting is done.
The function is a filtered-candidate-transformer
function which takes
two args CANDIDATES and SOURCE.
The function must use the flag helm-completion--sorting-done
and
return CANDIDATES unchanged when the flag is nil.
See default function helm-completion-in-region-sort-fn
as example.
It will be used only when helm-completion-style
is either Emacs or
helm, otherwise when helm-fuzzy style is used, the fuzzy sort function
will be used.
helm-completion-mark-suffix
¶Standard Value: t
Push mark at end of suffix when non nil.
helm-completion-style
¶Standard Value: helm
Style of completion to use in completion-in-region
.
This affects only completion-at-point
and friends, and
the completing-read
using the default handler
i.e. helm-completing-read-default-handler
.
NB: This has nothing to do with completion-styles
, it is independent from
helm, but when using ’emacs as helm-completion-style helm
will use the completion-styles
for its completions.
Up to the user to configure completion-styles
.
There are three possible values to use:
completion-styles
. Note that even in this style, helm allows using
multi match. Emacs-27 provides a style called flex
that can be used
aside helm
style (see completion-styles-alist
). When flex
style
is not available (Emacs<27) helm provides helm-flex
style which is similar to
flex
and helm fuzzy matching.
For a better experience, if you don’t know what to use, set
completion-styles
to ’(flex) if you are using emacs-27 or to
’(helm-flex) if you are using emacs-26 and keep ’emacs as default
value for helm-completion-style
. Advanced users can also have a
look to completion-category-overrides
to set styles according to category.
Please use custom interface or customize-set-variable
to set this,
NOT setq
.
helm-completion-styles-alist
¶Standard Value:
((gud-mode . helm))
Allow configuring helm-completion-style
per mode.
Each entry is a cons cell like (mode . style) where style must be a
suitable value for helm-completion-style
.
When specifying emacs as style for a mode, completion-styles
can be
specified by using a cons cell specifying completion-styles to use
with helm emacs style, e.g. (foo-mode . (emacs helm flex)) will set
completion-styles
to ’(helm flex) for foo-mode. This affects only
completions happening in buffers and not minibuffer completions,
i.e. completing-read’s.
helm-mode-handle-completion-in-region
¶Standard Value: t
Whether to replace or not completion-in-region-function
.
This enables support for completing-read-multiple
and completion-at-point
when non–nil.
helm-mode-no-completion-in-region-in-modes
¶Standard Value: nil
A list of modes that do not want helm for completion-in-region
.
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.
Previous: Options in library ‘helm-mode’, Up: Library: helm-mode [Contents][Index]
helm-mode--ido-everywhere-hook
¶Standard Value:
helm-mode-hook
¶Standard Value: nil
Hook run after entering or leaving helm-mode
.
No problems result if this variable is not bound.
add-hook
automatically binds it. (This is true for all hook variables.)
helm-mode-minibuffer-setup-hook-black-list
¶Standard Value:
(minibuffer-completion-help)
Incompatible minibuffer-setup-hook
functions go here.
A list of symbols. helm-mode
is rejecting all lambda’s, byte-code fns
and all functions belonging in this list from minibuffer-setup-hook
.
This is mainly needed to prevent “Completions” buffers to popup.
Next: Library: helm-net, Previous: Library: helm-mode, Up: Package: helm [Contents][Index]
helm-multi-match
helm-multi-match
(excludes keymaps)
Next: Commands in library helm-multi-match
(excludes keymaps), Up: Library: helm-multi-match [Contents][Index]
helm-multi-match
helm-migemo-mode
¶(helm-migemo-mode &optional ARG)
Enable migemo in helm. It will be available in the sources handling it, i.e. the sources which have the slot :migemo with non–nil value.
If called interactively, toggle Helm-Migemo 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.
Next: Options in library ‘helm-multi-match’, Previous: Modes in library helm-multi-match
, Up: Library: helm-multi-match [Contents][Index]
helm-multi-match
(excludes keymaps)helm-migemo-mode
¶(helm-migemo-mode &optional ARG)
Enable migemo in helm. It will be available in the sources handling it, i.e. the sources which have the slot :migemo with non–nil value.
If called interactively, toggle Helm-Migemo 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.
Next: Hooks in library ‘helm-multi-match’, Previous: Commands in library helm-multi-match
(excludes keymaps), Up: Library: helm-multi-match [Contents][Index]
helm-migemo-mode-hook
¶Standard Value: nil
Hook run after entering or leaving helm-migemo-mode
.
No problems result if this variable is not bound.
add-hook
automatically binds it. (This is true for all hook variables.)
helm-migemo-mode
¶Standard Value: nil
(helm-migemo-mode &optional ARG)
Enable migemo in helm. It will be available in the sources handling it, i.e. the sources which have the slot :migemo with non–nil value.
If called interactively, toggle Helm-Migemo 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-mm-matching-method
¶Standard Value: multi3
Matching method for helm match plugin. You can set here different methods to match candidates in helm. Here are the possible value of this symbol and their meaning:
Default is multi3, you should keep this for a better experience.
Note that multi1 and multi3p are incompatible with fuzzy matching in file completion and by the way fuzzy matching will be disabled there when these options are used.
Previous: Options in library ‘helm-multi-match’, Up: Library: helm-multi-match [Contents][Index]
helm-migemo-mode-hook
¶Standard Value: nil
Hook run after entering or leaving helm-migemo-mode
.
No problems result if this variable is not bound.
add-hook
automatically binds it. (This is true for all hook variables.)
Next: Library: helm-occur, Previous: Library: helm-multi-match, Up: Package: helm [Contents][Index]
Next: Options in library ‘helm-net’, Up: Library: helm-net [Contents][Index]
helm-net
(excludes keymaps)helm-browse-url-chromium
¶(helm-browse-url-chromium URL &optional IGNORE)
Browse URL with Google Chrome browser.
helm-browse-url-conkeror
¶(helm-browse-url-conkeror URL &optional IGNORE)
Browse URL with conkeror browser.
helm-browse-url-firefox
¶(helm-browse-url-firefox URL &optional IGNORE)
Same as browse-url-firefox
but detach from Emacs.
So when you quit Emacs you can keep your Firefox session open and not be prompted to kill the Firefox process.
NOTE: Probably not supported on some systems (e.g., Windows).
helm-browse-url-next
¶(helm-browse-url-next URL &optional IGNORE)
Browse URL with next browser.
helm-browse-url-opera
¶(helm-browse-url-opera URL &optional IGNORE)
Browse URL with Opera browser and detach from Emacs.
So when you quit Emacs you can keep your Opera session open and not be prompted to kill the Opera process.
NOTE: Probably not supported on some systems (e.g., Windows).
helm-browse-url-uzbl
¶(helm-browse-url-uzbl URL &optional IGNORE)
Browse URL with uzbl browser.
helm-google-suggest
) ¶Preconfigured helm
for Google search with Google suggest.
helm-surfraw
) ¶(helm-surfraw PATTERN ENGINE)
Preconfigured helm
to search PATTERN with search ENGINE.
Previous: Commands in library helm-net
(excludes keymaps), Up: Library: helm-net [Contents][Index]
helm-surfraw-default-browser-function
¶Standard Value: nil
The browse url function you prefer to use with surfraw.
When nil, fallback to browse-url-browser-function
.
helm-net-curl-switches
¶Standard Value:
("-s" "-L")
Arguments list passed to curl when using helm-net-prefer-curl
.
helm-net-prefer-curl
¶Standard Value: nil
When non–nil use CURL external program to fetch data.
Otherwise url-retrieve-synchronously
is used.
helm-browse-url-firefox-new-window
¶Standard Value: -new-tab
Allow choosing to browse url in new window or new tab. Can be “-new-tab” (default) or “-new-window”.
helm-home-url
¶Standard Value: https://www.google.com
Default url to use as home url.
helm-surfraw-duckduckgo-url
¶Standard Value: https://duckduckgo.com/lite/?q=%s&kp=1
The Duckduckgo url.
This is a format string, don’t forget the %s
.
If you have personal settings saved on duckduckgo you should have
a personal url, see your settings on duckduckgo.
helm-search-suggest-action-imdb-url
¶Standard Value: http://www.imdb.com/find?s=all&q=%s
The IMDb search url.
This is a format string, don’t forget the %s
.
helm-search-suggest-action-wikipedia-url
¶Standard Value: https://en.wikipedia.org/wiki/Special:Search?search=%s
The Wikipedia search url.
This is a format string, don’t forget the %s
.
helm-search-suggest-action-youtube-url
¶Standard Value: https://www.youtube.com/results?aq=f&search_query=%s
The Youtube search url.
This is a format string, don’t forget the %s
.
helm-google-suggest-search-url
¶Standard Value: https://encrypted.google.com/search?ie=utf-8&oe=utf-8&q=%s
URL used for Google searching.
This is a format string, don’t forget the %s
.
helm-google-suggest-url
¶Standard Value: https://encrypted.google.com/complete/search?output=toolbar&q=%s
URL used for looking up Google suggestions.
This is a format string, don’t forget the %s
.
helm-search-suggest-action-google-maps-url
¶Standard Value: https://maps.google.com/maps?f=q&source=s_q&q=%s
The Google Maps search url.
This is a format string, don’t forget the %s
.
helm-search-suggest-action-google-news-url
¶Standard Value: https://www.google.com/search?safe=off&prmd=nvlifd&source=lnms&tbs=nws:1&q=%s
The Google News search url.
This is a format string, don’t forget the %s
.
helm-google-suggest-actions
¶Standard Value:
(("Google Search" . helm-google-suggest-action) ("Wikipedia" lambda (candidate) (helm-search-suggest-perform-additional-action helm-search-suggest-action-wikipedia-url candidate)) ("Youtube" lambda (candidate) (helm-search-suggest-perform-additional-action helm-search-suggest-action-youtube-url candidate)) ("IMDb" lambda (candidate) (helm-search-suggest-perform-additional-action helm-search-suggest-action-imdb-url candidate)) ("Google Maps" lambda (candidate) (helm-search-suggest-perform-additional-action helm-search-suggest-action-google-maps-url candidate)) ("Google News" lambda (candidate) (helm-search-suggest-perform-additional-action helm-search-suggest-action-google-news-url candidate)))
List of actions for google suggest sources.
helm-google-suggest-default-browser-function
¶Standard Value: nil
The browse url function you prefer to use with Google suggest.
When nil, use the first browser function available
See helm-browse-url-default-browser-alist
.
helm-google-suggest-use-curl-p
¶Standard Value: nil
When non–nil use CURL external program to fetch data.
Otherwise url-retrieve-synchronously
is used.
Next: Library: helm-regexp, Previous: Library: helm-net, Up: Package: helm [Contents][Index]
helm-occur
helm-occur-map
helm-occur-mode-map
helm-occur
(excludes keymaps)
Next: Commands in keymap helm-occur-map
, Up: Library: helm-occur [Contents][Index]
helm-occur
helm-occur-mode
¶Major mode to provide actions in helm moccur saved buffer.
Special commands: \{helm-occur-mode-map}
In addition to any hooks its parent mode special-mode
might have
run, this mode runs the hook helm-occur-mode-hook
, as the final or
penultimate step during initialization.
Next: Commands in keymap helm-occur-mode-map
, Previous: Modes in library helm-occur
, Up: Library: helm-occur [Contents][Index]
helm-occur-map
helm-occur-run-goto-line-of
) ¶Run goto line new frame action from helm-occur
.
helm-occur-run-goto-line-ow
) ¶Run goto line other window action from helm-occur
.
helm-occur-run-save-buffer
) ¶Run moccur save results action from helm-moccur
.
Next: Commands in library helm-occur
(excludes keymaps), Previous: Commands in keymap helm-occur-map
, Up: Library: helm-occur [Contents][Index]
helm-occur-mode-map
helm-occur-mode-goto-line
) ¶helm-occur-mode-goto-line-ow
) ¶helm-occur-mode-goto-line-ow-backward
) ¶(helm-occur-mode-goto-line-ow-backward ARG)
helm-occur-mode-goto-line-ow-forward
) ¶(helm-occur-mode-goto-line-ow-forward ARG)
helm-occur-mode-resume-session
) ¶
Next: Options in library ‘helm-occur’, Previous: Commands in keymap helm-occur-mode-map
, Up: Library: helm-occur [Contents][Index]
helm-occur
(excludes keymaps)helm-occur-mode-mouse-goto-line
¶(helm-occur-mode-mouse-goto-line EVENT)
helm-multi-occur-from-isearch
¶Invoke helm-multi-occur
from isearch.
With a prefix arg, reverse the behavior of
helm-moccur-always-search-in-current
.
The prefix arg can be set before calling
helm-multi-occur-from-isearch
or during the buffer selection.
To use this bind it to a key in isearch-mode-map
.
helm-occur-from-isearch
¶Invoke helm-occur
from isearch.
To use this bind it to a key in isearch-mode-map
.
helm-occur-mode
¶Major mode to provide actions in helm moccur saved buffer.
Special commands: \{helm-occur-mode-map}
In addition to any hooks its parent mode special-mode
might have
run, this mode runs the hook helm-occur-mode-hook
, as the final or
penultimate step during initialization.
helm-occur
) ¶Preconfigured helm for searching lines matching pattern in current-buffer
.
When helm-source-occur
is member of
helm-sources-using-default-as-input
which is the default,
symbol at point is searched at startup.
When a region is marked search only in this region by narrowing.
To search in multiples buffers start from one of the commands listing
buffers (i.e. a helm command using helm-source-buffers-list
like
helm-mini
) and use the multi occur buffers action.
This is the helm implementation that collect lines matching pattern
like vanilla Emacs occur
but have nothing to do with it, the search
engine beeing completely different and also much faster.
helm-occur-right
¶helm-occur
action for right arrow.
This is used when helm-occur-use-ioccur-style-keys
is enabled.
If follow is enabled (default) go to next source, otherwise execute
persistent action.
helm-occur-run-default-action
¶helm-occur-visible-buffers
¶Run helm-occur on all visible buffers in frame.
Next: Hooks in library ‘helm-occur’, Previous: Commands in library helm-occur
(excludes keymaps), Up: Library: helm-occur [Contents][Index]
helm-occur-actions
¶Standard Value:
(("Go to Line" . helm-occur-goto-line) ("Goto line other window (C-u vertically)" . helm-occur-goto-line-ow) ("Goto line new frame" . helm-occur-goto-line-of) ("Save buffer" . helm-occur-save-results))
Actions for helm-occur.
helm-occur-always-search-in-current
¶Standard Value: nil
Helm multi occur always search in current buffer when non–nil.
helm-occur-auto-update-on-resume
¶Standard Value: nil
Allow auto updating helm-occur buffer when outdated. noask => Always update without asking nil => Don’t update but signal buffer needs update never => Never update and do not signal buffer needs update Any other non–nil value update after confirmation.
helm-occur-buffer-substring-fn-for-modes
¶Standard Value:
((mu4e-headers-mode . buffer-substring))
Function to use to display buffer contents for major-mode.
Can be one of buffer-substring
or buffer-substring-no-properties
.
Note that when using buffer-substring
initialization will be slower.
helm-occur-candidate-number-limit
¶Standard Value: 99999
Value of helm-candidate-number-limit
for helm-occur.
helm-occur-keep-closest-position
¶Standard Value: t
When non nil select closest candidate from point after update.
This happen only in helm-source-occur
which is always related to current-buffer
.
helm-occur-truncate-lines
¶Standard Value: t
Truncate lines in occur buffer when non nil.
helm-occur-use-ioccur-style-keys
¶Standard Value: nil
Similar to helm-grep-use-ioccur-style-keys
but for multi occur.
Note that if you define this variable with setq
your change will
have no effect, use customize instead.
Previous: Options in library ‘helm-occur’, Up: Library: helm-occur [Contents][Index]
helm-occur-mode-hook
¶Standard Value: nil
Hook run after entering helm-moccur mode.
No problems result if this variable is not bound.
add-hook
automatically binds it. (This is true for all hook variables.)
Next: Library: helm-ring, Previous: Library: helm-occur, Up: Package: helm [Contents][Index]
Up: Library: helm-regexp [Contents][Index]
helm-regexp
(excludes keymaps)helm-regexp
) ¶Preconfigured helm to build regexps.
query-replace-regexp
can be run from there against found regexp.
Next: Library: helm-semantic, Previous: Library: helm-regexp, Up: Package: helm [Contents][Index]
helm-kill-ring-map
helm-ring
(excludes keymaps)helm-kill-ring-map
helm-kill-ring-delete
) ¶Delete marked candidates from kill-ring
.
This is a command for helm-kill-ring-map
.
helm-kill-ring-kill-selection
) ¶Store the real value of candidate in kill-ring.
Same as helm-kill-selection-and-quit
called with a prefix arg.
helm-kill-ring-run-persistent-delete
) ¶Delete current candidate without quitting.
helm-kill-ring-run-search-from-string
) ¶helm-kill-ring-toggle-truncated
) ¶Toggle truncated view of candidates in helm kill-ring browser.
Next: Options in library ‘helm-ring’, Previous: Commands in keymap helm-kill-ring-map
, Up: Library: helm-ring [Contents][Index]
helm-ring
(excludes keymaps)helm-show-kill-ring
) ¶Preconfigured helm
for kill-ring
.
It is drop-in replacement of yank-pop
.
First call open the kill-ring browser, next calls move to next line.
helm-all-mark-rings
) ¶Preconfigured helm
for helm-source-global-mark-ring
and helm-source-mark-ring
.
helm-global-mark-ring
¶Preconfigured helm
for helm-source-global-mark-ring
.
helm-mark-ring
¶Preconfigured helm
for helm-source-mark-ring
.
helm-execute-kmacro
¶Preconfigured helm for keyboard macros.
Define your macros with f3
and f4
.
See (info “(emacs) Keyboard Macros”) for detailed infos.
This command is useful when used with persistent action.
helm-register
) ¶Preconfigured helm
for Emacs registers.
Previous: Commands in library helm-ring
(excludes keymaps), Up: Library: helm-ring [Contents][Index]
helm-register-max-offset
¶Standard Value: 160
Max size of string register entries before truncating.
helm-kill-ring-actions
¶Standard Value:
(("Yank marked" . helm-kill-ring-action-yank) ("Delete marked" . helm-kill-ring-action-delete) ("Search from candidate" . helm-kill-ring-search-from-string))
List of actions for kill ring source.
helm-kill-ring-max-offset
¶Standard Value: 400
Max number of chars displayed per candidate in kill-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 separators between candidates any more.
helm-kill-ring-separator
¶Standard Value:
The separator used to separate marked candidates when yanking.
helm-kill-ring-threshold
¶Standard Value: 3
Minimum length of a candidate to be listed by helm-source-kill-ring
.
Next: Library: helm-shell, Previous: Library: helm-ring, Up: Package: helm [Contents][Index]
helm-semantic
(excludes keymaps)helm-semantic
¶(helm-semantic ARG)
Preconfigured helm
for semantic
.
If ARG is supplied, pre-select symbol at point instead of current.
(helm-semantic-or-imenu ARG)
Preconfigured helm for semantic
or imenu
.
If ARG is supplied, pre-select symbol at point instead of current
semantic tag in scope.
If semantic-mode
is active in the current buffer, then use
semantic for generating tags, otherwise fall back to imenu
.
Fill in the symbol at point by default.
Previous: Commands in library helm-semantic
(excludes keymaps), Up: Library: helm-semantic [Contents][Index]
helm-semantic-display-style
¶Standard Value:
((python-mode . semantic-format-tag-summarize) (c-mode . semantic-format-tag-concise-prototype-c-mode) (emacs-lisp-mode . semantic-format-tag-abbreviate-emacs-lisp-mode))
Function to present a semantic tag according to major-mode
.
It is an alist where the car
of each element is a major-mode
and
the cdr
a semantic-format-tag-*
function.
If no function is found for current major-mode
, fall back to
semantic-format-tag-summarize
default function.
You can have more or less informations depending of the semantic-format-tag-*
function you choose.
All the supported functions are prefixed with “semantic-format-tag-”,
you have completion on these functions with C-M i
in the customize interface.
helm-semantic-lynx-style-map
¶Standard Value: nil
Use Arrow keys to jump to occurences.
helm-semantic-fuzzy-match
¶Standard Value: nil
Enable fuzzy matching in helm-source-semantic
.
Next: Library: helm-source, Previous: Library: helm-semantic, Up: Package: helm [Contents][Index]
Up: Library: helm-shell [Contents][Index]
helm-shell
(excludes keymaps)helm-shell-prompts
¶Pre-configured helm
to browse the prompts of the current comint buffer.
helm-shell-prompts-all
¶Pre-configured helm
to browse the prompts of all comint sessions.
Next: Library: helm-sys, Previous: Library: helm-shell, Up: Package: helm [Contents][Index]
Next: Library: helm-tags, Previous: Library: helm-source, Up: Package: helm [Contents][Index]
helm-sys
helm-top-map
helm-sys
(excludes keymaps)
Next: Commands in keymap helm-top-map
, Up: Library: helm-sys [Contents][Index]
helm-sys
helm-top-poll-mode
¶(helm-top-poll-mode &optional ARG)
Refresh automatically helm top buffer once enabled.
If called interactively, toggle Helm-Top-Poll 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.
Next: Commands in library helm-sys
(excludes keymaps), Previous: Modes in library helm-sys
, Up: Library: helm-sys [Contents][Index]
helm-top-map
helm-top-run-sort-by-com
) ¶helm-top-run-sort-by-cpu
) ¶helm-top-run-sort-by-mem
) ¶helm-top-run-sort-by-user
) ¶
Next: Options in library ‘helm-sys’, Previous: Commands in keymap helm-top-map
, Up: Library: helm-sys [Contents][Index]
helm-sys
(excludes keymaps)helm-top-poll-mode
¶(helm-top-poll-mode &optional ARG)
Refresh automatically helm top buffer once enabled.
If called interactively, toggle Helm-Top-Poll 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-list-emacs-process
) ¶Preconfigured helm
for Emacs process.
helm-top
) ¶Preconfigured helm
for top command.
helm-xrandr-set
¶Preconfigured helm for xrandr.
Next: Hooks in library ‘helm-sys’, Previous: Commands in library helm-sys
(excludes keymaps), Up: Library: helm-sys [Contents][Index]
helm-top-command
¶Standard Value: env COLUMNS=%s top -b -n 1
Top command used to display output of top.
A format string where %s will be replaced with frame-width
.
To use ’top’ command, a version supporting batch mode (-b option) is needed. On Mac OSX ’top’ command doesn’t support this, so the ’ps’ command is used instead by default.
Normally ’top’ command output have 12 columns, but in some
versions you may have less than this, so you can either customize
top to use 12 columns with the interactives ’f’ and ’W’ commands
of top, or modify helm-top-sort-columns-alist
to fit with the
number of columns your ’top’ command is using.
If you modify ’ps’ command be sure that ’pid’ comes in first and
“env COLUMNS=%s” is specified at beginning of command. Ensure
also that no elements contain spaces (e.g., use start_time and
not start). Same as for ’top’: you can customize
helm-top-sort-columns-alist
to make sort commands working
properly according to your settings.
helm-top-poll-delay
¶Standard Value: 1.5
Helm top poll after this delay when helm-top-poll-mode
is enabled.
The minimal delay allowed is 1.5, if less than this helm-top will use 1.5.
helm-top-poll-delay-post-command
¶Standard Value: 1.0
Helm top stop polling during this delay.
This delay is added to helm-top-poll-delay
after Emacs stops
being idle.
helm-top-poll-mode-hook
¶Standard Value: nil
Hook run after entering or leaving helm-top-poll-mode
.
No problems result if this variable is not bound.
add-hook
automatically binds it. (This is true for all hook variables.)
helm-top-poll-preselection
¶Standard Value: linum
Stay on same line or follow candidate when helm-top-poll
updates display.
Possible values are ’candidate or ’linum.
This affects also sorting functions in the same way.
helm-top-poll-mode
¶Standard Value: nil
(helm-top-poll-mode &optional ARG)
Refresh automatically helm top buffer once enabled.
If called interactively, toggle Helm-Top-Poll 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-top-sort-columns-alist
¶Standard Value:
((com . 11) (mem . 9) (cpu . 8) (user . 1))
Allow defining which column to use when sorting output of top/ps command. Only com, mem, cpu and user are sorted, so no need to put something else there, it will have no effect. Note that column numbers are counted from zero, i.e. column 1 is the nth 0 column.
Previous: Options in library ‘helm-sys’, Up: Library: helm-sys [Contents][Index]
helm-top-initialize-poll-hooks
¶Standard Value:
helm-top-poll-mode-hook
¶Standard Value: nil
Hook run after entering or leaving helm-top-poll-mode
.
No problems result if this variable is not bound.
add-hook
automatically binds it. (This is true for all hook variables.)
helm-top-after-init-hook
¶Standard Value: nil
Local hook for helm-top.
Next: Library: helm-types, Previous: Library: helm-sys, Up: Package: helm [Contents][Index]
helm-etags-map
helm-tags
(excludes keymaps)helm-etags-map
Run switch to other frame action from helm-source-etags-select
.
Run switch to other window action from helm-source-etags-select
.
Go to previous file in Helm grep/etags buffers.
Go to previous file in Helm grep/etags buffers.
Next: Options in library ‘helm-tags’, Previous: Commands in keymap helm-etags-map
, Up: Library: helm-tags [Contents][Index]
helm-tags
(excludes keymaps)(helm-etags-select REINIT)
Preconfigured helm for etags. If called with a prefix argument REINIT or if any of the tag files have been modified, reinitialize cache.
This function aggregates three sources of tag files:
helm-etags-get-tag-file
.
tags-file-name
, which is commonly set by find-tag
command.
tags-table-list
which is commonly set by visit-tags-table
command.
Previous: Commands in library helm-tags
(excludes keymaps), Up: Library: helm-tags [Contents][Index]
Standard Value: TAGS
Etags tag file name.
Standard Value: 10
The limit level of directory to search tag file. Don’t search tag file deeply if outside this value.
Standard Value: nil
Use fuzzy matching in helm-etags-select
.
Standard Value: tag
Allow choosing the tag part of CANDIDATE in helm-source-etags-select
.
A tag looks like this:
filename: (defun foo
You can choose matching against the tag part (i.e “(defun foo”),
or against the whole candidate (i.e “(filename:5:(defun foo”).
Standard Value: t
Whether to jump straight to the selected tag if there’s only one match.
Next: Library: helm-utils, Previous: Library: helm-tags, Up: Package: helm [Contents][Index]
Next: Options in library ‘helm-types’, Up: Library: helm-types [Contents][Index]
helm-generic-files-map
helm-ff-run-mail-attach-files
) ¶Run mail attach files command action from helm-source-find-files
.
helm-ff-run-marked-files-in-dired
) ¶Execute helm-marked-files-in-dired
interactively.
helm-ff-run-switch-other-frame
) ¶Run switch to other frame action from helm-source-find-files
.
helm-ff-run-switch-other-window
) ¶Run switch to other window action from helm-source-find-files
.
When a prefix arg is provided, split is done vertically.
helm-ff-run-open-file-externally
) ¶Run open file externally command action from helm-source-find-files
.
helm-ff-run-open-file-with-default-tool
) ¶Run open file externally command action from helm-source-find-files
.
helm-ff-run-ediff-file
) ¶Run Ediff file action from helm-source-find-files
.
helm-ff-run-ediff-merge-file
) ¶Run Ediff merge file action from helm-source-find-files
.
helm-ff-run-byte-compile-file
) ¶Run Byte compile file action from helm-source-find-files
.
helm-ff-run-copy-file
) ¶Run Copy file action from helm-source-find-files
.
helm-ff-run-delete-file
) ¶Run Delete file action from helm-source-find-files
.
helm-ff-run-find-file-as-root
) ¶helm-ff-run-hardlink-file
) ¶Run Hardlink file action from helm-source-find-files
.
helm-ff-run-load-file
) ¶Run Load file action from helm-source-find-files
.
helm-ff-run-rename-file
) ¶Run Rename file action from helm-source-find-files
.
helm-ff-run-symlink-file
) ¶Run Symlink file action from helm-source-find-files
.
helm-ff-run-grep
) ¶Run Grep action from helm-source-find-files
.
helm-ff-run-insert-org-link
) ¶helm-ff-run-pdfgrep
) ¶Run Pdfgrep action from helm-source-find-files
.
helm-ff-run-toggle-basename
) ¶helm-ff-run-zgrep
) ¶Run Grep action from helm-source-find-files
.
helm-ff-properties-persistent
) ¶Show properties without quitting helm.
Previous: Commands in keymap helm-generic-files-map
, Up: Library: helm-types [Contents][Index]
helm-type-bookmark-actions
¶Standard Value:
(("Jump to bookmark" . helm-bookmark-jump) ("Jump to BM other window" . helm-bookmark-jump-other-window) ("Jump to BM other frame" . helm-bookmark-jump-other-frame) ("Bookmark edit annotation" . bookmark-edit-annotation) ("Bookmark show annotation" . bookmark-show-annotation) ("Delete bookmark(s)" . helm-delete-marked-bookmarks) ("Edit Bookmark" . helm-bookmark-edit-bookmark) ("Rename bookmark" . helm-bookmark-rename) ("Relocate bookmark" . bookmark-relocate))
Default actions for type bookmarks.
helm-type-buffer-actions
¶Standard Value:
(("Switch to buffer(s)" . helm-buffer-switch-buffers) ("Switch to buffer(s) other window ~C-c o~" . helm-buffer-switch-buffers-other-window) ("Switch to buffer other frame ~C-c C-o~" . switch-to-buffer-other-frame) ("Switch to buffer other tab ~C-c C-t~" . helm-buffers-switch-to-buffer-other-tab) ("Switch to buffer at line number" . helm-switch-to-buffer-at-linum) ("Browse project ~C-x C-d~" . helm-buffers-browse-project) ("Query replace regexp ~C-M-%~" . helm-buffer-query-replace-regexp) ("Query replace ~M-%~" . helm-buffer-query-replace) ("View buffer" . view-buffer) ("Display buffer" . display-buffer) ("Rename buffer ~M-R~" . helm-buffers-rename-buffer) ("Grep buffer(s) ~M-g s~ (C-u grep all buffers)" . helm-zgrep-buffers) ("Multi occur buffer(s) ~C-s (C-u search also in current)~" . helm-multi-occur-as-action) ("Revert buffer(s) ~M-G~" . helm-revert-marked-buffers) ("Insert buffer" . insert-buffer) ("Kill buffer(s) ~M-D~" . helm-kill-marked-buffers) ("Diff with file ~C-=~" . diff-buffer-with-file) ("Ediff Marked buffers ~C-c =~" . helm-ediff-marked-buffers) ("Ediff Merge marked buffers ~M-=~" . #[257 "\300\301\"\207" [helm-ediff-marked-buffers t] 4 "\n\n(fn CANDIDATE)"]))
Default actions for type buffers.
helm-type-command-actions
¶Standard Value:
(("Execute command" . helm-M-x-execute-command) ("Describe function" . helm-describe-function) ("Find function" . xref-find-definitions) ("Info lookup" . helm-info-lookup-symbol) ("Debug on entry" . debug-on-entry) ("Cancel debug on entry" . cancel-debug-on-entry) ("Trace function" . trace-function) ("Trace function (background)" . trace-function-background) ("Untrace function" . untrace-function))
Default actions for type command.
helm-type-file-actions
¶Standard Value:
(("Find file" . helm-find-file-or-marked) ("Find file as root" . helm-find-file-as-root) ("Find file other window" . helm-find-files-other-window) ("Find file other frame" . find-file-other-frame) ("Open dired in file's directory" . helm-open-dired) ("Attach file(s) to mail buffer ~C-c C-a~" . helm-ff-mail-attach-files) ("Marked files in dired" . helm-marked-files-in-dired) ("Grep File(s) ~C-u recurse~" . helm-find-files-grep) ("Zgrep File(s) ~C-u Recurse~" . helm-ff-zgrep) ("Pdfgrep File(s)" . helm-ff-pdfgrep) ("Insert as org link" . helm-files-insert-as-org-link) ("Checksum File" . helm-ff-checksum) ("Ediff File" . helm-find-files-ediff-files) ("Ediff Merge File" . helm-find-files-ediff-merge-files) ("View file" . view-file) ("Insert file" . insert-file) ("Add marked files to file-cache" . helm-ff-cache-add-file) ("Delete file(s)" . helm-ff-delete-files) ("Copy file(s) ~M-C, C-u to follow~" . helm-find-files-copy) ("Rename file(s) ~M-R, C-u to follow~" . helm-find-files-rename) ("Symlink files(s) ~M-S, C-u to follow~" . helm-find-files-symlink) ("Relsymlink file(s) ~C-u to follow~" . helm-find-files-relsymlink) ("Hardlink file(s) ~M-H, C-u to follow~" . helm-find-files-hardlink) ("Open file externally (C-u to choose)" . helm-open-file-externally) ("Open file with default tool" . helm-open-file-with-default-tool) ("Find file in hex dump" . hexl-find-file))
Default actions for type files.
helm-type-function-actions
¶Standard Value:
(("Describe function" . helm-describe-function) ("Find function" . xref-find-definitions) ("Info lookup" . helm-info-lookup-symbol) ("Debug on entry" . debug-on-entry) ("Cancel debug on entry" . cancel-debug-on-entry) ("Trace function" . trace-function) ("Trace function (background)" . trace-function-background) ("Untrace function" . untrace-function))
Default actions for type functions.
helm-type-timers-actions
¶Standard Value:
(("Cancel Timer" lambda (_timer) (let ((mkd (helm-marked-candidates))) (cl-loop for timer in mkd do (cancel-timer timer)))) ("Describe Function" lambda (tm) (describe-function (timer--function tm))) ("Find Function" lambda (tm) (helm-aif (timer--function tm) (if (or (byte-code-function-p it) (helm-subr-native-elisp-p it)) (message "Can't find anonymous function ~%s~" it) (find-function it)))))
Default actions for type timers.
Next: Library: helm-x-files, Previous: Library: helm-types, Up: Package: helm [Contents][Index]
helm-utils
helm-utils
(excludes keymaps)helm-utils
helm-popup-tip-mode
¶(helm-popup-tip-mode &optional ARG)
Show help-echo informations in a popup tip at end of line.
If called interactively, toggle Helm-Popup-Tip 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.
Next: Options in library ‘helm-utils’, Previous: Modes in library helm-utils
, Up: Library: helm-utils [Contents][Index]
helm-utils
(excludes keymaps)helm-display-all-sources
¶Display all sources previously hidden by helm-set-source-filter
.
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.
helm-popup-tip-mode
¶(helm-popup-tip-mode &optional ARG)
Show help-echo informations in a popup tip at end of line.
If called interactively, toggle Helm-Popup-Tip 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-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.
Next: Hooks in library ‘helm-utils’, Previous: Commands in library helm-utils
(excludes keymaps), Up: Library: helm-utils [Contents][Index]
helm-window-prefer-horizontal-split
¶Standard Value: nil
Maybe switch to other window vertically when non nil.
Possible values are t, nil and decide
.
When t switch vertically.
When nil switch horizontally.
When decide
try to guess if it is possible to switch vertically
according to the setting of split-width-threshold
and the size of
the window from where splitting is done.
Note that when using decide
and split-width-threshold
is nil, the
behavior is the same as with a nil value.
helm-resize-on-pa-text-height
¶Standard Value: 12
The size of the helm-window when resizing on persistent action.
helm-buffers-to-resize-on-pa
¶Standard Value: nil
A list of helm buffers where the helm-window should be reduced on persistent actions.
helm-html-decode-entities-function
¶Standard Value: helm-html-decode-entities-string
Function used to decode HTML entities in HTML bookmarks.
Helm comes by default with helm-html-decode-entities-string
, if you need something
more sophisticated you can use w3m-decode-entities-string
if available.
In Emacs itself org-entities seem broken and xml-substitute-numeric-entities
supports only numeric entities.
helm-window-show-buffers-function
¶Standard Value: helm-window-default-split-fn
The default function to use when opening several buffers at once. It is typically used to rearrange windows.
helm-highlight-matches-around-point-max-lines
¶Standard Value:
(15 . 15)
Number of lines around point where matched items are highlighted.
Possible value are:
helm-highlight-number-lines-around-point
¶Standard Value:
(15 . 15)
Number of lines around point where matched items are highlighted.
Possible value are:
helm-popup-tip-mode-hook
¶Standard Value: nil
Hook run after entering or leaving helm-popup-tip-mode
.
No problems result if this variable is not bound.
add-hook
automatically binds it. (This is true for all hook variables.)
helm-sources-using-help-echo-popup
¶Standard Value:
("Ack-Grep" "AG" "RG" "Gid" "Git-Grep")
Show the buffer name or the filename in a popup at selection.
helm-popup-tip-mode
¶Standard Value: nil
(helm-popup-tip-mode &optional ARG)
Show help-echo informations in a popup tip at end of line.
If called interactively, toggle Helm-Popup-Tip 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-default-kbsize
¶Standard Value: 1024.0
Default Kbsize to use for showing files size. It is a float, usually 1024.0 but could be 1000.0 on some systems.
helm-su-or-sudo
¶Standard Value: sudo
What command to use for root access.
Previous: Options in library ‘helm-utils’, Up: Library: helm-utils [Contents][Index]
helm-find-many-files-after-hook
¶Standard Value: nil
Hook that runs at end of helm-find-many-files
.
helm-goto-line-before-hook
¶Standard Value:
(helm-save-current-pos-to-mark-ring)
Run before jumping to line.
This hook runs when jumping from helm-goto-line
, helm-etags-default-action
,
and helm-imenu-default-action
.
This allows you to retrieve a previous position after using the different helm
tools for searching (etags, grep, gid, (m)occur etc…).
By default positions are added to mark-ring
.
You can also add to register by using (or adding)
helm-save-pos-to-register-before-jump
instead. In this case
last position is added to the register helm-save-pos-before-jump-register
.
helm-persistent-autoresize-hook
¶Standard Value:
helm-popup-tip-mode-hook
¶Standard Value: nil
Hook run after entering or leaving helm-popup-tip-mode
.
No problems result if this variable is not bound.
add-hook
automatically binds it. (This is true for all hook variables.)
Previous: Library: helm-utils, Up: Package: helm [Contents][Index]
Up: Library: helm-x-files [Contents][Index]
helm-session-fuzzy-match
¶Standard Value: nil
Enable fuzzy matching in helm-source-session
when non–nil.
Next: Key Index, Previous: Package: helm, Up: The Helm Manual [Contents][Index]
Jump to: | E |
---|
Index Entry | Section | ||
---|---|---|---|
| |||
E | |||
emacs-helm.sh: | Minimal setup using source | ||
emacs-helm.sh: | Quick Try with ‘emacs-helmsh’ | ||
|
Jump to: | E |
---|
Next: Command and Function Index, Previous: Main Index, Up: The Helm Manual [Contents][Index]
Jump to: |
/
8
<
A B C D E F H I L M P R S T |
---|
Jump to: |
/
8
<
A B C D E F H I L M P R S T |
---|
Next: Variable Index, Previous: Key Index, Up: The Helm Manual [Contents][Index]
Jump to: | B F H L N P U |
---|
Jump to: | B F H L N P U |
---|
Previous: Command and Function Index, Up: The Helm Manual [Contents][Index]
This is not a complete index of variables and faces, only the ones that are mentioned in the manual. For a more complete list, use M-x org-customize and then click yourself through the tree.
Jump to: | H W |
---|
Jump to: | H W |
---|
https://github.com/raxod502/straight.el
https://github.com/emacs-helm/helm/releases
Don’t forget the final ‘:’ to use an absolute path (like ‘/home/you/foo/bar:’) instead of an abbreviated path like (‘~/foo/bar:’), specify ‘EMACSLOADPATH’.
Above steps assume that you have installed ‘emacs-async’ is in a standard location. If this is not the case, you need to tell ‘make’ program where it is available using ‘EMACSLOADPATH’7.
git clone https://github.com/emacs-helm/helm cd helm EMACSLOADPATH="/path/to/emacs-async:" make make sudo make install
If you want to install ‘helm’ in a path other than ‘/usr/local/’, pass that target path through a ‘PREFIX’ variable.
Helm uses async package to compile itself from Melpa. Ensure
that async-bytecomp-package-mode
is enabled by default. If this
isn’t so, add helm to async-bytecomp-allowed-packages
.
Different way of invoking commands
Behavior may change depending context in some source e.g. helm-find-files
.
Delete from point to end or all depending on the value of
helm-delete-minibuffer-contents-from-point
.
https://github.com/coldnew/linum-relative
Note that the key bindings are always available even if line numbers are not displayed. They are just useless in this case.