forked from get-iplayer/get_iplayer
-
Notifications
You must be signed in to change notification settings - Fork 0
/
get_iplayer.1
680 lines (677 loc) · 24.6 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
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
.TH GET_IPLAYER "1" "November 2014" "Phil Lewis" "get_iplayer Manual"
.SH NAME
get_iplayer \- Stream Recording tool and PVR for BBC iPlayer, BBC Podcasts and more
.SH SYNOPSIS
\fBget_iplayer\fR [<options>] [<regex|index> ...]
.PP
\fBget_iplayer\fR \fB\-\-get\fR [<options>] <regex|index> ...
.br
\fBget_iplayer\fR <url> \fB\-\-type\fR=<type> [<options>]
.PP
\fBget_iplayer\fR <pid|url> [\fB\-\-type\fR=<type> <options>]
.PP
\fBget_iplayer\fR \fB\-\-stream\fR [<options>] <regex|index> | mplayer \fB\-cache\fR 3072 \-
.PP
\fBget_iplayer\fR \fB\-\-stream\fR [<options>] \fB\-\-type\fR=<type> <pid|url> | mplayer \fB\-cache\fR 3072 \-
.PP
\fBget_iplayer\fR \fB\-\-stream\fR [<options>] \fB\-\-type\fR=livetv,liveradio <regex|index> \fB\-\-player\fR="mplayer \-cache 128 \-"
.PP
\fBget_iplayer\fR \fB\-\-refresh\fR
.SH DESCRIPTION
\fBget_iplayer\fR lists, searches and records BBC iPlayer TV/Radio, BBC Podcast programmes. Other 3rd\-Party plugins may be available.
.PP
\fBget_iplayer\fR has three modes: recording a complete programme for later playback, streaming a programme
directly to a playback application, such as mplayer; and as a Personal Video Recorder (PVR), subscribing to
search terms and recording programmes automatically. It can also stream or record live BBC iPlayer output
.PP
If given no arguments, \fBget_iplayer\fR updates and displays the list of currently available programmes.
Each available programme has a numerical identifier, \fBpid\fR.
\fBget_iplayer\fR utilises the \fBrtmpdump\fR tool to record BBC iPlayer programmes from RTMP flash streams at various qualities.
.PP
In PVR mode, \fBget_iplayer\fR can be called from cron to record programmes to a schedule.
.SH "OPTIONS"
.SS "Search Options:"
.TP
\fB\-\-before
Limit search to programmes added to the cache before N hours ago
.TP
\fB\-\-category <string>
Narrow search to matched categories (regex or comma separated values)
.TP
\fB\-\-channel <string>
Narrow search to matched channel(s) (regex or comma separated values)
.TP
\fB\-\-exclude <string>
Narrow search to exclude matched programme names (regex or comma separated values)
.TP
\fB\-\-exclude\-category <string>
Narrow search to exclude matched categories (regex or comma separated values)
.TP
\fB\-\-exclude\-channel <string>
Narrow search to exclude matched channel(s) (regex or comma separated values)
.TP
\fB\-\-fields <field1>,<field2>,..
Searches only in the specified comma separated fields
.TP
\fB\-\-future
Additionally search future programme schedule if it has been indexed (refresh cache with: \-\-refresh \-\-refresh\-future).
.TP
\fB\-\-history
Search/show recordings history
.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
Limit search to programmes added to the cache in the last N hours
.TP
\fB\-\-type <type>
Only search in these types of programmes: livetv,tv,liveradio,radio,all (tv is default)
.TP
\fB\-\-versions <versions>
Version of programme to search or record. List is processed from left to right and first version found is downloaded. Example: '\-\-versions signed,audiodescribed,default' will prefer signed and audiodescribed programmes if available. Default: 'default'
.SS "Display Options:"
.TP
\fB\-\-conditions
Shows GPLv3 conditions
.TP
\fB\-\-debug
Debug output
.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 modes and subtitles (max 50 matches)
.TP
\fB\-\-list <categories|channel>
Show a list of available categories/channels for the selected type and exit
.TP
\fB\-\-listformat <format>
Display programme data based on a user\-defined format string (such as <pid>, <name> etc)
.TP
\fB\-\-listplugins
Display a list of currently available plugins or programme types
.TP
\fB\-\-long, \-l
Show long 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
Displays the age of the selected programme caches then exit
.TP
\fB\-\-show\-options
Shows 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
Verbose
.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, per\-mode. TV modes typically have two streams available.
.TP
\fB\-\-bandwidth
In radio realaudio mode specify the link bandwidth in bps for rtsp streaming (default 512000)
.TP
\fB\-\-check\-duration
Print message showing recorded duration, expected duration and difference between them.
.TP
\fB\-\-ffmpeg\-liveradio\-opts <options>
Add custom options to ffmpeg re\-muxing for liveradio
.TP
\fB\-\-ffmpeg\-livetv\-opts <options>
Add custom options to ffmpeg re\-muxing for livetv
.TP
\fB\-\-ffmpeg\-radio\-opts <options>
Add custom options to ffmpeg re\-muxing for radio
.TP
\fB\-\-ffmpeg\-tv\-opts <options>
Add custom options to ffmpeg re\-muxing for tv
.TP
\fB\-\-force
Ignore programme history (unsets \-\-hide option also). Forces a script update if used with \-u
.TP
\fB\-\-get, \-g
Start recording matching programmes. Search terms required unless \-\-pid specified. Use \-\-search=.* to force download of all available programmes.
.TP
\fB\-\-hash
Show recording progress as hashes
.TP
\fB\-\-hds\-livetv
Use Adobe HDS manifests to locate live tv streams (for live HD tv where available)
.TP
\fB\-\-hls\-liveradio\-opts <options>
Add custom options to ffmpeg HLS download re\-muxing for liveradio
.TP
\fB\-\-hls\-livetv\-opts <options>
Add custom options to ffmpeg HLS download encoding for livetv
.TP
\fB\-\-hls\-radio\-opts <options>
Add custom options to ffmpeg HLS download re\-muxing for radio
.TP
\fB\-\-hls\-tv\-opts <options>
Add custom options to ffmpeg HLS download re\-muxing for tv
.TP
\fB\-\-liveradiomode <mode>,<mode>,..
Live Radio recording modes: flashaachigh,flashaacstd,flashaudio,flashaaclow,wma. Shortcuts: default,good,better(=default),best,rtmp,flash,flashaac. ('default'=flashaachigh,flashaacstd,flashaaclow)
.TP
\fB\-\-livetvmode <mode>,<mode>,...
Live TV recording modes: flashhd,flashvhigh,flashhigh,flashstd,flashnormal,flashlow. Shortcuts: default,good,better(=default),best,rtmp,flash. ('default'=flashvhigh,flashhigh,flashstd,flashnormal,flashlow)
.TP
\fB\-\-mediaselector <identifier>
Identifier of mediaselector API to use when searching for media streams. One of: 4,5 Default: 5
.TP
\fB\-\-metadata\-only
Create specified metadata info file without any recording or streaming (can also be used with thumbnail option).
.TP
\fB\-\-mmsnothread
Disable parallel threaded recording for mms
.TP
\fB\-\-modes <mode>,<mode>,...
Recording modes. See \-\-tvmode and \-\-radiomode for available modes and defaults. Shortcuts: default,good,better(=default),best. Use \-\-modes=best to select highest quality available (incl. HD TV).
.TP
\fB\-\-multimode
Allow the recording of more than one mode for the same programme \- WARNING: will record all specified/default modes!!
.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>
Record an arbitrary pid that does not necessarily appear in the index.
.TP
\fB\-\-pid\-recursive
When used with \-\-pid record all the embedded pids if the pid is a series or brand pid.
.TP
\fB\-\-proxy, \-p <url>
Web proxy URL e.g. 'http://USERNAME:PASSWORD@SERVER:PORT' or 'http://SERVER:PORT'
.TP
\fB\-\-radiomode <mode>,<mode>,...
Radio recording modes: flashaachigh,flashaacstd,flashaudio,flashaaclow,wma. Shortcuts: default,good,better(=default),best,rtmp,flash,flashaac. ('default'=flashaachigh,flashaacstd,flashaudio,flashaaclow)
.TP
\fB\-\-raw
Don't transcode or change the recording/stream in any way (i.e. radio/realaudio, rtmp/flv)
.TP
\fB\-\-rtmp\-liveradio\-opts <options>
Add custom options to rtmpdump for liveradio
.TP
\fB\-\-rtmp\-livetv\-opts <options>
Add custom options to rtmpdump for livetv
.TP
\fB\-\-rtmp\-radio\-opts <options>
Add custom options to rtmpdump for radio
.TP
\fB\-\-rtmp\-tv\-opts <options>
Add custom options to rtmpdump for tv
.TP
\fB\-\-rtmpport <port>
Override the RTMP port (e.g. 443)
.TP
\fB\-\-start <secs|hh:mm:ss>
Recording/streaming start offset (rtmp and realaudio only)
.TP
\fB\-\-stop <secs|hh:mm:ss>
Recording/streaming stop offset (can be used to limit live rtmp recording length) rtmp and realaudio only
.TP
\fB\-\-suboffset <offset>
Offset the subtitle timestamps by the specified number of milliseconds
.TP
\fB\-\-subsfmt <format>
Subtitles format. One of: default, compact. Default: 'default'
.TP
\fB\-\-subsraw
Additionally save the raw subtitles file
.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\-\-subtitles\-required
Do not download TV programme if subtitles are not available.
.TP
\fB\-\-swfurl <URL>
URL of Flash player used by rtmpdump for verification. Only use if default Flash player URL is not working.
.TP
\fB\-\-tag\-only
Only update the programme tag and not download the programme (can also be used with \-\-history)
.TP
\fB\-\-test, \-t
Test only \- no recording (will show programme type)
.TP
\fB\-\-thumb
Download Thumbnail image if available
.TP
\fB\-\-thumbnail\-only
Only Download Thumbnail image if available, not the programme
.TP
\fB\-\-tvmode <mode>,<mode>,...
TV recording modes: flashhd,flashvhigh,flashhigh,flashstd,flashnormal,flashlow. Shortcuts: default,good,better(=default),best,rtmp,flash. (Use 'best' for HD TV. 'default'=flashvhigh,flashhigh,flashstd,flashnormal,flashlow)
.TP
\fB\-\-url "<url>"
Record the embedded media player in the specified URL. Use with \-\-type=<type>.
.TP
\fB\-\-wav
In radio realaudio mode output as wav and don't transcode to mp3
.SS "Output Options:"
.TP
\fB\-\-aactomp3
Transcode AAC audio to MP3 with ffmpeg/avconv (CBR 128k unless \-\-mp3vbr is specified). Applied only to radio programmes. (Synonyms: \-\-mp3)
.TP
\fB\-\-avi
Output video in AVI container instead of MP4. There is no metadata tagging support for AVI output.
.TP
\fB\-\-command, \-c <command>
Run user command after successful recording using args such as <pid>, <name> etc
.TP
\fB\-\-email <address>
Email HTML index of matching programmes to specified address
.TP
\fB\-\-email\-password <password>
Email password
.TP
\fB\-\-email\-port <port number>
Email port number (default: appropriate port for \-\-email\-security)
.TP
\fB\-\-email\-security <TLS|SSL>
Email security TLS, SSL (default: none)
.TP
\fB\-\-email\-sender <address>
Optional email sender address
.TP
\fB\-\-email\-smtp <hostname>
SMTP server IP address to use to send email (default: localhost)
.TP
\fB\-\-email\-user <username>
Email username
.TP
\fB\-\-fatfilename
Remove FAT forbidden characters in file and directory names. Always applied on Windows. Overrides \-\-punctuation.
.TP
\fB\-\-file\-prefix <format>
The filename prefix (excluding dir and extension) using formatting fields. e.g. '<name>\-<episode>\-<pid>'
.TP
\fB\-\-fxd <file>
Create Freevo FXD XML of matching programmes in specified file
.TP
\fB\-\-hfsfilename
Remove colons in file and directory names. Prevents OS X Finder displaying colon as forward slash. Always applied on OS X. Overrides \-\-punctuation.
.TP
\fB\-\-html <file>
Create basic HTML index of matching programmes in specified file
.TP
\fB\-\-isodate
Use ISO8601 dates (YYYY\-MM\-DD) in filenames and subdirectory paths
.TP
\fB\-\-keep\-all
Keep whitespace, all possible punctuation and non\-ASCII characters in file and directory names. Shortcut for: \-\-whitespace \-\-non\-ascii \-\-punctuation.
.TP
\fB\-\-metadata <type>
Create metadata info file after recording. Valid types are: xbmc (or kodi), xbmc_movie (or kodi_movie), freevo, generic
.TP
\fB\-\-mkv
Output video in MKV container instead of MP4. There is no metadata tagging support for MKV output.
.TP
\fB\-\-mp3vbr
Set LAME VBR mode to N (0 to 9) for AAC transcoding. 0 = target bitrate 245 Kbit/s, 9 = target bitrate 65 Kbit/s (requires \-\-aactomp3). Applied only to radio programmes.
.TP
\fB\-\-mythtv <file>
Create Mythtv streams XML of matching programmes in specified file
.TP
\fB\-\-non\-ascii, \-\-na
Keep non\-ASCII characters in file and directory names. Default behaviour is to remove all non\-ASCII characters.
.TP
\fB\-\-nowrite, \-n
No writing of file to disk (use with \-x to prevent a copy being stored on disk)
.TP
\fB\-\-output, \-o <dir>
Recording output directory
.TP
\fB\-\-outputliveradio <dir>
Output directory for live radio recordings (overrides \-\-output)
.TP
\fB\-\-outputlivetv <dir>
Output directory for live tv recordings (overrides \-\-output)
.TP
\fB\-\-outputlocalfiles <dir>
Output directory for localfiles recordings (overrides \-\-output)
.TP
\fB\-\-outputpodcast <dir>
Output directory for podcast recordings (overrides \-\-output)
.TP
\fB\-\-outputradio <dir>
Output directory for radio recordings (overrides \-\-output)
.TP
\fB\-\-outputtv <dir>
Output directory for tv recordings (overrides \-\-output)
.TP
\fB\-\-player '<command> <options>'
Use specified command to directly play the stream
.TP
\fB\-\-punctuation, \-\-pu
Keep punctuation characters and symbols in file and directory names, with ellipsis always replaced by underscore. Default behaviour is to remove all punctuation and symbols except underscore, hyphen and full stop. Overridden by \-\-fatfilename and \-\-hfsfilename.
.TP
\fB\-\-stdout, \-x
Additionally stream to STDOUT (so you can pipe output to a player)
.TP
\fB\-\-stream
Stream to STDOUT (so you can pipe output to a player)
.TP
\fB\-\-subdir, \-s
Put Recorded files into Programme name subdirectory
.TP
\fB\-\-subdir\-format <format>
The format to be used for the subdirectory naming using formatting fields. e.g. '<nameshort>\-<seriesnum>'
.TP
\fB\-\-symlink <file>
Create symlink to <file> once we have the header of the recording
.TP
\fB\-\-thumb\-ext <ext>
Thumbnail filename extension to use
.TP
\fB\-\-thumbsize <index|width>
Default thumbnail size/index to use for the current recording and metadata (see \-\-info for thumbnailN: to get size/index)
.TP
\fB\-\-thumbsizecache <index|width>
Default thumbnail size/index to use when building cache and index (see \-\-info for thumbnailN: to get size/index)
.TP
\fB\-\-whitespace, \-w
Keep whitespace in file and directory names. Default behaviour is to replace whitespace with underscores.
.TP
\fB\-\-xml\-alpha
Create freevo/Mythtv menu sorted alphabetically by programme name
.TP
\fB\-\-xml\-channels
Create freevo/Mythtv menu of channels \-> programme names \-> episodes
.TP
\fB\-\-xml\-names
Create freevo/Mythtv menu of programme names \-> episodes
.SS "PVR Options:"
.TP
\fB\-\-comment <string>
Adds a comment to a PVR search
.TP
\fB\-\-pvr [pvr search name]
Runs the PVR using all saved PVR searches (intended to be run every hour from cron etc). 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. Use \-\-search=.* to force download of all available programmes. 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 (regex or comma separated values). 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. Use \-\-search=.* to force download of all available programmes. Synonyms: \-\-pvrqueue
.TP
\fB\-\-pvr\-scheduler <seconds>
Runs the PVR using all saved PVR searches every <seconds>. Synonyms: \-\-pvrscheduler
.TP
\fB\-\-pvr\-single <search name>
Runs a named PVR search. Synonyms: \-\-pvrsingle
.SS "Config Options:"
.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\-\-localfilesdirs <dir>[,dir,]
Directories/Folders to scan for new files
.TP
\fB\-\-nopurge
Don't ask to delete programmes recorded over 30 days ago
.TP
\fB\-\-packagemanager <string>
Tell the updater that we were installed using a package manager and don't update (use either: apt,rpm,deb,yum,disable)
.TP
\fB\-\-plugins\-update
Update get_iplayer plugins to the latest
.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/folder
.TP
\fB\-\-refresh, \-\-flush, \-f
Refresh cache
.TP
\fB\-\-refresh\-abortonerror
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 <string>
Exclude matched channel(s) when refreshing cache (regex or comma separated values)
.TP
\fB\-\-refresh\-exclude\-groups
Exclude channel groups when refreshing radio or tv cache (comma\-separated values). Valid values: 'national', 'regional', 'local'
.TP
\fB\-\-refresh\-exclude\-groups\-radio
Exclude channel groups when refreshing radio cache (comma\-separated values). Valid values: 'national', 'regional', 'local'
.TP
\fB\-\-refresh\-exclude\-groups\-tv
Exclude channel groups when refreshing tv cache (comma\-separated values). Valid values: 'national', 'regional', 'local'
.TP
\fB\-\-refresh\-feeds <string>
Alternate source for programme data. Valid values: 'ion','ion2','schedule'
.TP
\fB\-\-refresh\-feeds\-radio <string>
Alternate source for radio programme data. Valid values: 'ion','ion2','schedule'
.TP
\fB\-\-refresh\-feeds\-tv <string>
Alternate source for TV programme data. Valid values: 'ion','ion2','schedule'
.TP
\fB\-\-refresh\-future
Obtain future programme schedule when refreshing cache (between 7\-14 days)
.TP
\fB\-\-refresh\-include <string>
Include matched channel(s) when refreshing cache (regex or comma separated values)
.TP
\fB\-\-refresh\-limit <integer>
Number of days of programmes to cache. Only applied with \-\-refresh\-feeds=schedule. Makes cache updates VERY slow. Default: 7 Min: 1 Max: 30
.TP
\fB\-\-refresh\-limit\-radio <integer>
Number of days of radio programmes to cache. Only applied with \-\-refresh\-feeds=schedule. Makes cache updates VERY slow. Default: 7 Min: 1 Max: 30
.TP
\fB\-\-refresh\-limit\-tv <integer>
Number of days of TV programmes to cache. Only applied with \-\-refresh\-feeds=schedule. Makes cache updates VERY slow. 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\-\-update, \-u
Update get_iplayer if a newer one exists
.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 tagger binary
.TP
\fB\-\-ffmpeg <path>
Location of ffmpeg or avconv binary. Synonyms: \-\-avconv
.TP
\fB\-\-ffmpeg\-obsolete
Indicates you are using an obsolete version of ffmpeg (<0.7) that does not support the \-loglevel option, so \-\-quiet, \-\-verbose and \-\-debug will not be applied to ffmpeg. Synonym: \-\-avconv\-obsolete
.TP
\fB\-\-id3v2 <path>
Location of id3v2 or id3tag binary
.TP
\fB\-\-lame <path>
Location of lame binary
.TP
\fB\-\-mplayer <path>
Location of mplayer binary
.TP
\fB\-\-rtmpdump <path>
Location of rtmpdump binary. Synonyms: \-\-flvstreamer
.TP
\fB\-\-vlc <path>
Location of vlc or cvlc binary
.SS "Tagging Options:"
.TP
\fB\-\-no\-artwork
Do not embed thumbnail image in output file. All other metadata values will be written.
.TP
\fB\-\-no\-tag
Do not tag downloaded programmes
.TP
\fB\-\-tag\-cnid
Use AtomicParsley \-\-cnID argument (if supported) to add catalog ID used for combining HD and SD versions in iTunes
.TP
\fB\-\-tag\-fulltitle
Prepend album/show title to track title
.TP
\fB\-\-tag\-hdvideo
AtomicParsley accepts \-\-hdvideo argument for HD video flag
.TP
\fB\-\-tag\-id3sync
Save ID3 tags for MP3 files in synchronised form. Provides workaround for corruption of thumbnail images in Windows. Has no effect unless using MP3::Tag Perl module.
.TP
\fB\-\-tag\-isodate
Use ISO8601 dates (YYYY\-MM\-DD) in album/show names and track titles
.TP
\fB\-\-tag\-longdesc
AtomicParsley accepts \-\-longdesc argument for long description text
.TP
\fB\-\-tag\-longdescription
AtomicParsley accepts \-\-longDescription argument for long description text
.TP
\fB\-\-tag\-longepisode
Use <episode> instead of <episodeshort> for track title
.TP
\fB\-\-tag\-longtitle
Prepend <series> (if available) to track title. Ignored with \-\-tag\-fulltitle.
.TP
\fB\-\-tag\-podcast
Tag downloaded radio and tv programmes as iTunes podcasts (requires MP3::Tag module for AAC/MP3 files)
.TP
\fB\-\-tag\-podcast\-radio
Tag only downloaded radio programmes as iTunes podcasts (requires MP3::Tag module for AAC/MP3 files)
.TP
\fB\-\-tag\-podcast\-tv
Tag only downloaded tv programmes as iTunes podcasts
.TP
\fB\-\-tag\-shortname
Use <nameshort> instead of <name> for album/show title
.TP
\fB\-\-tag\-utf8
AtomicParsley accepts UTF\-8 input
.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/OSX = 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/OSX = 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/OSX = UTF\-8, Windows = cp1252
.TP
\fB\-\-no\-scrape\-versions
Do not scrape episode web pages as extra measure to find audiodescribed/signed versions (only applies with \-\-playlist\-metadata).
.TP
\fB\-\-playlist\-metadata
Force use of playlists (XML and JSON) for programme metadata instead of /programmes data endpoints.
.TP
\fB\-\-trim\-history <# days to retain>
Remove download history entries older than number of days specified in option value. Cannot specify 0 \- use 'all' to completely delete download history
.SH AUTHOR
get_iplayer was written by Phil Lewis <iplayer2 (at sign) linuxcentre.net> and is now maintained by the contributors at http://www.infradead.org/get_iplayer/html/get_iplayer.html
.PP
This manual page was originally written by Jonathan Wiltshire <[email protected]> for the Debian project (but may be used by others).
.SH COPYRIGHT NOTICE
get_iplayer v2.90, Copyright (C) 2008\-2010 Phil Lewis
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.