]> code.delx.au - gnu-emacs-elpa/blobdiff - Readme.org
Extend doc
[gnu-emacs-elpa] / Readme.org
index 011c8c1c30d6cacabca895397ae598ee3b43d0ec..def0bba34277a462c7116e03ad5207d227bac261 100644 (file)
@@ -7,18 +7,28 @@ This is a global minor-mode.  Turn it on everywhere with:
 
 [[file:example-beacon.gif]]
 
-Whenever the window scrolls or the buffer changes a light will shine
-on top of your cursor so you know where it is.
+Whenever the window scrolls or you switch buffer a light will shine on
+top of your cursor so you know where it is.
 
 That’s it.
 
-- To customize the appearance of the beacon, configure
-  ~beacon-size~ and ~beacon-color~.
+** Customizations
 
-- To customize how long it lasts, configure ~beacon-blink-duration~
-  and ~beacon-blink-delay~.
+- The appearance of the beacon is configured by ~beacon-size~ and
+  ~beacon-color~.
 
-- To customize /when/ it is used at all, configure
+- 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~.