From d7773c98a22ca3ab871696cf90f2fe55b6c8f611 Mon Sep 17 00:00:00 2001 From: o2sh Date: Sun, 2 Apr 2023 01:09:32 +0200 Subject: [PATCH] update manpage --- docs/onefetch.1 | 159 +++++++++++++++++++++++++----------------------- src/cli.rs | 14 ++--- 2 files changed, 90 insertions(+), 83 deletions(-) diff --git a/docs/onefetch.1 b/docs/onefetch.1 index c2eab15b3..de1ba398e 100644 --- a/docs/onefetch.1 +++ b/docs/onefetch.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.2. -.TH ONEFETCH "1" "February 2023" "onefetch 2.16.0" "User Commands" +.TH ONEFETCH "1" "April 2023" "onefetch 2.16.0" "User Commands" .SH NAME onefetch \- manual page for onefetch 2.16.0 .SH SYNOPSIS @@ -14,94 +14,111 @@ Command\-line Git information tool Run as if onefetch was started in instead of the current working directory .SH OPTIONS .HP -\fB\-\-ascii\-input\fR -.IP -Takes a non\-empty STRING as input to replace the ASCII logo -.IP -It is possible to pass a generated STRING by command substitution -.IP -For example: -.IP -\&'\-\-ascii\-input "$(fortune | cowsay \fB\-W\fR 25)"' -.HP -\fB\-a\fR, \fB\-\-ascii\-language\fR +\fB\-h\fR, \fB\-\-help\fR .IP -Which LANGUAGE's ascii art to print +Print help (see a summary with '\-h') .HP -\fB\-c\fR, \fB\-\-ascii\-colors\fR ... +\fB\-V\fR, \fB\-\-version\fR .IP -Colors (X X X...) to print the ascii art +Print version +.SS "INFO:" .HP \fB\-d\fR, \fB\-\-disabled\-fields\fR ... .IP Allows you to disable FIELD(s) from appearing in the output .HP -\fB\-i\fR, \fB\-\-image\fR +\fB\-\-no\-title\fR .IP -Path to the IMAGE file +Hides the title .HP -\fB\-\-image\-protocol\fR +\fB\-\-number\-of\-authors\fR .IP -Which image protocol to use +Maximum NUM of authors to be shown .IP -[possible values: kitty, sixel, iterm] +[default: 3] .HP -\fB\-\-color\-resolution\fR +\fB\-\-number\-of\-languages\fR .IP -VALUE of color resolution to use with SIXEL backend +Maximum NUM of languages to be shown .IP -[default: 16] -[possible values: 16, 32, 64, 128, 256] +[default: 6] .HP -\fB\-\-no\-bold\fR +\fB\-e\fR, \fB\-\-exclude\fR ... .IP -Turns off bold formatting +Ignore all files & directories matching EXCLUDE +.HP +\fB\-\-no\-bots\fR [] +.IP +Exclude [bot] commits. Use to override the default pattern .HP \fB\-\-no\-merges\fR .IP Ignores merge commits .HP -\fB\-\-no\-color\-palette\fR +\fB\-E\fR, \fB\-\-email\fR .IP -Hides the color palette +Show the email address of each author .HP -\fB\-\-no\-title\fR +\fB\-\-include\-hidden\fR .IP -Hides the title +Count hidden files and directories .HP -\fB\-\-number\-of\-authors\fR +\fB\-T\fR, \fB\-\-type\fR ... .IP -Maximum NUM of authors to be shown +Filters output by language type .IP -[default: 3] +[default: programming markup] +[possible values: programming, markup, prose, data] +.SS "TEXT FORMATTING:" .HP -\fB\-\-number\-of\-languages\fR +\fB\-t\fR, \fB\-\-text\-colors\fR ... .IP -Maximum NUM of languages to be shown +Changes the text colors (X X X...) .IP -[default: 6] +Goes in order of title, ~, underline, subtitle, colon, and info +.IP +For example: +.IP +\&'\-\-text\-colors 9 10 11 12 13 14' .HP -\fB\-e\fR, \fB\-\-exclude\fR ... +\fB\-z\fR, \fB\-\-iso\-time\fR .IP -Ignore all files & directories matching EXCLUDE +Use ISO 8601 formatted timestamps .HP -\fB\-\-no\-bots\fR [] +\fB\-\-number\-separator\fR .IP -Exclude [bot] commits. Use to override the default pattern +Which thousands SEPARATOR to use +.IP +[default: plain] +[possible values: plain, comma, space, underscore] .HP -\fB\-l\fR, \fB\-\-languages\fR +\fB\-\-no\-bold\fR .IP -Prints out supported languages +Turns off bold formatting +.SS "COLOR BLOCKS:" .HP -\fB\-p\fR, \fB\-\-package\-managers\fR +\fB\-\-no\-color\-palette\fR .IP -Prints out supported package managers +Hides the color palette +.SS "ASCII:" .HP -\fB\-o\fR, \fB\-\-output\fR +\fB\-\-ascii\-input\fR .IP -Outputs Onefetch in a specific format +Takes a non\-empty STRING as input to replace the ASCII logo .IP -[possible values: json, yaml] +It is possible to pass a generated STRING by command substitution +.IP +For example: +.IP +\&'\-\-ascii\-input "$(fortune | cowsay \fB\-W\fR 25)"' +.HP +\fB\-c\fR, \fB\-\-ascii\-colors\fR ... +.IP +Colors (X X X...) to print the ascii art +.HP +\fB\-a\fR, \fB\-\-ascii\-language\fR +.IP +Which LANGUAGE's ascii art to print .HP \fB\-\-true\-color\fR .IP @@ -120,56 +137,46 @@ If set to auto: the logo will be hidden if the terminal's width < 95 .IP [default: always] [possible values: auto, never, always] +.SS "IMAGE:" .HP -\fB\-t\fR, \fB\-\-text\-colors\fR ... -.IP -Changes the text colors (X X X...) -.IP -Goes in order of title, ~, underline, subtitle, colon, and info -.IP -For example: -.IP -\&'\-\-text\-colors 9 10 11 12 13 14' -.HP -\fB\-z\fR, \fB\-\-iso\-time\fR +\fB\-i\fR, \fB\-\-image\fR .IP -Use ISO 8601 formatted timestamps +Path to the IMAGE file .HP -\fB\-\-number\-separator\fR +\fB\-\-image\-protocol\fR .IP -Which thousands SEPARATOR to use +Which image PROTOCOL to use .IP -[default: plain] -[possible values: plain, comma, space, underscore] +[possible values: kitty, sixel, iterm] .HP -\fB\-E\fR, \fB\-\-email\fR +\fB\-\-color\-resolution\fR .IP -Show the email address of each author -.HP -\fB\-\-include\-hidden\fR +VALUE of color resolution to use with SIXEL backend .IP -Count hidden files and directories +[default: 16] +[possible values: 16, 32, 64, 128, 256] +.SS "DEVELOPER:" .HP -\fB\-T\fR, \fB\-\-type\fR ... +\fB\-o\fR, \fB\-\-output\fR .IP -Filters output by language type +Outputs Onefetch in a specific format .IP -[default: programming markup] -[possible values: programming, markup, prose, data] +[possible values: json, yaml] .HP \fB\-\-generate\fR .IP If provided, outputs the completion file for given SHELL .IP [possible values: bash, elvish, fish, powershell, zsh] +.SS "OTHER:" .HP -\fB\-h\fR, \fB\-\-help\fR +\fB\-l\fR, \fB\-\-languages\fR .IP -Print help (see a summary with '\-h') +Prints out supported languages .HP -\fB\-V\fR, \fB\-\-version\fR +\fB\-p\fR, \fB\-\-package\-managers\fR .IP -Print version +Prints out supported package managers .SH "SEE ALSO" The full documentation for .B onefetch diff --git a/src/cli.rs b/src/cli.rs index e0c595f9c..fac567829 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -42,7 +42,7 @@ pub struct CliOptions { } #[derive(Clone, Debug, Args, PartialEq, Eq)] -#[command(next_help_heading = "Info")] +#[command(next_help_heading = "INFO")] pub struct InfoCliOptions { /// Allows you to disable FIELD(s) from appearing in the output #[arg( @@ -90,7 +90,7 @@ pub struct InfoCliOptions { } #[derive(Clone, Debug, Args, PartialEq, Eq)] -#[command(next_help_heading = "Ascii")] +#[command(next_help_heading = "ASCII")] pub struct AsciiCliOptions { /// Takes a non-empty STRING as input to replace the ASCII logo /// @@ -132,7 +132,7 @@ pub struct AsciiCliOptions { } #[derive(Clone, Debug, Args, PartialEq, Eq)] -#[command(next_help_heading = "Image")] +#[command(next_help_heading = "IMAGE")] pub struct ImageCliOptions { /// Path to the IMAGE file #[arg(long, short, value_hint = ValueHint::FilePath)] @@ -153,7 +153,7 @@ pub struct ImageCliOptions { } #[derive(Clone, Debug, Args, PartialEq, Eq)] -#[command(next_help_heading = "Text formatting")] +#[command(next_help_heading = "TEXT FORMATTING")] pub struct TextForamttingCliOptions { /// Changes the text colors (X X X...) /// @@ -181,7 +181,7 @@ pub struct TextForamttingCliOptions { pub no_bold: bool, } #[derive(Clone, Debug, Args, PartialEq, Eq, Default)] -#[command(next_help_heading = "Color blocks")] +#[command(next_help_heading = "COLOR BLOCKS")] pub struct ColorBlocksCliOptions { /// Hides the color palette #[arg(long)] @@ -189,7 +189,7 @@ pub struct ColorBlocksCliOptions { } #[derive(Clone, Debug, Args, PartialEq, Eq, Default)] -#[command(next_help_heading = "Developer")] +#[command(next_help_heading = "DEVELOPER")] pub struct DeveloperCliOptions { /// Outputs Onefetch in a specific format #[arg(long, short, value_name = "FORMAT", value_enum)] @@ -200,7 +200,7 @@ pub struct DeveloperCliOptions { } #[derive(Clone, Debug, Args, PartialEq, Eq, Default)] -#[command(next_help_heading = "Other")] +#[command(next_help_heading = "OTHER")] pub struct OtherCliOptions { /// Prints out supported languages #[arg(long, short)]