-
Notifications
You must be signed in to change notification settings - Fork 229
/
get_iplayer.1
593 lines (590 loc) · 24.5 KB
/
get_iplayer.1
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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
.TH GET_IPLAYER "1" "January 2024" "Phil Lewis" "get_iplayer Manual"
.SH NAME
get_iplayer \- Stream Recording tool and PVR for BBC iPlayer and BBC Sounds
.SH SYNOPSIS
\fBget_iplayer\fR [<options>] [<regex|index> ...]
.PP
\fBget_iplayer\fR \fB\-\-get\fR [<options>] <regex|index> ...
.PP
\fBget_iplayer\fR <url> [\fB\-\-type\fR=<type> <options>]
.PP
\fBget_iplayer\fR <pid> [\fB\-\-type\fR=<type> <options>]
.PP
\fBget_iplayer\fR \fB\-\-refresh\fR [\fB\-\-type\fR=<type> <options>]
.SH DESCRIPTION
\fBget_iplayer\fR lists, searches and records BBC iPlayer TV and BBC Sounds radio programmes.
.PP
\fBget_iplayer\fR has two modes: recording a complete programme for later playback, and as a Personal Video Recorder (PVR), subscribing to
search terms and recording programmes automatically.
.PP
If given the regex ".*" (incl. quotes), \fBget_iplayer\fR updates and displays the list of currently available TV programmes.
Use \-\-type=radio for radio programmes. Each available programme has an alphanumeric identifier (\fBPID\fR).
.PP
In PVR mode, \fBget_iplayer\fR can be called from cron to record programmes on a schedule.
.SH "OPTIONS"
.PP
Boolean options can be negated by adding a "no\-" prefix, e.g., \-\-no\-subtitles or \-\-no\-whitespace.
This applies even if the base option name already begins with "no\-", e.g., \-\-no\-no\-tag or \-\-no\-no\-artwork
.SS "Search Options:"
.TP
\fB\-\-available\-before <hours>
Limit search to programmes that became available before <hours> hours ago
.TP
\fB\-\-available\-since <hours>
Limit search to programmes that have become available in the last <hours> hours
.TP
\fB\-\-before <hours>
Limit search to programmes added to the cache before <hours> hours ago
.TP
\fB\-\-category <string>
Narrow search to matched categories (comma\-separated regex list). Defaults to substring match. Only works with \-\-history.
.TP
\fB\-\-channel <string>
Narrow search to matched channel(s) (comma\-separated regex list). Defaults to substring match.
.TP
\fB\-\-exclude <string>
Narrow search to exclude matched programme names (comma\-separated regex list). Defaults to substring match.
.TP
\fB\-\-exclude\-category <string>
Narrow search to exclude matched categories (comma\-separated regex list). Defaults to substring match. Only works with \-\-history.
.TP
\fB\-\-exclude\-channel <string>
Narrow search to exclude matched channel(s) (comma\-separated regex list). Defaults to substring match.
.TP
\fB\-\-expires\-after <hours>
Limit search to programmes that will expire after <hours> hours from now
.TP
\fB\-\-expires\-before <hours>
Limit search to programmes that will expire before <hours> hours from now
.TP
\fB\-\-fields <field1>,<field2>,...
Searches only in the specified fields. The fields are concatenated with spaces in the order specified and the search term is applied to the resulting string.
.TP
\fB\-\-future
Additionally search future programme schedule if it has been indexed (refresh cache with: \-\-refresh \-\-refresh\-future).
.TP
\fB\-\-history
Search recordings history (requires search term)
.TP
\fB\-\-long, \-l
Additionally search in programme descriptions and episode names (same as \-\-fields=name,episode,desc )
.TP
\fB\-\-search <search term>
GetOpt compliant way of specifying search args
.TP
\fB\-\-since <hours>
Limit search to programmes added to the cache in the last <hours> hours
.TP
\fB\-\-type <type>,<type>,...
Only search in these types of programmes: tv,radio,all (tv is default)
.SS "Display Options:"
.TP
\fB\-\-conditions
Shows GPLv3 conditions
.TP
\fB\-\-debug
Debug output (very verbose and rarely useful)
.TP
\fB\-\-dump\-options
Dumps all options with their internal option key names
.TP
\fB\-\-help, \-h
Intermediate help text
.TP
\fB\-\-helpbasic, \-\-usage
Basic help text
.TP
\fB\-\-helplong
Advanced help text
.TP
\fB\-\-hide
Hide previously recorded programmes
.TP
\fB\-\-info, \-i
Show full programme metadata and availability of streams and subtitles (max 40 matches)
.TP
\fB\-\-list <element>
Show a list of distinct element values (with counts) for the selected programme type(s) and exit. Valid elements are: 'channel'
.TP
\fB\-\-listformat <format>
Display search results with a custom format. Use substitution parameters in format string (see docs for list).
.TP
\fB\-\-long, \-l
Show extended programme info
.TP
\fB\-\-manpage <file>
Create man page based on current help text
.TP
\fB\-\-nocopyright
Don't display copyright header
.TP
\fB\-\-page <number>
Page number to display for multipage output
.TP
\fB\-\-pagesize <number>
Number of matches displayed on a page for multipage output
.TP
\fB\-\-quiet, \-q
Reduce logging output
.TP
\fB\-\-series
Display programme series names only with number of episodes
.TP
\fB\-\-show\-cache\-age
Display the age of the selected programme caches then exit
.TP
\fB\-\-show\-options
Show options which are set and where they are defined
.TP
\fB\-\-silent
No logging output except PVR download report. Cannot be saved in preferences or PVR searches.
.TP
\fB\-\-sort <fieldname>
Field to use to sort displayed matches
.TP
\fB\-\-sortreverse
Reverse order of sorted matches
.TP
\fB\-\-streaminfo
Returns all of the media stream URLs of the programme(s)
.TP
\fB\-\-terse
Only show terse programme info (does not affect searching)
.TP
\fB\-\-tree
Display programme listings in a tree view
.TP
\fB\-\-verbose, \-v
Show additional output (useful for diagnosing problems)
.TP
\fB\-\-warranty
Displays warranty section of GPLv3
.TP
\fB\-V
Show get_iplayer version and exit.
.SS "Recording Options:"
.TP
\fB\-\-attempts <number>
Number of attempts to make or resume a failed connection. \-\-attempts is applied per\-stream. Programmes have multiple streams available for each recording quality.
.TP
\fB\-\-audio\-only
Only download audio stream for TV programme. Produces .m4a file. Implies \-\-force.
.TP
\fB\-\-download\-abort\-onfail
Exit immediately if any stream fails to download. Use to avoid repeated failed download attempts if connection is dropped or access is blocked.
.TP
\fB\-\-exclude\-format <format>,<format>,...
Comma\-separated list of media stream formats to ignore when recording. Valid values: hls,dash.
.TP
\fB\-\-exclude\-supplier <supplier>,<supplier>,...
Comma\-separated list of media stream suppliers (CDNs) to skip. Possible values: akamai,limelight,bidi,cloudfront. Synonym: \-\-exclude\-cdn.
.TP
\fB\-\-force
Ignore programme history (unsets \-\-hide option also).
.TP
\fB\-\-get, \-g
Start recording matching programmes. Search terms required.
.TP
\fB\-\-hash
Show recording progress as hashes
.TP
\fB\-\-include\-format <format>,<format>,...
Comma\-separated list of media stream to use when recording. Overrides \-\-exclude\-format. Valid values: hls,dash
.TP
\fB\-\-include\-supplier <supplier>,<supplier>,...
Comma\-separated list of media stream suppliers (CDNs) to use if not included by default or if previously excluded by \-\-exclude\-supplier. Possible values: akamai,limelight,bidi,cloudfront. Synonym: \-\-include\-cdn.
.TP
\fB\-\-log\-progress
Force HLS/DASH download progress display to be captured when screen output is redirected to file. Progress display is normally omitted unless writing to terminal.
.TP
\fB\-\-mark\-downloaded
Mark programmes in search results or specified with \-\-pid/\-\-url as downloaded by inserting records in download history.
.TP
\fB\-\-no\-merge\-versions
Do not merge programme versions with same name and duration.
.TP
\fB\-\-no\-proxy
Ignore \-\-proxy setting in preferences and/or http_proxy environment variable.
.TP
\fB\-\-no\-resume
Do not resume partial HLS/DASH downloads.
.TP
\fB\-\-no\-verify
Do not verify size of downloaded HLS/DASH file segments or file resize upon resume.
.TP
\fB\-\-overwrite
Overwrite recordings if they already exist
.TP
\fB\-\-partial\-proxy
Only uses web proxy where absolutely required (try this extra option if your proxy fails).
.TP
\fB\-\-pid <pid>,<pid>,...
Record arbitrary PIDs that do not necessarily appear in the index.
.TP
\fB\-\-pid\-index
Update (if necessary) and use programme index cache with \-\-pid. Cache is not searched for programme by default with \-\-pid. Synonym: \-\-pid\-refresh.
.TP
\fB\-\-pid\-recursive
Record all related episodes if value of \-\-pid is a series or brand PID. Requires \-\-pid.
.TP
\fB\-\-pid\-recursive\-list
If value of \-\-pid is a series or brand PID, list available episodes but do not download. Implies \-\-pid\-recursive. Requires \-\-pid.
.TP
\fB\-\-pid\-recursive\-type <type>
Download only programmes of <type> (radio or tv) with \-\-pid\-recursive. Requires \-\-pid\-recursive.
.TP
\fB\-\-proxy, \-p <url>
Web proxy URL, e.g., http://username:password@server:port or http://server:port. Value of http_proxy environment variable (if present) will be used unless \-\-proxy is specified. Used for both HTTP and HTTPS. Overridden by \-\-no\-proxy.
.TP
\fB\-\-quality <quality>,<quality>,...
TV and radio recording quality preference. See \-\-tv\-quality and \-\-radio\-quality for available values and defaults. Default: default for programme type.
.TP
\fB\-\-radio\-quality <quality>,<quality>,...
Radio recording quality preference (overrides \-\-quality): high,std,med,low,default (Aliases: 320k,128k,96k,48k). Comma\-delimited list in descending order of preference. Default: high,std,med,low.
.TP
\fB\-\-start <secs|hh:mm:ss>
Recording/streaming start offset (actual start may be several seconds earlier for HLS and DASH streams)
.TP
\fB\-\-stop <secs|hh:mm:ss>
Recording/streaming stop offset (actual stop may be several seconds later for HLS and DASH streams)
.TP
\fB\-\-subtitles\-required
Do not download TV programme if subtitles are not available.
.TP
\fB\-\-test, \-t
Test only \- no recording (only shows search results with \-\-pvr and \-\-pid\-recursive)
.TP
\fB\-\-tv\-lower\-bitrate, \-\-tvlbr
Prefer 25fps (or lower\-bitrate 50fps) streams for TV programmes if available.
.TP
\fB\-\-tv\-quality <quality>,<quality>,...
TV recording quality preference (overrides \-\-quality): fhd,hd,sd,web,mobile,default (Aliases: 1080p,720p,540p,396p,288p). Comma\-delimited list in descending order of preference. Default: hd,sd,web,mobile
.TP
\fB\-\-url <url>,<url>,...
Record the PIDs contained in the specified iPlayer episode URLs. Alias for \-\-pid.
.TP
\fB\-\-versions <versions>
Version of programme to record. List is processed from left to right and first version found is downloaded. Example: '\-\-versions=audiodescribed,default' will prefer audiodescribed programmes if available. Versions: 'default,audiodescribed,signed,combined'. Default: 'default'.
.SS "Output Options:"
.TP
\fB\-\-command, \-c <command>
User command to run after successful recording of programme. Use substitution parameters in command string (see docs for list).
.TP
\fB\-\-command\-radio <command>
User command to run after successful recording of radio programme. Use substitution parameters in command string (see docs for list). Overrides \-\-command.
.TP
\fB\-\-command\-tv <command>
User command to run after successful recording of TV programme. Use substitution parameters in command string (see docs for list). Overrides \-\-command.
.TP
\fB\-\-credits
Download programme credits, if available.
.TP
\fB\-\-credits\-only
Only download programme credits, if available.
.TP
\fB\-\-cuesheet
Create cue sheet (.cue file) for programme, if data available. Radio programmes only. Cue sheet will be very inaccurate and will required further editing. Cue sheet may require addition of UTF\-8 BOM (byte\-order mark) for some applications to identify encoding.
.TP
\fB\-\-cuesheet\-offset [\-]<offset>
Offset track times in cue sheet and track list by the specified number of seconds. Synonym: \-\-tracklist\-offset
.TP
\fB\-\-cuesheet\-only
Only create cue sheet (.cue file) for programme, if data available. Radio programmes only.
.TP
\fB\-\-file\-prefix <format>
The filename prefix template (excluding dir and extension). Use substitution parameters in template (see docs for list). Default: <name> \- <episode> <pid> <version>
.TP
\fB\-\-limitprefixlength <length>
The maximum length for a file prefix. Defaults to 240 to allow space within standard 256 limit.
.TP
\fB\-\-metadata
Create metadata info file after recording. Valid values: generic,json. XML generated for 'generic', JSON for 'json'. If no value specified, 'generic' is used.
.TP
\fB\-\-metadata\-only
Create specified metadata info file without any recording or streaming.
.TP
\fB\-\-mpeg\-ts
Ensure raw audio and video files are re\-muxed into MPEG\-TS file regardless of stream format. Overrides \-\-raw.
.TP
\fB\-\-no\-metadata
Do not create metadata info file after recording (overrides \-\-metadata).
.TP
\fB\-\-no\-sanitise
Do not sanitise output file and directory names. Implies \-\-whitespace. Invalid characters for Windows ("*:<>?|) and macOS (:) will be removed.
.TP
\fB\-\-output, \-o <dir>
Recording output directory
.TP
\fB\-\-output\-radio <dir>
Output directory for radio recordings (overrides \-\-output)
.TP
\fB\-\-output\-tv <dir>
Output directory for tv recordings (overrides \-\-output)
.TP
\fB\-\-raw
Don't remux or change the recording in any way. Saves output file in native container format (HLS\->MPEG\-TS, DASH\->MP4)
.TP
\fB\-\-subdir, \-s
Save recorded files into subdirectory of output directory. Default: same name as programme (see \-\-subdir\-format).
.TP
\fB\-\-subdir\-format <format>
The format to be used for subdirectory naming. Use substitution parameters in format string (see docs for list).
.TP
\fB\-\-suboffset <offset>
Offset the subtitle timestamps by the specified number of milliseconds. Requires \-\-subtitles.
.TP
\fB\-\-subs\-embed
Embed soft subtitles in MP4 output file. Ignored with \-\-audio\-only and \-\-ffmpeg\-obsolete. Requires \-\-subtitles. Implies \-\-subs\-mono.
.TP
\fB\-\-subs\-mono
Create monochrome titles, with leading hyphen used to denote change of speaker. Requires \-\-subtitles. Not required with \-\-subs\-embed.
.TP
\fB\-\-subs\-raw
Additionally save the raw subtitles file. Requires \-\-subtitles.
.TP
\fB\-\-subtitles
Download subtitles into srt/SubRip format if available and supported
.TP
\fB\-\-subtitles\-only
Only download the subtitles, not the programme
.TP
\fB\-\-tag\-only
Only update the programme metadata tag and not download the programme. Use with \-\-history or \-\-tag\-only\-filename.
.TP
\fB\-\-tag\-only\-filename <filename>
Add metadata tags to specified file (ignored unless used with \-\-tag\-only)
.TP
\fB\-\-thumb
Download thumbnail image if available
.TP
\fB\-\-thumb\-ext <ext>
Thumbnail filename extension to use
.TP
\fB\-\-thumbnail\-only
Only download thumbnail image if available, not the programme
.TP
\fB\-\-thumbnail\-series
Force use of series/brand thumbnail (series preferred) instead of episode thumbnail
.TP
\fB\-\-thumbnail\-size <width>
Thumbnail size to use for the current recording and metadata. Specify width: 192,256,384,448,512,640,704,832,960,1280,1920. Invalid values will be mapped to nearest available. Default: 1920 (1280 with \-\-thumbnail\-square)
.TP
\fB\-\-thumbnail\-square
Download square version of thumbnail image. Limits \-\-thumbnail\-size to 1280.
.TP
\fB\-\-tracklist
Create track list of music played in programme, if data available. Track times and durations may be missing or incorrect.
.TP
\fB\-\-tracklist\-only
Only create track list of music played in programme, if data available.
.TP
\fB\-\-whitespace, \-w
Keep whitespace in file and directory names. Default behaviour is to replace whitespace with underscores.
.SS "PVR Options:"
.TP
\fB\-\-comment <string>
Adds a comment to a PVR search
.TP
\fB\-\-pvr <search name>
Runs the PVR using all saved PVR searches (intended to be run periodically, e.g., from cron or Task Manager). The list can be limited by adding a regex to the command. Synonyms: \-\-pvrrun, \-\-pvr\-run
.TP
\fB\-\-pvr\-add <search name>
Save the named PVR search with the specified search terms. Search terms required unless \-\-pid specified. Synonyms: \-\-pvradd
.TP
\fB\-\-pvr\-del <search name>
Remove the named search from the PVR searches. Synonyms: \-\-pvrdel
.TP
\fB\-\-pvr\-disable <search name>
Disable (not delete) a named PVR search. Synonyms: \-\-pvrdisable
.TP
\fB\-\-pvr\-enable <search name>
Enable a previously disabled named PVR search. Synonyms: \-\-pvrenable
.TP
\fB\-\-pvr\-exclude <string>
Exclude the PVR searches to run by search name (comma\-separated regex list). Defaults to substring match. Synonyms: \-\-pvrexclude
.TP
\fB\-\-pvr\-list
Show the PVR search list. Synonyms: \-\-pvrlist
.TP
\fB\-\-pvr\-queue
Add currently matched programmes to queue for later one\-off recording using the \-\-pvr option. Search terms required unless \-\-pid specified. Synonyms: \-\-pvrqueue
.TP
\fB\-\-pvr\-scheduler <seconds>
Runs the PVR using all saved PVR searches every <seconds>. Synonyms: \-\-pvrscheduler
.TP
\fB\-\-pvr\-series
Create PVR search for each unique series name in search results. Search terms required. Synonyms: \-\-pvrseries
.TP
\fB\-\-pvr\-single <search name>
Runs a named PVR search. Synonyms: \-\-pvrsingle
.SS "Config Options:"
.TP
\fB\-\-cache\-rebuild
Rebuild cache with full 30\-day programme index. Use \-\-refresh\-limit to restrict cache window.
.TP
\fB\-\-expiry, \-e <secs>
Cache expiry in seconds (default 4hrs)
.TP
\fB\-\-limit\-matches <number>
Limits the number of matching results for any search (and for every PVR search)
.TP
\fB\-\-prefs\-add
Add/Change specified saved user or preset options
.TP
\fB\-\-prefs\-clear
Remove *ALL* saved user or preset options
.TP
\fB\-\-prefs\-del
Remove specified saved user or preset options
.TP
\fB\-\-prefs\-show
Show saved user or preset options
.TP
\fB\-\-preset, \-z <name>
Use specified user options preset
.TP
\fB\-\-preset\-list
Show all valid presets
.TP
\fB\-\-profile\-dir <dir>
Override the user profile directory
.TP
\fB\-\-refresh
Refresh cache
.TP
\fB\-\-refresh\-abort\-onerror
Abort cache refresh for programme type if data for any channel fails to download. Use \-\-refresh\-exclude to temporarily skip failing channels.
.TP
\fB\-\-refresh\-exclude <channel>,<channel>,...
Exclude matched channel(s) when refreshing cache (comma\-separated regex list). Defaults to substring match. Overrides \-\-refresh\-include\-groups[\-{tv,radio}] status for specified channel(s)
.TP
\fB\-\-refresh\-exclude\-groups <group>,<group>,...
Exclude channel groups when refreshing radio or TV cache (comma\-separated values). Valid values: 'national', 'regional', 'local'
.TP
\fB\-\-refresh\-exclude\-groups\-radio <group>,<group>,...
Exclude channel groups when refreshing radio cache (comma\-separated values). Valid values: 'national', 'regional', 'local'
.TP
\fB\-\-refresh\-exclude\-groups\-tv <group>,<group>,...
Exclude channel groups when refreshing TV cache (comma\-separated values). Valid values: 'national', 'regional', 'local'
.TP
\fB\-\-refresh\-future
Obtain future programme schedule when refreshing cache
.TP
\fB\-\-refresh\-include <channel>,<channel>,...
Include matched channel(s) when refreshing cache (comma\-separated regex list). Defaults to substring match. Overrides \-\-refresh\-exclude\-groups[\-{tv,radio}] status for specified channel(s)
.TP
\fB\-\-refresh\-include\-groups <group>,<group>,...
Include channel groups when refreshing radio or TV cache (comma\-separated values). Valid values: 'national', 'regional', 'local'
.TP
\fB\-\-refresh\-include\-groups\-radio <group>,<group>,...
Include channel groups when refreshing radio cache (comma\-separated values). Valid values: 'national', 'regional', 'local'
.TP
\fB\-\-refresh\-include\-groups\-tv <group>,<group>,...
Include channel groups when refreshing TV cache (comma\-separated values). Valid values: 'national', 'regional', 'local'
.TP
\fB\-\-refresh\-limit <days>
Minimum number of days of programmes to cache. Default: 7 Min: 1 Max: 30
.TP
\fB\-\-refresh\-limit\-radio <days>
Number of days of radio programmes to cache. Default: 7 Min: 1 Max: 30
.TP
\fB\-\-refresh\-limit\-tv <days>
Number of days of TV programmes to cache. Default: 7 Min: 1 Max: 30
.TP
\fB\-\-skipdeleted
Skip the download of metadata/thumbs/subs if the media file no longer exists. Use with \-\-history & \-\-metadataonly/subsonly/thumbonly.
.TP
\fB\-\-webrequest <urlencoded string>
Specify all options as a urlencoded string of "name=val&name=val&..."
.SS "External Program Options:"
.TP
\fB\-\-atomicparsley <path>
Location of AtomicParsley binary
.TP
\fB\-\-ffmpeg <path>
Location of ffmpeg binary. Assumed to be ffmpeg 3.0 or higher unless \-\-ffmpeg\-obsolete is specified.
.TP
\fB\-\-ffmpeg\-force
Bypass version checks and assume ffmpeg is version 3.0 or higher
.TP
\fB\-\-ffmpeg\-loglevel <level>
Set logging level for ffmpeg. Overridden by \-\-quiet and \-\-silent. Default: 'fatal'
.TP
\fB\-\-ffmpeg\-obsolete
Indicates you are using an obsolete version of ffmpeg (<1.0) that may not support certain options. Without this option, MP4 conversion may fail with obsolete versions of ffmpeg.
.SS "Tagging Options:"
.TP
\fB\-\-no\-artwork
Do not embed thumbnail image in output file. Also removes existing artwork. All other metadata values will be written.
.TP
\fB\-\-no\-tag
Do not tag downloaded programmes.
.TP
\fB\-\-tag\-credits
Add programme credits (if available) to long description field.
.TP
\fB\-\-tag\-encoding <name>
(Windows only) Single\-byte character encoding for non\-ASCII characters in metadata tags. Encoding name must be known to Perl Encode module. Unicode (UTF* or UCS*) character encodings are not supported. Default: active code page or cp1252 (Windows code page 1252)
.TP
\fB\-\-tag\-format\-show
Format template for programme name in tag metadata. Use substitution parameters in template (see docs for list). Default: <name>
.TP
\fB\-\-tag\-format\-title
Format template for episode title in tag metadata. Use substitution parameters in template (see docs for list). Default: <episodeshort>
.TP
\fB\-\-tag\-isodate
Use ISO8601 dates (YYYY\-MM\-DD) in album/show names and track titles
.TP
\fB\-\-tag\-no\-unicode
(Windows only) Do not attempt to perform Unicode tagging and use single\-byte character encoding instead (see \-\-tag\-encoding)
.TP
\fB\-\-tag\-podcast
Tag downloaded radio and tv programmes as iTunes podcasts (incompatible with Music/Podcasts/TV apps on macOS 10.15 and higher)
.TP
\fB\-\-tag\-podcast\-radio
Tag only downloaded radio programmes as iTunes podcasts (incompatible with Music/Podcasts/TV apps on macOS 10.15 and higher)
.TP
\fB\-\-tag\-podcast\-tv
Tag only downloaded tv programmes as iTunes podcasts (incompatible with Music/Podcasts/TV apps on macOS 10.15 and higher)
.TP
\fB\-\-tag\-tracklist
Add track list of music played in programme (if available) to lyrics field.
.SS "Misc Options:"
.TP
\fB\-\-encoding\-console\-in <name>
Character encoding for standard input (currently unused). Encoding name must be known to Perl Encode module. Default (only if auto\-detect fails): Linux/Unix/macOS = UTF\-8, Windows = cp850
.TP
\fB\-\-encoding\-console\-out <name>
Character encoding used to encode search results and other output. Encoding name must be known to Perl Encode module. Default (only if auto\-detect fails): Linux/Unix/macOS = UTF\-8, Windows = cp850
.TP
\fB\-\-encoding\-locale <name>
Character encoding used to decode command\-line arguments. Encoding name must be known to Perl Encode module. Default (only if auto\-detect fails): Linux/Unix/OSX = UTF\-8, Windows = cp1252
.TP
\fB\-\-encoding\-locale\-fs <name>
Character encoding used to encode file and directory names. Encoding name must be known to Perl Encode module. Default (only if auto\-detect fails): Linux/Unix/macOS = UTF\-8, Windows = cp1252
.TP
\fB\-\-encoding\-webrequest <name>
Character encoding used to encode commands sent from Web PVR. Encoding name must be known to Perl Encode module. Default = UTF\-8
.TP
\fB\-\-index\-maxconn <number>
Maximum number of connections to use for concurrent programme indexing. Default: 5 Min: 1 Max: 10
.TP
\fB\-\-release\-check
Forces check for new release if used on command line. Checks for new release weekly if saved in preferences.
.TP
\fB\-\-throttle <Mb/s>
Bandwidth limit (in Mb/s) for media file download. Default: unlimited. Synonym: \-\-bw
.SS "Deprecated Options:"
.TP
\fB\-\-no\-index\-concurrent
Do not use concurrent indexing to update programme cache. Cache updates will be very slow.
.SH AUTHOR
get_iplayer was written by Phil Lewis <iplayer2 (at sign) linuxcentre.net> and is now maintained by the contributors at https://github.com/get\-iplayer/get_iplayer
.PP
This manual page was originally written by Jonathan Wiltshire <jmw@debian.org> for the Debian project (but may be used by others).
.SH COPYRIGHT NOTICE
get_iplayer v3.35
Copyright (C) 2008\-2010 Phil Lewis, 2010\- get_iplayer contributors
This program comes with ABSOLUTELY NO WARRANTY; for details use \-\-warranty.
This is free software, and you are welcome to redistribute it under certain
conditions; use \-\-conditions for details.