hyfetch/README.md

438 lines
14 KiB
Markdown
Raw Normal View History

2016-01-05 19:16:52 -07:00
# fetch
2015-12-30 03:20:53 -07:00
2016-02-14 06:04:55 -07:00
[![Gitter](https://badges.gitter.im/dylanaraps/fetch.svg)](https://gitter.im/dylanaraps/fetch?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
2016-01-15 16:18:50 -07:00
This is the home of my fetch script! This script gathers info <br />
2016-01-29 20:31:40 -07: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 03:18:17 -07:00
2016-01-29 20:31:40 -07:00
![1](http://i.imgur.com/t1V9crb.png)
2015-12-30 03:18:17 -07:00
2016-01-20 02:40:17 -07:00
<!-- Table of Contents {{{ -->
## Table of Contents
2016-01-30 16:19:22 -07:00
- [Screenshots](#screenshots)
2016-01-29 21:34:34 -07:00
- [Features](#features)
2016-01-20 02:40:17 -07:00
- [Dependencies](#dependencies)
- [Installation](#installation)
- [Post Install](#post-install)
- [Usage](#usage)
- [Frequently Asked Questions](#frequently-asked-questions)
- [Issues and Workarounds](#issues-and-workarounds)
- [Thanks](#thanks)
<!-- }}} -->
2016-01-30 16:19:22 -07:00
<!-- Screenshots {{{ -->
## Screenshots
![Windows](https://i.imgur.com/oVv5gHn.png)
![Mac OS X](http://i.imgur.com/KEi9EEi.png)
![Linux](https://ipfs.pics/ipfs/QmQL7jbxuRAX8HxL2ePNH7zUpXnePV3LRuodXZQvdiFiWk)
2016-01-30 16:19:22 -07:00
![Linux](https://i.imgur.com/6fgnvcq.png)
2016-01-30 23:04:46 -07:00
![Linux](http://i.imgur.com/CBpGjnw.png)
2016-01-30 16:19:22 -07:00
<!-- }}} -->
2016-01-29 21:34:34 -07:00
<!-- Features {{{ -->
## Features
- Supports **Linux**, **Mac OS X**, **BSD (FreeBSD, OpenBSD & NetBSD)** and **Windows** (Cygwin)
2016-01-29 21:34:34 -07: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.
- See this **[wiki page](https://github.com/dylanaraps/fetch/wiki/Customizing-Info)**
<!-- }}} -->
2016-01-05 15:59:56 -07:00
<!-- Dependences {{{ -->
2015-12-31 15:36:26 -07:00
## Dependencies
2015-12-30 03:18:17 -07:00
2016-01-22 00:04:53 -07:00
2016-02-02 21:25:17 -07:00
### Required dependencies:
2015-12-30 17:21:10 -07:00
2016-01-20 02:40:17 -07:00
- `Bash 4.0+`
2016-02-02 21:25:17 -07:00
- `procps-ng`
- Not required on OS X
2016-01-17 18:55:38 -07:00
2016-01-27 15:14:02 -07:00
2016-01-22 00:04:53 -07:00
### Optional dependencies:
2016-01-17 18:55:38 -07:00
2016-02-03 00:55:00 -07:00
- Displaying images: `w3m-img` \[1\] or `iTerm2` \[2\]
2016-02-02 21:25:17 -07:00
- Thumbnail creation: `imagemagick`
2016-01-27 15:14:02 -07:00
2016-02-02 21:25:17 -07:00
##### Linux / BSD
2016-01-17 18:55:38 -07:00
2016-02-03 00:55:00 -07:00
- Window Manager: `wmctrl` \[3\]
2016-02-02 21:25:17 -07:00
- Wallpaper: `feh`, `nitrogen` or `gsettings`
- Current Song: `mpc` or `cmus`
- Resolution: `xorg-xdpyinfo`
2016-02-03 00:55:00 -07:00
- Screenshot: `scrot` \[4\]
2015-12-30 03:18:17 -07:00
2016-02-03 00:55:00 -07:00
\[1\] `w3m-img` is sometimes bundled together with `w3m`.
\[2\] You can enable the `iTerm2` image backend by using the launch flag `--image_backend iterm2` or by<br \>
changing the config option `$image_backend` to `iterm2`.
\[3\] You should install wmctrl if the builtin window manager detection isn't working for you. The builtin<br \>
2016-02-02 21:25:17 -07:00
detection works for most people and is generally faster which is why wmctrl isn't default.
2016-01-17 18:55:38 -07:00
2016-02-03 00:55:00 -07:00
\[4\] You can use the launch flag `--scrot_cmd` or change the config option `$scrot_cmd` to your screenshot<br \>
2016-02-02 21:25:17 -07:00
program's cmd and fetch will use it instead of scrot.
2016-01-17 18:55:38 -07:00
2015-12-31 15:36:26 -07:00
2015-12-31 15:33:08 -07:00
<!-- }}} -->
2015-12-30 03:18:17 -07:00
2015-12-31 15:33:08 -07:00
2016-01-08 19:27:37 -07:00
<!-- Installation {{{ -->
## Installation
### Arch
2016-01-20 02:40:17 -07:00
1. Install **[fetch-git](https://aur.archlinux.org/packages/fetch-git/)** from the aur.
2016-01-08 19:27:37 -07:00
2016-01-28 18:13:48 -07:00
### Gentoo / Funtoo
1. Add the 3rd party repo
- `layman -o https://gist.githubusercontent.com/z1lt0id/24d45b15800b98975260/raw/2fdf6645cdc3c1ca0b0af83a7bf8f86598e386ae/fs0ciety.xml -f -a fs0ciety`
2. Sync the repos
- `layman -S`
3. To enable w3m and scrot support, enable the appropriate flags.
- `echo "x11-apps/fetch" >> /etc/portage/package.use`
4. Install the package
- `emerge -a x11-apps/fetch`
2016-01-08 19:27:37 -07:00
### Others
1. Download the latest source at https://github.com/dylanaraps/fetch
2. Run `make install` inside the script directory to install the script.
- **El Captain**: `PREFIX=/usr/local make install`
**NOTE:** Fetch can be uninstalled easily using `make uninstall`.
**NOTE:** Fetch can also be run from any directory like a normal script,<br \>
2016-02-02 21:25:17 -07:00
you'll just be missing the ascii distro logos and automatic config file creation.
2016-01-08 19:27:37 -07:00
<!-- }}} -->
2016-01-17 18:43:06 -07:00
<!-- Post Install {{{ -->
2015-12-31 15:36:26 -07:00
2016-01-29 20:31:40 -07:00
2016-01-17 18:43:06 -07:00
## Post Install
2015-12-31 15:36:26 -07:00
2016-01-30 22:40:21 -07:00
2016-01-29 20:31:40 -07:00
#### Using the config file
Fetch will by default create a config file at `$HOME/.config/fetch/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`.
2015-12-30 03:18:17 -07:00
2016-01-21 04:33:05 -07:00
#### Sizing the image correctly
2016-01-29 20:31:40 -07:00
**NOTE:** For the images to be sized correctly you need to set the `$font_width` variable.<br \>
If you don't know your font width in pixels keep trying values until the image is half the<br \>
terminal width.
2016-01-16 23:57:39 -07:00
Once `font_width` is set the image will by default take up half the terminal width. You can<br \>
use the launch flag `--size px` or change the config option `$image_size` to set it to a custom<br \>
size in pixels.
You can also use the launch flag `--font_width` to set it on the fly.
2016-01-17 00:01:14 -07:00
2016-01-21 04:33:05 -07:00
2016-01-30 22:40:21 -07:00
#### Setting the prompt height
If your shell prompt's height is greater than 1 line high, you'll need to change a config<br \>
option to avoid issues with the top lines in the script output getting cut off. Set the variable<br \>
`$prompt_height` to your shell prompt's height in lines or use the launch flag `--prompt_height`.
2016-01-21 04:33:05 -07:00
#### Customizing what info gets displayed
2016-01-30 21:05:12 -07:00
In the config file there's a function that allows you to customize all of the info that<br \>
gets displayed.
2016-01-21 04:33:05 -07:00
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!
2016-01-17 18:43:06 -07:00
Here's what my fetch alias looks like:
```sh
alias fetch2="fetch \
--block_range 1 8 \
--line_wrap off \
--bold off \
--uptime_shorthand on \
--gtk_shorthand on \
--colors 4 1 8 8 8 7 \
"
```
<!-- }}} -->
<!-- Usage {{{ -->
## Usage
2015-12-30 04:40:58 -07:00
2016-02-02 21:25:17 -07:00
usage: fetch --option "value" --option "value"
2016-01-17 19:02:35 -07:00
Info:
--disable infoname Allows you to disable an info line from appearing
in the output.
NOTE: You can supply multiple args. eg.
'fetch --disable cpu gpu disk shell'
--osx_buildversion on/off Hide/Show Mac OS X build version.
--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.
--kernel_shorthand on/off Shorten the output of kernel
--uptime_shorthand on/off Shorten the output of uptime (tiny, on, off)
--gpu_shorthand on/off Shorten the output of GPU
--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
--birthday_shorthand on/off Shorten the output of birthday
--birthday_time on/off Enable/Disable showing the time in birthday output
2016-01-17 19:02:35 -07:00
Text Colors:
--title_color num Change the color of the title
--at_color num Change the color of "@" in title
--subtitle_color num Change the color of the subtitle
--colon_color num Change the color of the colons
--underline_color num Change the color of the underlines
--info_color num Change the color of the info
2016-01-17 19:02:35 -07:00
Text Formatting:
--underline_char char Character to use when underlineing title
--line_wrap on/off Enable/Disable line wrapping
--bold on/off Enable/Disable bold text
--prompt_height num Set this to your prompt height to fix issues with
the text going off screen at the top
2016-01-17 19:02:35 -07:00
Color Blocks:
--color_blocks on/off Enable/Disable the color blocks
--block_width num Width of color blocks
--block_range start end Range of colors to print as blocks
2016-01-17 19:02:35 -07:00
Image:
--image type Image source. Where and what image we display.
Possible values: wall, shuffle, ascii,
/path/to/img, off
--size px Size in pixels to make the image.
--image_backend w3m/iterm2 Which program to use to draw images.
--shuffle_dir path/to/dir Which directory to shuffle for an image.
--font_width px Used to automatically size the image
--image_position left/right Where to display the image: (Left/Right)
--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
2016-01-17 19:02:35 -07:00
2016-01-27 04:33:22 -07:00
Ascii:
--ascii value Where to get the ascii from, Possible values:
distro, /path/to/ascii
--ascii_color num Color to print the ascii art
--ascii_distro distro Which Distro\'s ascii art to print
2016-01-27 04:33:22 -07:00
2016-02-05 16:49:06 -07:00
Stdout:
--stdout info info Launch fetch in stdout mode which prints the info
in a plain-text format that you can use with
lemonbar etc.
--stdout_title on/off Hide/Show the title in stdout mode.
--stdout_separator string String to use as a separator in stdout mode.
2016-02-05 16:49:06 -07:00
--stdout_subtitles on/off Hide/Show the subtitles in stdout mode.
2016-01-17 19:02:35 -07:00
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
2016-01-17 19:02:35 -07:00
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
2015-12-30 03:18:17 -07:00
2015-12-31 15:36:26 -07:00
2015-12-31 15:33:08 -07:00
<!-- }}} -->
2015-12-30 03:18:17 -07:00
2016-01-20 02:40:17 -07:00
<!-- Frequently Asked Questions {{{ -->
## Frequently Asked Questions
2016-01-28 02:11:18 -07:00
#### How do I enable screenfetch mode?
2016-01-28 18:31:26 -07:00
Launching the script with `--ascii distro` or setting `ascii="distro"` and `image="ascii"` <br \>
2016-02-04 00:22:52 -07: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.
**NOTE:** If you don't have `w3m-img` or `imagemagick` installed screenfetch mode will be<br \>
used automatically
2016-01-28 02:11:18 -07:00
![arch](http://i.imgur.com/uCMjgf6.png)
2016-01-28 02:11:18 -07:00
2016-01-20 02:40:17 -07:00
#### Why doesn't fetch support my wallpaper setter?
2016-02-04 00:22:52 -07: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 02:40:17 -07:00
2016-02-04 00:22:52 -07: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 02:40:17 -07:00
<!-- }}} -->
<!-- Issues and Workarounds {{{ -->
## Issues and Workarounds
2016-02-02 21:27:09 -07:00
#### The text is too long for my terminal window and wraps to the next line
There are a few ways to fix this.
2016-01-25 15:35:12 -07:00
* Disable line wrapping with `line_wrap=off` in the script or with the launch flag `--line_wrap off`
* The uptime and gtk info lines each have a shorthand option that makes their output smaller. You can <br \>
enable them by changing these variables or using these flags.
```sh
# Config options
2016-01-22 00:04:53 -07:00
uptime_shorthand="on"
gtk_shorthand="on"
gpu_shorthand="on"
2016-01-30 21:08:12 -07:00
birthday_shorthand="on"
# Launch flags
--uptime_shorthand on
--gtk_shorthand on
2016-01-20 23:23:29 -07:00
--gpu_shorthand on
2016-01-30 21:08:12 -07:00
--birthday_shorthand on
```
2016-01-29 20:31:40 -07:00
* Edit the config to make the subtitles shorter
* Resizing the terminal so that the lines don't wrap.
#### 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 15:29:08 -07:00
#### getgpu doesn't show my exact video card name
2016-01-20 18:25:36 -07:00
If your `lspci | grep "VGA"` output looks like this:
2016-01-19 15:29:08 -07: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-01-08 19:27:37 -07:00
<!-- Thanks {{{ -->
## Thanks
Thanks to:
2016-02-05 17:15:49 -07:00
- `Screenfetch`:
2016-01-28 02:32:07 -07:00
- I've used some snippets as a base for a few functions in this script.
- I've used the ascii art from here.
2016-02-05 17:15:49 -07:00
- `metakirby5`: Providing great feedback as well as ideas for the script.
- `@jrgz`: Helping me test the Mac OS X version.
- `@xDemonessx`: Helping me test the Windows version.
- `@tudurom`: Helping me test **everything**.
- Everyone else who has helped test the script, given feedback or reported bugs.
2016-01-30 21:08:12 -07:00
2016-01-08 19:27:37 -07:00
<!-- }}} -->