From 5d9efe045e28474a381625b1509edc5630a8cbca Mon Sep 17 00:00:00 2001 From: Isaku Yamahata Date: Tue, 12 Feb 2013 17:10:41 +0900 Subject: doc: man pages for ryu-manager and ryu-client In order to quieten rpmlint > ryu.noarch: W: no-manual-page-for-binary ryu-manager > Each executable in standard binary directories should have a man page. > > ryu.noarch: W: no-manual-page-for-binary ryu-client > Each executable in standard binary directories should have a man page. Signed-off-by: Isaku Yamahata Signed-off-by: FUJITA Tomonori --- doc/source/conf.py | 6 +++++- doc/source/man/ryu_client.rst | 24 ++++++++++++++++++++++++ doc/source/man/ryu_manager.rst | 24 ++++++++++++++++++++++++ 3 files changed, 53 insertions(+), 1 deletion(-) create mode 100644 doc/source/man/ryu_client.rst create mode 100644 doc/source/man/ryu_manager.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index 95fc6474..2494b76e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -213,5 +213,9 @@ latex_documents = [ # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'ryu', u'ryu Documentation', - [u'ryu development team'], 1) + [u'ryu development team'], 1), + ('man/ryu_manager', 'ryu-manager', u'ryu manager', + [u'ryu development team'], 1), + ('man/ryu_client', 'ryu-client', u'ryu client utility', + [u'ryu development team'], 1), ] diff --git a/doc/source/man/ryu_client.rst b/doc/source/man/ryu_client.rst new file mode 100644 index 00000000..1f43916e --- /dev/null +++ b/doc/source/man/ryu_client.rst @@ -0,0 +1,24 @@ +:orphan: + +ryu-client manual page +====================== + +Synoposis +--------- +**ryu-client** [*options*] [] + +Description +----------- +:program:`ryu-manger` is a test utility for :program:`ryu-manager` + +Options +------- +-h, --help + +See also +-------- +:manpage:`ryu-manager(1)` + +Author +------ +Ryu development team diff --git a/doc/source/man/ryu_manager.rst b/doc/source/man/ryu_manager.rst new file mode 100644 index 00000000..7dabac46 --- /dev/null +++ b/doc/source/man/ryu_manager.rst @@ -0,0 +1,24 @@ +:orphan: + +ryu-manager manual page +======================= + +Synoposis +--------- +**ryu-manager** [*options*] [, ...] + +Description +----------- +:program:`ryu-manger` is an Operating System for Software Defined Networking + +Options +------- +-h, --help + +See also +-------- +:manpage:`ryu-client(1)` + +Author +------ +Ryu development team -- cgit v1.2.3