mirror of
https://github.com/unshackle-dl/unshackle.git
synced 2026-11-14 21:15:06 +00:00
Deployed b8824b8 with MkDocs version: 1.6.1
This commit is contained in:
@@ -846,6 +846,23 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
<nav class="md-nav" aria-label="Metadata & tagging">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#episode-ordering" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
Episode ordering
|
||||
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -2162,6 +2179,23 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
<nav class="md-nav" aria-label="Metadata & tagging">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#episode-ordering" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
Episode ordering
|
||||
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -2872,15 +2906,34 @@
|
||||
<td>IMDb ID, e.g. <code>tt1375666</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--tvdb</code></td>
|
||||
<td>TVDB ID (integer). Skips the series lookup that <code>--tvdb-order</code> would otherwise do.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--animeapi</code></td>
|
||||
<td>AnimeAPI ID, e.g. <code>mal:12345</code> or <code>anilist:98765</code> (defaults to MAL). Back-fills TMDB/IMDb.</td>
|
||||
<td>AnimeAPI ID, e.g. <code>mal:12345</code> or <code>anilist:98765</code> (defaults to MAL). Back-fills TMDB/IMDb/TVDB.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--enrich</code></td>
|
||||
<td>Override show title/year from the external source. <strong>Requires</strong> one of <code>--tmdb</code>, <code>--imdb</code>, or <code>--animeapi</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--tvdb-order</code></td>
|
||||
<td>Renumber episodes to a TVDB season order: <code>official</code> (aired), <code>dvd</code>, <code>absolute</code>, <code>alternate</code>, or <code>regional</code>. Needs <code>tvdb_api_key</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="episode-ordering">Episode ordering<a class="headerlink" href="#episode-ordering" title="Permanent link">¶</a></h4>
|
||||
<p>A service does not always number a series the way TVDB's aired order does. Some services list
|
||||
Futurama in TVDB's <code>alternate</code> (Streaming) order, for example. <code>--tvdb-order</code> works out which
|
||||
order the service used, then renumbers the episodes into the order you asked for.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Orders that do not cover the whole series</p>
|
||||
<p>An order can omit episodes the service carries; TVDB's <code>dvd</code> order for Futurama leaves out
|
||||
the four movies. Those episodes keep their original numbering. If that would give two
|
||||
episodes the same season/episode slot, and so the same filename, unshackle logs an error
|
||||
and keeps the service's numbering unchanged. Pick an order that covers the whole series.</p>
|
||||
</div>
|
||||
<h3 id="drm-keys-decryption">DRM, keys & decryption<a class="headerlink" href="#drm-keys-decryption" title="Permanent link">¶</a></h3>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@@ -1140,6 +1140,23 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
<nav class="md-nav" aria-label="Metadata and tagging">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#episode-ordering" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
Episode ordering
|
||||
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -2491,6 +2508,23 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
<nav class="md-nav" aria-label="Metadata and tagging">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#episode-ordering" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
Episode ordering
|
||||
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -3206,6 +3240,11 @@ tagging and naming:</p>
|
||||
<td>Use this IMDb ID.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--tvdb</code></td>
|
||||
<td><code>--tvdb 73871</code></td>
|
||||
<td>Use this TVDB ID instead of looking the series up.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--animeapi</code></td>
|
||||
<td><code>--animeapi mal:12345</code></td>
|
||||
<td>Resolve via AnimeAPI (<code>mal:</code>/<code>anilist:</code> prefix; defaults to MAL).</td>
|
||||
@@ -3215,10 +3254,31 @@ tagging and naming:</p>
|
||||
<td>-</td>
|
||||
<td>Override the show title and year from an external source. <strong>Requires</strong> one of <code>--tmdb</code>, <code>--imdb</code>, or <code>--animeapi</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--tvdb-order</code></td>
|
||||
<td><code>--tvdb-order dvd</code></td>
|
||||
<td>Renumber episodes to a TVDB season order. Needs <code>tvdb_api_key</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="language-shell highlight"><span class="filename">Force the right IMDb match and enrich the title</span><pre><span></span><code><span id="__span-28-1"><a id="__codelineno-28-1" name="__codelineno-28-1" href="#__codelineno-28-1"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>--imdb<span class="w"> </span>tt1375666<span class="w"> </span>--enrich<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span>
|
||||
</span></code></pre></div>
|
||||
<h3 id="episode-ordering">Episode ordering<a class="headerlink" href="#episode-ordering" title="Permanent link">¶</a></h3>
|
||||
<p>A service does not always number a series the way TVDB's aired order does. Some services list
|
||||
Futurama in TVDB's <code>alternate</code> (Streaming) order, for example, while TVDB's <code>official</code> order
|
||||
holds back four season-one episodes to the start of season two. <code>--tvdb-order</code> works out which
|
||||
order the service used, then renumbers the episodes into the order you asked for:</p>
|
||||
<div class="language-shell highlight"><span class="filename">Download Futurama in DVD order</span><pre><span></span><code><span id="__span-29-1"><a id="__codelineno-29-1" name="__codelineno-29-1" href="#__codelineno-29-1"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>--tvdb-order<span class="w"> </span>dvd<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span>
|
||||
</span></code></pre></div>
|
||||
<p>Available orders are <code>official</code> (aired), <code>dvd</code>, <code>absolute</code>, <code>alternate</code>, and <code>regional</code>. Set
|
||||
<code>tvdb_order</code> in your config to apply one by default.</p>
|
||||
<div class="admonition warning">
|
||||
<p class="admonition-title">Orders that do not cover the whole series</p>
|
||||
<p>An order can leave out episodes the service carries. TVDB's <code>dvd</code> order does not list
|
||||
Futurama's four movies. Those episodes keep their original numbering. If that would give
|
||||
two episodes the same season/episode slot, and so the same filename, unshackle logs an
|
||||
error and leaves the numbering untouched. Pick an order that covers the whole series.</p>
|
||||
</div>
|
||||
<h2 id="configuration-defaults">Configuration defaults<a class="headerlink" href="#configuration-defaults" title="Permanent link">¶</a></h2>
|
||||
<p>Every flag on this page can be set as a default in your configuration file so you don't
|
||||
have to type it each time, and defaults can be scoped per service. See
|
||||
@@ -3373,10 +3433,15 @@ authoritative list.</p>
|
||||
<td>Export track info and keys to JSON.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--tmdb</code> / <code>--imdb</code> / <code>--animeapi</code> / <code>--enrich</code></td>
|
||||
<td><code>--tmdb</code> / <code>--imdb</code> / <code>--tvdb</code> / <code>--animeapi</code> / <code>--enrich</code></td>
|
||||
<td></td>
|
||||
<td>Metadata overrides.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--tvdb-order</code></td>
|
||||
<td></td>
|
||||
<td>Renumber episodes to a TVDB season order.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
@@ -2586,10 +2586,13 @@ For an episode with no on-screen name, <code>{episode_name?}</code> and its adja
|
||||
<td><code>tag_imdb_tmdb</code></td>
|
||||
<td>bool</td>
|
||||
<td><code>true</code></td>
|
||||
<td>Look up and embed IMDb / TMDB / TVDB external-ID tags in the MKV metadata (uses <code>tmdb_api_key</code> / <code>simkl_client_id</code> when available).</td>
|
||||
<td>Look up and embed IMDb / TMDB / TVDB external-ID tags in the MKV metadata (uses <code>tmdb_api_key</code> / <code>tvdb_api_key</code> / <code>simkl_client_id</code> when available).</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>The IDs are written as the Matroska <code>IMDB</code>, <code>TMDB</code>, and <code>TVDB2</code> tags. <code>TVDB2</code> values carry the
|
||||
entity prefix the <a href="https://www.matroska.org/technical/tagging.html">Matroska tagging spec</a>
|
||||
requires: <code>series/73871</code> for a show, <code>movies/113</code> for a film.</p>
|
||||
<p>You can override the tag per run without editing config:</p>
|
||||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-12-1"><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>--tag<span class="w"> </span>OTHERGROUP<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="s2">"..."</span>
|
||||
</span></code></pre></div>
|
||||
|
||||
@@ -2277,9 +2277,15 @@ flags drive selection, sort order, output filenames, and the Matroska track flag
|
||||
</ul>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">SDH and CC are treated together for sorting and stripping</p>
|
||||
<p>Within a language, unshackle orders subtitles from fewest to most captions:
|
||||
<strong>Forced → Normal → SDH/CC</strong>. For the purposes of hearing-impaired handling, SDH and
|
||||
CC tracks are grouped as the "most captions" variant.</p>
|
||||
<p>unshackle orders subtitles from fewest to most captions: <strong>Forced → Normal → SDH/CC</strong>.
|
||||
For the purposes of hearing-impaired handling, SDH and CC tracks are grouped as the
|
||||
"most captions" variant.</p>
|
||||
<p>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
|
||||
<a href="../../reference/configuration/#subtitle"><code>subtitle.group_by</code></a> to <code>language</code>. Use
|
||||
<a href="../../reference/configuration/#subtitle"><code>subtitle.type_priority</code></a> to change the
|
||||
Forced → Normal → SDH/CC order itself.</p>
|
||||
</div>
|
||||
<p>A single track cannot be both CC and SDH, and a forced track cannot also be flagged
|
||||
CC or SDH. These combinations are rejected as invalid.</p>
|
||||
|
||||
Reference in New Issue
Block a user