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 DEPRECATION NOTICE 30This driver is scheduled for removal prior to the release of 31.Fx 13.0 . 32.Sh DESCRIPTION 33This is an example device driver manual page for the 34.Nm 35driver. 36It is intended that this example can be used as a template 37when writing a new manual page. 38.Pp 39The 40.Nm 41driver supports the following ioctls: 42.Bl -tag -width "EIOCNULL" 43.It Dv EIOCEX 44Example ioctl. 45.It Dv EIOCNULL 46Example ioctl. 47.El 48.Pp 49If the kernel is compiled with the 50.Dv EXAMPLE_DEBUG 51option, then additional debugging messages will be displayed. 52.Sh HARDWARE 53The 54.Nm 55driver supports the following example hardware: 56.Pp 57.Bl -bullet -compact 58.It 59Example device 4201 60.It 61Example device 4202 62.El 63.Sh FILES 64.Bl -tag -width "/dev/null" -compact 65.It Pa /dev/null 66Example of a file in the 67.Sx FILES 68section. 69.El 70.Sh DIAGNOSTICS 71.Bl -diag 72.It "example%d: example diagnostic message." 73An example of a diagnostic message. 74.It "example%d: another example diagnostic message." 75Self explanatory. 76.El 77.Sh SEE ALSO 78.Xr example 1 , 79.Xr example 3 , 80.Xr mdoc 7 , 81.Xr example 9 82.Sh HISTORY 83The 84.Nm 85device driver first appeared in 86.Fx 2.2 . 87.Pp 88Some other common 89.Sx HISTORY 90section examples are: 91.Pp 92The 93.Nm 94manual page example first appeared in 95.Bx 4.4 . 96.Pp 97The 98.Nm 99manual page example first appeared in 100.At v6 . 101.Sh AUTHORS 102This manual page was written by 103.An Mike Pritchard Aq Mt mpp@FreeBSD.org . 104.Sh BUGS 105The actual code for this device driver is vaporware. 106