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.\" [id for your version control system, if any] 26.\" 27.\" Note: The date here should be updated whenever a non-trivial 28.\" change is made to the manual page. 29.Dd January 8, 1997 30.Dt EXAMPLE 1 31.\" Note: Only specify the operating system when the command 32.\" is FreeBSD specific, otherwise use the .Os macro with no 33.\" arguments. 34.Os FreeBSD 2.2 35.Sh NAME 36.Nm example 37.Nd example command manual page 38.Sh SYNOPSIS 39.Nm example 40.Op Fl abc 41.Op Fl d Ar argument 42.Ar file 43.Sh DESCRIPTION 44This is an example manual page for 45the 46.Nm 47command. It is intended 48that this example can be used as a template when writing 49a new manual page. 50.Pp 51The options are as follows: 52.Bl -tag -width Fl 53.It Fl a 54Example optional 55.Fl a 56option. 57.It Fl b 58Example optional 59.Fl b 60option. 61.It Fl c 62Example optional 63.Fl c 64option. 65.It Fl d Ar argument 66Example optional 67.Fl d 68option with required argument 69.Ar argument . 70.It Ar file 71Required argument 72.Ar file . 73.El 74.Sh ENVIRONMENT 75The 76.Nm 77command ignores the 78.Ev EXAMPLE 79environment variable. 80.Sh FILES 81.Bl -tag -width /dev/null -compact 82.It Pa /dev/null 83Example of a file in the 84.Sx FILES 85section. 86.El 87.Sh EXAMPLES 88The following is an example of a typical usage 89of the 90.Nm 91command: 92.Pp 93.Dl % example -abc -d xyzzy /dev/null 94.Sh SEE ALSO 95.Xr example 3 , 96.Xr example 4 , 97.Xr mdoc 7 , 98.Xr mdoc.samples 7 99.Rs 100.%A A. B. Author 101.%T Example RFC Title 102.%O RFC0000 103.Re 104.Rs 105.%A A. B. Author 106.%B Example Book Title 107.%O ISBN-0-000-00000-0 108.Re 109.Rs 110.%A A. B. Author 111.%D January 1997 112.%J Example Journal Name 113.%T Example Article Title 114.Re 115.Sh STANDARDS 116If the command conforms to some standard, such as 117.St -p1003.2 118or 119.St -ansiC , 120it should be noted here. 121.Sh DIAGNOSTICS 122Exit status is 0 on success, and 1 if the command 123fails for one of the following reasons 124.Bl -diag 125.It example error message 126An example of an error message. 127.It another example error message. 128Self explanatory. 129.El 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 mpp@FreeBSD.org . 153.Sh BUGS 154The actual code for this command is vaporware. 155