[FFmpeg-trac] #9685(documentation:new): Make the documentation clearer

[FFmpeg]

#9685: Make the documentation clearer
-------------------------------------+-------------------------------------
             Reporter:  root         |                     Type:  defect
               Status:  new          |                 Priority:  important
            Component:               |                  Version:
  documentation                      |  unspecified
             Keywords:               |               Blocked By:
             Blocking:               |  Reproduced by developer:  0
Analyzed by developer:  0            |
-------------------------------------+-------------------------------------
 The documentation should clearly state which option does what.

 Let's take `-framerate` for example. https://ffmpeg.org/ffmpeg-all.html
 says:

   * The `-r` option "is not the same as the -framerate option". However,
 it does not say what the difference is.

   * `-framerate` is documented as "Set the grabbing frame rate.". However,
 it can be used for saving rather than grabbing.

   * "Default is ntsc, corresponding to a frame rate of 30000/1001."
 However, the default is `25`.

 When calling `ffmpeg --help`, the `-framerate` option is not even
 mentioned.
-- 
Ticket URL: <https://trac.ffmpeg.org/ticket/9685>
FFmpeg <https://ffmpeg.org>
FFmpeg issue tracker