1.\" Copyright (c) [year] [your name] 2.\" 3.\" Redistribution and use in source and binary forms, with or without 4.\" modification, are permitted provided that the following conditions 5.\" are met: 6.\" 1. Redistributions of source code must retain the above copyright 7.\" notice, this list of conditions and the following disclaimer. 8.\" 2. Redistributions in binary form must reproduce the above copyright 9.\" notice, this list of conditions and the following disclaimer in the 10.\" documentation and/or other materials provided with the distribution. 11.\" 12.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 13.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 14.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 15.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 16.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 17.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 18.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 19.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 20.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 21.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 22.\" SUCH DAMAGE. 23.\" 24.\" $FreeBSD$ 25.\" 26.\" Note: The date here should be updated whenever a non-trivial 27.\" change is made to the manual page. 28.Dd December 8, 1999 29.Dt EXAMPLE 1 30.Os 31.Sh NAME 32.Nm example 33.Nd "example command manual page" 34.Sh SYNOPSIS 35.Nm 36.Op Fl abc 37.Op Fl d Ar argument 38.Ar file 39.Sh DESCRIPTION 40This is an example manual page for the 41.Nm 42command. 43It is intended that this example can be used as a template 44when writing a new manual page. 45.Pp 46The options are as follows: 47.Bl -tag -width ".Fl d Ar argument" 48.It Fl a 49Example optional 50.Fl a 51option. 52.It Fl b 53Example optional 54.Fl b 55option. 56.It Fl c 57Example optional 58.Fl c 59option. 60.It Fl d Ar argument 61Example optional 62.Fl d 63option with required argument 64.Ar argument . 65.It Ar file 66Required argument 67.Ar file . 68.El 69.Sh ENVIRONMENT 70The 71.Nm 72command ignores the 73.Ev EXAMPLE 74environment variable. 75.Sh FILES 76.Bl -tag -width ".Pa /dev/null" -compact 77.It Pa /dev/null 78Example of a file in the 79.Sx FILES 80section. 81.El 82.Sh EXIT STATUS 83.Ex -std 84.Sh EXAMPLES 85The following is an example of a typical usage 86of the 87.Nm 88command: 89.Pp 90.Dl "example -abc -d xyzzy /dev/null" 91.Sh DIAGNOSTICS 92The command may fail for one of the following reasons: 93.Bl -diag 94.It "example error message" 95An example of an error message. 96.It "another example error message." 97Self explanatory. 98.El 99.Sh COMPATIBILITY 100The 101.Nm 102command has no known compatibility issues. 103.Sh SEE ALSO 104.Xr example 3 , 105.Xr example 4 , 106.Xr mdoc 7 , 107.Xr example 9 108.Rs 109.%A "A. B. Author" 110.%T "Example RFC Title" 111.%O RFC0000 112.Re 113.Rs 114.%A "A. B. Author" 115.%B "Example Book Title" 116.%O ISBN-0-000-00000-0 117.Re 118.Rs 119.%A "A. B. Author" 120.%D "January 1997" 121.%J "Example Journal Name" 122.%T "Example Article Title" 123.Re 124.Sh STANDARDS 125If the command conforms to some standard, such as 126.St -p1003.2 127or 128.St -isoC , 129it should be noted here. 130.Sh HISTORY 131The 132.Nm 133manual page example first appeared in 134.Fx 2.2 . 135.Pp 136Some other common 137.Sx HISTORY 138section examples are: 139.Pp 140The 141.Nm 142manual page example first appeared in 143.Bx 4.4 . 144.Pp 145The 146.Nm 147manual page example first appeared in 148.At v6 . 149.Sh AUTHORS 150This 151manual page was written by 152.An Mike Pritchard Aq Mt mpp@FreeBSD.org . 153.Sh BUGS 154The actual code for this command is vaporware. 155