mirror of
https://github.com/openvswitch/ovs
synced 2025-08-22 01:51:26 +00:00
e532f937f5
Add a man page for ovs-flowviz as well as a topic page with some more detailed examples. Acked-by: Eelco Chaudron <echaudro@redhat.com> Signed-off-by: Adrian Moreno <amorenoz@redhat.com> Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
130 lines
6.1 KiB
ReStructuredText
130 lines
6.1 KiB
ReStructuredText
..
|
|
Copyright (c) 2016, Stephen Finucane <stephen@that.guru>
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
not use this file except in compliance with the License. You may obtain
|
|
a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
Convention for heading levels in Open vSwitch documentation:
|
|
|
|
======= Heading 0 (reserved for the title in a document)
|
|
------- Heading 1
|
|
~~~~~~~ Heading 2
|
|
+++++++ Heading 3
|
|
''''''' Heading 4
|
|
|
|
Avoid deeper levels because they do not render well.
|
|
|
|
===============
|
|
Reference Guide
|
|
===============
|
|
|
|
Man Pages
|
|
---------
|
|
|
|
.. TODO(stephenfin): Remove the below notice once everything is converted to
|
|
rST
|
|
|
|
The following man pages are written in rST and converted to roff at compile
|
|
time:
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
ovs-actions.7
|
|
ovs-appctl.8
|
|
ovs-ctl.8
|
|
ovs-flowviz.8
|
|
ovs-l3ping.8
|
|
ovs-pki.8
|
|
ovs-sim.1
|
|
ovs-parse-backtrace.8
|
|
ovs-tcpdump.8
|
|
ovs-tcpundump.1
|
|
ovs-test.8
|
|
ovs-vlan-test.8
|
|
ovsdb-server.7
|
|
ovsdb.5
|
|
ovsdb.7
|
|
|
|
The remainder are still in roff format can be found below:
|
|
|
|
.. list-table::
|
|
|
|
* - ovs-bugtool(8)
|
|
- `(pdf) <http://www.openvswitch.org/support/dist-docs/ovs-bugtool.8.pdf>`__
|
|
- `(html) <http://www.openvswitch.org/support/dist-docs/ovs-bugtool.8.html>`__
|
|
- `(plain text) <http://www.openvswitch.org/support/dist-docs/ovs-bugtool.8.txt>`__
|
|
* - ovsdb-client(1)
|
|
- `(pdf) <http://www.openvswitch.org/support/dist-docs/ovsdb-client.1.pdf>`__
|
|
- `(html) <http://www.openvswitch.org/support/dist-docs/ovsdb-client.1.html>`__
|
|
- `(plain text) <http://www.openvswitch.org/support/dist-docs/ovsdb-client.1.txt>`__
|
|
* - ovsdb-server(1)
|
|
- `(pdf) <http://www.openvswitch.org/support/dist-docs/ovsdb-server.1.pdf>`__
|
|
- `(html) <http://www.openvswitch.org/support/dist-docs/ovsdb-server.1.html>`__
|
|
- `(plain text) <http://www.openvswitch.org/support/dist-docs/ovsdb-server.1.txt>`__
|
|
* - ovsdb-tool(1)
|
|
- `(pdf) <http://www.openvswitch.org/support/dist-docs/ovsdb-tool.1.pdf>`__
|
|
- `(html) <http://www.openvswitch.org/support/dist-docs/ovsdb-tool.1.html>`__
|
|
- `(plain text) <http://www.openvswitch.org/support/dist-docs/ovsdb-tool.1.txt>`__
|
|
* - ovs-dpctl(8)
|
|
- `(pdf) <http://www.openvswitch.org/support/dist-docs/ovs-dpctl.8.pdf>`__
|
|
- `(html) <http://www.openvswitch.org/support/dist-docs/ovs-dpctl.8.html>`__
|
|
- `(plain text) <http://www.openvswitch.org/support/dist-docs/ovs-dpctl.8.txt>`__
|
|
* - ovs-dpctl-top(8)
|
|
- `(pdf) <http://www.openvswitch.org/support/dist-docs/ovs-dpctl-top.8.pdf>`__
|
|
- `(html) <http://www.openvswitch.org/support/dist-docs/ovs-dpctl-top.8.html>`__
|
|
- `(plain text) <http://www.openvswitch.org/support/dist-docs/ovs-dpctl-top.8.txt>`__
|
|
* - ovs-fields(7)
|
|
- `(pdf) <http://www.openvswitch.org/support/dist-docs/ovs-fields.7.pdf>`__
|
|
- `(html) <http://www.openvswitch.org/support/dist-docs/ovs-fields.7.html>`__
|
|
- `(plain text) <http://www.openvswitch.org/support/dist-docs/ovs-fields.7.txt>`__
|
|
* - ovs-ofctl(8)
|
|
- `(pdf) <http://www.openvswitch.org/support/dist-docs/ovs-ofctl.8.pdf>`__
|
|
- `(html) <http://www.openvswitch.org/support/dist-docs/ovs-ofctl.8.html>`__
|
|
- `(plain text) <http://www.openvswitch.org/support/dist-docs/ovs-ofctl.8.txt>`__
|
|
* - ovs-pcap(1)
|
|
- `(pdf) <http://www.openvswitch.org/support/dist-docs/ovs-pcap.1.pdf>`__
|
|
- `(html) <http://www.openvswitch.org/support/dist-docs/ovs-pcap.1.html>`__
|
|
- `(plain text) <http://www.openvswitch.org/support/dist-docs/ovs-pcap.1.txt>`__
|
|
* - ovs-test(8)
|
|
- `(pdf) <http://www.openvswitch.org/support/dist-docs/ovs-test.8.pdf>`__
|
|
- `(html) <http://www.openvswitch.org/support/dist-docs/ovs-test.8.html>`__
|
|
- `(plain text) <http://www.openvswitch.org/support/dist-docs/ovs-test.8.txt>`__
|
|
* - ovs-testcontroller(8)
|
|
- `(pdf) <http://www.openvswitch.org/support/dist-docs/ovs-testcontroller.8.pdf>`__
|
|
- `(html) <http://www.openvswitch.org/support/dist-docs/ovs-testcontroller.8.html>`__
|
|
- `(plain text) <http://www.openvswitch.org/support/dist-docs/ovs-testcontroller.8.txt>`__
|
|
* - ovs-vlan-test(8)
|
|
- `(pdf) <http://www.openvswitch.org/support/dist-docs/ovs-vlan-test.8.pdf>`__
|
|
- `(html) <http://www.openvswitch.org/support/dist-docs/ovs-vlan-test.8.html>`__
|
|
- `(plain text) <http://www.openvswitch.org/support/dist-docs/ovs-vlan-test.8.txt>`__
|
|
* - ovs-vsctl(8)
|
|
- `(pdf) <http://www.openvswitch.org/support/dist-docs/ovs-vsctl.8.pdf>`__
|
|
- `(html) <http://www.openvswitch.org/support/dist-docs/ovs-vsctl.8.html>`__
|
|
- `(plain text) <http://www.openvswitch.org/support/dist-docs/ovs-vsctl.8.txt>`__
|
|
* - ovs-vswitchd(8)
|
|
- `(pdf) <http://www.openvswitch.org/support/dist-docs/ovs-vswitchd.8.pdf>`__
|
|
- `(html) <http://www.openvswitch.org/support/dist-docs/ovs-vswitchd.8.html>`__
|
|
- `(plain text) <http://www.openvswitch.org/support/dist-docs/ovs-vswitchd.8.txt>`__
|
|
* - ovs-vswitchd.conf.db(5)
|
|
- `(pdf) <http://www.openvswitch.org/support/dist-docs/ovs-vswitchd.conf.db.5.pdf>`__
|
|
- `(html) <http://www.openvswitch.org/support/dist-docs/ovs-vswitchd.conf.db.5.html>`__
|
|
- `(plain text) <http://www.openvswitch.org/support/dist-docs/ovs-vswitchd.conf.db.5.txt>`__
|
|
* - vtep(5)
|
|
- `(pdf) <http://www.openvswitch.org/support/dist-docs/vtep.5.pdf>`__
|
|
- `(html) <http://www.openvswitch.org/support/dist-docs/vtep.5.html>`__
|
|
- `(plain text) <http://www.openvswitch.org/support/dist-docs/vtep.5.txt>`__
|
|
* - vtep-ctl(8)
|
|
- `(pdf) <http://www.openvswitch.org/support/dist-docs/vtep-ctl.8.pdf>`__
|
|
- `(html) <http://www.openvswitch.org/support/dist-docs/vtep-ctl.8.html>`__
|
|
- `(plain text) <http://www.openvswitch.org/support/dist-docs/vtep-ctl.8.html>`__
|