diff options
Diffstat (limited to 'static/freebsd/man4/example.4')
| -rw-r--r-- | static/freebsd/man4/example.4 | 105 |
1 files changed, 105 insertions, 0 deletions
diff --git a/static/freebsd/man4/example.4 b/static/freebsd/man4/example.4 new file mode 100644 index 00000000..534444b0 --- /dev/null +++ b/static/freebsd/man4/example.4 @@ -0,0 +1,105 @@ +.\" +.\" Copyright (c) [year] [your name] +.\" +.\" SPDX-License-Identifier: BSD-2-Clause +.\" +.\" Note: The date here should be updated whenever a non-trivial +.\" change is made to the manual page. +.Dd July 31, 2015 +.Dt EXAMPLE 4 i386 +.Os +.Sh NAME +.Nm example +.Nd example device driver manual page +.Sh SYNOPSIS +To compile the driver into the kernel, +place the following lines in the +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device example" +.Cd "options EXAMPLE_DEBUG" +.Ed +.Pp +Alternatively, to load the driver as a +module at boot time, place the following line in +.Xr loader.conf 5 : +.Bd -literal -offset indent +example_load="YES" +.Ed +.Sh DEPRECATION NOTICE +This driver is scheduled for removal prior to the release of +.Fx 17.0 . +.Sh DESCRIPTION +This is an example device driver manual page for the +.Nm +driver. +It is intended that this example can be used as a template +when writing a new manual page. +.Pp +The +.Nm +driver supports the following ioctls: +.Bl -tag -width "EIOCNULL" +.It Dv EIOCEX +Example ioctl. +.It Dv EIOCNULL +Example ioctl. +.El +.Pp +If the kernel is compiled with the +.Dv EXAMPLE_DEBUG +option, then additional debugging messages will be displayed. +.Sh HARDWARE +The +.Nm +driver supports the following example hardware: +.Pp +.Bl -bullet -compact +.It +Example device 4201 +.It +Example device 4202 +.El +.Sh FILES +.Bl -tag -width "/dev/null" -compact +.It Pa /dev/null +Example of a file in the +.Sx FILES +section. +.El +.Sh DIAGNOSTICS +.Bl -diag +.It "example%d: example diagnostic message." +An example of a diagnostic message. +.It "example%d: another example diagnostic message." +Self explanatory. +.El +.Sh SEE ALSO +.Xr example 1 , +.Xr example 3 , +.Xr mdoc 7 , +.Xr example 9 +.Sh HISTORY +The +.Nm +device driver first appeared in +.Fx 2.2 . +.Pp +Some other common +.Sx HISTORY +section examples are: +.Pp +The +.Nm +manual page example first appeared in +.Bx 4.4 . +.Pp +The +.Nm +manual page example first appeared in +.At v6 . +.Sh AUTHORS +This manual page was written by +.An Mike Pritchard Aq Mt mpp@FreeBSD.org . +.Sh BUGS +The actual code for this device driver is vaporware. |
