From 8b82840ffd46e7f4eb7d1049fa857ae50c454084 Mon Sep 17 00:00:00 2001 From: Dylan Date: Mon, 18 Jan 2016 11:02:28 +1100 Subject: [PATCH] Readme --- Readme.md | 152 +++++++++++++++++++++++++++++------------------------- 1 file changed, 83 insertions(+), 69 deletions(-) diff --git a/Readme.md b/Readme.md index 418c055c..38e3d028 100644 --- a/Readme.md +++ b/Readme.md @@ -117,83 +117,83 @@ https://github.com/dylanaraps/fetch/blob/master/fetch#L29 ``` - usage: ${0##*/} [--colors 1 2 3 4 5] [--kernel "\$\(uname -rs\)"] +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 +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 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 +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 +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 +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 +--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 +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 +Other: +--clear on/off Whether or not to clear the terminal + before printing. +--help Print this text and exit ``` @@ -237,6 +237,20 @@ $gtk_shorthand on * Resizing the terminal so that the lines don't wrap. +#### [Linux] The script hangs and doesn't display anything + +This is caused by the getwallpaper function failing to find your current wallpaper and
+imagemagick trying to crop a nonexistent image. You can fix this by installing feh and using it
+to set your wallpaper or by changing the image source. + +You can change the source by editing the `$image` variable. The possible values are: + +* **wall** - Use the current wallpaper. +* **shuffle** - Shuffle through images in a directory. See `$shuffledir` +* **path/to/img.png** - Select an image to display. +* **off** - Disable images + +