From 6898e2eb83b1e2f50beb2acfe8badb87920fe61a Mon Sep 17 00:00:00 2001 From: Alex <100605452+Likio3000@users.noreply.github.com> Date: Wed, 23 Sep 2026 02:19:56 +1000 Subject: [PATCH] docs: document configuration keys that differ from CLI flags --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8e2bab2b..b34703ee 100644 --- a/README.md +++ b/README.md @@ -145,7 +145,7 @@ Usage: dust --dim Displays dimmer bars ## Config file -Dust has a config file where the above options can be set. +Dust has a config file for persistent options. Either: `$XDG_CONFIG_HOME/dust/config.toml` (falling back to `~/.config/dust/config.toml`) or `~/.dust.toml` ``` @@ -153,7 +153,17 @@ $ cat ~/.config/dust/config.toml reverse=true limit-filesystem=true ``` -Keys use the long flag name in kebab-case. See [config/config.toml](config/config.toml) for a fuller sample. +Keys use kebab-case. Most match the long flag name, but the following options +use different names in the config file: + +| Command-line flag | Config key | +| --- | --- | +| `--full-paths` | `display-full-paths` | +| `--apparent-size` | `display-apparent-size` | +| `--no-percent-bars` | `no-bars` | +| `--no-progress` | `disable-progress` | + +See [config/config.toml](config/config.toml) for a fuller sample. ## Alternatives