share/examples/mdoc/example.4

   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 .\"
  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
  30 .Dt EXAMPLE 4 i386
  31 .Os
  32 .Sh NAME
  33 .Nm example
  34 .Nd "example device driver manual page"
  35 .Sh SYNOPSIS
  36 To compile the
  37 driver into the kernel,
  38 place the following lines in the
  39 kernel configuration file:
  40 .Bd -ragged -offset indent
  41 .Cd "device example"
  42 .Cd "options EXAMPLE_DEBUG"
  43 .Ed
  44 .Pp
  45 Alternatively, to load the
  46 driver as a
  47 module at boot time, place the following line in
  48 .Xr loader.conf 5 :
  49 .Bd -literal -offset indent
  50 example_load="YES"
  51 .Ed
  52 .Sh DESCRIPTION
  53 This is an example device driver manual page for the
  54 .Nm
  55 driver.
  56 It is intended that this example can be used as a template
  57 when writing a new manual page.
  58 .Pp
  59 The
  60 .Nm
  61 driver supports the following ioctls:
  62 .Bl -tag -width ".Dv EIOCNULL"
  63 .It Dv EIOCEX
  64 Example ioctl.
  65 .It Dv EIOCNULL
  66 Example ioctl.
  67 .El
  68 .Pp
  69 If the kernel is compiled with the
  70 .Dv EXAMPLE_DEBUG
  71 option, then additional debugging messages will be displayed.
  72 .Sh HARDWARE
  73 The
  74 .Nm
  75 driver supports the following example hardware:
  76 .Pp
  77 .Bl -bullet -compact
  78 .It
  79 Example device 4201
  80 .It
  81 Example device 4202
  82 .El
  83 .Sh FILES
  84 .Bl -tag -width ".Pa /dev/null" -compact
  85 .It Pa /dev/null
  86 Example of a file in the
  87 .Sx FILES
  88 section.
  89 .El
  90 .Sh DIAGNOSTICS
  91 .Bl -diag
  92 .It "example%d: example diagnostic message."
  93 An example of a diagnostic message.
  94 .It "example%d: another example diagnostic message."
  95 Self explanatory.
  96 .El
  97 .Sh SEE ALSO
  98 .Xr example 1 ,
  99 .Xr example 3 ,
 100 .Xr mdoc 7 ,
 101 .Xr example 9
 102 .Sh HISTORY
 103 The
 104 .Nm
 105 device driver first appeared in
 106 .Fx 2.2 .
 107 .Pp
 108 Some other common
 109 .Sx HISTORY
 110 section examples are:
 111 .Pp
 112 The
 113 .Nm
 114 manual page example first appeared in
 115 .Bx 4.4 .
 116 .Pp
 117 The
 118 .Nm
 119 manual page example first appeared in
 120 .At v6 .
 121 .Sh AUTHORS
 122 This manual page was written by
 123 .An Mike Pritchard Aq mpp@FreeBSD.org .
 124 .Sh BUGS
 125 The actual code for this device driver is vaporware.