-
Notifications
You must be signed in to change notification settings - Fork 5
/
sorttv.conf
258 lines (215 loc) · 10.2 KB
/
sorttv.conf
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# This config file is optional, but is an easy way to configure SortTV.
# Simply place it in the same directory as SortTV.
#
# The lines that start with a # are for your information, and are ignored by SortTV.
# Edit the settings in this file to suit your needs.
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# ~~~~~~~~~~~
# Directories
# ~~~~~~~~~~~
# The new files to sort
# For example, set this to where completed downloads are stored
directory-to-sort:/home/cliffe/Files/Downloads/Unsorted
# Where to sort episodes into (dir that will contain dirs for each show)
# This directory will contain the structure (Show)/(Seasons)/(episodes)
# Alternatively set this to "KEEP_IN_SAME_DIRECTORIES" for a recursive renaming of files in directory-to-sort
directory-to-sort-into:/home/cliffe/Files/Media/TV
# Where to sort music into
# If not specified, music is not moved
sort-music-to:/home/cliffe/Files/Media/Music
# OPTIONAL - where to put things that are not episodes
# If this is supplied then files and directories that SortTV does not believe are episodes will be moved here
# If not specified, non-episodes are not moved
non-episode-dir:/home/cliffe/Files/Downloads/Non-episodes
# ~~~~~~~~~~~~~~~~~~~
# Which files to sort
# ~~~~~~~~~~~~~~~~~~~
# OPTIONAL - only sort if the file matches one of these
# uses shell-like simple pattern matches
whitelist:*
# OPTIONAL - don't sort if the file matches one of these
blacklist:*.uc!
blacklist:*.uc
blacklist:*.torrent
blacklist:sample*
blacklist:*.part
# don't sort compressed files, their contents will be extracted and sorted
blacklist:*.rar
blacklist:*.zip
blacklist:*.7z
blacklist:*.gz
blacklist:*.bz2
# OPTIONAL - sort files which fall within these ranges. Filesizes use the MB and GB postfixes,
# such as 170MB-400MB or 1.0GB-1.2GB. If no postfix specified, MB is assumed.
# The following ranges can be enabled by removing the leading '#':
#filesize-range:170MB-400MB
#filesize-range:1.05GB-1.15GB
#filesize-range:697MB-700MB
# OPTIONAL - Sort only files or directories that are older than this number of days
# A value of zero sorts everything.
# This may be useful if you rsync your media from a remote server.
sort-only-older-than-days:0
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~
# Output and xbmc integration
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~
# OPTIONAL - host:port for xbmc webserver, to automatically update library when new episodes arrive
# You probably want to set this to "localhost:8080". Remember to "allow control of xbmc via HTTP", and "set the content" of your TV directory in xbmc.
# If not specified, xbmc is not updated
# xbmc-web-server:
# OPTIONAL - log to this file
# If not specified, output goes to sorttv.log in the script directory
# log-file:
# OPTIONAL - Output verbosity. Set to TRUE to show messages describing the decision making process.
# TRUE/FALSE
# If not specified, FALSE
verbose:FALSE
# ~~~~~~~~~~~~~~~
# Download images
# ~~~~~~~~~~~~~~~
# OPTIONAL - Download images for shows, seasons, and episodes from thetvdb
# Downloaded images are copied into the sort-to (destination) directory.
# NEW_SHOWS - When new shows, seasons, or episodes are created the associated images are downloaded
# FALSE - No images are downloaded
# NEW_SHOWS/FALSE
# if not specified, NEW_SHOWS
fetch-images:NEW_SHOWS
# OPTIONAL - Sets the image format to use, poster or banner.
# POSTER/BANNER
# if not specified, POSTER
images-format:POSTER
# ~~~~~~~~~~~~~
# File renaming
# ~~~~~~~~~~~~~
# OPTIONAL - rename episodes to a new format when moving
# TRUE/FALSE
# If not specified, FALSE
rename-episodes:TRUE
# Optional - the format to use if renaming to a new format (as specified above)
# Hint: including the Episode Title as part of the name slows the process down a bit since titles are retrieved from thetvdb.com
# The format can be made up of:
# [SHOW_NAME]: "My Show"
# [EP1]: "S01E01"
# [EP2]: "1x1"
# [EP3]: "1x01"
# [EP_NAME1] " - Episode Title"
# [EP_NAME2] ".Episode Title"
# If not specified the format is, "[SHOW_NAME] - [EP1][EP_NAME1]"
#
# Examples: (remove the # from the renameformat line that follows the example filename you want)
# for "My Show - S01E01 - Episode Title" (this is the default)
rename-format:[SHOW_NAME] - [EP1][EP_NAME1]
# for "My Show - S01E01"
#rename-format:[SHOW_NAME] - [EP1]
# for "My Show.S01E01.Episode Title"
#rename-format:[SHOW_NAME].[EP1][EP_NAME2]
# for "My Show - S01E01 - Episode Title"
#rename-format:[SHOW_NAME] - [EP1][EP_NAME1]
# for "My Show - 1x1 - Episode Title"
#rename-format:[SHOW_NAME] - [EP2][EP_NAME1]
# for "My Show - 1x01 - Episode Title"
#rename-format:[SHOW_NAME] - [EP3][EP_NAME1]
# OPTIONAL - renames episodes to replace spaces with dots
# TRUE/FALSE
# If not specified, FALSE
use-dots-instead-of-spaces:FALSE
# Substitute the titles of these shows
show-name-substitute:CSI-->CSI: Crime Scene Investigation
show-name-substitute:CSI Crime Scene Investigation-->CSI: Crime Scene Investigation
show-name-substitute:Sanctuary US-->Sanctuary
show-name-substitute:Shit My Dad Says-->$#*! My Dad Says
show-name-substitute:ABC - Two and a Half Men-->Two and a Half Men
show-name-substitute:test-->Test this
show-name-substitute:Its Always Sunny in Philadelphia-->It's Always Sunny in Philadelphia
show-name-substitute:American Dad-->American Dad!
# ~~~~~~~~~~~~~~~~
# Directory naming
# ~~~~~~~~~~~~~~~~
# OPTIONAL - Season title (eg "Season " -> "Season 1", "Series "->"Series 1", "Season."->"Season.1")
# Note: if you want a space it needs to be included
# If not specified, "Season "
season-title:Season
# OPTIONAL - Season format padded to double digits (eg "Season 01" rather than "Season 1")
# TRUE/FALSE
# If not specified, FALSE
season-double-digits:FALSE
# ~~~~~~~~~~~~~~~~
# Matching options
# ~~~~~~~~~~~~~~~~
# OPTIONAL - Match type. LIBERAL assumes all files are episodes and tries to extract season and episode number any way possible.
# LIBERAL/NORMAL
# If not specified, NORMAL
match-type:NORMAL
# OPTIONAL - Attempt to sort files that are named after the episode title or air date.
# For example, "My show - My episode title.avi" or "My show - 2010-12-12.avi"
# could become "My Show - S01E01 - My episode title.avi"
# Attempts to lookup the season and episode number based on the episodes in thetvdb.com database.
# Since this involves downloading the list of episodes from the Internet, this will cause a slower sort.
# TRUE/FALSE
# If not specified, TRUE
match-files-based-on-tvdb-lookups:TRUE
# Use these tvdb IDs to lookup these shows
tvdb-id-substitute:$#*! My Dad Says-->164951
tvdb-id-substitute:$#-! My Dad Says-->164951
tvdb-id-substitute:Shit My Dad Says-->164951
tvdb-id-substitute:Test this-->164951
# Define additional extensions for music files (SortTV knows a lot already)
music-extension:mp3
# ~~~~~~~~~~~~~~~
# Other Behaviour
# ~~~~~~~~~~~~~~~
# OPTIONAL - Sort by moving or copying the file. If the file already exists because it was already copied it is silently skipped.
# the MOVE-AND-LEAVE-SYMLINK-BEHIND option may be handy if you want to continue to seed after sorting, this leaves a symlink in place of the newly moved file
# PLACE-SYMLINK does not move the original file, but places a symlink in the sort-to directory (probably not what you want).
# MOVE/COPY/MOVE-AND-LEAVE-SYMLINK-BEHIND/PLACE-SYMLINK
# If not specified, MOVE
sort-by:MOVE
# OPTIONAL - How to treat directories.
# AS_FILES_TO_SORT - sorts directories, moving entire directories that represents an episode, also detects and moves directories of entire seasons
# RECURSIVELY_SORT_CONTENTS - doesn't move directories, just their contents, including subdirectories
# IGNORE - ignores directories
# AS_FILES_TO_SORT/RECURSIVELY_SORT_CONTENTS/IGNORE
# If not specified, RECURSIVELY_SORT_CONTENTS
treat-directories:RECURSIVELY_SORT_CONTENTS
# OPTIONAL - Only sort into show directories that already exist
# This may be helpful if you have multiple destination directories. Just set up all the other details in the conf file,
# and specify the destination directory when invoking the script. Only episodes that match existing directories in the destination will be moved.
# If this is false, then new directories are created for shows that dont have a directory.
# TRUE/FALSE
# If not specified, FALSE
require-show-directories-already-exist:FALSE
# OPTIONAL - Delete symlinks from the directory to sort while sorting.
# This may be helpful if you want to remove all the symlinks you left behind using --sort-by:MOVE-AND-LEAVE-SYMLINK-BEHIND
# You could schedule "perl sorttv.pl --remove-symlinks:TRUE" to remove these once a week/month
# If this option is enabled and used at the same time as --sort-by:MOVE-AND-LEAVE-SYMLINK-BEHIND,
# then only the previous links will be removed, and new ones may also be created
# TRUE/FALSE
# If not specified, FALSE
remove-symlinks:FALSE
# OPTIONAL - Forces MSWindows compatible file names, even when run on other platforms such as Linux
# This may be helpful if you are writing to a Windows share from a Linux system
# If not specified, FALSE
force-windows-compatible-filenames:TRUE
# OPTIONAL - Set language for thetvdb lookups, this effects episode titles etc
# Valid values include: it, zh, es, hu, nl, pl, sl, da, de, el, he, sv, eng, fi, no, fr, ru, cs, en, ja, hr, tr, ko, pt
# If not specified, en (English)
lookup-language:en
# OPTIONAL - Should non-episode files loose their directory structure?
# This option only has an effect if a non-episode directory was specified.
# If set to TRUE, they will be renamed after directory they were in.
# Otherwise they keep their directory structure in the new non-episode-directory location.
# TRUE/FALSE
# If not specified, FALSE
flatten-non-eps:FALSE
# OPTIONAL - What to do if a file already exists in the destination
# SKIP/OVERWRITE
# If not specified, SKIP
if-file-exists:SKIP
# OPTIONAL - Extracts the contents of archives (.zip, .rar) into the directory-to-sort while sorting
# If "rar" and "unzip" programs are available they are used.
# TRUE/FALSE
# If not specified, TRUE
extract-compressed-before-sorting:TRUE
# OPTIONAL - secondary config file, overwrites settings loaded so far (DO NOT PUT THE NAME OF THIS FILE!)
# If not specified, only the default config file is loaded (sorttv.config)
# read-config-file: