.\"Text automatically generated by txt2man
.TH podget 7
.SH NAME
\fBPodget \- Simple tool to automate downloading of podcasts.
\fB
.SH SYNOPSIS
.nf
.fam C
\fBpodget\fP <options> [\fIcommand\fP]
\fBpodget\fP \fB-h\fP | \fB--help\fP

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION

.SH OPTIONS
.TP
.B
\fB-c\fP, \fB--config\fP <FILE>
Name of configuration file.
.TP
.B
\fB--create-config\fP <FILE>
Create configuration file.
.TP
.B
\fB-C\fP, \fB--cleanup\fP
Skip downloading and only run cleanup loop.
.TP
.B
\fB--cleanup_days\fP <NUMBER>
Cleanup files older than <NUMBER> days.
.TP
.B
\fB--cleanup_simulate\fP
Simulate cleanup loop to see what files would
be deleted.
.TP
.B
\fB-d\fP, \fB--dir_config\fP <DIRECTORY>
Directory that configuration files are stored in.
.TP
.B
\fB-f\fP, \fB--force\fP
Force download of items from each feed even if
they've already been downloaded.
.TP
.B
\fB--import_opml\fP <FILE or URL>
Import servers from OPML file or HTTP/FTP URL.
.TP
.B
\fB--export_opml\fP <FILE>
Export serverlist to OPML file.
.TP
.B
\fB--import_pcast\fP <FILE or URL>
Import server from iTunes PCAST file or HTTP/FTP URL.
.TP
.B
\fB-l\fP, \fB--library\fP <DIRECTORY>
Directory to store downloaded files in.
.TP
.B
\fB-p\fP, \fB--playlist-asx\fP
In addition to M3U playlists, create ASX playlists.
.TP
.B
\fB-r\fP, \fB--recent\fP <COUNT>
Download only the <COUNT> newest items from
each feed.
.TP
.B
\fB--serverlist\fP <FILE>
Use <FILE> as serverlist instead of default.
.TP
.B
\fB-s\fP, \fB--silent\fP
Run silently (for cron jobs).
.TP
.B
\fB-v\fP
Set verbosity to level 1.
.TP
.B
\fB--verbosity\fP <LEVEL>
Set verbosity level (0-3).
.TP
.B
\fB-h\fP, \fB--help\fP
Display help.
.RE
.PP

.SH EXAMPLE CRON JOB

Once \fBpodget\fP is running acceptably, its most useful if you run it from a cron job
so that the new songs are available to play or load onto a portable player and
you don't have to wait for them to download.
.PP
To edit your crontab, do:
.PP
.nf
.fam C
  $ crontab \-e

.fam T
.fi
Then insert one line (i for insert mode), like the following:
.PP
.nf
.fam C
  15 04 * * * /usr/bin/podget \-s

.fam T
.fi
This will run \fBpodget\fP at 4:15 AM every day.
.SH AUTOMATIC CLEANUP

You can enabled automatic cleanup with every run by configuring it in your $HOME/.\fBpodget\fP/podgetrc file. Simply set the following options:
.PP
.nf
.fam C
  # Autocleanup. 
  # 0 == disabled
  # 1 == delete any old content
  cleanup=1

  # Number of days to keep files.   Cleanup will remove anything 
  # older than this.
  cleanup_days=7

.fam T
.fi
However, some people prefer to run cleanup as a separate cron session. To do that, set the options in .podgetrc to:
.PP
.nf
.fam C
  # Autocleanup.
  # 0 == disabled
  # 1 == delete any old content
  cleanup=0

  # Number of days to keep files.   Cleanup will remove anything
  # older than this.
  cleanup_days=7

.fam T
.fi
And add a cron job to run cleanup, like one of these examples:
.PP
.nf
.fam C
  # Once a week on Sunday at 04:15AM
  15 04 * * Sun /usr/bin/podget \-C

.fam T
.fi
.SH SESSION CONTROL

.TP
.B
Podget checks for already running sessions when it starts and exits if any are found.
Each session requires its own core configuration file, so for multiple sessions simply provide a unique \fB-c\fP <configfile> option for each.    
.SH EXAMPLE SERVER LIST

By default, Podget uses $HOME/.\fBpodget\fP/serverlist for the default list of servers
.TP
.B
to contact.
However you can configure the name with the config_serverlist
variable in your $HOME/.\fBpodget\fP/podgetrc file.
.PP
The default format is: <url> <category> <name>
.PP
NOTES:
.RS
.IP 1. 4
URL Rules:
A. Any spaces in the URL needs to be converted to %20 
.IP 2. 4
Category Rules:
.RS
.TP
.B
A.
Must be one word without spaces. 
.TP
.B
B.
You may use underscores and dashes.
.TP
.B
C.
You can insert date substitions.
.RS
.TP
.B
%YY%
==  Year
.TP
.B
%MM%
==  Month
.TP
.B
%DD%
==  Day
.RE
.RE
.IP 3. 4
Name Rules:
.RS
.TP
.B
A.
If you are creating ASX playlists, make sure the feed name does not
have any spaces in it.
.TP
.B
B.
You can leave the feed name blank, and files will be saved in the category directory.
.RE
.IP 4. 4
Disable the downloading of any feed by commenting it out with a #.
.RE
.PP
Examples:
.PP
.nf
.fam C
  http://www.podcastingnews.com/forum/links.php?func=show&id=214 IT In the Trenches
  http://www.lugradio.org/episodes.rss Linux LUG Radio
  http://thelinuxlink.net/tllts/tllts.rss Linux The Linux Link
  http://www.bbc.co.uk/radio4/history/inourtime/mp3/podcast.xml Philosophy BBC: In Our Time
  http://www.privacyfreaks.org/podcast.php privacy Privacy Freaks
  http://dl.chickencat.com/podcast.php privacy Digital Liberties

  Example with date substitution in the category and a blank feed name.
  http://downloads.bbc.co.uk/rmhttp/downloadtrial/worldservice/summary/rss.xml News-%YY%-%MM%-%DD%

.fam T
.fi
HANDLING UTF-16 FEEDS
.PP
Some servers provide their feeds in UTF-16 format rather than the more common UTF-8.
.PP
To automatically convert these files, create a secondary serverlist at:
.PP
.nf
.fam C
        $HOME/.podget/serverlist.utf16 

.fam T
.fi
Remember to change the name of the serverlist to match what you set it to with config_serverlist if you changed it.
.SH AUTHORS
Dave Vehrs