1.\" 2.\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3.\" 4.\" Copyright (c) [year] [your name] 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25.\" SUCH DAMAGE. 26.\" 27.\" $FreeBSD$ 28.\" 29.\" Note: The date here should be updated whenever a non-trivial 30.\" change is made to the manual page. 31.Dd December 8, 1999 32.Dt EXAMPLE 1 33.Os 34.Sh NAME 35.Nm example 36.Nd "example command manual page" 37.Sh SYNOPSIS 38.Nm 39.Op Fl abc 40.Op Fl d Ar argument 41.Ar file 42.Sh DESCRIPTION 43This is an example manual page for the 44.Nm 45command. 46It is intended that this example can be used as a template 47when writing a new manual page. 48.Pp 49The options are as follows: 50.Bl -tag -width ".Fl d Ar argument" 51.It Fl a 52Example optional 53.Fl a 54option. 55.It Fl b 56Example optional 57.Fl b 58option. 59.It Fl c 60Example optional 61.Fl c 62option. 63.It Fl d Ar argument 64Example optional 65.Fl d 66option with required argument 67.Ar argument . 68.It Ar file 69Required argument 70.Ar file . 71.El 72.Sh ENVIRONMENT 73The 74.Nm 75command ignores the 76.Ev EXAMPLE 77environment variable. 78.Sh FILES 79.Bl -tag -width ".Pa /dev/null" -compact 80.It Pa /dev/null 81Example of a file in the 82.Sx FILES 83section. 84.El 85.Sh EXIT STATUS 86.Ex -std 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 95The command may fail for one of the following reasons: 96.Bl -diag 97.It "example error message" 98An example of an error message. 99.It "another example error message." 100Self explanatory. 101.El 102.Sh COMPATIBILITY 103The 104.Nm 105command has no known compatibility issues. 106.Sh SEE ALSO 107.Xr example 3 , 108.Xr example 4 , 109.Xr mdoc 7 , 110.Xr example 9 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 Mt mpp@FreeBSD.org . 156.Sh BUGS 157The actual code for this command is vaporware. 158