diff options
Diffstat (limited to 'DOCS/man/console.rst')
-rw-r--r-- | DOCS/man/console.rst | 128 |
1 files changed, 99 insertions, 29 deletions
diff --git a/DOCS/man/console.rst b/DOCS/man/console.rst index 3c83d7e877..69cc103c15 100644 --- a/DOCS/man/console.rst +++ b/DOCS/man/console.rst @@ -11,59 +11,105 @@ Keybindings \` Show the console. -ESC +ESC and Ctrl+[ Hide the console. -ENTER +ENTER, Ctrl+j and Ctrl+m Run the typed command. Shift+ENTER Type a literal newline character. -Ctrl+LEFT and Ctrl+RIGHT - Move cursor to previous/next word. +LEFT and Ctrl+b + Move the cursor to the previous character. -UP and DOWN - Navigate command history. +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 command history. + Stop navigating the command history. INSERT Toggle insert mode. -Shift+INSERT - Paste text (uses the primary selection on X11.) +Ctrl+v + Paste text (uses the clipboard on X11 and Wayland). -TAB - Complete the command or property name at the cursor. +Shift+INSERT + Paste text (uses the primary selection on X11 and Wayland). -Ctrl+C - Clear current line. +TAB and Ctrl+i + Complete the text at the cursor. The first press inserts the longest common + prefix of the completions, and subsequent presses cycle through them. -Ctrl+K. - Delete text from the cursor to the end of the line. +Shift+TAB + Cycle through the completions backwards. -Ctrl+L +Ctrl+l Clear all log messages from the console. -Ctrl+U - Delete text from the cursor to the beginning of the line. +Commands +-------- -Ctrl+V - Paste text (uses the clipboard on X11.) +``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. -Ctrl+W - Delete text from the cursor to the beginning of the current word. + .. admonition:: Examples for input.conf -Commands --------- + ``% script-message-to console type "seek absolute-percent; keypress ESC" 6`` + Enter a percent position to seek to and close the console. -``script-message-to console type <text>`` - Show the console and pre-fill it with the provided text. + ``Ctrl+o script-message-to console type "loadfile ''; keypress ESC" 11`` + Enter a file or URL to play. Tab completes paths in the filesystem. Known issues ------------ @@ -77,7 +123,7 @@ 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`_. +option. The configuration syntax is described in `mp.options functions`_. Key bindings can be changed in a standard way, see for example stats.lua documentation. @@ -97,11 +143,35 @@ Configurable Options ``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. + Set the font used for the REPL and the console. + This has to be a monospaced font for the completion suggestions to be + aligned correctly. ``font_size`` Default: 16 Set the font size used for the REPL and the console. This will be + multiplied by "scale". + +``border_size`` + Default: 1 + + Set the font border size used for the REPL and the console. + +``case_sensitive`` + Default: no on Windows, yes on other platforms. + + Whether Tab completion is case sensitive. Only works with ASCII characters. + +``history_dedup`` + Default: true + + Remove duplicate entries in history as to only keep the latest one. multiplied by "scale." + +``font_hw_ratio`` + Default: auto + + The ratio of font height to font width. + Adjusts table width of completion suggestions. + Values in the range 1.8..2.5 make sense for common monospace fonts. |