diff options
| author | Isaku Yamahata <yamahata@valinux.co.jp> | 2013-02-12 17:10:41 +0900 |
|---|---|---|
| committer | FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> | 2013-02-12 20:21:31 +0900 |
| commit | 5d9efe045e28474a381625b1509edc5630a8cbca (patch) | |
| tree | 8156ef0aa98d8073985e49b0a79440e7af37ba2e /doc | |
| parent | 48bd30f8f17c13f362fdb599c1b9c7647ca58048 (diff) | |
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 <yamahata@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/conf.py | 6 | ||||
| -rw-r--r-- | doc/source/man/ryu_client.rst | 24 | ||||
| -rw-r--r-- | doc/source/man/ryu_manager.rst | 24 |
3 files changed, 53 insertions, 1 deletions
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*] <command> [<command args>] + +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*] <ryu apps>[, <ryu apps> ...] + +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 |