Updated README and rearranged functions.

diff --git a/README.md b/README.md
index 5cba2b337747fbdf7bb21e52f85562891cb52d14..cea09cd635be42e8a73503892bad82c263fde8f8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -33,4 +33,18 @@ To use it, add the following to your .emacs file:
 (define-key global-map [(control shift o)] 'loccur-previous-match)
 ```
 
-Now you can point the cursor to the word and press `Ctrl+o` to hide all lines except those containing this word. Moving cursor to the required line and pressing `Ctrl+o` again will shows all the text. The good thing about this mode is what you can navigate through the buffer easily. `Ctrl+Shift+o` will repeat last search. 
+Now you can point the cursor to the word and press `Ctrl+o` to hide all lines except those containing this word. Moving cursor to the required line and pressing `Ctrl+o` again will shows all the text. The good thing about this mode is what you can navigate through the buffer easily. `Ctrl+Shift+o` will repeat last search.
+
+### Available commands
+Below is the list of interactive commands available for user:
+
+* `loccur` interactively asks user for regexp to search or toggle search off (if `loccur-mode` is already enabled)
+* `loccur-current` searches for the current word under the cursor
+* `loccur-previous-match` repeat previous `loccur` command
+* `loccur-no-highlight` is the same as `loccur` but not highlighting matches
+* `loccur-toggle-highlight` toggles highlighting of matches
+
+### Customization
+* `loccur-jump-beginning-of-line` variable specifies if move the cursor to the beginning of the matching line. Default `nil`
+* `loccur-highlight-matching-regexp` variable whenever `loccur` should highlight matching words. Default `t`.
+* `loccur-face` face to be used while highlighting. Default points to `isearch` face.

diff --git a/loccur.el b/loccur.el
index a59d406ff4ff2f4b6a8275a2ade16fb7e175e2a5..9b110b0c21df31c916ce63192a29a9cfdf52a266 100644 (file)
--- a/loccur.el
+++ b/loccur.el
@@ -154,6 +154,16 @@ REGEX is regexp to search"
   (let ((loccur-highlight-matching-regexp nil))
     (loccur regex)))
 
+(defun loccur-toggle-highlight (&optional arg)
+  "Toggle the highlighting of the match.
+Optional argument ARG if t turn highlight on, off otherwise."
+  (interactive)
+  (setq loccur-highlight-matching-regexp (not loccur-highlight-matching-regexp))
+  (when loccur-mode
+    (dolist (ovl loccur-overlay-list)
+      (when (overlay-get ovl loccur-overlay-visible-property-name)
+        (overlay-put ovl 'face (if loccur-highlight-matching-regexp 'loccur-face nil))))))
+
 (defun loccur (regex)
   "Perform a simple grep in current buffer.
 
@@ -181,7 +191,6 @@ unhides lines again"
         (beginning-of-line))))) ; optionally jump to the beginning of line
 
 
-
 (defun loccur-prompt ()
   "Return the default value of the prompt.
 
@@ -310,15 +319,6 @@ containing match"
         (forward-line 1))
       (setq lines (nreverse lines)))))
 
-(defun loccur-toggle-highlight (&optional arg)
-  "Toggle the highlighting of the match.
-Optional argument ARG if t turn highlight on, off otherwise."
-  (interactive)
-  (setq loccur-highlight-matching-regexp (not loccur-highlight-matching-regexp))
-  (when loccur-mode
-    (dolist (ovl loccur-overlay-list)
-      (when (overlay-get ovl loccur-overlay-visible-property-name)
-        (overlay-put ovl 'face (if loccur-highlight-matching-regexp 'loccur-face nil))))))