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: src/share/examples/mdoc/example.4,v 1.10.2.5 2001/08/17 13:08:35 ru Exp $
  26 .\"
  27 .\" Note: The date here should be updated whenever a non-trivial
  28 .\" change is made to the manual page.
  29 .Dd December 8, 1999
  30 .Dt EXAMPLE 4
  31 .Os
  32 .Sh NAME
  33 .Nm example
  34 .Nd example device driver manual page
  35 .Sh SYNOPSIS
  36 .Cd "pseudo-device example"
  37 .Cd "options EXAMPLE_DEBUG"
  38 .Sh DESCRIPTION
  39 This is an example device driver manual page for the
  40 .Nm
  41 driver.
  42 It is intended that this example can be used as a template
  43 when writing a new manual page.
  44 .Pp
  45 The
  46 .Nm
  47 driver supports the following ioctls:
  48 .Bl -tag -width ".Dv EIOCNULL"
  49 .It Dv EIOCEX
  50 Example ioctl.
  51 .It Dv EIOCNULL
  52 Example ioctl.
  53 .El
  54 .Pp
  55 If the kernel is compiled with the
  56 .Dv EXAMPLE_DEBUG
  57 option, then additional debugging messages will be displayed.
  58 .Sh FILES
  59 .Bl -tag -width ".Pa /dev/null" -compact
  60 .It Pa /dev/null
  61 Example of a file in the
  62 .Sx FILES
  63 section.
  64 .El
  65 .Sh DIAGNOSTICS
  66 .Bl -diag
  67 .It "example%d: example diagnostic message."
  68 An example of a diagnostic message.
  69 .It "example%d: another example diagnostic message."
  70 Self explanatory.
  71 .El
  72 .Sh SEE ALSO
  73 .Xr example 1 ,
  74 .Xr example 3 ,
  75 .Xr mdoc 7
  76 .Sh HISTORY
  77 The
  78 .Nm
  79 manual page example first appeared in
  80 .Fx 2.2 .
  81 .Pp
  82 Some other common
  83 .Sx HISTORY
  84 section examples are:
  85 .Pp
  86 The
  87 .Nm
  88 manual page example first appeared in
  89 .Bx 4.4 .
  90 .Pp
  91 The
  92 .Nm
  93 manual page example first appeared in
  94 .At v6 .
  95 .Sh AUTHORS
  96 This
  97 manual page was written by
  98 .An Mike Pritchard Aq Mt mpp@FreeBSD.org .
  99 .Sh BUGS
 100 The actual code for this device driver is vaporware.