diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 5d47ac45a..f69280b27 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -6,9 +6,9 @@ * [Configuration](./config-file.md) * [Reports](./reports.md) * [Tags](./tags.md) + * [Environment](./environment.md) * [Synchronization](./task-sync.md) * [Running the Sync Server](./running-sync-server.md) - * [Debugging](./debugging.md) - [Internal Details](./internals.md) * [Data Model](./data-model.md) * [Replica Storage](./storage.md) diff --git a/docs/src/config-file.md b/docs/src/config-file.md index bb3ba31d3..90a892805 100644 --- a/docs/src/config-file.md +++ b/docs/src/config-file.md @@ -6,7 +6,7 @@ Configuration is read from `taskchampion.toml` in your config directory. On Linux systems, that directory is `~/.config`. On OS X, it's `~/Library/Preferences`. On Windows, it's `AppData/Roaming` in your home directory. -This can be overridden by setting `$TASKCHAMPION_CONFIG` to the configuration filename. +This can be overridden by setting `TASKCHAMPION_CONFIG` to the configuration filename. The file format is [TOML](https://toml.io/). For example: diff --git a/docs/src/debugging.md b/docs/src/debugging.md deleted file mode 100644 index d81c9d746..000000000 --- a/docs/src/debugging.md +++ /dev/null @@ -1,9 +0,0 @@ -# Debugging - -Both `ta` and `taskchampion-sync-server` use [env-logger](https://docs.rs/env_logger) and can be configured to log at various levels with the `RUST_LOG` environment variable. -For example: -```shell -$ RUST_LOG=taskchampion=trace ta add foo -``` - -The output may provide valuable clues in debugging problems. diff --git a/docs/src/environment.md b/docs/src/environment.md new file mode 100644 index 000000000..14fea8aba --- /dev/null +++ b/docs/src/environment.md @@ -0,0 +1,21 @@ +# Environment Variables + +## Configuration + +Set `TASKCHAMPION_CONFIG` to the location of a configuration file in order to override the default location. + +## Terminal Output + +Taskchampion uses [termcolor](https://github.com/BurntSushi/termcolor) to color its output. +This library interprets [`TERM` and `NO_COLOR`](https://github.com/BurntSushi/termcolor#automatic-color-selection) to determine how it should behave, when writing to a tty. +Set `NO_COLOR` to any value to force plain-text output. + +## Debugging + +Both `ta` and `taskchampion-sync-server` use [env-logger](https://docs.rs/env_logger) and can be configured to log at various levels with the `RUST_LOG` environment variable. +For example: +```shell +$ RUST_LOG=taskchampion=trace ta add foo +``` + +The output may provide valuable clues in debugging problems.