xref: /freebsd/share/examples/mdoc/example.1 (revision b5b2a90624d3d900a42e99758eb95293d04f37fa)
1.\" Copyright (c) [year] [your name]
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
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.
12.\"
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
23.\" SUCH DAMAGE.
24.\"
25.\"	[id for your version control system, if any]
26.\"
27.\" Note: The date here should be updated whenever a non-trivial
28.\" change is made to the manual page.
29.Dd January 8, 1997
30.Dt EXAMPLE 1
31.\" Note: Only specify the operating system when the command
32.\" is FreeBSD specific, otherwise use the .Os macro with no
33.\" arguments.
34.Os FreeBSD 2.2
35.Sh NAME
36.Nm example
37.Nd example command manual page
38.Sh SYNOPSIS
39.Nm example
40.Op Fl abc
41.Op Fl d Ar argument
42.Ar file
43.Sh DESCRIPTION
44This is an example manual page for
45the
46.Nm
47command.  It is intended
48that this example can be used as a template when writing
49a new manual page.
50.Pp
51The options are as follows:
52has several options:
53.Bl -tag -width Fl
54.It Fl a
55Example optional
56.Fl a
57option.
58.It Fl b
59Example optional
60.Fl b
61option.
62.It Fl c
63Example optional
64.Fl c
65option.
66.It Fl d Ar argument
67Example optional
68.Fl d
69option with required argument
70.Ar argument .
71.It Ar file
72Required argument
73.Ar file .
74.El
75.Sh ENVIRONMENT
76The
77.Nm
78command ignores the
79.Ev EXAMPLE
80environment variable.
81.Sh FILES
82.Bl -tag -width /dev/null -compact
83.It Pa /dev/null
84Example of a file in the
85.Sx FILES
86section.
87.El
88.Sh EXAMPLES
89The following is an example of a typical usage
90of the
91.Nm
92command:
93.Pp
94.Dl % example -abc -d xyzzy /dev/null
95.Sh SEE ALSO
96.Xr example 3 ,
97.Xr example 4 ,
98.Xr mdoc 7 ,
99.Xr mdoc.samples 7
100.Rs
101.%A A. B. Author
102.%T Example RFC Title
103.%O RFC0000
104.Re
105.Rs
106.%A A. B. Author
107.%B Example Book Title
108.%O ISBN-0-000-00000-0
109.Re
110.Rs
111.%A A. B. Author
112.%D January 1997
113.%J Example Journal Name
114.%T Example Article Title
115.Re
116.Sh STANDARDS
117If the command conforms to some standard, such as
118.St -p1003.2
119or
120.St -ansiC ,
121it should be noted here.
122.Sh DIAGNOSTICS
123Exist status is 0 on success, and 1 if the command
124fails for one of the following reasons
125.Bl -diag
126.It example error message
127An example of an error message.
128.It another example error message.
129Self explanatory.
130.El
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 AUTHOR
151This
152manual page was written by Mike Pritchard
153.Aq mpp@FreeBSD.ORG .
154.Sh BUGS
155The actual code for this command is vaporware.
156