File: type-break.el.html
The docstring for the function type-break-mode(var)/type-break-mode(fun) summarizes most of the
details of the interface.
This package relies on the assumption that you live entirely in Emacs, as the author does. If that's not the case for you (e.g. you often suspend Emacs or work in other windows) then this won't help very much; it will depend on just how often you switch back to Emacs. At the very least, you will want to turn off the keystroke thresholds and rest interval tracking.
If you prefer not to be queried about taking breaks, but instead just want to be reminded, do the following:
(setq type-break-query-mode nil)
Or call the command type-break-query-mode(var)/type-break-query-mode(fun) with a negative prefix
argument.
If you find echo area messages annoying and would prefer to see messages in the mode line instead, do M-x type-break-mode-line-message-mode or set the variable of the same name to t.
This package was inspired by Roland McGrath's hanoi-break.el.
Several people contributed feedback and ideas, including
Roland McGrath <roland@gnu.org>
Kleanthes Koniaris <kgk@koniaris.com>
Mark Ashton <mpashton@gnu.org>
Matt Wilding <wilding@cli.com>
Robert S. Boyer <boyer@cs.utexas.edu>
Defined variables (25)
type-break-auto-save-file-name | Auto-save name of ‘type-break-file-name’. |
type-break-demo-boring-stats | Show word per minute and keystroke figures in the Boring demo. |
type-break-demo-functions | List of functions to consider running as demos during typing breaks. |
type-break-file-name | Name of file used to save state across sessions. |
type-break-good-break-interval | Number of seconds considered to be an adequate explicit typing rest. |
type-break-good-rest-interval | Number of seconds of idle time considered to be an adequate typing rest. |
type-break-interval | Number of seconds between scheduled typing breaks. |
type-break-keystroke-threshold | Upper and lower bound on number of keystrokes for considering typing break. |
type-break-keystroke-warning-intervals | List of keystroke measurements for warnings about upcoming typing break. |
type-break-mode | Non-nil if Type-Break mode is enabled. |
type-break-mode-hook | Hook run after entering or leaving ‘type-break-mode’. |
type-break-mode-line-format | Format of messages in the mode line concerning typing breaks. |
type-break-mode-line-message-mode | Non-nil if Type-Break-Mode-Line-Message mode is enabled. |
type-break-mode-line-message-mode-hook | Hook run after entering or leaving ‘type-break-mode-line-message-mode’. |
type-break-post-command-hook | Hook run indirectly by ‘post-command-hook’ for typing break functions. |
type-break-query-function | Function to use for making query for a typing break. |
type-break-query-interval | Number of seconds between queries to take a break, if put off. |
type-break-query-mode | Non-nil if Type-Break-Query mode is enabled. |
type-break-query-mode-hook | Hook run after entering or leaving ‘type-break-query-mode’. |
type-break-terse-messages | Use slightly terser messages. |
type-break-time-stamp-format | Timestamp format used to prefix messages. |
type-break-time-warning-intervals | List of time intervals for warnings about upcoming typing break. |
type-break-warning-countdown-string | If non-nil, this is a countdown for the next typing break. |
type-break-warning-countdown-string-type | Indicates the unit type of ‘type-break-warning-countdown-string’. |
type-break-warning-repeat | Number of keystrokes for which warnings should be repeated. |
Defined functions (28)
timep | (TIME) |
type-break | () |
type-break-cancel-function-timers | (FUNCTION) |
type-break-check | () |
type-break-choose-file | () |
type-break-demo-boring | () |
type-break-demo-hanoi | () |
type-break-demo-life | () |
type-break-file-keystroke-count | () |
type-break-file-time | (&optional TIME) |
type-break-force-mode-line-update | (&optional ALL) |
type-break-format-time | (SECS) |
type-break-get-previous-count | () |
type-break-get-previous-time | () |
type-break-guesstimate-keystroke-threshold | (WPM &optional WORDLEN FRAC) |
type-break-mode | (&optional ARG) |
type-break-mode-line-countdown-or-break | (&optional TYPE) |
type-break-mode-line-message-mode | (&optional ARG) |
type-break-noninteractive-query | (&optional IGNORED-ARGS) |
type-break-query-mode | (&optional ARG) |
type-break-run-at-time | (TIME REPEAT FUNCTION &rest ARGS) |
type-break-schedule | (&optional TIME START INTERVAL) |
type-break-statistics | () |
type-break-time-difference | (A B) |
type-break-time-stamp | (&optional WHEN) |
type-break-time-sum | (&rest TMLIST) |
type-break-time-warning-schedule | (&optional TIME RESETP) |
type-break-timep | (TIME) |