diff options
Diffstat (limited to 'doc/calcurse.1.txt')
| -rw-r--r-- | doc/calcurse.1.txt | 70 |
1 files changed, 38 insertions, 32 deletions
diff --git a/doc/calcurse.1.txt b/doc/calcurse.1.txt index 13297cf..1f79f9a 100644 --- a/doc/calcurse.1.txt +++ b/doc/calcurse.1.txt @@ -1,6 +1,6 @@ //// /* - * Copyright (c) 2004-2017 calcurse Development Team <misc@calcurse.org> + * Copyright (c) 2004-2023 calcurse Development Team <misc@calcurse.org> * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -57,7 +57,7 @@ The first form shows how to invoke calcurse interactively; the remainder is command line forms. The second form shows queries (as opposed to interactive use). For -convenience, common queries have abbriviated forms shown in the third line. +convenience, common queries have abbreviated forms shown in the third line. All queries may be combined with filter options as well as format options. The fourth form shows operations on the calcurse data files, one for @@ -91,11 +91,11 @@ and issue reminders; it stops automatically when the interactive mode is reentered. This man page mainly describes the command-line mode. The following two -subsections contain some general desriptions of command line options and usage. +subsections contain some general descriptions of command line options and usage. Input and Output Date Format ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Many options require a 'date' argument, and query results per day are set apart +Many options require a 'date' argument, and query results per day are set apart by a leading 'date line'. The input format of 'date' options and the output format of 'date lines' are @@ -143,19 +143,17 @@ are marked "('also interactively')". *-c* 'file', *--calendar* 'file':: ('also interactively') Specify the calendar file to use. The default - calendar is *~/.calcurse/apts* (see <<_files,FILES>>). If 'file' is not an - absolute path name, it is interpreted relative to the current working + calendar is located at *<datadir>/apts* (see <<_files,FILES>>). If 'file' is + not an absolute path name, it is interpreted relative to the current working directory. The option has precedence over *-D*. *-C* 'dir', *--confdir* 'dir':: - ('also interactively') Specify the configuration directory to use. If not - specified, the default directory is *~/.calcurse/*. See <<_files,FILES>> for - the interaction with *-D*. + ('also interactively') Specify the configuration directory to use. See section + <<_files,FILES>> for the default directory and the interaction with *-D*. *-D* 'dir', *--datadir* 'dir':: - ('also interactively') Specify the (data) directory to use. If not specified, - the default directory is *~/.calcurse/*. See section <<_files,FILES>> for - the interaction with *-C*. + ('also interactively') Specify the (data) directory to use. See section + <<_files,FILES>> for the default directory and the interaction with *-C*. *-d* 'date|num', *--day* 'date|num':: Print appointments and events for the given date or given range of days, @@ -192,7 +190,7 @@ displays those for yesterday and today. The first form is equivalent to *-Q <<_format_options,Format Options>>. *--export-uid*:: - When exporting items, add the hash of each item to the exported object as an + When exporting items, add the hash of each item to the exported object as a UID property. *--from* 'date':: @@ -208,7 +206,7 @@ displays those for yesterday and today. The first form is equivalent to *-Q *-g*, *--gc*:: Run the garbage collector for note files. The garbage collector removes files from the +notes+ directory (see <<_files,FILES>>) that are no longer - linked to an item. Ususally done automatically by setting the configuration + linked to an item. Usually done automatically by setting the configuration option +general.autogc+ in the 'General Options' submenu in interactive mode. *-G*, *--grep*:: @@ -622,15 +620,15 @@ The following structure is created by default in your home directory the first time calcurse is run without any options: ---- -$HOME/.calcurse/ - |___apts - |___conf - |___hooks/ - |___keys - |___notes/ - |___todo +$XDG_DATA_HOME/calcurse/ $XDG_CONFIG_HOME/calcurse/ + |___apts |___conf + |___notes/ |___hooks/ + |___todo |___keys ---- ++$XDG_DATA_HOME+ defaults to +$HOME/.local/share+ and +$XDG_CONFIG_HOME+ +defaults to +$HOME/.config+. + The files are of two different kinds: data and configuration. The data files constitute the calcurse database and are independent of the calcurse release version; the configuration files depend on the calcurse version although @@ -661,14 +659,16 @@ scripts, see <<_hooks,Hooks>>. Directory configuration ~~~~~~~~~~~~~~~~~~~~~~~ -An alternative directory to the default +$HOME/.calcurse+ may be specified -with the *-D* option. +An alternative directory for 'both' the configuration files and the data +directory may be specified with the *-D* option. An alternative directory for the configuration files 'only' may be specified with the *-C* option; in that case data files are either in the default -directory or in the directory specified by *-D*. If both *-D* and -*-C* are present, configuration files in the data directory, if any, are -ignored. +directory or in the directory specified by *-D*. If both *-D* and *-C* are +present, configuration files in the data directory, if any, are ignored. + +If +$HOME/.calcurse+ exists, then it will be used as the default for both the +data directory and the configuration directory. ---- <datadir> <confdir> @@ -677,7 +677,10 @@ ignored. |__ todo |___ keys |__ notes/ |___ hooks/ -default for both: $HOME/.calcurse/ +defaults: + <datadir>: $XDG_DATA_HOME/calcurse ($HOME/.local/share/calcurse) + <confdir>: $XDG_CONFIG_HOME/calcurse ($HOME/.config/calcurse) + both: $HOME/.calcurse (only if it exists) ---- calcurse may switch between two configuration setups, but still access @@ -686,15 +689,16 @@ the same data files e.g. with: ---- $ calcurse -$ calcurse -C "$HOME/.calcurse/config" +$ calcurse -C "$HOME/.config/calcurse/config" ---- Hooks ~~~~~ -Scripts placed in +$HOME/.calcurse/hooks/+ trigger actions at certain -events. To enable a hook, add a script with one of the following names to this -directory. Also make sure the script is executable. +Scripts placed in +<confdir>/calcurse/hooks/+ +(see <<_directory_configuration,Directory configuration>>) trigger actions at +certain events. To enable a hook, add a script with one of the following names +to this directory. Also make sure the script is executable. *pre-load*:: Executed before the data files are loaded. @@ -728,6 +732,8 @@ A few environment variables affect how calcurse operates. Tool used to merge two files to solve a save conflict. Default is +vimdiff+. The program is called with two file names as the only arguments. +See also <<_files,FILES>>. + BUGS ---- @@ -758,5 +764,5 @@ AUTHORS COPYRIGHT --------- -Copyright (c) 2004-2018 calcurse Development Team. +Copyright (c) 2004-2023 calcurse Development Team. This software is released under the BSD License. |