fyb/calcurse-edge
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve manual readability

Browse Source 
Signed-off-by: Lukas Fleischer <lfleischer@calcurse.org>
This commit is contained in:
Nitroretro 2019-12-24 09:54:06 +02:00 committed by Lukas Fleischer
parent 9266232170
commit 0cd8c210bd
1 changed files with 39 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
doc/manual.txt
View File

@ -176,10 +176,14 @@ long options are supported):
be specified using the `-c` flag. be specified using the `-c` flag.
`-c <file>, --calendar <file>`:: `-c <file>, --calendar <file>`::
Specify the calendar file to use. The default calendar is Specify the calendar file to use. The default calendar is located at
`$XDG_DATA_HOME/calcurse/apts` (`~/.local/share/calcurse/apts`) or `<datadir>/apts` (see section <<basics_files,calcurse files>>). This option
`~/.calcurse/apts` if `~/.calcurse` exists. (see section has precedence over `-D`.
<<basics_files,calcurse files>>). This option has precedence over `-D`.
`-C <dir>, --directory <dir>`::
Specify the configuration directory to use. See
<<basics_files,calcurse files>> for the default directory and for the
interaction with `-D`.
`-d <date|num>, --day <date|num>`:: `-d <date|num>, --day <date|num>`::
Print the appointments for the given date or for the given number of Print the appointments for the given date or for the given number of
@ -210,9 +214,8 @@ can be specified using the `-c` flag.
combined with `--to`. combined with `--to`.
`-D <dir>, --directory <dir>`:: `-D <dir>, --directory <dir>`::
Specify the data directory to use. If not specified, the default directory is Specify the (data) directory to use. See <<basics_files,calcurse files>> for
`$XDG_DATA_HOME/calcurse/` (`~/.local/share/calcurse/`) or `~/.calcurse` if the default directory and for the interaction with `-C`.
it exists.
`--filter-type <type>`:: `--filter-type <type>`::
Ignore any items that do not match the type mask. See Ignore any items that do not match the type mask. See
@ -634,13 +637,15 @@ The following environment variables affect the way `calcurse` operates:
Specifies the default viewer to be used for reading notes. If this variable Specifies the default viewer to be used for reading notes. If this variable
is not set, then `/usr/bin/less` is used. is not set, then `/usr/bin/less` is used.
See also <<basics_files,calcurse files>>.
Hooks Hooks
~~~~~ ~~~~~
You can place scripts in `$XDG_CONFIG_HOME/calcurse/hooks/` You can place scripts in `<confdir>/hooks/`
(`$HOME/.config/calcurse/hooks/`) to trigger actions at certain events. To (see section <<basics_files,calcurse files>>) to trigger actions at certain
enable a hook, add a script with one of the following names to this directory. events. To enable a hook, add a script with one of the following names to this
Also make sure the scripts are executable. directory. Also make sure the scripts are executable.
*pre-load*:: *pre-load*::
Executed before the data files are loaded. Executed before the data files are loaded.
@ -853,15 +858,28 @@ NOTE: To stop the daemon, just send the `TERM` signal to it, using a command
calcurse files calcurse files
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
The following structure is created in your `$XDG_CONFIG_HOME` (`$HOME/.config`) An alternative directory for 'both' the configuration files and the data
and in your `$XDG_DATA_HOME` (`$HOME/.local/share`) directories (or in the directory may be specified with the `-D` option.
directory you specified with the -D option) the first time calcurse is run:
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.
If +$HOME/.calcurse+ exists, then it will be used as the default for both the
data directory and the configuration directory.
---- ----
$XDG_DATA_HOME/calcurse/ $XDG_CONFIG_HOME/calcurse/ <datadir> <confdir>
|___notes/ |___conf | |
|___apts |___keys |__ apts |___ conf
|___todo |__ todo |___ keys
|__ notes/ |___ hooks/
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)
---- ----
`notes/`:: `notes/`::
this subdirectory contains descriptions of the notes which are attached to this subdirectory contains descriptions of the notes which are attached to
@ -877,6 +895,9 @@ $XDG_DATA_HOME/calcurse/ $XDG_CONFIG_HOME/calcurse/
this file contains the user configuration this file contains the user configuration
`keys`:: `keys`::
this file contains the user-defined key bindings this file contains the user-defined key bindings
`hooks/`::
this subdirectory contains scripts that you can use to trigger actions at
certain events (see <<_hooks,Hooks>>)
NOTE: If the logging of calcurse daemon activity was set in the notification NOTE: If the logging of calcurse daemon activity was set in the notification
configuration menu, the extra file `daemon.log` will appear in the configuration menu, the extra file `daemon.log` will appear in the