xref: /dragonfly/share/examples/mdoc/example.4 (revision cecb9aae)
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: src/share/examples/mdoc/example.4,v 1.10.2.5 2001/08/17 13:08:35 ru Exp $
26.\" $DragonFly: src/share/examples/mdoc/example.4,v 1.2 2003/06/17 04:36:57 dillon Exp $
27.\"
28.\" Note: The date here should be updated whenever a non-trivial
29.\" change is made to the manual page.
30.Dd December 8, 1999
31.Dt EXAMPLE 4 i386
32.Os
33.Sh NAME
34.Nm example
35.Nd "example device driver manual page"
36.Sh SYNOPSIS
37.Cd "pseudo-device example"
38.Cd "options EXAMPLE_DEBUG"
39.Sh DESCRIPTION
40This is an example device driver manual page for the
41.Nm
42driver.
43It is intended that this example can be used as a template
44when writing a new manual page.
45.Pp
46The
47.Nm
48driver supports the following ioctls:
49.Bl -tag -width ".Dv EIOCNULL"
50.It Dv EIOCEX
51Example ioctl.
52.It Dv EIOCNULL
53Example ioctl.
54.El
55.Pp
56If the kernel is compiled with the
57.Dv EXAMPLE_DEBUG
58option, then additional debugging messages will be displayed.
59.Sh FILES
60.Bl -tag -width ".Pa /dev/null" -compact
61.It Pa /dev/null
62Example of a file in the
63.Sx FILES
64section.
65.El
66.Sh DIAGNOSTICS
67.Bl -diag
68.It "example%d: example diagnostic message."
69An example of a diagnostic message.
70.It "example%d: another example diagnostic message."
71Self explanatory.
72.El
73.Sh SEE ALSO
74.Xr example 1 ,
75.Xr example 3 ,
76.Xr mdoc 7
77.Sh HISTORY
78The
79.Nm
80manual page example first appeared in
81.Fx 2.2 .
82.Pp
83Some other common
84.Sx HISTORY
85section examples are:
86.Pp
87The
88.Nm
89manual page example first appeared in
90.Bx 4.4 .
91.Pp
92The
93.Nm
94manual page example first appeared in
95.At v6 .
96.Sh AUTHORS
97This
98manual page was written by
99.An Mike Pritchard Aq mpp@FreeBSD.org .
100.Sh BUGS
101The actual code for this device driver is vaporware.
102