Update documentation

This commit is contained in:
Dylan 2016-04-29 17:41:21 +10:00
parent 8a89d6ec7c
commit b48eb75bb1
3 changed files with 39 additions and 8 deletions

View File

@ -350,6 +350,7 @@ alias fetch2="fetch \
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_char char Character to use when underlining title --underline_char char Character to use when underlining title
--line_wrap on/off Enable/Disable line wrapping --line_wrap on/off Enable/Disable line wrapping
--bold on/off Enable/Disable bold text --bold on/off Enable/Disable bold text
@ -364,7 +365,9 @@ alias fetch2="fetch \
Progress Bars: Progress Bars:
--progress_char char Character to use when drawing progress bars. --progress_char 'elapsed char' 'total char'
Characters to use when drawing progress bars.
--progress_border on/off Whether or not to surround the bar with '[]'
--progress_length num Length in spaces to make the progress bars. --progress_length num Length in spaces to make the progress bars.
--progress_colors num num Colors to make the progress bar. --progress_colors num num Colors to make the progress bar.
Set in this order: elapsed, total Set in this order: elapsed, total
@ -384,7 +387,6 @@ alias fetch2="fetch \
Possible values: wall, ascii, Possible values: wall, ascii,
/path/to/img, /path/to/dir/, off /path/to/img, /path/to/dir/, off
--size 20px | --size 20% Size to make the image, takes pixels or a percentage. --size 20px | --size 20% Size to make the image, takes pixels or a percentage.
--image_backend w3m/iterm2 Which program to use to draw images.
--image_position left/right Where to display the image: (Left/Right) --image_position left/right Where to display the image: (Left/Right)
--crop_mode mode Which crop mode to use --crop_mode mode Which crop mode to use
Takes the values: normal, fit, fill Takes the values: normal, fit, fill
@ -407,6 +409,8 @@ alias fetch2="fetch \
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
--ascii_distro distro Which Distro's ascii art to print --ascii_distro distro Which Distro's ascii art to print
--ascii_logo_size Size of ascii logo.
Supported distros: Arch, Gentoo, Crux, OpenBSD.
Stdout: Stdout:

View File

@ -2660,6 +2660,7 @@ usage () { cat << EOF
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_char char Character to use when underlining title --underline_char char Character to use when underlining title
--line_wrap on/off Enable/Disable line wrapping --line_wrap on/off Enable/Disable line wrapping
--bold on/off Enable/Disable bold text --bold on/off Enable/Disable bold text
@ -2674,7 +2675,9 @@ usage () { cat << EOF
Progress Bars: Progress Bars:
--progress_char char Character to use when drawing progress bars. --progress_char 'elapsed char' 'total char'
Characters to use when drawing progress bars.
--progress_border on/off Whether or not to surround the bar with '[]'
--progress_length num Length in spaces to make the progress bars. --progress_length num Length in spaces to make the progress bars.
--progress_colors num num Colors to make the progress bar. --progress_colors num num Colors to make the progress bar.
Set in this order: elapsed, total Set in this order: elapsed, total
@ -2716,6 +2719,8 @@ usage () { cat << EOF
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
--ascii_distro distro Which Distro's ascii art to print --ascii_distro distro Which Distro's ascii art to print
--ascii_logo_size Size of ascii logo.
Supported distros: Arch, Gentoo, Crux, OpenBSD.
Stdout: Stdout:

View File

@ -98,6 +98,10 @@ Format the birthday output. (Uses 'date' cmd format)
.B \--colors x x x x x x .B \--colors x x x x x x
Changes the text colors in this order: Changes the text colors in this order:
title, @, underline, subtitle, colon, info title, @, underline, subtitle, colon, info
.TP
.B \--underline on/off
enable/disable the underline.
.TP
.B \--underline_char 'char' .B \--underline_char 'char'
Character to use when underlining title Character to use when underlining title
.TP .TP
@ -124,8 +128,11 @@ Range of colors to print as blocks
.SH PROGRESS BARS .SH PROGRESS BARS
.TP .TP
.B \--progress_char 'char' .B \--progress_char 'elapsed char' 'total char'
Character to use when drawing progress bars. Characters to use when drawing progress bars.
.TP
.B \--progress_border on/off
Whether or not to surround the bar with '[]'
.TP .TP
.B \--progress_length 'num' .B \--progress_length 'num'
Length in spaces to make the progress bars. Length in spaces to make the progress bars.
@ -210,6 +217,11 @@ Colors to print the ASCII art
.TP .TP
.B \--ascii_distro 'distro' .B \--ascii_distro 'distro'
Which Distro\'s ASCII art to print Which Distro\'s ASCII art to print
.TP
.B \--ascii_logo_size 'size'
Size of ascii logo.
Supported distros: Arch, Gentoo, Crux, OpenBSD.
Possible values: small, normal
.SH STDOUT .SH STDOUT
.TP .TP
@ -233,11 +245,21 @@ Screenshot program to launch
.TP .TP
.B \--config 'path' .B \--config 'path'
Specify a path to a custom config file Specify a path to a custom config file
.TP .tp
.B \--config none .b \--config none
Launch the script without a config file launch the script without a config file
.TP .TP
.B \--help .B \--help
.TP
.B \--test
Launch the script with all functions / options enabled.
This should only be used for testing purposes, ie Travis.CI.
.TP
.B \-v
Display error messages.
.TP
.B \-vv
Display a verbose log for error reporting.
.SH "SEE ALSO" .SH "SEE ALSO"
http://github.com/dylanaraps/neofetch http://github.com/dylanaraps/neofetch