← Back to branch summary

~davewalker/get-iplayer/505433

« back to all changes in this revision

Viewing changes to get_iplayer.1

  • Committer: Bazaar Package Importer
  • Author(s): Jonathan Wiltshire
  • Date: 2009-09-25 19:05:22 UTC
  • mfrom: (1.2.1 upstream) (3.1.1 sid)
  • Revision ID: james.westby@ubuntu.com-20090925190522-ql8tqip7m09ur76m
Tags: 2.39-1
http://bugs.debian.org/543769
http://bugs.debian.org/548342
* New upstream release
* Tidy long description formatting (Closes: #543769)
* Remove suggestion for package lame (Closes: #548342)

Show diffs side-by-side

added added

removed removed

Lines of Context:
get_iplayer.1
1
 
.TH GET_IPLAYER "1" "April 2009" "Jonathan Wiltshire" "get_iplayer Manual"
 
1
.TH GET_IPLAYER "1" "September 2009" "Phil Lewis" "get_iplayer Manual"
2
2
.SH NAME
3
 
get_iplayer \- Stream Recording tool and PVR for BBC iPlayer, Podcasts and more
 
3
get_iplayer \- Stream Recording tool and PVR for BBC iPlayer, ITV, BBC Podcasts and more
4
4
.SH SYNOPSIS
5
 
\fBget_iplayer\fR [<search options>] [<regex|index> ...]
 
5
\fBget_iplayer\fR [<options>] [<regex|index> ...]
6
6
.PP
7
 
\fBget_iplayer\fR \fB\-\-get\fR [<search options>] <regex|index> ...
 
7
\fBget_iplayer\fR \fB\-\-get\fR [<options>] <regex|index> ...
8
8
.br
9
9
\fBget_iplayer\fR \fB\-\-pid\fR=<pid|url> \fB\-\-type\fR=<type> [<options>]
10
10
.PP
49
49
\fB\-\-fields <field1>,<field2>,..
50
50
Searches only in the specified comma separated fields
51
51
.TP
 
52
\fB\-\-history
 
53
Search/show recordings history
 
54
.TP
52
55
\fB\-\-long, \-l
53
56
Additionally search & display long programme descriptions / episode names
54
57
.TP
 
58
\fB\-\-search <search term>
 
59
GetOpt compliant way of specifying search args
 
60
.TP
55
61
\fB\-\-since
56
62
Limit search to programmes added to the cache in the last N hours
57
63
.TP
62
68
Version of programme to search or record (e.g. '\-\-versions signed,audiodescribed,default')
63
69
.SS "Display Options:"
64
70
.TP
 
71
\fB\-\-conditions
 
72
Shows GPLv3 conditions
 
73
.TP
 
74
\fB\-\-debug
 
75
Debug output
 
76
.TP
65
77
\fB\-\-dump\-options
66
78
Dumps all options with their internal option key names
67
79
.TP
 
80
\fB\-\-help, \-h
 
81
Intermediate help text
 
82
.TP
 
83
\fB\-\-helpbasic, \-\-usage
 
84
Basic help text
 
85
.TP
 
86
\fB\-\-helplong
 
87
Advanced help text
 
88
.TP
68
89
\fB\-\-hide
69
90
Hide previously recorded programmes
70
91
.TP
83
104
\fB\-\-manpage <file>
84
105
Create man page based on current help text
85
106
.TP
 
107
\fB\-\-nocopyright
 
108
Don't display copyright header
 
109
.TP
 
110
\fB\-\-page <number>
 
111
Page number to display for multipage output
 
112
.TP
 
113
\fB\-\-pagesize <number>
 
114
Number of matches displayed on a page for multipage output
 
115
.TP
 
116
\fB\-\-quiet, \-q
 
117
No logging output
 
118
.TP
 
119
\fB\-\-series
 
120
Display Programme series names only with number of episodes
 
121
.TP
86
122
\fB\-\-show\-options
87
123
Shows options which are set and where they are defined
88
124
.TP
 
125
\fB\-\-sort <fieldname>
 
126
Field to use to sort displayed matches
 
127
.TP
 
128
\fB\-\-sortreverse
 
129
Reverse order of sorted matches
 
130
.TP
89
131
\fB\-\-streaminfo
90
132
Returns all of the media stream urls of the programme(s)
91
133
.TP
94
136
.TP
95
137
\fB\-\-tree
96
138
Display Programme listings in a tree view
 
139
.TP
 
140
\fB\-\-verbose, \-v
 
141
Verbose
 
142
.TP
 
143
\fB\-\-warranty
 
144
Displays warranty section of GPLv3
97
145
.SS "Recording Options:"
98
146
.TP
99
147
\fB\-\-attempts <number>
171
219
\fB\-\-subtitles
172
220
Download subtitles into srt/SubRip format if available and supported
173
221
.TP
 
222
\fB\-\-subtitles\-only
 
223
Only download the subtitles, not the programme
 
224
.TP
174
225
\fB\-\-test, \-t
175
226
Test only \- no recording (will show programme type)
176
227
.TP
177
228
\fB\-\-thumb
178
229
Download Thumbnail image if available
179
230
.TP
180
 
\fB\-\-thumb\-ext <ext>
181
 
Thumbnail filename extension to use
 
231
\fB\-\-thumbnail\-only
 
232
Only Download Thumbnail image if available, not the programme
182
233
.TP
183
234
\fB\-\-tvmode <mode>,<mode>,...
184
235
TV Recoding modes: iphone,rtmp,flashhd,flashvhigh,flashhigh,flashstd,flashnormal,flashlow,n95_wifi (default: iphone,flashhigh,flashstd,flashnormal)
217
268
\fB\-\-output, \-o <dir>
218
269
Default Recording output directory
219
270
.TP
 
271
\fB\-\-outputitv <dir>
 
272
Output directory for itv recordings
 
273
.TP
220
274
\fB\-\-outputliveradio <dir>
221
275
Output directory for live radio recordings
222
276
.TP
223
277
\fB\-\-outputlivetv <dir>
224
278
Output directory for live tv recordings
225
279
.TP
 
280
\fB\-\-outputlocalfiles <dir>
 
281
Output directory for localfiles recordings
 
282
.TP
 
283
\fB\-\-outputpodcast <dir>
 
284
Output directory for podcast recordings
 
285
.TP
226
286
\fB\-\-outputradio <dir>
227
287
Output directory for radio recordings
228
288
.TP
232
292
\fB\-\-player '<command> <options>'
233
293
Use specified command to directly play the stream
234
294
.TP
235
 
\fB\-\-quiet, \-q
236
 
No logging output
237
 
.TP
238
295
\fB\-\-stdout, \-x
239
296
Additionally stream to STDOUT (so you can pipe output to a player)
240
297
.TP
247
304
\fB\-\-symlink <file>
248
305
Create symlink to <file> once we have the header of the recording
249
306
.TP
 
307
\fB\-\-thumb\-ext <ext>
 
308
Thumbnail filename extension to use
 
309
.TP
 
310
\fB\-\-thumbsize <index|width>
 
311
Default thumbnail size/index to use for the current recording and metadata (see \-\-info for thumbnailN: to get size/index)
 
312
.TP
 
313
\fB\-\-thumbsizecache <index|width>
 
314
Default thumbnail size/index to use when building cache and index (see \-\-info for thumbnailN: to get size/index)
 
315
.TP
250
316
\fB\-\-whitespace, \-w
251
317
Keep whitespace (and escape chars) in filenames
252
318
.TP
288
354
Add currently matched programmes to queue for later one\-off recording using the \-\-pvr option
289
355
.SS "Config Options:"
290
356
.TP
291
 
\fB\-\-debug
292
 
Debug output
293
 
.TP
294
357
\fB\-\-expiry, \-e <secs>
295
358
Cache expiry in seconds (default 4hrs)
296
359
.TP
297
360
\fB\-\-flush, \-\-refresh, \-f
298
361
Refresh cache
299
362
.TP
300
 
\fB\-\-help, \-h
301
 
This help text
302
 
.TP
303
 
\fB\-\-helplong
304
 
Advanced options help text
 
363
\fB\-\-localfilesdirs <dir>[,dir,]
 
364
Directories/Folders to scan for new files
305
365
.TP
306
366
\fB\-\-nopurge
307
367
Don't ask to delete programmes recorded over 30 days ago
308
368
.TP
 
369
\fB\-\-packagemanager <string>
 
370
Tell the updater that we were installed using a package manager and don't update (use either: apt,rpm,deb,yum,disable)
 
371
.TP
309
372
\fB\-\-plugins\-update
310
373
Update get_iplayer plugins to the latest
311
374
.TP
333
396
\fB\-\-update, \-u
334
397
Update get_iplayer if a newer one exists
335
398
.TP
336
 
\fB\-\-verbose, \-v
337
 
Verbose
 
399
\fB\-\-webrequest <urlencoded string>
 
400
Specify all options as a urlencoded string of "name=val&name=val&..."
338
401
.SS "External Program Options:"
339
402
.TP
340
403
\fB\-\-ffmpeg <path>
354
417
.TP
355
418
\fB\-\-vlc <path>
356
419
Location of vlc or cvlc binary
357
 
.SS "Misc Options:"
358
 
.TP
359
 
\fB\-\-conditions
360
 
Shows GPL conditions
361
 
.TP
362
 
\fB\-\-nocopyright
363
 
Don't display copyright header
364
 
.TP
365
 
\fB\-\-packagemanager <string>
366
 
Tell the updater that we were installed using a package manager and don't update (use either: apt,rpm,deb,yum,disable)
367
 
.TP
368
 
\fB\-\-search <search term>
369
 
GetOpt compliant way of specifying search args
370
 
.TP
371
 
\fB\-\-warranty
372
 
Displays warranty section of GPL
373
 
.TP
374
 
\fB\-\-webrequest <urlencoded string>
375
 
Specify all options as a urlencoded string of "name=val&name=val&..."
376
420
.SH AUTHOR
377
421
get_iplayer is written and maintained by Phil Lewis <iplayer2 (at sign) linuxcentre.net>.
378
422
.PP
379
423
This manual page was originally written by Jonathan Wiltshire <debian@jwiltshire.org.uk> for the Debian project (but may be used by others).
380
424
.SH COPYRIGHT NOTICE
381
 
get_iplayer v2.26, Copyright (C) 2009 Phil Lewis
 
425
get_iplayer v2.39, Copyright (C) 2009 Phil Lewis
382
426
  This program comes with ABSOLUTELY NO WARRANTY; for details use \-\-warranty.
383
427
  This is free software, and you are welcome to redistribute it under certain
384
428
  conditions; use \-\-conditions for details.