utilities/ovs-command-compgen.INSTALL.md

   1 Using bash command-line completion script
   2 -----------------------------------------
   3
   4 ovs-command-compgen.bash adds bash command-line completion support
   5 for ovs-appctl, ovs-dpctl, ovs-ofctl and ovsdb-tool commands.
   6
   7 Features:
   8 ---------
   9
  10    display available completion or complete on unfinished user input
  11    (long option, subcommand, and argument).
  12
  13    once the subcommand (e.g. ofproto/trace) has been given, the
  14    script will print the subcommand format.
  15
  16    the script can convert between keywords like 'bridge/port/interface/dp'
  17    and the available record in ovsdb.
  18
  19 Limitations:
  20 ------------
  21
  22    only support small set of important keywords
  23    (dp, datapath, bridge, switch, port, interface, iface).
  24
  25    does not support parsing of nested options
  26    (e.g. ovsdb-tool create [db [schema]]).
  27
  28    does not support expansion on repeatitive argument
  29    (e.g. ovs-dpctl show [dp...]).
  30
  31    only support matching on long options, and only in the format
  32    (--option [arg], i.e. should not use --option=[arg]).
  33
  34
  35 How to use:
  36 -----------
  37
  38    To use the script, either copy it inside /etc/bash_completion.d/
  39    or manually run it via . ovs-command-compgen.bash.
  40
  41 Test:
  42 -----
  43
  44    An unit testsuite is provided as ovs-command-compgen-test.bash.
  45    To run the test, first enter ovs sandbox via:
  46
  47         make sandbox && cd sandbox
  48
  49    Then copy both ovs-command-compgen-test.bash and ovs-command-compgen.bash
  50    to the current directory.  Finally, run the test via:
  51
  52         bash ovs-command-compgen-test.bash
  53
  54 Bug Reporting:
  55 --------------
  56
  57 Please report problems to bugs@openvswitch.org.