castgetrc(5)

1CASTGETRC(5)                     User Commands                    CASTGETRC(5)
2
3
4

NAME

6       castgetrc - configuration file for castget
7

DESCRIPTION

9       The  configuration  file  .castgetrc should be located in a user´s home
10       directory. It defines the behaviour of  the  RSS  enclosure  downloader
11       castget, and in particular the list of channels it operates on.
12
13       The  file is based on a simple key-value format. It consists of a chan‐
14       nel definition for each RSS feed castget should process. A channel def‐
15       inition  starts with a line containing a channel identifier enclosed in
16       brackets. The channel identifier can be freely chosen by the  user  and
17       is  used  for  all subsequent operations on the channel. Following this
18       are one or more key-value pairs on the form key=value that define cast‐
19       get´s  behaviour  when  operating  on the channel. A channel definition
20       ends when another channel definition is started or at the  end  of  the
21       file.
22
23       Lines beginning with a hash character (`#´) and blank lines are consid‐
24       ered comments.  All  identifiers,  keys  and  values  should  be  UTF-8
25       encoded.
26
27       Key-value pairs in a channel definition define the behaviour of castget
28       when processing the channel. The channel definition
29
30
31
32           [fooc]
33           url=http://downloads.bbc.co.uk/podcasts/radio4/fooc/rss.xml
34           spool=/home/joe/podcasts
35
36
37
38       for example, instructs castget to use /home/joe/podcasts as a  download
39       directory when processing the channel fooc.
40

KEYS

42       url    Retrieve  RSS feed from this URL. The field is mandatory for all
43              channel definitions.
44
45       spool  Download enclosures to this directory.
46
47       playlist
48              Write the fully qualified file names of  all  downloaded  enclo‐
49              sures to an m3u style playlist file with this name.
50
51       filter Restrict  operation  to enclosures whose URLs match this regular
52              expression.
53
54       id3leadartist
55              Add or overwrite the `lead artist´ (TPE1) ID3v2  tag  in  enclo‐
56              sures that support this.
57
58       id3contentgroup
59              Add  or overwrite the `content group´ (TIT1) ID3v2 tag in enclo‐
60              sures that support this.
61
62       id3title
63              Add or overwrite the `title´ (TIT2) ID3v2 tag in enclosures that
64              support this.
65
66       id3album
67              Add or overwrite the `album´ (TALB) ID3v2 tag in enclosures that
68              support this.
69
70       id3contenttype
71              Add or overwrite the `content type´ (TCON) ID3v2 tag  in  enclo‐
72              sures that support this.
73
74       id3year
75              Add  or overwrite the `year´ (TYER) ID3v2 tag in enclosures that
76              support this.
77
78       id3comment
79              Add or overwrite the `comment´ (COMM) ID3v2  tag  in  enclosures
80              that support this.
81
82       filename
83              Save  downloads  using  the  given  filename  pattern instead of
84              deriving it from the URL of the  enclosure.  See  FILENAME  PAT‐
85              TERNS.
86

GLOBAL CONFIGURATION

88       A channel definition with the channel identifier * will define a global
89       configuration affecting all channels. The global configuration
90
91
92
93           [*]
94           id3contenttype=Podcast
95
96
97
98       for example, is equivalent to adding  the  key-value  pair  id3content‐
99       type=Podcast to all other channel definitions.
100
101       Key-value  pairs  in channel definitions override the global configura‐
102       tion.
103

FILENAME PATTERNS

105       Filename patterns can contain patterns on the form %(parameter),  which
106       are  expanded  to  form a complete filename. Patterns are expanded once
107       for each enclosure download and can therefore be used to generate file‐
108       names that are unique to each download.
109
110       Anything  that is not a pattern is as a literal that will be reproduced
111       verbatim (subject to some sanity checking). The complete pathname of  a
112       download  is  determined by concatenating the channel´s spool directory
113       with the filename.
114
115       Note that castget will refuse to overwrite  files  that  already  exist
116       except  when it is invoked with the -r option to resume downloads. Some
117       RSS feeds reuse the same filename for all enclosures. In such cases the
118       -r  option will corrupt existing downloads unless you use filename pat‐
119       terns to construct unique filenames.
120
121       The following patterns take information from the item  element  or  the
122       enclosure in the RSS feed:
123
124       ·   %(date): date (by default on the format YYYY-MM-DD)
125
126       ·   %(title): title
127
128
129
130       The  following  take information from the channel element or the enclo‐
131       sure in the RSS feed:
132
133       ·   %(channel_title): channel title
134
135
136
137       If any of the information required by a pattern is missing from the RSS
138       feed  or  is  invalid  the pattern will be ignored and removed from the
139       resulting filename.
140

CHANNEL REMOVAL

142       If a channel configuration is removed, the channel status  remains  the
143       same  so  that  if the channel is subsequently re-added, any enclosures
144       marked as already downloaded will not be downloaded again.
145

NOTE

147       The source distribution includes a  sample  configuration  file  demon‐
148       strating all supported settings.
149

AUTHOR

154       Marius L. Jøhndal.
155
156
157
158castget 2.0.0                    December 2018                    CASTGETRC(5)