xref: /freebsd/share/examples/mdoc/example.1 (revision 9a78dbdeb7552283b59d09210a9fa99f78fecc86)
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.
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.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY [you name] AND CONTRIBUTORS ``AS IS'' AND
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.\"
32.\"
33.Dd "January 2, 1997"
34.Dt EXAMPLE 1
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
39.Sh NAME
40.Nm example
41.Nd example command manual page
42.Sh SYNOPSIS
43.Nm example
44.Op Fl abc
45.Op Fl d Ar argument
46.Ar file
47.Sh DESCRIPTION
48This is an example manual page for
49the
50.Nm
51command.  It is intended
52that this example can be used as a template when writing
53a new manual page.
54.Pp
55The options are as follows:
56has several options:
57.Bl -tag -width Fl
58.It Fl a
59Example optional
60.Fl a
61option.
62.It Fl b
63Example optional
64.Fl b
65option.
66.It Fl c
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
80The
81.Nm
82command ignores the
83.Ev EXAMPLE
84environment variable.
85.Sh FILES
86.Bl -tag -width /dev/null -compact
87.It Pa /dev/null
88Example of a file in the
89.Sx FILES
90section.
91.El
92.Sh SEE ALSO
93.Xr example 3 ,
94.Xr example 4 ,
95.Xr mdoc 7 ,
96.Xr mdoc.samples 7
97.Sh STANDARDS
98If the command conforms to some standard, such as
99.St -p1003.2
100or
101.St -ansiC ,
102it should be noted here.
103.Sh DIAGNOSTICS
104None.
105.Sh HISTORY
106The
107.Nm
108manual page example first appeared in
109.Fx 3.0 .
110.Sh AUTHOR
111This
112manual page was written by Mike Pritchard
113.Aq mpp@FreeBSD.ORG .
114.Sh BUGS
115The actual code for this command is vaporware.
116