fyb/calcurse-edge
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document for -l/--limit and %(remaing)/%(duration)

Browse Source 
Update man-page and manual to describe limit option, and new formatting options
for %(remaining) and %(duration).

Signed-off-by: William Pettersson <william.pettersson@gmail.com>
Signed-off-by: Lukas Fleischer <calcurse@cryptocrack.de>
This commit is contained in:
William Pettersson 2013-07-20 00:05:11 +10:00 committed by Lukas Fleischer
parent aea877145e
commit c2d324be51
2 changed files with 38 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/calcurse.1.txt
View File

@ -43,8 +43,8 @@ Synopsis
[verse] [verse]
*calcurse* [*-h*|*-v*] [*-an*] [*-t*[num]] [*-c*<file>] [*-D*<dir>] *calcurse* [*-h*|*-v*] [*-an*] [*-t*[num]] [*-c*<file>] [*-D*<dir>]
[*-i*<file>] [*-x*[format]] [*-d* <date>|<num>] [*-i*<file>] [*-x*[format]] [*-d* <date>|<num>] [*-s*[date]]
[*-s*[date]] [*-r*[range]] [*-S* <regex>] [*--status*] [*-l* <num>] [*-r*[range]] [*-S* <regex>] [*--status*]
Description Description
----------- -----------
@ -135,6 +135,9 @@ appointments can be specified using the *-c* flag.
*-i* <file>, *--import* <file>:: *-i* <file>, *--import* <file>::
Import the icalendar data contained in 'file'. Import the icalendar data contained in 'file'.
*-l* <num>, *--limit* <num>::
Limit the number of results printed to 'num'.
*-n*, *--next*:: *-n*, *--next*::
Print the next appointment within upcoming 24 hours and exit. The indicated Print the next appointment within upcoming 24 hours and exit. The indicated
time is the number of hours and minutes left before this appointment. 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)*
* *S*: *(start:epoch)* * *S*: *(start:epoch)*
* *d*: *(duration)*
* *e*: *(end)* * *e*: *(end)*
* *E*: *(end:epoch)* * *E*: *(end:epoch)*
* *d*: *(duration)*
* *r*: *(remaining)*
* *m*: *(message)* * *m*: *(message)*
* *n*: *(noteid)* * *n*: *(noteid)*
* *N*: *(note)* * *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 but displays *..:..* if the item doesn't start/end at the current day) are
supported. 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 Notes
----- -----

19
doc/manual.txt
View File

@ -245,6 +245,9 @@ can be specified using the `-c` flag.
`-i <file>, --import <file>`:: `-i <file>, --import <file>`::
Import the icalendar data contained in `file`. Import the icalendar data contained in `file`.
`-l <num>, --limit <num>`::
Limit the number of results printed to 'num'.
`-n, --next`:: `-n, --next`::
Print the next appointment within upcoming 24 hours and exit. The indicated Print the next appointment within upcoming 24 hours and exit. The indicated
time is the number of hours and minutes left before this appointment. time is the number of hours and minutes left before this appointment.
@ -377,9 +380,10 @@ short specifiers and corresponding long options:
* `s`: `(start)` * `s`: `(start)`
* `S`: `(start:epoch)` * `S`: `(start:epoch)`
* `d`: `(duration)`
* `e`: `(end)` * `e`: `(end)`
* `E`: `(end:epoch)` * `E`: `(end:epoch)`
* `d`: `(duration)`
* `r`: `(remaining)`
* `m`: `(message)` * `m`: `(message)`
* `n`: `(noteid)` * `n`: `(noteid)`
* `N`: `(note)` * `N`: `(note)`
@ -392,6 +396,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 but displays `..:..` if the item doesn't start/end at the current day) are
supported. 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 `-` before 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`.
[[basics_invocation_variable]] [[basics_invocation_variable]]
Environment variable for i18n Environment variable for i18n
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^