xref: /freebsd/share/examples/mdoc/example.4 (revision ed0bfbe5c7640195c36c6e2d921d9c9c1d36851a)
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 2.2
38.Sh NAME
39.Nm example
40.Nd example device driver manual page
41.Sh SYNOPSIS
42.Cd pseudo-device example
43.Sh DESCRIPTION
44This is an example device driver manual page for
45the
46.Nm example
47driver.  It is intended
48that this example can be used as a template when writing
49a new manual page.
50.Pp
51The
52.Nm
53driver supports the following ioctls:
54.Bl -tag -width XXXXXXXXXXX
55.It Dv EIOCEX
56Example ioctl.
57.It Dv EIOCNULL
58Example ioctl.
59.El
60.Sh FILES
61.Bl -tag -width /dev/null -compact
62.It Pa /dev/null
63Example of a file in the
64.Sx FILES
65section.
66.El
67.Sh DIAGNOSTICS
68.Bl -diag
69.It example%d: example diagnostic message.
70An example of a diagnostic message.
71.It example%d: another example diagnostic message.
72Self explanatory.
73.El
74.Sh SEE ALSO
75.Xr example 1 ,
76.Xr example 3 ,
77.Xr mdoc 7 ,
78.Xr mdoc.samples 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 mpp@FreeBSD.org .
102.Sh BUGS
103The actual code for this device driver is vaporware.
104