diff options
| author | brueffer <brueffer@FreeBSD.org> | 2006-04-01 10:10:36 +0000 |
|---|---|---|
| committer | brueffer <brueffer@FreeBSD.org> | 2006-04-01 10:10:36 +0000 |
| commit | 7426a2a8f43276f0672d4bda20aa9aa1965f1b7e (patch) | |
| tree | b66253aaef0555a80f937ece982f9c268d15e65a /share/examples/mdoc | |
| parent | 83cdc2ae52ad8b178c0bd5e90553926a7dc11997 (diff) | |
| download | FreeBSD-src-7426a2a8f43276f0672d4bda20aa9aa1965f1b7e.zip FreeBSD-src-7426a2a8f43276f0672d4bda20aa9aa1965f1b7e.tar.gz | |
Add a standard boilerplate to the SYNOPSIS section that mentions how
to load a kernel module.
MFC after: 3 days
Diffstat (limited to 'share/examples/mdoc')
| -rw-r--r-- | share/examples/mdoc/example.4 | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/share/examples/mdoc/example.4 b/share/examples/mdoc/example.4 index c292dae..8ab9776 100644 --- a/share/examples/mdoc/example.4 +++ b/share/examples/mdoc/example.4 @@ -26,15 +26,27 @@ .\" .\" Note: The date here should be updated whenever a non-trivial .\" change is made to the manual page. -.Dd August 17, 2004 +.Dd April 1, 2006 .Dt EXAMPLE 4 i386 .Os .Sh NAME .Nm example .Nd "example device driver manual page" .Sh SYNOPSIS +To compile this driver into the kernel, +place the following lines in your +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 +.Xr loader.conf 5 : +.Bd -literal -offset indent +example_load="YES" +.Ed .Sh DESCRIPTION This is an example device driver manual page for the .Nm |
