docs: Update CLI reference. Add notice about OS/Hardware specific options.

This commit is contained in:
sr55 2023-12-27 17:56:56 +00:00
parent d4bab1a6bb
commit 34db9a5708
No known key found for this signature in database
GPG Key ID: 99C970F83E86C84B
2 changed files with 26 additions and 10 deletions

View File

@ -19,7 +19,8 @@ Command line reference
The following details all the available options in the command line interface. This information may be accessed at any time by running `HandBrakeCLI --help`.
Please run this command on your own system as available options may vary depending on operating system and system hardware.
For reference, the following was generated by the Windows version of HandBrakeCLI:
For reference, the following was generated by the Windows version of HandBrakeCLI.
Options may vary slightly depending on hardware / operating system. Run `HandBrakeCLI --help` for valid options for your system.
Usage: HandBrakeCLI [options] -i <source> -o <destination>
@ -128,6 +129,7 @@ For reference, the following was generated by the Windows version of HandBrakeCL
mpeg2
VP8
VP9
VP9_10bit
theora
--encoder-preset <string>
Adjust video encoding settings for a particular
@ -158,9 +160,9 @@ For reference, the following was generated by the Windows version of HandBrakeCL
specified video encoder
-q, --quality <float> Set video quality (e.g. 22.0)
-b, --vb <number> Set video bitrate in kbit/s (default: 1000)
-2, --two-pass Use two-pass mode
--no-two-pass Disable two-pass mode
-T, --turbo When using 2-pass use "turbo" options on the
--multi-pass Use multi-pass mode
--no-multi-pass Disable multi-pass mode
-T, --turbo When using multi-pass use "turbo" options on the
first pass to improve speed
(works with x264 and x265)
--no-turbo Disable 2-pass mode's "turbo" first pass
@ -181,6 +183,10 @@ For reference, the following was generated by the Windows version of HandBrakeCL
timing if it's below that rate.
If none of these flags are given, the default
is --pfr when -r is given and --vfr otherwise
--enable-hw-decoding <string>
Use 'nvdec' to enable NVDec
--disable-hw-decoding Disable hardware decoding of the video track,
forcing software decoding instead
Audio Options ----------------------------------------------------------------
@ -192,7 +198,7 @@ For reference, the following was generated by the Windows version of HandBrakeCL
matching each language will be added to your
output. Provide the language's ISO 639-2 code
(e.g. fre, eng, spa, dut, et cetera)
Use code 'und' (Unknown) to match all languages.
Use code 'any' to match all languages.
--all-audio Select all audio tracks matching languages in
the specified language list (--audio-lang-list).
Any language if list is not specified.
@ -708,3 +714,5 @@ For reference, the following was generated by the Windows version of HandBrakeCL
the video track.
If 'number' is omitted, the first SSA is burned.
'number' is a 1-based index into the 'ssa-file' list

View File

@ -19,7 +19,8 @@ Command line reference
The following details all the available options in the command line interface. This information may be accessed at any time by running `HandBrakeCLI --help`.
Please run this command on your own system as available options may vary depending on operating system and system hardware.
For reference, the following was generated by the Windows version of HandBrakeCLI:
For reference, the following was generated by the Windows version of HandBrakeCLI.
Options may vary slightly depending on hardware / operating system. Run `HandBrakeCLI --help` for valid options for your system.
Usage: HandBrakeCLI [options] -i <source> -o <destination>
@ -128,6 +129,7 @@ For reference, the following was generated by the Windows version of HandBrakeCL
mpeg2
VP8
VP9
VP9_10bit
theora
--encoder-preset <string>
Adjust video encoding settings for a particular
@ -158,9 +160,9 @@ For reference, the following was generated by the Windows version of HandBrakeCL
specified video encoder
-q, --quality <float> Set video quality (e.g. 22.0)
-b, --vb <number> Set video bitrate in kbit/s (default: 1000)
-2, --two-pass Use two-pass mode
--no-two-pass Disable two-pass mode
-T, --turbo When using 2-pass use "turbo" options on the
--multi-pass Use multi-pass mode
--no-multi-pass Disable multi-pass mode
-T, --turbo When using multi-pass use "turbo" options on the
first pass to improve speed
(works with x264 and x265)
--no-turbo Disable 2-pass mode's "turbo" first pass
@ -181,6 +183,10 @@ For reference, the following was generated by the Windows version of HandBrakeCL
timing if it's below that rate.
If none of these flags are given, the default
is --pfr when -r is given and --vfr otherwise
--enable-hw-decoding <string>
Use 'nvdec' to enable NVDec
--disable-hw-decoding Disable hardware decoding of the video track,
forcing software decoding instead
Audio Options ----------------------------------------------------------------
@ -192,7 +198,7 @@ For reference, the following was generated by the Windows version of HandBrakeCL
matching each language will be added to your
output. Provide the language's ISO 639-2 code
(e.g. fre, eng, spa, dut, et cetera)
Use code 'und' (Unknown) to match all languages.
Use code 'any' to match all languages.
--all-audio Select all audio tracks matching languages in
the specified language list (--audio-lang-list).
Any language if list is not specified.
@ -708,3 +714,5 @@ For reference, the following was generated by the Windows version of HandBrakeCL
the video track.
If 'number' is omitted, the first SSA is burned.
'number' is a 1-based index into the 'ssa-file' list