FreeBSD Manual Pages
CASTGETRC(5) User Commands CASTGETRC(5) NAME castgetrc - configuration file for castget DESCRIPTION The configuration file .castgetrc should be located in a user's home directory. It defines the behaviour of the RSS enclosure downloader castget, and in particular the list of channels it operates on. The file is based on a simple key-value format. It consists of a chan- nel definition for each RSS feed castget should process. A channel def- inition starts with a line containing a channel identifier enclosed in brackets. The channel identifier can be freely chosen by the user and is used for all subsequent operations on the channel. Following this are one or more key-value pairs on the form key=value that define cast- get's behaviour when operating on the channel. A channel definition ends when another channel definition is started or at the end of the file. Lines beginning with a hash character (`#') and blank lines are consid- ered comments. All identifiers, keys and values should be UTF-8 en- coded. Key-value pairs in a channel definition define the behaviour of castget when processing the channel. The channel definition [fooc] url=http://downloads.bbc.co.uk/podcasts/radio4/fooc/rss.xml spool=/home/joe/podcasts for example, instructs castget to use /home/joe/podcasts as a download directory when processing the channel fooc. Directory names and filenames with spaces do not need to be quoted or escaped. KEYS url Retrieve RSS feed from this URL. The field is mandatory for all channel definitions. spool Download enclosures to this directory. playlist Write the fully qualified file names of all downloaded enclo- sures to an m3u style playlist file with this name. filter Restrict operation to enclosures whose URLs match this regular expression. title_tag Add or set the title tag in the media file (e.g. `title' (TIT2) in ID3v2). album_tag Add or set the album tag in the media file (e.g. `album' (TALB) in ID3v2). genre_tag Add or set the genre tag in the media file (e.g. `content type' (TCON) in ID3v2). year_tag Add or set the year tag in the media file (e.g. `year' (TYER) in ID3v2). comment_tag Add or set the comment tag in the media file (e.g. `comment' (COMM) in ID3v2). filename Save downloads using the given filename pattern instead of de- riving it from the URL of the enclosure. See FILENAME PATTERNS. GLOBAL CONFIGURATION A channel definition with the channel identifier * will define a global configuration affecting all channels. The global configuration [*] genre_tag=Podcast for example, is equivalent to adding the key-value pair genre_tag=Pod- cast to all other channel definitions. Key-value pairs in channel definitions override the global configura- tion. FILENAME PATTERNS Filename patterns can contain patterns on the form %(parameter), which are expanded to form a complete filename. Patterns are expanded once for each enclosure download and can therefore be used to generate file- names that are unique to each download. Anything that is not a pattern is as a literal that will be reproduced verbatim (subject to some sanity checking). The complete pathname of a download is determined by concatenating the channel's spool directory with the filename. Note that castget will refuse to overwrite files that already exist ex- cept when it is invoked with the -r option to resume downloads. Some RSS feeds reuse the same filename for all enclosures. In such cases the -r option will corrupt existing downloads unless you use filename pat- terns to construct unique filenames. The following patterns take information from the item element or the enclosure in the RSS feed: • %(date): date (by default on the format YYYY-MM-DD) • %(title): title The following take information from the channel element or the enclo- sure in the RSS feed: • %(channel_title): channel title If any of the information required by a pattern is missing from the RSS feed or is invalid the pattern will be ignored and removed from the re- sulting filename. CHANNEL REMOVAL If a channel configuration is removed, the channel status remains the same so that if the channel is subsequently re-added, any enclosures marked as already downloaded will not be downloaded again. NOTE The source distribution includes a sample configuration file demon- strating all supported settings. SEE ALSO castget(1) AUTHOR Marius L. Jhndal. castget 2.0.1 February 2022 CASTGETRC(5)
NAME | DESCRIPTION | KEYS | GLOBAL CONFIGURATION | FILENAME PATTERNS | CHANNEL REMOVAL | NOTE | SEE ALSO | AUTHOR
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=castgetrc&sektion=5&manpath=FreeBSD+Ports+14.3.quarterly>