diff options
Diffstat (limited to 'doc/calcurse.1.txt')
| -rw-r--r-- | doc/calcurse.1.txt | 134 |
1 files changed, 127 insertions, 7 deletions
diff --git a/doc/calcurse.1.txt b/doc/calcurse.1.txt index 884aa34..6768088 100644 --- a/doc/calcurse.1.txt +++ b/doc/calcurse.1.txt @@ -1,6 +1,6 @@ //// /* - * Copyright (c) 2004-2011 calcurse Development Team <misc@calcurse.org> + * Copyright (c) 2004-2012 calcurse Development Team <misc@calcurse.org> * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -42,7 +42,7 @@ Synopsis -------- [verse] -*calcurse* [*-h*|*-v*] [*-N*] [*-an*] [*-t*[num]] [*-c*<file> | *-D*<dir>] +*calcurse* [*-h*|*-v*] [*-an*] [*-t*[num]] [*-c*<file> | *-D*<dir>] [*-i*<file>] [*-x*[format]] [*-d* <date>|<num>] [*-s*[date]] [*-r*[range]] [*-S* <regex>] [*--status*] @@ -103,6 +103,32 @@ appointments can be specified using the *-c* flag. Specify the data directory to use. This option is incompatible with -c. If not specified, the default directory is *~/.calcurse/*. +*--format-apt* <format>:: + Specify a format to control the output of appointments in non-interactive + mode. See the 'FORMAT STRINGS' section for detailed information on format + strings. + +*--format-recur-apt* <format>:: + Specify a format to control the output of recurrent appointments in + non-interactive mode. See the 'FORMAT STRINGS' section for detailed + information on format strings. + +*--format-event* <format>:: + Specify a format to control the output of events in non-interactive mode. See + the 'FORMAT STRINGS' section for detailed information on format strings. + +*--format-recur-event* <format>:: + Specify a format to control the output of recurrent events in non-interactive + mode. See the 'FORMAT STRINGS' section for detailed information on format + strings. + +*--format-todo* <format>:: + 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. + +*-g*, *--gc*:: + Run the garbage collector for note files and exit. + *-h*, *--help*:: Print a short help text describing the supported command-line options, and exit. @@ -117,14 +143,16 @@ appointments can be specified using the *-c* flag. 'Note:' the calendar from which to read the appointments can be specified using the *-c* flag. -*-N*, *--note*:: - When used with the *-a* or *-t* flag, also print note content if one is - associated with the displayed item. - *-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. +*--read-only*:: + Don't save configuration nor appointments/todos. ++ +'Warning:' Use this this with care! If you run an interactive calcurse instance +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. @@ -161,6 +189,98 @@ such as: $ 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. + +Format strings +-------------- + +Format strings are composed of printf()-style format specifiers -- ordinary +characters are copied to stdout without modification. Each specifier is +introduced by a *%* and is followed by a character which specifies the field to +print. The set of available fields depends on the item type. + +Format specifiers for appointments +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +*s*:: + Print the start time of the appointment as UNIX time stamp +*S*:: + Print the start time of the appointment using the *hh:mm* format +*d*:: + Print the duration of the appointment in seconds +*e*:: + Print the end time of the appointment as UNIX time stamp +*E*:: + Print the end time of the appointment using the *hh:mm* format +*m*:: + Print the description of the item +*n*:: + Print the name of the note file belonging to the item +*N*:: + Print the note belonging to the item + +Format specifiers for events +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +*m*:: + Print the description of the item +*n*:: + Print the name of the note file belonging to the item +*N*:: + Print the note belonging to the item + +Format specifiers for todo items +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +*p*:: + Print the priority of the item +*m*:: + Print the description of the item +*n*:: + Print the name of the note file belonging to the item +*N*:: + Print the note belonging to the item + +Examples +~~~~~~~~ + +*`calcurse -r7 --format-apt='- %S -> %E\n\t%m\n%N'`*:: + Print appointments and events for the next seven days. Also, print the notes + attached to each regular appointment (simulates *-N* for appointments). + +*`calcurse -r7 --format-apt=' - %m (%S to %E)\n' --format-recur-apt=' - %m (%S to %E)\n'`*:: + Print appointments and events for the next seven days and use a custom format + for (recurrent) appointments: * - Some appointment (18:30 to 21:30)*. + +*`calcurse -t --format-todo '(%p) %m\n'`*:: + List all todo items and put parentheses around the priority specifiers. + +Extended format specifiers +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Extended format specifiers can be used if you want to specify advanced +formatting options. Extended specifiers are introduced by *%(* and are +terminated by a closing parenthesis (*)*). The following list includes all +short specifiers and corresponding long options: + +* *s*: *(start)* +* *S*: *(start:epoch)* +* *d*: *(duration)* +* *e*: *(end)* +* *E*: *(end:epoch)* +* *m*: *(message)* +* *n*: *(noteid)* +* *N*: *(note)* +* *p*: *(priority)* + +The *(start)* and *(end)* specifiers support strftime()-style extended +formatting options that can be used for fine-grained formatting. Additionally, +the special formats *epoch* (which is equivalent to *(start:%s)* or *(end:%s)*) +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. + Notes ----- @@ -271,5 +391,5 @@ Authors Copyright --------- -Copyright (c) 2004-2011 calcurse Development Team. +Copyright (c) 2004-2012 calcurse Development Team. This software is released under the BSD License. |