RepoMirrors/mpv
1
0
Fork 0
mirror of https://github.com/mpv-player/mpv synced 2024-12-18 12:55:16 +00:00
Code Issues Releases Wiki Activity
14d3a8ed28
mpv/DOCS/man/console.rst

171 lines
4.3 KiB
ReStructuredText
Raw Normal View History

console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-07 16:16:10 +00:00
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.
console.lua: exit with with Ctrl+[ This binding commonly closes similar input buffers like vim's Command-line mode and dmenu.
2023-10-10 06:33:08 +00:00
ESC and Ctrl+[
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-07 16:16:10 +00:00
Hide the console.
DOCS/console: correct capitalization of keybindings
2023-11-05 05:36:09 +00:00
ENTER, Ctrl+j and Ctrl+m
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-07 16:16:10 +00:00
Run the typed command.
Shift+ENTER
Type a literal newline character.
DOCS/console: correct capitalization of keybindings
2023-11-05 05:36:09 +00:00
LEFT and Ctrl+b
console.lua: define remaining emacs keybindings
2021-10-31 10:30:25 +00:00
Move the cursor to the previous character.
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-07 16:16:10 +00:00
DOCS/console: correct capitalization of keybindings
2023-11-05 05:36:09 +00:00
RIGHT and Ctrl+f
console.lua: define remaining emacs keybindings
2021-10-31 10:30:25 +00:00
Move the cursor to the next character.
DOCS/console: correct capitalization of keybindings
2023-11-05 05:36:09 +00:00
Ctrl+LEFT and Alt+b
console.lua: define remaining emacs keybindings
2021-10-31 10:30:25 +00:00
Move the cursor to the beginning of the current word, or if between words,
to the beginning of the previous word.
DOCS/console: correct capitalization of keybindings
2023-11-05 05:36:09 +00:00
Ctrl+RIGHT and Alt+f
console.lua: define remaining emacs keybindings
2021-10-31 10:30:25 +00:00
Move the cursor to the end of the current word, or if between words, to the
end of the next word.
DOCS/console: correct capitalization of keybindings
2023-11-05 05:36:09 +00:00
HOME and Ctrl+a
console.lua: define remaining emacs keybindings
2021-10-31 10:30:25 +00:00
Move the cursor to the start of the current line.
DOCS/console: correct capitalization of keybindings
2023-11-05 05:36:09 +00:00
END and Ctrl+e
console.lua: define remaining emacs keybindings
2021-10-31 10:30:25 +00:00
Move the cursor to the end of the current line.
DOCS/console: correct capitalization of keybindings
2023-11-05 05:36:09 +00:00
BACKSPACE and Ctrl+h
console.lua: define remaining emacs keybindings
2021-10-31 10:30:25 +00:00
Delete the previous character.
DOCS/console: correct capitalization of keybindings
2023-11-05 05:36:09 +00:00
Ctrl+d
console.lua: define remaining emacs keybindings
2021-10-31 10:30:25 +00:00
Hide the console if the current line is empty, otherwise delete the next
character.
DOCS/console: correct capitalization of keybindings
2023-11-05 05:36:09 +00:00
Ctrl+BACKSPACE and Ctrl+w
console.lua: define remaining emacs keybindings
2021-10-31 10:30:25 +00:00
Delete text from the cursor to the beginning of the current word, or if
between words, to the beginning of the previous word.
DOCS/console: correct capitalization of keybindings
2023-11-05 05:36:09 +00:00
Ctrl+DEL and Alt+d
console.lua: define remaining emacs keybindings
2021-10-31 10:30:25 +00:00
Delete text from the cursor to the end of the current word, or if between
words, to the end of the next word.
DOCS/console: correct capitalization of keybindings
2023-11-05 05:36:09 +00:00
Ctrl+u
console.lua: define remaining emacs keybindings
2021-10-31 10:30:25 +00:00
Delete text from the cursor to the beginning of the current line.
DOCS/console: correct capitalization of keybindings
2023-11-05 05:36:09 +00:00
Ctrl+k
console.lua: define remaining emacs keybindings
2021-10-31 10:30:25 +00:00
Delete text from the cursor to the end of the current line.
DOCS/console: correct capitalization of keybindings
2023-11-05 05:36:09 +00:00
Ctrl+c
console.lua: define remaining emacs keybindings
2021-10-31 10:30:25 +00:00
Clear the current line.
DOCS/console: correct capitalization of keybindings
2023-11-05 05:36:09 +00:00
UP and Ctrl+p
console.lua: define remaining emacs keybindings
2021-10-31 10:30:25 +00:00
Move back in the command history.
DOCS/console: correct capitalization of keybindings
2023-11-05 05:36:09 +00:00
DOWN and Ctrl+n
console.lua: define remaining emacs keybindings
2021-10-31 10:30:25 +00:00
Move forward in the command history.
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-07 16:16:10 +00:00
PGUP
Go to the first command in the history.
PGDN
console.lua: define remaining emacs keybindings
2021-10-31 10:30:25 +00:00
Stop navigating the command history.
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-07 16:16:10 +00:00
console.lua: implement history search
2024-08-14 16:18:48 +00:00
Ctrl+r
Search the command history.
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-07 16:16:10 +00:00
INSERT
Toggle insert mode.
DOCS/console: correct capitalization of keybindings
2023-11-05 05:36:09 +00:00
Ctrl+v
console.lua: define remaining emacs keybindings
2021-10-31 10:30:25 +00:00
Paste text (uses the clipboard on X11 and Wayland).
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-07 16:16:10 +00:00
Shift+INSERT
console: use wl-paste on Wayland
2020-12-14 19:18:55 +00:00
Paste text (uses the primary selection on X11 and Wayland).
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-07 16:16:10 +00:00
DOCS/console: correct capitalization of keybindings
2023-11-05 05:36:09 +00:00
TAB and Ctrl+i
console.lua: cycle through completions
2023-11-25 17:30:49 +00:00
Complete the text at the cursor. The first press inserts the longest common
prefix of the completions, and subsequent presses cycle through them.
Shift+TAB
Cycle through the completions backwards.
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-07 16:16:10 +00:00
DOCS/console: correct capitalization of keybindings
2023-11-05 05:36:09 +00:00
Ctrl+l
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-07 16:16:10 +00:00
Clear all log messages from the console.
Commands
--------
console: let type set the cursor position This allows keybindings such as: a script-message-to console type "seek :0 absolute" 6 % script-message-to console type "seek absolute-percent" 6 The cursor position 0 isn't allowed because it has the weird effect of filling the console with the text twice, leaving the cursor in the middle. Negative positions would put the cursor n characters before the end, and positions greater than the text's length at the end. They seem to work at first, but the console breaks when you move the cursor, so they aren't allowed. It seems that float values don't cause issues, but I'm using the argument's floor anyway to be safe. Using >= 1 instead of > 0 ignores values like 0.5.
2020-03-27 13:46:39 +00:00
``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.
DOCS/man/console: update type examples
2023-11-02 12:16:53 +00:00
.. admonition:: Examples for input.conf
console: let type set the cursor position This allows keybindings such as: a script-message-to console type "seek :0 absolute" 6 % script-message-to console type "seek absolute-percent" 6 The cursor position 0 isn't allowed because it has the weird effect of filling the console with the text twice, leaving the cursor in the middle. Negative positions would put the cursor n characters before the end, and positions greater than the text's length at the end. They seem to work at first, but the console breaks when you move the cursor, so they aren't allowed. It seems that float values don't cause issues, but I'm using the argument's floor anyway to be safe. Using >= 1 instead of > 0 ignores values like 0.5.
2020-03-27 13:46:39 +00:00
DOCS/man/console: update type examples
2023-11-02 12:16:53 +00:00
``% script-message-to console type "seek absolute-percent; keypress ESC" 6``
Enter a percent position to seek to and close the console.
``Ctrl+o script-message-to console type "loadfile ''; keypress ESC" 11``
Enter a file or URL to play. Tab completes paths in the filesystem.
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-07 16:16:10 +00:00
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
DOCS/man: refer to "mp.options functions" for script config docs Currently they refer to the OSC documentation. However, the "mp.options functions" already documents that, is more detailed, and does not contain false statements like "there may be no spaces around the ``=`` or anywhere else" (the primitive parser does not care about them, so starting a string option value with spaces is perfectly fine). Change them to refer to "mp.options functions" and remove the redundant section in the OSC documentation.
2024-04-20 14:16:53 +00:00
option. The configuration syntax is described in `mp.options functions`_.
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-07 16:16:10 +00:00
Key bindings can be changed in a standard way, see for example stats.lua
documentation.
Configurable Options
~~~~~~~~~~~~~~~~~~~~
``font``
Default: unset (picks a hardcoded font depending on detected platform)
console: show completion suggestions as table Completion suggestions are now nicely formatted into a table. Maximum width of the table is estimated based on OSD size and font size. This requires a new scaling factor option `font_hw_ratio`. A factor of 2.15 works great for me, but the default is 2.0 to avoid problems with other fonts. The space between columns is automatically adjusted to be between 2 and 8 spaces. It tries to use as few rows as possible.
2022-06-20 21:26:33 +00:00
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.
console.lua: add this script Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
2019-12-07 16:16:10 +00:00
``font_size``
Default: 16
Set the font size used for the REPL and the console. This will be
console.lua: remove the scale script-opt This is redundant because you can set font_size and border_size to have the same effect.
2024-06-27 10:22:31 +00:00
multiplied by ``display-hidpi-scale``.
console: add history deduplication Deduplicate history like the fish shell. So for example entering "cmd 1" then "cmd 2" then "cmd 3" then "cmd 1" would result in a history of [cmd 2][cmd 3][cmd 1] instead of [cmd 1][cmd 2][cmd 3][cmd 1] Adds a function `history_add` to replace directly adding to history. Adds an option `history_dedup` to activate the deduplication. Defaults to on.
2022-06-18 01:29:32 +00:00
console.lua: add a script-opt for the border size Because I find the console log easier to read with a thicker border.
2023-03-11 10:25:26 +00:00
``border_size``
Default: 1
Set the font border size used for the REPL and the console.
console.lua: implement case-insensitive completion This is useful for completing files and more rarely for profiles. It will also be useful to third-party scripts interacting with the console once the API to do it is merged.
2023-11-29 18:14:47 +00:00
``case_sensitive``
Default: no on Windows, yes on other platforms.
Whether Tab completion is case sensitive. Only works with ASCII characters.
console: add history deduplication Deduplicate history like the fish shell. So for example entering "cmd 1" then "cmd 2" then "cmd 3" then "cmd 1" would result in a history of [cmd 2][cmd 3][cmd 1] instead of [cmd 1][cmd 2][cmd 3][cmd 1] Adds a function `history_add` to replace directly adding to history. Adds an option `history_dedup` to activate the deduplication. Defaults to on.
2022-06-18 01:29:32 +00:00
``history_dedup``
Default: true
Remove duplicate entries in history as to only keep the latest one.
console: show completion suggestions as table Completion suggestions are now nicely formatted into a table. Maximum width of the table is estimated based on OSD size and font size. This requires a new scaling factor option `font_hw_ratio`. A factor of 2.15 works great for me, but the default is 2.0 to avoid problems with other fonts. The space between columns is automatically adjusted to be between 2 and 8 spaces. It tries to use as few rows as possible.
2022-06-20 21:26:33 +00:00
``font_hw_ratio``
console: automatically determine the font_hw_ratio A simplified version of the text width estimation code from uosc. An osd_overlay is created with compute_bounds=true for measuring the width of the lower case alphabet at what's estimated to be the largest font size possible without clipping. The lower case alphabet was chosen to get decent results for proportional fonts, even if they aren't officially supported.
2023-11-07 23:03:48 +00:00
Default: auto
console: show completion suggestions as table Completion suggestions are now nicely formatted into a table. Maximum width of the table is estimated based on OSD size and font size. This requires a new scaling factor option `font_hw_ratio`. A factor of 2.15 works great for me, but the default is 2.0 to avoid problems with other fonts. The space between columns is automatically adjusted to be between 2 and 8 spaces. It tries to use as few rows as possible.
2022-06-20 21:26:33 +00:00
The ratio of font height to font width.
Adjusts table width of completion suggestions.
console: automatically determine the font_hw_ratio A simplified version of the text width estimation code from uosc. An osd_overlay is created with compute_bounds=true for measuring the width of the lower case alphabet at what's estimated to be the largest font size possible without clipping. The lower case alphabet was chosen to get decent results for proportional fonts, even if they aren't officially supported.
2023-11-07 23:03:48 +00:00
Values in the range 1.8..2.5 make sense for common monospace fonts.
Reference in New Issue Copy Permalink