52a227c309
This commit enable users to run `tox -e docs` to build docs for os-ken. It fixes several issues to ensure the build will succeed. In addition, the docs from upstream Ryu library is grouped into archived content. The future work is merging those docs into the os-ken contents. Change-Id: I5ee1998e0d2835495650cda530eb0b73c49b091a
1.5 KiB
- orphan
os_ken manual page
Synopsis
os_ken [-h] [--config-dir DIR] [--config-file PATH] [--version] [subcommand] ...
Description
os_ken is the
executable for OS-Ken applications. os_ken loads a sub-module
corresponding to the sub-command and run it. 'run' sub-command is an
equivalent to os_ken-manager.
OS-Ken is a component-based software defined networking framework. OS-Ken provides software components with well defined API that make it easy for developers to create new network management and control applications. OS-Ken supports various protocols for managing network devices, such as OpenFlow, Netconf, OF-config, etc. About OpenFlow, OS-Ken supports fully 1.0, 1.2, 1.3, 1.4 and Nicira Extensions.
Options
- subcommand
-
[rpc-cliof-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
- --version
-
show program's version number and exit