share/examples/mdoc/example.1

   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.1,v 1.23 2005/01/16 22:22:28 ru Exp $
  26 .\" $DragonFly: src/share/examples/mdoc/example.1,v 1.2 2003/06/17 04:36:57 dillon Exp $
  27 .\"
  28 .\" Note: The date here should be updated whenever a non-trivial
  29 .\" change is made to the manual page.
  30 .Dd December 8, 1999
  31 .Dt EXAMPLE 1
  32 .Os
  33 .Sh NAME
  34 .Nm example
  35 .Nd "example command manual page"
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl abc
  39 .Op Fl d Ar argument
  40 .Ar file
  41 .Sh DESCRIPTION
  42 This is an example manual page for the
  43 .Nm
  44 command.
  45 It is intended that this example can be used as a template
  46 when writing a new manual page.
  47 .Pp
  48 The options are as follows:
  49 .Bl -tag -width ".Fl d Ar argument"
  50 .It Fl a
  51 Example optional
  52 .Fl a
  53 option.
  54 .It Fl b
  55 Example optional
  56 .Fl b
  57 option.
  58 .It Fl c
  59 Example optional
  60 .Fl c
  61 option.
  62 .It Fl d Ar argument
  63 Example optional
  64 .Fl d
  65 option with required argument
  66 .Ar argument .
  67 .It Ar file
  68 Required argument
  69 .Ar file .
  70 .El
  71 .Sh ENVIRONMENT
  72 The
  73 .Nm
  74 command ignores the
  75 .Ev EXAMPLE
  76 environment variable.
  77 .Sh FILES
  78 .Bl -tag -width ".Pa /dev/null" -compact
  79 .It Pa /dev/null
  80 Example of a file in the
  81 .Sx FILES
  82 section.
  83 .El
  84 .Sh EXIT STATUS
  85 .Ex -std
  86 .Sh EXAMPLES
  87 The following is an example of a typical usage
  88 of the
  89 .Nm
  90 command:
  91 .Pp
  92 .Dl "example -abc -d xyzzy /dev/null"
  93 .Sh DIAGNOSTICS
  94 The command may fail for one of the following reasons:
  95 .Bl -diag
  96 .It "example error message"
  97 An example of an error message.
  98 .It "another example error message."
  99 Self explanatory.
 100 .El
 101 .Sh COMPATIBILITY
 102 The
 103 .Nm
 104 command has no known compatibility issues.
 105 .Sh SEE ALSO
 106 .Xr example 3 ,
 107 .Xr example 4 ,
 108 .Xr mdoc 7
 109 .Rs
 110 .%A "A. B. Author"
 111 .%T "Example RFC Title"
 112 .%O RFC0000
 113 .Re
 114 .Rs
 115 .%A "A. B. Author"
 116 .%B "Example Book Title"
 117 .%O ISBN-0-000-00000-0
 118 .Re
 119 .Rs
 120 .%A "A. B. Author"
 121 .%D "January 1997"
 122 .%J "Example Journal Name"
 123 .%T "Example Article Title"
 124 .Re
 125 .Sh STANDARDS
 126 If the command conforms to some standard, such as
 127 .St -p1003.2
 128 or
 129 .St -isoC ,
 130 it should be noted here.
 131 .Sh HISTORY
 132 The
 133 .Nm
 134 manual page example first appeared in
 135 .Fx 2.2 .
 136 .Pp
 137 Some other common
 138 .Sx HISTORY
 139 section examples are:
 140 .Pp
 141 The
 142 .Nm
 143 manual page example first appeared in
 144 .Bx 4.4 .
 145 .Pp
 146 The
 147 .Nm
 148 manual page example first appeared in
 149 .At v6 .
 150 .Sh AUTHORS
 151 This
 152 manual page was written by
 153 .An Mike Pritchard Aq mpp@FreeBSD.org .
 154 .Sh BUGS
 155 The actual code for this command is vaporware.