docs: Add a manpage

This commit is contained in:
Jaime Marquínez Ferrándiz 2014-03-24 19:52:53 +01:00
parent cef96f1abf
commit 904954f1a0
3 changed files with 27 additions and 1 deletions

View File

@ -3,4 +3,4 @@ include test/*.py
include test/*.json
include youtube-dl.bash-completion
include youtube-dl.1
recursive-include docs Makefile conf.py *.rst
recursive-include docs Makefile conf.py *.rst *.rst.inc

View File

@ -69,3 +69,7 @@ html_static_path = ['_static']
# Output file base name for HTML help builder.
htmlhelp_basename = 'youtube-dldoc'
# -- Options for the man page ---------------------------------------------
man_pages = [('youtube-dl.1', 'youtube-dl', 'download videos from youtube.com or other video platforms', 'Ricardo Garcia Gonzalez', 1)]

22
docs/youtube-dl.1.rst Normal file
View File

@ -0,0 +1,22 @@
:orphan:
YOUTUBE-DL(1)
*************
SYNOPSIS
========
**youtube-dl** [OPTIONS] URL [URL...]
DESCRIPTION
===========
**youtube-dl** is a small command-line program to download videos from
YouTube.com and a few more sites. It requires the Python interpreter, version
2.6, 2.7, or 3.3+, and it is not platform specific. It should work on
your Unix box, on Windows or on Mac OS X. It is released to the public domain,
which means you can modify it, redistribute it or use it however you like.
OPTIONS
=======
.. include:: options.rst.inc