Document extended format specifiers

Add documentation for extended format specifiers (which were introduced
in 68b26ff85415ee687b082fbd5150de58cdce0935) to the man page and the
manual. Add a note about strftime()-style extended formats for
"%(start)" and "%(end)".

Signed-off-by: Lukas Fleischer <calcurse@cryptocrack.de>
This commit is contained in:
Lukas Fleischer 2012-05-23 02:04:59 +02:00
parent 94a5d4cb1b
commit 9719de8ea3
2 changed files with 50 additions and 0 deletions

View File

@ -256,6 +256,31 @@ Examples
*`calcurse -t --format-todo '(%p) %m\n'`*:: *`calcurse -t --format-todo '(%p) %m\n'`*::
List all todo items and put parenthesesaround the priority specifiers. List all todo items and put parenthesesaround 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 Notes
----- -----

View File

@ -366,6 +366,31 @@ Examples
`calcurse -t --format-todo '(%p) %m\n'`:: `calcurse -t --format-todo '(%p) %m\n'`::
List all todo items and put parenthesesaround the priority specifiers. List all todo items and put parenthesesaround 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.
[[basics_invocation_variable]] [[basics_invocation_variable]]
Environment variable for i18n Environment variable for i18n
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^