From 65963f96e8fd1c43ec1b82dda8e6a7ed51b87794 Mon Sep 17 00:00:00 2001 From: Lukas Fleischer Date: Sat, 7 Feb 2015 10:39:29 +0100 Subject: Document new options Document the query and grep modes, as well as the new filter interface, in the man page and in the user manual. Signed-off-by: Lukas Fleischer --- doc/calcurse.1.txt | 127 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 127 insertions(+) (limited to 'doc/calcurse.1.txt') diff --git a/doc/calcurse.1.txt b/doc/calcurse.1.txt index 4b10d80..86a2747 100644 --- a/doc/calcurse.1.txt +++ b/doc/calcurse.1.txt @@ -98,10 +98,60 @@ menu. Four formats are available: 'Note:' as for the *-a* flag, the calendar from which to read the appointments can be specified using the *-c* flag. +*--days* :: + Specify the length of the range (in days) when used with *-Q*. Cannot be + combined with *--to*. + *-D* , *--directory* :: Specify the data directory to use. If not specified, the default directory is *~/.calcurse/*. +*--filter-type* :: + Ignore any items that do not match the type mask. See 'FILTERS' for details. + +*--filter-pattern* :: + Ignore any items with a description that does not match the pattern. See + 'FILTERS' for details. + +*--filter-start-from* :: + Ignore any items that start before a given date. See 'FILTERS' for details. + +*--filter-start-to* :: + Ignore any items that start after a given date. See 'FILTERS' for details. + +*--filter-start-after* :: + Only include items that start after a given date. See 'FILTERS' for details. + +*--filter-start-before* :: + Only include items that start before a given date. See 'FILTERS' for details. + +*--filter-start-range* :: + Only include items within a given range. See 'FILTERS' for details. + +*--filter-end-from* :: + Ignore any items that end before a given date. See 'FILTERS' for details. + +*--filter-end-to* :: + Ignore any items that end after a given date. See 'FILTERS' for details. + +*--filter-end-after* :: + Only include items that end after a given date. See 'FILTERS' for details. + +*--filter-end-before* :: + Only include items that end before a given date. See 'FILTERS' for details. + +*--filter-end-range* :: + Only include items within a given range. See 'FILTERS' for details. + +*--filter-priority* :: + Only include items with a given priority. See 'FILTERS' for details. + +*--filter-completed*:: + Only include completed TODO items. See 'FILTERS' for details. + +*--filter-uncompleted*:: + Only include uncompleted TODO items. See 'FILTERS' for details. + *--format-apt* :: Specify a format to control the output of appointments in non-interactive mode. See the 'FORMAT STRINGS' section for detailed information on format @@ -125,9 +175,17 @@ appointments can be specified using the *-c* flag. Specify a format to control the output of todo items in non-interactive mode. See the 'FORMAT STRINGS' section for detailed information on format strings. +*--from* :: + Specify the start date of the range when used with *-Q*. + *-g*, *--gc*:: Run the garbage collector for note files and exit. +*-G*, *--grep*:: + Print appointments and TODO items using the calcurse data file format. The + filter interface can be used to further restrict the output. See also: + 'FILTERS'. + *-h*, *--help*:: Print a short help text describing the supported command-line options, and exit. @@ -145,6 +203,12 @@ 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*, *--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 + using the *--from* and *--to* (or *--days*) parameters. The filter interface + can be used to further restrict the output. See also: 'FILTERS'. + *-r*[num], *--range*[=num]:: Print events and appointments for the 'num' number of days and exit. If no 'num' is given, a range of 1 day is considered. @@ -175,6 +239,10 @@ in read-only mode, all changes from this session will be lost without warning! specify *0* for the priority, in which case only completed tasks will be shown. +*--to* :: + Specify the end date of the range when used with *-Q*. Cannot be combined + with *--days*. + *-v*, *--version*:: Display *calcurse* version and exit. @@ -194,6 +262,65 @@ $ calcurse --export > my_data.dat 'Note:' The *-N* option has been removed in calcurse 3.0.0. See the 'FORMAT STRINGS' section on how to print note along with appointments and events. +Filters +------- + +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-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', + 'recur-event', 'recur-apt' and 'todo'. You can also use 'recur' as a + shorthand for 'recur-event,recur-apt' and 'cal' as a shorthand for + 'event,apt,recur'. + +*--filter-pattern* :: + Ignore any items with a description that does not match the pattern. The + pattern is interpreted as extended regular expression. + +*--filter-start-from* :: + Ignore any items that start before a given date. + +*--filter-start-to* :: + Ignore any items that start after a given date. + +*--filter-start-after* :: + Only include items that start after a given date. + +*--filter-start-before* :: + Only include items that start before a given date. + +*--filter-start-range* :: + Only include items with a start date that falls within a given range. A range + consists of a start date and an end date, separated by a comma. + +*--filter-end-from* :: + Ignore any items that end before a given date. + +*--filter-end-to* :: + Ignore any items that end after a given date. + +*--filter-end-after* :: + Only include items that end after a given date. + +*--filter-end-before* :: + Only include items that end before a given date. + +*--filter-end-range* :: + Only include items with an end date that falls within a given range. A range + consists of a start date and an end date, separated by a comma. + +*--filter-priority* :: + Only include items with a given priority. + +*--filter-completed*:: + Only include completed TODO items. + +*--filter-uncompleted*:: + Only include uncompleted TODO items. + Format strings -------------- -- cgit v1.2.3-54-g00ecf