diff options
| author | Yoshihiro Kaneko <ykaneko0929@gmail.com> | 2014-06-18 15:23:01 +0900 |
|---|---|---|
| committer | FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> | 2014-06-19 08:41:51 +0900 |
| commit | 03731ad04cab7746e095c44934fbdee3f1134ea0 (patch) | |
| tree | a91194fbb592815448a26cf56a358a60b6d24877 /doc/source/man/ryu.rst | |
| parent | cc6dcbabaa99c77e49fabf52445d2741fcaa7676 (diff) | |
package: add python-ryu-doc
This patch adds python-ryu-doc package which contains the HTML
documentation generated from doc/.
Also updates the man pages in doc/source/man/.
Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Diffstat (limited to 'doc/source/man/ryu.rst')
| -rw-r--r-- | doc/source/man/ryu.rst | 42 |
1 files changed, 35 insertions, 7 deletions
diff --git a/doc/source/man/ryu.rst b/doc/source/man/ryu.rst index 6b2d88f6..d6968c36 100644 --- a/doc/source/man/ryu.rst +++ b/doc/source/man/ryu.rst @@ -3,18 +3,46 @@ ryu manual page =============== -Synoposis ---------- -**ryu** [*options*] <subcommand> [*subcommand options*] +Synopsis +-------- +**ryu** [-h] [--config-dir DIR] [--config-file PATH] [--version] [subcommand] ... Description ----------- -:program:`ryu` is an Operating System for Software Defined Networking +:program:`ryu` is the executable for Ryu applications. ryu loads a sub-module +corresponding to the sub-command and run it. 'run' sub-command is an +equivalent to ryu-manager. + +Ryu is a component-based software defined networking framework. Ryu +provides software components with well defined API that make it easy for +developers to create new network management and control applications. +Ryu supports various protocols for managing network devices, such as +OpenFlow, Netconf, OF-config, etc. About OpenFlow, Ryu supports fully +1.0, 1.2, 1.3, 1.4 and Nicira Extensions. Options ------- +subcommand + [rpc-cli|run|of-config-cli] + +subcommand_args + subcommand specific arguments + -h, --help + show this help message and exit + +--config-dir DIR + Path to a config directory to pull \*.conf files from. + This file set is sorted, so as to provide a predictable + parse order if individual options are over-ridden. The + set is parsed after the file(s) specified via previous + --config-file, arguments hence over-ridden options in + the directory take precedence. + +--config-file PATH + Path to a config file to use. Multiple config files can + be specified, with values in later files taking + precedence. The default files used are: None -Author ------- -Ryu development team +--version + show program's version number and exit |