d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add a standard boilerplate to the SYNOPSIS section that mentions how

Browse Source 
to load a kernel module.

MFC after:	3 days
This commit is contained in:
Christian Brueffer 2006-04-01 10:10:36 +00:00
parent 7bffbceefe
commit c541fe558c
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
share/examples/mdoc/example.4
View File

@ -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