table of contents
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:¶
- --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'
- --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 supports Linux with cpufreq.
- --speed_shorthand on/off
- Whether or not to show decimals in CPU speed.
- --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 Possible values: logical, physical, off
- NOTE: 'physical' doesn't work on BSD.
- --cpu_speed on/off
- Hide/Show cpu speed.
- --cpu_temp C/F/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.
- --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)
- --gpu_type type
- Which GPU to display. (all, dedicated, integrated)
- NOTE: This only supports Linux.
- --gtk_shorthand on/off
- Shorten output of gtk theme/icons
- --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
- --disk_show value
- Which disks to display. Possible values: '/', '/dev/sdXX', '/path/to/mount point'
- NOTE: Multiple values can be given. (--disk_show '/' '/dev/sdc1')
- --disk_subtitle type
- 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)
- --ip_host url
- URL to query for public IP
- --song_shorthand on/off
- Print the Artist/Title on separate lines
- --install_time on/off
- Enable/Disable showing the time in Install Date output.
- --install_time_format 12h/24h
- Set time format in Install Date to be 12 hour or 24 hour.
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 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 num num
- Range of colors to print as blocks
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 '[]'
- --bar_length num
- Length in spaces to make the bars.
- --bar_colors num num
- Colors to make the bar. Set in this order: elapsed, total
- --cpu_display mode
- Bar mode. Possible values: bar, infobar, barinfo, off
- --memory_display mode
- Bar mode. Possible values: bar, infobar, barinfo, off
- --battery_display mode
- Bar mode. Possible values: bar, infobar, barinfo, off
- --disk_display mode
- Bar mode. Possible values: bar, infobar, barinfo, off
IMAGE BACKEND:¶
- --backend backend
- Which image backend to use. Possible values: 'ascii', 'caca', 'catimg', 'jp2a', 'iterm2', 'off', 'sixel', 'tycat', 'w3m'
- --source source
- Which image or ascii file to use. Possible values: 'auto', 'ascii', 'wallpaper', '/path/to/img', '/path/to/ascii', '/path/to/dir/'
- --ascii source
- Shortcut to use 'ascii' backend.
- --caca source
- Shortcut to use 'caca' backend.
- --catimg source
- Shortcut to use 'catimg' backend.
- --iterm2 source
- Shortcut to use 'iterm2' backend.
- --jp2a source
- Shortcut to use 'jp2a' backend.
- --sixel source
- Shortcut to use 'sixel' backend.
- --termpix source
- Shortcut to use 'termpix' backend.
- --tycat source
- Shortcut to use 'tycat' backend.
- --w3m source
- Shortcut to use 'w3m' backend.
- --off
- 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:¶
- --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 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.
- --ascii_bold on/off
- Whether or not to bold the ascii logo.
- -L, --logo
- Hide the info text and only show the ascii logo.
- Possible values: bar, infobar, barinfo, off
IMAGE:¶
- --size 00px | --size 00%
- How to size the image. Possible values: auto, 00px, 00%, none
- --crop_mode mode
- Which crop mode to use Takes the values: normal, fit, fill
- --crop_offset value
- Change the crop offset for normal mode. Possible values: northwest, north, northeast, west, center, east, southwest, south, southeast
- --xoffset px
- How close the image will be to the left edge of the window. This only works with w3m.
- --yoffset px
- How close the image will be to the top edge of the window. This only works with w3m.
- --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.
- --clean
- Delete cached files and thumbnails.
SCREENSHOT:¶
- -s, --scrot /path/to/img
- Take a screenshot, if path is left empty the screenshot function will use $scrot_dir and $scrot_name.
- -su, --upload /path/to/img
- Same as --scrot but uploads the scrot to a website.
- --image_host imgur/teknik
- Website to upload scrots to.
- --scrot_cmd cmd
- Screenshot program to launch
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. (Requires GNU help2man)
AUTHOR¶
Written by Dylan Araps with help from the following people:
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 |