summaryrefslogtreecommitdiff
path: root/doc/calcurse.1.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/calcurse.1.txt')
-rw-r--r--doc/calcurse.1.txt21
1 files changed, 14 insertions, 7 deletions
diff --git a/doc/calcurse.1.txt b/doc/calcurse.1.txt
index 86a2747..6868a64 100644
--- a/doc/calcurse.1.txt
+++ b/doc/calcurse.1.txt
@@ -61,8 +61,9 @@ Options
The following options are supported:
*-a*, *--appointment*::
- Print the appointments and events for the current day and exit. 'Note:' The calendar
- from which to read the appointments can be specified using the *-c* flag.
+ Print the appointments and events for the current day and exit. Equivalent to
+ *-Q --filter-type cal*. 'Note:' The calendar from which to read the
+ appointments can be specified using the *-c* flag.
*-c* <file>, *--calendar* <file>::
Specify the calendar file to use. The default calendar is *~/.calcurse/apts*
@@ -83,7 +84,9 @@ returned, while in the second case the appointment list for the *n* upcoming
days will be returned.
+
As an example, typing *calcurse -d 3* will display your appointments for
-today, tomorrow, and the day after tomorrow.
+today, tomorrow, and the day after tomorrow. The first form is equivalent to
+*-Q --filter-type cal --from <date>*, the second form is equivalent to *-Q
+--filter-type cal --days <num>*.
+
The date format used is the one specified in the ``General options''
menu. Four formats are available:
@@ -211,7 +214,8 @@ the *-c* flag.
*-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.
+ 'num' is given, a range of 1 day is considered. Equivalent to *-Q
+ --filter-type cal --days <num>*.
*--read-only*::
Don't save configuration nor appointments/todos.
@@ -221,11 +225,13 @@ in read-only mode, all changes from this session will be lost without warning!
*-s*[date], *--startday*[=date]::
Print events and appointments from 'date' and exit. If no 'date' is given,
- the current day is considered.
+ the current day is considered. Equivalent to *-Q --filter-type cal --from
+ <date>*.
*-S*<regex>, *--search*=<regex>::
When used with the *-a*, *-d*, *-r*, *-s*, or *-t* flag, print only the items
- having a description that matches the given regular expression.
+ having a description that matches the given regular expression. Equivalent to
+ *-Q --filter-pattern <regex>*.
*--status*::
Display the status of running instances of calcurse. If calcurse is
@@ -237,7 +243,8 @@ in read-only mode, all changes from this session will be lost without warning!
only todos having a priority equal to 'num' will be returned. The priority
number must be between 1 (highest) and 9 (lowest). It is also possible to
specify *0* for the priority, in which case only completed tasks will be
- shown.
+ shown. Equivalent to *-Q --filter-type todo*, combined with
+ *--filter-priority* and *--filter-completed* or *--filter-uncompleted*.
*--to* <date>::
Specify the end date of the range when used with *-Q*. Cannot be combined