summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKevin Mitchell <kevmitch@gmail.com>2014-10-03 02:18:48 -0700
committerAlessandro Ghedini <alessandro@ghedini.me>2014-10-11 13:56:06 +0200
commitf842b3f2b2a0b7751d466a7b2ed096ae555dcaf2 (patch)
treeab3fa103bb5b8e44f0a088e240691422dd693ccc
parente4f6235a47b7328f9931a0290ce811f1494c9867 (diff)
downloadmpv-f842b3f2b2a0b7751d466a7b2ed096ae555dcaf2.tar.bz2
mpv-f842b3f2b2a0b7751d466a7b2ed096ae555dcaf2.tar.xz
manpage: improve consistency with new ~/.config/mpv default
Signed-off-by: wm4 <wm4@nowhere>
-rw-r--r--DOCS/man/input.rst5
-rw-r--r--DOCS/man/lua.rst24
-rw-r--r--DOCS/man/mpv.rst6
-rw-r--r--DOCS/man/options.rst24
4 files changed, 32 insertions, 27 deletions
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index f83e72703c..4e044c7c90 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -11,8 +11,9 @@ value (upper case if combined with ``Shift``), or a name for special keys. For
example, ``a`` maps to the ``a`` key without shift, and ``A`` maps to ``a``
with shift.
-The file is normally located in ``~/.config/mpv/input.conf`` (some platforms
-may use different paths). The default bindings are defined here::
+The file is located in the mpv configuration directory (normally at
+``~/.config/mpv/input.conf`` depending on platform). The default bindings are
+defined here::
https://github.com/mpv-player/mpv/blob/master/etc/input.conf
diff --git a/DOCS/man/lua.rst b/DOCS/man/lua.rst
index 3b11085503..1c4605eacd 100644
--- a/DOCS/man/lua.rst
+++ b/DOCS/man/lua.rst
@@ -1,11 +1,12 @@
LUA SCRIPTING
=============
-mpv can load Lua scripts. Scripts in ``~/.mpv/lua/`` will be loaded on program
-start, or if passed to ``--lua``. mpv appends ``~/.mpv/lua`` to the end of
-lua's path so you can import them too. Since it's added to the end, don't name
-scripts you want to import the same as lua libraries because they will be
-overshadowed by them.
+mpv can load Lua scripts. Scripts passed to the ``--lua`` option, or found in
+the ``lua`` subdirectory of the mpv configuration directory (usually
+``~/.config/mpv/lua/``) will be loaded on program start. mpv also appends the
+``lua`` subdirectory to the end of Lua's path so you can import scripts from
+there too. Since it's added to the end, don't name scripts you want to import
+the same as Lua libraries because they will be overshadowed by them.
mpv provides the built-in module ``mp``, which provides functions to send
commands to the mpv core and to retrieve information about playback state, user
@@ -32,12 +33,13 @@ allow users implement features which are not going to be added to the mpv core.
Mode of operation
-----------------
-Your script will be loaded by the player at program start from ``~/.mpv/lua/``,
-or ``--lua``, or in some cases, internally (like ``--osc``). Each script runs
-in its own thread. Your script is first run "as is", and once that is done,
-the event loop is entered. This event loop will dispatch events received by mpv
-and call your own event handlers which you have registered with
-``mp.register_event``, or timers added with ``mp.add_timeout`` or similar.
+Your script will be loaded by the player at program start from the ``lua``
+configuration subdirectory, from a path specified with the ``--lua`` option, or
+in some cases, internally (like ``--osc``). Each script runs in its own
+thread. Your script is first run "as is", and once that is done, the event loop
+is entered. This event loop will dispatch events received by mpv and call your
+own event handlers which you have registered with ``mp.register_event``, or
+timers added with ``mp.add_timeout`` or similar.
When the player quits, all scripts will be asked to terminate. This happens via
a ``shutdown`` event, which by default will make the event loop return. If your
diff --git a/DOCS/man/mpv.rst b/DOCS/man/mpv.rst
index 16c2a89308..f4069fedce 100644
--- a/DOCS/man/mpv.rst
+++ b/DOCS/man/mpv.rst
@@ -265,7 +265,7 @@ need to escape special characters. To work this around, the path can be
additionally wrapped in the ``%n%string_of_length_n`` syntax (see above).
Some mpv options interpret paths starting with ``~``. Currently, the prefix
-``~~/`` expands to the mpv configuration directory (usually ``~/.mpv/``).
+``~~/`` expands to the mpv configuration directory (usually ``~/.config/mpv/``).
``~/`` expands to the user's home directory. (The trailing ``/`` is always
required.)
@@ -355,11 +355,11 @@ File-specific Configuration Files
You can also write file-specific configuration files. If you wish to have a
configuration file for a file called 'video.avi', create a file named
'video.avi.conf' with the file-specific options in it and put it in
-``~/.mpv/``. You can also put the configuration file in the same directory
+``~/.config/mpv/``. You can also put the configuration file in the same directory
as the file to be played, as long as you give the ``--use-filedir-conf``
option (either on the command line or in your global config file). If a
file-specific configuration file is found in the same directory, no
-file-specific configuration is loaded from ``~/.mpv``. In addition, the
+file-specific configuration is loaded from ``~/.config/mpv``. In addition, the
``--use-filedir-conf`` option enables directory-specific configuration files.
For this, mpv first tries to load a mpv.conf from the same directory
as the file played and then tries to load any file-specific configuration.
diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst
index e8e41331d6..64dc4bc2c8 100644
--- a/DOCS/man/options.rst
+++ b/DOCS/man/options.rst
@@ -255,9 +255,8 @@ Program Behavior
Print version string and exit.
``--no-config``
- Do not load default configuration files. This prevents loading of
- ``~/.config/mpv/mpv.conf`` and ``~/.config/mpv/input.conf``, as well as
- loading the same files from system wide configuration directories. Other
+ Do not load default configuration files. This prevents loading of both the
+ user-level and system-wide ``mpv.conf`` and ``input.conf`` files. Other
configuration files are blocked as well, such as resume playback files.
.. note::
@@ -313,7 +312,8 @@ Program Behavior
Specify configuration file to be parsed after the default ones.
``--load-scripts=<yes|no>``
- If set to ``no``, don't auto-load scripts from ``~/.mpv/lua/``.
+ If set to ``no``, don't auto-load scripts from the ``lua`` configuration
+ subdirectory (usually ``~/.config/mpv/lua/``).
(Default: ``yes``)
``--lua=<filename>``
@@ -335,7 +335,8 @@ Program Behavior
commands.
``--no-resume-playback``
- Do not restore playback position from ``~/.mpv/watch_later/``.
+ Do not restore playback position from the ``watch_later`` configuration
+ subdirectory (usually ``~/.config/mpv/watch_later/``).
See ``quit_watch_later`` input command.
``--profile=<profile1,profile2,...>``
@@ -1362,7 +1363,7 @@ Subtitles
- ``/path/to/video/sub/``
- ``/path/to/video/subtitles/``
- ``/tmp/subs/``
- - ``~/.mpv/sub/``
+ - the ``sub`` configuration subdirectory (usually ``~/.config/mpv/sub/``)
``--sub-visibility``, ``--no-sub-visibility``
Can be used to disable display of subtitles, but still select and decode
@@ -2081,8 +2082,8 @@ Input
Number of key presses to generate per second on autorepeat.
``--input-conf=<filename>``
- Specify input configuration file other than the default
- ``~/.config/mpv/input.conf``.
+ Specify input configuration file other than the default location in the mpv
+ configuration directory (usually ``~/.config/mpv/input.conf``).
``--no-input-default-bindings``
Disable mpv default (built-in) key bindings.
@@ -2963,9 +2964,10 @@ DVB
Specifies using card number 1-4 (default: 1).
``--dvbin-file=<filename>``
- Instructs mpv to read the channels list from ``<filename>``. Default is
- ``~/.mpv/channels.conf.{sat,ter,cbl,atsc}`` (based on your card type) or
- ``~/.mpv/channels.conf`` as a last resort.
+ Instructs mpv to read the channels list from ``<filename>``. The default is
+ in the mpv configuration directory (usually ``~/.config/mpv``) with the
+ filename ``channels.conf.{sat,ter,cbl,atsc}`` (based on your card type) or
+ ``channels.conf`` as a last resort.
``--dvbin-timeout=<1-30>``
Maximum number of seconds to wait when trying to tune a frequency before