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

« back to all changes in this revision

Viewing changes to DOC/podget.man.txt

  • 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
NAME
 
2
  Podget
 
3
 
 
4
SYNOPSIS
 
5
  podget <options> [command]
 
6
  podget -h | --help
 
7
 
 
8
DESCRIPTION
 
9
 
 
10
OPTIONS
 
11
    -c, --config <FILE>          Name of configuration file.
 
12
 
 
13
    -C, --cleanup                Skip downloading and only run cleanup loop.
 
14
 
 
15
    --cleanup_days <NUMBER>      Cleanup files older than <NUMBER> days.
 
16
 
 
17
    --cleanup_simulate           Simulate cleanup loop to see what files would
 
18
                                 be deleted.
 
19
 
 
20
    -d, --dir_config <DIRECTORY>  Directory that configuration files are stored in.
 
21
 
 
22
    -f, --force                  Force download of items from each feed even if
 
23
                                 they've already been downloaded.
 
24
 
 
25
    --import_opml <FILE or URL>  Import servers from OPML file or HTTP/FTP URL.
 
26
    
 
27
    --import_pcast <FILE or URL>  Import server from iTunes PCAST file or HTTP/FTP URL.
 
28
    
 
29
    -l, --library <DIRECTORY>    Directory to store downloaded files in.
 
30
 
 
31
    -p, --playlist-asx           In addition to M3U playlists, create ASX playlists.
 
32
 
 
33
    -r, --recent <COUNT>         Download only the <COUNT> newest items from
 
34
                                 each feed.
 
35
 
 
36
    --serverlist <FILE>          Use <FILE> as serverlist instead of default.
 
37
 
 
38
    -s, --silent                 Run silently (for cron jobs).
 
39
 
 
40
    -v                           Set verbosity to level 1.
 
41
    
 
42
    --verbosity <LEVEL>          Set verbosity level (0-3).
 
43
 
 
44
    -h, --help                   Display help.
 
45
 
 
46
 
 
47
EXAMPLE CRON JOB
 
48
 
 
49
Once podget is running acceptably, its most useful if you run it from a cron job
 
50
so that the new songs are available to play or load onto a portable player and
 
51
you dont have to wait for them to download.
 
52
 
 
53
To edit your crontab, do:
 
54
 
 
55
  $ crontab -e
 
56
 
 
57
Then insert one line (i for insert mode), like the following:
 
58
 
 
59
  15 04 * * * /usr/bin/podget -s
 
60
 
 
61
This will run podget at 4:15 AM every day.
 
62
 
 
63
AUTOMATIC CLEANUP
 
64
 
 
65
You can enabled automatic cleanup with every run by configuring it in your $HOME/.podget/podgetrc file. Simply set the following options:
 
66
 
 
67
  # Autocleanup. 
 
68
  # 0 == disabled
 
69
  # 1 == delete any old content
 
70
  cleanup=1
 
71
 
 
72
  # Number of days to keep files.   Cleanup will remove anything 
 
73
  # older than this.
 
74
  cleanup_days=7
 
75
 
 
76
However, some people prefer to run cleanup as a seperate cron session. To do that, set the options in .podgetrc to:
 
77
 
 
78
  # Autocleanup.
 
79
  # 0 == disabled
 
80
  # 1 == delete any old content
 
81
  cleanup=0
 
82
 
 
83
  # Number of days to keep files.   Cleanup will remove anything
 
84
  # older than this.
 
85
  cleanup_days=7
 
86
 
 
87
And add a cron job to run cleanup, like one of these examples:
 
88
 
 
89
  # Once a week on Sunday at 04:15AM
 
90
  15 04 * * Sun /usr/bin/podget -C
 
91
 
 
92
SESSION CONTROL
 
93
 
 
94
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 -c <configfile> option for each.    
 
95
 
 
96
EXAMPLE SERVER LIST
 
97
 
 
98
By default, Podget uses $HOME/.podget/serverlist for the default list of servers
 
99
to contact.  However you can configure the name with the config_serverlist
 
100
variable in your $HOME/.podget/podgetrc file.
 
101
 
 
102
The default format is: <url> <category> <name>
 
103
 
 
104
Note: Category must be one word.
 
105
 
 
106
Example:
 
107
 
 
108
  # Default Server List for podget
 
109
  # FORMAT:    <url> <category> <name>
 
110
  # NOTE: Category must be one word
 
111
  http://www.distortedview.com/show/index.xml Humor Distorted View
 
112
  http://www.podcastingnews.com/forum/links.php?func=show&id=214 IT In the Trenches
 
113
  http://www.lugradio.org/episodes.rss Linux LUG Radio
 
114
  http://thelinuxlink.net/tllts/tllts.rss Linux The Linux Link
 
115
  http://www.bbc.co.uk/radio4/history/inourtime/mp3/podcast.xml Philosophy BBC: In Our Time
 
116
  http://www.privacyfreaks.org/podcast.php privacy Privacy Freaks
 
117
  http://www.rsasecurity.com/blog/rssfeed.asp security Speaking of Security
 
118
  http://dl.chickencat.com/podcast.php privacy Digital Liberties
 
119
  http://feeds.feedburner.com/LiveAmmo security LiveAmmo
 
120
 
 
121
HANDLING UTF-16 FEEDS
 
122
 
 
123
Some servers provide their feeds in UTF-16 format rather than the more common UTF-8.
 
124
 
 
125
To automatically convert these files, create a secondary serverlist at:
 
126
 
 
127
        $HOME/.podget/serverlist.utf16 
 
128
 
 
129
Remember to change the name of the serverlist to match what you set it to with config_serverlist if you changed it.
 
130
 
 
131
AUTHORS
 
132
  Dave Vehrs