1.\" Copyright (c) [year] [your name] 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" 27.\" Note: The date here should be updated whenever a non-trivial 28.\" change is made to the manual page. 29.Dd April 1, 2006 30.Dt EXAMPLE 4 i386 31.Os 32.Sh NAME 33.Nm example 34.Nd "example device driver manual page" 35.Sh SYNOPSIS 36To compile 37.Ns Nm 38into the kernel, 39place the following lines in the 40kernel configuration file: 41.Bd -ragged -offset indent 42.Cd "device example" 43.Cd "options EXAMPLE_DEBUG" 44.Ed 45.Pp 46Alternatively, to load 47.Ns Nm 48as a module at boot time, place the following line in 49.Xr loader.conf 5 : 50.Bd -literal -offset indent 51example_load="YES" 52.Ed 53.Sh DESCRIPTION 54This is an example device driver manual page for the 55.Nm 56driver. 57It is intended that this example can be used as a template 58when writing a new manual page. 59.Pp 60The 61.Nm 62driver supports the following ioctls: 63.Bl -tag -width ".Dv EIOCNULL" 64.It Dv EIOCEX 65Example ioctl. 66.It Dv EIOCNULL 67Example ioctl. 68.El 69.Pp 70If the kernel is compiled with the 71.Dv EXAMPLE_DEBUG 72option, then additional debugging messages will be displayed. 73.Sh HARDWARE 74The 75.Nm 76driver supports the following example hardware: 77.Pp 78.Bl -bullet -compact 79.It 80Example device 4201 81.It 82Example device 4202 83.El 84.Sh FILES 85.Bl -tag -width ".Pa /dev/null" -compact 86.It Pa /dev/null 87Example of a file in the 88.Sx FILES 89section. 90.El 91.Sh DIAGNOSTICS 92.Bl -diag 93.It "example%d: example diagnostic message." 94An example of a diagnostic message. 95.It "example%d: another example diagnostic message." 96Self explanatory. 97.El 98.Sh SEE ALSO 99.Xr example 1 , 100.Xr example 3 , 101.Xr mdoc 7 , 102.Xr example 9 103.Sh HISTORY 104The 105.Nm 106device driver first appeared in 107.Fx 2.2 . 108.Pp 109Some other common 110.Sx HISTORY 111section examples are: 112.Pp 113The 114.Nm 115manual page example first appeared in 116.Bx 4.4 . 117.Pp 118The 119.Nm 120manual page example first appeared in 121.At v6 . 122.Sh AUTHORS 123This manual page was written by 124.An Mike Pritchard Aq [email protected] . 125.Sh BUGS 126The actual code for this device driver is vaporware. 127