Docs: Better manpage format
This commit is contained in:
Muhammad Herdiansyah
parent
058ee8a211
commit
72ce23befb
2 changed files with 18 additions and 35 deletions
27
neofetch
27
neofetch
|
|
@ -3116,8 +3116,7 @@ NOTE: Every launch flag has a config option.
|
|||
|
||||
Options:
|
||||
|
||||
INFO
|
||||
|
||||
INFO:
|
||||
--disable infoname Allows you to disable an info line from appearing
|
||||
in the output.
|
||||
|
||||
|
|
@ -3171,23 +3170,20 @@ INFO
|
|||
--install_time_format 12h/24h
|
||||
Set time format in Install Date to be 12 hour or 24 hour.
|
||||
|
||||
TEXT FORMATTING
|
||||
|
||||
TEXT FORMATTING:
|
||||
--colors x x x x x x Changes the text colors in this order:
|
||||
title, @, underline, subtitle, colon, info
|
||||
--underline on/off Enable/Disable the underline.
|
||||
--underline_char char Character to use when underlining title
|
||||
--bold on/off Enable/Disable bold text
|
||||
|
||||
COLOR BLOCKS
|
||||
|
||||
COLOR BLOCKS:
|
||||
--color_blocks on/off Enable/Disable the color blocks
|
||||
--block_width num Width of color blocks in spaces
|
||||
--block_height num Height of color blocks in lines
|
||||
--block_range num num Range of colors to print as blocks
|
||||
|
||||
BARS
|
||||
|
||||
BARS:
|
||||
--bar_char 'elapsed char' 'total char'
|
||||
Characters to use when drawing bars.
|
||||
--bar_border on/off Whether or not to surround the bar with '[]'
|
||||
|
|
@ -3202,8 +3198,7 @@ BARS
|
|||
Takes: bar, infobar, barinfo, off
|
||||
--disk_display mode Bar mode.
|
||||
Takes: bar, infobar, barinfo, off
|
||||
IMAGE
|
||||
|
||||
IMAGE:
|
||||
--image type Image source. Where and what image we display.
|
||||
Possible values: wall, ascii,
|
||||
/path/to/img, /path/to/dir/, off
|
||||
|
|
@ -3227,8 +3222,7 @@ IMAGE
|
|||
|
||||
--clean Delete cached files and thumbnails.
|
||||
|
||||
ASCII
|
||||
|
||||
ASCII:
|
||||
--ascii value Where to get the ascii from, Possible values:
|
||||
distro, /path/to/ascii
|
||||
--ascii_colors x x x x x x Colors to print the ascii art
|
||||
|
|
@ -3249,16 +3243,14 @@ ASCII
|
|||
--ascii_bold on/off Whether or not to bold the ascii logo.
|
||||
-L, --logo Hide the info text and only show the ascii logo.
|
||||
|
||||
SCREENSHOT
|
||||
|
||||
SCREENSHOT:
|
||||
-s, --scrot /path/to/img Take a screenshot, if path is left empty the screen-
|
||||
shot function will use \$scrot_dir and \$scrot_name.
|
||||
-su, --upload /path/to/img Same as --scrot but uploads the scrot to a website.
|
||||
--image_host Website to upload scrots to. Takes: imgur, teknik
|
||||
--scrot_cmd cmd Screenshot program to launch
|
||||
|
||||
OTHER
|
||||
|
||||
OTHER:
|
||||
--config /path/to/config Specify a path to a custom config file
|
||||
--config none Launch the script without a config file
|
||||
--help Print this text and exit
|
||||
|
|
@ -3266,8 +3258,7 @@ OTHER
|
|||
-v Display error messages.
|
||||
-vv Display a verbose log for error reporting.
|
||||
|
||||
DEVELOPER
|
||||
|
||||
DEVELOPER:
|
||||
--gen-man Generate a manpage for Neofetch in your PWD. (Requires GNU help2man)
|
||||
|
||||
|
||||
|
|
|
|||
26
neofetch.1
26
neofetch.1
|
|
@ -12,7 +12,7 @@ or any ASCII file of your choice.
|
|||
.PP
|
||||
NOTE: Every launch flag has a config option.
|
||||
.SH OPTIONS
|
||||
INFO
|
||||
.SS "INFO:"
|
||||
.TP
|
||||
\fB\-\-disable\fR infoname
|
||||
Allows you to disable an info line from appearing
|
||||
|
|
@ -101,8 +101,7 @@ Enable/Disable showing the time in Install Date output.
|
|||
.TP
|
||||
\fB\-\-install_time_format\fR 12h/24h
|
||||
Set time format in Install Date to be 12 hour or 24 hour.
|
||||
.PP
|
||||
TEXT FORMATTING
|
||||
.SS "TEXT FORMATTING:"
|
||||
.TP
|
||||
\fB\-\-colors\fR x x x x x x
|
||||
Changes the text colors in this order:
|
||||
|
|
@ -116,8 +115,7 @@ Character to use when underlining title
|
|||
.TP
|
||||
\fB\-\-bold\fR on/off
|
||||
Enable/Disable bold text
|
||||
.PP
|
||||
COLOR BLOCKS
|
||||
.SS "COLOR BLOCKS:"
|
||||
.TP
|
||||
\fB\-\-color_blocks\fR on/off
|
||||
Enable/Disable the color blocks
|
||||
|
|
@ -130,8 +128,7 @@ Height of color blocks in lines
|
|||
.TP
|
||||
\fB\-\-block_range\fR num num
|
||||
Range of colors to print as blocks
|
||||
.PP
|
||||
BARS
|
||||
.SS "BARS:"
|
||||
.TP
|
||||
\fB\-\-bar_char\fR 'elapsed char' 'total char'
|
||||
Characters to use when drawing bars.
|
||||
|
|
@ -161,8 +158,7 @@ Takes: bar, infobar, barinfo, off
|
|||
\fB\-\-disk_display\fR mode
|
||||
Bar mode.
|
||||
Takes: bar, infobar, barinfo, off
|
||||
.PP
|
||||
IMAGE
|
||||
.SS "IMAGE:"
|
||||
.TP
|
||||
\fB\-\-image\fR type
|
||||
Image source. Where and what image we display.
|
||||
|
|
@ -201,8 +197,7 @@ NOTE: \fB\-\-gap\fR can take a negative value which will move the text closer to
|
|||
.TP
|
||||
\fB\-\-clean\fR
|
||||
Delete cached files and thumbnails.
|
||||
.PP
|
||||
ASCII
|
||||
.SS "ASCII:"
|
||||
.TP
|
||||
\fB\-\-ascii\fR value
|
||||
Where to get the ascii from, Possible values:
|
||||
|
|
@ -231,8 +226,7 @@ Whether or not to bold the ascii logo.
|
|||
.TP
|
||||
\fB\-L\fR, \fB\-\-logo\fR
|
||||
Hide the info text and only show the ascii logo.
|
||||
.PP
|
||||
SCREENSHOT
|
||||
.SS "SCREENSHOT:"
|
||||
.TP
|
||||
\fB\-s\fR, \fB\-\-scrot\fR \fI\,/path/to/img\/\fP
|
||||
Take a screenshot, if path is left empty the screenshot function will use $scrot_dir and $scrot_name.
|
||||
|
|
@ -245,8 +239,7 @@ Website to upload scrots to. Takes: imgur, teknik
|
|||
.TP
|
||||
\fB\-\-scrot_cmd\fR cmd
|
||||
Screenshot program to launch
|
||||
.PP
|
||||
OTHER
|
||||
.SS "OTHER:"
|
||||
.TP
|
||||
\fB\-\-config\fR \fI\,/path/to/config\/\fP
|
||||
Specify a path to a custom config file
|
||||
|
|
@ -265,8 +258,7 @@ Display error messages.
|
|||
.TP
|
||||
\fB\-vv\fR
|
||||
Display a verbose log for error reporting.
|
||||
.PP
|
||||
DEVELOPER
|
||||
.SS "DEVELOPER:"
|
||||
.TP
|
||||
\fB\-\-gen\-man\fR
|
||||
Generate a manpage for Neofetch in your PWD. (Requires GNU help2man)
|
||||
|
|
|
|||
Loading…
Reference in a new issue