Merge pull request #273 from simonhoffmann/sh-improve-doc

Improve docs: clarify report variable and add command line options
This commit is contained in:
Dheepak Krishnamurthy 2021-09-06 04:16:12 -06:00 committed by GitHub
commit e587e36dd8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,5 +1,7 @@
# Advanced configuration
## `taskrc` config file options:
Other `taskwarrior-tui` configuration options are possible using the user defined attribute feature of `taskwarrior`.
All `taskwarrior-tui` specific configuration options will begin with `uda.taskwarrior-tui.`.
The following is a full list of all the options available and their default values implemented by `taskwarrior-tui` if not defined in your `taskrc` file.
@ -25,6 +27,12 @@ uda.taskwarrior-tui.style.calendar.title=black on rgb444
uda.taskwarrior-tui.task-report.next.filter=$(task show report.next.filter)
```
The `uda.taskwarrior-tui.task-report.next.filter` variable defines the default view at program startup. Set this to any preconfigured report (`task reports`), or create your own report in taskwarrior and specify its name here.
## commandline options:
`-r`: specify a report to be shown, overrides `uda.taskwarrior-tui.task-report.next.filter` for this instance
## Configure user defined shortcuts:
You can configure shortcuts to execute custom commands from your `taskwarrior`'s `taskrc` file (default: `~/.taskrc`).