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 <william.pettersson@gmail.com>
Signed-off-by: Lukas Fleischer <calcurse@cryptocrack.de>

1 files changed, 18 insertions, 1 deletions

diff --git a/doc/manual.txt b/doc/manual.txt
index 09dc035..02aff4f 100644
--- a/doc/manual.txt
+++ b/doc/manual.txt
@@ -245,6 +245,9 @@ can be specified using the `-c` flag.
 `-i <file>, --import <file>`::
   Import the icalendar data contained in `file`.
 
+`-l <num>, --limit <num>`::
+  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.
@@ -377,9 +380,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)`
@@ -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
 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]]
 Environment variable for i18n
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^