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.Os 35.Sh NAME 36.Nm example 37.Nd example command manual page 38.Sh SYNOPSIS 39.Nm 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 DIAGNOSTICS 95Exit status is 0 on success, and 1 if the command 96fails for one of the following reasons 97.Bl -diag 98.It example error message 99An example of an error message. 100.It another example error message. 101Self explanatory. 102.El 103.Sh COMPATIBILITY 104The 105.Nm 106command has no known compatibility issues. 107.Sh SEE ALSO 108.Xr example 3 , 109.Xr example 4 , 110.Xr mdoc 7 111.Rs 112.%A A. B. Author 113.%T Example RFC Title 114.%O RFC0000 115.Re 116.Rs 117.%A A. B. Author 118.%B Example Book Title 119.%O ISBN-0-000-00000-0 120.Re 121.Rs 122.%A A. B. Author 123.%D January 1997 124.%J Example Journal Name 125.%T Example Article Title 126.Re 127.Sh STANDARDS 128If the command conforms to some standard, such as 129.St -p1003.2 130or 131.St -isoC , 132it should be noted here. 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