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