summaryrefslogtreecommitdiff
path: root/utilities/ovs-command-bashcomp.INSTALL.md
blob: 411f42fe621a34c5e7f660dbb430731e96bf419b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
Using bash command-line completion scripts
------------------------------------------

There are two completion scripts available, ovs-appctl-bashcomp.bash
and ovs-vsctl-bashcomp.bash respectively.

ovs-appctl-bashcomp
-------------------

   ovs-appctl-bashcomp.bash adds bash command-line completion support
   for ovs-appctl, ovs-dpctl, ovs-ofctl and ovsdb-tool commands.

   Features:
   ---------

      display available completion or complete on unfinished user input
      (long option, subcommand, and argument).

      once the subcommand (e.g. ofproto/trace) has been given, the
      script will print the subcommand format.

      the script can convert between keywords like 'bridge/port/interface/dp'
      and the available record in ovsdb.

   Limitations:
   ------------

      only support small set of important keywords
      (dp, datapath, bridge, switch, port, interface, iface).

      does not support parsing of nested options
      (e.g. ovsdb-tool create [db [schema]]).

      does not support expansion on repeatitive argument
      (e.g. ovs-dpctl show [dp...]).

      only support matching on long options, and only in the format
      (--option [arg], i.e. should not use --option=[arg]).

ovs-vsctl-bashcomp
-------------------

   ovs-vsctl-bashcomp.bash adds bash command-line completion support
   for ovs-vsctl command.

   Features:
   ---------

      display available completion and complete on user input for
      global/local options, command, and argument.

      query database and expand keywords like 'table/record/column/key'
      to available completions.

      deal with argument relations like 'one and more', 'zero or one'.

      complete multiple ovs-vsctl commands cascaded via '--'.

   Limitations:
   ------------

      completion of very long ovs-vsctl command can take up to several
      seconds.

How to use:
-----------

   To use the scripts, either copy them inside /etc/bash_completion.d/ or
   manually run it directly in bash via . ovs-appctl-bashcomp.bash or
   . ovs-vsctl-bashcomp.bash.

Test:
-----

   Unit tests are added in tests/completion.at and integrated into autotest
   framework.  To run the tests, just do make check.

Bug Reporting:
--------------

Please report problems to bugs@openvswitch.org.