Commit Graph

301 Commits

Author SHA1 Message Date
Stefano Sabatini
cadbccb658 Put @ignore-d man page specific trailer at the end of the file.
This makes the ordering of the sections in the file more consistent
with that of the final man output.

Originally committed as revision 23443 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-06-03 19:07:13 +00:00
Stefano Sabatini
54b11f1743 Rename @chapter "Quick Start" to "Examples", for consistency with the
corresponding man page section.

Originally committed as revision 23410 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-06-01 14:08:46 +00:00
Stefano Sabatini
9f41ed5a7e Fix texi2pod.pl rendering of the Tips section by putting each @item
command on its own line, and create a corresponding "TIPS" man page
section.

Note that such section is not displayed, as currently only sections
with pre-defined names are rendered.

Originally committed as revision 23409 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-06-01 14:00:44 +00:00
Stefano Sabatini
12f8341ae8 Merge @chapter Introduction and @chapter Description into a single
section, and make the whole rendered in the man output.

Simplify layout, and make it more consistent with that of the other
man pages. Also I cannot see a good reason for keeping split the two
sections.

Originally committed as revision 23407 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-06-01 13:09:49 +00:00
Robert Krüger
2328e5a289 Allow setting the environment variable FFMPEG_DATADIR to locate preset files.
Patch by Robert Krüger <krueger signal7 de>.

Originally committed as revision 22923 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-04-20 17:37:06 +00:00
Jai Menon
c7512f6bb3 Fix a few typos/grammar nits from r22739.
Originally committed as revision 22747 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-03-31 14:15:01 +00:00
Michael Niedermayer
49553ec865 Better documentation of -vsync
Originally committed as revision 22739 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-03-31 00:41:31 +00:00
Carl Eugen Hoyos
35a3bd844e It is difficult nowadays to compile without swscale support.
Originally committed as revision 22592 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-03-18 00:24:26 +00:00
Reimar Döffinger
fc5607f862 Make -benchmark also print the maximum memory usage if possible.
Originally committed as revision 21973 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-02-22 22:21:58 +00:00
Stefano Sabatini
8b9da8b50a Put all the options shared amongst the ff* tools under a dedicated
section "Generic options".

Originally committed as revision 21934 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-02-21 10:56:38 +00:00
John Van Sickle
385e1658b3 Adds -aq documentation to the ffmpeg docs.
Patch by John Van Sickle rot13(<wbua.inafvpxyr@tznvy.pbz>).

Originally committed as revision 21331 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-01-19 22:13:51 +00:00
Stefano Sabatini
5f6cb6eb9c Factorize common options documentation.
Originally committed as revision 20907 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-12-21 21:32:09 +00:00
Ramiro Polla
870e015048 Add -?, -help, and --help as alternative options to get help.
Originally committed as revision 20906 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-12-21 02:20:13 +00:00
Matthieu Crapet
0fc2c0f618 Add -vlang option to set ISO 639 video stream language code.
This is similar to existing -alang & -slang options.

Patch by Matthieu Crapet m${surname} ^ gmail com.

Originally committed as revision 20880 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-12-16 12:08:01 +00:00
Stefano Sabatini
62d7566239 Implement a -filters option, listing all the available libavfilter
filters.
Currently filters are not registered, so the option will show none.

Originally committed as revision 20807 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-12-12 16:18:11 +00:00
Ramiro Polla
35c504b6fe Update documentation for r20435 (which added the -fpre option).
Originally committed as revision 20753 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-12-06 17:02:12 +00:00
Daniel Verkamp
0584b71823 Document -formats split
Originally committed as revision 20561 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-11-20 10:23:40 +00:00
Diego Biurrun
f0ef7beeb6 Document -sn option.
Originally committed as revision 20122 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-10-01 13:48:23 +00:00
Stefano Sabatini
13d41a194e Document the -loglevel option in the ffmpeg man page.
Originally committed as revision 20028 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-09-26 17:21:22 +00:00
Diego Biurrun
72cdcc0b9b Replace @node commands with @anchor to refer to specific points in the text.
This fixes the warnings
** `Developers Guide' is up for `Coding Rules', but has no menu entry for this node
** `Invocation' is up for `FFmpeg formula evaluator', but has no menu entry for this node

Originally committed as revision 19831 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-09-13 16:46:28 +00:00
Stefano Sabatini
edb501c45b Add an explanation and complete the metadata usage example.
Originally committed as revision 19320 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-07-01 20:11:53 +00:00
Stefano Sabatini
5227bd63a6 Fix braino.
Originally committed as revision 19287 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-06-28 20:25:08 +00:00
Stefano Sabatini
39a4f14643 Update ffmpeg documentation regarding metadata setting. -title,
-author, -copyright, -track, -album, and -year options have been
dropped in favor of -metadata.

Originally committed as revision 19285 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-06-27 13:26:35 +00:00
Martin Storsjö
2b12317a90 Fix documentation for the "-ps" option
Patch by Martin Storsjö (martin AT martin DOT st)

Originally committed as revision 18403 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-04-09 21:52:12 +00:00
Gwenole Beauchesne
41913a35b0 Add 16cif video frame size abbreviation. i.e. -s alias for 1408x1152.
Originally committed as revision 18301 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-04-01 08:55:31 +00:00
Stefano Sabatini
c73d39965e Add an example showing how to create a video from many images.
Originally committed as revision 17955 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-03-14 10:18:18 +00:00
Diego Biurrun
fdf119062e Remove deprecated vhook subsystem.
Originally committed as revision 17769 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-03-03 14:09:10 +00:00
Robert Swain
66d8229072 http://bytesex.org/xawtv/ permanently redirects to
http://linux.bytesex.org/xawtv/ so update the URL

Originally committed as revision 17592 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-02-25 20:18:01 +00:00
Daniel Verkamp
f67f485b36 Document 'ffmpeg -formats', patch by Daniel Verkamp, daniel drv nu.
Originally committed as revision 17536 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-02-23 01:47:18 +00:00
Stefano Sabatini
bd591ead45 Update preset files documentation to match with r16795.
Originally committed as revision 16810 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-01-26 22:23:04 +00:00
Víctor Paesa
17bdc29039 Document the ld, st, while statements.
Originally committed as revision 16588 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-01-13 21:20:03 +00:00
Víctor Paesa
593b321969 Document the same functions, in the same order, that eval.c has.
Originally committed as revision 16586 to svn://svn.ffmpeg.org/ffmpeg/trunk
2009-01-13 21:07:27 +00:00
Stefano Sabatini
44fe71133d Fix documentation for -passlogfile, the argument is not a file name
but a prefix used to create the complete pass log file name.

Originally committed as revision 16324 to svn://svn.ffmpeg.org/ffmpeg/trunk
2008-12-26 13:40:02 +00:00
Stefano Sabatini
c2902c9c66 Improve documentation for the -pass and -passlog options. Add mention
to how the log file is used and specify the default log file name.

Originally committed as revision 15969 to svn://svn.ffmpeg.org/ffmpeg/trunk
2008-12-01 08:27:53 +00:00
Benoit Fouet
c27c66c3f0 Add a space between frequencies and their units.
Originally committed as revision 15613 to svn://svn.ffmpeg.org/ffmpeg/trunk
2008-10-13 15:09:04 +00:00
Stefano Sabatini
66e9aa7463 Make less verbose a sentence in the preset system documentation.
Originally committed as revision 15570 to svn://svn.ffmpeg.org/ffmpeg/trunk
2008-10-05 22:41:43 +00:00
Stefano Sabatini
4a60e574bb Document the preset files system.
Originally committed as revision 15563 to svn://svn.ffmpeg.org/ffmpeg/trunk
2008-10-05 09:45:54 +00:00
Diego Biurrun
1a27fb001a FFmpeg is not made for bats: Fix 22050Hz vs. 22050kHz typo.
Originally committed as revision 15535 to svn://svn.ffmpeg.org/ffmpeg/trunk
2008-10-03 19:14:48 +00:00
Diego Biurrun
910f02a054 spelling cosmetics
Originally committed as revision 15518 to svn://svn.ffmpeg.org/ffmpeg/trunk
2008-10-02 16:28:58 +00:00
Stefano Sabatini
0769649711 Add to the ffmpeg manual an example showing how to add streams to the
output.

Originally committed as revision 15030 to svn://svn.ffmpeg.org/ffmpeg/trunk
2008-08-29 17:44:42 +00:00
Erwan Ducroquet
850a8d42ab Add examples in documentation showing how to avoid to decode audio and
output video in pass 1 for 2-pass encoding.
Patch by Erwan Ducroquet erwan _dot_ ducroquet _at_ gmail _dot_ com

Originally committed as revision 14736 to svn://svn.ffmpeg.org/ffmpeg/trunk
2008-08-13 19:49:37 +00:00
Stefano Sabatini
8d36d36e74 Add to the ffmpeg docs an usage example showing how to extract images
from a video.

Originally committed as revision 14711 to svn://svn.ffmpeg.org/ffmpeg/trunk
2008-08-12 10:07:28 +00:00
Stefano Sabatini
bb89b0bc9d Improve docs for the ffmpeg -map option.
Originally committed as revision 14530 to svn://svn.ffmpeg.org/ffmpeg/trunk
2008-08-04 07:02:48 +00:00
tripp
9c17037200 Fix and clarify invalid examples for framerate override in the documentation.
patch by tripp, eliared yahoo com

Originally committed as revision 14431 to svn://svn.ffmpeg.org/ffmpeg/trunk
2008-07-27 19:38:25 +00:00
Jason Garrett-Glaser
e3576e2513 Improve documentation about -bt option
Originally committed as revision 14397 to svn://svn.ffmpeg.org/ffmpeg/trunk
2008-07-25 21:04:06 +00:00
tripp
3a9b190c54 Enhance qblur and qcomp documentation.
Patch by tripp eliared yahoo com

Originally committed as revision 14333 to svn://svn.ffmpeg.org/ffmpeg/trunk
2008-07-22 07:20:17 +00:00
tripp
5ad2b4c621 Add complete listing of bitstream filters and 2 examples to the documentation.
patch by tripp, eliared yahoo com

Originally committed as revision 14329 to svn://svn.ffmpeg.org/ffmpeg/trunk
2008-07-21 21:06:49 +00:00
tripp
bbc35f515f Clarify -minrate/-maxrate description in the documentation.
patch by tripp, eliared yahoo com

Originally committed as revision 14320 to svn://svn.ffmpeg.org/ffmpeg/trunk
2008-07-21 05:25:59 +00:00
Diego Biurrun
831ec93567 Run documentation through ispell, plus some minor fixes.
Originally committed as revision 13670 to svn://svn.ffmpeg.org/ffmpeg/trunk
2008-06-06 07:51:36 +00:00
Stefano Sabatini
a19caa0f3e Mark option arguments as variables using @var{}.
patch by Stefano Sabatini, stefano.sabatini-lala poste it

Originally committed as revision 12771 to svn://svn.ffmpeg.org/ffmpeg/trunk
2008-04-08 16:39:30 +00:00