summaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorYAMAMOTO Takashi <yamamoto@valinux.co.jp>2014-03-26 15:20:10 +0900
committerFUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>2014-04-20 21:00:57 +0900
commit86da3d9939d67f9632b8209002000b4223aa6acf (patch)
tree9b590e5440d806b9d9b5f11266d263b4dadd7802 /doc
parent769fb62ca9bf5f5e6a1912506b2c564aac547ae2 (diff)
document ryu command
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Diffstat (limited to 'doc')
-rw-r--r--doc/source/conf.py2
-rw-r--r--doc/source/man/ryu.rst20
2 files changed, 22 insertions, 0 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index fcec4c62..56eff88a 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -220,6 +220,8 @@ man_pages = [
[u'ryu development team'], 1),
('man/rpc_cli', 'rpc-cli', u'a simple msgpack-rpc client',
[u'ryu development team'], 1),
+ ('man/ryu', 'ryu', u'ryu',
+ [u'ryu development team'], 1),
('man/ryu_manager', 'ryu-manager', u'ryu manager',
[u'ryu development team'], 1),
]
diff --git a/doc/source/man/ryu.rst b/doc/source/man/ryu.rst
new file mode 100644
index 00000000..6b2d88f6
--- /dev/null
+++ b/doc/source/man/ryu.rst
@@ -0,0 +1,20 @@
+:orphan:
+
+ryu manual page
+===============
+
+Synoposis
+---------
+**ryu** [*options*] <subcommand> [*subcommand options*]
+
+Description
+-----------
+:program:`ryu` is an Operating System for Software Defined Networking
+
+Options
+-------
+-h, --help
+
+Author
+------
+Ryu development team