https://github.com/marcinorlowski/show-cheatsheet

Shell script that displays any image file centered over specified area, either active window or whole display.
https://github.com/marcinorlowski/show-cheatsheet

bash cheat-sheet cheatsheets helper-tool xwin

Last synced: about 2 months ago
JSON representation

Shell script that displays any image file centered over specified area, either active window or whole display.

• Host: GitHub
• URL: https://github.com/marcinorlowski/show-cheatsheet
• Owner: MarcinOrlowski
• License: mit
• Created: 2019-07-22T20:57:05.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2021-01-21T21:15:53.000Z (over 4 years ago)
• Last Synced: 2025-02-03T08:13:37.176Z (4 months ago)
• Topics: bash, cheat-sheet, cheatsheets, helper-tool, xwin
• Language: Shell
• Homepage:
• Size: 72.3 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Show cheatsheet #

## Preface ##

 Shell script that displays any image file centered over specified area, either active window or whole display. 

 The main reason to write this script was to let me me quickly display cheatsheet image of my choice (with 

 this [shell shortcuts cheatsheet](img/shell-keys-cheatsheet.png) being the main reason). I wanted to be able to peek the 

 cheatsheet easily at any time, but I couldn't find any existing tool to show me that image in useful way - display it

 centered over currently actvive (focused) window and be quickly dismissed. This script reads details of currently active

 window and then steers existing image viewers to show the image centered over that window (or whole display area).

 Once I had it working, I created global key shortcut in my desktop environment that once hit, started `show-cheatsheet`

 and voila - I had my cheatsheet hovering over my currently used terminal window (see [Integration](#integration) for

 how to do the same in KDE).

 This script shall work with any modern window manager.

## Requirements ##

 The following packages are required:

  * ImageMagick ([website](https://imagemagick.org/))

  * xdotool ([website](https://www.semicomplete.com/projects/xdotool/))

 Optional but recommended:

  * feh - image viewer ([website](https://feh.finalrewind.org/))

 All these should be installable by your package manager. For Debian/Ubuntu/Kubuntu do:

    sudo apt install -y imagemagick xdotool feh

## Usage ##

    show-cheatsheet [-h] [-c MODE] [-v VIEWER] FILE

 Supported arguments are:

  * `-h` displays help page

  * `-c MODE` sets centering mode of displayed image. Supported options are:

     * `window` or `w` to open image centered over currently active window (default)

     * `display` or `d` to open image centered over whole display (screen) area

  * `-v VIEWER` sets viewer to be used. If not specified, tries to find one automatically. Supported viewers are:

     * `feh` ([website](https://feh.finalrewind.org/))

     * `display` from ImageMagick package ([website](https://imagemagick.org/script/display.php))

  * `FILE` image file to be displayed

## Viewers ##

 Support for any new image viewer can be easily added, however only apps that support `--geometry` type of argument

 or are offering any other way control placement of their opened window are of any use. It'd be also handy if viewer

 could be dismissed with just `ECS` key but that's optional.

## Examples ##

 To display `bash-cheatsheet.png` over currently active terminal window:

    show-cheatsheet bash-cheatsheet.png

 This assumes cheatsheet image is in your current working directory and `show-cheatsheet` is in your `$PATH`.

 If neither is the case, use full paths.

 To make image display centered:

    show-cheatsheet -c window bash-cheatsheet.png

 To use `display` utility instead of `feh` in case both are installed

    show-cheatsheet -v display bash-cheatsheet.png

## Integration ##

 Using script with global shortcut in KDE:

  - Run `kmenuedit`

  - Create `New item...` and name it as you like (i.e. "Shell cheatsheet")

  - Set `/show-cheatsheet /bash-cheatsheet.png` as `Command`

  - Set `Current shortcut key` on `Advanced` tab to whatever you like

  - Save.

 You can now i.e. open new Konsole window and try your shortcut to see if it makes cheatsheet image pop up.

---

## License ##

 * Written and copyrighted ©2019-2021 by Marcin Orlowski 

 * This is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)