branch: externals/tmr
commit 0d94b417820d437c1a85c7e517d46f1d3b5e07ac
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Document tmr-clone and new grid view key bindings
---
README.org | 23 +++++++++++++++++++----
tmr.el | 17 +++++++++++++++--
2 files changed, 34 insertions(+), 6 deletions(-)
diff --git a/README.org b/README.org
index d1db07b0e7..c9f864da24 100644
--- a/README.org
+++ b/README.org
@@ -120,8 +120,13 @@ the completion prompt are described by the exact time they
were set and
the input that was used to create them, including the optional
description that ~tmr~ and ~tmr-with-description~ accept.
-[ The following information about the grid view is part of
- {{{development-version}}} ]
+[ The following information is part of {{{development-version}}}. Some
+ things may still change. ]
+
+#+findex: tmr-clone
+An existing timer can be cloned with the ~tmr-clone~ command. It copies
+the duration and optional description of an existing timer into a new
+one.
#+findex: tmr-tabulated-view
Active timers can be viewed in a grid with ~tmr-tabulated-view~ (part of
@@ -144,9 +149,19 @@ From the =*tmr-tabulated-view*= buffer, invoke the command
~describe-mode~ to learn about the applicable key bindings, such as how
to expand/contract columns and toggle their sort.
+While in this grid view:
+
++ The =+= key creates a new timer by calling the standard ~tmr~ command.
+ As always, use a prefix argument to also prompt for a description.
+
+#+findex: tmr-tabulated-cancel
++ The =c= key invokes the ~tmr-tabulated-cancel~ command. It is the
+ same as the aforementioned ~tmr-cancel~ plus some tweaks for the grid
+ view.
+
#+findex: tmr-tabulated-cancel
-While in this grid view, the =k= key runs the ~tmr-tabulated-cancel~
-command. It immediately cancels the timer at point.
++ The =k= key runs the ~tmr-tabulated-cancel~ command. It immediately
+ cancels the timer at point.
* Installation
:PROPERTIES:
diff --git a/tmr.el b/tmr.el
index 583f191445..d5ca9c325c 100644
--- a/tmr.el
+++ b/tmr.el
@@ -76,6 +76,10 @@
;; the input that was used to create them, including the optional
;; description that `tmr' and `tmr-with-description' accept.
;;
+;; An existing timer can be cloned with the `tmr-clone' command. It copies
+;; the duration and optional description of an existing timer into a new
+;; one.
+;;
;; Active timers can be viewed in a grid with `tmr-tabulated-view' (part of
;; the `tmr-tabulated.el' file). The grid is placed in the
;; `*tmr-tabulated-view*' buffer and looks like this:
@@ -94,8 +98,17 @@
;; `describe-mode' to learn about the applicable key bindings, such as how
;; to expand/contract columns and toggle their sort.
;;
-;; While in this grid view, the `k' key runs the `tmr-tabulated-cancel'
-;; command. It immediately cancels the timer at point.
+;; While in this grid view:
+;;
+;; + The `+' key creates a new timer by calling the standard `tmr' command.
+;; As always, use a prefix argument to also prompt for a description.
+;;
+;; + The `c' key invokes the `tmr-tabulated-cancel' command. It is the
+;; same as the aforementioned `tmr-cancel' plus some tweaks for the grid
+;; view.
+;;
+;; + The `k' key runs the `tmr-tabulated-cancel' command. It immediately
+;; cancels the timer at point.
;;; Code:
