Merge pull request #528 from dylanaraps/help2man
Generate man page from --help and --version
This commit is contained in:
commit
2541aa7c01
2 changed files with 241 additions and 207 deletions
117
neofetch
117
neofetch
|
@ -3015,67 +3015,83 @@ cache_uname() {
|
||||||
|
|
||||||
# FINISH UP
|
# FINISH UP
|
||||||
|
|
||||||
usage() { printf "%s" "
|
usage() { printf "%s" "\
|
||||||
NEOFETCH
|
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
|
--disable infoname Allows you to disable an info line from appearing
|
||||||
in the output.
|
in the output.
|
||||||
NOTE: You can supply multiple args. eg.
|
|
||||||
'neofetch --disable cpu gpu disk shell'
|
NOTE: You can supply multiple args. eg. 'neofetch --disable cpu gpu disk shell'
|
||||||
NOTE: The arguments must all be lowercase.
|
|
||||||
--os_arch on/off Hide/Show OS architecture.
|
--os_arch on/off Hide/Show OS architecture.
|
||||||
--speed_type 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.
|
||||||
|
|
||||||
--cpu_shorthand type Shorten the output of CPU
|
--cpu_shorthand type Shorten the output of CPU
|
||||||
Possible values: name, speed, tiny, on, off
|
Possible values: name, speed, tiny, on, off
|
||||||
--cpu_cores type Whether or not to display the number of CPU cores
|
--cpu_cores type Whether or not to display the number of CPU cores
|
||||||
Takes: logical, physical, off
|
Takes: logical, physical, off
|
||||||
|
|
||||||
NOTE: 'physical' doesn't work on BSD.
|
NOTE: 'physical' doesn't work on BSD.
|
||||||
|
|
||||||
--cpu_speed on/off Hide/Show cpu speed.
|
--cpu_speed on/off Hide/Show cpu speed.
|
||||||
--cpu_temp on/off Hide/Show cpu temperature.
|
--cpu_temp on/off Hide/Show cpu temperature.
|
||||||
|
|
||||||
NOTE: This only works on Linux and BSD.
|
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)
|
--distro_shorthand on/off Shorten the output of distro (tiny, on, off)
|
||||||
|
|
||||||
NOTE: This option won't work in Windows (Cygwin)
|
NOTE: This option won't work in Windows (Cygwin)
|
||||||
|
|
||||||
--kernel_shorthand on/off Shorten the output of kernel
|
--kernel_shorthand on/off Shorten the output of kernel
|
||||||
|
|
||||||
NOTE: This option won't work in BSDs (except PacBSD and PC-BSD)
|
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)
|
--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
|
--refresh_rate on/off Whether to display the refresh rate of each monitor
|
||||||
Unsupported on Windows
|
Unsupported on Windows
|
||||||
--gpu_brand on/off Enable/Disable GPU brand in output. (AMD/NVIDIA/Intel)
|
--gpu_brand on/off Enable/Disable GPU brand in output. (AMD/NVIDIA/Intel)
|
||||||
--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/font/icons output
|
||||||
--gtk3 on/off Enable/Disable gtk3 theme/icons output
|
--gtk3 on/off Enable/Disable gtk3 theme/font/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
|
||||||
--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
|
--song_shorthand on/off Print the Artist/Title on seperate lines
|
||||||
--birthday_shorthand on/off Shorten the output of birthday
|
--birthday_shorthand on/off Shorten the output of birthday
|
||||||
--birthday_time on/off Enable/Disable showing the time in birthday output
|
--birthday_time on/off Enable/Disable showing the time in birthday output
|
||||||
--birthday_format format Format the birthday output. (Uses 'date' cmd format)
|
--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:
|
--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 start end Range of colors to print as blocks
|
--block_range start end 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 '[]'
|
||||||
|
@ -3090,8 +3106,8 @@ usage() { printf "%s" "
|
||||||
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
|
||||||
|
@ -3110,39 +3126,83 @@ usage() { printf "%s" "
|
||||||
--bg_color color Background color to display behind transparent image.
|
--bg_color color Background color to display behind transparent image.
|
||||||
This only works with w3m.
|
This only works with w3m.
|
||||||
--gap num Gap between image and text.
|
--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.
|
--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
|
||||||
--ascii_distro distro Which Distro's ascii art to print
|
--ascii_distro distro Which Distro's ascii art to print
|
||||||
|
|
||||||
NOTE: Arch and Ubuntu have 'old' logo varients.
|
NOTE: Arch and Ubuntu have 'old' logo varients.
|
||||||
|
|
||||||
NOTE: Use 'arch_old' or 'ubuntu_old' to use the old logos.
|
NOTE: Use 'arch_old' or 'ubuntu_old' to use the old logos.
|
||||||
|
|
||||||
NOTE: Ubuntu has flavor varients.
|
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.
|
--ascii_logo_size Size of ascii logo.
|
||||||
Supported distros: Arch, Gentoo, Crux, OpenBSD.
|
Supported distros: Arch, Gentoo, Crux, OpenBSD.
|
||||||
--ascii_bold on/off Whether or not to bold the ascii logo.
|
--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:
|
SCREENSHOT
|
||||||
--scrot | -s /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.
|
||||||
--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
|
--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
|
||||||
--version Show neofetch version
|
--version Show neofetch version
|
||||||
-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
|
||||||
|
|
||||||
|
--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
|
exit 1
|
||||||
}
|
}
|
||||||
|
@ -3313,7 +3373,8 @@ get_args() {
|
||||||
"-v") verbose="on" ;;
|
"-v") verbose="on" ;;
|
||||||
"-vv") set -x; verbose="on" ;;
|
"-vv") set -x; verbose="on" ;;
|
||||||
"--help") usage ;;
|
"--help") usage ;;
|
||||||
"--version") printf "%s\n" "Neofetch 2.1.0"; exit ;;
|
"--version") version ;;
|
||||||
|
"--gen-man") help2man -N neofetch -o neofetch.1; exit 1 ;;
|
||||||
esac
|
esac
|
||||||
|
|
||||||
shift
|
shift
|
||||||
|
|
331
neofetch.1
331
neofetch.1
|
@ -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
|
.SH NAME
|
||||||
neofetch \- simple system information script
|
Neofetch \- manual page for Neofetch 2.1.0
|
||||||
|
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.B neofetch \fR[Optional Flags]
|
.B neofetch
|
||||||
|
\fI\,--option "value" --option "value"\/\fR
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
neofetch is a script that gathers information about your system and prints
|
Neofetch is a CLI system information tool written in BASH.
|
||||||
it to the terminal next to an image, a distro's logo or any ASCII art of
|
.PP
|
||||||
your choice.
|
NOTE: Every launch flag has a config option.
|
||||||
|
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
|
INFO
|
||||||
.TP
|
.TP
|
||||||
.B \--disable 'infoname'
|
\fB\-\-disable\fR infoname
|
||||||
Allows you to disable an info line from appearing in the output.
|
Allows you to disable an info line from appearing
|
||||||
.br
|
in the output.
|
||||||
NOTE: You can supply multiple args. eg.
|
.IP
|
||||||
.br
|
NOTE: You can supply multiple args. eg. 'neofetch \fB\-\-disable\fR cpu gpu disk shell'
|
||||||
\'neofetch --disable cpu gpu disk shell\'
|
|
||||||
.br
|
|
||||||
NOTE: The arguments must all be lowercase.
|
|
||||||
.TP
|
.TP
|
||||||
.B \--os_arch 'on/off'
|
\fB\-\-os_arch\fR on/off
|
||||||
Hide/Show OS architecture.
|
Hide/Show OS architecture.
|
||||||
.TP
|
.TP
|
||||||
.B \--speed_type 'type'
|
\fB\-\-speed_type\fR type
|
||||||
Change the type of cpu speed to display.
|
Change the type of cpu speed to display.
|
||||||
.br
|
|
||||||
Possible values: current, min, max, bios,
|
Possible values: current, min, max, bios,
|
||||||
scaling_current, scaling_min, scaling_max
|
scaling_current, scaling_min, scaling_max
|
||||||
.br
|
.IP
|
||||||
NOTE: This only support Linux with cpufreq.
|
NOTE: This only support Linux with cpufreq.
|
||||||
.TP
|
.TP
|
||||||
.B \--cpu_shorthand 'type'
|
\fB\-\-cpu_shorthand\fR type
|
||||||
Shorten the output of CPU
|
Shorten the output of CPU
|
||||||
.br
|
|
||||||
Possible values: name, speed, tiny, on, off
|
Possible values: name, speed, tiny, on, off
|
||||||
.TP
|
.TP
|
||||||
.B \--cpu_cores 'logical/physical/off'
|
\fB\-\-cpu_cores\fR type
|
||||||
Whether or not to display the number of CPU cores
|
Whether or not to display the number of CPU cores
|
||||||
.br
|
Takes: logical, physical, off
|
||||||
Note: 'physical' doesn't work on BSD.
|
.IP
|
||||||
|
NOTE: 'physical' doesn't work on BSD.
|
||||||
.TP
|
.TP
|
||||||
.B \--cpu_speed 'on/off'
|
\fB\-\-cpu_speed\fR on/off
|
||||||
Hide/Show cpu speed.
|
Hide/Show cpu speed.
|
||||||
.TP
|
.TP
|
||||||
.B \--cpu_temp 'on/off'
|
\fB\-\-cpu_temp\fR on/off
|
||||||
Hide/Show cpu temperature.
|
Hide/Show cpu temperature.
|
||||||
.br
|
.IP
|
||||||
NOTE: This only works on Linux and BSD.
|
NOTE: This only works on Linux and BSD.
|
||||||
.br
|
.IP
|
||||||
NOTE: For FreeBSD-based systems, you need to enable coretemp kernel module.
|
NOTE: For FreeBSD\-based systems, you need to enable coretemp kernel module.
|
||||||
.TP
|
.TP
|
||||||
.B \--distro_shorthand 'on/off'
|
\fB\-\-distro_shorthand\fR on/off
|
||||||
Shorten the output of distro (tiny, on, off)
|
Shorten the output of distro (tiny, on, off)
|
||||||
.br
|
.IP
|
||||||
NOTE: This option won't work in Windows (Cygwin)
|
NOTE: This option won't work in Windows (Cygwin)
|
||||||
.TP
|
.TP
|
||||||
.B \--kernel_shorthand 'on/off'
|
\fB\-\-kernel_shorthand\fR on/off
|
||||||
Shorten the output of kernel
|
Shorten the output of kernel
|
||||||
.br
|
.IP
|
||||||
NOTE: This option won't work in BSDs (except PacBSD and PC-BSD)
|
NOTE: This option won't work in BSDs (except PacBSD and PC\-BSD)
|
||||||
.TP
|
.TP
|
||||||
.B \--uptime_shorthand 'on/off'
|
\fB\-\-uptime_shorthand\fR on/off
|
||||||
Shorten the output of uptime (tiny, on, off)
|
Shorten the output of uptime (tiny, on, off)
|
||||||
.TP
|
.TP
|
||||||
.B \--refresh_rate 'on/off'
|
\fB\-\-refresh_rate\fR on/off
|
||||||
Whether to display the refresh rate of each monitor
|
Whether to display the refresh rate of each monitor
|
||||||
.br
|
Unsupported on Windows
|
||||||
Note: Unsupported on Windows
|
|
||||||
.TP
|
.TP
|
||||||
.B \--gpu_brand on/off
|
\fB\-\-gpu_brand\fR on/off
|
||||||
Enable/Disable GPU brand in output. (AMD/NVIDIA/Intel)
|
Enable/Disable GPU brand in output. (AMD/NVIDIA/Intel)
|
||||||
.TP
|
.TP
|
||||||
.B \--gtk_shorthand 'on/off'
|
\fB\-\-gtk_shorthand\fR on/off
|
||||||
Shorten output of gtk theme/icons
|
Shorten output of gtk theme/icons
|
||||||
.TP
|
.TP
|
||||||
.B \--gtk2 'on/off'
|
\fB\-\-gtk2\fR on/off
|
||||||
Enable/Disable GTK2 theme/icons output
|
Enable/Disable gtk2 theme/font/icons output
|
||||||
.TP
|
.TP
|
||||||
.B \--gtk3 'on/off'
|
\fB\-\-gtk3\fR on/off
|
||||||
Enable/Disable gtk3 theme/icons output
|
Enable/Disable gtk3 theme/font/icons output
|
||||||
.TP
|
.TP
|
||||||
.B \--shell_path 'on/off'
|
\fB\-\-shell_path\fR on/off
|
||||||
Enable/Disable showing $SHELL path
|
Enable/Disable showing $SHELL path
|
||||||
.TP
|
.TP
|
||||||
.B \--shell_version 'on/off'
|
\fB\-\-shell_version\fR on/off
|
||||||
Enable/Disable showing $SHELL version
|
Enable/Disable showing $SHELL version
|
||||||
.TP
|
.TP
|
||||||
.B \--ip_host 'url'
|
\fB\-\-ip_host\fR url
|
||||||
URL to query for public IP
|
URL to query for public IP
|
||||||
.TP
|
.TP
|
||||||
.B \--song_shorthand 'on/off'
|
\fB\-\-song_shorthand\fR on/off
|
||||||
Print the Artist/Title on seperate lines
|
Print the Artist/Title on seperate lines
|
||||||
|
.HP
|
||||||
|
\fB\-\-birthday_shorthand\fR on/off Shorten the output of birthday
|
||||||
.TP
|
.TP
|
||||||
.B \--birthday_shorthand 'on/off'
|
\fB\-\-birthday_time\fR on/off
|
||||||
Shorten the output of birthday
|
|
||||||
.TP
|
|
||||||
.B \--birthday_time 'on/off'
|
|
||||||
Enable/Disable showing the time in birthday output
|
Enable/Disable showing the time in birthday output
|
||||||
.TP
|
.TP
|
||||||
.B \--birthday_format 'format'
|
\fB\-\-birthday_format\fR format
|
||||||
Format the birthday output. (Uses 'date' cmd format)
|
Format the birthday output. (Uses 'date' cmd format)
|
||||||
|
.PP
|
||||||
.SH TEXT FORMATTING
|
TEXT FORMATTING
|
||||||
.TP
|
.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:
|
Changes the text colors in this order:
|
||||||
title, @, underline, subtitle, colon, info
|
title, @, underline, subtitle, colon, info
|
||||||
.TP
|
.TP
|
||||||
.B \--underline on/off
|
\fB\-\-underline\fR on/off
|
||||||
enable/disable the underline.
|
Enable/Disable the underline.
|
||||||
.TP
|
.TP
|
||||||
.B \--underline_char 'char'
|
\fB\-\-underline_char\fR char
|
||||||
Character to use when underlining title
|
Character to use when underlining title
|
||||||
.TP
|
.TP
|
||||||
.B \--bold 'on/off'
|
\fB\-\-bold\fR on/off
|
||||||
Enable/Disable bold text
|
Enable/Disable bold text
|
||||||
|
.PP
|
||||||
|
COLOR BLOCKS
|
||||||
.TP
|
.TP
|
||||||
.B \--prompt_height 'num'
|
\fB\-\-color_blocks\fR on/off
|
||||||
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'
|
|
||||||
Enable/Disable the color blocks
|
Enable/Disable the color blocks
|
||||||
.TP
|
.TP
|
||||||
.B \--block_width 'num'
|
\fB\-\-block_width\fR num
|
||||||
Width of color blocks in spaces
|
Width of color blocks in spaces
|
||||||
.TP
|
.TP
|
||||||
.B \--block_height 'num'
|
\fB\-\-block_height\fR num
|
||||||
Height of color blocks in lines
|
Height of color blocks in lines
|
||||||
.TP
|
.TP
|
||||||
.B \--block_range 'start' 'end'
|
\fB\-\-block_range\fR start end
|
||||||
Range of colors to print as blocks
|
Range of colors to print as blocks
|
||||||
|
.PP
|
||||||
.SH BARS
|
BARS
|
||||||
.TP
|
.TP
|
||||||
.B \--bar_char 'elapsed char' 'total char'
|
\fB\-\-bar_char\fR 'elapsed char' 'total char'
|
||||||
Characters to use when drawing bars.
|
Characters to use when drawing bars.
|
||||||
.TP
|
.TP
|
||||||
.B \--bar_border on/off
|
\fB\-\-bar_border\fR on/off
|
||||||
Whether or not to surround the bar with '[]'
|
Whether or not to surround the bar with '[]'
|
||||||
.TP
|
.TP
|
||||||
.B \--bar_length 'num'
|
\fB\-\-bar_length\fR num
|
||||||
Length in spaces to make the bars.
|
Length in spaces to make the bars.
|
||||||
.TP
|
.TP
|
||||||
.B \--bar_colors 'num' 'num'
|
\fB\-\-bar_colors\fR num num
|
||||||
Colors to make the bar.
|
Colors to make the bar.
|
||||||
.br
|
|
||||||
Set in this order: elapsed, total
|
Set in this order: elapsed, total
|
||||||
.TP
|
.TP
|
||||||
.B \--cpu_display 'mode'
|
\fB\-\-cpu_display\fR mode
|
||||||
Bar mode.
|
Bar mode.
|
||||||
.br
|
|
||||||
Takes: bar, infobar, barinfo, off
|
Takes: bar, infobar, barinfo, off
|
||||||
.TP
|
.TP
|
||||||
.B \--memory_display 'mode'
|
\fB\-\-memory_display\fR mode
|
||||||
Bar mode.
|
Bar mode.
|
||||||
.br
|
|
||||||
Takes: bar, infobar, barinfo, off
|
Takes: bar, infobar, barinfo, off
|
||||||
.TP
|
.TP
|
||||||
.B \--battery_display 'mode'
|
\fB\-\-battery_display\fR mode
|
||||||
Bar mode.
|
Bar mode.
|
||||||
.br
|
|
||||||
Takes: bar, infobar, barinfo, off
|
Takes: bar, infobar, barinfo, off
|
||||||
.TP
|
.TP
|
||||||
.B \--disk_display 'mode'
|
\fB\-\-disk_display\fR mode
|
||||||
Bar mode.
|
Bar mode.
|
||||||
.br
|
|
||||||
Takes: bar, infobar, barinfo, off
|
Takes: bar, infobar, barinfo, off
|
||||||
|
.PP
|
||||||
.SH IMAGE
|
IMAGE
|
||||||
.TP
|
.TP
|
||||||
.B \--image 'type'
|
\fB\-\-image\fR type
|
||||||
Image source. Where and what image we display.
|
Image source. Where and what image we display.
|
||||||
.br
|
Possible values: wall, ascii,
|
||||||
Possible values: wall, ascii, /path/to/img, /path/to/dir/, off
|
\fI\,/path/to/img\/\fP, /path/to/dir/, off
|
||||||
.TP
|
.TP
|
||||||
.B \--size 'size'
|
\fB\-\-size\fR 00px | \fB\-\-size\fR 00%
|
||||||
How to size the image.
|
How to size the image.
|
||||||
.br
|
|
||||||
Possible values: auto, 00px, 00%, none
|
Possible values: auto, 00px, 00%, none
|
||||||
.TP
|
.TP
|
||||||
.B \--crop_mode 'mode'
|
\fB\-\-crop_mode\fR mode
|
||||||
Which crop mode to use
|
Which crop mode to use
|
||||||
.br
|
|
||||||
Takes the values: normal, fit, fill
|
Takes the values: normal, fit, fill
|
||||||
.TP
|
.TP
|
||||||
.B \--crop_offset 'value'
|
\fB\-\-crop_offset\fR value
|
||||||
Change the crop offset for normal mode.
|
Change the crop offset for normal mode.
|
||||||
.br
|
|
||||||
Possible values: northwest, north, northeast,
|
Possible values: northwest, north, northeast,
|
||||||
west, center, east, southwest, south, southeast
|
west, center, east, southwest, south, southeast
|
||||||
.TP
|
.TP
|
||||||
.B \--xoffset 'value'
|
\fB\-\-xoffset\fR px
|
||||||
How close the image will be to the left edge of the
|
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
|
.TP
|
||||||
.B \--yoffset 'value'
|
\fB\-\-yoffset\fR px
|
||||||
How close the image will be to the top edge
|
How close the image will be to the top edge of the
|
||||||
of the window. This only works with w3m.
|
window. This only works with w3m.
|
||||||
.TP
|
.TP
|
||||||
.B \--bg_color 'color'
|
\fB\-\-bg_color\fR color
|
||||||
Background color to display behind transparent image.
|
Background color to display behind transparent image.
|
||||||
This only works with w3m.
|
This only works with w3m.
|
||||||
.TP
|
.TP
|
||||||
.B \--gap 'num'
|
\fB\-\-gap\fR num
|
||||||
Gap between image and text.
|
Gap between image and text.
|
||||||
.br
|
.IP
|
||||||
NOTE: --gap can take a negative value which
|
NOTE: \fB\-\-gap\fR can take a negative value which will move the text closer to the left side.
|
||||||
will move the text closer to the left side.
|
|
||||||
.TP
|
.TP
|
||||||
.B \--clean
|
\fB\-\-clean\fR
|
||||||
Delete cached files and thumbnails.
|
Delete cached files and thumbnails.
|
||||||
|
.PP
|
||||||
.SH ASCII
|
ASCII
|
||||||
.TP
|
.TP
|
||||||
.B \--ascii 'value'
|
\fB\-\-ascii\fR value
|
||||||
Where to get the ASCII from
|
Where to get the ascii from, Possible values:
|
||||||
.br
|
distro, \fI\,/path/to/ascii\/\fP
|
||||||
Possible values: distro, /path/to/ascii
|
|
||||||
.TP
|
.TP
|
||||||
.B \--ascii_colors x x x x x x
|
\fB\-\-ascii_colors\fR x x x x x x
|
||||||
Colors to print the ASCII art
|
Colors to print the ascii art
|
||||||
.TP
|
.TP
|
||||||
.B \--ascii_distro 'distro'
|
\fB\-\-ascii_distro\fR distro
|
||||||
Which Distro\'s ASCII art to print
|
Which Distro's ascii art to print
|
||||||
.br
|
.IP
|
||||||
NOTE: Arch and Ubuntu have 'old' logo varients.
|
NOTE: Arch and Ubuntu have 'old' logo varients.
|
||||||
.br
|
.IP
|
||||||
NOTE: Use 'arch_old' or 'ubuntu_old' to use the old logos.
|
NOTE: Use 'arch_old' or 'ubuntu_old' to use the old logos.
|
||||||
.br
|
.IP
|
||||||
NOTE: Ubuntu has flavor varients.
|
NOTE: Ubuntu has flavor varients.
|
||||||
.br
|
.IP
|
||||||
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.
|
||||||
.TP
|
.TP
|
||||||
.B \--ascii_logo_size 'size'
|
\fB\-\-ascii_logo_size\fR
|
||||||
Size of ascii logo.
|
Size of ascii logo.
|
||||||
Supported distros: Arch, Gentoo, Crux, OpenBSD.
|
Supported distros: Arch, Gentoo, Crux, OpenBSD.
|
||||||
Possible values: small, normal
|
|
||||||
.TP
|
.TP
|
||||||
.B \--ascii_bold 'on/off'
|
\fB\-\-ascii_bold\fR on/off
|
||||||
Whether or not to bold the ascii logo.
|
Whether or not to bold the ascii logo.
|
||||||
.TP
|
.TP
|
||||||
.B \--logo | -L
|
\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
|
||||||
.SH SCREENSHOT
|
SCREENSHOT
|
||||||
.TP
|
.TP
|
||||||
.B \--scrot 'path'
|
\fB\-s\fR, \fB\-\-scrot\fR \fI\,/path/to/img\/\fP
|
||||||
Take a screenshot, if path is left empty the screenshot
|
Take a screenshot, if path is left empty the screenshot function will use $scrot_dir and $scrot_name.
|
||||||
function will use $scrot_dir and $scrot_name.
|
|
||||||
.TP
|
.TP
|
||||||
.B \--upload | -su 'path'
|
\fB\-su\fR, \fB\-\-upload\fR \fI\,/path/to/img\/\fP
|
||||||
Same as --scrot but uploads the scrot to a website.
|
Same as \fB\-\-scrot\fR but uploads the scrot to a website.
|
||||||
.TP
|
.TP
|
||||||
.B \--image_host 'host'
|
\fB\-\-image_host\fR
|
||||||
Website to upload scrots to. Takes: imgur, teknik
|
Website to upload scrots to. Takes: imgur, teknik
|
||||||
.TP
|
.TP
|
||||||
.B \--scrot_cmd 'cmd'
|
\fB\-\-scrot_cmd\fR cmd
|
||||||
Screenshot program to launch
|
Screenshot program to launch
|
||||||
|
.PP
|
||||||
.SH OTHER
|
OTHER
|
||||||
.TP
|
.TP
|
||||||
.B \--config 'path'
|
\fB\-\-config\fR \fI\,/path/to/config\/\fP
|
||||||
Specify a path to a custom config file
|
Specify a path to a custom config file
|
||||||
.TP
|
.TP
|
||||||
.B \--config none
|
\fB\-\-config\fR none
|
||||||
Launch the script without a config file
|
Launch the script without a config file
|
||||||
.TP
|
.TP
|
||||||
.B \--help
|
\fB\-\-help\fR
|
||||||
|
Print this text and exit
|
||||||
.TP
|
.TP
|
||||||
.B \--test
|
\fB\-\-version\fR
|
||||||
Launch the script with all functions / options enabled.
|
Show neofetch version
|
||||||
This should only be used for testing purposes, ie Travis.CI.
|
|
||||||
.TP
|
.TP
|
||||||
.B \--version
|
\fB\-v\fR
|
||||||
Show neofetch version.
|
|
||||||
.TP
|
|
||||||
.B \-v
|
|
||||||
Display error messages.
|
Display error messages.
|
||||||
.TP
|
.TP
|
||||||
.B \-vv
|
\fB\-vv\fR
|
||||||
Display a verbose log for error reporting.
|
Display a verbose log for error reporting.
|
||||||
|
.PP
|
||||||
.SH "SEE ALSO"
|
DEVELOPER
|
||||||
http://github.com/dylanaraps/neofetch
|
.TP
|
||||||
|
\fB\-\-gen\-man\fR
|
||||||
.SH BUGS
|
Generate a manpage for Neofetch in your PWD.
|
||||||
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.
|
|
||||||
|
|
||||||
.SH AUTHOR
|
.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.
|
||||||
|
|
Loading…
Reference in a new issue