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
25 .\" $FreeBSD: src/share/examples/mdoc/example.1,v 1.12.2.6 2001/08/17 13:08:35 ru Exp $
26 .\" $DragonFly: src/share/examples/mdoc/example.1,v 1.2 2003/06/17 06:36:57 dillon Exp $
28 .\" Note: The date here should be updated whenever a non-trivial
29 .\" change is made to the manual page.
35 .Nd "example command manual page"
42 This is an example manual page for the
45 It is intended that this example can be used as a template
46 when writing a new manual page.
48 The options are as follows:
49 .Bl -tag -width ".Fl d Ar argument"
65 option with required argument
78 .Bl -tag -width ".Pa /dev/null" -compact
80 Example of a file in the
85 The following is an example of a typical usage
90 .Dl "example -abc -d xyzzy /dev/null"
92 Exit status is 0 on success, and 1 if the command
93 fails for one of the following reasons:
95 .It "example error message"
96 An example of an error message.
97 .It "another example error message."
103 command has no known compatibility issues.
110 .%T "Example RFC Title"
115 .%B "Example Book Title"
116 .%O ISBN-0-000-00000-0
121 .%J "Example Journal Name"
122 .%T "Example Article Title"
125 If the command conforms to some standard, such as
129 it should be noted here.
133 manual page example first appeared in
138 section examples are:
142 manual page example first appeared in
147 manual page example first appeared in
151 manual page was written by
152 .An Mike Pritchard Aq mpp@FreeBSD.org .
154 The actual code for this command is vaporware.