From 398d49ac26ba12e88fdca3fa96befbbdb3db5b86 Mon Sep 17 00:00:00 2001 From: Ivan Habunek Date: Sun, 10 Feb 2019 10:46:03 +0100 Subject: [PATCH] Add man page --- .gitignore | 3 ++- Makefile | 5 ++++- twitch-dl.1.scd | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 53 insertions(+), 2 deletions(-) create mode 100644 twitch-dl.1.scd diff --git a/.gitignore b/.gitignore index f80fd60..9967b57 100644 --- a/.gitignore +++ b/.gitignore @@ -9,4 +9,5 @@ tmp/ /.env /.coverage /htmlcov -/toot-*.tar.gz +/twitch-dl-*.tar.gz +/twitch-dl.1.man diff --git a/Makefile b/Makefile index f50291f..3c1e835 100644 --- a/Makefile +++ b/Makefile @@ -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 diff --git a/twitch-dl.1.scd b/twitch-dl.1.scd new file mode 100644 index 0000000..8857b0e --- /dev/null +++ b/twitch-dl.1.scd @@ -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 + +Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html