1PODBOAT(1) PODBOAT(1)
2
6 podboat - a podcast download manager for text terminals
7
9 podboat [-C configfile] [-q queuefile] [-a] [-h]
10
12 podboat is a podcast manager for text terminals. It is a helper program
13 to newsboat which queues podcast downloads into a file. These queued
14 downloads can then be download with podboat.
15
17 -h, --help
18 Display help
19 -C configfile, --config-file=configfile
21 Use an alternative configuration file
22 -q queuefile, --queue-file=queuefile
24 Use an alternative queue file
25 -a, --autodownload
27 Start automatic download of all queued files on startup
28 -l loglevel, --log-level=loglevel
30 Generate a logfile with a certain loglevel. Valid loglevels are 1
31 to 6. An actual logfile will only be written when you provide a
32 logfile name.
33 -d logfile, --log-file=logfile
35 Use this logfile as output when logging debug messages. Please note
36 that this only works when providing a loglevel.
37
39 A podcast is a media file distributed over the internet using
40 syndication feeds such as RSS, for later playback on portable players
41 or computers. Newsboat contains support for downloading and saving
42 podcasts. This support differs a bit from other podcast aggregators or
43 "podcatchers" in how it is done.
44 Podcast content is transported in RSS feeds via special tags called
46 "enclosures". Newsboat recognizes these enclosures and stores the
47 relevant information for every podcast item it finds in an RSS feed.
48 Since version 2.0, it also recognizes and handles the Yahoo Media RSS
49 extensions. What the user then can do is to add the podcast download
50 URL to a download queue. Alternatively, newsboat can be configured to
51 automatically do that. This queue is stored in the queue file next to
52 the cache.db file.
53 The user can then use the download manager podboat to download these
55 files to a directory on the local filesystem. Podboat comes with the
56 newsboat package, and features a look and feel very close to the one of
57 newsboat. It also shares the same configuration file.
58 Podcasts that have been downloaded but haven’t been played yet remain
60 in the queue but are marked as downloaded. You can remove them by
61 purging them from the queue with the "P" key. After you’ve played a
62 file and close podboat, it will be removed from the queue. The
63 downloaded file remains on the filesystem unless "delete-played-files"
64 is enabled.
65
67 delete-played-files (parameters: [yes/no]; default value: no)
68 If set to yes, podboat will delete files when their corresponding
69 queue entry is removed (this includes "finished" and "deleted"
70 entries as well). (example: delete-played-files yes)
71 download-path (parameters: <path>; default value: ~/)
73 Specifies the directory where podboat shall download the files to.
74 Optionally, placeholders can be used to place downloads in a
75 directory structure. See "Format Strings" section of Newsboat
76 manual for details on available formats. This setting is applied at
77 enqueueing time; changing it won’t affect download paths of the
78 podcasts that were already added to the queue. (example:
79 download-path "~/Downloads/%h/%n")
80 download-filename-format (parameters: <string>; default value:
82 "%?u?%u&%Y-%b-%d-%H%M%S.unknown?")
83 Specifies how podboat would name the files it downloads (see also
84 download-path). See "Format Strings" section of Newsboat manual for
85 details on available formats. (example: download-filename-format
86 "%F-%t.%e")
87 max-downloads (parameters: <number>; default value: 1)
89 Specifies the maximum number of parallel downloads when automatic
90 download is enabled. (example: max-downloads 3)
91 player (parameters: <player command>; default value: "")
93 Specifies the player that shall be used for playback of downloaded
94 files. (example: player "mp3blaster")
95 podlist-format (parameters: <format>; default value: "%4i [%6dMB/%6tMB]
97 [%5p %%] [%12K] %-20S %u → %F")
98 This variable defines the format of entries in podboat’s download
99 list. See the respective section in the documentation for more
100 information on format strings. (example: podlist-format "%i %u
101 %-20S %F")
102
104 By default, Newsboat stores all the files in a traditional Unix
105 fashion, i.e. in the "dotdir" located at ~/.newsboat. However, it also
106 supports a modern way, XDG Base Directory Specification
107 <https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>,
108 which splits the files between the following locations:
109 · ~/.local/share/newsboat/
111 · ~/.config/newsboat/
113 If these directories exist or the environment variables
115 $XDG_CONFIG_HOME and $XDG_DATA_HOME are set, newsboat will use these
116 directories, otherwise it will default to ~/.newsboat as its
117 configuration directory.
118 If you’re currently using ~/.newsboat/ but wish to migrate to XDG
120 directories, you should move the files as follows:
121 config, urls
123 to $HOME/.config/newsboat/
124 cache.db, history.search, history.cmdline, queue
126 to $HOME/.local/share/newsboat/
127 dotfiles
129 $HOME/.newsboat/config
130 $HOME/.newsboat/queue
132 XDG
134 $HOME/.config/newsboat/config
135 $HOME/.local/share/newsboat/queue
137
139 BROWSER
140 Tells Newsboat what browser to use if there is no browser setting
141 in the config file. If this variable doesn’t exist, a default of
142 lynx(1) will be used.
143 CURL_CA_BUNDLE
145 Tells Newsboat to use the specified certificate file to verify the
146 peer. The file may contain multiple certificates. The
147 certificate(s) must be in PEM format.
148 This option is useful if your libcurl is built without useful
150 certificate information, and you can’t rebuild the library
151 yourself.
152 EDITOR
154 Tells Newsboat what fallback editor to use when editing the urls
155 file via the edit-urls operation and no VISUAL environment variable
156 is set. If this variable doesn’t exist either, a default of vi(1)
157 will be used.
158 PAGER
160 Tells Newsboat what pager to use if the pager setting in the config
161 file is explicitly set to an empty string.
162 TMPDIR
164 Tells Newsboat to use the specified directory for storing temporary
165 files. If this variable doesn’t exist, a default of /tmp will be
166 used.
167 VISUAL
169 Tells Newsboat what editor to use when editing the urls file via
170 the edit-urls operation. If this variable doesn’t exist, the EDITOR
171 environment variable will be used.
172 XDG_CONFIG_HOME
174 Tells Newsboat which base directory to use for the configuration
175 files. See also the section on files for more information.
176 XDG_DATA_HOME
178 Tells Newsboat which base directory to use for the data files. See
179 also the section on files for more information.
180
182 newsboat(1)
183
185 Alexander Batischev
186 2020-07-28 PODBOAT(1)