share/examples/mdoc/example.4

   1 .\"
   2 .\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3 .\"
   4 .\" Copyright (c) [year] [your name]
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD$
  28 .\"
  29 .\" Note: The date here should be updated whenever a non-trivial
  30 .\" change is made to the manual page.
  31 .Dd July 31, 2015
  32 .Dt EXAMPLE 4 i386
  33 .Os
  34 .Sh NAME
  35 .Nm example
  36 .Nd "example device driver manual page"
  37 .Sh SYNOPSIS
  38 To compile the 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 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 "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 Mt mpp@FreeBSD.org .
 124 .Sh BUGS
 125 The actual code for this device driver is vaporware.