branch: master
commit 7cca04a65e77450abce4d32243abcc9e2135be9d
Author: Oleh Krehel <ohwoeo...@gmail.com>
Commit: Oleh Krehel <ohwoeo...@gmail.com>
doc/ivy.org: Document the marking feature
Re #2214
---
doc/ivy.org | 33 ++++++++++++++++++++++-----------
doc/ivy.texi | 43 +++++++++++++++++++++++++++++++++++++++----
2 files changed, 61 insertions(+), 15 deletions(-)
diff --git a/doc/ivy.org b/doc/ivy.org
index e035ee1..eddb853 100644
--- a/doc/ivy.org
+++ b/doc/ivy.org
@@ -513,17 +513,17 @@ actions.
When Hydra is active, minibuffer editing is disabled and menus
display short aliases:
-| Short | Normal | Command name |
-|-------+-----------+---------------------------|
-| ~o~ | ~C-g~ | =keyboard-escape-quit= |
-| ~j~ | ~C-n~ | =ivy-next-line= |
-| ~k~ | ~C-p~ | =ivy-previous-line= |
-| ~h~ | ~M-<~ | =ivy-beginning-of-buffer= |
-| ~l~ | ~M->~ | =ivy-end-of-buffer= |
-| ~d~ | ~C-m~ | =ivy-done= |
-| ~f~ | ~C-j~ | =ivy-alt-done= |
-| ~g~ | ~C-M-m~ | =ivy-call= |
-| ~u~ | ~C-c C-o~ | =ivy-occur= |
+| Short | Normal | Command name |
+|-------+---------+-------------------------|
+| ~o~ | ~C-g~ | =keyboard-escape-quit= |
+| ~j~ | ~C-n~ | =ivy-next-line= |
+| ~k~ | ~C-p~ | =ivy-previous-line= |
+| ~h~ | ~M-<~ | =ivy-beginning-of-buffer= |
+| ~l~ | ~M->~ | =ivy-end-of-buffer= |
+| ~d~ | ~C-m~ | =ivy-done= |
+| ~f~ | ~C-j~ | =ivy-alt-done= |
+| ~g~ | ~C-M-m~ | =ivy-call= |
+| ~u~ | ~C-c C-o~ | =ivy-occur= |
Hydra reduces key strokes, for example: ~C-n C-n C-n C-n~ is ~C-o
jjjj~ in Hydra.
@@ -556,6 +556,17 @@ Hydra menu offers these additional bindings:
Toggle case folding (match both upper and lower case
characters for lower case input).
+Hydra menu also offers bindings for marking multiple candidates:
+
+| Key | Command name |
+|-----+---------------------|
+| ~m~ | =ivy-mark= |
+| ~u~ | =ivy-unmark= |
+| ~DEL~ | =ivy-unmark-backward= |
+| ~t~ | =ivy-toggle-marks= |
+
+The action is called on each marked candidate one by one.
+
*** Saving the current completion session to a buffer
:PROPERTIES:
:CUSTOM_ID: saving-the-current-completion-session-to-a-buffer
diff --git a/doc/ivy.texi b/doc/ivy.texi
index 72c43ea..e4813cc 100644
--- a/doc/ivy.texi
+++ b/doc/ivy.texi
@@ -8,7 +8,7 @@
@copying
@ifnottex
-Ivy manual, version 0.11.0
+Ivy manual, version 0.12.0
Ivy is an interactive interface for completion in Emacs. Emacs uses
completion mechanism in a variety of contexts: code, menus, commands,
@@ -20,7 +20,7 @@ final candidate is either through simple keyboard character
inputs or
through powerful regular expressions.
@end ifnottex
-Copyright (C) 2015-2018 Free Software Foundation, Inc.
+Copyright (C) 2015-2019 Free Software Foundation, Inc.
@quotation
Permission is granted to copy, distribute and/or modify this document
@@ -329,14 +329,19 @@ with some sample bindings:
@subsubheading Ivy-based interface to standard commands
@indentedblock
@lisp
-(global-set-key (kbd "C-s") 'swiper)
+(global-set-key (kbd "C-s") 'swiper-isearch)
(global-set-key (kbd "M-x") 'counsel-M-x)
(global-set-key (kbd "C-x C-f") 'counsel-find-file)
+(global-set-key (kbd "M-y") 'counsel-yank-pop)
(global-set-key (kbd "<f1> f") 'counsel-describe-function)
(global-set-key (kbd "<f1> v") 'counsel-describe-variable)
(global-set-key (kbd "<f1> l") 'counsel-find-library)
(global-set-key (kbd "<f2> i") 'counsel-info-lookup-symbol)
(global-set-key (kbd "<f2> u") 'counsel-unicode-char)
+(global-set-key (kbd "<f2> j") 'counsel-set-variable)
+(global-set-key (kbd "C-x b") 'ivy-switch-buffer)
+(global-set-key (kbd "C-c v") 'ivy-push-view)
+(global-set-key (kbd "C-c V") 'ivy-pop-view)
@end lisp
@end indentedblock
@subsubheading Ivy-based interface to shell and system tools
@@ -345,9 +350,14 @@ with some sample bindings:
(global-set-key (kbd "C-c c") 'counsel-compile)
(global-set-key (kbd "C-c g") 'counsel-git)
(global-set-key (kbd "C-c j") 'counsel-git-grep)
-(global-set-key (kbd "C-c k") 'counsel-ag)
+(global-set-key (kbd "C-c L") 'counsel-git-log)
+(global-set-key (kbd "C-c k") 'counsel-rg)
+(global-set-key (kbd "C-c m") 'counsel-linux-app)
+(global-set-key (kbd "C-c n") 'counsel-fzf)
(global-set-key (kbd "C-x l") 'counsel-locate)
+(global-set-key (kbd "C-c J") 'counsel-file-jump)
(global-set-key (kbd "C-S-o") 'counsel-rhythmbox)
+(global-set-key (kbd "C-c w") 'counsel-wmctrl)
@end lisp
@end indentedblock
@subsubheading Ivy-resume and other commands
@@ -356,9 +366,17 @@ with some sample bindings:
@lisp
(global-set-key (kbd "C-c C-r") 'ivy-resume)
+(global-set-key (kbd "C-c b") 'counsel-bookmark)
+(global-set-key (kbd "C-c d") 'counsel-descbinds)
+(global-set-key (kbd "C-c g") 'counsel-git)
+(global-set-key (kbd "C-c o") 'counsel-outline)
+(global-set-key (kbd "C-c t") 'counsel-load-theme)
+(global-set-key (kbd "C-c F") 'counsel-org-file)
@end lisp
@end indentedblock
+You can also enable @code{counsel-mode} to make some global key binding
remapping for you.
+
@node Minibuffer key bindings
@section Minibuffer key bindings
@@ -730,6 +748,23 @@ Toggle case folding (match both upper and lower case
characters for lower case input).
@end indentedblock
+Hydra menu also offers bindings for marking multiple candidates:
+
+@multitable {aaaaa} {aaaaaaaaaaaaaaaaaaaaa}
+@headitem Key
+@tab Command name
+@item @kbd{m}
+@tab @code{ivy-mark}
+@item @kbd{u}
+@tab @code{ivy-unmark}
+@item @kbd{DEL}
+@tab @code{ivy-unmark-backward}
+@item @kbd{t}
+@tab @code{ivy-toggle-marks}
+@end multitable
+
+The action is called on each marked candidate one by one.
+
@node Saving the current completion session to a buffer
@subsection Saving the current completion session to a buffer
