luisgulo/neofetch
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Readme

Browse source
This commit is contained in:
Dylan 2016-01-18 13:02:35 +11:00
parent 7b3db5d9e5
commit bf86605250
1 changed files with 73 additions and 74 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

147
Readme.md
View file

@ -17,13 +17,14 @@ about your system and prints it to the terminal next to an image of your choice!
- **Supports Linux, Mac OS X and Windows (Cygwin)!** - **Supports Linux, Mac OS X and Windows (Cygwin)!**
- If the script isn't working on your system open an issue. - If the script isn't working on your system open an issue.
- *BSD support is currently in testing! See issue #10
- **It's Fast** - **It's Fast**
- The script makes heavy use of bash builtins and <br \>string manipulation. - The script makes heavy use of bash builtins and <br \>string manipulation.
- **Display an image next to the info. (or not)** - **Display an image next to the info. (or don't!)**
- The script can use your wallpaper, shuffle through a directory or just <br \>display an image. - The script can use your current wallpaper, shuffle through a directory or just <br \>display an image of your choice.
- The wallpaper function on linux uses feh, It's hard to add support <br \> - The wallpaper function on linux uses feh, It's hard to add support <br \>
for other wallpaper setters as they don't provide a way of getting <br \> for other wallpaper setters as they don't provide a way of getting <br \>
current wallpaper from the cli. the current wallpaper from the cli.
- **Highly Customizable** - **Highly Customizable**
- You can customize almost everything. - You can customize almost everything.
- See Usage below or lines 23-233 in script - See Usage below or lines 23-233 in script
@ -146,85 +147,83 @@ alias fetch2="fetch \
## Usage ## Usage
``` usage: ${0##*/} [--colors 1 2 3 4 5] [--kernel "\$\(uname -rs\)"]
usage: ${0##*/} [--colors 1 2 3 4 5] [--kernel "\$\(uname -rs\)"]
Info: Info:
--exclude "OS: getos" Disable an info line at launch --exclude "OS: getos" Disable an info line at launch
--title string Change the title at the top --title string Change the title at the top
--distro string/cmd Manually set the distro --distro string/cmd Manually set the distro
--kernel string/cmd Manually set the kernel --kernel string/cmd Manually set the kernel
--uptime string/cmd Manually set the uptime --uptime string/cmd Manually set the uptime
--uptime_shorthand on/off --v --uptime_shorthand on/off --v
Shorten the output of uptime Shorten the output of uptime
--packages string/cmd Manually set the package count --packages string/cmd Manually set the package count
--shell string/cmd Manually set the shell --shell string/cmd Manually set the shell
--winman string/cmd Manually set the window manager --winman string/cmd Manually set the window manager
--use_wmctrl on/off Use wmctrl for a more accurate reading --use_wmctrl on/off Use wmctrl for a more accurate reading
--gtk_shorthand on/off Shorten output of gtk theme/icons --gtk_shorthand on/off Shorten output of gtk theme/icons
--cpu string/cmd Manually set the cpu name --cpu string/cmd Manually set the cpu name
--memory string/cmd Manually set the memory --memory string/cmd Manually set the memory
--speed_type Change the type of cpu speed to get --speed_type Change the type of cpu speed to get
Possible values: current, min, max Possible values: current, min, max
--song string/cmd Manually set the current song --song string/cmd Manually set the current song
Text Colors: Text Colors:
--colors 1 2 3 4 5 Change the color of text --colors 1 2 3 4 5 Change the color of text
(title, subtitle, colon, underline, info) (title, subtitle, colon, underline, info)
--title_color num Change the color of the title --title_color num Change the color of the title
--subtitle_color num Change the color of the subtitle --subtitle_color num Change the color of the subtitle
--colon_color num Change the color of the colons --colon_color num Change the color of the colons
--underline_color num Change the color of the underlines --underline_color num Change the color of the underlines
--info_color num Change the color of the info --info_color num Change the color of the info
Text Formatting: Text Formatting:
--underline on/off Enable/Disable title underline --underline on/off Enable/Disable title underline
--underline_char char Character to use when underlineing title --underline_char char Character to use when underlineing title
--line_wrap on/off Enable/Disable line wrapping --line_wrap on/off Enable/Disable line wrapping
--bold on/off Enable/Disable bold text --bold on/off Enable/Disable bold text
--prompt_height num Set this to your prompt height to fix --prompt_height num Set this to your prompt height to fix
issues with the text going off screen at the top issues with the text going off screen at the top
Color Blocks: Color Blocks:
--color_blocks on/off Enable/Disable the color blocks --color_blocks on/off Enable/Disable the color blocks
--block_width num Width of color blocks --block_width num Width of color blocks
--block_range start end --v --block_range start end --v
Range of colors to print as blocks Range of colors to print as blocks
Image: Image:
--image Image source. Where and what image we display. --image Image source. Where and what image we display.
Possible values: wall, shuffle, /path/to/img, off Possible values: wall, shuffle, /path/to/img, off
--shuffledir Which directory to shuffle for an image. --shuffledir Which directory to shuffle for an image.
--font_width px Used to automatically size the image --font_width px Used to automatically size the image
--image_position Where to display the image: (Left/Right) --image_position Where to display the image: (Left/Right)
--split_size num Width of img/text splits --split_size num Width of img/text splits
A value of 2 makes each split half the terminal A value of 2 makes each split half the terminal
width and etc width and etc
--crop_mode Which crop mode to use --crop_mode Which crop mode to use
Takes the values: normal, fit, fill Takes the values: normal, fit, fill
--crop_offset value Change the crop offset for normal mode. --crop_offset value Change the crop offset for normal mode.
Possible values: northwest, north, northeast, Possible values: northwest, north, northeast,
west, center, east, southwest, south, southeast west, center, east, southwest, south, southeast
--xoffset px How close the image will be --xoffset px How close the image will be
to the left edge of the window to the left edge of the window
--yoffset px How close the image will be --yoffset px How close the image will be
to the top edge of the window to the top edge of the window
--gap num Gap between image and text right side --gap num Gap between image and text right side
to the top edge of the window to the top edge of the window
--clean Remove all cropped images --clean Remove all cropped images
Screenshot: Screenshot:
--scrot Take a screenshot --scrot Take a screenshot
--scrotdir Directory to save the scrot --scrotdir Directory to save the scrot
--scrotfile File name of scrot --scrotfile File name of scrot
--scrotcmd Screenshot program to launch --scrotcmd Screenshot program to launch
Other: Other:
--clear on/off Whether or not to clear the terminal --clear on/off Whether or not to clear the terminal
before printing. before printing.
--help Print this text and exit --help Print this text and exit
```
<!-- }}} --> <!-- }}} -->