A different version of HandBrakeCLI -help

Discussion of the HandBrake command line interface (CLI)
Forum rules
An Activity Log is required for support requests. Please read How-to get an activity log? for details on how and why this should be provided.
Post Reply
MickM
Novice
Posts: 68
Joined: Sat Nov 04, 2017 3:45 pm

A different version of HandBrakeCLI -help

Post by MickM »

I found the output of HandBrakeCLI -help to just be too darn long (likely optimized for a narrow window) and annoying to scroll through. I made a version that only works well with a much wider window, and I also edited most of the text so it fits that width i.e. there may be errors (but hopefully not). It's meant to be viewed with a fixed width font e.g. Courier.

This will likely be of no use to anybody...

Code: Select all

NOTE: The following was derived from HandBrakeCLI v1.51
Usage: HandBrakeCLI [options] -i <source> -o <destination>

--------------------------------------------------- General Options ----------------------------------------------------------------------------
-h, --help                       Display help
    --version                    Display version
    --json                       Log title, progress, and version info in JSON format
-v, --verbose[=num]              Be verbose (optional argument: logging level)
    --no-dvdnav                  Do not use dvdnav for reading DVDs
-Z. --preset <name>              Preset name (case-sensitive). Double-quote names containing spaces (e.g. "Preset Name")
-z, --preset-list                List available presets
    --preset-import-file <file>  Import presets from a json preset file. 'file' can be a list of space separated files, or use shell wildcards
    --preset-import-gui          Import presets from GUI config preset file.
    --preset-export <name>       Create preset from CLI options and write a json version to console or a file if --preset-export-file specified
    --preset-export-file <file>  Write a preset generated by --preset-export to 'file'.
    --preset-export-description <arg>   Add a description to the preset created with --preset-export
    --queue-import-file <file>   Import an encode queue file created by the GUI

--------------------------------------------------- Source Options -----------------------------------------------------------------------------
-i, --input <arg>                Source input file or device
-t, --title <num>                Title to encode (0 to scan all titles only, default: 1)
    --min-duration               Minimum title duration (in seconds). Shorter titles are ignored (default: 10).
    --scan                       Scan selected title only.
    --main-feature               Detect and select the main feature title.
-c, --chapters <arg>             Chapters (e.g. "1-3" for chapters 1 to 3 or "3" for chapter 3 only, default: all chapters)
    --angle <num>                Video angle (DVD or Blu-ray only)
    --previews <num:boolean>     Number of preview images to generate, and whether to store to disk (0 or 1). (default: 10:0)
    --start-at-preview <num>     Start encoding at a given preview.
    --start-at <arg:num>         Start encoding at 'num' seconds, frames or pts (on a 90kHz clock) 
                                 (e.g. seconds:10, frames:300, pts:900000). Units must match --stop-at units, if specified.
    --stop-at  <arg:num>         Stop encoding after 'num' seconds, frames or pts (on a 90kHz clock) has passed 
                                 (e.g. seconds:10, frames:300, pts:900000). Duration is relative to --start-at, if specified (units must match)

--------------------------------------------------- Destination Options ------------------------------------------------------------------------
-o, --output <file>              Destination file'name'
-f, --format <arg>               Container format: av_mp4 | av_mkv | av_webm. Default: auto-detected from destination file name)
-m, --markers                    Add chapter markers
    --no-markers                 Disable preset chapter markers
-O, --optimize                   Optimize MP4 files for HTTP streaming (fast start, s.s. rewrite file to place MOOV atom at beginning)
    --no-optimize                Disable preset 'optimize'
-I, --ipod-atom                  Add iPod 5G compatibility atom to MP4 container
    --no-ipod-atom               Disable iPod 5G atom
    --align-av                   Add audio silence or black video frames to start of streams so all streams start at exactly the same time
    --inline-parameter-sets      Make adaptive streaming compatible output. Insert param sets (SPS & PPS) inline in video stream before each IDR

--------------------------------------------------- Video Options ------------------------------------------------------------------------------
-e, --encoder <arg>              Video encoder. arg: x264 | x264_10bit | vt_h264 | x265 | x265_10bit | x265_12bit |
                                                     vt_h265 | vt_h265_10bit | mpeg4 | mpeg2 | VP8 | VP9 | theora
    --encoder-preset <arg>       Adjust video encoding settings for a particular speed/efficiency tradeoff (encoder-specific)
    --encoder-preset-list <arg>  List supported --encoder-preset values for the specified video encoder
    --encoder-tune <arg>         Adjust video encoding settings for a particular type of source or situation (encoder-specific)
    --encoder-tune-list <arg>    List supported --encoder-tune values for the specified video encoder
-x, --encopts <arg>              Advanced encoding options like mencoder (all encoders except theora). arg: opt1=val1:opt2=val2...
    --encoder-profile <arg>      Ensure compliance with the requested codec profile (encoder-specific)
    --encoder-profile-list <arg> List supported --encoder-profile values for the specified video encoder
    --encoder-level <arg>        Ensures compliance with the requested codec level (encoder-specific)
    --encoder-level-list <arg>   List supported --encoder-level values for the specified video encoder
-q, --quality <float>            Video quality (e.g. 22.0)
-b, --vb <num>                   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 1st pass to improve speed (works with x264 and x265)
    --no-turbo                   Disable 2-pass mode's "turbo" 1st pass
-r, --rate <float>               Video framerate (5 10 12 15 20 23.976 24 25 29.97 30 48 50 59.94 60 72 75 90 100 120 or number between 1-1000) 
                                 Omitting a framerate preserves a source's time stamps, potentially creating variable framerate video
    --cfr                        Makes the output rate constant at that given by the -r flag (or source's average rate if no -r is given). 
    --pfr                        Preserves the source timing but limits the rate to that specified with the -r flag. 
    --vfr                        Preserves the source timing. Default is --pfr when -r is given and --vfr otherwise

--------------------------------------------------- Audio Options ------------------------------------------------------------------------------
    --audio-lang-list <arg> Comma separated ISO 639-2 code languages to select from the source title (e.g. fre, eng, spa, dut, etc.). 
                            'und' matches all languages. Default: 1st audio matching each language is added to your output.
    --all-audio             Select all audio tracks matching languages in --audio-lang-list. Default is any language.
    --1st-audio             Select 1st audio track  matching languages in --audio-lang-list. Default is any language.
-a, --audio <arg>           Comma separated audio track(s). ("none" for no audio, "1,2,3" for multiple tracks. Default: 1st one).
-E, --aencoder <arg>        Audio encoder(s): none | ca_aac | ca_haac | copy:aac | ac3 | copy:ac3 | eac3 | copy:eac3 | copy:truehd | copy:dts | 
                                              copy:dtshd | copy:mp2 | mp3 | copy:mp3 | vorbis | flac16 | flac24 | copy:flac | opus | copy 
                            "copy:<type>" passes through the specified unmodified audio track, if pass through supported for the audio type. 
                            Separate tracks by commas. Defaults: av_mp4 | ca_aac | av_mkv | ca_aac | av_webm | vorbis
    --audio-copy-mask <arg> Comma separated codecs allowable when "copy" audio encoder option used (aac,ac3,eac3,truehd,dts,dtshd,mp2,mp3,flac)
    --audio-fallback <arg>  Codec to use when it is not possible to copy an audio track without re-encoding.
-B, --ab <num>              Comma separated audio track bitrate(s) in kbit/s. Default: via selected codec, mixdown, and samplerate combination
-Q, --aq <float>            Audio quality metric. Separate tracks by commas.
-C, --ac <float>            Audio compression metric. (available depending on selected codec) Separate tracks by commas.
-6, --mixdown <arg>         Comma separated audio up/down mixing format(s). 
                            arg: mono | left_only | right_only | stereo | dpl1 | dpl2 | 5point1 | 6point1 | 7point1 | 5_2_lfe 
                            Defaults: none (≤ dpl2) | ca_aac (≤ 7point1) | ca_haac (≤ 7point1) | ac3 (≤ 5point1) | eac3 (≤ 5point1) | 
                                      mp3 (≤ dpl2) | vorbis (≤ dpl2) | flac16 (≤ 7point1) | flac24 (≤ 7point1) | opus (≤ 7point1)
    --normalize-mix <arg>   Normalize audio mix levels to prevent clipping. Separate tracks by commas. 
                            0 = Disable Normalization (default), 1 = Enable Normalization
-R, --arate                 Audio sample rate(s) (8 11.025 12 16 22.05 24 32 44.1 48 kHz) or "auto". Separate tracks by commas.
-D, --drc <float>           Apply extra audio dynamic range compression, making soft sounds louder. 
                            Range is 1.0 to 4.0 (too loud), with 1.5 - 2.5 being a useful range. Separate tracks by commas.
    --gain <float>          Amplify or attenuate audio before encoding. Doesn't work with audio passthru (copy). Values are in dB.  
                            Negative values attenuate, positive values amplify. A 1 dB difference is barely audible.
    --adither <arg>         Apply dither before encoding audio. Separate tracks by commas. 
                            arg: auto (default) | none | rectangular | triangular | triangular_hp | [Censored]_ns. Supported by flac16 encoder
-A, --aname <arg>           Comma separated audio track name(s).

--------------------------------------------------- Picture Options ----------------------------------------------------------------------------
-w, --width  <num>           Storage width in pixels
-l, --height <num>           Storage height in pixels
    --crop <T:B:L:R>         Cropping in pixels (default: automatically remove black bars)
    --loose-crop             Always crop to a multiple of the modulus
    --no-loose-crop          Disable preset 'loose-crop'
-Y, --maxHeight <num>        Maximum height in pixels
-X, --maxWidth <num>         Maximum width in pixels
    --non-anamorphic         Set pixel aspect ratio to 1:1
    --auto-anamorphic        Store pixel aspect ratio that maximizes storage resolution
    --loose-anamorphic       Store pixel aspect ratio that is as close as possible to the source video pixel aspect ratio
    --custom-anamorphic      Store pixel aspect ratio in video stream and directly control all parameters.
    --display-width <pixels> Set playback display aspect width for custom anamorphic. This may differ from the storage aspect.
    --keep-display-aspect    Keep the source's display aspect ratio when using custom anamorphic
    --no-keep-display-aspect Disable preset 'keep-display-aspect'
    --pixel-aspect <X:Y>     Pixel aspect for custom anamorphic. --display-width and --pixel-aspect are mutually exclusive.
    --itu-par                Use wider ITU pixel aspect values for loose and custom anamorphic, useful with underscanned sources
    --no-itu-par             Disable preset 'itu-par'
    --modulus <num>          Storage width & height modulus. Dimensions are made divisible by this number (default: set by preset, typ 2)
-M, --color-matrix <arg>     Set the color space signaled by the output: Overrides color signalling with no conversion. 
                             Options: 2020 | 709 | 601 | ntsc (same as 601) | pal. Default: auto-detected from source

--------------------------------------------------- Filters Options ----------------------------------------------------------------------------
    --comb-detect[=arg]  Detect interlace artifacts in frames.  arg: permissive | fast.
                         If not accompanied by the decomb or deinterlace filters, only log the interlaced frame count to the activity log. 
                         If     accompanied by the decomb or deinterlace filters, deinterlace only frames where interlacing is detected. 
                         Custom:  mode=m:spatial-metric=s:motion-thresh=m:       Default: mode=3:spatial-metric=2:motion-thresh=1:
                                  spatial-thresh=s:filter-mode=f:block-thresh=b:          spatial-thresh=1:filter-mode=2:block-thresh=40:
                                  block-width=b:block-height=b:disable=d                  block-width=16:block-height=16
    --no-comb-detect     Disable preset comb-detect filter
-d, --deinterlace[=arg]  Deinterlace video using FFmpeg yadif. arg: skip-spatial | bob.  Custom: mode=m:parity=p  Default: mode=3
    --no-deinterlace     Disable preset deinterlace filter
-5, --decomb[=arg]       Deinterlace using a combination of yadif, blend, cubic or EEDI2 interpolation. 
                         arg: bob | eedi2 | eedi2bob   Default: mode=7
                         Custom: mode=m:magnitude-thresh=m:variance-thresh=v:  laplacian-thresh=l:dilation-thresh=d:  
                                 erosion-thresh=e:noise-thresh=n:              search-distance=s:postproc=p:parity=p
    --no-decomb          Disable preset decomb filter
-9, --detelecine[=arg]   Detelecine (ivtc) video with pullup filter. 
                         Drops duplicate frames to restore pre-telecine framerate, unless constant framerate specified (--rate 29.97 --cfr) 
                         Custom:  skip-left=s:skip-right=s:skip-top=s:     skip-bottom=s:strict-breaks=s:plane=p:parity=p:   disable=d 
                         Default: skip-left=1:skip-right=1:skip-top=4:     skip-bottom=4:plane=0
    --no-detelecine      Disable preset detelecine filter
-8, --hqdn3d[=arg]       Denoise video with hqdn3d filter.  arg: ultralight | light | medium | strong. 
                         Custom:  y-spatial=y:cb-spatial=c:cr-spatial=c:   y-temporal=y:cb-temporal=c:cr-temporal=c  
                         Default: y-spatial=3:cb-spatial=2:cr-spatial=2:   y-temporal=2:cb-temporal=3:cr-temporal=3
    --no-hqdn3d          Disable preset hqdn3d filter
    --denoise[=arg]      Legacy alias for --hqdn3d
    --nlmeans[=arg]      Denoise video with NLMeans filter.  arg: ultralight | light | medium | strong 
                         Custom: y-strength=y:y-origin-tune=y:y-patch-size=y:   Default: y-strength=6:y-origin-tune=1:y-patch-size=7:
                                 y-range=y:y-frame-count=y:y-prefilter=y:                y-range=3:y-frame-count=2:y-prefilter=0:
                                 cb-strength=c:cb-origin-tune=c:cb-patch-size=c:         cb-strength=6:cb-origin-tune=1:cb-patch-size=7:
                                 cb-range=c:cb-frame-count=c:cb-prefilter=c:             cb-range=3:cb-frame-count=2:cb-prefilter=0
                                 cr-strength=c:cr-origin-tune=c:cr-patch-size=c: 
                                 cr-range=c:cr-frame-count=c:cr-prefilter=c:  
                                 threads=t 
    --no-nlmeans         Disable preset NLMeans filter
    --nlmeans-tune <arg> Tune NLMeans filter to content type. arg: none | film | grain | highmotion | animation | tape | sprite. 
                         Alters only NLMeans presets, not custom settings
    --chroma-smooth[=arg] Sharpen video with chroma smooth filter. arg: ultralight | light | medium | strong | stronger | verystrong. 
                          Custom: cb-strength=c:cb-size=c:cr-strength=c:cr-size=c    Default: cb-strength=1.2:cb-size=7
    --no-chroma-smooth   Disable preset chroma smooth filter
    --chroma-smooth-tune <arg>   Tune chroma smooth filter. arg: none | tiny | small | medium | wide | verywide. 
                                 Alters only chroma smooth presets, not custom settings
    --unsharp[=arg]      Sharpen video with unsharp filter. arg: ultralight | light | medium | strong | stronger | verystrong. 
                         Custom:  y-strength=y:y-size=y:cb-strength=c:cb-size=c:    cr-strength=c:cr-size=c 
                         Default: y-strength=0.25:y-size=7:cb-strength=0.25:        cb-size=7
    --no-unsharp         Disable preset unsharp filter
    --unsharp-tune <arg> Tune unsharp filter. arg: none | ultrafine | fine | medium | coarse | verycoarse. 
                         Alters only unsharp presets, not custom settings
    --lapsharp[=arg]     Sharpen video with lapsharp filter. arg: ultralight | light | medium | strong | stronger | verystrong. 
                         Custom:  y-strength=y:y-kernel=y:cb-strength=c:           cb-kernel=c:cr-strength=c:cr-kernel=c
                         Default: y-strength=0.2:y-kernel=isolap:cb-strength=0.2:  cb-kernel=isolap  
    --no-lapsharp        Disable preset lapsharp filter
    --lapsharp-tune <arg> Tune lapsharp filter. arg: none | film | grain | animation | sprite. Alters only lapsharp presets, not custom settings
-7, --deblock[=arg]      Deblock video with avfilter deblock. arg: ultralight | light | medium | strong | stronger | verystrong. 
                         Custom: strength=s:thresh=t:blocksize=b:disable=d      Default: strength=strong:thresh=20
    --no-deblock         Disable preset deblock filter
    --deblock-tune <arg> Tune deblock filter. arg: small | medium | large. Alters only deblock presets, not custom settings
    --rotate[=arg]       Rotate image or flip its axes. Angle rotates clockwise, arg: 0 | 90 | 180 | 270. 
                         hflip=1 flips about the x axis (horizontally). Custom: angle=a:hflip=h:disable=d Default: angle=180:hflip=0
    --pad <arg>          Pad image with borders (e.g. letterbox). The padding color may be set (default black). 
                         Color may be an HTML color name or RGB value. The position of image in pad may also be set.
                         Custom: width=w:height=h:color=c:x=x:y=y:top=t:bottom=b:    left=l:right=r
    --colorspace <arg>   Convert colorspace, transfer characteristics or color primaries. arg: bt2020 | bt709 | bt601-6-525 | bt601-6-625. 
                         Custom: primaries=p:transfer=t:matrix=m:range=r:     tonemap=t:param=p:desat=d
-g, --grayscale          Grayscale encoding
    --no-grayscale       Disable preset 'grayscale'

--------------------------------------------------- Subtitles Options --------------------------------------------------------------------------
    --subtitle-lang-list <arg>  Comma separated list of ISO 639-2 subtitle languages to select from the source e.g. fre, eng, spa, etc.
                                Default: 1st subtitle matching each language is added to your output.
    --all-subtitles      Select all subtitle tracks matching languages in the --subtitle-lang-list list. Default is any language.
    --1st-subtitle       Select 1st subtitle track  matching languages in the --subtitle-lang-list list. Default is any language.
-s, --subtitle <arg>     Comma separated subtitle track(s). Multiple output tracks can be used for one input. "none" for no subtitles. 
                         "scan" adds an extra 1st pass scan of subtitles matching the language of the 1st audio or that selected 
                         by --native-language, selecting the one that's used ≤10% of the time. 
                         This should locate subtitles for short foreign language segments. Best used with --subtitle-forced.
-S, --subname <arg>      Comma separated subtitle track name(s).
-F, --subtitle-forced[=arg] Only display subtitles from selected stream if the subtitle has the forced flag set. 
                            The values in 'arg' are indexes into the subtitle list specified with '--subtitle'. 
                            Separate tracks by commas. Example: "1,2,3" for multiple tracks. Without 'arg', the 1st track is forced.
    --subtitle-burned["native"|"none"|=num] Burn selected subtitle into the video track. Without 'num' the 1st track is burned. 
                                            'num': index into the --subtitle list. "native" burns subtitle track added by --native-language
    --subtitle-default["none"|=num] Flag selected subtitle as playback default. No default means no subtitle is displayed automatically. 
                                    'num': index into the --subtitle list. "none" overrides automatically selected default subtitle track.
-N, --native-language <arg>  Specify your ISO 639-2 language preference (e.g. fre, eng, spa, dut, etc.). 
                             When the 1st audio track doesn't match your native language then select the 1st subtitle that does. 
                             When used with --native-dub the audio track is changed in preference to subtitles.
    --native-dub         Used with --native-language. If no audio tracks selected, select the 1st one that matches the --native-language. 
                         If no match is found then the 1st matching subtitle track is used instead.
    --srt-file <arg>     SubRip SRT filename(s), comma separated.
    --srt-codeset <arg>  Character codeset(s) that the SRT file(s) are encoded as, comma separated. Default = 'latin1'. 
                         Command 'iconv -l' provides a list of valid codesets.
    --srt-offset <arg>   Offset (in milliseconds) to apply to the SRT file(s), comma separated. Default = 0. Offsets may be negative.
    --srt-lang <arg>     SRT track language as an ISO 639-2 code (e.g. fre, eng, spa, dut, etc.). If no default use 'und'. Comma separated.
    --srt-default[=num]  Flag selected SRT as default displayed subtitle during playback. No default means automatically display no subtitle.
                         Without 'num' the 1st SRT is default. 'num': 1-based index into the 'srt-file' list
    --srt-burn[=num]     Burn selected SRT subtitle into video track. 'num': 1-based index into --srt-file list, without 'num' 1st SRT burned
    --ssa-file <arg>     SubStationAlpha SSA comma separated filename(s).
    --ssa-offset <arg>   Offset (in milliseconds) to apply to the SSA file(s), comma separated. Default zero is assumed. Offsets may be < 0.
    --ssa-lang <arg>     SSA comma separated, ISO 639-2 track language(s) (e.g. fre, eng, spa, dut, etc.). Default is 'und'.
    --ssa-default[=num]  Flag selected SSA as default displayed subtitle during playback. No default means automatically display no subtitle. 
                         Without 'num' the 1st SSA is default. 'num': 1-based index into the 'ssa-file' list
    --ssa-burn[=num]     Burn selected SSA subtitle into video track. 'num': 1-based index into --ssa-file list, without 'num' 1st SSA burned
Post Reply