Merge branches 'enh/cfg-verbose', 'doc/readme-config' and 'rename-completion'
This commit is contained in:
2
Makefile
2
Makefile
@@ -64,7 +64,7 @@ clean: test-pre-clean
|
|||||||
|
|
||||||
install: installdirs
|
install: installdirs
|
||||||
$(INSTALL_PROGRAM) todo.sh $(DESTDIR)$(bindir)/todo.sh
|
$(INSTALL_PROGRAM) todo.sh $(DESTDIR)$(bindir)/todo.sh
|
||||||
$(INSTALL_DATA) todo_completion $(DESTDIR)$(datarootdir)/todo
|
$(INSTALL_DATA) todo_completion $(DESTDIR)$(datarootdir)/todo.sh
|
||||||
[ -e $(DESTDIR)$(sysconfdir)/todo/config ] || \
|
[ -e $(DESTDIR)$(sysconfdir)/todo/config ] || \
|
||||||
sed "s/^\(export[ \t]*TODO_DIR=\).*/\1~\/.todo/" todo.cfg > $(DESTDIR)$(sysconfdir)/todo/config
|
sed "s/^\(export[ \t]*TODO_DIR=\).*/\1~\/.todo/" todo.cfg > $(DESTDIR)$(sysconfdir)/todo/config
|
||||||
|
|
||||||
|
|||||||
@@ -46,7 +46,7 @@ make test
|
|||||||
*NOTE:* Makefile defaults to several default paths for installed files. Adjust to your system:
|
*NOTE:* Makefile defaults to several default paths for installed files. Adjust to your system:
|
||||||
|
|
||||||
- `INSTALL_DIR`: PATH for executables (default /usr/local/bin)
|
- `INSTALL_DIR`: PATH for executables (default /usr/local/bin)
|
||||||
- `CONFIG_DIR`: PATH for todo.txt config
|
- `CONFIG_DIR`: PATH for the todo.txt configuration template
|
||||||
- `BASH_COMPLETION`: PATH for autocompletion scripts (default to /etc/bash_completion.d)
|
- `BASH_COMPLETION`: PATH for autocompletion scripts (default to /etc/bash_completion.d)
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
@@ -58,6 +58,11 @@ make install CONFIG_DIR=/etc INSTALL_DIR=/usr/bin BASH_COMPLETION=/usr/share/bas
|
|||||||
https://aur.archlinux.org/packages/todotxt/
|
https://aur.archlinux.org/packages/todotxt/
|
||||||
|
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
No configuration is required; however, most users tweak the default settings (e.g. relocating the todo.txt directory to a subdirectory of the user's home directory, or onto a cloud drive (via the `TODO_DIR` variable)), modify the colors, add additional highlighting of projects, contexts, dates, and so on. A configuration template with a commented-out list of all available options is included.
|
||||||
|
It is recommended to _copy_ that template into one of the locations listed by `todo.sh help` on `-d CONFIG_FILE`, even if it is installed in the global configuration location (`/etc/todo/config`).
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
```shell
|
```shell
|
||||||
todo.sh [-fhpantvV] [-d todo_config] action [task_number] [task_description]
|
todo.sh [-fhpantvV] [-d todo_config] action [task_number] [task_description]
|
||||||
|
|||||||
7
todo.cfg
7
todo.cfg
@@ -76,6 +76,13 @@ export REPORT_FILE="$TODO_DIR/report.txt"
|
|||||||
|
|
||||||
# === BEHAVIOR ===
|
# === BEHAVIOR ===
|
||||||
|
|
||||||
|
## verbosity
|
||||||
|
#
|
||||||
|
# By default, additional information and confirmation of actions (like
|
||||||
|
# "TODO: 1 added") are printed. You can suppress this via 0 or add extra
|
||||||
|
# verbosity via 2.
|
||||||
|
# export TODOTXT_VERBOSE=1
|
||||||
|
|
||||||
## customize list output
|
## customize list output
|
||||||
#
|
#
|
||||||
# TODOTXT_SORT_COMMAND will filter after line numbers are
|
# TODOTXT_SORT_COMMAND will filter after line numbers are
|
||||||
|
|||||||
Reference in New Issue
Block a user