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