branch: elpa/isl
commit b0a0b592d8be657683a05ab8273df8d68fdbe7d8
Author: Thierry Volpiatto <[email protected]>
Commit: Thierry Volpiatto <[email protected]>
Add a configure section in README
---
README.org | 33 ++++++++++++++++++++++++++++++++-
1 file changed, 32 insertions(+), 1 deletion(-)
diff --git a/README.org b/README.org
index 357840f605b..2e879da419a 100644
--- a/README.org
+++ b/README.org
@@ -54,7 +54,9 @@ Then add =(require 'isl)= in your init file.
Even better, you can autoload it:
#+begin_src elisp
- (autoload 'isl "isl" nil t)
+ (autoload 'isl-search "isl" nil t)
+ (autoload 'isl-narrow-to-defun "isl" nil t)
+ (autoload 'isl-resume "isl" nil t)
#+end_src
With =use-package= and binding =C-s=
@@ -64,6 +66,35 @@ With =use-package= and binding =C-s=
:bind (("C-s" . isl-search)))
#+end_src
+** Configure
+
+You may want to disable all =Isearch= global bindings:
+
+#+begin_src elisp
+ (global-set-key [remap isearch-forward] 'undefined)
+ (global-set-key [remap isearch-backward] 'undefined)
+ (global-set-key [remap isearch-forward-regexp] 'undefined)
+ (global-set-key [remap isearch-backward-regexp] 'undefined)
+ (global-set-key (kbd "C-r") nil)
+ (global-set-key (kbd "C-s") nil)
+ (global-set-key (kbd "C-M-s") nil)
+ (global-set-key (kbd "C-M-r") nil)
+#+end_src
+
+And the rebind the necessary keys to isl-* commands:
+
+#+begin_src elisp
+ (global-set-key (kbd "C-s") 'isl-search)
+ (global-set-key (kbd "C-z") 'isl-narrow-to-defun)
+ (global-set-key (kbd "C-M-s") 'isl-resume)
+#+end_src
+
+You will find severals user variables prefixed with =isl-=, see M-x
customize-variable.
+
+NOTE: many of them can be toggled while in =isl-search= session, so
+you may not need to modify them unless you want to change the default
+behavior.
+
** Usage
=M-x isl-search=
