share/examples: use .Mt for emails in man pages
[dragonfly.git] / share / examples / mdoc / example.1
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 .\" $FreeBSD: src/share/examples/mdoc/example.1,v 1.23 2005/01/16 22:22:28 ru Exp $
26 .\"
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
30 .Dt EXAMPLE 1
31 .Os
32 .Sh NAME
33 .Nm example
34 .Nd example command manual page
35 .Sh SYNOPSIS
36 .Nm
37 .Op Fl abc
38 .Op Fl d Ar argument
39 .Ar file
40 .Sh DESCRIPTION
41 This is an example manual page for the
42 .Nm
43 command.
44 It is intended that this example can be used as a template
45 when writing a new manual page.
46 .Pp
47 The options are as follows:
48 .Bl -tag -width ".Fl d Ar argument"
49 .It Fl a
50 Example optional
51 .Fl a
52 option.
53 .It Fl b
54 Example optional
55 .Fl b
56 option.
57 .It Fl c
58 Example optional
59 .Fl c
60 option.
61 .It Fl d Ar argument
62 Example optional
63 .Fl d
64 option with required argument
65 .Ar argument .
66 .It Ar file
67 Required argument
68 .Ar file .
69 .El
70 .Sh ENVIRONMENT
71 The
72 .Nm
73 command ignores the
74 .Ev EXAMPLE
75 environment variable.
76 .Sh FILES
77 .Bl -tag -width ".Pa /dev/null" -compact
78 .It Pa /dev/null
79 Example of a file in the
80 .Sx FILES
81 section.
82 .El
83 .Sh EXIT STATUS
84 .Ex -std
85 .Sh EXAMPLES
86 The following is an example of a typical usage
87 of the
88 .Nm
89 command:
90 .Pp
91 .Dl "example -abc -d xyzzy /dev/null"
92 .Sh DIAGNOSTICS
93 The command may fail for one of the following reasons:
94 .Bl -diag
95 .It "example error message"
96 An example of an error message.
97 .It "another example error message."
98 Self explanatory.
99 .El
100 .Sh COMPATIBILITY
101 The
102 .Nm
103 command has no known compatibility issues.
104 .Sh SEE ALSO
105 .Xr example 3 ,
106 .Xr example 4 ,
107 .Xr mdoc 7
108 .Rs
109 .%A "A. B. Author"
110 .%T "Example RFC Title"
111 .%O RFC0000
112 .Re
113 .Rs
114 .%A "A. B. Author"
115 .%B "Example Book Title"
116 .%O ISBN-0-000-00000-0
117 .Re
118 .Rs
119 .%A "A. B. Author"
120 .%D "January 1997"
121 .%J "Example Journal Name"
122 .%T "Example Article Title"
123 .Re
124 .Sh STANDARDS
125 If the command conforms to some standard, such as
126 .St -p1003.2
127 or
128 .St -isoC ,
129 it should be noted here.
130 .Sh HISTORY
131 The
132 .Nm
133 manual page example first appeared in
134 .Fx 2.2 .
135 .Pp
136 Some other common
137 .Sx HISTORY
138 section examples are:
139 .Pp
140 The
141 .Nm
142 manual page example first appeared in
143 .Bx 4.4 .
144 .Pp
145 The
146 .Nm
147 manual page example first appeared in
148 .At v6 .
149 .Sh AUTHORS
150 This
151 manual page was written by
152 .An Mike Pritchard Aq Mt mpp@FreeBSD.org .
153 .Sh BUGS
154 The actual code for this command is vaporware.