summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorBen Pfaff <blp@nicira.com>2010-06-29 14:29:40 -0700
committerBen Pfaff <blp@nicira.com>2010-06-29 14:29:40 -0700
commit4e312e694f1e9e34ed0aad7d5778b73d7add270d (patch)
tree4d399875944a9475d83bc264ebd18ca71bda19ed /lib
parent86f2fa597c6eb8eb1c9a42685200c0ac90b85e97 (diff)
downloadopenvswitch-4e312e694f1e9e34ed0aad7d5778b73d7add270d.tar.gz
doc: Change "-" to "\-" in appropriate places.
The newer manpages tend to get this right more often than the old ones, but there were lots of places that needed to be corrected.
Diffstat (limited to 'lib')
-rw-r--r--lib/common-syn.man4
-rw-r--r--lib/daemon-syn.man8
-rw-r--r--lib/daemon.man24
-rw-r--r--lib/ssl-bootstrap.man2
-rw-r--r--lib/ssl-peer-ca-cert.man6
-rw-r--r--lib/vlog-syn.man6
-rw-r--r--lib/vlog-unixctl.man6
-rw-r--r--lib/vlog.man14
8 files changed, 35 insertions, 35 deletions
diff --git a/lib/common-syn.man b/lib/common-syn.man
index ae1bed51d..3b8055186 100644
--- a/lib/common-syn.man
+++ b/lib/common-syn.man
@@ -1,4 +1,4 @@
.IP "Common options:"
-[\fB-h\fR | \fB--help\fR]
-[\fB-V\fR | \fB--version\fR]
+[\fB\-h\fR | \fB\-\-help\fR]
+[\fB\-V\fR | \fB\-\-version\fR]
diff --git a/lib/daemon-syn.man b/lib/daemon-syn.man
index 49705644e..fcc15cce1 100644
--- a/lib/daemon-syn.man
+++ b/lib/daemon-syn.man
@@ -1,5 +1,5 @@
.IP "Daemon options:"
-[\fB--pidfile\fR[\fB=\fIpidfile\fR]]
-[\fB--overwrite-pidfile\fR]
-[\fB--detach\fR]
-[\fB--no-chdir\fR]
+[\fB\-\-pidfile\fR[\fB=\fIpidfile\fR]]
+[\fB\-\-overwrite\-pidfile\fR]
+[\fB\-\-detach\fR]
+[\fB\-\-no\-chdir\fR]
diff --git a/lib/daemon.man b/lib/daemon.man
index 3dcb38dfa..d9f25e1a9 100644
--- a/lib/daemon.man
+++ b/lib/daemon.man
@@ -6,45 +6,45 @@ specified, or
if it does not begin with \fB/\fR, then it is created in
\fB@RUNDIR@\fR.
.IP
-If \fB--pidfile\fR is not specified, no pidfile is created.
+If \fB\-\-pidfile\fR is not specified, no pidfile is created.
.
.TP
-\fB--overwrite-pidfile\fR
-By default, when \fB--pidfile\fR is specified and the specified pidfile
+\fB\-\-overwrite\-pidfile\fR
+By default, when \fB\-\-pidfile\fR is specified and the specified pidfile
already exists and is locked by a running process, \fB\*(PN\fR refuses
-to start. Specify \fB--overwrite-pidfile\fR to cause it to instead
+to start. Specify \fB\-\-overwrite\-pidfile\fR to cause it to instead
overwrite the pidfile.
.IP
-When \fB--pidfile\fR is not specified, this option has no effect.
+When \fB\-\-pidfile\fR is not specified, this option has no effect.
.
.TP
-\fB--detach\fR
+\fB\-\-detach\fR
Causes \fB\*(PN\fR to detach itself from the foreground session and
run as a background process.
.
.TP
-\fB--monitor\fR
+\fB\-\-monitor\fR
Creates an additional process to monitor the \fB\*(PN\fR daemon. If
the daemon dies due to a signal that indicates a programming error
(e.g. \fBSIGSEGV\fR, \fBSIGABRT\fR), then the monitor process starts a
new copy of it. If the daemon die or exits for another reason, the
monitor process exits.
.IP
-This option is normally used with \fB--detach\fR, but it also
+This option is normally used with \fB\-\-detach\fR, but it also
functions without it.
.
.TP
-\fB--no-chdir\fR
-By default, when \fB--detach\fR is specified, \fB\*(PN\fR
+\fB\-\-no\-chdir\fR
+By default, when \fB\-\-detach\fR is specified, \fB\*(PN\fR
changes its current working directory to the root directory after it
detaches. Otherwise, invoking \fB\*(PN\fR from a carelessly chosen
directory would prevent the administrator from unmounting the file
system that holds that directory.
.IP
-Specifying \fB--no-chdir\fR suppresses this behavior, preventing
+Specifying \fB\-\-no\-chdir\fR suppresses this behavior, preventing
\fB\*(PN\fR from changing its current working directory. This may be
useful for collecting core files, since it is common behavior to write
core dumps into the current working directory and the root directory
is not a good directory to use.
.IP
-This option has no effect when \fB--detach\fR is not specified.
+This option has no effect when \fB\-\-detach\fR is not specified.
diff --git a/lib/ssl-bootstrap.man b/lib/ssl-bootstrap.man
index 68e41c012..7fe4a1ffd 100644
--- a/lib/ssl-bootstrap.man
+++ b/lib/ssl-bootstrap.man
@@ -18,5 +18,5 @@ the server to send the CA certificate, but
\fBovs\-controller\fR(8) can be configured to do so with the
\fB\-\-peer\-ca\-cert\fR option.
.IP
-This option is mutually exclusive with \fB-C\fR and
+This option is mutually exclusive with \fB\-C\fR and
\fB\-\-ca\-cert\fR.
diff --git a/lib/ssl-peer-ca-cert.man b/lib/ssl-peer-ca-cert.man
index 183f93ea2..cfdd915ec 100644
--- a/lib/ssl-peer-ca-cert.man
+++ b/lib/ssl-peer-ca-cert.man
@@ -1,12 +1,12 @@
-.IP "\fB--peer-ca-cert=\fIpeer-cacert.pem\fR"
+.IP "\fB\-\-peer\-ca\-cert=\fIpeer-cacert.pem\fR"
Specifies a PEM file that contains one or more additional certificates
to send to SSL peers. \fIpeer-cacert.pem\fR should be the CA
certificate used to sign the \fB\*(PN\fR own certificate (the
-certificate specified on \fB-c\fR or \fB--certificate\fR).
+certificate specified on \fB\-c\fR or \fB\-\-certificate\fR).
.IP
This option is not useful in normal operation, because the SSL peer
must already have the CA certificate for the peer to have any
confidence in \fB\*(PN\fR's identity. However, this option allows a
newly installed switch to obtain the peer CA certificate on first boot
-using, e.g., the \fB\-\-bootstrap-ca-cert\fR option to
+using, e.g., the \fB\-\-bootstrap\-ca\-cert\fR option to
\fBovs\-openflowd\fR(8).
diff --git a/lib/vlog-syn.man b/lib/vlog-syn.man
index 873b2f0ba..3df967ad1 100644
--- a/lib/vlog-syn.man
+++ b/lib/vlog-syn.man
@@ -1,6 +1,6 @@
.IP "Logging options:"
-[\fB-v\fR[\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]]]\&...
+[\fB\-v\fR[\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]]]\&...
.br
-[\fB--verbose[=\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]]]\&...
+[\fB\-\-verbose[=\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]]]\&...
.br
-[\fB--log-file\fR[\fB=\fIfile\fR]]
+[\fB\-\-log\-file\fR[\fB=\fIfile\fR]]
diff --git a/lib/vlog-unixctl.man b/lib/vlog-unixctl.man
index 86eece3b7..5c60a855d 100644
--- a/lib/vlog-unixctl.man
+++ b/lib/vlog-unixctl.man
@@ -7,7 +7,7 @@ Sets the logging level for \fImodule\fR in \fIfacility\fR to
.RS
.IP \(bu
\fImodule\fR may be any valid module name (as displayed by the
-\fB--list\fR action on \fBovs\-appctl\fR(8)), or the special name
+\fB\-\-list\fR action on \fBovs\-appctl\fR(8)), or the special name
\fBANY\fR to set the logging levels for all modules.
.
.IP \(bu
@@ -17,7 +17,7 @@ respectively, or \fBANY\fR to set the logging levels for both
facilities. If it is omitted, \fIfacility\fR defaults to \fBANY\fR.
.IP
The log level for the \fBfile\fR facility has no effect unless
-\fB\*(PN\fR was invoked with the \fB--log-file\fR option.
+\fB\*(PN\fR was invoked with the \fB\-\-log\-file\fR option.
.IP \(bu
\fIlevel\fR must be one of \fBemer\fR, \fBerr\fR, \fBwarn\fR,
\fBinfo\fR, or
@@ -36,4 +36,4 @@ Causes \fB\*(PN\fR to close and reopen its log file. (This is useful
after rotating log files, to cause a new log file to be used.)
.IP
This has no effect unless \fB\*(PN\fR was invoked with the
-\fB--log-file\fR option.
+\fB\-\-log\-file\fR option.
diff --git a/lib/vlog.man b/lib/vlog.man
index ca895b15a..a645f3a42 100644
--- a/lib/vlog.man
+++ b/lib/vlog.man
@@ -1,5 +1,5 @@
.TP
-\fB-v\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]], \fB--verbose=\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]
+\fB\-v\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]], \fB\-\-verbose=\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]
.
Sets the logging level for \fImodule\fR in \fIfacility\fR to
\fIlevel\fR:
@@ -7,7 +7,7 @@ Sets the logging level for \fImodule\fR in \fIfacility\fR to
.RS
.IP \(bu
\fImodule\fR may be any valid module name (as displayed by the
-\fB--list\fR action on \fBovs\-appctl\fR(8)), or the special name
+\fB\-\-list\fR action on \fBovs\-appctl\fR(8)), or the special name
\fBANY\fR to set the logging levels for all modules.
.
.IP \(bu
@@ -17,7 +17,7 @@ respectively, or \fBANY\fR to set the logging levels for both
facilities. If it is omitted, \fIfacility\fR defaults to \fBANY\fR.
.IP
Regardless of the log levels set for \fBfile\fR, logging to a file
-will not take place unless \fB--log-file\fR is also specified (see
+will not take place unless \fB\-\-log\-file\fR is also specified (see
below).
.
.IP \(bu
@@ -28,17 +28,17 @@ logged. If it is omitted, \fIlevel\fR defaults to \fBdbg\fR.
.RE
.
.TP
-\fB-v\fR, \fB--verbose\fR
+\fB\-v\fR, \fB\-\-verbose\fR
Sets the maximum logging verbosity level, equivalent to
-\fB--verbose=ANY:ANY:dbg\fR.
+\fB\-\-verbose=ANY:ANY:dbg\fR.
.
.TP
-\fB-vPATTERN:\fIfacility\fB:\fIpattern\fR, \fB--verbose=PATTERN:\fIfacility\fB:\fIpattern\fR
+\fB\-vPATTERN:\fIfacility\fB:\fIpattern\fR, \fB\-\-verbose=PATTERN:\fIfacility\fB:\fIpattern\fR
Sets the log pattern for \fIfacility\fR to \fIpattern\fR. Refer to
\fBovs\-appctl\fR(8) for a description of the valid syntax for \fIpattern\fR.
.
.TP
-\fB--log-file\fR[\fB=\fIfile\fR]
+\fB\-\-log\-file\fR[\fB=\fIfile\fR]
Enables logging to a file. If \fIfile\fR is specified, then it is
used as the exact name for the log file. The default log file name
used if \fIfile\fR is omitted is \fB@LOGDIR@/\*(PN.log\fR.