[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] master d1f0728 26/34: Extend doc
From: |
Artur Malabarba |
Subject: |
[elpa] master d1f0728 26/34: Extend doc |
Date: |
Fri, 16 Oct 2015 09:56:58 +0000 |
branch: master
commit d1f0728ea61891c8afd984861426528df898e918
Author: Artur Malabarba <address@hidden>
Commit: Artur Malabarba <address@hidden>
Extend doc
---
Readme.org | 22 +++++++++++++++-------
beacon.el | 22 +++++++++++++++-------
2 files changed, 30 insertions(+), 14 deletions(-)
diff --git a/Readme.org b/Readme.org
index cc9cd29..def0bba 100644
--- a/Readme.org
+++ b/Readme.org
@@ -7,20 +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.
** Customizations
-- To customize the appearance of the beacon, configure
- ~beacon-size~ and ~beacon-color~.
+- The appearance of the beacon is configured by ~beacon-size~ and
+ ~beacon-color~.
-- To customize how long it lasts, configure ~beacon-blink-duration~
- and ~beacon-blink-delay~.
+- The duration is configured by ~beacon-blink-duration~ and
+ ~beacon-blink-delay~.
-- To customize /when/ it is used at all, configure
+- 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~.
diff --git a/beacon.el b/beacon.el
index 8e24120..0b1ae0a 100644
--- a/beacon.el
+++ b/beacon.el
@@ -1,4 +1,4 @@
-;;; beacon.el --- Highlight the cursor whenever it moves long distances -*-
lexical-binding: t; -*-
+;;; beacon.el --- Highlight the cursor whenever the window scrolls -*-
lexical-binding: t; -*-
;; Copyright (C) 2015 Free Software Foundation, Inc.
@@ -28,7 +28,7 @@
;; │ (beacon-mode 1)
;; └────
;;
-;; Whenever the window scrolls or the buffer changes a light will shine on
+;; 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.
@@ -37,16 +37,24 @@
;; 1 Customizations
;; ════════════════
;;
-;; • To customize the appearance of the beacon, configure `beacon-size'
-;; and `beacon-color'.
+;; • The appearance of the beacon is configured by `beacon-size' and
+;; `beacon-color'.
;;
-;; • To customize how long it lasts, configure `beacon-blink-duration'
-;; and `beacon-blink-delay'.
+;; • The duration is configured by `beacon-blink-duration' and
+;; `beacon-blink-delay'.
;;
-;; • To customize /when/ it is used at all, configure
+;; • 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'.
;;; Code:
- [elpa] master b60416c 01/34: First commit, (continued)
- [elpa] master b60416c 01/34: First commit, Artur Malabarba, 2015/10/16
- [elpa] master ca3ec24 14/34: Fix temporary line breaks due to too long after-strings, Artur Malabarba, 2015/10/16
- [elpa] master c507480 13/34: Fix after-string overlays, Artur Malabarba, 2015/10/16
- [elpa] master 02112fa 12/34: Fix lighter, Artur Malabarba, 2015/10/16
- [elpa] master f1bb231 20/34: Fix scrolling outside command loop, Artur Malabarba, 2015/10/16
- [elpa] master 0b7041e 22/34: More documentation, Artur Malabarba, 2015/10/16
- [elpa] master 5622af4 25/34: [#2] Add more options for preventing a blink, Artur Malabarba, 2015/10/16
- [elpa] master 6f647f6 21/34: Only blink selected window, Artur Malabarba, 2015/10/16
- [elpa] master 0036355 23/34: Copyright, Artur Malabarba, 2015/10/16
- [elpa] master bccd3de 33/34: Document contributors, Artur Malabarba, 2015/10/16
- [elpa] master d1f0728 26/34: Extend doc,
Artur Malabarba <=
- [elpa] master 4a7079e 17/34: Improve readme, Artur Malabarba, 2015/10/16
- [elpa] master f439a41 27/34: Fix double blink when switching buffer, Artur Malabarba, 2015/10/16
- [elpa] master d66b206 28/34: Refactor overlay creation, Artur Malabarba, 2015/10/16
- [elpa] master b033c63 30/34: Merge pull request #6 from tsdh/master, Artur Malabarba, 2015/10/16
- [elpa] master 7294729 24/34: Don't blink on the minibuffer, Artur Malabarba, 2015/10/16
- [elpa] master 3e1defb 32/34: Don't blink in magit status buffers, Artur Malabarba, 2015/10/16
- [elpa] master d48f296 31/34: Doc, Artur Malabarba, 2015/10/16
- [elpa] master 0bdebed 29/34: Blink only in selected window; blink when switching windows, Artur Malabarba, 2015/10/16
- [elpa] master 441ebfe 19/34: Indentation, Artur Malabarba, 2015/10/16
- [elpa] master 849bc39 18/34: Rely on window-scroll-functions for scroll blinks, Artur Malabarba, 2015/10/16