kforney/hyfetch
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #528 from dylanaraps/help2man

Browse source 
Generate man page from --help and --version
This commit is contained in:
Dylan Araps 2016-12-15 09:32:29 +11:00 committed by GitHub
commit 2541aa7c01
2 changed files with 241 additions and 207 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

117
neofetch
View file

@ -3015,67 +3015,83 @@ cache_uname() {
# FINISH UP
usage() { printf "%s" "
NEOFETCH
usage() { printf "%s" "\
Usage: neofetch --option \"value\" --option \"value\"
USAGE: neofetch --option \"value\" --option \"value\"
Neofetch is a CLI system information tool written in BASH.
NOTE: There's also a config option for each flag below.
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.
NOTE: You can supply multiple args. eg.
'neofetch --disable cpu gpu disk shell'
NOTE: The arguments must all be lowercase.
NOTE: You can supply multiple args. eg. 'neofetch --disable cpu gpu disk shell'
--os_arch on/off Hide/Show OS architecture.
--speed_type type Change the type of cpu speed to display.
Possible values: current, min, max, bios,
scaling_current, scaling_min, scaling_max
NOTE: This only support Linux with cpufreq.
--cpu_shorthand type Shorten the output of CPU
Possible values: name, speed, tiny, on, off
--cpu_cores type Whether or not to display the number of CPU cores
Takes: logical, physical, off
NOTE: 'physical' doesn't work on BSD.
--cpu_speed on/off Hide/Show cpu speed.
--cpu_temp on/off Hide/Show cpu temperature.
NOTE: This only works on Linux and BSD.
NOTE: For FreeBSD-based systems, you need to enable coretemp
kernel module.
NOTE: For FreeBSD-based systems, you need to enable coretemp kernel module.
--distro_shorthand on/off Shorten the output of distro (tiny, on, off)
NOTE: This option won't work in Windows (Cygwin)
--kernel_shorthand on/off Shorten the output of kernel
NOTE: This option won't work in BSDs (except PacBSD and PC-BSD)
--uptime_shorthand on/off Shorten the output of uptime (tiny, on, off)
--refresh_rate on/off Whether to display the refresh rate of each monitor
Unsupported on Windows
--gpu_brand on/off Enable/Disable GPU brand in output. (AMD/NVIDIA/Intel)
--gtk_shorthand on/off Shorten output of gtk theme/icons
--gtk2 on/off Enable/Disable gtk2 theme/icons output
--gtk3 on/off Enable/Disable gtk3 theme/icons output
--gtk2 on/off Enable/Disable gtk2 theme/font/icons output
--gtk3 on/off Enable/Disable gtk3 theme/font/icons output
--shell_path on/off Enable/Disable showing \$SHELL path
--shell_version on/off Enable/Disable showing \$SHELL version
--ip_host url Url to query for public IP
--ip_host url URL to query for public IP
--song_shorthand on/off Print the Artist/Title on seperate lines
--birthday_shorthand on/off Shorten the output of birthday
--birthday_time on/off Enable/Disable showing the time in birthday output
--birthday_format format Format the birthday output. (Uses 'date' cmd format)
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 start end 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 '[]'
@ -3090,8 +3106,8 @@ usage() { printf "%s" "
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
@ -3110,39 +3126,83 @@ usage() { printf "%s" "
--bg_color color Background color to display behind transparent image.
This only works with w3m.
--gap num Gap between image and text.
NOTE: --gap can take a negative value which will
move the text closer to the left side.
NOTE: --gap can take a negative value which will move the text closer to the left side.
--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
--ascii_distro distro Which Distro's ascii art to print
NOTE: Arch and Ubuntu have 'old' logo varients.
NOTE: Use 'arch_old' or 'ubuntu_old' to use the old logos.
NOTE: Ubuntu has flavor varients.
NOTE: Change this to 'Lubuntu', 'Xubuntu', 'Ubuntu-GNOME'
or 'Ubuntu-Budgie' to use the flavors.
NOTE: Change this to 'Lubuntu', 'Xubuntu', 'Ubuntu-GNOME', 'Ubuntu-Studio' or 'Ubuntu-Budgie' to use the flavors.
--ascii_logo_size Size of ascii logo.
Supported distros: Arch, Gentoo, Crux, OpenBSD.
--ascii_bold on/off Whether or not to bold the ascii logo.
--logo | -L Hide the info text and only show the ascii logo.
-L, --logo Hide the info text and only show the ascii logo.
Screenshot:
--scrot | -s /path/to/img Take a screenshot, if path is left empty the screen-
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.
--upload | -su /pth/t/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
--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
--version Show neofetch version
-v Display error messages.
-vv Display a verbose log for error reporting.
DEVELOPER
--gen-man Generate a manpage for Neofetch in your PWD.
Report bugs to https://github.com/dylanaraps/neofetch/issues
"
exit 1
}
version() { printf "%s" "\
Neofetch 2.1.0
Copyright (c) 2016 Dylan Araps
License MIT: Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the 'Software'), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Written by Dylan Araps with help from the following people:
https://github.com/dylanaraps/neofetch/contributors
"
exit 1
}
@ -3313,7 +3373,8 @@ get_args() {
"-v") verbose="on" ;;
"-vv") set -x; verbose="on" ;;
"--help") usage ;;
"--version") printf "%s\n" "Neofetch 2.1.0"; exit ;;
"--version") version ;;
"--gen-man") help2man -N neofetch -o neofetch.1; exit 1 ;;
esac
shift

331
neofetch.1
View file

@ -1,317 +1,290 @@
.TH NEOFETCH "1" "December 2016" "2.1.0" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
.TH NEOFETCH "1" "December 2016" "Neofetch 2.1.0" "User Commands"
.SH NAME
neofetch \- simple system information script
Neofetch \- manual page for Neofetch 2.1.0
.SH SYNOPSIS
.B neofetch \fR[Optional Flags]
.B neofetch
\fI\,--option "value" --option "value"\/\fR
.SH DESCRIPTION
neofetch is a script that gathers information about your system and prints
it to the terminal next to an image, a distro's logo or any ASCII art of
your choice.
Neofetch is a CLI system information tool written in BASH.
.PP
NOTE: Every launch flag has a config option.
.SH OPTIONS
INFO
.TP
.B \--disable 'infoname'
Allows you to disable an info line from appearing in the output.
.br
NOTE: You can supply multiple args. eg.
.br
\'neofetch --disable cpu gpu disk shell\'
.br
NOTE: The arguments must all be lowercase.
\fB\-\-disable\fR infoname
Allows you to disable an info line from appearing
in the output.
.IP
NOTE: You can supply multiple args. eg. 'neofetch \fB\-\-disable\fR cpu gpu disk shell'
.TP
.B \--os_arch 'on/off'
\fB\-\-os_arch\fR on/off
Hide/Show OS architecture.
.TP
.B \--speed_type 'type'
\fB\-\-speed_type\fR type
Change the type of cpu speed to display.
.br
Possible values: current, min, max, bios,
scaling_current, scaling_min, scaling_max
.br
.IP
NOTE: This only support Linux with cpufreq.
.TP
.B \--cpu_shorthand 'type'
\fB\-\-cpu_shorthand\fR type
Shorten the output of CPU
.br
Possible values: name, speed, tiny, on, off
.TP
.B \--cpu_cores 'logical/physical/off'
\fB\-\-cpu_cores\fR type
Whether or not to display the number of CPU cores
.br
Note: 'physical' doesn't work on BSD.
Takes: logical, physical, off
.IP
NOTE: 'physical' doesn't work on BSD.
.TP
.B \--cpu_speed 'on/off'
\fB\-\-cpu_speed\fR on/off
Hide/Show cpu speed.
.TP
.B \--cpu_temp 'on/off'
\fB\-\-cpu_temp\fR on/off
Hide/Show cpu temperature.
.br
.IP
NOTE: This only works on Linux and BSD.
.br
NOTE: For FreeBSD-based systems, you need to enable coretemp kernel module.
.IP
NOTE: For FreeBSD\-based systems, you need to enable coretemp kernel module.
.TP
.B \--distro_shorthand 'on/off'
\fB\-\-distro_shorthand\fR on/off
Shorten the output of distro (tiny, on, off)
.br
.IP
NOTE: This option won't work in Windows (Cygwin)
.TP
.B \--kernel_shorthand 'on/off'
\fB\-\-kernel_shorthand\fR on/off
Shorten the output of kernel
.br
NOTE: This option won't work in BSDs (except PacBSD and PC-BSD)
.IP
NOTE: This option won't work in BSDs (except PacBSD and PC\-BSD)
.TP
.B \--uptime_shorthand 'on/off'
\fB\-\-uptime_shorthand\fR on/off
Shorten the output of uptime (tiny, on, off)
.TP
.B \--refresh_rate 'on/off'
\fB\-\-refresh_rate\fR on/off
Whether to display the refresh rate of each monitor
.br
Note: Unsupported on Windows
Unsupported on Windows
.TP
.B \--gpu_brand on/off
\fB\-\-gpu_brand\fR on/off
Enable/Disable GPU brand in output. (AMD/NVIDIA/Intel)
.TP
.B \--gtk_shorthand 'on/off'
\fB\-\-gtk_shorthand\fR on/off
Shorten output of gtk theme/icons
.TP
.B \--gtk2 'on/off'
Enable/Disable GTK2 theme/icons output
\fB\-\-gtk2\fR on/off
Enable/Disable gtk2 theme/font/icons output
.TP
.B \--gtk3 'on/off'
Enable/Disable gtk3 theme/icons output
\fB\-\-gtk3\fR on/off
Enable/Disable gtk3 theme/font/icons output
.TP
.B \--shell_path 'on/off'
\fB\-\-shell_path\fR on/off
Enable/Disable showing $SHELL path
.TP
.B \--shell_version 'on/off'
\fB\-\-shell_version\fR on/off
Enable/Disable showing $SHELL version
.TP
.B \--ip_host 'url'
\fB\-\-ip_host\fR url
URL to query for public IP
.TP
.B \--song_shorthand 'on/off'
\fB\-\-song_shorthand\fR on/off
Print the Artist/Title on seperate lines
.HP
\fB\-\-birthday_shorthand\fR on/off Shorten the output of birthday
.TP
.B \--birthday_shorthand 'on/off'
Shorten the output of birthday
.TP
.B \--birthday_time 'on/off'
\fB\-\-birthday_time\fR on/off
Enable/Disable showing the time in birthday output
.TP
.B \--birthday_format 'format'
\fB\-\-birthday_format\fR format
Format the birthday output. (Uses 'date' cmd format)
.SH TEXT FORMATTING
.PP
TEXT FORMATTING
.TP
.B \--colors x x x x x x
\fB\-\-colors\fR x x x x x x
Changes the text colors in this order:
title, @, underline, subtitle, colon, info
.TP
.B \--underline on/off
enable/disable the underline.
\fB\-\-underline\fR on/off
Enable/Disable the underline.
.TP
.B \--underline_char 'char'
\fB\-\-underline_char\fR char
Character to use when underlining title
.TP
.B \--bold 'on/off'
\fB\-\-bold\fR on/off
Enable/Disable bold text
.PP
COLOR BLOCKS
.TP
.B \--prompt_height 'num'
Set this to your prompt height to fix issues
with the text going off screen at the top
.SH COLOR BLOCKS
.TP
.B \--color_blocks 'on/off'
\fB\-\-color_blocks\fR on/off
Enable/Disable the color blocks
.TP
.B \--block_width 'num'
\fB\-\-block_width\fR num
Width of color blocks in spaces
.TP
.B \--block_height 'num'
\fB\-\-block_height\fR num
Height of color blocks in lines
.TP
.B \--block_range 'start' 'end'
\fB\-\-block_range\fR start end
Range of colors to print as blocks
.SH BARS
.PP
BARS
.TP
.B \--bar_char 'elapsed char' 'total char'
\fB\-\-bar_char\fR 'elapsed char' 'total char'
Characters to use when drawing bars.
.TP
.B \--bar_border on/off
\fB\-\-bar_border\fR on/off
Whether or not to surround the bar with '[]'
.TP
.B \--bar_length 'num'
\fB\-\-bar_length\fR num
Length in spaces to make the bars.
.TP
.B \--bar_colors 'num' 'num'
\fB\-\-bar_colors\fR num num
Colors to make the bar.
.br
Set in this order: elapsed, total
.TP
.B \--cpu_display 'mode'
\fB\-\-cpu_display\fR mode
Bar mode.
.br
Takes: bar, infobar, barinfo, off
.TP
.B \--memory_display 'mode'
\fB\-\-memory_display\fR mode
Bar mode.
.br
Takes: bar, infobar, barinfo, off
.TP
.B \--battery_display 'mode'
\fB\-\-battery_display\fR mode
Bar mode.
.br
Takes: bar, infobar, barinfo, off
.TP
.B \--disk_display 'mode'
\fB\-\-disk_display\fR mode
Bar mode.
.br
Takes: bar, infobar, barinfo, off
.SH IMAGE
.PP
IMAGE
.TP
.B \--image 'type'
\fB\-\-image\fR type
Image source. Where and what image we display.
.br
Possible values: wall, ascii, /path/to/img, /path/to/dir/, off
Possible values: wall, ascii,
\fI\,/path/to/img\/\fP, /path/to/dir/, off
.TP
.B \--size 'size'
\fB\-\-size\fR 00px | \fB\-\-size\fR 00%
How to size the image.
.br
Possible values: auto, 00px, 00%, none
.TP
.B \--crop_mode 'mode'
\fB\-\-crop_mode\fR mode
Which crop mode to use
.br
Takes the values: normal, fit, fill
.TP
.B \--crop_offset 'value'
\fB\-\-crop_offset\fR value
Change the crop offset for normal mode.
.br
Possible values: northwest, north, northeast,
west, center, east, southwest, south, southeast
.TP
.B \--xoffset 'value'
\fB\-\-xoffset\fR px
How close the image will be to the left edge of the
window in pixel. This only works with w3m.
window. This only works with w3m.
.TP
.B \--yoffset 'value'
How close the image will be to the top edge
of the window. This only works with w3m.
\fB\-\-yoffset\fR px
How close the image will be to the top edge of the
window. This only works with w3m.
.TP
.B \--bg_color 'color'
\fB\-\-bg_color\fR color
Background color to display behind transparent image.
This only works with w3m.
.TP
.B \--gap 'num'
\fB\-\-gap\fR num
Gap between image and text.
.br
NOTE: --gap can take a negative value which
will move the text closer to the left side.
.IP
NOTE: \fB\-\-gap\fR can take a negative value which will move the text closer to the left side.
.TP
.B \--clean
\fB\-\-clean\fR
Delete cached files and thumbnails.
.SH ASCII
.PP
ASCII
.TP
.B \--ascii 'value'
Where to get the ASCII from
.br
Possible values: distro, /path/to/ascii
\fB\-\-ascii\fR value
Where to get the ascii from, Possible values:
distro, \fI\,/path/to/ascii\/\fP
.TP
.B \--ascii_colors x x x x x x
Colors to print the ASCII art
\fB\-\-ascii_colors\fR x x x x x x
Colors to print the ascii art
.TP
.B \--ascii_distro 'distro'
Which Distro\'s ASCII art to print
.br
\fB\-\-ascii_distro\fR distro
Which Distro's ascii art to print
.IP
NOTE: Arch and Ubuntu have 'old' logo varients.
.br
.IP
NOTE: Use 'arch_old' or 'ubuntu_old' to use the old logos.
.br
.IP
NOTE: Ubuntu has flavor varients.
.br
NOTE: Change this to 'Lubuntu', 'Xubuntu', 'Ubuntu-GNOME' or 'Ubuntu-Budgie' to use the flavors.
.IP
NOTE: Change this to 'Lubuntu', 'Xubuntu', 'Ubuntu\-GNOME', 'Ubuntu\-Studio' or 'Ubuntu\-Budgie' to use the flavors.
.TP
.B \--ascii_logo_size 'size'
\fB\-\-ascii_logo_size\fR
Size of ascii logo.
Supported distros: Arch, Gentoo, Crux, OpenBSD.
Possible values: small, normal
.TP
.B \--ascii_bold 'on/off'
\fB\-\-ascii_bold\fR on/off
Whether or not to bold the ascii logo.
.TP
.B \--logo | -L
\fB\-L\fR, \fB\-\-logo\fR
Hide the info text and only show the ascii logo.
.SH SCREENSHOT
.PP
SCREENSHOT
.TP
.B \--scrot 'path'
Take a screenshot, if path is left empty the screenshot
function will use $scrot_dir and $scrot_name.
\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.
.TP
.B \--upload | -su 'path'
Same as --scrot but uploads the scrot to a website.
\fB\-su\fR, \fB\-\-upload\fR \fI\,/path/to/img\/\fP
Same as \fB\-\-scrot\fR but uploads the scrot to a website.
.TP
.B \--image_host 'host'
\fB\-\-image_host\fR
Website to upload scrots to. Takes: imgur, teknik
.TP
.B \--scrot_cmd 'cmd'
\fB\-\-scrot_cmd\fR cmd
Screenshot program to launch
.SH OTHER
.PP
OTHER
.TP
.B \--config 'path'
\fB\-\-config\fR \fI\,/path/to/config\/\fP
Specify a path to a custom config file
.TP
.B \--config none
\fB\-\-config\fR none
Launch the script without a config file
.TP
.B \--help
\fB\-\-help\fR
Print this text and exit
.TP
.B \--test
Launch the script with all functions / options enabled.
This should only be used for testing purposes, ie Travis.CI.
\fB\-\-version\fR
Show neofetch version
.TP
.B \--version
Show neofetch version.
.TP
.B \-v
\fB\-v\fR
Display error messages.
.TP
.B \-vv
\fB\-vv\fR
Display a verbose log for error reporting.
.SH "SEE ALSO"
http://github.com/dylanaraps/neofetch
.SH BUGS
Report bugs to <https://github.com/dylanaraps/neofetch/issues>
.SH LICENSE
The MIT License (MIT)
Copyright (c) 2016 Dylan Araps
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions:
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
.PP
DEVELOPER
.TP
\fB\-\-gen\-man\fR
Generate a manpage for Neofetch in your PWD.
.SH AUTHOR
Created by Dylan Araps.
Written by Dylan Araps with help from the following people:
.PP
https://github.com/dylanaraps/neofetch/contributors
.SH "REPORTING BUGS"
Report bugs to https://github.com/dylanaraps/neofetch/issues
.SH COPYRIGHT
Copyright \(co 2016 Dylan Araps
.PP
License MIT: Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the 'Software'), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
.PP
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.