This is a simple table with links to the manpages published on openvswitch.org. Something fancier can be done in the future.
Signed-off-by: Stephen Finucane <step...@that.guru> --- Documentation/ref/index.rst | 144 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 143 insertions(+), 1 deletion(-) diff --git a/Documentation/ref/index.rst b/Documentation/ref/index.rst index cb4f30b..27d975a 100644 --- a/Documentation/ref/index.rst +++ b/Documentation/ref/index.rst @@ -30,4 +30,146 @@ Reference Guide Man Pages --------- -**TODO** +.. TODO(stephenfin): Investigate some way to get the manpages into rST format. + The most viable option seems to be writing them all in rST, converting them + to roff format and storing both the rST and roff formatted docs in version + control. + +.. list-table:: + + * - ovn-architecture(7) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovn-architecture.7.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovn-architecture.7.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovn-architecture.7.txt>`__ + * - ovn-controller(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovn-controller.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovn-controller.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovn-controller.8.txt>`__ + * - ovn-controller-vtep(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovn-controller-vtep.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovn-controller-vtep.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovn-controller-vtep.8.txt>`__ + * - ovn-ctl(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovn-ctl.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovn-ctl.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovn-ctl.8.txt>`__ + * - ovn-nb(5) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovn-nb.5.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovn-nb.5.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovn-nb.5.txt>`__ + * - ovn-nbctl(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovn-nbctl.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovn-nbctl.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovn-nbctl.8.txt>`__ + * - ovn-northd(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovn-northd.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovn-northd.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovn-northd.8.txt>`__ + * - ovn-sb(5) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovn-sb.5.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovn-sb.5.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovn-sb.5.txt>`__ + * - ovn-sbctl(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovn-sbctl.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovn-sbctl.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovn-sbctl.8.txt>`__ + * - ovn-trace(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovn-trace.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovn-trace.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovn-trace.8.txt>`__ + * - ovs-appctl(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovs-appctl.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovs-appctl.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovs-appctl.8.txt>`__ + * - ovs-bugtool(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovs-bugtool.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovs-bugtool.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovs-bugtool.8.txt>`__ + * - ovs-ctl(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovs-ctl.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovs-ctl.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovs-ctl.8.txt>`__ + * - ovsdb-client(1) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovsdb-client.1.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovsdb-client.1.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovsdb-client.1.txt>`__ + * - ovsdb-server(1) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovsdb-server.1.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovsdb-server.1.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovsdb-server.1.txt>`__ + * - ovsdb-tool(1) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovsdb-tool.1.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovsdb-tool.1.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovsdb-tool.1.txt>`__ + * - ovs-dpctl(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovs-dpctl.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovs-dpctl.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovs-dpctl.8.txt>`__ + * - ovs-dpctl-top(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovs-dpctl-top.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovs-dpctl-top.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovs-dpctl-top.8.txt>`__ + * - ovs-l3ping(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovs-l3ping.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovs-l3ping.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovs-l3ping.8.txt>`__ + * - ovs-ofctl(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovs-ofctl.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovs-ofctl.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovs-ofctl.8.txt>`__ + * - ovs-parse-backtrace(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovs-parse-backtrace.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovs-parse-backtrace.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovs-parse-backtrace.8.txt>`__ + * - ovs-pcap(1) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovs-pcap.1.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovs-pcap.1.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovs-pcap.1.txt>`__ + * - ovs-pki(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovs-pki.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovs-pki.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovs-pki.8.txt>`__ + * - ovs-tcpdump(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovs-tcpdump.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovs-tcpdump.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovs-tcpdump.8.txt>`__ + * - ovs-tcpundump(1) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovs-tcpundump.1.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovs-tcpundump.1.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovs-tcpundump.1.txt>`__ + * - ovs-test(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovs-test.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovs-test.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovs-test.8.txt>`__ + * - ovs-testcontroller(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovs-testcontroller.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovs-testcontroller.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovs-testcontroller.8.txt>`__ + * - ovs-vlan-bug-workaround(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovs-vlan-bug-workaround.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovs-vlan-bug-workaround.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovs-vlan-bug-workaround.8.txt>`__ + * - ovs-vlan-test(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovs-vlan-test.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovs-vlan-test.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovs-vlan-test.8.txt>`__ + * - ovs-vsctl(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovs-vsctl.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovs-vsctl.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovs-vsctl.8.txt>`__ + * - ovs-vswitchd(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovs-vswitchd.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovs-vswitchd.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovs-vswitchd.8.txt>`__ + * - ovs-vswitchd.conf.db(5) + - `(pdf) <http://openvswitch.org/support/dist-docs/ovs-vswitchd.conf.db.5.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/ovs-vswitchd.conf.db.5.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/ovs-vswitchd.conf.db.5.txt>`__ + * - vtep(5) + - `(pdf) <http://openvswitch.org/support/dist-docs/vtep.5.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/vtep.5.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/vtep.5.txt>`__ + * - vtep-ctl(8) + - `(pdf) <http://openvswitch.org/support/dist-docs/vtep-ctl.8.pdf>`__ + - `(html) <http://openvswitch.org/support/dist-docs/vtep-ctl.8.html>`__ + - `(plain text) <http://openvswitch.org/support/dist-docs/vtep-ctl.8.html>`__ -- 2.7.4 _______________________________________________ dev mailing list d...@openvswitch.org https://mail.openvswitch.org/mailman/listinfo/ovs-dev