Man: Add generated manpage

neofetch.1

-.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/icons output
 .TP
-.B \--gtk3 'on/off'
+\fB\-\-gtk3\fR on/off
 Enable/Disable gtk3 theme/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'
-URL to query for public IP
+\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' 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
-.TP
-.B \--test
-Launch the script with all functions / options enabled.
-This should only be used for testing purposes, ie Travis.CI.
+\fB\-\-help\fR
+Print this text and exit
 .TP
-.B \--version
-Show neofetch version.
+\fB\-\-version\fR
+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.
-
 .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 ASIS, 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.