mitsuo_makuda/linutil
1
0
Fork 0
mirror of https://github.com/ChrisTitusTech/linutil.git synced 2024-12-25 12:59:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update CLI arguments documentation (#926)

Browse Source
This commit is contained in:
Jeevitha Kannan K S 2024-11-11 21:56:15 +05:30 committed by GitHub
parent 16dd91ca29
commit fab3415c48
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 19 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -24,13 +24,16 @@ curl -fsSL https://christitus.com/linux | sh
```bash ```bash
curl -fsSL https://christitus.com/linuxdev | sh 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: 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]. - `-c, --config <CONFIG>` : Path to the configuration file.
- `--override-validation` : Show all available options, disregarding compatibility checks (UNSAFE). - `--override-validation` : Show all available options, disregarding compatibility checks (UNSAFE).
- `--size-bypass` : Bypass the terminal size limit.
- `-y, --skip-confirmation` : Skip confirmation prompt before executing commands.
- `-t, --theme <THEME>` : Set the theme to use in the application [default: `default`] [possible values: `default`, `compatible`].
- `-h, --help` : Print help. - `-h, --help` : Print help.
For more detailed usage, run: For more detailed usage, run:
@ -42,7 +45,6 @@ curl -fsSL https://christitus.com/linux | sh -s -- --help
```bash ```bash
linutil --help linutil --help
``` ```
</details>
## ⬇️ Installation ## ⬇️ Installation

26
man/linutil.1
View File

@ -1,5 +1,5 @@
.\" manpage for Linutil .\" manpage for Linutil
.TH "linutil" "1" "October 2024" "" "Linutil Manual" .TH "linutil" "1" "November 2024" "Linutil 2024.10.31" "Linutil Manual"
.SH NAME .SH NAME
linutil \- Chris Titus Tech's Linux Toolbox linutil \- Chris Titus Tech's Linux Toolbox
@ -26,6 +26,18 @@ curl -fsSL https://christitus.com/linuxdev | sh
\fB\-c\fR, \fB\-\-config\fR \fI<path>\fR \fB\-c\fR, \fB\-\-config\fR \fI<path>\fR
Path to the configuration file. 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 .TP
\fB\-t\fR, \fB\-\-theme\fR \fI<theme>\fR \fB\-t\fR, \fB\-\-theme\fR \fI<theme>\fR
Set the theme to use in the TUI. Set the theme to use in the TUI.
@ -36,18 +48,6 @@ Possible values:
.br .br
Defaults to \fIdefault\fR. 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 .TP
\fB\-h\fR, \fB\-\-help\fR \fB\-h\fR, \fB\-\-help\fR
Print help. Print help.