summaryrefslogtreecommitdiffstats
path: root/DOCS/man/console.rst
diff options
context:
space:
mode:
Diffstat (limited to 'DOCS/man/console.rst')
-rw-r--r--DOCS/man/console.rst145
1 files changed, 145 insertions, 0 deletions
diff --git a/DOCS/man/console.rst b/DOCS/man/console.rst
new file mode 100644
index 0000000000..f883a14c2b
--- /dev/null
+++ b/DOCS/man/console.rst
@@ -0,0 +1,145 @@
+CONSOLE
+=======
+
+The console is a REPL for mpv input commands. It is displayed on the video
+window. It also shows log messages. It can be disabled entirely using the
+``--load-osd-console=no`` option.
+
+Keybindings
+-----------
+
+\`
+ Show the console.
+
+ESC
+ Hide the console.
+
+ENTER, Ctrl+J and Ctrl+M
+ Run the typed command.
+
+Shift+ENTER
+ Type a literal newline character.
+
+LEFT and Ctrl+B
+ Move the cursor to the previous character.
+
+RIGHT and Ctrl+F
+ Move the cursor to the next character.
+
+Ctrl+LEFT and Alt+B
+ Move the cursor to the beginning of the current word, or if between words,
+ to the beginning of the previous word.
+
+Ctrl+RIGHT and Alt+F
+ Move the cursor to the end of the current word, or if between words, to the
+ end of the next word.
+
+HOME and Ctrl+A
+ Move the cursor to the start of the current line.
+
+END and Ctrl+E
+ Move the cursor to the end of the current line.
+
+BACKSPACE and Ctrl+H
+ Delete the previous character.
+
+Ctrl+D
+ Hide the console if the current line is empty, otherwise delete the next
+ character.
+
+Ctrl+BACKSPACE and Ctrl+W
+ Delete text from the cursor to the beginning of the current word, or if
+ between words, to the beginning of the previous word.
+
+Ctrl+DEL and Alt+D
+ Delete text from the cursor to the end of the current word, or if between
+ words, to the end of the next word.
+
+Ctrl+U
+ Delete text from the cursor to the beginning of the current line.
+
+Ctrl+K
+ Delete text from the cursor to the end of the current line.
+
+Ctrl+C
+ Clear the current line.
+
+UP and Ctrl+P
+ Move back in the command history.
+
+DOWN and Ctrl+N
+ Move forward in the command history.
+
+PGUP
+ Go to the first command in the history.
+
+PGDN
+ Stop navigating the command history.
+
+INSERT
+ Toggle insert mode.
+
+Ctrl+V
+ Paste text (uses the clipboard on X11 and Wayland).
+
+Shift+INSERT
+ Paste text (uses the primary selection on X11 and Wayland).
+
+TAB and Ctrl+I
+ Complete the command or property name at the cursor.
+
+Ctrl+L
+ Clear all log messages from the console.
+
+Commands
+--------
+
+``script-message-to console type <text> [<cursor_pos>]``
+ Show the console and pre-fill it with the provided text, optionally
+ specifying the initial cursor position as a positive integer starting from
+ 1.
+
+ .. admonition:: Example for input.conf
+
+ ``% script-message-to console type "seek absolute-percent" 6``
+
+Known issues
+------------
+
+- Pasting text is slow on Windows
+- Non-ASCII keyboard input has restrictions
+- The cursor keys move between Unicode code-points, not grapheme clusters
+
+Configuration
+-------------
+
+This script can be customized through a config file ``script-opts/console.conf``
+placed in mpv's user directory and through the ``--script-opts`` command-line
+option. The configuration syntax is described in `ON SCREEN CONTROLLER`_.
+
+Key bindings can be changed in a standard way, see for example stats.lua
+documentation.
+
+Configurable Options
+~~~~~~~~~~~~~~~~~~~~
+
+``scale``
+ Default: 1
+
+ All drawing is scaled by this value, including the text borders and the
+ cursor.
+
+ If the VO backend in use has HiDPI scale reporting implemented, the option
+ value is scaled with the reported HiDPI scale.
+
+``font``
+ Default: unset (picks a hardcoded font depending on detected platform)
+
+ Set the font used for the REPL and the console. This probably doesn't
+ have to be a monospaced font.
+
+``font_size``
+ Default: 16
+
+ Set the font size used for the REPL and the console. This will be
+ multiplied by "scale."