svragv/peertube-cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add manpage

Browse source
This commit is contained in:
qorg11 2021-11-07 18:34:57 +01:00
parent 68c6083370
commit 3fe6bcab0a
No known key found for this signature in database
GPG key ID: 343FC20A4ACA62B9
1 changed files with 23 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
doc/peertube-cli.1
View file

@ -0,0 +1,23 @@
.TH peertube-cli 1 2021-11-07 KILL-9
.SH NAME
peertube-cli \- A peertube CLI client.
.SH SYPNOSIS
.B peertube-cli
[\-\-instance=INSTANCE] [\-\-resolution=[0|1|...|n]] [\-\-player=PLAYER] [URL]
.SH DESCRIPTION
peertube-cli is a peertube client. If no parameters are given, it will
use the config file
.B
~/.ptclirc
or anything in the
.B
PTCLIRC
env
.SH CONFIG
The file
.B
~/.ptclirc
is written in perl using perl's hashes. And it contains 3
values, instance, resolution and player. peertube-cli will use the
values set in this file if nothing is passed with getopt arguments.