example.4 (eb2d52f4b89110371b3cb47a62f12d41390ad1ac) example.4 (9a78dbdeb7552283b59d09210a9fa99f78fecc86)
1.\" Copyright (c) [year] [your name]
2.\" All rights reserved.
1.\" Copyright (c) [year]
2.\" [you name here]. 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.
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. All advertising materials mentioning features or use of this software
13.\" must display the following acknowledgement:
14.\" This product includes software developed by [you name]
15.\" and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\" may be used to endorse or promote products derived from this software
18.\" without specific prior written permission.
12.\"
19.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20.\" THIS SOFTWARE IS PROVIDED BY [you name] 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.\"
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
25.\" $FreeBSD$
26.\"
32.\"
27.\" Note: The date here should be updated whenever a non-trivial
28.\" change is made to the manual page.
29.Dd April 1, 2006
33.Dd "January 2, 1997"
30.Dt EXAMPLE 4 i386
34.Dt EXAMPLE 4 i386
31.Os
35.\" Note: Only specify the operating system when the command
36.\" is FreeBSD specific, otherwise use the .Os macro with no
37.\" arguments.
38.Os FreeBSD 3.0
32.Sh NAME
33.Nm example
39.Sh NAME
40.Nm example
34.Nd "example device driver manual page"
41.Nd example device driver manual page
35.Sh SYNOPSIS
42.Sh SYNOPSIS
36To compile the
37.Ns Nm
38driver into the kernel,
39place the following lines in the
40kernel configuration file:
41.Bd -ragged -offset indent
42.Cd "device example"
43.Cd "options EXAMPLE_DEBUG"
44.Ed
45.Pp
46Alternatively, to load the
47.Ns Nm
48driver as a
49module at boot time, place the following line in
50.Xr loader.conf 5 :
51.Bd -literal -offset indent
52example_load="YES"
53.Ed
43.Cd pseudo-device example
54.Sh DESCRIPTION
44.Sh DESCRIPTION
55This is an example device driver manual page for the
56.Nm
57driver.
58It is intended that this example can be used as a template
59when writing a new manual page.
45This is an example device driver manual page for
46the
47.Nm example
48driver. It is intended
49that this example can be used as a template when writing
50a new manual page.
60.Pp
61The
62.Nm
63driver supports the following ioctls:
51.Pp
52The
53.Nm
54driver supports the following ioctls:
64.Bl -tag -width ".Dv EIOCNULL"
55.Bl -tag -width XXXXXXXXXXX
65.It Dv EIOCEX
66Example ioctl.
67.It Dv EIOCNULL
68Example ioctl.
69.El
56.It Dv EIOCEX
57Example ioctl.
58.It Dv EIOCNULL
59Example ioctl.
60.El
70.Pp
71If the kernel is compiled with the
72.Dv EXAMPLE_DEBUG
73option, then additional debugging messages will be displayed.
74.Sh HARDWARE
75The
76.Nm
77driver supports the following example hardware:
78.Pp
79.Bl -bullet -compact
80.It
81Example device 4201
82.It
83Example device 4202
84.El
85.Sh FILES
61.Sh FILES
86.Bl -tag -width ".Pa /dev/null" -compact
62.Bl -tag -width /dev/null -compact
87.It Pa /dev/null
88Example of a file in the
89.Sx FILES
90section.
91.El
63.It Pa /dev/null
64Example of a file in the
65.Sx FILES
66section.
67.El
92.Sh DIAGNOSTICS
93.Bl -diag
94.It "example%d: example diagnostic message."
95An example of a diagnostic message.
96.It "example%d: another example diagnostic message."
97Self explanatory.
98.El
99.Sh SEE ALSO
100.Xr example 1 ,
101.Xr example 3 ,
102.Xr mdoc 7 ,
68.Sh SEE ALSO
69.Xr example 1 ,
70.Xr example 3 ,
71.Xr mdoc 7 ,
103.Xr example 9
72.Xr mdoc.samples 7
73.Sh DIAGNOSTICS
74None.
104.Sh HISTORY
105The
106.Nm
75.Sh HISTORY
76The
77.Nm
107device driver first appeared in
108.Fx 2.2 .
109.Pp
110Some other common
111.Sx HISTORY
112section examples are:
113.Pp
114The
115.Nm
116manual page example first appeared in
78manual page example first appeared in
117.Bx 4.4 .
118.Pp
119The
120.Nm
121manual page example first appeared in
122.At v6 .
123.Sh AUTHORS
124This manual page was written by
125.An Mike Pritchard Aq mpp@FreeBSD.org .
79.Fx 3.0 .
80.Sh AUTHOR
81This
82manual page was written by Mike Pritchard
83.Aq mpp@FreeBSD.ORG .
126.Sh BUGS
127The actual code for this device driver is vaporware.
84.Sh BUGS
85The actual code for this device driver is vaporware.