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