From 7d8c95ed93201ec14d70bdfee37f15c80a66f082 Mon Sep 17 00:00:00 2001 From: Jeevitha Kannan K S Date: Fri, 8 Nov 2024 06:15:32 +0530 Subject: [PATCH] Update CLI arguments documentation No word wrap for options in README 123 --- README.md | 12 +++++++----- man/linutil.1 | 26 +++++++++++++------------- 2 files changed, 20 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 78bd1d0e1..7ba2edd5e 100644 --- a/README.md +++ b/README.md @@ -24,14 +24,17 @@ curl -fsSL https://christitus.com/linux | sh ```bash curl -fsSL https://christitus.com/linuxdev | sh ``` -
- CLI arguments + +### CLI arguments Linutil supports various command-line arguments to customize its behavior. Here are some common arguments you can use: -- `-t, --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. +- `-c, --config ` : Path to the configuration file. +- `--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 ` : Set the theme to use in the application [default: `default`] [possible values: `default`, `compatible`]. For more detailed usage, run: @@ -42,7 +45,6 @@ curl -fsSL https://christitus.com/linux | sh -s -- --help ```bash linutil --help ``` -
## ⬇️ Installation diff --git a/man/linutil.1 b/man/linutil.1 index f846614f0..c66c0019b 100644 --- a/man/linutil.1 +++ b/man/linutil.1 @@ -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 @@ -26,6 +26,18 @@ curl -fsSL https://christitus.com/linuxdev | sh \fB\-c\fR, \fB\-\-config\fR \fI\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\fR Set the theme to use in the TUI. @@ -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.