mirror of
https://github.com/hykilpikonna/hyfetch.git
synced 2026-03-22 01:34:25 -05:00
487 lines
14 KiB
Groff
487 lines
14 KiB
Groff
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
|
|
.TH NEOFETCH "1" "October 2025" "Neofetch 8.0.3" "User Commands"
|
|
.SH NAME
|
|
Neofetch \- manual page for Neofetch 8.0.3
|
|
.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\-\-package_separate\fR on/off
|
|
Whether to separate system/user modes for supported package managers
|
|
.TP
|
|
\fB\-\-package_minimal\fR
|
|
Reduce output of packages list by not showing programming language package managers or Steam games
|
|
.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\-\-editor_path\fR on/off
|
|
Enable/Disable showing $EDITOR path
|
|
.TP
|
|
\fB\-\-editor_version\fR on/off
|
|
Enable/Disable showing $EDITOR 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\-\-ip_interface\fR value
|
|
Interface(s) to use for local IP
|
|
.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 (k/m/g/t)ib
|
|
Memory output unit.
|
|
.TP
|
|
\fB\-\-memory_precision\fR integer
|
|
Change memory output precision. (???0, default=2)
|
|
.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\-\-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', 'catimg', 'chafa', 'jp2a',
|
|
\&'iterm2', 'off', 'sixel', 'tycat', 'w3m', 'kitty', 'viu'
|
|
.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\-\-catimg\fR source
|
|
Shortcut to use 'catimg' 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\-\-viu\fR source
|
|
Shortcut to use 'viu' 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: Ad??lie, aerOS, Afterglow, AIX, AlmaLinux, Alpine, Alter,
|
|
Amazon, AmogOS, Anarchy, Android, Antergos, antiX, AOSC OS, Aperio
|
|
GNU/Linux, Aperture, Apricity, Arch, ArchBox, Archcraft,
|
|
archcraft_ascii, archcraft_minimal, ARCHlabs, ArchMerge, ArchStrike,
|
|
ArcoLinux, Arkane, ArseLinux, Artix, Arya, Asahi, AsteroidOS, astOS,
|
|
Astra Linux, Athena, azos, Bazzite, Bedrock, BigLinux,
|
|
BigLinux_large, Bitrig, BlackArch, BlackMesa, blackPanther, BLAG,
|
|
BlankOn, BlueLight, Bodhi, bonsai, BSD, BunsenLabs, CachyOS,
|
|
Calculate, CalinixOS, Carbs, CBL\-Mariner, CelOS, Center, CentOS,
|
|
Chakra, ChaletOS, Chapeau, Chimera, ChonkySealOS, Chrom, Cleanjaro,
|
|
Clear Linux OS, ClearOS, Clover, Cobalt, Condres, Container Linux by
|
|
CoreOS, CRUX, Crystal Linux, Cucumber, CutefishOS, CuteOS, CyberOS,
|
|
dahlia, DarkOs, Darwin, Debian, Deepin, DesaOS, Devuan, DietPi,
|
|
digital UNIX, DracOS, DragonFly, Drauger, Droidian, Elementary,
|
|
Elive, EncryptOS, EndeavourOS, Endless, Enso, EuroLinux,
|
|
EvolutionOS, eweOS, Exherbo, Exodia Predator OS, Fedora, Fedora
|
|
Kinoite, Fedora Sericea, Fedora Silverblue, Fedora_unicode,
|
|
FemboyOS, Feren, Finnix, Floflis, FreeBSD, FreeMiNT, Frugalware,
|
|
Funtoo, Furreto, GalliumOS, Garuda, Gentoo, GhostBSD, glaucus,
|
|
Gloire, gNewSense, GNOME, GNU, GoboLinux, GrapheneOS, Grombyang,
|
|
Guix, Haiku, HamoniKR, HarDClanZ, Hash, Huayra, Hybrid, HydroOS,
|
|
Hyperbola, iglunix, instantOS, Interix, IRIX, Itc, januslinux,
|
|
Kaisen, Kali, KaOS, KDE, Kibojoe, Kogaion, Korora, KrassOS, KSLinux,
|
|
Kubuntu, LainOS, LangitKetujuh, LaxerOS, LEDE, LibreELEC, Linspire,
|
|
Linux, Linux Lite, Linux Mint, Linux Mint Old, LinuxFromScratch,
|
|
Live Raizo, LMDE, Lubuntu, Lunar, mac, MacaroniOS, Mageia, Magix,
|
|
MagpieOS, MainsailOS, Mandriva, Manjaro, MassOS, MatuusOS, Maui,
|
|
Mauna, Meowix, Mer, Minix, MIRACLE LINUX, MX, Namib, NekOS, Neptune,
|
|
NetBSD, Netrunner, Nitrux, NixOS, nixos_colorful, Nobara, NomadBSD,
|
|
Nurunner, NuTyX, Obarun, OBRevenge, OmniOS, Open Source Media
|
|
Center, OpenBSD, openEuler, OpenIndiana, openKylin, openmamba,
|
|
OpenMandriva, OpenStage, openSUSE, openSUSE Leap, openSUSE
|
|
Tumbleweed, openSUSE Tumbleweed\-Slowroll, OPNsense, Oracle, orchid,
|
|
OS Elbrus, PacBSD, Panwah, Parabola, parch, Pardus, Parrot, Parsix,
|
|
PCBSD, PCLinuxOS, pearOS, Pengwin, Pentoo, Peppermint, Peropesis,
|
|
phyOS, PikaOS, Pisi, PNM Linux, Pop!_OS, Porteus, PostMarketOS,
|
|
Profelis SambaBOX, Proxmox, PuffOS, Puppy, PureOS, Q4OS, Qubes,
|
|
Qubyt, Quibian, Radix, Raspbian, ravynOS, Reborn OS, Red Star,
|
|
Redcore, Redhat, Refracted Devuan, Regata, Regolith, RhaymOS, Rhino
|
|
Linux, rocky, Rosa, Sabayon, sabotage, Sailfish, SalentOS, Salient
|
|
OS, Salix, Sasanqua, Scientific, semc, Septor, Serene, SharkLinux,
|
|
ShastraOS, Siduction, SkiffOS, Slackel, Slackware, SliTaz, SmartOS,
|
|
Soda, Solus, Source Mage, Sparky, Star, SteamOS, Stock Linux, Sulin,
|
|
SunOS, SwagArch, t2, Tails, Tatra, TeArch, TorizonCore, Trisquel,
|
|
Twister, Ubuntu, Ubuntu Budgie, Ubuntu Cinnamon, Ubuntu Kylin,
|
|
Ubuntu MATE, Ubuntu Studio, Ubuntu Sway, Ubuntu Touch, Ubuntu\-GNOME,
|
|
ubuntu_old02, Ultramarine Linux, unicodearch, Univalent, Univention,
|
|
Uos, UrukOS, uwuntu, Vanilla, Venom, VNux, Void, VzLinux, wii\-linuxngx, Windows, Windows 10, Windows 11, Windows95, Wrt, Xenia, Xenia2,
|
|
XFerience, Xray_OS, Xubuntu, yiffOS, Zorin have ascii logos.
|
|
.TP
|
|
NOTE: arch, dragonfly, Fedora, LangitKetujuh, nixos, redhat, Ubuntu
|
|
have 'old' logo variants, use {distro}_old to use them.
|
|
.TP
|
|
NOTE: alpine, android, arch, arcolinux, artix, CalinixOS, centos,
|
|
cleanjaro, crux, debian, dragonfly, elementary, endeavouros, fedora,
|
|
freebsd, garuda, gentoo, guix, haiku, hyperbola, kali, Linux,
|
|
linuxlite, linuxmint, mac, mageia, MainsailOS, manjaro, mx, netbsd,
|
|
nixos, openbsd, opensuse, orchid, parabola, popos, postmarketos,
|
|
pureos, Raspbian, rocky, slackware, sunos, ubuntu, venom, void have
|
|
\&'small' logo variants, use {distro}_small to use them.
|
|
.IP
|
|
NOTE: Fedora has immutable spins with unique logos (except Onyx).
|
|
.TP
|
|
NOTE: Change this to Silverblue, Kinoite, Sericea, or CoreOS to use
|
|
the spins.
|
|
.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\-\-catimg_size\fR 1/2
|
|
Change the resolution of catimg.
|
|
.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.
|
|
.TP
|
|
\fB\-\-yoffset\fR px
|
|
How close the image will be to the top edge of the
|
|
window. This only works with w3m.
|
|
.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=\fI\,on\/\fR
|
|
Turn off all colors and disables any ASCII/image backend.
|
|
.TP
|
|
\fB\-\-stdout\fR=\fI\,off\/\fR
|
|
Enable the colored output and ASCII/image backend
|
|
.TP
|
|
\fB\-\-stdout\fR=\fI\,auto\/\fR
|
|
Let the program decide basing on the output type (default behavior)
|
|
.TP
|
|
\fB\-\-stdout\fR
|
|
Equivalent to '\-\-stdout=on', for backward compatibility
|
|
.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
|
|
.SH "SEE ALSO"
|
|
The full documentation for
|
|
.B Neofetch
|
|
is maintained as a Texinfo manual. If the
|
|
.B info
|
|
and
|
|
.B Neofetch
|
|
programs are properly installed at your site, the command
|
|
.IP
|
|
.B info Neofetch
|
|
.PP
|
|
should give you access to the complete manual.
|