Bring manpages and usage messages up-to-date.

[sliver-openvswitch.git] / switch / switch.8.in

diff --git a/switch/switch.8 b/switch/switch.8.in
similarity index 65%
rename from switch/switch.8
rename to switch/switch.8.in
index c081149..93e6868 100644 (file)
--- a/switch/switch.8
+++ b/switch/switch.8.in
@@ -31,17 +31,17 @@ root.
 The mandatory \fIcontroller\fR argument specifies how to connect to
 the OpenFlow controller.  It takes one of the following forms:
 
-.TP
-\fBtcp:\fIhost\fR[\fB:\fIport\fR]
-The specified TCP \fIport\fR (default: 975) on the given remote
-\fIhost\fR.
-
 .TP
 \fBssl:\fIhost\fR[\fB:\fIport\fR]
 The specified SSL \fIport\fR (default: 976) on the given remote
 \fIhost\fR.  The \fB--private-key\fR, \fB--certificate\fR, and
 \fB--ca-cert\fR options are mandatory when this form is used.
 
+.TP
+\fBtcp:\fIhost\fR[\fB:\fIport\fR]
+The specified TCP \fIport\fR (default: 975) on the given remote
+\fIhost\fR.
+
 .SH OPTIONS
 .TP
 \fB-i\fR, \fB--interfaces=\fR\fInetdev\fR[\fB,\fInetdev\fR]...
@@ -72,21 +72,56 @@ private key to identify a trustworthy switch.
 Specifies a PEM file containing the CA certificate used to verify that
 the switch is connected to a trustworthy controller.
 
+.TP
+\fB-P\fR[\fIpidfile\fR], \fB--pidfile\fR[\fB=\fIpidfile\fR]
+Causes a file (by default, \fBswitch.pid\fR) to be created indicating
+the PID of the running process.  If \fIpidfile\fR is not specified, or
+if it does not begin with \fB/\fR, then it is created in
+\fB@rundir@\fR.
+
+.TP
+\fB-D\fR, \fB--detach\fR
+Causes \fBswitch\fR to detach itself from the foreground session and
+run as a background process.
+
 .TP
 .BR \-h ", " \-\^\-help
 Prints a brief help message to the console.
 
 .TP
-.BR \-v ", " \-\^\-verbose
-Prints debug messages to the console.
+\fB-v\fR \fImodule\fB:\fIfacility\fB:\fIlevel\fR, \fB--verbose=\fImodule\fB:\fIfacility\fB:\fIlevel\fR
+Sets the logging level for \fImodule\fR in \fIfacility\fR to
+\fIlevel\fR.  The \fImodule\fR may be any valid module name (as
+displayed by the \fB--list\fR action on \fBvlogconf\fR(8)), or the
+special name \fBANY\fR to set the logging levels for all modules.  The
+\fIfacility\fR may be \fBsyslog\fR or \fBconsole\fR to set the levels
+for logging to the system log or to the console, respectively, or
+\fBANY\fR to set the logging levels for both facilities.  The
+\fIlevel\fR must be one of \fBemer\fR, \fBerr\fR, \fBwarn\fR, or
+\fBdbg\fR, designating the minimum severity of a message for it to be
+logged.
+
+.TP
+\fB-v\fR, \fB--verbose\fR
+Sets the maximum logging verbosity level, equivalent to
+\fB--verbose=ANY:ANY:dbg\fR.
 
 .TP
 .BR \-V ", " \-\^\-version
 Prints version information to the console.
 
+.SH BUGS
+
+The userspace switch implementation lags significantly behind the
+kernel-based switch, both in implementation quality and performance.
+It should only be used when the kernel-based switch cannot be.
+
+General-purpose support for VLAN tag rewriting is precluded by the
+Linux kernel AF_PACKET implementation.
+
 .SH "SEE ALSO"
 
 .BR dpctl (8),
 .BR ofp-pki (8),
-.BR controller (8)
+.BR controller (8),
 .BR vlogconf (8)