Scroll to navigation

NEOFETCH(1) User Commands NEOFETCH(1)

NAME

Neofetch - A fast, highly customizable system info script

SYNOPSIS

neofetch --option "value" --option "value"

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.

NOTE: Every launch flag has a config option.

OPTIONS

INFO:

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'
Hide/Show OS architecture.
Change the type of cpu speed to display. Possible values: current, min, max, bios, scaling_current, scaling_min, scaling_max
NOTE: This only supports Linux with cpufreq.
Whether or not to show decimals in CPU speed.
Shorten the output of CPU Possible values: name, speed, tiny, on, off
Whether or not to display the number of CPU cores Possible values: logical, physical, off
NOTE: 'physical' doesn't work on BSD.
Hide/Show cpu speed.
Hide/Show cpu temperature.
NOTE: This only works on Linux and BSD.
NOTE: For FreeBSD-based systems, you need to enable coretemp kernel module.
Shorten the output of distro (tiny, on, off)
NOTE: This option won't work in Windows (Cygwin)
Shorten the output of kernel
NOTE: This option won't work in BSDs (except PacBSD and PC-BSD)
Shorten the output of uptime (tiny, on, off)
Whether to display the refresh rate of each monitor Unsupported on Windows
Enable/Disable GPU brand in output. (AMD/NVIDIA/Intel)
Which GPU to display. (all, dedicated, integrated)
NOTE: This only supports Linux.
Shorten output of gtk theme/icons
Enable/Disable gtk2 theme/font/icons output
Enable/Disable gtk3 theme/font/icons output
Enable/Disable showing $SHELL path
Enable/Disable showing $SHELL version
Which disks to display. Possible values: '/', '/dev/sdXX', '/path/to/mount point'
NOTE: Multiple values can be given. (--disk_show '/' '/dev/sdc1')
What information to append to the Disk subtitle. Takes: name, mount, dir
'name' shows the disk's name (sda1, sda2, etc)
'mount' shows the disk's mount point (/, /mnt/Local Disk, etc)
'dir' shows the basename of the disks's path. (/, Local Disk, etc)
URL to query for public IP
Print the Artist/Title on separate lines
Enable/Disable showing the time in Install Date output.
Set time format in Install Date to be 12 hour or 24 hour.

TEXT FORMATTING:

Changes the text colors in this order: title, @, underline, subtitle, colon, info
Enable/Disable the underline.
Character to use when underlining title
Enable/Disable bold text

COLOR BLOCKS:

Enable/Disable the color blocks
Width of color blocks in spaces
Height of color blocks in lines
Range of colors to print as blocks

BARS:

Characters to use when drawing bars.
Whether or not to surround the bar with '[]'
Length in spaces to make the bars.
Colors to make the bar. Set in this order: elapsed, total
Bar mode. Possible values: bar, infobar, barinfo, off
Bar mode. Possible values: bar, infobar, barinfo, off
Bar mode. Possible values: bar, infobar, barinfo, off
Bar mode. Possible values: bar, infobar, barinfo, off

IMAGE BACKEND:

Which image backend to use. Possible values: 'ascii', 'caca', 'catimg', 'jp2a', 'iterm2', 'off', 'sixel', 'tycat', 'w3m'
Which image or ascii file to use. Possible values: 'auto', 'ascii', 'wallpaper', '/path/to/img', '/path/to/ascii', '/path/to/dir/'
Shortcut to use 'ascii' backend.
Shortcut to use 'caca' backend.
Shortcut to use 'catimg' backend.
Shortcut to use 'iterm2' backend.
Shortcut to use 'jp2a' backend.
Shortcut to use 'sixel' backend.
Shortcut to use 'termpix' backend.
Shortcut to use 'tycat' backend.
Shortcut to use 'w3m' backend.
Shortcut to use 'off' backend.
NOTE: 'source; can be any of the following: 'auto', 'ascii', 'wallpaper', '/path/to/img', '/path/to/ascii', '/path/to/dir/'

ASCII:

Colors to print the ascii art
Which Distro's ascii art to print
NOTE: Arch and Ubuntu have 'old' logo variants.
NOTE: Use 'arch_old' or 'ubuntu_old' to use the old logos.
NOTE: Ubuntu has flavor variants.
NOTE: Change this to 'Lubuntu', 'Xubuntu', 'Ubuntu-GNOME', 'Ubuntu-Studio' or 'Ubuntu-Budgie' to use the flavors.
NOTE: Alpine, Arch, Crux, Gentoo, OpenBSD, and Void have a smaller logo variant.
NOTE: Change this to 'alpine_small', 'arch_small', 'crux_small', 'gentoo_small', 'openbsd_small', and 'void_small' to use the small logos.
Whether or not to bold the ascii logo.
Hide the info text and only show the ascii logo.
Possible values: bar, infobar, barinfo, off

IMAGE:

How to size the image. Possible values: auto, 00px, 00%, none
Which crop mode to use Takes the values: normal, fit, fill
Change the crop offset for normal mode. Possible values: northwest, north, northeast, west, center, east, southwest, south, southeast
How close the image will be to the left edge of the window. This only works with w3m.
How close the image will be to the top edge of the window. This only works with w3m.
Background color to display behind transparent image. This only works with w3m.
Gap between image and text.
NOTE: --gap can take a negative value which will move the text closer to the left side.
Delete cached files and thumbnails.

SCREENSHOT:

Take a screenshot, if path is left empty the screenshot function will use $scrot_dir and $scrot_name.
Same as --scrot but uploads the scrot to a website.
Website to upload scrots to.
Screenshot program to launch

OTHER:

Specify a path to a custom config file
Launch the script without a config file
Print this text and exit
Show neofetch version
Display error messages.
Display a verbose log for error reporting.

DEVELOPER:

Generate a manpage for Neofetch in your PWD. (Requires GNU help2man)

AUTHOR

Written by Dylan Araps with help from the following people:

https://github.com/dylanaraps/neofetch/contributors

REPORTING BUGS

Report bugs to https://github.com/dylanaraps/neofetch/issues

COPYRIGHT

Copyright © 2016-2017 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.

April 2017 Neofetch 3.1.0