xref: /freebsd/share/examples/mdoc/example.4 (revision a8445737e740901f5f2c8d24c12ef7fc8b00134e)
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.\"	[id for your version control system, if any]
26.\"
27.\" Note: The date here should be updated whenever a non-trivial
28.\" change is made to the manual page.
29.Dd January 8, 1997
30.Dt EXAMPLE 4 i386
31.\" Note: Only specify the operating system when the command
32.\" is FreeBSD specific, otherwise use the .Os macro with no
33.\" arguments.
34.Os FreeBSD 2.2
35.Sh NAME
36.Nm example
37.Nd example device driver manual page
38.Sh SYNOPSIS
39.Cd pseudo-device example
40.Sh DESCRIPTION
41This is an example device driver manual page for
42the
43.Nm example
44driver.  It is intended
45that this example can be used as a template when writing
46a 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.Sh FILES
58.Bl -tag -width /dev/null -compact
59.It Pa /dev/null
60Example of a file in the
61.Sx FILES
62section.
63.El
64.Sh SEE ALSO
65.Xr example 1 ,
66.Xr example 3 ,
67.Xr mdoc 7 ,
68.Xr mdoc.samples 7
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 HISTORY
77The
78.Nm
79manual page example first appeared in
80.Fx 2.2 .
81.Pp
82Some other common
83.Sx HISTORY
84section examples are:
85.Pp
86The
87.Nm
88manual page example first appeared in
89.Bx 4.4 .
90.Pp
91The
92.Nm
93manual page example first appeared in
94.At v6 .
95.Sh AUTHORS
96This
97manual page was written by
98.An Mike Pritchard Aq mpp@FreeBSD.org .
99.Sh BUGS
100The actual code for this device driver is vaporware.
101