neofetch/README.md

118 lines
4.4 KiB
Markdown
Raw Normal View History

2016-02-28 00:44:45 +00:00
# Neofetch
2015-12-30 10:20:53 +00:00
2016-04-01 14:29:45 +01:00
[![Gitter](https://badges.gitter.im/dylanaraps/fetch.svg)](https://gitter.im/dylanaraps/fetch?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Build Status](https://travis-ci.org/dylanaraps/neofetch.svg?branch=master)](https://travis-ci.org/dylanaraps/neofetch) [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md) [![Latest release](https://img.shields.io/github/release/dylanaraps/neofetch.svg)](https://github.com/dylanaraps/neofetch/releases)
2016-02-14 13:04:55 +00:00
2016-11-16 14:21:30 +00:00
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. The main purpose of neofetch is to be used in screenshots to show other users what OS/Distro you're running, what Theme/Icons you're using and etc.
2015-12-30 10:18:17 +00:00
2016-11-16 14:21:30 +00:00
Neofetch is highly customizable through the use of commandline flags or the user config file. There are over 50 config options to mess around with and there's the `print_info()` function and friends which let you add your own custom info.
2016-04-24 11:45:50 +01:00
Neofetch can be used on any OS that has BASH, it's just a matter of adding support. If your OS/Distro isn't in the list below, feel free to open an issue on the repo and I'll gladly add support. Neofetch currently supports `Linux`, `MacOS`, `iOS`, `BSD`, `Solaris`, `Android`, `Haiku`, `GNU Hurd` and `Windows (Cygwin/Windows 10 Linux subsystem)`.
2015-12-30 10:18:17 +00:00
2016-11-16 14:21:30 +00:00
For more information:
2015-12-30 10:18:17 +00:00
2016-11-16 14:21:30 +00:00
**https://github.com/dylanaraps/neofetch/wiki**
2016-01-30 04:34:34 +00:00
2016-11-16 14:21:30 +00:00
![1](https://ipfs.pics/ipfs/QmTtF9Sx8o617QE88GH3Z4yX7mRyi4yS1hsMHyRVmn14vJ)
2016-01-30 04:34:34 +00:00
2015-12-31 22:36:26 +00:00
## Dependencies
2015-12-30 10:18:17 +00:00
2016-11-12 09:59:59 +00:00
https://github.com/dylanaraps/neofetch/wiki/Dependencies
2016-11-02 02:31:22 +00:00
2016-10-26 23:40:16 +01:00
2016-01-09 02:27:37 +00:00
## Installation
2016-11-12 10:05:53 +00:00
https://github.com/dylanaraps/neofetch/wiki/Installation
2016-01-09 02:27:37 +00:00
2016-01-18 01:43:06 +00:00
## Post Install
2015-12-31 22:36:26 +00:00
2016-01-31 05:40:21 +00:00
2016-11-16 14:26:41 +00:00
### Using the config file
2016-01-30 03:31:40 +00:00
2016-11-16 14:26:08 +00:00
Neofetch will by default create a config file at `$HOME/.config/neofetch/config` and this file contains all of the script's options/settings. The config file allows you to keep your customizations between script versions and allows you to easily share your customizations with other people.
2016-01-30 03:31:40 +00:00
2016-11-16 14:26:08 +00:00
You can launch the script without a config file by using the flag `--config none` and you can specify a custom config location using `--config path/to/config`.
2016-01-30 03:31:40 +00:00
2015-12-30 10:18:17 +00:00
2016-11-16 14:26:41 +00:00
### Customizing what info gets displayed
2016-01-21 11:33:05 +00:00
https://github.com/dylanaraps/fetch/wiki/Customizing-Info
2016-11-16 14:26:41 +00:00
### Customizing the script using a custom alias
2016-01-21 11:33:05 +00:00
If you don't want to use the config file you can customize almost everything using launch flags!
2016-01-18 01:43:06 +00:00
2016-08-12 13:01:39 +01:00
Here's an example neofetch alias:
2016-01-18 01:43:06 +00:00
```sh
2016-08-12 13:01:39 +01:00
alias neofetch2="neofetch \
--config off \
2016-01-18 01:43:06 +00:00
--block_range 1 8 \
--bold off \
--uptime_shorthand on \
--gtk_shorthand on \
--colors 4 1 8 8 8 7 \
"
```
2016-01-20 09:40:17 +00:00
## Frequently Asked Questions
2016-11-16 14:26:41 +00:00
### How do I enable screenfetch mode?
2016-01-28 09:11:18 +00:00
2016-11-16 14:26:08 +00:00
Launching the script with `--ascii` or setting `image="ascii"` inside the config file will launch the script in "screenfetch mode". The script will display your distro's ascii next to the info, exactly like screenfetch.
2016-02-04 07:22:52 +00:00
2016-11-16 14:26:08 +00:00
**NOTE:** If you **don't** have an image-mode dependency installed screenfetch mode will be used automatically.
2016-01-28 09:11:18 +00:00
2016-11-16 14:26:41 +00:00
### Why doesn't Neofetch support my wallpaper setter?
2016-01-20 09:40:17 +00:00
2016-11-16 14:26:08 +00:00
It's hard to add support for other wallpaper setters as they don't provide a way of getting the current wallpaper from the cli.
2016-01-20 09:40:17 +00:00
2016-11-16 14:27:48 +00:00
If your wallpaper setter **does** provide a way of getting the current wallpaper or you know where the wallpaper is stored then adding support won't be a problem!
2016-01-20 09:40:17 +00:00
## Issues and Workarounds
2016-11-16 14:26:41 +00:00
### getgpu doesn't show my exact video card name
2016-01-19 22:29:08 +00:00
2016-01-21 01:25:36 +00:00
If your `lspci | grep "VGA"` output looks like this:
2016-01-19 22:29:08 +00:00
```
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.
2016-11-16 14:26:08 +00:00
This is caused by your `/usr/share/misc/pci.ids*` files being outdated and you can fix it by running this command as root.
2016-01-19 22:29:08 +00:00
```
sudo update-pciids
```
2016-11-16 14:26:41 +00:00
### Neofetch doesn't work correctly with ConEmu.
2016-03-27 03:34:29 +01:00
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:
2016-02-23 14:33:25 +00:00
- [Screenfetch](https://github.com/KittyKatt/screenFetch):
2016-01-28 09:32:07 +00:00
- I've used some snippets as a base for a few functions in this script.
2016-08-12 13:01:39 +01:00
- Some of the ascii logos.
- [ufetch](https://github.com/jschx/ufetch):
- Tiny ascii logos
2016-11-16 14:26:08 +00:00
- Everyone else helped out in one way or another. I'd list all of the names but there's just too many of you. :)