A few keys are named after the flag's internal name
Most keys are obvious, but set these exact ones: range (-r), list (--list), tmdb_id (--tmdb), imdb_id (--imdb), tvdb_id (--tvdb), no_atmos (--noatmos), and output_dir -(-o). The Configuration Reference has the full list +(-o). The Configuration Reference has the full list and every available key.
range
-r
list
--list
tmdb_id
--tmdb
imdb_id
--imdb
tvdb_id
--tvdb
no_atmos
--noatmos
output_dir
-o
unshackle searches entries in the order listed, and the first source to define a given service tag wins, so put local folders last if you want them to act as fallbacks rather than overrides. unshackle clones remote repositories on first use and refreshes them at most once a day. See Creating a Service for how service discovery and repositories work.
filenames
Alongside directories, the filenames key lets you override the templates unshackle uses when naming its own working and log files (for example the log filename or the temporary chapters file). Most users never need to touch this. The available names and their default templates are listed in the Configuration Reference.
directories
unshackle cfg
You do not have to edit unshackle.yaml by hand. The unshackle cfg command reads and writes individual values for you, creating the config file (and its parent directory) if it does not exist yet.
unshackle.yaml
Read a single value by passing its key. Nested keys use dot notation:
shaka-packager is the default decryptor
unshackle decrypts with shaka-packager unless you explicitly configure a different decryptor. If it is missing, protected downloads will fail at the -decryption step. See the configuration reference for the +decryption step. See the configuration reference for the decryption key if you want to switch to mp4decrypt.
decryption
mp4decrypt
These flags select languages, they do not order them
Naming languages with -l or -sl removes the others. To keep every language but put your preferred ones first, use audio.language_priority and -subtitle.language_priority in your +subtitle.language_priority in your configuration file.
-l
-sl
audio.language_priority
subtitle.language_priority
The special language tokens orig, all, and best are honoured everywhere a language is expected.
orig
all
best
See subtitle.language_priority for the details.
By default language matching is fuzzy: -l en also accepts en-US, en-GB, etc. (up to a small distance). Pass --exact-lang to require an exact match: with it, -l es-419 diff --git a/guide/drm-and-cdm/index.html b/guide/drm-and-cdm/index.html index c8451c76..ec4a5f37 100644 --- a/guide/drm-and-cdm/index.html +++ b/guide/drm-and-cdm/index.html @@ -1225,6 +1225,26 @@ + + + + + + + + + + + + + + + + + + + + @@ -1242,8 +1262,9 @@ - - + + + @@ -1257,8 +1278,14 @@ - - + + + + + + + + @@ -1272,20 +1299,246 @@ + + - + - Reference + Directories + + + + + + + + + + + + + + + + + + + + + + + + + + + + Services & Authentication + + + + + + + + + + + + + + + + + + + + + + + + + + + + Download & Processing + + + + + + + + + + + + + + + + + + + + + + + + + + + + Output & Naming + + + + + + + + + + + + + + + + + + + + + + + + + + + + DRM & CDM + + + + + + + + + + + + + + + + + + + + + + + + + + + + Network & Proxy + + + + + + + + + + + + + + + + + + + + + + + + + + + + Key Vaults + + + + + + + + + + + + + + + + + + + + + + + + + + + + Other Settings + + + + + + + + + + + + + + + + + + + + + + + + + + + + Annotated Example diff --git a/guide/output-and-naming/index.html b/guide/output-and-naming/index.html index 1c47057c..b6fc98ac 100644 --- a/guide/output-and-naming/index.html +++ b/guide/output-and-naming/index.html @@ -1180,6 +1180,26 @@ + + + + + + + + + + + + + + + + + + + + @@ -1197,8 +1217,9 @@ - - + + + @@ -1212,8 +1233,14 @@ - - + + + + + + + + @@ -1227,20 +1254,246 @@ + + - + - Reference + Directories + + + + + + + + + + + + + + + + + + + + + + + + + + + + Services & Authentication + + + + + + + + + + + + + + + + + + + + + + + + + + + + Download & Processing + + + + + + + + + + + + + + + + + + + + + + + + + + + + Output & Naming + + + + + + + + + + + + + + + + + + + + + + + + + + + + DRM & CDM + + + + + + + + + + + + + + + + + + + + + + + + + + + + Network & Proxy + + + + + + + + + + + + + + + + + + + + + + + + + + + + Key Vaults + + + + + + + + + + + + + + + + + + + + + + + + + + + + Other Settings + + + + + + + + + + + + + + + + + + + + + + + + + + + + Annotated Example @@ -2398,7 +2651,7 @@ For an episode with no on-screen name, {episode_name?} and its adja dual -DUAL for two audio languages (see dual_multi_mode) +DUAL for two audio languages (see dual_multi_mode) DUAL @@ -2561,10 +2814,10 @@ For an episode with no on-screen name, {episode_name?} and its adja The --no-mux flag skips muxing entirely and writes the individual track files, each with a track-type suffix, into the same output/folder structure. Tags & group naming¶ The release-group tag is the -TAG portion at the end of scene-style names, produced by the {tag} variable. -It can be swapped per release with tag_rules: ordered rules that +It can be swapped per release with tag_rules: ordered rules that match on the release-attribute variables only (quality, resolution, hdr, source, lang_tag, title_type, and so on), first match wins. The title's own fields, such as title and season_episode, -cannot be matched. See the reference page for the exact list. +cannot be matched. See the reference page for the exact list. unshackle.yamltag: "MYGROUP" tag_group_name: true tag_imdb_tmdb: true @@ -2789,7 +3042,7 @@ so Season {season} keeps its space even though it holds only one va Place {dual?}, {multi?} and {dubbed?} next to each other. At most one of them is -ever set (see dual_multi_mode), and the +ever set (see dual_multi_mode), and the empty ones collapse: output_template: movies: "{title}.{year}.{quality}.{source}.WEB-DL.{dual?}.{multi?}.{dubbed?}.{audio_full}.{video}-{tag}" @@ -2808,7 +3061,7 @@ three variables is set: The.Movie.2024.1080p.EXAMPLE.WEB-DL.DDP5.1.H.264-TAG.mkv For finer control (e.g. a SUBBED tag driven by subtitle languages), use {lang_tag?} -with language_tags rules instead. +with language_tags rules instead. Dated content needs no special template. When an episode carries an air date, diff --git a/guide/proxies-and-vpn/index.html b/guide/proxies-and-vpn/index.html index b81938a6..69f8bf96 100644 --- a/guide/proxies-and-vpn/index.html +++ b/guide/proxies-and-vpn/index.html @@ -1191,6 +1191,26 @@ + + + + + + + + + + + + + + + + + + + + @@ -1208,8 +1228,9 @@ - - + + + @@ -1223,8 +1244,14 @@ - - + + + + + + + + @@ -1238,20 +1265,246 @@ + + - + - Reference + Directories + + + + + + + + + + + + + + + + + + + + + + + + + + + + Services & Authentication + + + + + + + + + + + + + + + + + + + + + + + + + + + + Download & Processing + + + + + + + + + + + + + + + + + + + + + + + + + + + + Output & Naming + + + + + + + + + + + + + + + + + + + + + + + + + + + + DRM & CDM + + + + + + + + + + + + + + + + + + + + + + + + + + + + Network & Proxy + + + + + + + + + + + + + + + + + + + + + + + + + + + + Key Vaults + + + + + + + + + + + + + + + + + + + + + + + + + + + + Other Settings + + + + + + + + + + + + + + + + + + + + + + + + + + + + Annotated Example diff --git a/guide/subtitles/index.html b/guide/subtitles/index.html index 2d10ac8c..764ab7d4 100644 --- a/guide/subtitles/index.html +++ b/guide/subtitles/index.html @@ -1153,6 +1153,26 @@ + + + + + + + + + + + + + + + + + + + + @@ -1170,8 +1190,9 @@ - - + + + @@ -1185,8 +1206,14 @@ - - + + + + + + + + @@ -1200,20 +1227,246 @@ + + - + - Reference + Directories + + + + + + + + + + + + + + + + + + + + + + + + + + + + Services & Authentication + + + + + + + + + + + + + + + + + + + + + + + + + + + + Download & Processing + + + + + + + + + + + + + + + + + + + + + + + + + + + + Output & Naming + + + + + + + + + + + + + + + + + + + + + + + + + + + + DRM & CDM + + + + + + + + + + + + + + + + + + + + + + + + + + + + Network & Proxy + + + + + + + + + + + + + + + + + + + + + + + + + + + + Key Vaults + + + + + + + + + + + + + + + + + + + + + + + + + + + + Other Settings + + + + + + + + + + + + + + + + + + + + + + + + + + + + Annotated Example @@ -2295,8 +2548,8 @@ For the purposes of hearing-impaired handling, SDH and CC tracks are grouped as By default this type order is the primary sort, so all forced tracks come first, then all normal tracks, then all SDH/CC tracks, each block sorted by language. To keep each language next to its own variants instead, set -subtitle.group_by to language. Use -subtitle.type_priority to change the +subtitle.group_by to language. Use +subtitle.type_priority to change the Forced → Normal → SDH/CC order itself. A single track cannot be both CC and SDH, and a forced track cannot also be flagged diff --git a/guide/troubleshooting/index.html b/guide/troubleshooting/index.html index 5af06d99..e82b7887 100644 --- a/guide/troubleshooting/index.html +++ b/guide/troubleshooting/index.html @@ -1136,6 +1136,26 @@ + + + + + + + + + + + + + + + + + + + + @@ -1153,8 +1173,9 @@ - - + + + @@ -1168,8 +1189,14 @@ - - + + + + + + + + @@ -1183,20 +1210,246 @@ + + - + - Reference + Directories + + + + + + + + + + + + + + + + + + + + + + + + + + + + Services & Authentication + + + + + + + + + + + + + + + + + + + + + + + + + + + + Download & Processing + + + + + + + + + + + + + + + + + + + + + + + + + + + + Output & Naming + + + + + + + + + + + + + + + + + + + + + + + + + + + + DRM & CDM + + + + + + + + + + + + + + + + + + + + + + + + + + + + Network & Proxy + + + + + + + + + + + + + + + + + + + + + + + + + + + + Key Vaults + + + + + + + + + + + + + + + + + + + + + + + + + + + + Other Settings + + + + + + + + + + + + + + + + + + + + + + + + + + + + Annotated Example @@ -2387,13 +2640,13 @@ - +
-l en
en-US
en-GB
--exact-lang
-l es-419
{episode_name?}
dual
DUAL
dual_multi_mode
The --no-mux flag skips muxing entirely and writes the individual track files, each with a track-type suffix, into the same output/folder structure.
--no-mux
The release-group tag is the -TAG portion at the end of scene-style names, produced by the {tag} variable. -It can be swapped per release with tag_rules: ordered rules that +It can be swapped per release with tag_rules: ordered rules that match on the release-attribute variables only (quality, resolution, hdr, source, lang_tag, title_type, and so on), first match wins. The title's own fields, such as title and season_episode, -cannot be matched. See the reference page for the exact list.
-TAG
{tag}
tag_rules
quality
resolution
hdr
source
lang_tag
title_type
title
season_episode
tag: "MYGROUP" tag_group_name: true tag_imdb_tmdb: true @@ -2789,7 +3042,7 @@ so Season {season} keeps its space even though it holds only one va
Season {season}
Place {dual?}, {multi?} and {dubbed?} next to each other. At most one of them is -ever set (see dual_multi_mode), and the +ever set (see dual_multi_mode), and the empty ones collapse:
{dual?}
{multi?}
{dubbed?}
output_template: movies: "{title}.{year}.{quality}.{source}.WEB-DL.{dual?}.{multi?}.{dubbed?}.{audio_full}.{video}-{tag}" @@ -2808,7 +3061,7 @@ three variables is set: The.Movie.2024.1080p.EXAMPLE.WEB-DL.DDP5.1.H.264-TAG.mkv For finer control (e.g. a SUBBED tag driven by subtitle languages), use {lang_tag?} -with language_tags rules instead. +with language_tags rules instead.
The.Movie.2024.1080p.EXAMPLE.WEB-DL.DDP5.1.H.264-TAG.mkv
For finer control (e.g. a SUBBED tag driven by subtitle languages), use {lang_tag?} -with language_tags rules instead.
SUBBED
{lang_tag?}
language_tags
Dated content needs no special template. When an episode carries an air date, diff --git a/guide/proxies-and-vpn/index.html b/guide/proxies-and-vpn/index.html index b81938a6..69f8bf96 100644 --- a/guide/proxies-and-vpn/index.html +++ b/guide/proxies-and-vpn/index.html @@ -1191,6 +1191,26 @@ + + + + + + + + + + + + + + + + + + + + @@ -1208,8 +1228,9 @@ - - + + + @@ -1223,8 +1244,14 @@ - - + + + + + + + + @@ -1238,20 +1265,246 @@ + + - + - Reference + Directories + + + + + + + + + + + + + + + + + + + + + + + + + + + + Services & Authentication + + + + + + + + + + + + + + + + + + + + + + + + + + + + Download & Processing + + + + + + + + + + + + + + + + + + + + + + + + + + + + Output & Naming + + + + + + + + + + + + + + + + + + + + + + + + + + + + DRM & CDM + + + + + + + + + + + + + + + + + + + + + + + + + + + + Network & Proxy + + + + + + + + + + + + + + + + + + + + + + + + + + + + Key Vaults + + + + + + + + + + + + + + + + + + + + + + + + + + + + Other Settings + + + + + + + + + + + + + + + + + + + + + + + + + + + + Annotated Example diff --git a/guide/subtitles/index.html b/guide/subtitles/index.html index 2d10ac8c..764ab7d4 100644 --- a/guide/subtitles/index.html +++ b/guide/subtitles/index.html @@ -1153,6 +1153,26 @@ + + + + + + + + + + + + + + + + + + + + @@ -1170,8 +1190,9 @@ - - + + + @@ -1185,8 +1206,14 @@ - - + + + + + + + + @@ -1200,20 +1227,246 @@ + + - + - Reference + Directories + + + + + + + + + + + + + + + + + + + + + + + + + + + + Services & Authentication + + + + + + + + + + + + + + + + + + + + + + + + + + + + Download & Processing + + + + + + + + + + + + + + + + + + + + + + + + + + + + Output & Naming + + + + + + + + + + + + + + + + + + + + + + + + + + + + DRM & CDM + + + + + + + + + + + + + + + + + + + + + + + + + + + + Network & Proxy + + + + + + + + + + + + + + + + + + + + + + + + + + + + Key Vaults + + + + + + + + + + + + + + + + + + + + + + + + + + + + Other Settings + + + + + + + + + + + + + + + + + + + + + + + + + + + + Annotated Example @@ -2295,8 +2548,8 @@ For the purposes of hearing-impaired handling, SDH and CC tracks are grouped as By default this type order is the primary sort, so all forced tracks come first, then all normal tracks, then all SDH/CC tracks, each block sorted by language. To keep each language next to its own variants instead, set -subtitle.group_by to language. Use -subtitle.type_priority to change the +subtitle.group_by to language. Use +subtitle.type_priority to change the Forced → Normal → SDH/CC order itself.
By default this type order is the primary sort, so all forced tracks come first, then all normal tracks, then all SDH/CC tracks, each block sorted by language. To keep each language next to its own variants instead, set -subtitle.group_by to language. Use -subtitle.type_priority to change the +subtitle.group_by to language. Use +subtitle.type_priority to change the Forced → Normal → SDH/CC order itself.
subtitle.group_by
language
subtitle.type_priority
A single track cannot be both CC and SDH, and a forced track cannot also be flagged diff --git a/guide/troubleshooting/index.html b/guide/troubleshooting/index.html index 5af06d99..e82b7887 100644 --- a/guide/troubleshooting/index.html +++ b/guide/troubleshooting/index.html @@ -1136,6 +1136,26 @@ + + + + + + + + + + + + + + + + + + + + @@ -1153,8 +1173,9 @@ - - + + + @@ -1168,8 +1189,14 @@ - - + + + + + + + + @@ -1183,20 +1210,246 @@ + + - + - Reference + Directories + + + + + + + + + + + + + + + + + + + + + + + + + + + + Services & Authentication + + + + + + + + + + + + + + + + + + + + + + + + + + + + Download & Processing + + + + + + + + + + + + + + + + + + + + + + + + + + + + Output & Naming + + + + + + + + + + + + + + + + + + + + + + + + + + + + DRM & CDM + + + + + + + + + + + + + + + + + + + + + + + + + + + + Network & Proxy + + + + + + + + + + + + + + + + + + + + + + + + + + + + Key Vaults + + + + + + + + + + + + + + + + + + + + + + + + + + + + Other Settings + + + + + + + + + + + + + + + + + + + + + + + + + + + + Annotated Example @@ -2387,13 +2640,13 @@ - +