example.1 (06d7435baf3cb0653ecfbdea7a52adba7c0445fd) example.1 (9a78dbdeb7552283b59d09210a9fa99f78fecc86)
1.\" Copyright (c) [year] [your name]
2.\" All rights reserved.
1.\" Copyright (c) [year]
2.\" [you name here]. 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.
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.\" 3. All advertising materials mentioning features or use of this software
13.\" must display the following acknowledgement:
14.\" This product includes software developed by [you name]
15.\" and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\" may be used to endorse or promote products derived from this software
18.\" without specific prior written permission.
12.\"
19.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20.\" THIS SOFTWARE IS PROVIDED BY [you name] 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.\"
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
25.\" $FreeBSD$
26.\"
32.\"
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
33.Dd "January 2, 1997"
30.Dt EXAMPLE 1
34.Dt EXAMPLE 1
31.Os
35.\" Note: Only specify the operating system when the command
36.\" is FreeBSD specific, otherwise use the .Os macro with no
37.\" arguments.
38.Os FreeBSD 3.0
32.Sh NAME
33.Nm example
39.Sh NAME
40.Nm example
34.Nd "example command manual page"
41.Nd example command manual page
35.Sh SYNOPSIS
42.Sh SYNOPSIS
36.Nm
43.Nm example
37.Op Fl abc
38.Op Fl d Ar argument
39.Ar file
40.Sh DESCRIPTION
44.Op Fl abc
45.Op Fl d Ar argument
46.Ar file
47.Sh DESCRIPTION
41This is an example manual page for the
48This is an example manual page for
49the
42.Nm
50.Nm
43command.
44It is intended that this example can be used as a template
45when writing a new manual page.
51command. It is intended
52that this example can be used as a template when writing
53a new manual page.
46.Pp
47The options are as follows:
54.Pp
55The options are as follows:
48.Bl -tag -width ".Fl d Ar argument"
56has several options:
57.Bl -tag -width Fl
49.It Fl a
50Example optional
51.Fl a
52option.
53.It Fl b
54Example optional
55.Fl b
56option.
58.It Fl a
59Example optional
60.Fl a
61option.
62.It Fl b
63Example optional
64.Fl b
65option.
57.It Fl c
66.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
67Example optional
68.Fl c
69option.
70.It Fl d Ar argument
71Example optional
72.Fl d
73option with required argument
74.Ar argument .
75.It Ar file
76Required argument
77.Ar file .
78.El
79.Sh ENVIRONMENT
71The
80The
72.Nm
73command ignores the
74.Ev EXAMPLE
75environment variable.
76.Sh FILES
81.Nm
82command ignores the
83.Ev EXAMPLE
84environment variable.
85.Sh FILES
77.Bl -tag -width ".Pa /dev/null" -compact
86.Bl -tag -width /dev/null -compact
78.It Pa /dev/null
79Example of a file in the
80.Sx FILES
81section.
82.El
87.It Pa /dev/null
88Example of a file in the
89.Sx FILES
90section.
91.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 ,
92.Sh SEE ALSO
93.Xr example 3 ,
94.Xr example 4 ,
95.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
96.Xr mdoc.samples 7
125.Sh STANDARDS
126If the command conforms to some standard, such as
127.St -p1003.2
128or
97.Sh STANDARDS
98If the command conforms to some standard, such as
99.St -p1003.2
100or
129.St -isoC ,
101.St -ansiC ,
130it should be noted here.
102it should be noted here.
103.Sh DIAGNOSTICS
104None.
131.Sh HISTORY
132The
133.Nm
134manual page example first appeared in
105.Sh HISTORY
106The
107.Nm
108manual 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
109.Fx 3.0 .
110.Sh AUTHOR
151This
111This
152manual page was written by
153.An Mike Pritchard Aq mpp@FreeBSD.org .
112manual page was written by Mike Pritchard
113.Aq mpp@FreeBSD.ORG .
154.Sh BUGS
155The actual code for this command is vaporware.
114.Sh BUGS
115The actual code for this command is vaporware.