[FFmpeg-devel] [PATCH] doc/ffmpeg: document keyboard interaction capabilities of ffmpeg

[Ganesh Ajjanagadde]

Mostly based off the help text; slightly modified in some cases for
better clarity and correctness (based off code inspection).

Signed-off-by: Ganesh Ajjanagadde <gajjanagadde at gmail.com>
---
 doc/ffmpeg.texi | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)

diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index a38a32e..7ae6773 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -428,6 +428,7 @@ the encoding process. It is made of "@var{key}=@var{value}" lines. @var{key}
 consists of only alphanumeric characters. The last key of a sequence of
 progress information is always "progress".
 
+ at anchor{stdin interaction}
 @item -stdin
 Enable interaction on standard input. On by default unless standard input is
 used as an input. To explicitly disable interaction you need to specify
@@ -1295,6 +1296,46 @@ ffmpeg -i input.ts -filter_complex \
 (0x2d0, 0x2dc and 0x2ef are the MPEG-TS PIDs of respectively the video,
 audio and subtitles streams; 0:0, 0:3 and 0:7 would have worked too)
 
+ at section Keyboard interaction
+
+When stdin interaction is enabled (default), the following keyboard input is
+recognized. For more information regarding stdin interaction, see
+ at ref{stdin interaction,,the stdin and nostdin options of this manual}.
+
+ at table @key
+
+ at item q
+Quit.
+
+ at item +
+Increase log verbosity.
+
+ at item -
+Decrease log verbosity.
+
+ at item s
+Toggle QP histogram display.
+
+ at item h
+Dump packets/hex; press to cycle through the 3 states.
+
+ at item c
+Prompt for and send command to first matching filter supporting it.
+
+ at item C
+Prompt for and send command to all matching filters supporting it.
+
+ at item d
+Accept subsequent entry up to carriage return as debug mode.
+
+ at item D
+Cycle through available debug modes.
+
+ at item ?
+Display help regarding keyboard interaction.
+
+ at end table
+
 @section Preset files
 A preset file contains a sequence of @var{option}=@var{value} pairs,
 one for each line, specifying a sequence of options which would be
-- 
2.7.0