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 June 19, 2026 9.Dt EXAMPLE 4 amd64 10.Os 11.Sh NAME 12.Nm example 13.Nd example device driver manual page 14.Sh SYNOPSIS 15.Cd device example 16.Cd options EXAMPLE_DEBUG 17.Pp 18In 19.Xr device.hints 5 : 20.Cd here.is.a.example.device.hint Ns Ao Ns = Ns Ar optional_value Ac 21.Pp 22In 23.Xr rc.conf 5 : 24.Cd kld_list="kernel_module_name" 25.Pp 26In 27.Xr loader.conf 5 : 28.Cd here.is.a.example.tunable Ns Ao Ns = Ns Ar optional_value Ac 29.Pp 30In 31.Xr loader.conf 5 32or 33.Xr sysctl.conf 5 : 34.Cd here.is.a.example.sysctl Ns Ao Ns = Ns Ar optional_value Ac 35.Sh DEPRECATION NOTICE 36This driver is scheduled for removal prior to the release of 37.Fx 17.0 . 38.Sh DESCRIPTION 39This is an example device driver manual page for the 40.Nm 41driver. 42It is intended that this example can be used as a template 43when writing a new manual page. 44.Pp 45If the kernel is compiled with the 46.Dv EXAMPLE_DEBUG 47option, then additional debugging messages will be displayed. 48.Pp 49The 50.Nm 51driver supports the following ioctls: 52.Bl -tag -width "EIOCNULL" 53.It Dv EIOCEX 54Example ioctl. 55.It Dv EIOCNULL 56Example ioctl. 57.El 58.Sh HARDWARE 59The 60.Nm 61driver supports the following example hardware: 62.Pp 63.Bl -bullet -compact 64.It 65Example device 4201 66.It 67Example device 4202 68.El 69.Sh FILES 70.Bl -tag -width "/dev/null" -compact 71.It Pa /dev/null 72Example of a file in the 73.Sx FILES 74section. 75.El 76.Sh DIAGNOSTICS 77.Bl -diag 78.It "example%d: example diagnostic message." 79An example of a diagnostic message. 80.It "example%d: another example diagnostic message." 81Self explanatory. 82.El 83.Sh SEE ALSO 84.Xr example 1 , 85.Xr example 3 , 86.Xr mdoc 7 , 87.Xr example 9 88.Sh HISTORY 89The 90.Nm 91device driver first appeared in 92.Fx 2.2 . 93.Pp 94Some other common 95.Sx HISTORY 96section examples are: 97.Pp 98The 99.Nm 100manual page example first appeared in 101.Bx 4.4 . 102.Pp 103The 104.Nm 105manual page example first appeared in 106.At v6 . 107.Sh AUTHORS 108This manual page was written by 109.An Mike Pritchard Aq Mt mpp@FreeBSD.org 110and 111.An Alexander Ziaee Aq Mt ziaee@FreeBSD.org . 112.Sh BUGS 113The actual code for this device driver is vaporware. 114