neofetch/README.md

143 lines
4.6 KiB
Markdown
Raw Normal View History

2016-02-28 01:44:45 +01:00
# Neofetch
2015-12-30 11:20:53 +01:00
2016-04-01 15:29:45 +02: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 14:04:55 +01:00
2016-01-16 00:18:50 +01:00
This is the home of my fetch script! This script gathers info <br />
2016-01-30 04:31:40 +01:00
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!
2015-12-30 11:18:17 +01:00
2016-05-09 00:27:59 +02:00
Have a look at the wiki, I've updated/added some new pages!<br \>
2016-04-24 12:46:38 +02:00
**https://github.com/dylanaraps/neofetch/wiki**
2016-04-24 12:45:50 +02:00
2016-05-29 10:00:31 +02:00
![1](https://ipfs.pics/ipfs/QmTtF9Sx8o617QE88GH3Z4yX7mRyi4yS1hsMHyRVmn14vJ)
2015-12-30 11:18:17 +01:00
2016-01-30 05:34:34 +01:00
## Features
2016-11-07 01:27:10 +01:00
- Supports **Linux**, **MacOS**, **iOS**, **BSD**, **Solaris**, **Android**, **Haiku OS**, **GNU Hurd** and **Windows (Cygwin/Windows 10 Linux subsystem)**
2016-01-30 05:34:34 +01:00
- 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.
2016-02-28 01:44:45 +01:00
- See this **[wiki page](https://github.com/dylanaraps/neofetch/wiki/Customizing-Info)**
2016-01-30 05:34:34 +01:00
2015-12-31 23:36:26 +01:00
## Dependencies
2015-12-30 11:18:17 +01:00
2016-11-12 10:59:59 +01:00
https://github.com/dylanaraps/neofetch/wiki/Dependencies
2016-11-02 03:31:22 +01:00
2016-10-27 00:40:16 +02:00
2016-01-09 03:27:37 +01:00
## Installation
2016-11-12 11:05:53 +01:00
https://github.com/dylanaraps/neofetch/wiki/Installation
2016-01-09 03:27:37 +01:00
2016-01-18 02:43:06 +01:00
## Post Install
2015-12-31 23:36:26 +01:00
2016-01-31 06:40:21 +01:00
2016-01-30 04:31:40 +01:00
#### Using the config file
2016-02-28 01:44:45 +01:00
Neofetch will by default create a config file at `$HOME/.config/neofetch/config` and this file<br \>
2016-01-30 04:31:40 +01:00
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`.
2015-12-30 11:18:17 +01:00
2016-01-21 12:33:05 +01:00
#### Customizing what info gets displayed
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!
2016-01-18 02:43:06 +01:00
2016-08-12 14:01:39 +02:00
Here's an example neofetch alias:
2016-01-18 02:43:06 +01:00
```sh
2016-08-12 14:01:39 +02:00
alias neofetch2="neofetch \
--config off \
2016-01-18 02:43:06 +01:00
--block_range 1 8 \
--bold off \
--uptime_shorthand on \
--gtk_shorthand on \
--colors 4 1 8 8 8 7 \
"
```
2016-01-20 10:40:17 +01:00
## Frequently Asked Questions
2016-01-28 10:11:18 +01:00
#### How do I enable screenfetch mode?
2016-08-12 14:01:39 +02:00
Launching the script with `--ascii` or setting `image="ascii"` <br \>
2016-02-04 08:22:52 +01:00
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.
2016-03-10 09:21:22 +01:00
**NOTE:** If you **don't** have `w3m-img` or `imagemagick` installed screenfetch mode will be<br \>
2016-02-04 08:22:52 +01:00
used automatically
2016-01-28 10:11:18 +01:00
2016-02-28 01:44:45 +01:00
#### Why doesn't Neofetch support my wallpaper setter?
2016-01-20 10:40:17 +01:00
2016-02-04 08:22:52 +01:00
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.
2016-01-20 10:40:17 +01:00
2016-02-04 08:22:52 +01:00
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 \>
2016-01-20 10:40:17 +01:00
## 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.
2016-01-19 23:29:08 +01:00
#### getgpu doesn't show my exact video card name
2016-01-21 02:25:36 +01:00
If your `lspci | grep "VGA"` output looks like this:
2016-01-19 23:29:08 +01: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.
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
```
2016-03-27 04:34:29 +02:00
#### 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:
2016-02-23 15:33:25 +01:00
- [Screenfetch](https://github.com/KittyKatt/screenFetch):
2016-01-28 10:32:07 +01:00
- I've used some snippets as a base for a few functions in this script.
2016-08-12 14:01:39 +02:00
- Some of the ascii logos.
- [ufetch](https://github.com/jschx/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. :)