Config

For ease of use Tv Renamr uses a config file. By default it looks for it in ~/.tvrenamr/config.yml, an example is listed below which shows all the possible default values you can use.

Defaults

The defaults segment should be self-explanatory but I’ll list them just for completeness. The listed values are the assumed defaults if any of the options are not added.

Format

The output format for files to be renamed to.

format: '%n - %s%e - %t%x'
  • %n: Show name
  • %s: Season Number
  • %e: Episode Number
  • %t: Episode Title
  • %x: Extension

Note

The extension part includes the period (.) part of the file’s extension and is also optional.

Library

The online database to use for episode names. Options are: thetvdb or tvrage

library: thetvdb

Organise

Organise your files within the renamed directory.

organise: yes

Renamed

The directory to move your renamed files to.

renamed: /Volumes/Media/TV/

The

If a show has a leading ‘The’, such as ‘The Big Bang Theory’, move it to the end of the show name, i.e. ‘Big Bang Theory, The’.

the: true

Tv Shows

Below the defaults are shows that won’t get renamed correctly using the default options. Taking CSI as the example you have:

csi:
    canonical: "CSI: Crime Scene Investigation"
    output: "CSI, Crime Scene Investigation"

Show Name

In the above example csi is used to match the show name in the downloaded file name, which might look something like this csi.s10e01.blah.blah.avi.

Canonical

The name used by the online database(s) for a show.

Since The TVDb and Tv Rage both list CSI as CSI: Crime Scene Investigation the canonical option is used.

canonical: "CSI: Crime Scene Investigation"

Note

This method is the easiest way to deal with shows with a year in the name too, i.e. Castle (2009).

Output

The show name to use when writing the new filename.

The canonical show name contains a colon which most filesystems won’t play nice with

output: "CSI, Crime Scene Investigation"

Format

The output format to use when writing the new filename.

format: %n - %s%e

Warning

The colon (:) and comma (,) characters are reserved in YAML so must be quoted.

defaults:
  format: '%n - %s%e - %t%x'
  library: thetvdb
  organise: yes
  renamed: /Volumes/Media/TV/
  the: true

'24':
  format: '%n - %s%e'

american dad:
  canonical: American Dad!

castle 2009:
  canonical: Castle (2009)

csi:
  canonical: "CSI: Crime Scene Investigation"
  output: "CSI, Crime Scene Investigation"

doctor who 2005:
  canonical: Doctor Who (2005)

the it crowd:
  the: false

the simpsons:
  the: false

v 2009:
  canonical: V (2009)
  output: V
Read the Docs v: 3.3.3
Versions
latest
3.4.0
3.3.3
3.3.2
3.3.1
3.3
3.2.1
3.2.0
3.1.0
3.0.3
3.0.2
3.0.1
3.0.0
2.2.7
Downloads
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.