# fetch
[[Features](#features)] [[Dependencies](#dependencies)] [[Installation](#installation)] [[Usage](#usage)] [[TODO](#todo)] [[Thanks](#thanks)]
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 of your choice!
## Features
- **Supports Linux, Mac OS X and Windows (Cygwin)!**
- If the script isn't working on your system
open an issue.
- **It's Fast**
- The script makes heavy use of bash builtins
and string manipulation.
- **Display an image next to the info. (or not)**
- The script can use your wallpaper, shuffle through a
directory or just display an image.
- **Highly Customizable**
- You can customize almost everything.
- See Usage below or lines 23-233 in script
- **Take a screenshot at the end.**
- It's disabled by default and you can specify the cmd
to use with ```--scrotcmd cmd``` at launch or by
changing the value of ```$scrotcmd``` in the script.
- **Smart crop (or Waifu crop)**
- See https://github.com/dylanaraps/fetch/wiki/What-is-Smart-Crop%3F
## Dependencies
These are the script's required dependencies
- Bash **4.0+**
- Text formatting, dynamic image size and padding: tput
- Uptime detection: procps or procps-ng
These are the script's optional dependencies:
- Displaying Images: w3m
- You may also need w3m-img
- Image Cropping: ImageMagick
- Display Wallpaper: feh
- Current Song: mpc
- Resolution Detection: xorg-xdpyinfo
- Window manager detection: wmctrl
- This is used as a fallback to parsing ```.xinitrc``` and ```$XDG_CURRENT_DESKTOP```.
- Take a screenshot on script finish: scrot
- You can change this to another program with a ```--scrotcmd``` and an in script option.
## Installation
### Arch
1. Install ```fetch-git``` from the aur.
### Others
1. Download the latest source at https://github.com/dylanaraps/fetch
2. Make the file executable using chmod. ```chmod +x /path/to/fetch```
3. Move the script to somewhere in your $PATH or just run it from where it is.
## Usage
There's an array near the top of the script that allows you
to pick and choose what to display and where! You can also add custom
info to print!
The script now supports dynamic image sizing and padding,
it's enabled by default and there's a variable you
need to set for it to work correctly.
You can either change the variable $fontwidth inside of the
script or launch it with ```--font_width num```.
Once you set the var the script will scale the image and padding
to fit your terminal window.
```
usage: ${0##*/} [--colors 1 2 3 4 5] [--kernel "\$\(uname -rs\)"]
Info:
--exclude "OS: getos" Disable an info line at launch
--title string Change the title at the top
--distro string/cmd Manually set the distro
--kernel string/cmd Manually set the kernel
--uptime string/cmd Manually set the uptime
--uptime_shorthand on/off --v
Shorten the output of uptime
--packages string/cmd Manually set the package count
--shell string/cmd Manually set the shell
--winman string/cmd Manually set the window manager
--use_wmctrl on/off Use wmctrl for a more accurate reading
--gtk_shorthand on/off Shorten output of gtk theme/icons
--cpu string/cmd Manually set the cpu name
--memory string/cmd Manually set the memory
--speed_type Change the type of cpu speed to get
Possible values: current, min, max
--song string/cmd Manually set the current song
Text Colors:
--colors 1 2 3 4 5 Change the color of text
(title, subtitle, colon, underline, info)
--title_color num Change the color of the 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
Text Formatting:
--underline on/off Enable/Disable title underline
--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
Color Blocks:
--color_blocks on/off Enable/Disable the color blocks
--block_width num Width of color blocks
--block_range start end --v
Range of colors to print as blocks
Image:
--image Image source. Where and what image we display.
Possible values: wall, shuffle, /path/to/img, off
--shuffledir Which directory to shuffle for an image.
--font_width px Used to automatically size the image
--image_position Where to display the image: (Left/Right)
--split_size num Width of img/text splits
A value of 2 makes each split half the terminal
width and etc
--crop_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
--yoffset px How close the image will be
to the top edge of the window
--gap num Gap between image and text right side
to the top edge of the window
--clean Remove all cropped images
Screenshot:
--scrot Take a screenshot
--scrotdir Directory to save the scrot
--scrotfile File name of scrot
--scrotcmd Screenshot program to launch
Other:
--clear on/off Whether or not to clear the terminal
before printing.
--help Print this text and exit
```
## TODO
Here's what's on my todo list
- Add Windows resolution detection
- Cleanup of info array handling
- Imagemagick optimizations
- More info outputs. Now that it's easy to customize what's printed and
everything is a function we can add optional support for pretty much anything.
- Resolution (Done!)
- GTK themes (Done!)
- Terminal Font
- GPU
- IP
- etc
### Thanks
Thanks to:
- metakirby5: Providing great feedback as well as ideas for the script.
- Screenfetch: I've used some snippets as a base for a few functions in this script.
- @jrgz: Helping me test the Mac OS X version.
- @xDemonessx: Helping me test the Windows version.