neofetch/Readme.md

179 lines
5.1 KiB
Markdown
Raw Normal View History

2015-12-30 10:18:17 +00:00
# fetch.sh
2015-12-30 10:20:53 +00:00
2016-01-04 05:00:19 +00:00
## Big updates: Check the releases page.
2016-01-03 08:59:15 +00:00
2015-12-30 10:18:17 +00:00
This is the home of my fetch script! This script gathers info <br\>
about your system and prints it to the terminal.
2016-01-05 22:59:56 +00:00
The script currently supports Linux, Mac OS X and Windows (Cygwin), if your OS or distro isn't
supported open an issue and I'll add support for it.
2015-12-30 10:18:17 +00:00
2016-01-03 08:59:15 +00:00
![1](https://sr.ht/Jd8Y.png)
2015-12-30 10:18:17 +00:00
2016-01-05 22:59:56 +00:00
<!-- Dependences {{{ -->
2015-12-31 22:36:26 +00:00
## Dependencies
2015-12-30 10:18:17 +00:00
2015-12-31 00:21:10 +00:00
These are the script's required dependencies
- Text formatting, dynamic image size and padding: tput
These are the script's optional dependencies:
2015-12-30 10:18:17 +00:00
- Displaying Images: w3m
2016-01-04 23:24:41 +00:00
- You may also need w3m-img
2015-12-30 10:18:17 +00:00
- Image Cropping: ImageMagick
- Display Wallpaper: feh
- Current Song: mpc
2016-01-04 05:00:19 +00:00
- Resolution Detection: xorg-xdpyinfo
2016-01-04 05:26:09 +00:00
- Window manager detection: wmctrl
- This is used as a fallback to parsing ```.xinitrc``` and ```$XDG_CURRENT_DESKTOP```.
2015-12-30 10:18:17 +00:00
2015-12-31 22:36:26 +00:00
2015-12-31 22:33:08 +00:00
<!-- }}} -->
2015-12-30 10:18:17 +00:00
2015-12-31 22:33:08 +00:00
2016-01-05 22:59:56 +00:00
<!-- Usage {{{ -->
2015-12-31 22:36:26 +00:00
## Usage
2015-12-30 10:18:17 +00:00
2015-12-31 00:21:10 +00:00
The script now supports dynamic image sizing and padding,
<br\> it's enabled by default and there's a variable you
2015-12-31 00:21:10 +00:00
<br\> need to set for it to work correctly.
You can either change the variable $fontwidth inside of the
<br\> script or launch it with ```--font_width num```.
2015-12-31 00:21:10 +00:00
Once you set the var the script will scale the image and padding
<br\> to fit your terminal window.
Please report any bugs or issues you're having with this as I can't
<br\> test with many configurations.
2015-12-30 11:40:58 +00:00
```
usage: scrot.sh [--colors 1 2 4 5] [--kernel "$(uname -rs)"]
Info:
--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
2015-12-30 11:40:58 +00:00
--packages string/cmd Manually set the package count
--shell string/cmd Manually set the shell
--winman string/cmd Manually set the window manager
--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
2015-12-30 11:40:58 +00:00
--song string/cmd Manually set the current song
Text Colors:
--colors 1 2 3 4 5 Change the color of text
2015-12-30 11:40:58 +00:00
(title, subtitle, colon, 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 underline
--info_color num Change the color of the info
2015-12-30 11:40:58 +00:00
2015-12-31 00:21:10 +00:00
Text Formatting:
2015-12-31 22:33:08 +00:00
--underline on/off Enable/Disable title underline
--underline_char char Character to use when underlineing title
--line_wrap on/off Enable/Disable line wrapping
2015-12-31 22:33:08 +00:00
--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
2015-12-31 00:21:10 +00:00
2015-12-30 11:40:58 +00:00
Color Blocks:
2015-12-31 22:33:08 +00:00
--color_blocks on/off Enable/Disable the color blocks
--block_range start end --v
Range of colors to print as blocks
--block_width num Width of color blocks
2015-12-30 11:40:58 +00:00
Image:
--image Image to display with the script
The image gets priority over other
images: (wallpaper, \$img)
2015-12-31 00:21:10 +00:00
--font_width px Used to automatically size the image
2016-01-03 23:36:32 +00:00
--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 crop_mode normal.
Possible values: northwest, north, northeast,
west, center, east, southwest, south, southeast
2015-12-30 11:40:58 +00:00
--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
2015-12-31 00:21:10 +00:00
--gap num Gap between image and text right side
--images on/off Enable/Disable all images
2015-12-31 22:33:08 +00:00
--wall on/off Enable/Disable the wallpaper function
2015-12-30 11:40:58 +00:00
and fallback to \$img
--clean Remove all cropped images
Other:
--help Print this text and exit
```
2015-12-30 10:18:17 +00:00
2015-12-31 22:36:26 +00:00
2015-12-31 22:33:08 +00:00
<!-- }}} -->
2015-12-30 10:18:17 +00:00
2016-01-05 22:59:56 +00:00
<!-- TODO {{{ -->
2015-12-31 22:36:26 +00:00
## TODO
2015-12-30 10:18:17 +00:00
Here's what's on my todo list
2016-01-04 07:27:49 +00:00
- Cleanup of info array handling
2015-12-31 22:33:08 +00:00
2016-01-03 09:02:39 +00:00
- Windows support (I'm almost done)
- OpenBSD support (Partially implemented, just needs testing)
2016-01-03 09:02:39 +00:00
- 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.
2016-01-04 07:27:49 +00:00
- Resolution (Done!)
2016-01-03 09:02:39 +00:00
- GTK themes
- Terminal Font
- GPU
- IP
- etc
2015-12-31 22:36:26 +00:00
2015-12-31 22:33:08 +00:00
<!-- }}} -->
### Crop mode comparison
2015-12-31 22:33:08 +00:00
2015-12-31 22:38:31 +00:00
#### Fit
2015-12-31 22:37:50 +00:00
![fit](https://imgur.com/MI0UtSV.png)
2015-12-31 22:33:08 +00:00
2015-12-31 22:38:31 +00:00
#### Fill
2015-12-31 22:37:50 +00:00
![fill](https://imgur.com/LvxYwki.png)
### Thanks
Thanks to:
2016-01-04 07:26:34 +00:00
- 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.