This repository has been archived on 2021-11-29. You can view files and clone it, but cannot push or open issues or pull requests.
rsstube-bash-old/rsstube.1

86 lines
1.9 KiB
Groff

.\" Manual for rsstube.
.TH man rsstube 1 "10 January 2020" "" "rsstube manual"
.SH NAME
rsstube \- get feed for a page
.SH SYNOPSIS
\f[B]rsstube\f[] [OPTIONS] URL
.SH DESCRIPTION
rsstube attempts to get an RSS feed for a page from a supported site. If it can determine the feed URL based on the page URL, it does so. Otherwise, it uses \f[B]curl\f[] to download the page and tries to use information from the page to find the feed URL.
.SH OPTIONS
.TP
.BR \-c,\ --curl-args
\fIARGS\fR
pass arbitrary arguments to curl, not recommended unless you know what you're doing
.TP
.BR \-h,\ --help
print help information
.TP
.BR \-n,\ --non-network
non-network mode (only try to get feed without downloading page)
.TP
.BR -p,\ --proxy
\fIPROXY\fR
specify a proxy argument for curl
.TP
.BR \-q,\ --quiet
only output error messages (suppress warnings and notifications)
.TP
.BR \-t,\ --tor-mode
pretend to be Tor Browser (to evade Cloudflare scrutiny while using a Tor proxy with -p)
.TP
.BR \-U,\ --update
update rsstube
.TP
.BR \-V,\ --version
Get rsstube version
.SH EXAMPLES
.TP
rsstube https://www.youtube.com/channel/UCqC_GY2ZiENFz2pwL0cSfAw
.TP
rsstube https://www.youtube.com/watch?v=XzIXc5CTC2M
.TP
rsstube "https://www.youtube.com/watch?v=fFlfxwZDFzY&list=PL8D8D4240EC972114"
.TP
rsstube -q https://soundcloud.com/greatnessgd
.TP
rsstube -p "socks5h://localhost:9150" https://www.youtube.com/watch?v=XzIXc5CTC2M
.TP
rsstube --proxy "socks5h://localhost:9050" -t https://player.fm/series/series-1456689
.SH CONFIG OPTIONS
A config file can be specified at /etc/rsstube/config or ~/.config/rsstube/config. This file may contain the same options listed above. Arguments to rsstube supercede the config file options.
.SH CURRENTLY SUPPORTED SITES
.TP
Assorted podcast sites
.TP
Chirbit
.TP
DeviantArt
.TP
Hugo
.TP
Invidious
.TP
Mastodon
.TP
Nitter
.TP
Pleroma
.TP
Plume
.TP
Reddit
.TP
Soundcloud
.TP
Tumblr
.TP
Vimeo
.TP
WriteFreely
.TP
YouTube
.SH LICENSE
GPLv3+
.SH CURRENT VERSION
2020.01.10