[FFmpeg-devel] [PATCH] doc/ffmpeg mention both ffpreset/avpreset in documentation, remove superfluous example

Werner Robitza werner.robitza at gmail.com
Thu Jan 1 22:08:34 CET 2015

ffmpeg looks for both .ffpreset and .avpreset files in addition to

Added a paragraph explaining that both are included for compatibility

Removed a superfluous section from "Examples" (7.1) which mentioned
AVCONV_DATADIR and .avpreset. It was not an example, really, and was
confusing, since it did not mention FFMPEG_DATADIR (which on the other
hand is mentioned a few sections above under "Presets").

Now everything is mentioned under "Presets".

Signed-off-by: Werner Robitza <werner.robitza at gmail.com>
 doc/ffmpeg.texi | 20 +++++---------------
 1 file changed, 5 insertions(+), 15 deletions(-)

diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index 6de5004..4498c5f 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -1239,6 +1239,11 @@ directories, where @var{codec_name} is the name of the codec to which
 the preset file options will be applied. For example, if you select
 the video codec with @code{-vcodec libvpx} and use @code{-vpre 1080p},
 then it will search for the file @file{libvpx-1080p.ffpreset}.
+If no preset is found in the above locations, ffmpeg will also look in
+ at file{$AVCONV_DATADIR}, @file{$HOME/.avconv} and for files with an
+ at file{.avpreset} suffix in the datadir defined at configuration time.
 @c man end OPTIONS
 @chapter Tips
@@ -1285,21 +1290,6 @@ quality).
 @chapter Examples
 @c man begin EXAMPLES
- at section Preset files
-A preset file contains a sequence of @var{option=value} pairs, one for
-each line, specifying a sequence of options which can be specified also on
-the command line. Lines starting with the hash ('#') character are ignored and
-are used to provide comments. Empty lines are also ignored. Check the
- at file{presets} directory in the FFmpeg source tree for examples.
-Preset files are specified with the @code{pre} option, this option takes a
-preset name as input.  FFmpeg searches for a file named @var{preset_name}.avpreset in
-the directories @file{$AVCONV_DATADIR} (if set), and @file{$HOME/.ffmpeg}, and in
-the data directory defined at configuration time (usually @file{$PREFIX/share/ffmpeg})
-in that order.  For example, if the argument is @code{libx264-max}, it will
-search for the file @file{libx264-max.avpreset}.
 @section Video and Audio grabbing
 If you specify the input format and device then ffmpeg can grab video
1.9.3 (Apple Git-50)

More information about the ffmpeg-devel mailing list