Skip to content

Commit b360d9d

Browse files
committed
Update info file
1 parent 904e7df commit b360d9d

File tree

1 file changed

+73
-36
lines changed

1 file changed

+73
-36
lines changed

chronos.info

+73-36
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,11 @@ specification: time-spec. for more sophisticated options). When
125125
prompted for the message, enter a short description of the timer for
126126
display and notification.
127127

128+
Alternatively, you can use `M-x chronos-add-timers-from-string'.
129+
This function prompts for a string, from which one or more timers can
130+
be parsed. See the section *note Add timers from string:
131+
add-timers-from-string.
132+
128133

129134
File: chronos.info, Node: Configuration, Next: Controls, Prev: Installation and quick start, Up: Top
130135

@@ -157,8 +162,13 @@ time and a message.
157162
4.1.1 Expiry time specification
158163
-------------------------------
159164

160-
The expiry time specification can be relative to current time or the
161-
expiry of another timer, or absolute.
165+
The expiry time specification can be absolute or relative. Relative
166+
times are with respect to a base time that, depending on
167+
circumstances, could be:
168+
169+
* current time, or
170+
171+
* the expiry time of another timer
162172

163173
4.1.1.1 absolute time
164174
.....................
@@ -174,7 +184,7 @@ add 24 hours: e.g. `=25:30' specifies 1:30 tomorrow morning.
174184
Up to three numbers can be given, separated with colons `:'. A minus
175185
`-' can be prepended to indicate negative times.
176186

177-
* No numbers (or all zeros) - current time
187+
* No numbers (or all zeros) - the base time
178188

179189
* One number - minutes
180190

@@ -207,21 +217,20 @@ to expire earlier, one with `-5' (five minutes before end, i.e.
207217
[18:55] 58 51:10 Thanks and goodbyes
208218
[19:00] 2:01 56:10 Talk ends
209219

210-
4.1.2 chronos-add-timers-from-string
211-
------------------------------------
212-
213-
`M-x chronos-add-timers-from-string' can be used to add multiple
214-
consecutive timers from one string.
220+
4.1.2 Add timers from string
221+
----------------------------
215222

216-
This string specifies a timer by a chronos expiry time
217-
specification and a message, separated by `/'. Multiple cumulative
218-
timers can be specified by separating them with `+'.
223+
Although mainly useful for the helm-chronos helm interface, `M-x
224+
chronos-add-timers-from-string' can be used to add multiple
225+
consecutive timers from one string. If the first timer in the string
226+
has a relative expiry time, this is relative to current time or, with
227+
the prefix argument, to the currently selected timer. Subsequent
228+
relative timers in the string are with respect to the expiry time of
229+
the previous timer in the string.
219230

220-
If the first timer in the string has a relative expiry time, this
221-
is relative to current time or, with the prefix argument, to the
222-
currently selected timer. Subsequent relative timers in the string
223-
are with respect to the expiry time of the previous timer in the
224-
string.
231+
The format of the string for a single timer is `<expiry
232+
specification>/<message>'. Multiple cumulative timers can be
233+
specified by separating them with `+'.
225234

226235
For example: "5/Coffee" would be for a timer expiring in five
227236
minutes with the message "Coffee".
@@ -230,8 +239,8 @@ minutes with the message "Coffee".
230239

231240
25/Pomodoro: Work on helm-chronos + 5/Pomodoro: Rest
232241

233-
Which will give a timer to go off in 25 minute and 30 (=25+5)
234-
minutes:
242+
Which will give a timer to go off in 25 minutes and another in 30
243+
(=25+5) minutes:
235244

236245
Expiry Elapsed To go Message
237246
[13:10] --now--
@@ -262,16 +271,43 @@ In the *chronos* buffer, new timers can be added, selected, paused,
262271
unpaused, lapped, adjusted or deleted. Default keybindings in this
263272
buffer are:
264273

265-
a add a timer
266-
A add multiple consecutive timer(s) in one go
267-
n/p move selection down/up
268-
SPC pause/unpause selected timer
269-
d delete selected timer
270-
D delete all expired timers
271-
e edit selected timer
272-
l lap selected timer
273-
F freeze/unfreeze the display
274-
q quit window
274+
`a'
275+
add a timer
276+
277+
`A'
278+
add multiple consecutive timer(s) in one go
279+
280+
`n'
281+
`C-n'
282+
`<down>'
283+
Select next timer
284+
285+
`p'
286+
`C-p'
287+
`<up>'
288+
Select previous timer
289+
290+
`SPC'
291+
pause/unpause selected timer
292+
293+
`d'
294+
delete selected timer
295+
296+
`D'
297+
delete all expired timers
298+
299+
`e'
300+
edit selected timer
301+
302+
`l'
303+
lap selected timer
304+
305+
`F'
306+
freeze/unfreeze the display
307+
308+
`q'
309+
quit window
310+
275311

276312
Whether relative times are against current time or the expiry time
277313
of the selected timer is controlled by the prefix.
@@ -296,8 +332,8 @@ chronos-add-timers-from-string'.
296332
--------------------
297333

298334
A timer is selected when the cursor is on its line. The cursor can be
299-
moved down and up the timer list, wrapping as necessary, with `n' and
300-
`p'.
335+
moved down and up the timer list, wrapping as necessary, with
336+
`n'/`C-n'/`<down>' and `p'/`C-p'/`<up>'.
301337

302338
The -now- timer can be selected, but cannot be paused, lapped or
303339
deleted.
@@ -963,11 +999,12 @@ Tag Table:
963999
Node: Top787
9641000
Node: Introduction to Chronos1070
9651001
Node: Installation and quick start2229
966-
Node: Configuration3967
967-
Node: Controls4388
968-
Ref: time-spec4830
969-
Ref: buff-cmds8348
970-
Node: Notifications12864
971-
Node: GNU Free Documentation License16142
1002+
Node: Configuration4187
1003+
Node: Controls4608
1004+
Ref: time-spec5050
1005+
Ref: add-timers-from-string6857
1006+
Ref: buff-cmds8708
1007+
Node: Notifications13309
1008+
Node: GNU Free Documentation License16587
9721009

9731010
End Tag Table

0 commit comments

Comments
 (0)