From f433e964207af8a50e316102928126261b563e38 Mon Sep 17 00:00:00 2001 From: dylan araps Date: Wed, 30 Dec 2015 22:40:58 +1100 Subject: [PATCH] Readme --- Readme.md | 96 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 51 insertions(+), 45 deletions(-) diff --git a/Readme.md b/Readme.md index 2b3049bf..cee4c5b1 100644 --- a/Readme.md +++ b/Readme.md @@ -29,59 +29,65 @@ These are the script's optional dependencies - Window Manager Detection: wmctrl - You can manually set this at launch with: - ```scrot.sh --winman string``` - + ```sh + scrot.sh --winman string + ``` ## Usage - usage: scrot.sh [--colors 1 2 4 5] [--kernel "$(uname -rs)"] +The whitespace - 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 - --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 +``` +usage: scrot.sh [--colors 1 2 4 5] [--kernel "$(uname -rs)"] - Color Blocks: - --printcols start end Range of colors to print as blocks - --nopal Disable the color blocks +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 +--song string/cmd Manually set the current song - Image: - --image Image to display with the script - The image gets priority over other - images: (wallpaper, \$img) - --size px Change the size of the image - --cropoffset value Change the crop offset. Possible values: - northwest, north, northeast, west, center - east, southwest, south, southeast" - --padding How many spaces to pad the text - 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 - --noimg Disable all images - --nowall Disable the wallpaper function - and fallback to \$img - --clean Remove all cropped images +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 - Other: - --help Print this text and exit +Color Blocks: +--printcols start end Range of colors to print as blocks +--nopal Disable the color blocks + +Image: +--image Image to display with the script + The image gets priority over other + images: (wallpaper, \$img) +--size px Change the size of the image +--cropoffset value Change the crop offset. Possible values: + northwest, north, northeast, west, center + east, southwest, south, southeast +--padding How many spaces to pad the text + 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 +--noimg Disable all images +--nowall Disable the wallpaper function + and fallback to \$img +--clean Remove all cropped images + +Other: +--help Print this text and exit +``` ## TODO