Skip to content

Commit

Permalink
Update CLI arguments documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jeevithakannan2 committed Nov 8, 2024
1 parent f5f3824 commit cb36e4a
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 19 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,19 @@ curl -fsSL https://christitus.com/linux | sh
```bash
curl -fsSL https://christitus.com/linuxdev | sh
```
<details>
<summary>CLI arguments</summary>

### CLI arguments

Linutil supports various command-line arguments to customize its behavior. Here are some common arguments you can use:

- `-t, --theme <THEME>` : Set the theme to use in the application [default: default] [possible values: default, compatible].
- `--override-validation` : Show all available options, disregarding compatibility checks (UNSAFE).
- `-h, --help` : Print help.
| Option | Description | Default |
|:------------------:|------------------|:---------:|
| <span style="white-space: nowrap;"><code>-h, --help</code></span> | Print help | |
| <span style="white-space: nowrap;"><code>-c, --config <CONFIG></code></span> | Path to the configuration file |
| <span style="white-space: nowrap;"><code>--override-validation</code></span> | Show all available options, disregarding compatibility checks (UNSAFE) | |
| <span style="white-space: nowrap;"><code>--size-bypass</code></span> | Bypass the terminal size limit | |
| <span style="white-space: nowrap;"><code>-y, --skip-confirmation</code></span> | Skip confirmation prompt before executing commands | |
| <span style="white-space: nowrap;"><code>-t, --theme <THEME></code></span> | Set the theme to use in the application [possible values: `default`, `compatible`] | `default` |

For more detailed usage, run:

Expand All @@ -42,7 +47,6 @@ curl -fsSL https://christitus.com/linux | sh -s -- --help
```bash
linutil --help
```
</details>

## ⬇️ Installation

Expand Down
26 changes: 13 additions & 13 deletions man/linutil.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\" manpage for Linutil
.TH "linutil" "1" "October 2024" "" "Linutil Manual"
.TH "linutil" "1" "November 2024" "Linutil 2024.10.31" "Linutil Manual"

.SH NAME
linutil \- Chris Titus Tech's Linux Toolbox
Expand All @@ -26,6 +26,18 @@ curl -fsSL https://christitus.com/linuxdev | sh
\fB\-c\fR, \fB\-\-config\fR \fI<path>\fR
Path to the configuration file.

.TP
\fB\-\-override\-validation\fR
Show all available entries, disregarding compatibility checks (\fBUNSAFE\fR).

.TP
\fB\-\-size\-bypass\fR
Bypass the terminal size limit.

.TP
\fB\-y\fR, \fB\-\-skip\-confirmation\fR
Skip confirmation prompt before executing commands.

.TP
\fB\-t\fR, \fB\-\-theme\fR \fI<theme>\fR
Set the theme to use in the TUI.
Expand All @@ -36,18 +48,6 @@ Possible values:
.br
Defaults to \fIdefault\fR.

.TP
\fB\-y\fR, \fB\-\-skip\-confirmation\fR
Skip confirmation prompt before executing commands.

.TP
\fB\-\-override\-validation\fR
Show all available entries, disregarding compatibility checks. (\fBUNSAFE\fR)

.TP
\fB\-\-size\-bypass\fR
Bypass the terminal size limit

.TP
\fB\-h\fR, \fB\-\-help\fR
Print help.
Expand Down

0 comments on commit cb36e4a

Please sign in to comment.