aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLukas Fleischer <lfleischer@calcurse.org>2016-01-15 18:53:19 +0100
committerLukas Fleischer <lfleischer@calcurse.org>2016-01-15 18:53:19 +0100
commit6ebcbd4d69a90e9d100220e4e5dea6e88f202a6d (patch)
tree08b81b368c5a8cd1c2ec2d4512bb52f5bff57bdd /doc
parentc3648f08c7099e4ef120c8ce33c40eb0352c5acd (diff)
downloadcalcurse-6ebcbd4d69a90e9d100220e4e5dea6e88f202a6d.tar.gz
calcurse-6ebcbd4d69a90e9d100220e4e5dea6e88f202a6d.zip
Document new options and format specifiers
Signed-off-by: Lukas Fleischer <lfleischer@calcurse.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/calcurse.1.txt27
-rw-r--r--doc/manual.txt27
2 files changed, 54 insertions, 0 deletions
diff --git a/doc/calcurse.1.txt b/doc/calcurse.1.txt
index 367729f..829ede2 100644
--- a/doc/calcurse.1.txt
+++ b/doc/calcurse.1.txt
@@ -100,10 +100,20 @@ appointments can be specified using the *-c* flag.
Specify the length of the range (in days) when used with *-Q*. Cannot be
combined with *--to*.
+*--export-uid*::
+ When exporting items, add the hash of each item to the exported object as an
+ UID property.
+
*-D* <dir>, *--directory* <dir>::
Specify the data directory to use. If not specified, the default directory is
*~/.calcurse/*.
+*-F*, *--filter*::
+ Read items from the data files and write them back. The filter interface can
+ be used to drop specific items. Be careful with this option, specifying a
+ wrong filter might result it data loss! It is highly recommended to test the
+ effect of filters with -G first. See also: 'Filter Options'.
+
*--from* <date>::
Specify the start date of the range when used with *-Q*.
@@ -125,6 +135,9 @@ appointments can be specified using the *-c* flag.
*-l* <num>, *--limit* <num>::
Limit the number of results printed to 'num'.
+*--list-imported*::
+ When importing items, print the hash of each newly created object to stdout.
+
*-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.
@@ -132,6 +145,9 @@ appointments can be specified using the *-c* flag.
'Note:' the calendar from which to read the appointments can be specified using
the *-c* flag.
+*-q*, *--quiet*::
+ Be quiet. Do not show system dialogs.
+
*-Q*, *--query*::
Print all appointments inside a given query range, followed by all TODO
items. The query range defaults to the current day and can be changed by
@@ -203,6 +219,10 @@ Filters can be used to restrict the set of items which are loaded from the
appointments file when using calcurse in non-interactive mode. The following
filters are currently supported:
+*--filter-hash <pattern>*::
+ Only include items with a hash starting with the specified pattern. The
+ pattern can be inverted by prepending an exclamation mark ('!').
+
*--filter-type* <type>::
Ignore any items that do not match the type mask. The type mask is a
comma-separated list of valid type descriptions which include 'event', 'apt',
@@ -384,6 +404,13 @@ appointment in 50 hours will show as 02:00 with the formatting string
that if you are combining the *-* and *E* options, the *-* must come
first. The default format for the *(remaining)* specifier is *%EH:%M*.
+There are two additional long format specifiers that do not have any
+corresponding short options. They can be used to print an item's hash or its
+internal representation and were designed to be used for scripting:
+
+* *(hash)*
+* *(raw)*
+
Notes
-----
diff --git a/doc/manual.txt b/doc/manual.txt
index 77d4990..f105be0 100644
--- a/doc/manual.txt
+++ b/doc/manual.txt
@@ -293,6 +293,16 @@ can be specified using the `-c` flag.
See the <<basics_format_strings,Format strings>> section for detailed
information on format strings.
+`--export-uid`::
+ When exporting items, add the hash of each item to the exported object as an
+ UID property.
+
+`-F`, `--filter`::
+ Read items from the data files and write them back. The filter interface can
+ be used to drop specific items. Be careful with this option, specifying a
+ wrong filter might result it data loss! It is highly recommended to test the
+ effect of filters with -G first. See also: <<basics_filters,Filters>>.
+
`--from <date>`::
Specify the start date of the range when used with `-Q`.
@@ -314,6 +324,9 @@ can be specified using the `-c` flag.
`-l <num>, --limit <num>`::
Limit the number of results printed to 'num'.
+`--list-imported`::
+ When importing items, print the hash of each newly created object to stdout.
+
`-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.
@@ -321,6 +334,9 @@ can be specified using the `-c` flag.
Note: the calendar from which to read the appointments can be specified using
the `-c` flag.
+`-q`, `--quiet`::
+ Be quiet. Do not show system dialogs.
+
`-Q, --query`::
Print all appointments inside a given query range, followed by all TODO
items. The query range defaults to the current day and can be changed by
@@ -394,6 +410,10 @@ Filters can be used to restrict the set of items which are loaded from the
appointments file when using calcurse in non-interactive mode. The following
filters are currently supported:
+`--filter-hash <pattern>`::
+ Only include items with a hash starting with the specified pattern. The
+ pattern can be inverted by prepending an exclamation mark (`!`).
+
`--filter-type <type>`::
Ignore any items that do not match the type mask. The type mask is a
comma-separated list of valid type descriptions which include `event`, `apt`,
@@ -550,6 +570,13 @@ 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`.
+There are two additional long format specifiers that do not have any
+corresponding short options. They can be used to print an item's hash or its
+internal representation and were designed to be used for scripting:
+
+* `(hash)`
+* `(raw)`
+
[[basics_invocation_variable]]
Environment variable for i18n
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^