timew-config - Man Page

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:

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 '>>'.

Referenced By

timew(1).

2024-11-14 timew 1.7.1 User Manuals