mirror of
https://github.com/GothenburgBitFactory/timewarrior.git
synced 2025-07-07 20:06:39 +02:00
Extract documentation about configuration file into separate man page
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
This commit is contained in:
Thomas Lauf
parent
bbf0e059ce
commit
7538cbf2f1
2 changed files with 136 additions and 137 deletions
136
doc/man/timew-config.7.in
Normal file
136
doc/man/timew-config.7.in
Normal file
|
|
@ -0,0 +1,136 @@
|
|||
.SH CONFIGURATION FILE AND OVERRIDE OPTIONS
|
||||
Timewarrior stores its configuration in a file in the user's home directory:
|
||||
~/.timewarrior/timewarrior.cfg.
|
||||
.
|
||||
This file contains a mix of rules and configuration settings.
|
||||
Note that the environment variable $TIMEWARRIORDB 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).
|
||||
.
|
||||
.TP
|
||||
.B confirmation = yes
|
||||
Determines whether harmful operations require interactive confirmation.
|
||||
May be overridden by the ':yes' hint.
|
||||
Default value is 'yes'.
|
||||
.
|
||||
.TP
|
||||
.B debug = off
|
||||
Determines whether diagnostic debugging information is shown.
|
||||
Useful for troubleshooting, but not for general use.
|
||||
Default value is 'off'.
|
||||
.
|
||||
.TP
|
||||
.B debug.indicator = >>
|
||||
The debug output prefix string.
|
||||
Default value is '>>'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.cell = 15
|
||||
.br
|
||||
Determines how many minutes are represented by a single character cell, for the charts.
|
||||
A value of '15' means that an hour is represented by 60/15, or 4 character cells.
|
||||
Suitable values are the divisors of 60 (30, 20, 15, 12, ...).
|
||||
The value must be greater than '0'.
|
||||
Default value is '15'.
|
||||
Type is one of 'month', 'week', 'day'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.day = yes
|
||||
.br
|
||||
Determines whether the current day of the month is shown at left margin.
|
||||
Default value is 'yes'.
|
||||
Type is one of 'month', 'week', 'day'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.holidays = yes
|
||||
.br
|
||||
Determines whether relevant holidays are shown beneath the report.
|
||||
Default value is 'yes'.
|
||||
Type is one of 'month', 'week', 'day', 'summary'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.hours = all
|
||||
.br
|
||||
Determines how the <type> report shows all the hours in a day ('all'), or is limited to only hours where data is tracked ('auto').
|
||||
Default value is 'all'.
|
||||
Type is one of 'month', 'week', 'day'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.lines = 1
|
||||
.br
|
||||
Determines how many lines are used to render each day on the <type> report.
|
||||
Default value is '1'.
|
||||
Type is one of 'month', 'week', 'day'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.month = yes
|
||||
.br
|
||||
Determines whether the current month is shown at left margin.
|
||||
Default value is 'yes'.
|
||||
Type is one of 'month', 'week', 'day'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.range = <range hint>
|
||||
.br
|
||||
For reports that show a range of data, this setting will override the default value.
|
||||
The value should be a range hint, see 'hints'
|
||||
Type is one of 'gaps', 'day', 'week', 'month'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.spacing = 1
|
||||
.br
|
||||
Specifies how many spaces are inserted between the hours in the <type> report exclusions.
|
||||
A value of '0' yields a more compact report.
|
||||
Default value is '1'.
|
||||
Type is one of 'month', 'week', 'day'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.axis = external
|
||||
.br
|
||||
The value 'internal' puts the hour markers (time line at the top) inside the exclusion blocks, 'external' puts the hour markers in a separate line; additional values might be defined in the future.
|
||||
Default is 'internal' for the day report and 'external' for other reports.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.summary = on
|
||||
.br
|
||||
Determines whether the hours summary is shown.
|
||||
Default value is 'on'.
|
||||
Type is one of 'month', 'week', 'day'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.totals = on
|
||||
.br
|
||||
Determines whether the time totals are shown for each day on the report.
|
||||
Default value is 'on'.
|
||||
Type is one of 'month', 'week', 'day'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.week = yes
|
||||
.br
|
||||
Determines whether the current week number is shown at left margin.
|
||||
Default value is 'yes'.
|
||||
Type is one of 'month', 'week', 'day'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.weekday = yes
|
||||
.br
|
||||
Determines whether the current weekday is shown at left margin.
|
||||
Default value is 'yes'.
|
||||
Type is one of 'month', 'week', 'day'.
|
||||
.
|
||||
.TP
|
||||
.B verbose = yes
|
||||
Determines whether Timewarrior generates feedback.
|
||||
May be overridden by the ':quiet' hint.
|
||||
Default value is 'yes'.
|
||||
|
|
@ -413,143 +413,6 @@ Supported DOM references are:
|
|||
.
|
||||
dom.rc.<name> Configuration setting
|
||||
.
|
||||
.SH CONFIGURATION FILE AND OVERRIDE OPTIONS
|
||||
Timewarrior stores its configuration in a file in the user's home directory:
|
||||
~/.timewarrior/timewarrior.cfg.
|
||||
.
|
||||
This file contains a mix of rules and configuration settings.
|
||||
Note that the environment variable $TIMEWARRIORDB 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).
|
||||
.
|
||||
.TP
|
||||
.B confirmation = yes
|
||||
Determines whether harmful operations require interactive confirmation.
|
||||
May be overridden by the ':yes' hint.
|
||||
Default value is 'yes'.
|
||||
.
|
||||
.TP
|
||||
.B debug = off
|
||||
Determines whether diagnostic debugging information is shown.
|
||||
Useful for troubleshooting, but not for general use.
|
||||
Default value is 'off'.
|
||||
.
|
||||
.TP
|
||||
.B debug.indicator = >>
|
||||
The debug output prefix string.
|
||||
Default value is '>>'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.cell = 15
|
||||
.br
|
||||
Determines how many minutes are represented by a single character cell, for the charts.
|
||||
A value of '15' means that an hour is represented by 60/15, or 4 character cells.
|
||||
Suitable values are the divisors of 60 (30, 20, 15, 12, ...).
|
||||
The value must be greater than '0'.
|
||||
Default value is '15'.
|
||||
Type is one of 'month', 'week', 'day'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.day = yes
|
||||
.br
|
||||
Determines whether the current day of the month is shown at left margin.
|
||||
Default value is 'yes'.
|
||||
Type is one of 'month', 'week', 'day'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.holidays = yes
|
||||
.br
|
||||
Determines whether relevant holidays are shown beneath the report.
|
||||
Default value is 'yes'.
|
||||
Type is one of 'month', 'week', 'day', 'summary'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.hours = all
|
||||
.br
|
||||
Determines how the <type> report shows all the hours in a day ('all'), or is limited to only hours where data is tracked ('auto').
|
||||
Default value is 'all'.
|
||||
Type is one of 'month', 'week', 'day'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.lines = 1
|
||||
.br
|
||||
Determines how many lines are used to render each day on the <type> report.
|
||||
Default value is '1'.
|
||||
Type is one of 'month', 'week', 'day'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.month = yes
|
||||
.br
|
||||
Determines whether the current month is shown at left margin.
|
||||
Default value is 'yes'.
|
||||
Type is one of 'month', 'week', 'day'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.range = <range hint>
|
||||
.br
|
||||
For reports that show a range of data, this setting will override the default value.
|
||||
The value should be a range hint, see 'hints'
|
||||
Type is one of 'gaps', 'day', 'week', 'month'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.spacing = 1
|
||||
.br
|
||||
Specifies how many spaces are inserted between the hours in the <type> report exclusions.
|
||||
A value of '0' yields a more compact report.
|
||||
Default value is '1'.
|
||||
Type is one of 'month', 'week', 'day'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.axis = external
|
||||
.br
|
||||
The value 'internal' puts the hour markers (time line at the top) inside the exclusion blocks, 'external' puts the hour markers in a separate line; additional values might be defined in the future.
|
||||
Default is 'internal' for the day report and 'external' for other reports.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.summary = on
|
||||
.br
|
||||
Determines whether the hours summary is shown.
|
||||
Default value is 'on'.
|
||||
Type is one of 'month', 'week', 'day'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.totals = on
|
||||
.br
|
||||
Determines whether the time totals are shown for each day on the report.
|
||||
Default value is 'on'.
|
||||
Type is one of 'month', 'week', 'day'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.week = yes
|
||||
.br
|
||||
Determines whether the current week number is shown at left margin.
|
||||
Default value is 'yes'.
|
||||
Type is one of 'month', 'week', 'day'.
|
||||
.
|
||||
.TP
|
||||
.B reports.<type>.weekday = yes
|
||||
.br
|
||||
Determines whether the current weekday is shown at left margin.
|
||||
Default value is 'yes'.
|
||||
Type is one of 'month', 'week', 'day'.
|
||||
.
|
||||
.TP
|
||||
.B verbose = yes
|
||||
Determines whether Timewarrior generates feedback.
|
||||
May be overridden by the ':quiet' hint.
|
||||
Default value is 'yes'.
|
||||
.
|
||||
.SH "MORE EXAMPLES"
|
||||
.
|
||||
For examples please see the online documentation starting at:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue