Docs: Better manpage format

This commit is contained in:
Muhammad Herdiansyah 2016-12-29 15:26:44 +07:00
parent 058ee8a211
commit 72ce23befb
2 changed files with 18 additions and 35 deletions

View File

@ -3116,8 +3116,7 @@ NOTE: Every launch flag has a config option.
Options: Options:
INFO INFO:
--disable infoname Allows you to disable an info line from appearing --disable infoname Allows you to disable an info line from appearing
in the output. in the output.
@ -3171,23 +3170,20 @@ INFO
--install_time_format 12h/24h --install_time_format 12h/24h
Set time format in Install Date to be 12 hour or 24 hour. 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: --colors x x x x x x Changes the text colors in this order:
title, @, underline, subtitle, colon, info title, @, underline, subtitle, colon, info
--underline on/off Enable/Disable the underline. --underline on/off Enable/Disable the underline.
--underline_char char Character to use when underlining title --underline_char char Character to use when underlining title
--bold on/off Enable/Disable bold text --bold on/off Enable/Disable bold text
COLOR BLOCKS COLOR BLOCKS:
--color_blocks on/off Enable/Disable the color blocks --color_blocks on/off Enable/Disable the color blocks
--block_width num Width of color blocks in spaces --block_width num Width of color blocks in spaces
--block_height num Height of color blocks in lines --block_height num Height of color blocks in lines
--block_range num num Range of colors to print as blocks --block_range num num Range of colors to print as blocks
BARS BARS:
--bar_char 'elapsed char' 'total char' --bar_char 'elapsed char' 'total char'
Characters to use when drawing bars. Characters to use when drawing bars.
--bar_border on/off Whether or not to surround the bar with '[]' --bar_border on/off Whether or not to surround the bar with '[]'
@ -3202,8 +3198,7 @@ BARS
Takes: bar, infobar, barinfo, off Takes: bar, infobar, barinfo, off
--disk_display mode Bar mode. --disk_display mode Bar mode.
Takes: bar, infobar, barinfo, off Takes: bar, infobar, barinfo, off
IMAGE IMAGE:
--image type Image source. Where and what image we display. --image type Image source. Where and what image we display.
Possible values: wall, ascii, Possible values: wall, ascii,
/path/to/img, /path/to/dir/, off /path/to/img, /path/to/dir/, off
@ -3227,8 +3222,7 @@ IMAGE
--clean Delete cached files and thumbnails. --clean Delete cached files and thumbnails.
ASCII ASCII:
--ascii value Where to get the ascii from, Possible values: --ascii value Where to get the ascii from, Possible values:
distro, /path/to/ascii distro, /path/to/ascii
--ascii_colors x x x x x x Colors to print the ascii art --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. --ascii_bold on/off Whether or not to bold the ascii logo.
-L, --logo Hide the info text and only show 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- -s, --scrot /path/to/img Take a screenshot, if path is left empty the screen-
shot function will use \$scrot_dir and \$scrot_name. shot function will use \$scrot_dir and \$scrot_name.
-su, --upload /path/to/img Same as --scrot but uploads the scrot to a website. -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 --image_host Website to upload scrots to. Takes: imgur, teknik
--scrot_cmd cmd Screenshot program to launch --scrot_cmd cmd Screenshot program to launch
OTHER OTHER:
--config /path/to/config Specify a path to a custom config file --config /path/to/config Specify a path to a custom config file
--config none Launch the script without a config file --config none Launch the script without a config file
--help Print this text and exit --help Print this text and exit
@ -3266,8 +3258,7 @@ OTHER
-v Display error messages. -v Display error messages.
-vv Display a verbose log for error reporting. -vv Display a verbose log for error reporting.
DEVELOPER DEVELOPER:
--gen-man Generate a manpage for Neofetch in your PWD. (Requires GNU help2man) --gen-man Generate a manpage for Neofetch in your PWD. (Requires GNU help2man)

View File

@ -12,7 +12,7 @@ or any ASCII file of your choice.
.PP .PP
NOTE: Every launch flag has a config option. NOTE: Every launch flag has a config option.
.SH OPTIONS .SH OPTIONS
INFO .SS "INFO:"
.TP .TP
\fB\-\-disable\fR infoname \fB\-\-disable\fR infoname
Allows you to disable an info line from appearing Allows you to disable an info line from appearing
@ -101,8 +101,7 @@ Enable/Disable showing the time in Install Date output.
.TP .TP
\fB\-\-install_time_format\fR 12h/24h \fB\-\-install_time_format\fR 12h/24h
Set time format in Install Date to be 12 hour or 24 hour. Set time format in Install Date to be 12 hour or 24 hour.
.PP .SS "TEXT FORMATTING:"
TEXT FORMATTING
.TP .TP
\fB\-\-colors\fR x x x x x x \fB\-\-colors\fR x x x x x x
Changes the text colors in this order: Changes the text colors in this order:
@ -116,8 +115,7 @@ Character to use when underlining title
.TP .TP
\fB\-\-bold\fR on/off \fB\-\-bold\fR on/off
Enable/Disable bold text Enable/Disable bold text
.PP .SS "COLOR BLOCKS:"
COLOR BLOCKS
.TP .TP
\fB\-\-color_blocks\fR on/off \fB\-\-color_blocks\fR on/off
Enable/Disable the color blocks Enable/Disable the color blocks
@ -130,8 +128,7 @@ Height of color blocks in lines
.TP .TP
\fB\-\-block_range\fR num num \fB\-\-block_range\fR num num
Range of colors to print as blocks Range of colors to print as blocks
.PP .SS "BARS:"
BARS
.TP .TP
\fB\-\-bar_char\fR 'elapsed char' 'total char' \fB\-\-bar_char\fR 'elapsed char' 'total char'
Characters to use when drawing bars. Characters to use when drawing bars.
@ -161,8 +158,7 @@ Takes: bar, infobar, barinfo, off
\fB\-\-disk_display\fR mode \fB\-\-disk_display\fR mode
Bar mode. Bar mode.
Takes: bar, infobar, barinfo, off Takes: bar, infobar, barinfo, off
.PP .SS "IMAGE:"
IMAGE
.TP .TP
\fB\-\-image\fR type \fB\-\-image\fR type
Image source. Where and what image we display. 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 .TP
\fB\-\-clean\fR \fB\-\-clean\fR
Delete cached files and thumbnails. Delete cached files and thumbnails.
.PP .SS "ASCII:"
ASCII
.TP .TP
\fB\-\-ascii\fR value \fB\-\-ascii\fR value
Where to get the ascii from, Possible values: Where to get the ascii from, Possible values:
@ -231,8 +226,7 @@ Whether or not to bold the ascii logo.
.TP .TP
\fB\-L\fR, \fB\-\-logo\fR \fB\-L\fR, \fB\-\-logo\fR
Hide the info text and only show the ascii logo. Hide the info text and only show the ascii logo.
.PP .SS "SCREENSHOT:"
SCREENSHOT
.TP .TP
\fB\-s\fR, \fB\-\-scrot\fR \fI\,/path/to/img\/\fP \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. 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 .TP
\fB\-\-scrot_cmd\fR cmd \fB\-\-scrot_cmd\fR cmd
Screenshot program to launch Screenshot program to launch
.PP .SS "OTHER:"
OTHER
.TP .TP
\fB\-\-config\fR \fI\,/path/to/config\/\fP \fB\-\-config\fR \fI\,/path/to/config\/\fP
Specify a path to a custom config file Specify a path to a custom config file
@ -265,8 +258,7 @@ Display error messages.
.TP .TP
\fB\-vv\fR \fB\-vv\fR
Display a verbose log for error reporting. Display a verbose log for error reporting.
.PP .SS "DEVELOPER:"
DEVELOPER
.TP .TP
\fB\-\-gen\-man\fR \fB\-\-gen\-man\fR
Generate a manpage for Neofetch in your PWD. (Requires GNU help2man) Generate a manpage for Neofetch in your PWD. (Requires GNU help2man)