neofetch/Readme.md

158 lines
4.6 KiB
Markdown
Raw Normal View History

2015-12-30 10:18:17 +00:00
# fetch.sh
2015-12-31 00:21:10 +00:00
### Check the releases page
2015-12-30 10:18:17 +00:00
2015-12-30 10:20:53 +00:00
https://github.com/dylanaraps/fetch.sh
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.
I've spent the past few days rewriting this and it now supports <br\>
other distros as well as a ton of new features and bug fixes.
If you're having any issues or have any ideas, please open an issue! <br\>
I can't test on many other distros and I want this to work <br\>
for as many people as possible.
2015-12-31 00:37:31 +00:00
![1](https://sr.ht/xL9f.png)
2015-12-30 10:18:17 +00:00
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
- Image Cropping: ImageMagick
- Display Wallpaper: feh
- Current Song: mpc
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
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\> they're enabled by default and there's a variable you
<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 "--fontwidth num".
Once you set the var the script will scale the image and padding
<br\> to fit your terminal window.
You can disable this by changing the var "$img_auto" or by launching
<br\> the script with "--size px".
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
--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 string/cmd Manually set the cpu speed
--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 Change the color of text
(title, subtitle, colon, info)
--titlecol num Change the color of the title
--subtitlecol num Change the color of the subtitle
--coloncol num Change the color of the colons
--infocol num Change the color of the info
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
--linewrap on/off Enable/Disable line wrapping
--bold on/off Enable/Disable bold text
2015-12-31 00:21:10 +00:00
2015-12-30 11:40:58 +00:00
Color Blocks:
--printcols start end Range of colors to print as blocks
2015-12-31 22:33:08 +00:00
--blockwidth num Width of color blocks
--color_blocks on/off Enable/Disable the 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
--fontwidth Used to automatically size the image
2015-12-30 11:40:58 +00:00
--size px Change the size of the image
2015-12-31 22:33:08 +00:00
--smart_crop on/off Smart crop images with plain color backgrounds
--smart_crop_mode Which mode to use with smart crop
Takes the values: fit, fill
--img_auto on/off Enable/Disable automatic i mage sizing
2015-12-30 11:40:58 +00:00
--cropoffset value Change the crop offset. Possible values:
northwest, north, northeast, west, center
east, southwest, south, southeast
2015-12-31 00:21:10 +00:00
--padding num How many spaces to pad the text
2015-12-30 11:40:58 +00:00
to the right
--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
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
- Add an easy way to define info prefixes at launch.
2015-12-31 01:39:46 +00:00
- Cleanup
2015-12-31 05:24:02 +00:00
- Add options to bold other text in the script (info, underline, colons)
2015-12-31 22:33:08 +00:00
- Fix linewrapping flag with tmux
- Fix issues with multiline prompts
2015-12-31 22:36:26 +00:00
2015-12-31 22:33:08 +00:00
<!-- }}} -->
### Smart Crop mode comparison
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)