From c2d324be516ad03bd1935f909b58efbc17b858a0 Mon Sep 17 00:00:00 2001 From: William Pettersson Date: Sat, 20 Jul 2013 00:05:11 +1000 Subject: Document for -l/--limit and %(remaing)/%(duration) Update man-page and manual to describe limit option, and new formatting options for %(remaining) and %(duration). Signed-off-by: William Pettersson Signed-off-by: Lukas Fleischer --- doc/calcurse.1.txt | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) (limited to 'doc/calcurse.1.txt') diff --git a/doc/calcurse.1.txt b/doc/calcurse.1.txt index 369eafc..4b10d80 100644 --- a/doc/calcurse.1.txt +++ b/doc/calcurse.1.txt @@ -43,8 +43,8 @@ Synopsis [verse] *calcurse* [*-h*|*-v*] [*-an*] [*-t*[num]] [*-c*] [*-D*] - [*-i*] [*-x*[format]] [*-d* |] - [*-s*[date]] [*-r*[range]] [*-S* ] [*--status*] + [*-i*] [*-x*[format]] [*-d* |] [*-s*[date]] + [*-l* ] [*-r*[range]] [*-S* ] [*--status*] Description ----------- @@ -135,6 +135,9 @@ appointments can be specified using the *-c* flag. *-i* , *--import* :: Import the icalendar data contained in 'file'. +*-l* , *--limit* :: + Limit the number of results printed to 'num'. + *-n*, *--next*:: Print the next appointment within upcoming 24 hours and exit. The indicated time is the number of hours and minutes left before this appointment. @@ -265,9 +268,10 @@ short specifiers and corresponding long options: * *s*: *(start)* * *S*: *(start:epoch)* -* *d*: *(duration)* * *e*: *(end)* * *E*: *(end:epoch)* +* *d*: *(duration)* +* *r*: *(remaining)* * *m*: *(message)* * *n*: *(noteid)* * *N*: *(note)* @@ -280,6 +284,19 @@ and *default* (which is mostly equivalent to *(start:%H:%M)* or *(end:%H:%M)* but displays *..:..* if the item doesn't start/end at the current day) are supported. +The *(remaining)* and *(duration)* specifiers support a subset of the +strftime()-style formatting options, along with two extra qualifiers. +The supported options are *%d*, *%H*, *%M* and *%S*, and by default each +of these is zero-padded to two decimal places. To avoid the +zero-padding, add *-* in front of the formatting option (for example, +*%-d*). Additionally, the *E* option will display the total number of +time units until the appointment, rather than showing the remaining +number of time units modulo the next larger time unit. For example, an +appointment in 50 hours will show as 02:00 with the formatting string +*%H:%M*, but will show 50:00 with the formatting string *%EH:%M*. Note +that if you are combining the *-* and *E* options, the *-* must come +first. The default format for the *(remaining)* specifier is *%EH:%M*. + Notes ----- -- cgit v1.2.3-54-g00ecf