From 3db8715f70bb5406ae00fb97c30d7dbc6c733a31 Mon Sep 17 00:00:00 2001
From: wm4 <wm4@nowhere>
Date: Wed, 19 Feb 2020 23:11:02 +0100
Subject: [PATCH] manpage: minor fixes
In particular, all_formats description split away the example section of
an unrelated option, so move that to its proper place.
---
DOCS/man/ipc.rst | 2 +-
DOCS/man/options.rst | 20 ++++++++++----------
2 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/DOCS/man/ipc.rst b/DOCS/man/ipc.rst
index 42e67f6e4a..2919dd3dff 100644
--- a/DOCS/man/ipc.rst
+++ b/DOCS/man/ipc.rst
@@ -315,7 +315,7 @@ When executed, a socket (the IPC connection) is passed to them through file
descriptor inheritance. The file descriptor is indicated as the special command
line argument ``--mpv-ipc-fd=N``, where ``N`` is the numeric file descriptor.
Currently, this is hardcoded as ``--mpv-ipc-fd=3``, and the intention is that
-it will always be ``3``. (This was a promise between keeping it as simple as
+it will always be ``3``. (This was a compromise between keeping it as simple as
possible, and not doing too much implicitly. Also, since there is a chance that
this will change anyway, you should at least validate that you got the expected
argument.)
diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst
index 6ef710137f..6720b34831 100644
--- a/DOCS/man/options.rst
+++ b/DOCS/man/options.rst
@@ -823,6 +823,16 @@ Program Behavior
should use ``%`` before any of the characters ``^$()%|,.[]*+-?`` to match
that character.
+ .. admonition:: Examples
+
+ - ``--script-opts=ytdl_hook-exclude='^youtube%.com'``
+ will exclude any URL that starts with ``http://youtube.com`` or
+ ``https://youtube.com``.
+ - ``--script-opts=ytdl_hook-exclude='%.mkv$|%.mp4$'``
+ will exclude any URL that ends with ``.mkv`` or ``.mp4``.
+
+ See more lua patterns here: https://www.lua.org/manual/5.1/manual.html#5.4.1
+
The ``all_formats`` script option accepts a boolean 'yes' or 'no',
and if 'yes' will attempt to add all formats found reported by youtube-dl
(default: no). Each format is added as a separate track. In addition, they
@@ -836,16 +846,6 @@ Program Behavior
purpose for various technical reasons. In general, this option is not
useful, and was only added to show that it's possible.
- .. admonition:: Examples
-
- - ``--script-opts=ytdl_hook-exclude='^youtube%.com'``
- will exclude any URL that starts with ``http://youtube.com`` or
- ``https://youtube.com``.
- - ``--script-opts=ytdl_hook-exclude='%.mkv$|%.mp4$'``
- will exclude any URL that ends with ``.mkv`` or ``.mp4``.
-
- See more lua patterns here: https://www.lua.org/manual/5.1/manual.html#5.4.1
-
The ``use_manifests`` script option makes mpv use the master manifest URL for
formats like HLS and DASH, if available, allowing for video/audio selection
in runtime. It's disabled ("no") by default for performance reasons.