424 lines
12 KiB
Groff
424 lines
12 KiB
Groff
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16.
|
|
.TH NEOFETCH "1" "August 2020" "Neofetch 7.1.0" "User Commands"
|
|
.SH NAME
|
|
Neofetch \- A fast, highly customizable system info script
|
|
.SH SYNOPSIS
|
|
.B neofetch
|
|
\fI\,func_name --option "value" --option "value"\/\fR
|
|
.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.
|
|
.PP
|
|
NOTE: Every launch flag has a config option.
|
|
.SH OPTIONS
|
|
.SS "INFO:"
|
|
.TP
|
|
func_name
|
|
Specify a function name (second part of info() from config) to
|
|
quickly display only that function's information.
|
|
.IP
|
|
Example: neofetch uptime \fB\-\-uptime_shorthand\fR tiny
|
|
.IP
|
|
Example: neofetch uptime disk wm memory
|
|
.IP
|
|
This can be used in bars and scripts like so:
|
|
.IP
|
|
memory="$(neofetch memory)"; memory="${memory##*: }"
|
|
.IP
|
|
For multiple outputs at once (each line of info in an array):
|
|
.IP
|
|
IFS=$'\en' read \fB\-d\fR "" \fB\-ra\fR info < <(neofetch memory uptime wm)
|
|
.IP
|
|
info=("${info[@]##*: }")
|
|
.TP
|
|
\fB\-\-disable\fR infoname
|
|
Allows you to disable an info line from appearing
|
|
in the output. 'infoname' is the function name from the
|
|
\&'print_info()' function inside the config file.
|
|
For example: 'info "Memory" memory' would be '\-\-disable memory'
|
|
.IP
|
|
NOTE: You can supply multiple args. eg. 'neofetch \fB\-\-disable\fR cpu gpu'
|
|
.TP
|
|
\fB\-\-title_fqdn\fR on/off
|
|
Hide/Show Fully Qualified Domain Name in title.
|
|
.TP
|
|
\fB\-\-package_managers\fR on/off
|
|
Hide/Show Package Manager names . (on, tiny, off)
|
|
.TP
|
|
\fB\-\-os_arch\fR on/off
|
|
Hide/Show OS architecture.
|
|
.TP
|
|
\fB\-\-speed_type\fR type
|
|
Change the type of cpu speed to display.
|
|
Possible values: current, min, max, bios,
|
|
scaling_current, scaling_min, scaling_max
|
|
.IP
|
|
NOTE: This only supports Linux with cpufreq.
|
|
.TP
|
|
\fB\-\-speed_shorthand\fR on/off
|
|
Whether or not to show decimals in CPU speed.
|
|
.TP
|
|
NOTE: This flag is not supported in systems with CPU speed less than
|
|
1 GHz.
|
|
.TP
|
|
\fB\-\-cpu_brand\fR on/off
|
|
Enable/Disable CPU brand in output.
|
|
.TP
|
|
\fB\-\-cpu_cores\fR type
|
|
Whether or not to display the number of CPU cores
|
|
Possible values: logical, physical, off
|
|
.IP
|
|
NOTE: 'physical' doesn't work on BSD.
|
|
.TP
|
|
\fB\-\-cpu_speed\fR on/off
|
|
Hide/Show cpu speed.
|
|
.TP
|
|
\fB\-\-cpu_temp\fR C/F/off
|
|
Hide/Show cpu temperature.
|
|
.IP
|
|
NOTE: This only works on Linux and BSD.
|
|
.TP
|
|
NOTE: For FreeBSD and NetBSD\-based systems, you need to enable
|
|
coretemp kernel module. This only supports newer Intel processors.
|
|
.TP
|
|
\fB\-\-distro_shorthand\fR on/off
|
|
Shorten the output of distro (on, tiny, off)
|
|
.IP
|
|
NOTE: This option won't work in Windows (Cygwin)
|
|
.TP
|
|
\fB\-\-kernel_shorthand\fR on/off
|
|
Shorten the output of kernel
|
|
.IP
|
|
NOTE: This option won't work in BSDs (except PacBSD and PC\-BSD)
|
|
.TP
|
|
\fB\-\-uptime_shorthand\fR on/off
|
|
Shorten the output of uptime (on, tiny, off)
|
|
.TP
|
|
\fB\-\-refresh_rate\fR on/off
|
|
Whether to display the refresh rate of each monitor
|
|
Unsupported on Windows
|
|
.TP
|
|
\fB\-\-gpu_brand\fR on/off
|
|
Enable/Disable GPU brand in output. (AMD/NVIDIA/Intel)
|
|
.TP
|
|
\fB\-\-gpu_type\fR type
|
|
Which GPU to display. (all, dedicated, integrated)
|
|
.IP
|
|
NOTE: This only supports Linux.
|
|
.TP
|
|
\fB\-\-de_version\fR on/off
|
|
Show/Hide Desktop Environment version
|
|
.TP
|
|
\fB\-\-gtk_shorthand\fR on/off
|
|
Shorten output of gtk theme/icons
|
|
.TP
|
|
\fB\-\-gtk2\fR on/off
|
|
Enable/Disable gtk2 theme/font/icons output
|
|
.TP
|
|
\fB\-\-gtk3\fR on/off
|
|
Enable/Disable gtk3 theme/font/icons output
|
|
.TP
|
|
\fB\-\-shell_path\fR on/off
|
|
Enable/Disable showing $SHELL path
|
|
.TP
|
|
\fB\-\-shell_version\fR on/off
|
|
Enable/Disable showing $SHELL version
|
|
.TP
|
|
\fB\-\-disk_show\fR value
|
|
Which disks to display.
|
|
Possible values: '/', '/dev/sdXX', '/path/to/mount point'
|
|
.IP
|
|
NOTE: Multiple values can be given. (\fB\-\-disk_show\fR '/' '/dev/sdc1')
|
|
.TP
|
|
\fB\-\-disk_subtitle\fR type
|
|
What information to append to the Disk subtitle.
|
|
Takes: name, mount, dir, none
|
|
.IP
|
|
\&'name' shows the disk's name (sda1, sda2, etc)
|
|
.IP
|
|
\&'mount' shows the disk's mount point (/, \fI\,/mnt/Local\/\fP Disk, etc)
|
|
.IP
|
|
\&'dir' shows the basename of the disks's path. (/, Local Disk, etc)
|
|
.IP
|
|
\&'none' shows only 'Disk' or the configured title.
|
|
.TP
|
|
\fB\-\-disk_percent\fR on/off
|
|
Hide/Show disk percent.
|
|
.TP
|
|
\fB\-\-ip_host\fR url
|
|
URL to query for public IP
|
|
.TP
|
|
\fB\-\-ip_timeout\fR int
|
|
Public IP timeout (in seconds).
|
|
.TP
|
|
\fB\-\-song_format\fR format
|
|
Print the song data in a specific format (see config file).
|
|
.TP
|
|
\fB\-\-song_shorthand\fR on/off
|
|
Print the Artist/Album/Title on separate lines.
|
|
.TP
|
|
\fB\-\-memory_percent\fR on/off
|
|
Display memory percentage.
|
|
.TP
|
|
\fB\-\-memory_unit\fR kib/mib/gib
|
|
Memory output unit.
|
|
.TP
|
|
\fB\-\-music_player\fR player\-name
|
|
Manually specify a player to use.
|
|
Available values are listed in the config file
|
|
.SS "TEXT FORMATTING:"
|
|
.TP
|
|
\fB\-\-colors\fR x x x x x x
|
|
Changes the text colors in this order:
|
|
title, @, underline, subtitle, colon, info
|
|
.TP
|
|
\fB\-\-underline\fR on/off
|
|
Enable/Disable the underline.
|
|
.TP
|
|
\fB\-\-underline_char\fR char
|
|
Character to use when underlining title
|
|
.TP
|
|
\fB\-\-bold\fR on/off
|
|
Enable/Disable bold text
|
|
.TP
|
|
\fB\-\-separator\fR string
|
|
Changes the default ':' separator to the specified string.
|
|
.SS "COLOR BLOCKS:"
|
|
.TP
|
|
\fB\-\-color_blocks\fR on/off
|
|
Enable/Disable the color blocks
|
|
.TP
|
|
\fB\-\-col_offset\fR auto/num
|
|
Left\-padding of color blocks
|
|
.TP
|
|
\fB\-\-block_width\fR num
|
|
Width of color blocks in spaces
|
|
.TP
|
|
\fB\-\-block_height\fR num
|
|
Height of color blocks in lines
|
|
.TP
|
|
\fB\-\-block_range\fR num num
|
|
Range of colors to print as blocks
|
|
.SS "BARS:"
|
|
.TP
|
|
\fB\-\-bar_char\fR 'elapsed char' 'total char'
|
|
Characters to use when drawing bars.
|
|
.TP
|
|
\fB\-\-bar_border\fR on/off
|
|
Whether or not to surround the bar with '[]'
|
|
.TP
|
|
\fB\-\-bar_length\fR num
|
|
Length in spaces to make the bars.
|
|
.TP
|
|
\fB\-\-bar_colors\fR num num
|
|
Colors to make the bar.
|
|
Set in this order: elapsed, total
|
|
.TP
|
|
\fB\-\-cpu_display\fR mode
|
|
Bar mode.
|
|
Possible values: bar, infobar, barinfo, off
|
|
.TP
|
|
\fB\-\-memory_display\fR mode
|
|
Bar mode.
|
|
Possible values: bar, infobar, barinfo, off
|
|
.TP
|
|
\fB\-\-battery_display\fR mode
|
|
Bar mode.
|
|
Possible values: bar, infobar, barinfo, off
|
|
.TP
|
|
\fB\-\-disk_display\fR mode
|
|
Bar mode.
|
|
Possible values: bar, infobar, barinfo, off
|
|
.SS "IMAGE BACKEND:"
|
|
.TP
|
|
\fB\-\-backend\fR backend
|
|
Which image backend to use.
|
|
Possible values: 'ascii', 'caca', 'chafa', 'jp2a', 'iterm2',
|
|
\&'off', 'sixel', 'tycat', 'w3m', 'kitty', 'ueberzug'
|
|
.TP
|
|
\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/', 'command output' [ascii]
|
|
.TP
|
|
\fB\-\-ascii\fR source
|
|
Shortcut to use 'ascii' backend.
|
|
.IP
|
|
NEW: neofetch \fB\-\-ascii\fR "$(fortune | cowsay \fB\-W\fR 30)"
|
|
.TP
|
|
\fB\-\-caca\fR source
|
|
Shortcut to use 'caca' backend.
|
|
.TP
|
|
\fB\-\-chafa\fR source
|
|
Shortcut to use 'chafa' backend.
|
|
.TP
|
|
\fB\-\-iterm2\fR source
|
|
Shortcut to use 'iterm2' backend.
|
|
.TP
|
|
\fB\-\-jp2a\fR source
|
|
Shortcut to use 'jp2a' backend.
|
|
.TP
|
|
\fB\-\-kitty\fR source
|
|
Shortcut to use 'kitty' backend.
|
|
.TP
|
|
\fB\-\-pot\fR source
|
|
Shortcut to use 'pot' backend.
|
|
.TP
|
|
\fB\-\-pixterm\fR source
|
|
Shortcut to use 'pixterm' backend.
|
|
.TP
|
|
\fB\-\-sixel\fR source
|
|
Shortcut to use 'sixel' backend.
|
|
.TP
|
|
\fB\-\-termpix\fR source
|
|
Shortcut to use 'termpix' backend.
|
|
.TP
|
|
\fB\-\-tycat\fR source
|
|
Shortcut to use 'tycat' backend.
|
|
.TP
|
|
\fB\-\-w3m\fR source
|
|
Shortcut to use 'w3m' backend.
|
|
.TP
|
|
\fB\-\-ueberzug\fR source
|
|
Shortcut to use 'ueberzug' backend.
|
|
.TP
|
|
\fB\-\-off\fR
|
|
Shortcut to use 'off' backend (Disable ascii art).
|
|
.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
|
|
.TP
|
|
NOTE: AIX, Hash, Alpine, AlterLinux, Amazon, Anarchy, Android, instantOS,
|
|
Antergos, antiX, "AOSC OS", "AOSC OS/Retro", Apricity, ArchCraft,
|
|
ArcoLinux, ArchBox, ARCHlabs, ArchStrike, XFerience, ArchMerge, Arch,
|
|
Artix, Arya, Bedrock, Bitrig, BlackArch, BLAG, BlankOn, BlueLight,
|
|
bonsai, BSD, BunsenLabs, Calculate, Carbs, CentOS, Chakra, ChaletOS,
|
|
Chapeau, Chrom*, Cleanjaro, ClearOS, Clear_Linux, Clover, Condres,
|
|
Container_Linux, CRUX, Cucumber, dahlia, Debian, Deepin, DesaOS,
|
|
Devuan, DracOS, DarkOs, Itc, DragonFly, Drauger, Elementary,
|
|
EndeavourOS, Endless, EuroLinux, Exherbo, Fedora, Feren, FreeBSD,
|
|
FreeMiNT, Frugalware, Funtoo, GalliumOS, Garuda, Gentoo, Pentoo,
|
|
gNewSense, GNOME, GNU, GoboLinux, Grombyang, Guix, Haiku, Huayra,
|
|
Hyperbola, janus, Kali, KaOS, KDE_neon, Kibojoe, Kogaion, Korora,
|
|
KSLinux, Kubuntu, LEDE, LaxerOS, LibreELEC, LFS, Linux_Lite, LMDE,
|
|
Lubuntu, Lunar, macos, Mageia, MagpieOS, Mandriva, Manjaro, Maui,
|
|
Mer, Minix, LinuxMint, Live_Raizo, MX_Linux, Namib, Neptune, NetBSD,
|
|
Netrunner, Nitrux, NixOS, Nurunner, NuTyX, OBRevenge, OpenBSD,
|
|
openEuler, OpenIndiana, openmamba, OpenMandriva, OpenStage, OpenWrt,
|
|
osmc, Oracle, OS Elbrus, PacBSD, Parabola, Pardus, Parrot, Parsix,
|
|
TrueOS, PCLinuxOS, Pengwin, Peppermint, popos, Porteus, PostMarketOS,
|
|
Proxmox, Puppy, PureOS, Qubes, Quibian, Radix, Raspbian, Reborn_OS,
|
|
Redstar, Redcore, Redhat, Refracted_Devuan, Regata, Regolith, Rosa,
|
|
sabotage, Sabayon, Sailfish, SalentOS, Scientific, Septor,
|
|
SereneLinux, SharkLinux, Siduction, Slackware, SliTaz, SmartOS,
|
|
Solus, Source_Mage, Sparky, Star, SteamOS, SunOS, openSUSE_Leap, t2,
|
|
openSUSE_Tumbleweed, openSUSE, SwagArch, Tails, Trisquel,
|
|
Ubuntu-Cinnamon, Ubuntu-Budgie, Ubuntu-GNOME, Ubuntu-MATE,
|
|
Ubuntu-Studio, Ubuntu, Univention, Venom, Void, semc, Obarun,
|
|
windows10, Windows7, Xubuntu, Zorin, and IRIX have ascii logos.
|
|
.IP
|
|
NOTE: Arch, Ubuntu, Redhat, and Dragonfly have 'old' logo variants.
|
|
.IP
|
|
NOTE: Use '{distro name}_old' to use the old logos.
|
|
.IP
|
|
NOTE: Ubuntu has flavor variants.
|
|
.TP
|
|
Change this to Lubuntu, Kubuntu, Xubuntu, Ubuntu-GNOME,
|
|
Ubuntu-Studio, Ubuntu-Mate or Ubuntu-Budgie to use the flavors.
|
|
.TP
|
|
NOTE: Arcolinux, Dragonfly, Fedora, Alpine, Arch, Ubuntu,
|
|
CRUX, Debian, Gentoo, FreeBSD, Mac, NixOS, OpenBSD, android,
|
|
Antrix, CentOS, Cleanjaro, ElementaryOS, GUIX, Hyperbola,
|
|
Manjaro, MXLinux, NetBSD, Parabola, POP_OS, PureOS,
|
|
Slackware, SunOS, LinuxLite, OpenSUSE, Raspbian,
|
|
postmarketOS, and Void have a smaller logo variant.
|
|
.IP
|
|
NOTE: Use '{distro name}_small' to use the small variants.
|
|
.TP
|
|
\fB\-\-ascii_bold\fR on/off
|
|
Whether or not to bold the ascii logo.
|
|
.TP
|
|
\fB\-L\fR, \fB\-\-logo\fR
|
|
Hide the info text and only show the ascii logo.
|
|
.SS "IMAGE:"
|
|
.TP
|
|
\fB\-\-loop\fR
|
|
Redraw the image constantly until Ctrl+C is used. This fixes issues
|
|
in some terminals emulators when using image mode.
|
|
.TP
|
|
\fB\-\-size\fR 00px | \fB\-\-size\fR 00%
|
|
How to size the image.
|
|
Possible values: auto, 00px, 00%, none
|
|
.TP
|
|
\fB\-\-crop_mode\fR mode
|
|
Which crop mode to use
|
|
Takes the values: normal, fit, fill
|
|
.TP
|
|
\fB\-\-crop_offset\fR value
|
|
Change the crop offset for normal mode.
|
|
Possible values: northwest, north, northeast,
|
|
west, center, east, southwest, south, southeast
|
|
.TP
|
|
\fB\-\-xoffset\fR px
|
|
How close the image will be to the left edge of the
|
|
window. This only works with w3m and ueberzug.
|
|
.TP
|
|
\fB\-\-yoffset\fR px
|
|
How close the image will be to the top edge of the
|
|
window. This only works with w3m and ueberzug.
|
|
.TP
|
|
\fB\-\-bg_color\fR color
|
|
Background color to display behind transparent image.
|
|
This only works with w3m.
|
|
.TP
|
|
\fB\-\-gap\fR num
|
|
Gap between image and text.
|
|
.TP
|
|
NOTE: \fB\-\-gap\fR can take a negative value which will move the text
|
|
closer to the left side.
|
|
.TP
|
|
\fB\-\-clean\fR
|
|
Delete cached files and thumbnails.
|
|
.SS "OTHER:"
|
|
.TP
|
|
\fB\-\-config\fR \fI\,/path/to/config\/\fP
|
|
Specify a path to a custom config file
|
|
.TP
|
|
\fB\-\-config\fR none
|
|
Launch the script without a config file
|
|
.TP
|
|
\fB\-\-no_config\fR
|
|
Don't create the user config file.
|
|
.TP
|
|
\fB\-\-print_config\fR
|
|
Print the default config file to stdout.
|
|
.TP
|
|
\fB\-\-stdout\fR
|
|
Turn off all colors and disables any ASCII/image backend.
|
|
.TP
|
|
\fB\-\-help\fR
|
|
Print this text and exit
|
|
.TP
|
|
\fB\-\-version\fR
|
|
Show neofetch version
|
|
.TP
|
|
\fB\-v\fR
|
|
Display error messages.
|
|
.TP
|
|
\fB\-vv\fR
|
|
Display a verbose log for error reporting.
|
|
.SS "DEVELOPER:"
|
|
.TP
|
|
\fB\-\-gen\-man\fR
|
|
Generate a manpage for Neofetch in your PWD. (Requires GNU help2man)
|
|
.SH "REPORTING BUGS"
|
|
Report bugs to https://github.com/dylanaraps/neofetch/issues
|