winneon.gsu/README.md

gsu

gsu (General Screenshot Utility) allows for easy capturing and uploading of images, video, and gifs from your desktop.

Features

• Screenshot capture.
• Video capture.
• GIF capture.
• Built-in uploading to uguu.se, streamable, and gfycat.
• Custom uploading capability if the above services don't suit your fancy.
• dmenu and rofi integration.
• A clean and easy to understand CLI.

Usage

Usage: gsu [OPTION]... SOURCE
A general screenshot and upload utility for images, video, and gifs.

SOURCE defaults to $XDG_CONFIG_HOME/gsu/imgs if nothing is provided.
The most common location for $XDG_CONFIG_HOME is ~/.config.

GENERAL OPTIONS
  -h, --help                 Show the help menu.
  -v, --version              Show the current version.
  -l, --list-displays        List your current displays and their resolutions.
  -u, --upload               Upload after running the utility.
  --hide                     Minimize the current window while capturing.
                             This is useful when running with --terminal to hide
							 the newly opened term.
  --terminal                 Open interactive commands in a new terminal..
                             SET THIS IF RUNNING FROM ANYTHING OTHER THAN A TERM,
                             i.e. xbindkeys
  --notify                   Send a libnotify notification of the output.

UTILITY OPTIONS
  -r, --dmenu                Select the one of the below options from dmenu or rofi.
  -s, --screenshot           Take a screenshot. (default)
  -m, --video                Record a video of the screen.
  -g, --gif                  Record a video and convert it to the gif format.

CAPTURE OPTIONS
  -n, --nocursor             Hide the cursor.
  -d, --display NUM|TYPE     Set the selection to a specific display.
                             Can read from an argument or from stdin.
                             Values: number of display, 'active', 'all' (default)

VIDEO OPTIONS
  -c, --countdown NUM        Countdown before recording.

Installation

Arch Linux

Install gsu or gsu-git from the AUR.

Universal Install

gsu depends heavily on maim, slop, FFmpeg, curl, and jq for its functionality. To install gsu's dependencies, run the following commands in accordance to your distro.

Arch Linux

$ sudo pacman -S maim slop ffmpeg curl jq xdotool

Debian 8

Be sure that the unstable repository is enabled on Debian, or your screenshots may not output properly. This is because Debian 8 has outdated versions of maim and slop.

$ sudo apt-get install maim slop ffmpeg curl jq xdotool

Ubuntu 17.04

Unsupported. slop and maim both are terribly out of date in Ubuntu's 17.04 repositories, resulting in artifacting and improper screenshots. When Ubuntu 17.10 is released, it will be properly supported.

If you can't wait until then, you can install slop and maim from source. Afterwards, run the following command to install the remaining dependencies.

$ sudo apt-get install ffmpeg curl jq xdotool

Other Linux or BSD

Install maim, slop, ffmpeg, curl, jq, and xdotool using your package manager of choice. You could also install each package from source, but who has time for that?

---

After installing the dependents, run the following commands to install gsu.

$ curl -o gsu.tar.gz https://codeload.github.com/winneon/gsu/tar.gz/1.3.1
$ tar xvf gsu.tar.gz && cd gsu-1.3.1
$ sudo make install

You can optionally install xsel if you want automatic URL clipboard pasting after the utility finishes an upload.

Configuration

Run the utility at least once, i.e. gsu --help. The configuration file will be generated in $XDG_CONFIG_HOME/gsu if it didn't already exist. The most common location is ~/.config/gsu.

Troubleshooting

Here are some frequent problems users may face and their respective solutions. If you have more solutions, feel free to send in an issue or pull request.

The outputted screenshot has weird black or white sections.

This is a common problem with older versions of maim. You have a few choices:

• On Debian 8, enable the unstable APT repository, and upgrade maim and slop.
• On Ubuntu 17.04 and other distros, install both maim and slop from source.

There is no audio in the captured video.

Pulseaudio is the default audio capture device. If you do not use pulseaudio, adjust your audio capture device in the configuration file.

If you do use pulseaudio, use a program like pavucontrol to change the input device to a monitor of your audio output device. If you use pavucontrol, the resulting setup should look similar to below.

Credits

• Dalton Nell for maim and slop, used for screenshot creation and selections
• The FFmpeg team for ffmpeg, used for video and gif creation
• Daniel Stenberg for curl, used for uploading
• Stephen Dolan for jq, used for parsing JSON