summaryrefslogtreecommitdiffstats
path: root/DOCS/man
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2020-01-07 23:08:45 +0100
committerwm4 <wm4@nowhere>2020-01-07 23:08:45 +0100
commitd3cef97ad38fb027262a905bd82e1d3d2549aec7 (patch)
tree200c7c376af503ee826a50a8b812d1f0aceb316a /DOCS/man
parent5b56be0e91a78565d51e69ef0df625f52c140820 (diff)
downloadmpv-d3cef97ad38fb027262a905bd82e1d3d2549aec7.tar.bz2
mpv-d3cef97ad38fb027262a905bd82e1d3d2549aec7.tar.xz
options: change option parsing when using a single dash
Addresses dumb things like accidentally overwriting a media file with e.g. "mpv --log-file test.mkv" (when the user thought that --log-file was a flag option, when it actually takes a filename). This example will now print an error. It still works with "-log-file overwritten.mkv", but prints a warning. Not sure if I'm being too careful or not "radical" enough. In any case, both the syntax that stops working and the syntax that produces a warning now have been discouraged and were called legacy for almost a decade.
Diffstat (limited to 'DOCS/man')
-rw-r--r--DOCS/man/mpv.rst14
1 files changed, 10 insertions, 4 deletions
diff --git a/DOCS/man/mpv.rst b/DOCS/man/mpv.rst
index a014388877..676cd1897f 100644
--- a/DOCS/man/mpv.rst
+++ b/DOCS/man/mpv.rst
@@ -314,7 +314,7 @@ Legacy option syntax
--------------------
The ``--option=value`` syntax is not strictly enforced, and the alternative
-legacy syntax ``-option value`` and ``--option value`` will also work. This is
+legacy syntax ``-option value`` and ``-option=value`` will also work. This is
mostly for compatibility with MPlayer. Using these should be avoided. Their
semantics can change any time in the future.
@@ -324,9 +324,15 @@ because ``--fs`` is a flag option that requires no parameter. If an option
changes and its parameter becomes optional, then a command line using the
alternative syntax will break.
-Currently, the parser makes no difference whether an option starts with ``--``
-or a single ``-``. This might also change in the future, and ``--option value``
-might always interpret ``value`` as filename in order to reduce ambiguities.
+Until mpv 0.31.0, there was no difference whether an option started with ``--``
+or a single ``-``. Newer mpv releases strictly expect that you pass the option
+value after a ``=``. For example, before ``mpv --log-file f.txt`` would write
+a log to ``f.txt``, but now this command line fails, as ``--log-file`` expects
+an option value, and ``f.txt`` is simply considered a normal file to be played
+(as in ``mpv f.txt``).
+
+The future plan is that ``-option value`` will not work anymore, and options
+with a single ``-`` behave the same as ``--`` options.
Escaping spaces and other special characters
--------------------------------------------