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