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

Document new options and format specifiers

Browse Source 
Signed-off-by: Lukas Fleischer <lfleischer@calcurse.org>
This commit is contained in:
Lukas Fleischer 2016-01-15 18:53:19 +01:00
parent c3648f08c7
commit 6ebcbd4d69
2 changed files with 54 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/calcurse.1.txt
View File

@ -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 Specify the length of the range (in days) when used with *-Q*. Cannot be
combined with *--to*. 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>:: *-D* <dir>, *--directory* <dir>::
Specify the data directory to use. If not specified, the default directory is Specify the data directory to use. If not specified, the default directory is
*~/.calcurse/*. *~/.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>:: *--from* <date>::
Specify the start date of the range when used with *-Q*. 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>:: *-l* <num>, *--limit* <num>::
Limit the number of results printed to '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*:: *-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.
@ -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 'Note:' the calendar from which to read the appointments can be specified using
the *-c* flag. the *-c* flag.
*-q*, *--quiet*::
Be quiet. Do not show system dialogs.
*-Q*, *--query*:: *-Q*, *--query*::
Print all appointments inside a given query range, followed by all TODO 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 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 appointments file when using calcurse in non-interactive mode. The following
filters are currently supported: 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>:: *--filter-type* <type>::
Ignore any items that do not match the type mask. The type mask is a 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', 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 that if you are combining the *-* and *E* options, the *-* must come
first. The default format for the *(remaining)* specifier is *%EH:%M*. 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 Notes
----- -----

27
doc/manual.txt
View File

@ -293,6 +293,16 @@ can be specified using the `-c` flag.
See the <<basics_format_strings,Format strings>> section for detailed See the <<basics_format_strings,Format strings>> section for detailed
information on format strings. 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>`:: `--from <date>`::
Specify the start date of the range when used with `-Q`. 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>`:: `-l <num>, --limit <num>`::
Limit the number of results printed to '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`:: `-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.
@ -321,6 +334,9 @@ can be specified using the `-c` flag.
Note: the calendar from which to read the appointments can be specified using Note: the calendar from which to read the appointments can be specified using
the `-c` flag. the `-c` flag.
`-q`, `--quiet`::
Be quiet. Do not show system dialogs.
`-Q, --query`:: `-Q, --query`::
Print all appointments inside a given query range, followed by all TODO 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 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 appointments file when using calcurse in non-interactive mode. The following
filters are currently supported: 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>`:: `--filter-type <type>`::
Ignore any items that do not match the type mask. The type mask is a 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`, 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 combining the `-` and `E` options, the `-` must come first. The default
format for the `(remaining)` specifier is `%EH:%M`. 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]] [[basics_invocation_variable]]
Environment variable for i18n Environment variable for i18n
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^