Git Inbox Mirror of the ffmpeg-devel mailing list - see https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
 help / color / mirror / Atom feed
From: Stefano Sabatini <stefasab@gmail.com>
To: FFmpeg development discussions and patches <ffmpeg-devel@ffmpeg.org>
Cc: Stefano Sabatini <stefasab@gmail.com>
Subject: [FFmpeg-devel] [PATCH] doc/ffmpeg: slightly rework introductory examples
Date: Mon, 27 Mar 2023 02:22:53 +0200
Message-ID: <20230327002253.96051-1-stefasab@gmail.com> (raw)

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

Address issue:
http://trac.ffmpeg.org/ticket/8730
---
 doc/ffmpeg.texi | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index adfc2726ff..68a6bc6e22 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -49,22 +49,30 @@ 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:
+@example
+ffmpeg -i input.avi output.avi
+@end example
+
+@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
 @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
 @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
 @end example
-- 
2.25.1

_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".

             reply	other threads:[~2023-03-27  0:23 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-27  0:22 Stefano Sabatini [this message]
2023-03-27  5:29 ` Gyan Doshi
2023-03-28 23:22   ` Stefano Sabatini
2023-03-30  8:37     ` Anton Khirnov
2023-04-02 15:15       ` Stefano Sabatini

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230327002253.96051-1-stefasab@gmail.com \
    --to=stefasab@gmail.com \
    --cc=ffmpeg-devel@ffmpeg.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Git Inbox Mirror of the ffmpeg-devel mailing list - see https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://master.gitmailbox.com/ffmpegdev/0 ffmpegdev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 ffmpegdev ffmpegdev/ https://master.gitmailbox.com/ffmpegdev \
		ffmpegdev@gitmailbox.com
	public-inbox-index ffmpegdev

Example config snippet for mirrors.


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git