xref: /freebsd/share/examples/mdoc/example.4 (revision 9cb8091ff082e4af28ad0b3de68298861604f360)
1.\" Copyright (c) [year]
2.\"	[your name].  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.\" 3. Neither the name of the author nor the names of any co-contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY [your name] AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"
29.\" Note: The date here should be updated whenever a non-trivial
30.\" change is made to the manual page.
31.Dd January 8, 1997
32.Dt EXAMPLE 4 i386
33.\" Note: Only specify the operating system when the command
34.\" is FreeBSD specific, otherwise use the .Os macro with no
35.\" arguments.
36.Os FreeBSD 2.2
37.Sh NAME
38.Nm example
39.Nd example device driver manual page
40.Sh SYNOPSIS
41.Cd pseudo-device example
42.Sh DESCRIPTION
43This is an example device driver manual page for
44the
45.Nm example
46driver.  It is intended
47that this example can be used as a template when writing
48a new manual page.
49.Pp
50The
51.Nm
52driver supports the following ioctls:
53.Bl -tag -width XXXXXXXXXXX
54.It Dv EIOCEX
55Example ioctl.
56.It Dv EIOCNULL
57Example ioctl.
58.El
59.Sh FILES
60.Bl -tag -width /dev/null -compact
61.It Pa /dev/null
62Example of a file in the
63.Sx FILES
64section.
65.El
66.Sh SEE ALSO
67.Xr example 1 ,
68.Xr example 3 ,
69.Xr mdoc 7 ,
70.Xr mdoc.samples 7
71.Sh DIAGNOSTICS
72.Bl -diag
73.It example%d: example diagnostic message.
74An example of a diagnostic message.
75.It example%d: another example diagnostic message.
76Self explanatory.
77.El
78.Sh HISTORY
79The
80.Nm
81manual page example first appeared in
82.Fx 2.2 .
83.Pp
84Some other common
85.Sx HISTORY
86section examples are:
87.Pp
88The
89.Nm
90manual page example first appeared in
91.Bx 4.4 .
92.Pp
93The
94.Nm
95manual page example first appeared in
96.At v6 .
97.Sh AUTHOR
98This
99manual page was written by Mike Pritchard
100.Aq mpp@FreeBSD.ORG .
101.Sh BUGS
102The actual code for this device driver is vaporware.
103