docs: split configuration reference into per-area pages

This commit is contained in:
imSp4rky
2026-08-04 10:25:32 -06:00
parent 051f1e668f
commit c4b25756eb
22 changed files with 1169 additions and 1002 deletions
+1 -1
View File
@@ -103,7 +103,7 @@ unshackle dl [OPTIONS] SERVICE [SERVICE ARGS...]
!!! tip "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`](../reference/configuration.md#subtitle) in your
[`subtitle.language_priority`](../reference/configuration/download.md#subtitle) in your
configuration file.
The special language tokens `orig`, `all`, and `best` are honoured everywhere a language is expected.
+1 -1
View File
@@ -272,7 +272,7 @@ alphabetically, after the title's original language. Nothing is removed. Audio w
same way, but the languages you leave out keep their bitrate and codec order instead of an
alphabetical one.
See [`subtitle.language_priority`](../reference/configuration.md#subtitle) for the details.
See [`subtitle.language_priority`](../reference/configuration/download.md#subtitle) for the details.
### Exact vs fuzzy matching
+1 -1
View File
@@ -516,5 +516,5 @@ debug_requests: true
- [Downloading](downloading.md): the `dl` command and its DRM-related flags.
- [Key vaults](vaults.md): caching content keys across downloads.
- [Configuration](../reference/configuration.md): the full `unshackle.yaml` reference.
- [Configuration](../reference/configuration/index.md): the full `unshackle.yaml` reference.
- [Dependencies](../getting-started/installation.md): installing shaka-packager and mp4decrypt.
+8 -3
View File
@@ -102,6 +102,7 @@ Every variable below is valid in both output and folder templates. Values are de
| Variable | Meaning | Example |
|---|---|---|
| `title` | Title name (movie/show/song name; `$` is rendered as `S`) | `The Show` |
| `title_type` | Media kind of the title | `movie`, `series`, `music` |
| `year` | Release year | `2024` |
| `source` | Service tag / class name (empty with `--no-source`) | `EXAMPLE` |
| `quality` | Resolution with scan suffix | `1080p`, `2160p`, `576i` |
@@ -138,7 +139,7 @@ Every variable below is valid in both output and folder templates. Values are de
| `audio_channels` | Channel layout | `5.1`, `2.0` |
| `audio_full` | Codec + channels combined | `DDP5.1` |
| `atmos` | `Atmos` when any track carries JOC | `Atmos` |
| `dual` | `DUAL` for two audio languages (see [`dual_multi_mode`](../reference/configuration.md#dual_multi_mode)) | `DUAL` |
| `dual` | `DUAL` for two audio languages (see [`dual_multi_mode`](../reference/configuration/download.md#dual_multi_mode)) | `DUAL` |
| `multi` | `MULTi` for more than two audio languages | `MULTi` |
| `dubbed` | `DUBBED` for a single audio language that is not the original (strict mode only) | `DUBBED` |
@@ -234,6 +235,10 @@ The `--no-mux` flag skips muxing entirely and writes the individual track files,
## 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`](../reference/configuration/output.md#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](../reference/configuration/output.md#tag_rules) for the exact list.
```yaml title="unshackle.yaml"
tag: "MYGROUP"
@@ -405,7 +410,7 @@ how the optional (`?`) variables appear and disappear.
=== "Multi-language"
Place `{dual?}`, `{multi?}` and `{dubbed?}` next to each other. At most one of them is
ever set (see [`dual_multi_mode`](../reference/configuration.md#dual_multi_mode)), and the
ever set (see [`dual_multi_mode`](../reference/configuration/download.md#dual_multi_mode)), and the
empty ones collapse:
```yaml
@@ -439,7 +444,7 @@ how the optional (`?`) variables appear and disappear.
```
For finer control (e.g. a `SUBBED` tag driven by subtitle languages), use `{lang_tag?}`
with [`language_tags` rules](../reference/configuration.md#language_tags) instead.
with [`language_tags` rules](../reference/configuration/download.md#language_tags) instead.
=== "Daily shows"
+2 -2
View File
@@ -154,8 +154,8 @@ flags drive selection, sort order, output filenames, and the Matroska track flag
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`](../reference/configuration.md#subtitle) to `language`. Use
[`subtitle.type_priority`](../reference/configuration.md#subtitle) to change the
[`subtitle.group_by`](../reference/configuration/download.md#subtitle) to `language`. Use
[`subtitle.type_priority`](../reference/configuration/download.md#subtitle) 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