openvswitch/lib/common.man

.de IQ
.  br
.  ns
.  IP "\\$1"
..
.IP "\fB\-h\fR"
.IQ "\fB\-\-help\fR"
Prints a brief help message to the console.
.
.IP "\fB\-V\fR"
.IQ "\fB\-\-version\fR"
Prints version information to the console.
docs: Consistently format each form of an option on a separate line. Most options were formatted like this in the manpage: -o ARGUMENT --option ARGUMENT but a few were formatted like this: -o ARGUMENT \| --option ARGUMENT or even as: -o, --option ARGUMENT The former seems least confusing to me, so switch all of the documentation to this format. Signed-off-by: Ben Pfaff <blp@nicira.com> 2012-02-08 15:05:50 -08:00			`.de IQ`
			`. br`
			`. ns`
			`. IP "\\$1"`
			`..`
			`.IP "\fB\-h\fR"`
			`.IQ "\fB\-\-help\fR"`
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45. 2009-07-08 13:19:16 -07:00			`Prints a brief help message to the console.`
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better. 2010-02-24 13:42:43 -08:00			`.`
docs: Consistently format each form of an option on a separate line. Most options were formatted like this in the manpage: -o ARGUMENT --option ARGUMENT but a few were formatted like this: -o ARGUMENT \| --option ARGUMENT or even as: -o, --option ARGUMENT The former seems least confusing to me, so switch all of the documentation to this format. Signed-off-by: Ben Pfaff <blp@nicira.com> 2012-02-08 15:05:50 -08:00			`.IP "\fB\-V\fR"`
			`.IQ "\fB\-\-version\fR"`
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45. 2009-07-08 13:19:16 -07:00			`Prints version information to the console.`