'\" t .\" Title: Podboat .\" Author: Alexander Batischev .\" Generator: DocBook XSL Stylesheets v1.79.1 .\" Date: 12/29/2017 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" .TH "PODBOAT" "1" "12/29/2017" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" podboat \- a podcast download manager for text terminals .SH "SYNOPSIS" .sp \fIpodboat\fR [\-C configfile] [\-q queuefile] [\-a] [\-h] .SH "DESCRIPTION" .sp \fIpodboat\fR is a podcast manager for text terminals\&. It is a helper program to \fInewsboat\fR which queues podcast downloads into a file\&. These queued downloads can then be download with \fInewsboat\fR\&. .SH "OPTIONS" .PP \-h, \-\-help .RS 4 Display help .RE .PP \-C configfile, \-\-config\-file=configfile .RS 4 Use an alternative configuration file .RE .PP \-q queuefile, \-\-queue\-file=queuefile .RS 4 Use an alternative queue file .RE .PP \-a, \-\-autodownload .RS 4 Start automatic download of all queued files on startup .RE .PP \-l loglevel, \-\-log\-level=loglevel .RS 4 Generate a logfile with a certain loglevel\&. Valid loglevels are 1 to 6\&. An actual logfile will only be written when you provide a logfile name\&. .RE .PP \-d logfile, \-\-log\-file=logfile .RS 4 Use this logfile as output when logging debug messages\&. Please note that this only works when providing a loglevel\&. .RE .SH "PODCAST SUPPORT" .sp A podcast is a media file distributed over the internet using syndication feeds such as RSS, for later playback on portable players or computers\&. Newsboat contains support for downloading and saving podcasts\&. This support differs a bit from other podcast aggregators or "podcatchers" in how it is done\&. .sp Podcast content is transported in RSS feeds via special tags called "enclosures"\&. Newsboat recognizes these enclosures and stores the relevant information for every podcast item it finds in an RSS feed\&. Since version 2\&.0, it also recognizes and handles the Yahoo Media RSS extensions\&. What the user then can do is to add the podcast download URL to a download queue\&. Alternatively, newsboat can be configured to automatically do that\&. This queue is stored in the file \fI$HOME/\&.newsboat/queue\fR\&. .sp The user can then use the download manager podboat to download these files to a directory on the local filesystem\&. Podboat comes with the newsboat package, and features a look and feel very close to the one of newsboat\&. It also shares the same configuration file\&. .sp Podcasts that have been downloaded but haven\(cqt been played yet remain in the queue but are marked as downloaded\&. You can remove them by purging them from the queue with the "P" key\&. After you\(cqve played a file and close podboat, it will be removed from the queue\&. The downloaded file remains on the filesystem\&. .SH "CONFIGURATION COMMANDS" .PP \fIdownload\-path\fR (parameters: ; default value: \fI~/\fR) .RS 4 Specifies the directory where podboat shall download the files to\&. Optionally, the placeholders "%n" (for the podcast feed\(cqs name) and "%h" (for the podcast feed\(cqs hostname) can be used to place downloads in a directory structure\&. (example: download\-path "~/Downloads/%h/%n") .RE .PP \fImax\-downloads\fR (parameters: ; default value: \fI1\fR) .RS 4 Specifies the maximum number of parallel downloads when automatic download is enabled\&. (example: max\-downloads 3) .RE .PP \fIplayer\fR (parameters: ; default value: \fI""\fR) .RS 4 Specifies the player that shall be used for playback of downloaded files\&. (example: player "mp3blaster") .RE .SH "XDG BASE DIRECTORY SUPPORT" .sp Podboat defaults to storing everything in \fI$HOME/\&.newsboat\fR directory\&. If you prefer XDG, create \fI$HOME/\&.config/newsboat\fR and \fI$HOME/\&.local/share/newsboat\fR directories, and Podboat will use them from there on\&. .sp If you already have some files in \fI$HOME/\&.newsboat/\fR, move the \fIqueue\fR file to \fI$HOME/\&.local/share/newsboat/\fR, and that should be it\&. .sp See also a corresponding section in newsboat(1)\&. .SH "FILES" .PP dotfiles .RS 4 \fI$HOME/\&.newsboat/config\fR \fI$HOME/\&.newsboat/urls\fR .RE .PP XDG .RS 4 \fI$HOME/\&.config/newsboat/config\fR \fI$HOME/\&.config/newsboat/urls\fR .RE .SH "SEE ALSO" .sp newsboat(1) .SH "AUTHOR" .PP \fBAlexander Batischev\fR <\&eual\&.jp@gmail\&.com\&> .RS 4 Author. .RE