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