From d3e3bd43074ddd8f4c8829a7454b9f855454f462 Mon Sep 17 00:00:00 2001 From: wm4 Date: Wed, 18 Dec 2019 05:11:57 +0100 Subject: options: increase consistency between list options and document them Whenever I deal with this, I have to look at the code to make sense of this. And beyond that, there are some strange inconsistencies. (I think this code is cursed. It always was, and maybe always will be.) Although the manpage claimed that using multiple items for -add etc. is deprecated, string list options didn't warn against it. So add the warning, and add something in the changelog (even though nobody will ever read this). The manpage mentioned --vf-append, but this didn't even exist. So add it, I guess. We encourage using -append for the other option types, so for consistency, it should work on filter options. (And I already tricked me into believing it existed when I mentioned it in the manpage.) Make the "operations" table separate for all option types, and mention the option type on every single of the top-level list options. --- DOCS/man/encode.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) (limited to 'DOCS/man/encode.rst') diff --git a/DOCS/man/encode.rst b/DOCS/man/encode.rst index 4c885ea168..e897a342cf 100644 --- a/DOCS/man/encode.rst +++ b/DOCS/man/encode.rst @@ -15,8 +15,7 @@ You can encode files from one format/codec to another using this facility. Specifies the output format options for libavformat. See ``--ofopts=help`` for a full list of supported options. - Options are managed in lists. There are a few commands to manage the - options list. + This is a key/value list option. See `List Options`_ for details. ``--ofopts-add=`` Appends the options given as arguments to the options list. @@ -41,8 +40,7 @@ You can encode files from one format/codec to another using this facility. "``--oac=libmp3lame --oacopts=b=128000``" selects 128 kbps MP3 encoding. - Options are managed in lists. There are a few commands to manage the - options list. + This is a key/value list option. See `List Options`_ for details. ``--oacopts-add=`` Appends the options given as arguments to the options list. @@ -74,8 +72,7 @@ You can encode files from one format/codec to another using this facility. ``"--ovc=libx264 --ovcopts=crf=23"`` selects VBR quality factor 23 for H.264 encoding. - Options are managed in lists. There are a few commands to manage the - options list. + This is a key/value list option. See `List Options`_ for details. ``--ovcopts-add=`` Appends the options given as arguments to the options list. @@ -103,6 +100,8 @@ You can encode files from one format/codec to another using this facility. FLAC allow almost arbitrary keys, while support in MP4 and MP3 is more limited. + This is a key/value list option. See `List Options`_ for details. + .. admonition:: Example "``--oset-metadata=title="Output title",comment="Another tag"``" @@ -112,6 +111,8 @@ You can encode files from one format/codec to another using this facility. Specifies metadata to exclude from the output file when copying from the input file. + This is a string list option. See `List Options`_ for details. + .. admonition:: Example "``--oremove-metadata=comment,genre``" -- cgit v1.2.3