hyfetch/neofetch.1

329 lines
9 KiB
Groff
Raw Normal View History

2016-12-13 18:47:44 -07:00
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
2017-01-22 20:41:10 -07:00
.TH NEOFETCH "1" "January 2017" "Neofetch 3.0.1" "User Commands"
2016-03-04 06:59:56 -07:00
.SH NAME
Neofetch \- A fast, highly customizable system info script
2016-03-04 06:59:56 -07:00
.SH SYNOPSIS
2016-12-13 18:47:44 -07:00
.B neofetch
\fI\,--option "value" --option "value"\/\fR
2016-03-04 06:59:56 -07:00
.SH DESCRIPTION
Neofetch is a CLI system information tool written in BASH. Neofetch
displays information about your system next to an image, your OS logo,
or any ASCII file of your choice.
2016-12-13 18:47:44 -07:00
.PP
NOTE: Every launch flag has a config option.
2016-03-04 06:59:56 -07:00
.SH OPTIONS
2016-12-29 01:26:44 -07:00
.SS "INFO:"
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\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'
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-os_arch\fR on/off
Hide/Show OS architecture.
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-speed_type\fR type
2016-03-04 06:59:56 -07:00
Change the type of cpu speed to display.
Possible values: current, min, max, bios,
scaling_current, scaling_min, scaling_max
2016-12-13 18:47:44 -07:00
.IP
NOTE: This only supports Linux with cpufreq.
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-cpu_shorthand\fR type
Shorten the output of CPU
Possible values: name, speed, tiny, on, off
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-cpu_cores\fR type
2016-03-15 01:55:35 -06:00
Whether or not to display the number of CPU cores
2017-01-14 18:13:10 -07:00
Possible values: logical, physical, off
2016-12-13 18:47:44 -07:00
.IP
NOTE: 'physical' doesn't work on BSD.
2016-03-15 01:55:35 -06:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-cpu_speed\fR on/off
2016-10-22 16:45:03 -06:00
Hide/Show cpu speed.
.TP
2017-01-01 17:30:34 -07:00
\fB\-\-cpu_temp\fR C/F/off
2016-10-22 16:45:03 -06:00
Hide/Show cpu temperature.
2016-12-13 18:47:44 -07:00
.IP
2016-11-26 00:43:59 -07:00
NOTE: This only works on Linux and BSD.
2016-12-13 18:47:44 -07:00
.IP
NOTE: For FreeBSD\-based systems, you need to enable coretemp kernel module.
2016-10-22 16:45:03 -06:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-distro_shorthand\fR on/off
Shorten the output of distro (tiny, on, off)
2016-12-13 18:47:44 -07:00
.IP
2016-10-30 01:18:15 -06:00
NOTE: This option won't work in Windows (Cygwin)
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-kernel_shorthand\fR on/off
2016-03-04 06:59:56 -07:00
Shorten the output of kernel
2016-12-13 18:47:44 -07:00
.IP
NOTE: This option won't work in BSDs (except PacBSD and PC\-BSD)
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-uptime_shorthand\fR on/off
2016-03-04 06:59:56 -07:00
Shorten the output of uptime (tiny, on, off)
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-refresh_rate\fR on/off
2016-03-17 23:32:06 -06:00
Whether to display the refresh rate of each monitor
2016-12-13 18:47:44 -07:00
Unsupported on Windows
2016-03-17 23:32:06 -06:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-gpu_brand\fR on/off
Enable/Disable GPU brand in output. (AMD/NVIDIA/Intel)
.TP
2016-12-21 19:23:48 -07:00
\fB\-\-gpu_type\fR type
Which GPU to display. (all, dedicated, integrated)
.IP
NOTE: This only supports Linux.
2016-12-21 19:23:48 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-gtk_shorthand\fR on/off
2016-03-04 06:59:56 -07:00
Shorten output of gtk theme/icons
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-gtk2\fR on/off
2016-12-13 23:10:20 -07:00
Enable/Disable gtk2 theme/font/icons output
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-gtk3\fR on/off
2016-12-13 23:10:20 -07:00
Enable/Disable gtk3 theme/font/icons output
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-shell_path\fR on/off
2016-10-03 00:05:29 -06:00
Enable/Disable showing $SHELL path
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-shell_version\fR on/off
2016-10-03 00:05:29 -06:00
Enable/Disable showing $SHELL version
2016-03-04 06:59:56 -07:00
.TP
2017-01-06 00:53:40 -07:00
\fB\-\-disk_show\fR value
Which disks to display.
2017-01-14 18:13:10 -07:00
Possible values: '/', '/dev/sdXX', '/path/to/mount point'
2017-01-06 00:53:40 -07:00
.IP
NOTE: Multiple values can be given. (\fB\-\-disk_show\fR '/' '/dev/sdc1')
.TP
2017-01-07 20:23:55 -07:00
\fB\-\-disk_subtitle\fR name/mount
What information to append to the Disk subtitle.
.IP
\&'name' shows the disk's name (sda1, sda2, etc)
.IP
\&'mount' shows the disk's mount point (/, \fI\,/mnt/Local\/\fP Disk, etc)
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-ip_host\fR url
2016-12-13 23:08:55 -07:00
URL to query for public IP
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-song_shorthand\fR on/off
2016-12-18 20:53:38 -07:00
Print the Artist/Title on separate lines
2016-03-04 06:59:56 -07:00
.TP
\fB\-\-install_time\fR on/off
Enable/Disable showing the time in Install Date output.
.TP
\fB\-\-install_time_format\fR 12h/24h
Set time format in Install Date to be 12 hour or 24 hour.
2016-12-29 01:26:44 -07:00
.SS "TEXT FORMATTING:"
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-colors\fR x x x x x x
2016-03-04 06:59:56 -07:00
Changes the text colors in this order:
title, @, underline, subtitle, colon, info
2016-04-29 01:41:21 -06:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-underline\fR on/off
Enable/Disable the underline.
2016-04-29 01:41:21 -06:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-underline_char\fR char
2016-03-04 07:18:22 -07:00
Character to use when underlining title
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-bold\fR on/off
2016-03-04 06:59:56 -07:00
Enable/Disable bold text
2016-12-29 01:26:44 -07:00
.SS "COLOR BLOCKS:"
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-color_blocks\fR on/off
2016-03-04 06:59:56 -07:00
Enable/Disable the color blocks
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-block_width\fR num
Width of color blocks in spaces
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-block_height\fR num
Height of color blocks in lines
2016-03-04 06:59:56 -07:00
.TP
2016-12-23 06:09:32 -07:00
\fB\-\-block_range\fR num num
2016-03-04 06:59:56 -07:00
Range of colors to print as blocks
2016-12-29 01:26:44 -07:00
.SS "BARS:"
2016-03-12 15:14:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-bar_char\fR 'elapsed char' 'total char'
Characters to use when drawing bars.
2016-04-29 01:41:21 -06:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-bar_border\fR on/off
2016-04-29 01:41:21 -06:00
Whether or not to surround the bar with '[]'
2016-03-12 15:14:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-bar_length\fR num
Length in spaces to make the bars.
2016-03-12 15:14:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-bar_colors\fR num num
Colors to make the bar.
2016-03-12 15:14:56 -07:00
Set in this order: elapsed, total
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-cpu_display\fR mode
Bar mode.
2017-01-14 18:13:10 -07:00
Possible values: bar, infobar, barinfo, off
2016-03-12 15:14:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-memory_display\fR mode
Bar mode.
2017-01-14 18:13:10 -07:00
Possible values: bar, infobar, barinfo, off
2016-03-12 15:14:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-battery_display\fR mode
Bar mode.
2017-01-14 18:13:10 -07:00
Possible values: bar, infobar, barinfo, off
2016-03-12 15:14:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-disk_display\fR mode
Bar mode.
2017-01-14 18:13:10 -07:00
Possible values: bar, infobar, barinfo, off
.SS "IMAGE BACKEND:"
.TP
2017-01-16 20:59:57 -07:00
\fB\-\-backend\fR backend
Which image backend to use.
2017-01-14 06:15:33 -07:00
Possible values: 'ascii', 'caca', 'catimg', 'jp2a', 'iterm2', 'off', 'tycat', 'w3m'
.TP
2017-01-16 20:59:57 -07:00
\fB\-\-source\fR source
Which image or ascii file to use.
Possible values: 'auto', 'ascii', 'wallpaper', '/path/to/img', '/path/to/ascii', '/path/to/dir/'
.TP
\fB\-\-ascii\fR source
Shortcut to use 'ascii' backend.
.TP
\fB\-\-caca\fR source
Shortcut to use 'caca' backend.
.TP
\fB\-\-catimg\fR source
Shortcut to use 'catimg' backend.
.TP
\fB\-\-iterm2\fR source
Shortcut to use 'iterm2' backend.
2017-01-22 16:02:30 -07:00
.TP
\fB\-\-jp2a\fR source
Shortcut to use 'jp2a' backend.
.TP
\fB\-\-tycat\fR source
Shortcut to use 'tycat' backend.
.TP
\fB\-\-w3m\fR source
Shortcut to use 'w3m' backend.
2017-01-16 20:59:57 -07:00
.TP
\fB\-\-off\fR
Shortcut to use 'off' backend.
.IP
NOTE: 'source; can be any of the following: 'auto', 'ascii', 'wallpaper', '/path/to/img', '/path/to/ascii', '/path/to/dir/'
.SS "ASCII:"
.TP
\fB\-\-ascii_colors\fR x x x x x x
Colors to print the ascii art
.TP
\fB\-\-ascii_distro\fR distro
Which Distro's ascii art to print
.IP
NOTE: Arch and Ubuntu have 'old' logo variants.
.IP
NOTE: Use 'arch_old' or 'ubuntu_old' to use the old logos.
.IP
NOTE: Ubuntu has flavor variants.
.IP
NOTE: Change this to 'Lubuntu', 'Xubuntu', 'Ubuntu\-GNOME', 'Ubuntu\-Studio' or 'Ubuntu\-Budgie' to use the flavors.
.IP
NOTE: Alpine, Arch, Crux, Gentoo, OpenBSD, and Void have a smaller logo variant.
.IP
NOTE: Change this to 'alpine_small', 'arch_small', 'crux_small', 'gentoo_small', 'openbsd_small', and 'void_small' to use the small logos.
.TP
\fB\-\-ascii_bold\fR on/off
Whether or not to bold the ascii logo.
2016-03-04 06:59:56 -07:00
.TP
\fB\-L\fR, \fB\-\-logo\fR
Hide the info text and only show the ascii logo.
.IP
Possible values: bar, infobar, barinfo, off
.SS "IMAGE:"
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-size\fR 00px | \fB\-\-size\fR 00%
2016-05-26 23:23:02 -06:00
How to size the image.
Possible values: auto, 00px, 00%, none
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-crop_mode\fR mode
2016-03-04 06:59:56 -07:00
Which crop mode to use
2016-03-12 15:14:56 -07:00
Takes the values: normal, fit, fill
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-crop_offset\fR value
2016-03-04 06:59:56 -07:00
Change the crop offset for normal mode.
Possible values: northwest, north, northeast,
west, center, east, southwest, south, southeast
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-xoffset\fR px
2016-03-04 06:59:56 -07:00
How close the image will be to the left edge of the
2016-12-13 18:47:44 -07:00
window. This only works with w3m.
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-yoffset\fR px
How close the image will be to the top edge of the
window. This only works with w3m.
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-bg_color\fR color
2016-10-21 08:14:02 -06:00
Background color to display behind transparent image.
This only works with w3m.
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-gap\fR num
2016-03-04 06:59:56 -07:00
Gap between image and text.
2016-12-13 18:47:44 -07:00
.IP
NOTE: \fB\-\-gap\fR can take a negative value which will move the text closer to the left side.
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-clean\fR
2016-11-15 04:34:44 -07:00
Delete cached files and thumbnails.
2016-12-29 01:26:44 -07:00
.SS "SCREENSHOT:"
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\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.
2016-10-03 15:26:31 -06:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-su\fR, \fB\-\-upload\fR \fI\,/path/to/img\/\fP
Same as \fB\-\-scrot\fR but uploads the scrot to a website.
2016-10-03 15:26:31 -06:00
.TP
2017-01-14 18:13:10 -07:00
\fB\-\-image_host\fR imgur/teknik
Website to upload scrots to.
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-scrot_cmd\fR cmd
2016-03-04 06:59:56 -07:00
Screenshot program to launch
2016-12-29 01:26:44 -07:00
.SS "OTHER:"
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-config\fR \fI\,/path/to/config\/\fP
2016-03-04 06:59:56 -07:00
Specify a path to a custom config file
2016-05-08 16:27:59 -06:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-config\fR none
2016-05-08 16:27:59 -06:00
Launch the script without a config file
2016-03-04 06:59:56 -07:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-help\fR
Print this text and exit
2016-04-29 01:41:21 -06:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-\-version\fR
Show neofetch version
2016-05-29 23:14:16 -06:00
.TP
2016-12-13 18:47:44 -07:00
\fB\-v\fR
2016-04-29 01:41:21 -06:00
Display error messages.
.TP
2016-12-13 18:47:44 -07:00
\fB\-vv\fR
2016-04-29 01:41:21 -06:00
Display a verbose log for error reporting.
2016-12-29 01:26:44 -07:00
.SS "DEVELOPER:"
2016-12-14 05:04:08 -07:00
.TP
\fB\-\-gen\-man\fR
Generate a manpage for Neofetch in your PWD. (Requires GNU help2man)
2016-03-04 06:59:56 -07:00
.SH AUTHOR
2016-12-13 18:47:44 -07:00
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
2017-01-06 05:16:44 -07:00
Copyright \(co 2016\-2017 Dylan Araps
2016-12-13 18:47:44 -07:00
.PP
Permission is hereby granted, free of charge, to any person obtaining a copy
2016-12-13 23:21:17 -07:00
of this software and associated documentation files (the 'Software'), to deal
2016-12-13 18:47:44 -07:00
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
2016-12-13 23:21:17 -07:00
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
2016-12-13 18:47:44 -07:00
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.