1 .\" Copyright (c) [year] [your name]
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
26 .\" Note: All FreeBSD man pages should have a FreeBSD revision
27 .\" control id to make it easier for translation teams to track
30 .\" Note: The date here should be updated whenever a non-trivial
31 .\" change is made to the manual page.
34 .\" Note: Only specify the operating system when the command
35 .\" is FreeBSD specific, otherwise use the .Os macro with no
40 .Nd example command manual page
47 This is an example manual page for
50 command. It is intended
51 that this example can be used as a template when writing
54 The options are as follows:
71 option with required argument
84 .Bl -tag -width /dev/null -compact
86 Example of a file in the
91 The following is an example of a typical usage
96 .Dl % example -abc -d xyzzy /dev/null
98 Exit status is 0 on success, and 1 if the command
99 fails for one of the following reasons
101 .It example error message
102 An example of an error message.
103 .It another example error message.
109 command has no known compatibility issues.
117 .%T Example RFC Title
122 .%B Example Book Title
123 .%O ISBN-0-000-00000-0
128 .%J Example Journal Name
129 .%T Example Article Title
132 If the command conforms to some standard, such as
136 it should be noted here.
140 manual page example first appeared in
145 section examples are:
149 manual page example first appeared in
154 manual page example first appeared in
158 manual page was written by
159 .An Mike Pritchard Aq mpp@FreeBSD.org .
161 The actual code for this command is vaporware.