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