EvolutionOS
/
neofetch
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reformat usage to fit the value of each option

This commit is contained in:
Dylan 2016-02-03 19:15:42 +11:00
parent 6b3f598def
commit a33f96cc02
2 changed files with 143 additions and 150 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
README.md
View File

@ -155,7 +155,8 @@ specify a custom config location using `--config path/to/config`.
#### Sizing the image correctly #### Sizing the image correctly
**NOTE:** For the images to be sized correctly you need to set the `$font_width` variable.<br \> **NOTE:** For the images to be sized correctly you need to set the `$font_width` variable.<br \>
If you don't know your font width in pixels keep trying values until the image is sized correctly. If you don't know your font width in pixels keep trying values until the image is half the<br \>
terminal width.
You can also use the launch flag `--font_width` to set it on the fly. You can also use the launch flag `--font_width` to set it on the fly.
@ -213,28 +214,28 @@ alias fetch2="fetch \
usage: fetch --option "value" --option "value" usage: fetch --option "value" --option "value"
Info: Info:
--disable infoname Allows you to disable an info line from --disable infoname Allows you to disable an info line from appearing
appearing in the output. in the output.
NOTE: You can supply multiple args. eg. NOTE: You can supply multiple args. eg.
'fetch --disable cpu gpu disk shell' 'fetch --disable cpu gpu disk shell'
--osx_buildversion on/off Hide/Show Mac OS X build version.
--os_arch on/off Hide/Show Windows architecture. --os_arch on/off Hide/Show Windows architecture.
--osx_buildversion Hide/Show Mac OS X build version. --speed_type type Change the type of cpu speed to display.
--speed_type Change the type of cpu speed to display.
Possible values: current, min, max, bios, Possible values: current, min, max, bios,
scaling_current, scaling_min, scaling_max scaling_current, scaling_min, scaling_max
NOTE: This only support Linux with cpufreq. NOTE: This only support Linux with cpufreq.
--kernel_shorthand Shorten the output of kernel --kernel_shorthand on/off Shorten the output of kernel
--uptime_shorthand Shorten the output of uptime (tiny, on, off) --uptime_shorthand on/off Shorten the output of uptime (tiny, on, off)
--gpu_shorthand on/off Shorten the output of GPU --gpu_shorthand on/off Shorten the output of GPU
--gtk_shorthand on/off Shorten output of gtk theme/icons --gtk_shorthand on/off Shorten output of gtk theme/icons
--gtk2 on/off Enable/Disable gtk2 theme/icons output --gtk2 on/off Enable/Disable gtk2 theme/icons output
--gtk3 on/off Enable/Disable gtk3 theme/icons output --gtk3 on/off Enable/Disable gtk3 theme/icons output
--shell_path on/off Enable/Disable showing \$SHELL path --shell_path on/off Enable/Disable showing \$SHELL path
--shell_version on/off Enable/Disable showing \$SHELL version --shell_version on/off Enable/Disable showing \$SHELL version
--battery_num Which battery to display, default value is 'all' --battery_num num Which battery to display, default value is 'all'
--battery_shorthand Whether or not each battery gets its own line and title --battery_shorthand on/off Whether or not each battery gets its own line/title
--birthday_shorthand Shorten the output of birthday --birthday_shorthand on/off Shorten the output of birthday
--birthday_time Enable/Disable showing the time in birthday output --birthday_time on/ff Enable/Disable showing the time in birthday output
Text Colors: Text Colors:
--title_color num Change the color of the title --title_color num Change the color of the title
@ -248,60 +249,56 @@ alias fetch2="fetch \
--underline_char char Character to use when underlineing title --underline_char char Character to use when underlineing 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
--prompt_height num Set this to your prompt height to fix --prompt_height num Set this to your prompt height to fix issues with
issues with the text going off screen at the top the text going off screen at the top
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 --block_width num Width of color blocks
--block_range start end --v --block_range start end Range of colors to print as blocks
Range of colors to print as blocks
Image: Image:
--image Image source. Where and what image we display. --image type Image source. Where and what image we display.
Possible values: wall, shuffle, ascii, Possible values: wall, shuffle, ascii,
/path/to/img, off /path/to/img, off
--image_backend Which program to use to draw images. --image_backend w3m/iterm2 Which program to use to draw images.
--shuffle_dir Which directory to shuffle for an image. --shuffle_dir path/to/dir Which directory to shuffle for an image.
--font_width px Used to automatically size the image --font_width px Used to automatically size the image
--image_position Where to display the image: (Left/Right) --image_position left/right Where to display the image: (Left/Right)
--split_size num Width of img/text splits --split_size num Width of img/text splits, A value of 2 makes each
A value of 2 makes each split half the terminal split half the terminal width and etc.
width and etc --crop_mode mode Which crop mode to use
--crop_mode Which crop mode to use
Takes the values: normal, fit, fill Takes the values: normal, fit, fill
--crop_offset value Change the crop offset for normal mode. --crop_offset value Change the crop offset for normal mode.
Possible values: northwest, north, northeast, Possible values: northwest, north, northeast,
west, center, east, southwest, south, southeast west, center, east, southwest, south, southeast
--xoffset px How close the image will be --xoffset px How close the image will be to the left edge of the
to the left edge of the window window. This only works with w3m.
NOTE: This only works with w3m --yoffset px How close the image will be to the top edge of the
--yoffset px How close the image will be window. This only works with w3m.
to the top edge of the window --gap num Gap between image and text.
NOTE: This only works with w3m
--gap num Gap between image and text right side
to the top edge of the window
NOTE: --gap can take a negative value which will NOTE: --gap can take a negative value which will
move the text closer to the left side. move the text closer to the left side.
--clean Remove all cropped images --clean Remove all cropped images
Ascii: Ascii:
--ascii 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_color Color to print the ascii art --ascii_color num Color 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
Screenshot: Screenshot:
--scrot /path/to/img Take a screenshot, if path is left empty --scrot /path/to/img Take a screenshot, if path is left empty the screen-
the screenshot function will use shot function will use \$scrot_dir and \$scrot_name.
\$scrot_dir and \$scrot_name. --scrot_cmd cmd Screenshot program to launch
--scrot_cmd Screenshot program to launch
Other: Other:
--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

72
fetch
View File

@ -1981,31 +1981,31 @@ unset_func () {
usage () { cat << EOF usage () { cat << EOF
usage: ${0##*/} --option "value" usage: fetch --option "value" --option "value"
Info: Info:
--disable infoname Allows you to disable an info line from --disable infoname Allows you to disable an info line from appearing
appearing in the output. in the output.
NOTE: You can supply multiple args. eg. NOTE: You can supply multiple args. eg.
'fetch --disable cpu gpu disk shell' 'fetch --disable cpu gpu disk shell'
--osx_buildversion Hide/Show Mac OS X build version. --osx_buildversion on/off Hide/Show Mac OS X build version.
--os_arch on/off Hide/Show Windows architecture. --os_arch on/off Hide/Show Windows architecture.
--speed_type Change the type of cpu speed to display. --speed_type type Change the type of cpu speed to display.
Possible values: current, min, max, bios, Possible values: current, min, max, bios,
scaling_current, scaling_min, scaling_max scaling_current, scaling_min, scaling_max
NOTE: This only support Linux with cpufreq. NOTE: This only support Linux with cpufreq.
--kernel_shorthand Shorten the output of kernel --kernel_shorthand on/off Shorten the output of kernel
--uptime_shorthand Shorten the output of uptime (tiny, on, off) --uptime_shorthand on/off Shorten the output of uptime (tiny, on, off)
--gpu_shorthand on/off Shorten the output of GPU --gpu_shorthand on/off Shorten the output of GPU
--gtk_shorthand on/off Shorten output of gtk theme/icons --gtk_shorthand on/off Shorten output of gtk theme/icons
--gtk2 on/off Enable/Disable gtk2 theme/icons output --gtk2 on/off Enable/Disable gtk2 theme/icons output
--gtk3 on/off Enable/Disable gtk3 theme/icons output --gtk3 on/off Enable/Disable gtk3 theme/icons output
--shell_path on/off Enable/Disable showing \$SHELL path --shell_path on/off Enable/Disable showing \$SHELL path
--shell_version on/off Enable/Disable showing \$SHELL version --shell_version on/off Enable/Disable showing \$SHELL version
--battery_num Which battery to display, default value is 'all' --battery_num num Which battery to display, default value is 'all'
--battery_shorthand Whether or not each battery gets its own line and title --battery_shorthand on/off Whether or not each battery gets its own line/title
--birthday_shorthand Shorten the output of birthday --birthday_shorthand on/off Shorten the output of birthday
--birthday_time Enable/Disable showing the time in birthday output --birthday_time on/ff Enable/Disable showing the time in birthday output
Text Colors: Text Colors:
--title_color num Change the color of the title --title_color num Change the color of the title
@ -2019,60 +2019,56 @@ usage () { cat << EOF
--underline_char char Character to use when underlineing title --underline_char char Character to use when underlineing 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
--prompt_height num Set this to your prompt height to fix --prompt_height num Set this to your prompt height to fix issues with
issues with the text going off screen at the top the text going off screen at the top
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 --block_width num Width of color blocks
--block_range start end --v --block_range start end Range of colors to print as blocks
Range of colors to print as blocks
Image: Image:
--image Image source. Where and what image we display. --image type Image source. Where and what image we display.
Possible values: wall, shuffle, ascii, Possible values: wall, shuffle, ascii,
/path/to/img, off /path/to/img, off
--image_backend Which program to use to draw images. --image_backend w3m/iterm2 Which program to use to draw images.
--shuffle_dir Which directory to shuffle for an image. --shuffle_dir path/to/dir Which directory to shuffle for an image.
--font_width px Used to automatically size the image --font_width px Used to automatically size the image
--image_position Where to display the image: (Left/Right) --image_position left/right Where to display the image: (Left/Right)
--split_size num Width of img/text splits --split_size num Width of img/text splits, A value of 2 makes each
A value of 2 makes each split half the terminal split half the terminal width and etc.
width and etc --crop_mode mode Which crop mode to use
--crop_mode Which crop mode to use
Takes the values: normal, fit, fill Takes the values: normal, fit, fill
--crop_offset value Change the crop offset for normal mode. --crop_offset value Change the crop offset for normal mode.
Possible values: northwest, north, northeast, Possible values: northwest, north, northeast,
west, center, east, southwest, south, southeast west, center, east, southwest, south, southeast
--xoffset px How close the image will be --xoffset px How close the image will be to the left edge of the
to the left edge of the window window. This only works with w3m.
NOTE: This only works with w3m --yoffset px How close the image will be to the top edge of the
--yoffset px How close the image will be window. This only works with w3m.
to the top edge of the window --gap num Gap between image and text.
NOTE: This only works with w3m
--gap num Gap between image and text right side
to the top edge of the window
NOTE: --gap can take a negative value which will NOTE: --gap can take a negative value which will
move the text closer to the left side. move the text closer to the left side.
--clean Remove all cropped images --clean Remove all cropped images
Ascii: Ascii:
--ascii 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_color Color to print the ascii art --ascii_color num Color 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
Screenshot: Screenshot:
--scrot /path/to/img Take a screenshot, if path is left empty --scrot /path/to/img Take a screenshot, if path is left empty the screen-
the screenshot function will use shot function will use \$scrot_dir and \$scrot_name.
\$scrot_dir and \$scrot_name. --scrot_cmd cmd Screenshot program to launch
--scrot_cmd Screenshot program to launch
Other: Other:
--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