From 7538cbf2f13aeebce986383622ec2bd2095f6c40 Mon Sep 17 00:00:00 2001 From: Thomas Lauf Date: Fri, 15 Feb 2019 14:04:03 +0100 Subject: [PATCH] Extract documentation about configuration file into separate man page Signed-off-by: Thomas Lauf --- doc/man/timew-config.7.in | 136 +++++++++++++++++++++++++++++++++++++ doc/man/timew.1.in | 137 -------------------------------------- 2 files changed, 136 insertions(+), 137 deletions(-) create mode 100644 doc/man/timew-config.7.in diff --git a/doc/man/timew-config.7.in b/doc/man/timew-config.7.in new file mode 100644 index 00000000..2ce703f8 --- /dev/null +++ b/doc/man/timew-config.7.in @@ -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.= +. +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..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..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..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..hours = all +.br +Determines how the 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..lines = 1 +.br +Determines how many lines are used to render each day on the report. +Default value is '1'. +Type is one of 'month', 'week', 'day'. +. +.TP +.B reports..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..range = +.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..spacing = 1 +.br +Specifies how many spaces are inserted between the hours in the 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..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..summary = on +.br +Determines whether the hours summary is shown. +Default value is 'on'. +Type is one of 'month', 'week', 'day'. +. +.TP +.B reports..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..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..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'. diff --git a/doc/man/timew.1.in b/doc/man/timew.1.in index 26d196c6..a3115439 100644 --- a/doc/man/timew.1.in +++ b/doc/man/timew.1.in @@ -413,143 +413,6 @@ Supported DOM references are: . dom.rc. 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.= -. -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..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..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..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..hours = all -.br -Determines how the 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..lines = 1 -.br -Determines how many lines are used to render each day on the report. -Default value is '1'. -Type is one of 'month', 'week', 'day'. -. -.TP -.B reports..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..range = -.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..spacing = 1 -.br -Specifies how many spaces are inserted between the hours in the 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..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..summary = on -.br -Determines whether the hours summary is shown. -Default value is 'on'. -Type is one of 'month', 'week', 'day'. -. -.TP -.B reports..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..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..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: