docs: Revise Command line reference article.

This commit is contained in:
Bradley Sepos 2018-05-29 20:09:16 -04:00
parent a8b5d80f95
commit d43f751bba
No known key found for this signature in database
GPG Key ID: DEADE2F57D42D9C7

View File

@ -1,29 +1,22 @@
--- ---
Type: article Type: article
State: [ draft ] Title: Command line reference
Title: CLI Guide
Project: HandBrake Project: HandBrake
Project_URL: https://handbrake.fr/ Project_URL: https://handbrake.fr/
Project_Version: Latest Project_Version: Latest
Language: English Language: English
Language_Code: en Language_Code: en
Authors: [ Scott (s55) ] Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS), Scott (s55) ]
Copyright: 2018 HandBrake Team Copyright: 2018 HandBrake Team
License: Creative Commons Attribution-ShareAlike 4.0 International License: Creative Commons Attribution-ShareAlike 4.0 International
License_Abbr: CC BY-SA 4.0 License_Abbr: CC BY-SA 4.0
License_URL: https://handbrake.fr/docs/license.html License_URL: https://handbrake.fr/docs/license.html
--- ---
CLI Guide Command line reference
============================= ======================
The following details all the available options in HandBrakeCLI The following details all the available options in the command line interface. This information may be accessed at any time by running `HandBrakeCLI --help`.
You can access this information at any time by running the following command:
> HandBrakeCLI --help
### The HandBrakeCLI Help Output
Usage: HandBrakeCLI [options] -i <source> -o <destination> Usage: HandBrakeCLI [options] -i <source> -o <destination>
@ -31,6 +24,8 @@ You can access this information at any time by running the following command:
-h, --help Print help -h, --help Print help
--version Print version --version Print version
--json Log title, progress, and version info in
JSON format
-v, --verbose[=number] Be verbose (optional argument: logging level) -v, --verbose[=number] Be verbose (optional argument: logging level)
-Z. --preset <string> Select preset by name (case-sensitive) -Z. --preset <string> Select preset by name (case-sensitive)
Enclose names containing spaces in double quotation Enclose names containing spaces in double quotation
@ -101,13 +96,22 @@ You can access this information at any time by running the following command:
--no-optimize Disable preset 'optimize' --no-optimize Disable preset 'optimize'
-I, --ipod-atom Add iPod 5G compatibility atom to MP4 container -I, --ipod-atom Add iPod 5G compatibility atom to MP4 container
--no-ipod-atom Disable iPod 5G atom --no-ipod-atom Disable iPod 5G atom
--align-av Add audio silence or black video frames to start
of streams so that all streams start at exactly
the same time
--inline-parameter-sets Create adaptive streaming compatible output.
Inserts parameter sets (SPS and PPS) inline
in the video stream before each IDR.
Video Options ---------------------------------------------------------------- Video Options ----------------------------------------------------------------
-e, --encoder <string> Select video encoder: -e, --encoder <string> Select video encoder:
x264 x264
x264_10bit
x265 x265
x265_10bit
x265_12bit
mpeg4 mpeg4
mpeg2 mpeg2
VP8 VP8
@ -189,7 +193,6 @@ You can access this information at any time by running the following command:
Multiple output tracks can be used for one input. Multiple output tracks can be used for one input.
-E, --aencoder <string> Select audio encoder(s): -E, --aencoder <string> Select audio encoder(s):
none none
av_aac
ca_aac ca_aac
ca_haac ca_haac
copy:aac copy:aac
@ -213,8 +216,8 @@ You can access this information at any time by running the following command:
is supported for the audio type. is supported for the audio type.
Separate tracks by commas. Separate tracks by commas.
Defaults: Defaults:
av_mp4 ca_aac/av_aac av_mp4 ca_aac
av_mkv ca_aac/mp3 av_mkv ca_aac
--audio-copy-mask <string> --audio-copy-mask <string>
Set audio codecs that are permitted when the Set audio codecs that are permitted when the
"copy" audio encoder option is specified "copy" audio encoder option is specified
@ -246,7 +249,6 @@ You can access this information at any time by running the following command:
Separate tracks by commas. Separate tracks by commas.
Defaults: Defaults:
none up to dpl2 none up to dpl2
av_aac up to dpl2
ca_aac up to dpl2 ca_aac up to dpl2
ca_haac up to dpl2 ca_haac up to dpl2
ac3 up to 5point1 ac3 up to 5point1
@ -262,7 +264,7 @@ You can access this information at any time by running the following command:
1 = Enable Normalization 1 = Enable Normalization
-R, --arate Set audio samplerate(s) -R, --arate Set audio samplerate(s)
(8/11.025/12/16/22.05/24/32/44.1/48 kHz) (8/11.025/12/16/22.05/24/32/44.1/48 kHz)
Separate tracks by commas. or "auto". Separate tracks by commas.
-D, --drc <float> Apply extra dynamic range compression to the -D, --drc <float> Apply extra dynamic range compression to the
audio, making soft sounds louder. Range is 1.0 audio, making soft sounds louder. Range is 1.0
to 4.0 (too loud), with 1.5 - 2.5 being a useful to 4.0 (too loud), with 1.5 - 2.5 being a useful
@ -421,7 +423,8 @@ You can access this information at any time by running the following command:
cb-strength=c:cb-origin-tune=c:cb-patch-size=c: cb-strength=c:cb-origin-tune=c:cb-patch-size=c:
cb-range=c:cb-frame-count=c:cb-prefilter=c: cb-range=c:cb-frame-count=c:cb-prefilter=c:
cr-strength=c:cr-origin-tune=c:cr-patch-size=c: cr-strength=c:cr-origin-tune=c:cr-patch-size=c:
cr-range=c:cr-frame-count=c:cr-prefilter=c cr-range=c:cr-frame-count=c:cr-prefilter=c:
threads=t
Default: Default:
y-strength=6:y-origin-tune=1:y-patch-size=7: y-strength=6:y-origin-tune=1:y-patch-size=7:
y-range=3:y-frame-count=2:y-prefilter=0: y-range=3:y-frame-count=2:y-prefilter=0: