The new .xml files in this commit are translations to XML of the existing
nroff fragments in .man files.
Signed-off-by: Ben Pfaff <b...@ovn.org>
---
lib/automake.mk | 5 +-
lib/common.xml | 14 ++++
lib/ssl.xml | 36 +++++++++++
lib/vlog.xml | 144 ++++++++++++++++++++++++++++++++++++++++++
ovn/utilities/ovn-nbctl.8.xml | 26 +++-----
5 files changed, 208 insertions(+), 17 deletions(-)
create mode 100644 lib/common.xml
create mode 100644 lib/ssl.xml
create mode 100644 lib/vlog.xml
diff --git a/lib/automake.mk b/lib/automake.mk
index 646306d..a519d54 100644
--- a/lib/automake.mk
+++ b/lib/automake.mk
@@ -432,8 +432,11 @@ EXTRA_DIST += \
lib/dh1024.pem \
lib/dh2048.pem \
lib/dh4096.pem \
+ lib/common.xml \
lib/dirs.c.in \
- lib/db-ctl-base.xml
+ lib/db-ctl-base.xml \
+ lib/ssl.xml \
+ lib/vlog.xml
MAN_FRAGMENTS += \
lib/colors.man \
diff --git a/lib/common.xml b/lib/common.xml
new file mode 100644
index 0000000..274d7fe
--- /dev/null
+++ b/lib/common.xml
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8"?>
+<dl>
+ <dt><code>-h</code></dt>
+ <dt><code>--help</code></dt>
+ <dd>
+ Prints a brief help message to the console.
+ </dd>
+
+ <dt><code>-V</code></dt>
+ <dt><code>--version</code></dt>
+ <dd>
+ Prints version information to the console.
+ </dd>
+</dl>
diff --git a/lib/ssl.xml b/lib/ssl.xml
new file mode 100644
index 0000000..c3a1aca
--- /dev/null
+++ b/lib/ssl.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="utf-8"?>
+<dl>
+ <dt><code>-p</code> <var>privkey.pem</var></dt>
+ <dt><code>--private-key=</code><var>privkey.pem</var></dt>
+ <dd>
+ Specifies a PEM file containing the private key used as
+ identity for outgoing SSL connections.
+ </dd>
+
+ <dt><code>-c</code> <var>cert.pem</var></dt>
+ <dt><code>--certificate=</code><var>cert.pem</var></dt>
+ <dd>
+ Specifies a PEM file containing a certificate that certifies the
+ private key specified on <code>-p</code> or <code>--private-key</code> to
be
+ trustworthy. The certificate must be signed by the certificate
+ authority (CA) that the peer in SSL connections will use to verify it.
+ </dd>
+
+ <dt><code>-C</code> <var>cacert.pem</var></dt>
+ <dt><code>--ca-cert=</code><var>cacert.pem</var></dt>
+ <dd>
+ Specifies a PEM file containing the CA certificate for
+ verifying certificates presented to this program by SSL peers. (This
+ may be the same certificate that SSL peers use to verify the
+ certificate specified on <code>-c</code> or <code>--certificate</code>, or
it may
+ be a different one, depending on the PKI design in use.)
+ </dd>
+
+ <dt><code>-C none</code></dt>
+ <dt><code>--ca-cert=none</code></dt>
+ <dd>
+ Disables verification of certificates presented by SSL peers. This
+ introduces a security risk, because it means that certificates cannot
+ be verified to be those of known trusted hosts.
+ </dd>
+</dl>
diff --git a/lib/vlog.xml b/lib/vlog.xml
new file mode 100644
index 0000000..70f88b3
--- /dev/null
+++ b/lib/vlog.xml
@@ -0,0 +1,144 @@
+<?xml version="1.0" encoding="utf-8"?>
+<dl>
+ <dt><code>-v</code>[<var>spec</var>]</dt>
+ <dt><code>--verbose=</code>[<var>spec</var>]</dt>
+ <dd>
+ <p>
+ Sets logging levels. Without any <var>spec</var>, sets the log level for
+ every module and destination to <code>dbg</code>. Otherwise,
+ <var>spec</var> is a list of words separated by spaces or commas or
+ colons, up to one from each category below:
+ </p>
+
+ <ul>
+ <li>
+ A valid module name, as displayed by the <code>vlog/list</code> command
+ on <code>ovs-appctl</code>(8), limits the log level change to the
+ specified module.
+ </li>
+
+ <li>
+ <p>
+ <code>syslog</code>, <code>console</code>, or <code>file</code>, to
+ limit the log level change to only to the system log, to the console,
+ or to a file, respectively. (If <code>--detach</code> is specified,
+ the daemon closes its standard file descriptors, so logging to the
+ console will have no effect.)
+ </p>
+
+ <p>
+ On Windows platform, <code>syslog</code> is accepted as a word and is
+ only useful along with the <code>--syslog-target</code> option (the
+ word has no effect otherwise).
+ </p>
+ </li>
+
+ <li>
+ <code>off</code>, <code>emer</code>, <code>err</code>,
+ <code>warn</code>, <code>info</code>, or <code>dbg</code>, to control
+ the log level. Messages of the given severity or higher will be
+ logged, and messages of lower severity will be filtered out.
+ <code>off</code> filters out all messages. See
+ <code>ovs-appctl</code>(8) for a definition of each log level.
+ </li>
+ </ul>
+
+ <p>
+ Case is not significant within <var>spec</var>.
+ </p>
+
+ <p>
+ Regardless of the log levels set for <code>file</code>, logging to a file
+ will not take place unless <code>--log-file</code> is also specified (see
+ below).
+ </p>
+
+ <p>
+ For compatibility with older versions of OVS, <code>any</code> is
+ accepted as a word but has no effect.
+ </p>
+ </dd>
+
+ <dt><code>-v</code></dt>
+ <dt><code>--verbose</code></dt>
+ <dd>
+ Sets the maximum logging verbosity level, equivalent to
+ <code>--verbose=dbg</code>.
+ </dd>
+
+
<dt><code>-vPATTERN:</code><var>destination</var><code>:</code><var>pattern</var></dt>
+
<dt><code>--verbose=PATTERN:</code><var>destination</var><code>:</code><var>pattern</var></dt>
+ <dd>
+ Sets the log pattern for <var>destination</var> to <var>pattern</var>.
+ Refer to <code>ovs-appctl</code>(8) for a description of the valid syntax
+ for <var>pattern</var>.
+ </dd>
+
+ <dt><code>-vFACILITY:</code><var>facility</var></dt>
+ <dt><code>--verbose=FACILITY:</code><var>facility</var></dt>
+ <dd>
+ Sets the RFC5424 facility of the log message. <var>facility</var> can be
+ one of <code>kern</code>, <code>user</code>, <code>mail</code>,
+ <code>daemon</code>, <code>auth</code>, <code>syslog</code>,
+ <code>lpr</code>, <code>news</code>, <code>uucp</code>, <code>clock</code>,
+ <code>ftp</code>, <code>ntp</code>, <code>audit</code>, <code>alert</code>,
+ <code>clock2</code>, <code>local0</code>, <code>local1</code>,
+ <code>local2</code>, <code>local3</code>, <code>local4</code>,
+ <code>local5</code>, <code>local6</code> or <code>local7</code>. If this
+ option is not specified, <code>daemon</code> is used as the default for the
+ local system syslog and <code>local0</code> is used while sending a message
+ to the target provided via the <code>--syslog-target</code> option.
+ </dd>
+
+ <dt><code>--log-file</code>[<code>=</code><var>file</var>]</dt>
+ <dd>
+ Enables logging to a file. If <var>file</var> is specified, then it is
+ used as the exact name for the log file. The default log file name used if
+ <var>file</var> is omitted is <code>@LOGDIR@/<var>program</var>.log</code>.
+ </dd>
+
+
<dt><code>--syslog-target=</code><var>host</var><code>:</code><var>port</var></dt>
+ <dd>
+ Send syslog messages to UDP <var>port</var> on <var>host</var>, in addition
+ to the system syslog. The <var>host</var> must be a numerical IP address,
+ not a hostname.
+ </dd>
+
+ <dt><code>--syslog-method=</code><var>method</var></dt>
+ <dd>
+ <p>
+ Specify <var>method</var> as how syslog messages should be sent to syslog
+ daemon. The following forms are supported:
+ </p>
+
+ <ul>
+ <li>
+ <code>libc</code>, to use the libc <code>syslog()</code> function.
+ This is the default behavior. Downside of using this options is that
+ libc adds fixed prefix to every message before it is actually sent to
+ the syslog daemon over <code>/dev/log</code> UNIX domain socket.
+ </li>
+
+ <li>
+ <code>unix:<var>file</var></code>, to use a UNIX domain socket
+ directly. It is possible to specify arbitrary message format with this
+ option. However, <code>rsyslogd 8.9</code> and older versions use hard
+ coded parser function anyway that limits UNIX domain socket use. If
+ you want to use arbitrary message format with older
+ <code>rsyslogd</code> versions, then use UDP socket to localhost IP
+ address instead.
+ </li>
+
+ <li>
+ <code>udp:<var>ip</var>:<var>port</var></code>, to use a UDP socket.
+ With this method it is possible to use arbitrary message format also
+ with older <code>rsyslogd</code>. When sending syslog messages over
+ UDP socket extra precaution needs to be taken into account, for
+ example, syslog daemon needs to be configured to listen on the
+ specified UDP port, accidental iptables rules could be interfering with
+ local syslog traffic and there are some security considerations that
+ apply to UDP sockets, but do not apply to UNIX domain sockets.
+ </li>
+ </ul>
+ </dd>
+</dl>
diff --git a/ovn/utilities/ovn-nbctl.8.xml b/ovn/utilities/ovn-nbctl.8.xml
index 68301f3..3ea0db2 100644
--- a/ovn/utilities/ovn-nbctl.8.xml
+++ b/ovn/utilities/ovn-nbctl.8.xml
@@ -543,25 +543,19 @@
default is unlikely to be useful outside of single-machine OVN test
environments.
</dd>
-
- <dt><code>-h</code> | <code>--help</code></dt>
- <dt><code>-o</code> | <code>--options</code></dt>
- <dt><code>-V</code> | <code>--version</code></dt>
</dl>
<h1>Logging options</h1>
- <dl>
- <dt><code>-v</code><var>spec</var>,
<code>--verbose=</code><var>spec</var></dt>
- <dt><code>-v</code>, <code>--verbose</code></dt>
- <dt><code>--log-file</code>[<code>=</code><var>file</var>]</dt>
-
<dt><code>--syslog-target=</code><var>host</var><code>:</code><var>port</var></dt>
- </dl>
+ <xi:include href="lib/vlog.xml"
xmlns:xi="http://www.w3.org/2003/XInclude"/>
+ <h2>PKI Options</h2>
+ <p>
+ PKI configuration is required to use SSL for the connection to the
+ database.
+ </p>
+ <xi:include href="lib/ssl.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
- <h1>PKI configuration (required to use SSL)</h1>
- <dl>
- <dt><code>-p</code>, <code>--private-key=</code><var>file</var> file with
private key</dt>
- <dt><code>-c</code>, <code>--certificate=</code><var>file</var> file with
certificate for private key</dt>
- <dt><code>-C</code>, <code>--ca-cert=</code><var>file</var> file with
peer CA certificate</dt>
- </dl>
+ <h2>Other Options</h2>
+
+ <xi:include href="lib/common.xml"
xmlns:xi="http://www.w3.org/2003/XInclude"/>
</manpage>
--
2.1.3
_______________________________________________
dev mailing list
dev@openvswitch.org
http://openvswitch.org/mailman/listinfo/dev
