peertube-viewer-rs.1.in

.\" Manpage for peertube-viewer-rs

.TH man  "2022" "@version@" "peertube-viewer-rs manpage"

.SH NAME
peertube-viewer a simple PeerTube cli browser

.SH SYNOPSIS
peertube-viewer [--player=player][--instance=instance][initial query or video url]


.SH DESCRIPTION
Allows you to search videos from a PeerTube instance with a similar interface to youtube-viewer

.B FEATURES 

.B sepia search (sepiasearch.org)

.B search history 

.B trending videos

.B channel videos

.B instance selection

.B instance blocklist and allowlist
 
.B quality selection

.B video comments


.SH OPTIONS

.B --search-engine
overrides the search engine set in the config file.

.B -i, --instance
overrides the instance set in the config file.

.B -c, --config
sets the path to the config file

.B -p, --[player/torrent-downloader]
overrides the player/torrent client set in the config file.

.B --[player/torrent-downloader]-args
overrides the player/torrent downloader arguments set in the config file.

.B --chandle
List the videos for a specific channel

.SH FLAGS

.B -t, --trending
Browse trending

.B --channels
Search channels by name

.B --use-raw-url
Will pass the url to the seed file instead of the web url to the player.
This might be necessary for some players(vlc) but some(mpv) don't need it and will even extract some information from it to display in their GUI.

.B -s, --select-quality
Will prompt you to chose the video quality when playing a video

.B -h, --help
Display basic help.

.B --use-torrent
Use the provided torrent downloader instead of the video player


.B --[no-]color
specify whether colors should be used

.B --[block/tag/let]-nsfw
Specify the behavior for nsfw videos (block them, add a nsfw tag in the search results or let them be)

.SH CONFIG
A config file can be put in `$XDG_CONFIG_HOME/peertube-viewer-rs/config.toml` or `/home/sos/.config/peertube-viewer-rs/config.toml`.
The expected format is TOML and an example of all configuration options can be obtained with the --print-full-example-config flag

.SH ONLINE DOCUMENTATION
https://docs.peertube-viewer.com

.SH REPORTING BUGS

Gitlab issue tracker : https://gitlab.com/peertube-viewer/peertube-viewer-rs/-/issues

.SH AUTHOR

Written by Sosthène Guédon