R-yan/l1ving_youtube-dl
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs: Add a manpage

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
MANIFEST.in
View File

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

4
docs/conf.py
View File

@ -69,3 +69,7 @@ html_static_path = ['_static']
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'youtube-dldoc' 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