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