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

Improve man page readability

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

43
doc/calcurse.1.txt
View File

@ -143,22 +143,17 @@ are marked "('also interactively')".
*-c* 'file', *--calendar* 'file':: *-c* 'file', *--calendar* 'file'::
('also interactively') Specify the calendar file to use. The default ('also interactively') Specify the calendar file to use. The default
calendar is *$XDG_DATA_HOME/apts* (*\~/.local/share/calcurse/apts*) or calendar is located at *<datadir>/apts* (see <<_files,FILES>>). If 'file' is
*\~/.calcurse/apts* if *~/.calcurse* exists. (see <<_files,FILES>>). If not an absolute path name, it is interpreted relative to the current working
'file' is not an absolute path name, it is interpreted relative to the current directory. The option has precedence over *-D*.
working directory. The option has precedence over *-D*.
*-C* 'dir', *--confdir* 'dir':: *-C* 'dir', *--confdir* 'dir'::
('also interactively') Specify the configuration directory to use. If not ('also interactively') Specify the configuration directory to use. See section
specified, the default directory is *$XDG_CONFIG_HOME/calcurse/* <<_files,FILES>> for the default directory and the interaction with *-D*.
(*\~/.config/calcurse/*) or *~/.calcurse* if it exists. See <<_files,FILES>>
for the interaction with *-D*.
*-D* 'dir', *--datadir* 'dir':: *-D* 'dir', *--datadir* 'dir'::
('also interactively') Specify the (data) directory to use. If not specified, ('also interactively') Specify the (data) directory to use. See section
the default directory is *$XDG_DATA_HOME/calcurse* <<_files,FILES>> for the default directory and the interaction with *-C*.
(*\~/.local/share/calcurse/*) or *~/.calcurse* if it exists. See section
<<_files,FILES>> for the interaction with *-C*.
*-d* 'date|num', *--day* 'date|num':: *-d* 'date|num', *--day* 'date|num'::
Print appointments and events for the given date or given range of days, Print appointments and events for the given date or given range of days,
@ -631,8 +626,8 @@ $XDG_DATA_HOME/calcurse/ $XDG_CONFIG_HOME/calcurse/
|___todo |___keys |___todo |___keys
---- ----
+$XDG_DATA_HOME+ defaults to +\~/.local/share+ and +$XDG_CONFIG_HOME+ defaults to +$XDG_DATA_HOME+ defaults to +$HOME/.local/share+ and +$XDG_CONFIG_HOME+
+~/.config+. defaults to +$HOME/.config+.
The files are of two different kinds: data and configuration. The data files The files are of two different kinds: data and configuration. The data files
constitute the calcurse database and are independent of the calcurse release constitute the calcurse database and are independent of the calcurse release
@ -664,15 +659,13 @@ scripts, see <<_hooks,Hooks>>.
Directory configuration Directory configuration
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
An alternative directory to the defaults +$XDG_DATA_HOME/calcurse+ An alternative directory for 'both' the configuration files and the data
(+$HOME/.local/share/calcurse+) and +$XDG_CONFIG_HOME/calcurse+ directory may be specified with the *-D* option.
(+$HOME/.config/calcurse+) may be specified with the *-D* option.
An alternative directory for the configuration files 'only' may be specified 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 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 directory or in the directory specified by *-D*. If both *-D* and *-C* are
*-C* are present, configuration files in the data directory, if any, are present, configuration files in the data directory, if any, are ignored.
ignored.
If +$HOME/.calcurse+ exists, then it will be used as the default for both the If +$HOME/.calcurse+ exists, then it will be used as the default for both the
data directory and the configuration directory. data directory and the configuration directory.
@ -702,10 +695,10 @@ $ calcurse -C "$HOME/.config/calcurse/config"
Hooks Hooks
~~~~~ ~~~~~
Scripts placed in +$XDG_CONFIG_HOME/calcurse/hooks/+ Scripts placed in +<confdir>/calcurse/hooks/+
(+$HOME/.config/calcurse/hooks+) trigger actions at certain events. To enable a (see <<_directory_configuration,Directory configuration>>) trigger actions at
hook, add a script with one of the following names to this directory. Also make certain events. To enable a hook, add a script with one of the following names
sure the script is executable. to this directory. Also make sure the script is executable.
*pre-load*:: *pre-load*::
Executed before the data files are loaded. Executed before the data files are loaded.
@ -739,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+. 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. The program is called with two file names as the only arguments.
See also <<_files,FILES>>.
BUGS BUGS
---- ----