Opened 3 years ago
Closed 3 years ago
#9685 closed defect (invalid)
Make the documentation clearer
Reported by: | root | Owned by: | |
---|---|---|---|
Priority: | important | Component: | documentation |
Version: | unspecified | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | Reproduced by developer: | no | |
Analyzed by developer: | no |
Description
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.
Change History (4)
follow-up: 2 comment:1 by , 3 years ago
Resolution: | → invalid |
---|---|
Status: | new → closed |
comment:2 by , 3 years ago
Replying to Elon Musk:
use ffmpeg -h full
The -framerate option is important. Why is it not listed in ffmpeg --help?
Do not mix general and per component (filter, decoder, muxer, demuxer, encoder, device, bitstream filter) options
What options exactly do I "mix"? What do you mean by "mix"?
I listed several problems in the ticket, could you please respond to each?
comment:3 by , 3 years ago
Resolution: | invalid |
---|---|
Status: | closed → reopened |
comment:4 by , 3 years ago
Resolution: | → invalid |
---|---|
Status: | reopened → closed |
ffmpeg --help is short help. Not full help.
-framerate option is not generic option, but option for many components in ffmpeg.
ntsc framerate is listed only for avfoundation as default, and that is correct and match with documentation of avfoundation component.
To get all help for avfoundation component use:
ffmpeg -h demuxer=avfoundation
use ffmpeg -h full
Do not mix general and per component (filter, decoder, muxer, demuxer, encoder, device, bitstream filter) options