[FFmpeg-cvslog] doc/ffmpeg: slightly rework introductory examples

Stefano Sabatini git at videolan.org
Sun Apr 2 17:30:36 EEST 2023


ffmpeg | branch: master | Stefano Sabatini <stefasab at gmail.com> | Mon Mar 27 02:22:28 2023 +0200| [627d5a87bbe0495cdde10be7da9d3fe3810a3dc7] | committer: Stefano Sabatini

doc/ffmpeg: slightly rework introductory examples

In particular, add a sentence to introduce the example, and add a
simpler starting example with no options.

Also use different format for input.avi and output.mp4, to convey
that the conversion also works on the container format.

Address issue:
http://trac.ffmpeg.org/ticket/8730

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=627d5a87bbe0495cdde10be7da9d3fe3810a3dc7
---

 doc/ffmpeg.texi | 22 +++++++++++++++-------
 1 file changed, 15 insertions(+), 7 deletions(-)

diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index adfc2726ff..630971d90b 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -49,24 +49,32 @@ Do not mix input and output files -- first specify all input files, then all
 output files. Also do not mix options which belong to different files. All
 options apply ONLY to the next input or output file and are reset between files.
 
+Some simple examples follow.
+
 @itemize
 @item
-To set the video bitrate of the output file to 64 kbit/s:
+Convert an input media file to a different format, by re-encoding media streams:
+ at example
+ffmpeg -i input.avi output.mp4
+ at end example
+
+ at item
+Set the video bitrate of the output file to 64 kbit/s:
 @example
-ffmpeg -i input.avi -b:v 64k -bufsize 64k output.avi
+ffmpeg -i input.avi -b:v 64k -bufsize 64k output.mp4
 @end example
 
 @item
-To force the frame rate of the output file to 24 fps:
+Force the frame rate of the output file to 24 fps:
 @example
-ffmpeg -i input.avi -r 24 output.avi
+ffmpeg -i input.avi -r 24 output.mp4
 @end example
 
 @item
-To force the frame rate of the input file (valid for raw formats only)
-to 1 fps and the frame rate of the output file to 24 fps:
+Force the frame rate of the input file (valid for raw formats only) to 1 fps and
+the frame rate of the output file to 24 fps:
 @example
-ffmpeg -r 1 -i input.m2v -r 24 output.avi
+ffmpeg -r 1 -i input.m2v -r 24 output.mp4
 @end example
 @end itemize
 



More information about the ffmpeg-cvslog mailing list