Add 'dm-recording/README.md'

This commit is contained in:
dominic 2019-11-05 21:36:52 +00:00
parent 8e3d087d08
commit 6a96bd6279

13
dm-recording/README.md Normal file
View File

@ -0,0 +1,13 @@
# dm-recording
dm-recording is a dmenu controlled utility that manages screen recordings using `ffmpeg`s `x11grab` mode.
## What it does
You can either select Fullscreen or Region mode. Fullscreen mode records the entire default X display, Region mode lets the user click on a window or drag a region to be recorded. A notification brief (900ms) notification is displayed after which (100ms later) the recording is started. Unless in fullscreen mode, a frame is drawn around the recorded region.
## Usage
Run `dm-recording`. Everything else is managed and communicated by `dmenu` and `notify-send`.
In order to stop the recording, kill the corresponding process. While not the prettiest solution, `killall ffmpeg` works for non-nested recordings.
## Requirements
You need to have `dmenu`, `ffmpeg` and `libxcb` (for ffmpeg) installed in order to run dm-recording. It is recommended to have a notification server setup that allows communication via `notify-send`.