Skip to content

docs: document configuration keys that differ from CLI flags #628

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Likio3000 wants to merge 1 commit into
base: master
Choose a base branch
from
+12 −2
Open

docs: document configuration keys that differ from CLI flags #628

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,15 +145,25 @@ 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`
```
$ 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

Expand Down