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