summaryrefslogtreecommitdiffstats
path: root/DOCS/man/console.rst
blob: 89726b72a68b2daa89b5dfa842adf6bf4f0e7d34 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
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
    Run the typed command.

Shift+ENTER
    Type a literal newline character.

Ctrl+LEFT and Ctrl+RIGHT
    Move cursor to previous/next word.

UP and DOWN
    Navigate command history.

PGUP
    Go to the first command in the history.

PGDN
    Stop navigating command history.

INSERT
    Toggle insert mode.

Shift+INSERT
    Paste text (uses the primary selection on X11.)

TAB
    Complete the command or property name at the cursor.

Ctrl+C
    Clear current line.

Ctrl+K.
    Delete text from the cursor to the end of the line.

Ctrl+L
    Clear all log messages from the console.

Ctrl+U
    Delete text from the cursor to the beginning of the line.

Ctrl+V
    Paste text (uses the clipboard on X11.)

Ctrl+W
    Delete text from the cursor to the beginning of the current word.

Commands
--------

``script-message-to console type <text>``
    Show the console and pre-fill it with the provided text.

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. Change it if you have a high-DPI display.

``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."