summaryrefslogtreecommitdiffstats
path: root/share/examples
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2006-09-18 11:56:51 +0000
committerru <ru@FreeBSD.org>2006-09-18 11:56:51 +0000
commit033894c029aea331814310c19af7fb43cee9db1b (patch)
treed671ba41cf47d810b8ebe34c57fe52215892ef53 /share/examples
parent731fda35ce88946da33482413f668ed0742794f7 (diff)
downloadFreeBSD-src-033894c029aea331814310c19af7fb43cee9db1b.zip
FreeBSD-src-033894c029aea331814310c19af7fb43cee9db1b.tar.gz
- Avoid using second person.
- Demonstrate how .Nm can be used without the side effect of causing a line break in the SYNOPSIS section.
Diffstat (limited to 'share/examples')
-rw-r--r--share/examples/mdoc/example.411
1 files changed, 7 insertions, 4 deletions
diff --git a/share/examples/mdoc/example.4 b/share/examples/mdoc/example.4
index 7ee51f7..5596d75 100644
--- a/share/examples/mdoc/example.4
+++ b/share/examples/mdoc/example.4
@@ -33,16 +33,19 @@
.Nm example
.Nd "example device driver manual page"
.Sh SYNOPSIS
-To compile this driver into the kernel,
-place the following lines in your
+To compile
+.Ns Nm
+into the kernel,
+place the following lines in the
kernel configuration file:
.Bd -ragged -offset indent
.Cd "device example"
.Cd "options EXAMPLE_DEBUG"
.Ed
.Pp
-Alternatively, to load the driver as a
-module at boot time, place the following line in
+Alternatively, to load
+.Ns Nm
+as a module at boot time, place the following line in
.Xr loader.conf 5 :
.Bd -literal -offset indent
example_load="YES"
OpenPOWER on IntegriCloud