ryu/doc/source/man/ryu.rst

   1 :orphan:
   2
   3 ryu manual page
   4 ===============
   5
   6 Synopsis
   7 --------
   8 **ryu** [-h] [--config-dir DIR] [--config-file PATH] [--version] [subcommand] ...
   9
  10 Description
  11 -----------
  12 :program:`ryu` is the executable for Ryu applications. ryu loads a sub-module
  13 corresponding to the sub-command and run it. 'run' sub-command is an
  14 equivalent to ryu-manager.
  15
  16 Ryu is a component-based software defined networking framework. Ryu
  17 provides software components with well defined API that make it easy for
  18 developers to create new network management and control applications.
  19 Ryu supports various protocols for managing network devices, such as
  20 OpenFlow, Netconf, OF-config, etc. About OpenFlow, Ryu supports fully
  21 1.0, 1.2, 1.3, 1.4 and Nicira Extensions.
  22
  23 Options
  24 -------
  25 subcommand
  26     [rpc-cli|run|of-config-cli]
  27
  28 subcommand_args
  29     subcommand specific arguments
  30
  31 -h, --help
  32     show this help message and exit
  33
  34 --config-dir DIR
  35     Path to a config directory to pull \*.conf files from.
  36     This file set is sorted, so as to provide a predictable
  37     parse order if individual options are over-ridden. The
  38     set is parsed after the file(s) specified via previous
  39     --config-file, arguments hence over-ridden options in
  40     the directory take precedence.
  41
  42 --config-file PATH
  43     Path to a config file to use. Multiple config files can
  44     be specified, with values in later files taking
  45     precedence. The default files used are: None
  46
  47 --version
  48     show program's version number and exit