mirror of
https://github.com/GothenburgBitFactory/timewarrior.git
synced 2025-06-26 10:54:28 +02:00
72 lines
2.2 KiB
Text
72 lines
2.2 KiB
Text
= timew-config(7)
|
|
|
|
== NAME
|
|
timew-config - Timewarrior configuration file and override options
|
|
|
|
== SYNOPSIS
|
|
**timew rc.**__<name>__**=**__<value>__ _<command>_
|
|
|
|
== DESCRIPTION
|
|
Timewarrior stores its configuration in the user's home directory in _~/.timewarrior/timewarrior.cfg_ on non-Unix systems (e.g. Windows).
|
|
|
|
On Unix systems, XDG Base Directory specification is supported, if _~/.timewarrior_ directory doesn't exist
|
|
(old config directory is still supported and has precedence over XDG BD compliant locations).
|
|
|
|
This means configuration is stored in _$XDG_CONFIG_HOME/timewarrior/timewarrior.cfg_, which defaults to _~/.config/timewarrior/timewarrior.cfg_ if _$XDG_CONFIG_HOME_ environment variable is not specified.
|
|
|
|
Those wanting to migrate their data to a new directory scheme, might do that with following shell snippet:
|
|
|
|
[source,shell]
|
|
----
|
|
LEGACY="${HOME}/.timewarrior"
|
|
CONFIG_DIR="${XDG_CONFIG_HOME:-$HOME/.config}/timewarrior"
|
|
DATA_DIR="${XDG_DATA_HOME:-$HOME/.local/share}/timewarrior"
|
|
mkdir -p "${CONFIG_DIR}"
|
|
mkdir -p "${DATA_DIR}"
|
|
mv "${LEGACY}/timewarrior.cfg" "${CONFIG_DIR}"
|
|
mv "${LEGACY}/extensions" "${CONFIG_DIR}"
|
|
mv "${LEGACY}/data" "${DATA_DIR}"
|
|
rmdir "${LEGACY}"
|
|
----
|
|
|
|
This file contains a mix of rules and configuration settings.
|
|
Note that the TIMEWARRIORDB environment variable can be set to override this location.
|
|
|
|
The values 'true', '1', 'y', 'yes' and 'on' are all equivalent and enable a setting.
|
|
Any other value means disable the setting.
|
|
|
|
Default values may be overridden by timewarrior.cfg values, which may in turn be overridden on the command line using: **rc.**__<name>__**=**__<value>__
|
|
|
|
For example, to turn off verbose mode:
|
|
|
|
rc.verbose=0
|
|
|
|
Note that hints can also do this (:quiet).
|
|
|
|
== CONFIGURATION
|
|
|
|
*confirmation*::
|
|
Determines whether harmful operations require interactive confirmation.
|
|
+
|
|
May be overridden by the ':yes' hint.
|
|
+
|
|
Default value is 'yes'.
|
|
|
|
*verbose*::
|
|
Determines whether Timewarrior generates feedback.
|
|
+
|
|
May be overridden by the ':quiet' hint.
|
|
+
|
|
Default value is 'yes'.
|
|
|
|
*debug*::
|
|
Determines whether diagnostic debugging information is shown.
|
|
+
|
|
Useful for troubleshooting, but not for general use.
|
|
+
|
|
Default value is 'off'.
|
|
|
|
*debug.indicator*::
|
|
The debug output prefix string.
|
|
+
|
|
Default value is '>>'.
|