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