~ubuntu-branches/ubuntu/trusty/podget/trusty

« back to all changes in this revision

Viewing changes to DOC/podget.7

  • Committer: Bazaar Package Importer
  • Author(s): Dave Vehrs
  • Date: 2007-01-23 13:19:37 UTC
  • Revision ID: james.westby@ubuntu.com-20070123131937-7mkbeyf0896fkpf6
Tags: upstream-0.5.8
ImportĀ upstreamĀ versionĀ 0.5.8

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
." Text automatically generated by txt2man-1.4.7
 
2
.TH podget.man 7 "January 06, 2007" "DOC" "Linux Reference Manual"
 
3
.SH NAME
 
4
\fBPodget
 
5
\fB
 
6
.SH SYNOPSIS
 
7
.nf
 
8
.fam C
 
9
\fBpodget\fP <options> [\fIcommand\fP]
 
10
\fBpodget\fP \fB-h\fP | \fB--help\fP
 
11
.fam T
 
12
.fi
 
13
.SH DESCRIPTION
 
14
 
 
15
.SH OPTIONS
 
16
.TP
 
17
.B
 
18
\fB-c\fP, \fB--config\fP <FILE>
 
19
Name of configuration file.
 
20
.TP
 
21
.B
 
22
\fB-C\fP, \fB--cleanup\fP
 
23
Skip downloading and only run cleanup loop.
 
24
.TP
 
25
.B
 
26
\fB--cleanup_days\fP <NUMBER>
 
27
Cleanup files older than <NUMBER> days.
 
28
.TP
 
29
.B
 
30
\fB--cleanup_simulate\fP
 
31
Simulate cleanup loop to see what files would
 
32
be deleted.
 
33
.TP
 
34
.B
 
35
\fB-d\fP, \fB--dir_config\fP <DIRECTORY>
 
36
Directory that configuration files are stored in.
 
37
.TP
 
38
.B
 
39
\fB-f\fP, \fB--force\fP
 
40
Force download of items from each feed even if
 
41
they've already been downloaded.
 
42
.TP
 
43
.B
 
44
\fB--import_opml\fP <FILE or URL>
 
45
Import servers from OPML file or HTTP/FTP URL.
 
46
.TP
 
47
.B
 
48
\fB--import_pcast\fP <FILE or URL>
 
49
Import server from iTunes PCAST file or HTTP/FTP URL.
 
50
.TP
 
51
.B
 
52
\fB-l\fP, \fB--library\fP <DIRECTORY>
 
53
Directory to store downloaded files in.
 
54
.TP
 
55
.B
 
56
\fB-p\fP, \fB--playlist-asx\fP
 
57
In addition to M3U playlists, create ASX playlists.
 
58
.TP
 
59
.B
 
60
\fB-r\fP, \fB--recent\fP <COUNT>
 
61
Download only the <COUNT> newest items from
 
62
each feed.
 
63
.TP
 
64
.B
 
65
\fB--serverlist\fP <FILE>
 
66
Use <FILE> as serverlist instead of default.
 
67
.TP
 
68
.B
 
69
\fB-s\fP, \fB--silent\fP
 
70
Run silently (for cron jobs).
 
71
.TP
 
72
.B
 
73
\fB-v\fP
 
74
Set verbosity to level 1.
 
75
.TP
 
76
.B
 
77
\fB--verbosity\fP <LEVEL>
 
78
Set verbosity level (0-3).
 
79
.TP
 
80
.B
 
81
\fB-h\fP, \fB--help\fP
 
82
Display help.
 
83
.RE
 
84
.PP
 
85
 
 
86
.SH EXAMPLE CRON JOB
 
87
 
 
88
Once \fBpodget\fP is running acceptably, its most useful if you run it from a cron job
 
89
so that the new songs are available to play or load onto a portable player and
 
90
you dont have to wait for them to download.
 
91
.PP
 
92
To edit your crontab, do:
 
93
.PP
 
94
.nf
 
95
.fam C
 
96
  $ crontab -e
 
97
 
 
98
.fam T
 
99
.fi
 
100
Then insert one line (i for insert mode), like the following:
 
101
.PP
 
102
.nf
 
103
.fam C
 
104
  15 04 * * * /usr/bin/podget -s
 
105
 
 
106
.fam T
 
107
.fi
 
108
This will run \fBpodget\fP at 4:15 AM every day.
 
109
.SH AUTOMATIC CLEANUP
 
110
 
 
111
You can enabled automatic cleanup with every run by configuring it in your $HOME/.\fBpodget\fP/podgetrc file. Simply set the following options:
 
112
.PP
 
113
.nf
 
114
.fam C
 
115
  # Autocleanup. 
 
116
  # 0 == disabled
 
117
  # 1 == delete any old content
 
118
  cleanup=1
 
119
 
 
120
  # Number of days to keep files.   Cleanup will remove anything 
 
121
  # older than this.
 
122
  cleanup_days=7
 
123
 
 
124
.fam T
 
125
.fi
 
126
However, some people prefer to run cleanup as a seperate cron session. To do that, set the options in .podgetrc to:
 
127
.PP
 
128
.nf
 
129
.fam C
 
130
  # Autocleanup.
 
131
  # 0 == disabled
 
132
  # 1 == delete any old content
 
133
  cleanup=0
 
134
 
 
135
  # Number of days to keep files.   Cleanup will remove anything
 
136
  # older than this.
 
137
  cleanup_days=7
 
138
 
 
139
.fam T
 
140
.fi
 
141
And add a cron job to run cleanup, like one of these examples:
 
142
.PP
 
143
.nf
 
144
.fam C
 
145
  # Once a week on Sunday at 04:15AM
 
146
  15 04 * * Sun /usr/bin/podget -C
 
147
 
 
148
.fam T
 
149
.fi
 
150
.SH SESSION CONTROL
 
151
 
 
152
.TP
 
153
.B
 
154
Podget checks for already running sessions when it starts and exits if any are found.
 
155
Each session requires its own core configuration file, so for multiple sessions simply provide a unique \fB-c\fP <configfile> option for each.    
 
156
.SH EXAMPLE SERVER LIST
 
157
 
 
158
By default, Podget uses $HOME/.\fBpodget\fP/serverlist for the default list of servers
 
159
.TP
 
160
.B
 
161
to contact.
 
162
However you can configure the name with the config_serverlist
 
163
variable in your $HOME/.\fBpodget\fP/podgetrc file.
 
164
.PP
 
165
The default format is: <url> <category> <name>
 
166
.PP
 
167
Note: Category must be one word.
 
168
.PP
 
169
Example:
 
170
.PP
 
171
.nf
 
172
.fam C
 
173
  # Default Server List for podget
 
174
  # FORMAT:    <url> <category> <name>
 
175
  # NOTE: Category must be one word
 
176
  http://www.distortedview.com/show/index.xml Humor Distorted View
 
177
  http://www.podcastingnews.com/forum/links.php?func=show&id=214 IT In the Trenches
 
178
  http://www.lugradio.org/episodes.rss Linux LUG Radio
 
179
  http://thelinuxlink.net/tllts/tllts.rss Linux The Linux Link
 
180
  http://www.bbc.co.uk/radio4/history/inourtime/mp3/podcast.xml Philosophy BBC: In Our Time
 
181
  http://www.privacyfreaks.org/podcast.php privacy Privacy Freaks
 
182
  http://www.rsasecurity.com/blog/rssfeed.asp security Speaking of Security
 
183
  http://dl.chickencat.com/podcast.php privacy Digital Liberties
 
184
  http://feeds.feedburner.com/LiveAmmo security LiveAmmo
 
185
 
 
186
.fam T
 
187
.fi
 
188
HANDLING UTF-16 FEEDS
 
189
.PP
 
190
Some servers provide their feeds in UTF-16 format rather than the more common UTF-8.
 
191
.PP
 
192
To automatically convert these files, create a secondary serverlist at:
 
193
.PP
 
194
.nf
 
195
.fam C
 
196
        $HOME/.podget/serverlist.utf16 
 
197
 
 
198
.fam T
 
199
.fi
 
200
Remember to change the name of the serverlist to match what you set it to with config_serverlist if you changed it.
 
201
.SH AUTHORS
 
202
Dave Vehrs