Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 14 May 2012 16:25:17 +0000 (UTC)
From:      Joel Dahl <joel@FreeBSD.org>
To:        src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org
Subject:   svn commit: r235450 - head/share/man/man4
Message-ID:  <201205141625.q4EGPHsU041190@svn.freebsd.org>

next in thread | raw e-mail | index | archive | help
Author: joel (doc committer)
Date: Mon May 14 16:25:17 2012
New Revision: 235450
URL: http://svn.freebsd.org/changeset/base/235450

Log:
  mdoc: Avoid playing tricks with Ns: If Nm is present in the SYNOPSIS section,
  it will be output on its own line. Ns cancels this effect however. This change
  is also consistent with the rest of our manual pages.

Modified:
  head/share/man/man4/divert.4
  head/share/man/man4/gre.4
  head/share/man/man4/ipfirewall.4
  head/share/man/man4/send.4
  head/share/man/man4/siftr.4

Modified: head/share/man/man4/divert.4
==============================================================================
--- head/share/man/man4/divert.4	Mon May 14 15:46:37 2012	(r235449)
+++ head/share/man/man4/divert.4	Mon May 14 16:25:17 2012	(r235450)
@@ -21,7 +21,7 @@ kernel configuration file:
 .Ed
 .Pp
 Alternatively, to load
-.Ns Nm
+the driver
 as a module at boot time, add the following lines into the
 .Xr loader.conf 5
 file:

Modified: head/share/man/man4/gre.4
==============================================================================
--- head/share/man/man4/gre.4	Mon May 14 15:46:37 2012	(r235449)
+++ head/share/man/man4/gre.4	Mon May 14 16:25:17 2012	(r235450)
@@ -37,16 +37,14 @@
 .Nd encapsulating network device
 .Sh SYNOPSIS
 To compile the
-.Ns Nm
-device into the kernel, place the following line in the kernel
+driver into the kernel, place the following line in the kernel
 configuration file:
 .Bd -ragged -offset indent
 .Cd "device gre"
 .Ed
 .Pp
 Alternatively, to load the
-.Ns Nm
-device as a module at boot time, place the following line in
+driver as a module at boot time, place the following line in
 .Xr loader.conf 5 :
 .Bd -literal -offset indent
 if_gre_load="YES"

Modified: head/share/man/man4/ipfirewall.4
==============================================================================
--- head/share/man/man4/ipfirewall.4	Mon May 14 15:46:37 2012	(r235449)
+++ head/share/man/man4/ipfirewall.4	Mon May 14 16:25:17 2012	(r235450)
@@ -9,15 +9,14 @@
 .Nd IP packet filter and traffic accounting
 .Sh SYNOPSIS
 To compile
-.Ns Nm
+the driver
 into the kernel, place the following option in the kernel configuration
 file:
 .Bd -ragged -offset indent
 .Cd "options IPFIREWALL"
 .Ed
 .Pp
-Other kernel options related to
-.Ns Nm
+Other related kernel options
 which may also be useful are:
 .Bd -ragged -offset indent
 .Cd "options IPFIREWALL_DEFAULT_TO_ACCEPT"
@@ -27,7 +26,7 @@ which may also be useful are:
 .Ed
 .Pp
 To load
-.Ns Nm
+the driver
 as a module at boot time, add the following line into the
 .Xr loader.conf 5
 file:

Modified: head/share/man/man4/send.4
==============================================================================
--- head/share/man/man4/send.4	Mon May 14 15:46:37 2012	(r235449)
+++ head/share/man/man4/send.4	Mon May 14 16:25:17 2012	(r235450)
@@ -38,10 +38,7 @@
 .Ft int
 .Fn socket PF_INET6 SOCK_RAW IPPROTO_SEND
 .Pp
-To enable
-.Ns Nm
-support, load the kernel side SeND as a module.
-To load it at boot time, add the following line to
+To load the driver as a module at boot time, place the following line in
 .Xr loader.conf 5 :
 .Bd -literal -offset indent
 send_load="YES"

Modified: head/share/man/man4/siftr.4
==============================================================================
--- head/share/man/man4/siftr.4	Mon May 14 15:46:37 2012	(r235449)
+++ head/share/man/man4/siftr.4	Mon May 14 16:25:17 2012	(r235450)
@@ -38,14 +38,14 @@
 .Nd Statistical Information For TCP Research
 .Sh SYNOPSIS
 To load
-.Ns Nm
+the driver
 as a module at run-time, run the following command as root:
 .Bd -literal -offset indent
 kldload siftr
 .Ed
 .Pp
 Alternatively, to load
-.Ns Nm
+the driver
 as a module at boot time, add the following line into the
 .Xr loader.conf 5
 file:
@@ -53,13 +53,16 @@ file:
 siftr_load="YES"
 .Ed
 .Sh DESCRIPTION
+The
 .Nm
-.Ns ( Em S Ns tatistical
+.Po
+.Em S Ns tatistical
 .Em I Ns nformation
 .Em F Ns or
 .Em T Ns CP
-.Em R Ns esearch )
-is a kernel module that logs a range of statistics on active TCP connections to
+.Em R Ns esearch
+.Pc
+kernel module logs a range of statistics on active TCP connections to
 a log file.
 It provides the ability to make highly granular measurements of TCP connection
 state, aimed at system administrators, developers and researchers.



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201205141625.q4EGPHsU041190>