From 6a96bd627919d41c048353fb6480f982bca67737 Mon Sep 17 00:00:00 2001 From: dominic Date: Tue, 5 Nov 2019 21:36:52 +0000 Subject: [PATCH] Add 'dm-recording/README.md' --- dm-recording/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 dm-recording/README.md diff --git a/dm-recording/README.md b/dm-recording/README.md new file mode 100644 index 0000000..446ab28 --- /dev/null +++ b/dm-recording/README.md @@ -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`. \ No newline at end of file