]> code.delx.au - gnu-emacs-elpa/blob - Readme.org
[#45] Bump seq dependency to the new version
[gnu-emacs-elpa] / Readme.org
1 #+TITLE: Beacon --- Never lose your cursor again
2
3 This is a global minor-mode. Turn it on everywhere with:
4 #+BEGIN_SRC emacs-lisp
5 (beacon-mode 1)
6 #+END_SRC
7
8 [[file:example-beacon.gif]]
9
10 Whenever the window scrolls a light will shine on top of your cursor
11 so you know where it is.
12
13 That’s it.
14
15 ** Customizations
16
17 - The appearance of the beacon is configured by ~beacon-size~ and
18 ~beacon-color~.
19
20 - The duration is configured by ~beacon-blink-duration~ and
21 ~beacon-blink-delay~.
22
23 - To customize /when/ the beacon should blink at all, configure
24 ~beacon-blink-when-window-scrolls~,
25 ~beacon-blink-when-window-changes~, and
26 ~beacon-blink-when-point-moves~.
27
28 - To prevent the beacon from blinking only on specific situations
29 configure ~beacon-dont-blink-major-modes~,
30 ~beacon-dont-blink-predicates~, or ~beacon-dont-blink-commands~. You
31 can also disable it only in specific buffers by doing
32 ~(setq-local beacon-mode nil)~.
33
34 - Beacon can also push the mark for you whenever point moves a long
35 distance. For this, configure ~beacon-push-mark~.
36
37 ** Contributors
38
39 - [[https://github.com/tsdh][Tassilo Horn]]
40
41 If you’d like to help too, just open a PR.