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