Add man page

This commit is contained in:
Ivan Habunek 2019-02-10 10:46:03 +01:00
parent 7d152f6424
commit 398d49ac26
No known key found for this signature in database
GPG Key ID: CDBD63C43A30BB95
3 changed files with 53 additions and 2 deletions

3
.gitignore vendored
View File

@ -9,4 +9,5 @@ tmp/
/.env
/.coverage
/htmlcov
/toot-*.tar.gz
/twitch-dl-*.tar.gz
/twitch-dl.1.man

View File

@ -13,7 +13,7 @@ dist :
clean :
find . -name "*pyc" | xargs rm -rf $1
rm -rf build dist MANIFEST htmlcov deb_dist toot*.tar.gz
rm -rf build dist MANIFEST htmlcov deb_dist twitch-dl*.tar.gz twitch-dl.1.man
publish :
twine upload dist/*
@ -23,3 +23,6 @@ coverage:
deb:
@python setup.py --command-packages=stdeb.command bdist_deb
man:
scdoc < twitch-dl.1.scd > twitch-dl.1.man

47
twitch-dl.1.scd Normal file
View File

@ -0,0 +1,47 @@
twitch-dl(1)
# NAME
twitch-dl - download twitch.tv videos quickly
# SYNOPSYS
twitch-dl videos [options] [channel\_name]
twitch-dl download [options] [video\_id]
# DESCRIPTION
twitch-dl is a command-line tool for downloading videos from Twitch (twitch.tv).
It uses multiple workers to download VODs in paralel which makes it considerably
faster than tools which download them one at the time, such as youtube-dl.
# EXAMPLES
List recent videos from bananasaurus\_rex's channel:
```
twitch-dl videos bananasaurus_rex
```
Download by URL:
```
twitch-dl download https://www.twitch.tv/videos/377220226
```
Download by ID:
```
twitch-dl download 377220226
```
# SEE ALSO
youtube-dl(1)
# COPYRIGHT
Copyright Ivan Habunek <ivan@habunek.com>
Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html