docs: add configuration to the manpage & README

This commit is contained in:
Adam Perkowski 2024-10-30 00:35:13 +01:00
parent 6cabee6d72
commit eb9c13c941
2 changed files with 26 additions and 0 deletions

View File

@ -72,6 +72,28 @@ Note that crates installed using `cargo install` require manual updating with `c
</details>
## Configuration
Linutil supports configuration through a TOML config file. Path to the file can be specified with `--config` (or `-c`).
Available options:
- `auto_execute` - a list of commands to execute automatically (can be combined with `--skip-confirmation`)
Example config:
```toml
# example_config.toml
auto_execute = [
"Fastfetch",
"Alacritty",
"Kitty"
]
```
```bash
linutil --config /path/to/example_config.toml
```
## 💖 Support
If you find Linutil helpful, please consider giving it a ⭐️ to show your support!

View File

@ -22,6 +22,10 @@ curl -fsSL https://christitus.com/linux | sh
curl -fsSL https://christitus.com/linuxdev | sh
.SH OPTIONS
.TP
\fB\-c\fR, \fB\-\-config\fR \fI<path>\fR
Path to the configuration file.
.TP
\fB\-t\fR, \fB\-\-theme\fR \fI<theme>\fR
Set the theme to use in the TUI.