[FFmpeg-devel] [PATCH] doc/encoders: extend documentation for the x264opts and x264-params options

[Stefano Sabatini]

---
 doc/encoders.texi | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

diff --git a/doc/encoders.texi b/doc/encoders.texi
index e603f6c..1fddf17 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -1182,25 +1182,35 @@ Constant bit rate (not allowed in MP4 container).
 Set any x264 option, see @command{x264 --fullhelp} for a list.
 
 Argument is a list of @var{key}=@var{value} couples separated by
-":". In @var{filter} and @var{psy-rd} options that use ":" as a separator
+":". In case the option value is omitted, it is assumed 1 by default.
+
+In @option{deblock} and @option{psy-rd} options that use ":" as a separator
 themselves, use "," instead. They accept it as well since long ago but this
 is kept undocumented for some reason.
 
 For example to specify libx264 encoding options with @command{ffmpeg}:
 @example
-ffmpeg -i foo.mpg -vcodec libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
+ffmpeg -i foo.mpg -codec:v libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
 @end example
 
 @item x264-params
-Override the x264 configuration using a :-separated list of key=value parameters.
+Override the x264 configuration using a :-separated list of
+ at var{key}=@var{value} parameters. Keys and values can be escaped
+assuming the rules defined in the ``Quoting and escaping'' section of
+the ffmpeg-utils manual. For example the value may contain the special
+":" character as it happens in the @option{deblock} and @option{psy-rd}
+options.
 
 For example to specify libx264 encoding options with @command{ffmpeg}:
 @example
-ffmpeg -x264-params level=30:bframes=0:weightp=0:cabac=0:ref=1:vbv-maxrate=768:\
-vbv-bufsize=2000:analyse=all:me=umh:no-fast-pskip=1:subq=6:8x8dct=0:trellis=0
+ffmpeg -i ... -x264-params level=30:bframes=0:weightp=0:cabac=0:ref=1:vbv-maxrate=768:\
+vbv-bufsize=2000:analyse=all:me=umh:no-fast-pskip=1:subq=6:8x8dct=0:trellis=0 ...
 @end example
 @end table
 
+The @option{x264opts} and @option{x264-params} options are mostly
+equivalent but support a slightly different syntax.
+
 Encoding ffpresets for common usages are provided so they can be used with the
 general presets system (e.g. passing the @option{pre} option).
 
-- 
1.8.1.2