2 .\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 .\" Copyright (c) [year] [your name]
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
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.
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
29 .\" Note: The date here should be updated whenever a non-trivial
30 .\" change is made to the manual page.
36 .Nd "example command manual page"
43 This is an example manual page for the
46 It is intended that this example can be used as a template
47 when writing a new manual page.
49 The options are as follows:
50 .Bl -tag -width ".Fl d Ar argument"
66 option with required argument
79 .Bl -tag -width ".Pa /dev/null" -compact
81 Example of a file in the
88 The following is an example of a typical usage
93 .Dl "example -abc -d xyzzy /dev/null"
95 The command may fail for one of the following reasons:
97 .It "example error message"
98 An example of an error message.
99 .It "another example error message."
105 command has no known compatibility issues.
113 .%T "Example RFC Title"
118 .%B "Example Book Title"
119 .%O ISBN-0-000-00000-0
124 .%J "Example Journal Name"
125 .%T "Example Article Title"
128 If the command conforms to some standard, such as
132 it should be noted here.
136 manual page example first appeared in
141 section examples are:
145 manual page example first appeared in
150 manual page example first appeared in
154 manual page was written by
155 .An Mike Pritchard Aq Mt mpp@FreeBSD.org .
157 The actual code for this command is vaporware.