[ovs-dev,1/3] ovsdb: add xml equivalents of remote man page fragments

Submitted by Lance Richardson on April 20, 2017, 3:39 p.m.

Details

Message ID 20170420153926.4170-1-lrichard@redhat.com
State New
Headers show

Commit Message

Lance Richardson April 20, 2017, 3:39 p.m.
Add XML equivalents for remote-active.man and remote-passive.man
for inclusion by man pages using XML format.

Signed-off-by: Lance Richardson <lrichard@redhat.com>
---
 ovsdb/remote-active.xml  | 30 ++++++++++++++++++++++++++++++
 ovsdb/remote-passive.xml | 36 ++++++++++++++++++++++++++++++++++++
 2 files changed, 66 insertions(+)
 create mode 100644 ovsdb/remote-active.xml
 create mode 100644 ovsdb/remote-passive.xml

Patch hide | download patch | download mbox

diff --git a/ovsdb/remote-active.xml b/ovsdb/remote-active.xml
new file mode 100644
index 0000000..fe4801c
--- /dev/null
+++ b/ovsdb/remote-active.xml
@@ -0,0 +1,30 @@ 
+<?xml version="1.0" encoding="utf-8"?>
+<dl>
+  <dt><code>ssl:</code><var>ip</var><code>:</code><var>port</var></dt>
+  <dd>
+    The specified SSL <var>port</var> on the host at the given <var>ip</var>,
+    which must be expressed as an IP address (not a DNS name) in IPv4 or IPv6
+    address format.  If <var>ip</var> is an IPv6 address, then wrap
+    <var>ip</var> with square brackets, e.g.: <code>ssl:[::1]:6640</code>.
+    The <code>--private-key</code>, <code>--certificate</code>, and
+    <code>--ca-cert</code> options are mandatory when this form is used.
+  </dd>
+  <dt><code>tcp:</code><var>ip</var><code>:</code><var>port</var></dt>
+  <dd>
+    Connect to the given TCP <var>port</var> on <var>ip</var>, where
+    <var>ip</var> can be an IPv4 or IPv6 address.  If <var>ip</var> is an
+    IPv6 address, then wrap <var>ip</var> with square brackets, e.g.:
+    <code>tcp:[::1]:6640</code>.
+  </dd>
+  <dt><code>unix:</code><var>file</var></dt>
+  <dd>
+    <p>
+    On POSIX, connect to the Unix domain server socket named <var>file</var>.
+    </p>
+    <p>
+    On Windows, connect to a local named pipe that is represented by a file
+    created in the path <var>file</var> to mimic the behavior of a Unix domain
+    socket.
+    </p>
+  </dd>
+</dl>
diff --git a/ovsdb/remote-passive.xml b/ovsdb/remote-passive.xml
new file mode 100644
index 0000000..6056b1e
--- /dev/null
+++ b/ovsdb/remote-passive.xml
@@ -0,0 +1,36 @@ 
+<?xml version="1.0" encoding="utf-8"?>
+<dl>
+  <dt><code>pssl:</code><var>port</var><code>:</code><var>ip</var></dt>
+  <dd>
+    Listen on the given SSL <var>port</var> for a connection.  By default,
+    connections are not bound to a particular local IP address and
+    it listens only on IPv4 (but not IPv6) addresses, but
+    specifying <var>ip</var> limits connections to those from the given
+    <var>ip</var>, either IPv4 or IPv6 address.  If <var>ip</var> is
+    an IPv6 address, then wrap <var>ip</var> with square brackets, e.g.:
+    <code>pssl:6640:[::1]</code>. The <code>--private-key</code>,
+    <code>--certificate</code>, and <code>--ca-cert</code> options are
+    mandatory when this form is used.
+  </dd>
+  <dt><code>ptcp:</code><var>port</var><code>:</code><var>ip</var></dt>
+  <dd>
+    Listen on the given TCP <var>port</var> for a connection.  By default,
+    connections are not bound to a particular local IP address and
+    it listens only on IPv4 (but not IPv6) addresses, but
+    <var>ip</var> may be specified to listen only for connections to the given
+    <var>ip</var>, either IPv4 or IPv6 address.  If <var>ip</var> is
+    an IPv6 address, then wrap <var>ip</var> with square brackets, e.g.:
+    <code>ptcp:6640:[::1]</code>.
+  </dd>
+  <dt><code>punix:</code><var>file</var></dt>
+  <dd>
+    <p>
+    On POSIX, listen on the Unix domain server socket named \fIfile\fR for a
+    connection.
+    </p>
+    <p>
+    On Windows, listen on a local named pipe.  A file is created in the
+    path <var>file</var> to mimic the behavior of a Unix domain socket.
+    </p>
+  </dd>
+</dl>