]> code.delx.au - gnu-emacs-elpa/blobdiff - Readme.org
Blink only in selected window; blink when switching windows
[gnu-emacs-elpa] / Readme.org
index 6587e1228fdf324c1581cda75f122611418ec664..def0bba34277a462c7116e03ad5207d227bac261 100644 (file)
@@ -1,20 +1,34 @@
-#+TITLE: Spotlight --- Never lose your cursor again
+#+TITLE: Beacon --- Never lose your cursor again
 
 This is a global minor-mode.  Turn it on everywhere with:
 #+BEGIN_SRC emacs-lisp
-(spotlight-mode 1)
+(beacon-mode 1)
 #+END_SRC
 
-Whenever point moves a long distance (as defined by
-~spotlight-minimum-distance~) a light will shine on top of your cursor
-to make sure you see where it is.
+[[file:example-beacon.gif]]
 
-- To customize the appearance of the spotlight, configure
-  ~spotlight-size~ and ~spotlight-brightness~.
+Whenever the window scrolls or you switch buffer a light will shine on
+top of your cursor so you know where it is.
 
-- To customize how long it lasts, configure ~spotlight-blink-duration~
-  and ~spotlight-blink-delay~.
+That’s it.
 
-- To customize when it is used at all, configure
-  ~spotlight-minimum-distance~ and
-  ~spotlight-blink-when-buffer-changes~.
+** Customizations
+
+- The appearance of the beacon is configured by ~beacon-size~ and
+  ~beacon-color~.
+
+- The duration is configured by ~beacon-blink-duration~ and
+  ~beacon-blink-delay~.
+
+- To customize /when/ the beacon should blink at all, configure
+  ~beacon-blink-when-window-scrolls~,
+  ~beacon-blink-when-buffer-changes~, and
+  ~beacon-blink-when-point-moves~.
+
+- To prevent the beacon from blinking only on some major-modes,
+  configure ~beacon-dont-blink-major-modes~. For specific buffers, you
+  can do ~(setq-local beacon-mode nil)~. For even more refined
+  control, configure ~beacon-dont-blink-predicates~
+
+- Beacon can also push the mark for you whenever point moves a long
+  distance. For this, configure ~beacon-push-mark~.