Skip to content

Commit

Permalink
doc: Change "-" to "\-" in appropriate places.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
blp committed Jun 29, 2010
1 parent 86f2fa5 commit 4e312e6
Show file tree
Hide file tree
Showing 24 changed files with 219 additions and 219 deletions.
16 changes: 8 additions & 8 deletions debian/ovs-switch-setup.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH ovs-switch-setup 8 "June 2008" "Open vSwitch" "Open vSwitch Manual"
.TH ovs\-switch\-setup 8 "June 2008" "Open vSwitch" "Open vSwitch Manual"

.SH NAME
ovs\-switch\-setup \- interactive setup for Open vSwitch switch
Expand All @@ -15,27 +15,27 @@ including the underlying public key infrastructure (PKI).
ovs\-switch\-setup does not accept any command-line options.

.SH FILES
.IP /etc/default/openvswitch-switch
.IP /etc/default/openvswitch\-switch
Main configuration file for Open vSwitch switch.

.IP /etc/openvswitch/cacert.pem
Default location of CA certificate for OpenFlow controllers.

.IP /etc/openvswitch/of0-cert.pem
.IP /etc/openvswitch/of0\-cert.pem
Default location of certificate for the Open vSwitch switch's private key.

.IP /etc/openvswitch/of0-privkey.pem
.IP /etc/openvswitch/of0\-privkey.pem
Default location of the Open vSwitch switch's private key. This file
should be readable only by \fBroot\fR.

.IP /etc/openvswitch/of0-req.pem
.IP /etc/openvswitch/of0\-req.pem
Default location of certificate request for the Open vSwitch switch's
certificate. This file is not used after the signed certificate
(typically \fB/etc/openvswitch/of0-cert.pem\fR, above) has been
(typically \fB/etc/openvswitch/of0\-cert.pem\fR, above) has been
obtained from the OpenFlow PKI server.

.SH "SEE ALSO"

.BR ovs\-dpctl (8),
.BR ovs-pki (8),
.BR ovs-openflowd (8)
.BR ovs\-pki (8),
.BR ovs\-openflowd (8)
4 changes: 2 additions & 2 deletions lib/common-syn.man
Original file line number Diff line number Diff line change
@@ -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]

8 changes: 4 additions & 4 deletions lib/daemon-syn.man
Original file line number Diff line number Diff line change
@@ -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]
24 changes: 12 additions & 12 deletions lib/daemon.man
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion lib/ssl-bootstrap.man
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 3 additions & 3 deletions lib/ssl-peer-ca-cert.man
Original file line number Diff line number Diff line change
@@ -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).
6 changes: 3 additions & 3 deletions lib/vlog-syn.man
Original file line number Diff line number Diff line change
@@ -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]]
6 changes: 3 additions & 3 deletions lib/vlog-unixctl.man
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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.
14 changes: 7 additions & 7 deletions lib/vlog.man
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
.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:
.
.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
Expand All @@ -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
Expand All @@ -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.
34 changes: 17 additions & 17 deletions ovsdb/ovsdb-client.1.in
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ ovsdb\-client \- command-line interface to \fBovsdb-server\fR(1)
.SH SYNOPSIS
\fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-dbs\fI server\fR
.br
\fBovsdb\-client \fR[\fIoptions\fR] \fBget-schema\fI server database\fR
\fBovsdb\-client \fR[\fIoptions\fR] \fBget\-schema\fI server database\fR
.br
\fBovsdb\-client \fR[\fIoptions\fR] \fBlist-tables\fI server database\fR
\fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-tables\fI server database\fR
.br
\fBovsdb\-client \fR[\fIoptions\fR] \fBlist-columns\fI server database \fR[\fItable\fR]
\fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-columns\fI server database \fR[\fItable\fR]
.br
\fBovsdb\-client \fR[\fIoptions\fR] \fBtransact\fI server transaction\fR
.br
Expand All @@ -30,8 +30,8 @@ ovsdb\-client \- command-line interface to \fBovsdb-server\fR(1)
.br
\fBovsdb\-client help\fR
.IP "Output formatting options:"
[\fB--format=\fIformat\fR]
[\fB--no-heading\fR]
[\fB\-\-format=\fIformat\fR]
[\fB\-\-no\-heading\fR]
.so lib/daemon-syn.man
.so lib/vlog-syn.man
.so lib/ssl-syn.man
Expand All @@ -50,21 +50,21 @@ the following forms:
.
.SS "Commands"
The following commands are implemented:
.IP "\fBlist-dbs\fI server\fR"
.IP "\fBlist\-dbs\fI server\fR"
Connects to \fIserver\fR, retrieves the list of known databases, and
prints them one per line. These database names are the ones that may
be used for \fIdatabase\fR in the following commands.
.
.IP "\fBget-schema\fI server database\fR"
.IP "\fBget\-schema\fI server database\fR"
Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
prints it in JSON format.
.
.IP "\fBlist-tables\fI server database\fR"
.IP "\fBlist\-tables\fI server database\fR"
Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
prints a table listing the name of each table
within the database.
.
.IP "\fBlist-columns\fI server database \fR[\fItable\fR]"
.IP "\fBlist\-columns\fI server database \fR[\fItable\fR]"
Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and
prints a table listing the name and type of each
column. If \fItable\fR is specified, only columns in that table are
Expand Down Expand Up @@ -96,16 +96,16 @@ Print deleted rows.
Print old and new values of modified rows.
.RE
.IP
If \fB--detach\fR is used with \fBmonitor\fR, then \fBovsdb\-client\fR
If \fB\-\-detach\fR is used with \fBmonitor\fR, then \fBovsdb\-client\fR
detaches after it has successfully received and printed the initial
contents of \fItable\fR.
.SH OPTIONS
.SS "Output Formatting Options"
Much of the output from \fBovsdb\-client\fR is in the form of tables.
The following options controlling output formatting:
.
.IP "\fB-f \fIformat\fR"
.IQ "\fB--format=\fIformat\fR"
.IP "\fB\-f \fIformat\fR"
.IQ "\fB\-\-format=\fIformat\fR"
Sets the type of table formatting. The following types of
\fIformat\fR are available:
.RS
Expand All @@ -117,22 +117,22 @@ HTML tables.
Comma-separated values as defined in RFC 4180.
.RE
.
.IP "\fB-d \fIformat\fR"
.IP "\fB--data=\fIformat\fR"
.IP "\fB\-d \fIformat\fR"
.IP "\fB\-\-data=\fIformat\fR"
Sets the formatting for cells within output tables. The following
types of \fIformat\fR are available:
.RS
.IP "\fBstring\fR (default)"
The simple format described in \fBovs-vsctl\fR(8).
The simple format described in \fBovs\-vsctl\fR(8).
.IP "\fBjson\fR"
JSON.
.RE
.
.IP "\fB--no-heading\fR"
.IP "\fB\-\-no\-heading\fR"
This option suppresses the heading row that otherwise appears in the
first row of table output.
.
.IP "\fB--pretty\fR"
.IP "\fB\-\-pretty\fR"
By default, JSON in output is printed as compactly as possible. This
option causes JSON in output to be printed in a more readable
fashion. Members of objects and elements of arrays are printed one
Expand Down
4 changes: 2 additions & 2 deletions ovsdb/ovsdb-idlc.1
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ ovsdb\-idlc \- Open vSwitch IDL (Interface Definition Language) compiler
.br
\fBovsdb\-idlc \fBc\-idl\-source\fI idl\fR
.br
\fBovsdb\-idlc --help\fR
\fBovsdb\-idlc \-\-help\fR
.br
\fBovsdb\-idlc --version\fR
\fBovsdb\-idlc \-\-version\fR
.
.SH DESCRIPTION
The \fBovsdb\-idlc\fR program is a command-line tool for translating
Expand Down
18 changes: 9 additions & 9 deletions ovsdb/ovsdb-server.1.in
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ ovsdb\-server \- Open vSwitch database server
.SH SYNOPSIS
\fBovsdb\-server\fR
\fIdatabase\fR
[\fB--remote=\fIremote\fR]\&...
[\fB--run=\fIcommand\fR]
.so lib/daemon-syn.man
.so lib/vlog-syn.man
.so lib/unixctl-syn.man
.so lib/common-syn.man
[\f\-\-remote=\fIremote\fR]\&...
[\f\-\-run=\fIcommand\fR]
.so lib/daemon\-syn.man
.so lib/vlog\-syn.man
.so lib/unixctl\-syn.man
.so lib/common\-syn.man
.
.SH DESCRIPTION
The \fBovsdb\-server\fR program provides RPC interfaces to an Open
Expand Down Expand Up @@ -54,7 +54,7 @@ otherwise, it exits with exit code 1.
.IP
This option can be useful where a database server is needed only to
run a single command, e.g.:
.B "ovsdb-server --remote=punix:socket --run='ovsdb-client dump unix:socket Open_vSwitch'"
.B "ovsdb\-server \-\-remote=punix:socket \-\-run='ovsdb\-client dump unix:socket Open_vSwitch'"
.SS "Daemon Options"
.so lib/daemon.man
.SS "Logging Options"
Expand All @@ -78,11 +78,11 @@ one row in \fItable\fR.)
\fBovs\-appctl\fR(8) can send commands to a running
\fBovsdb\-server\fR process. The currently supported commands are
described below.
.SS "OVSDB-SERVER COMMANDS"
.SS "OVSDB\-SERVER COMMANDS"
These commands are specific to \fBovsdb\-server\fR.
.IP "\fBexit\fR"
Causes \fBovsdb\-server\fR to gracefully terminate.
.IP "\fBovsdb-server/compact\fR"
.IP "\fBovsdb\-server/compact\fR"
Compacts the database in-place. The database is also automatically
compacted occasionally.
.
Expand Down
Loading

0 comments on commit 4e312e6

Please sign in to comment.