1.\" 2.\" Copyright (c) [year] [your name] 3.\" 4.\" SPDX-License-Identifier: BSD-2-Clause 5.\" 6.\" Note: The date here should be updated whenever a non-trivial 7.\" change is made to the manual page. 8.Dd July 31, 2015 9.Dt EXAMPLE 4 i386 10.Os 11.Sh NAME 12.Nm example 13.Nd "example device driver manual page" 14.Sh SYNOPSIS 15To compile the driver into the kernel, 16place the following lines in the 17kernel configuration file: 18.Bd -ragged -offset indent 19.Cd "device example" 20.Cd "options EXAMPLE_DEBUG" 21.Ed 22.Pp 23Alternatively, to load the driver as a 24module at boot time, place the following line in 25.Xr loader.conf 5 : 26.Bd -literal -offset indent 27example_load="YES" 28.Ed 29.Sh DESCRIPTION 30This is an example device driver manual page for the 31.Nm 32driver. 33It is intended that this example can be used as a template 34when writing a new manual page. 35.Pp 36The 37.Nm 38driver supports the following ioctls: 39.Bl -tag -width "EIOCNULL" 40.It Dv EIOCEX 41Example ioctl. 42.It Dv EIOCNULL 43Example ioctl. 44.El 45.Pp 46If the kernel is compiled with the 47.Dv EXAMPLE_DEBUG 48option, then additional debugging messages will be displayed. 49.Sh HARDWARE 50The 51.Nm 52driver supports the following example hardware: 53.Pp 54.Bl -bullet -compact 55.It 56Example device 4201 57.It 58Example device 4202 59.El 60.Sh FILES 61.Bl -tag -width "/dev/null" -compact 62.It Pa /dev/null 63Example of a file in the 64.Sx FILES 65section. 66.El 67.Sh DIAGNOSTICS 68.Bl -diag 69.It "example%d: example diagnostic message." 70An example of a diagnostic message. 71.It "example%d: another example diagnostic message." 72Self explanatory. 73.El 74.Sh SEE ALSO 75.Xr example 1 , 76.Xr example 3 , 77.Xr mdoc 7 , 78.Xr example 9 79.Sh HISTORY 80The 81.Nm 82device driver first appeared in 83.Fx 2.2 . 84.Pp 85Some other common 86.Sx HISTORY 87section examples are: 88.Pp 89The 90.Nm 91manual page example first appeared in 92.Bx 4.4 . 93.Pp 94The 95.Nm 96manual page example first appeared in 97.At v6 . 98.Sh AUTHORS 99This manual page was written by 100.An Mike Pritchard Aq Mt mpp@FreeBSD.org . 101.Sh BUGS 102The actual code for this device driver is vaporware. 103