3f983245bb
Config fixes |
||
---|---|---|
.github | ||
ascii/distro | ||
config | ||
.travis.yml | ||
1.8.md | ||
LICENSE.md | ||
Makefile | ||
neofetch | ||
neofetch.1 | ||
README.md |
Neofetch
This is the home of my fetch script! This script gathers info
about your system and prints it to the terminal next to an image, <br >
your distro's logo or any ascii art of your choice!
Have a look at the wiki, I've updated/added some new pages!<br > https://github.com/dylanaraps/neofetch/wiki
Table of Contents
- Screenshots
- Features
- Dependencies
- Installation
- Post Install
- Usage
- Frequently Asked Questions
- Issues and Workarounds
- Thanks
Screenshots
Features
- Supports Linux, Mac OS X, iOS, BSD, Solaris and Windows (Cygwin)
- Display a full color image, a file containing ascii art or your distro's logo in ascii next to the info.
- The script is fast. We use bash builtins wherever possible and only spawn external processes when necessary.
- Take a screenshot of your desktop on script finish.
- Customize which info is displayed, where it's displayed and when it's displayed.
- See this wiki page
Dependencies
Required dependencies:
Bash 3.0+
- Alpine Linux: You also need
ncurses
.
- Alpine Linux: You also need
iOS
These dependencies can all be installed through Cydia.<br > Note: The cydia package installs these dependencies for you.
Bourne-Again SHell
Core Utilities
Core Utilities (/bin)
Darwin Tools
system-cmds
Gawk
grep
Optional dependencies:
- Desktop Environment and Window Manager:
xprop
[1] - Displaying images:
w3m-img
[2] [3] oriTerm2
orTerminology
[4] - Thumbnail creation:
imagemagick
- Displaying song information from Google Play Music Desktop Player:
gpmdp-remote
Linux / BSD
- Wallpaper:
feh
,nitrogen
orgsettings
- Current Song:
mpc
,cmus
,moc
,spotify
,gpmdc
- Resolution:
xorg-xrandr
orxorg-xdpyinfo
[5] - Screenshot:
scrot
[6]
OSX
- Resolution (quicker):
screenresolution
BSD
- GPU:
glxinfo
- Not required on FreeBSD.
Windows (CYGWIN)
procps-ng
orprocps
[1] See #79 about why this is now a required dependency.
[2] w3m-img
is sometimes bundled together with w3m
.
[3] Image support only works in certain terminal emulators. The script will fallback to ascii mode on<br > terminal emulators that don't support the xterm escape sequences we're using for image sizing.
[4] Image support is built into Terminology and iTerm2, and doesn't require w3m-img.
[5] Xrandr is prefered over xdpyinfo as Xrandr supports multi monitor and refresh rate display in the<br > output.
[6] You can use the launch flag --scrot_cmd
or change the config option $scrot_cmd
to your screenshot<br >
program's cmd and neofetch will use it instead of scrot.
Installation
Those using a git version of neofetch should check this page after<br > updating, this page lists any breaking changes that were made and<br > how you can workaround them.
https://github.com/dylanaraps/neofetch/wiki/Following-HEAD
- Arch Linux
- Gentoo / Funtoo
- CRUX
- Ubuntu
- Debian
- Fedora / RHEL / CentOS
- Void Linux
- BunsenLabs
- Slackware
- Mac OS X
- iOS
- Others
Arch
- Install neofetch or neofetch-git from the aur.
Gentoo / Funtoo
- Add the 3rd party repo
# wget -O /etc/portage/repos.conf/konimex.conf https://git.io/vocNV
- Sync the repo
# emerge --sync konimex
- To enable additional features such as w3m and music support, enable the appropriate USE flags. For example:
# echo "app-misc/neofetch X -moc" >> /etc/portage/package.use
- Install the package
# emerge -a app-misc/neofetch
To install the git version, just add app-misc/neofetch ~<your architecture>
to package.accept_keywords
CRUX
- Install git and the git ports(8) driver
sudo prt-get depinst git
- Add the 3rd party repo
sudo wget -O /etc/ports/tudurom.git https://git.io/vV46y
- Sync the repos
sudo ports -u
- Add the repo to /etc/prt-get.conf with your text editor of choice
prtdir /usr/ports/tudurom
- Install the package
sudo prt-get depinst neofetch
Or alternatively use the port:
- Download port
wget -O ~/work/neofetch/Pkgfile https://raw.githubusercontent.com/tudurom/crux-ports/master/neofetch/Pkgfile
- Build the package
fakeroot pkgmk -d
- Install the package
sudo pkgadd neofetch#git-*.pkg.tar.gz
Ubuntu
- Add PPA
sudo add-apt-repository ppa:dawidd0811/neofetch
- Update repositories
sudo apt update
- Install the package
sudo apt install neofetch
Debian
- Add the 3rd party repo
echo "deb http://dl.bintray.com/dawidd6/neofetch jessie main" | sudo tee -a /etc/apt/sources.list
- Add public key (you need to have curl installed)
curl -L "https://bintray.com/user/downloadSubjectPublicKey?username=bintray" -o Release-neofetch.key && sudo apt-key add Release-neofetch.key && rm Release-neofetch.key
- Update repositories
sudo apt-get update
- Install the package
sudo apt-get install neofetch
Fedora / RHEL / CentOS
NOTE: If you are using RHEL/CentOS, change dnf
into yum
.
- Make sure you have installed
dnf-plugins-core
- Enable COPR repository
sudo dnf copr enable konimex/neofetch
- Install the package
sudo dnf install neofetch
Alternatively:
- Change your working directory to
/etc/yum.repos.d/
- Fetch the repo file
wget https://copr.fedorainfracloud.org/coprs/konimex/neofetch/repo/epel-7/konimex-neofetch-epel-7.repo
- NOTE: If you are using Fedora, change
epel-7
tofedora-23
or your Fedora version respectively. However if you are using RHEL/CentOS 6, change it toepel-6
.
- NOTE: If you are using Fedora, change
- Install the package
sudo dnf install neofetch
Void Linux
Install it from the official repositories
sudo xbps-install -S neofetch
BunsenLabs
Neofetch is available in the official repos.
sudo apt-get update
sudo apt-get install neofetch
Slackware
Download the files from SlackBuilds and follow their instructions.
Mac OS X
- Install
neofetch
with Homebrewbrew install neofetch
iOS
- Add
http://dylanaraps.com/repo
to your cydia sources. - Install
neofetch
through cydia.
Others
- Download the latest source at https://github.com/dylanaraps/neofetch
- Run
make install
inside the script directory to install the script.- El Capitan:
PREFIX=/usr/local make install
- El Capitan:
NOTE: Neofetch can be uninstalled easily using make uninstall
.
NOTE: You can run neofetch from any folder on your system, all the makefile does is move the files to a "sane" location. The makefile is optional.
Post Install
Using the config file
Neofetch will by default create a config file at $HOME/.config/neofetch/config
and this file<br >
contains all of the script's options/settings. The config file allows you to keep your<br >
customizations between script versions and allows you to easily share your customizations<br >
with other people.
You can launch the script without a config file by using the flag --config none
and you can<br >
specify a custom config location using --config path/to/config
.
Customizing what info gets displayed
In the config file there's a function that allows you to customize all of the info that<br > gets displayed.
Here's what you can do:
- Add new info lines
- Change the ordering of the info
- Remove unwanted info lines
- Use bash syntax to control when info gets displayed
See this wiki page that goes more in-depth about it:
https://github.com/dylanaraps/fetch/wiki/Customizing-Info
Customizing the script using a custom alias
If you don't want to use the config file you can customize almost everything using launch flags!
Here's an example neofetch alias:
alias neofetch2="neofetch \
--config off \
--block_range 1 8 \
--bold off \
--uptime_shorthand on \
--gtk_shorthand on \
--colors 4 1 8 8 8 7 \
"
Usage
usage: neofetch --option "value" --option "value"
NOTE: There's also a config option for each flag below.
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'
--osx_buildversion on/off Hide/Show Mac OS X build version.
--osx_codename on/off Hide/Show Mac OS X codename.
--os_arch on/off Hide/Show Windows 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 support Linux with cpufreq.
--cpu_shorthand type Shorten the output of CPU
Possible values: name, speed, tiny, on, off
--cpu_cores on/off Whether or not to display the number of CPU cores
--kernel_shorthand on/off Shorten the output of kernel
--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_shorthand on/off Shorten the output of GPU (tiny, on, off)
--gtk_shorthand on/off Shorten output of gtk theme/icons
--gtk2 on/off Enable/Disable gtk2 theme/icons output
--gtk3 on/off Enable/Disable gtk3 theme/icons output
--shell_path on/off Enable/Disable showing \$SHELL path
--shell_version on/off Enable/Disable showing \$SHELL version
--battery_num num Which battery to display, default value is 'all'
--battery_shorthand on/off Whether or not each battery gets its own line/title
--ip_host url Url to ping for public IP
--song_shorthand on/off Print the Artist/Title on seperate lines
--birthday_shorthand on/off Shorten the output of birthday
--birthday_time on/off Enable/Disable showing the time in birthday output
--birthday_format format Format the birthday output. (Uses 'date' cmd format)
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 start end Range of colors to print as blocks
Progress Bars:
--progress_char 'elapsed char' 'total char'
Characters to use when drawing progress bars.
--progress_border on/off Whether or not to surround the bar with '[]'
--progress_length num Length in spaces to make the progress bars.
--progress_colors num num Colors to make the progress bar.
Set in this order: elapsed, total
--cpu_display mode Progress bar mode.
Takes: bar, infobar, barinfo, off
--memory_display mode Progress bar mode.
Takes: bar, infobar, barinfo, off
--battery_display mode Progress bar mode.
Takes: bar, infobar, barinfo, off
--disk_display mode Progress bar mode.
Takes: bar, infobar, barinfo, off
Image:
--image type Image source. Where and what image we display.
Possible values: wall, ascii,
/path/to/img, /path/to/dir/, off
--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.
--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 Remove all cropped images
Ascii:
--ascii value Where to get the ascii from, Possible values:
distro, /path/to/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
--ascii_logo_size Size of ascii logo.
Supported distros: Arch, Gentoo, Crux, OpenBSD.
--ascii_bold on/off Whether or not to bold the ascii logo.
Stdout:
--stdout info info Launch neofetch in stdout mode which prints the info
in a plain-text format that you can use with
lemonbar etc.
--stdout_separator string String to use as a separator in stdout mode.
Screenshot:
--scrot /path/to/img Take a screenshot, if path is left empty the screen-
shot function will use \$scrot_dir and \$scrot_name.
--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
--test Launch the script with all functions / options enabled.
This should only be used for testing purposes, ie Travis.CI.
-v Display error messages.
-vv Display a verbose log for error reporting.
Frequently Asked Questions
How do I enable screenfetch mode?
Launching the script with --ascii
or setting image="ascii"
<br >
inside the config file will launch the script in "screenfetch mode". The script will<br >
display your distro's ascii next to the info, exactly like screenfetch.
NOTE: If you don't have w3m-img
or imagemagick
installed screenfetch mode will be<br >
used automatically
Why doesn't Neofetch support my wallpaper setter?
It's hard to add support for other wallpaper setters as they don't provide a way of <br > getting the current wallpaper from the cli.
If your wallpaper setter does provide a way of getting the current wallpaper or you<br > know where it's stored then adding support won't be a problem!<br >
Issues and Workarounds
The text is pushed over too far to the right
The easiest way to fix this is to change the value of --gap
or $gap
<br >
to a negative value. For example --gap -10
will move the text 10 spaces to the left.
getgpu doesn't show my exact video card name
If your lspci | grep "VGA"
output looks like this:
01:00.0 VGA compatible controller: NVIDIA Corporation Device 1401 (rev a1)
Instead of this:
01:00.0 VGA compatible controller: NVIDIA Corporation GM206 [GeForce GTX 960] (rev a1)
Then you're affected by the issue.
This is caused by your /usr/share/misc/pci.ids\*
files being outdated and you can fix it<br >
by running this command as root.
sudo update-pciids
Neofetch doesn't work correctly with ConEmu.
You need to be using the CYGWIN/Msys connector for Neofetch to work seamlessly with ConEmu.
https://conemu.github.io/en/CygwinMsysConnector.html
Thanks
Thanks to:
- Screenfetch:
- I've used some snippets as a base for a few functions in this script.
- Some of the ascii logos.
- ufetch:
- Tiny ascii logos
- Everyone else helped out in one way or another. I'd list all of the names<br > but there's just too many of you. :)