example.1 (03e563d7dc415d00b5511a44bdaf7bfeabe2e376) example.1 (d72ca9ddd13a8e6359af1ff0f3c017e7a34a7878)
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 unchanged lines hidden (view full) ---

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$
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 unchanged lines hidden (view full) ---

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$
26.\" Note: All FreeBSD man pages should have a FreeBSD revision
27.\" control id to make it easier for translation teams to track
28.\" changes.
29.\"
30.\" Note: The date here should be updated whenever a non-trivial
31.\" change is made to the manual page.
32.Dd December 8, 1999
33.Dt EXAMPLE 1
34.Os
35.Sh NAME
36.Nm example
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
37.Nd example command manual page
34.Nd "example command manual page"
38.Sh SYNOPSIS
39.Nm
40.Op Fl abc
41.Op Fl d Ar argument
42.Ar file
43.Sh DESCRIPTION
44This is an example manual page for the
45.Nm
46command.
47It is intended that this example can be used as a template
48when writing a new manual page.
49.Pp
50The options are as follows:
35.Sh SYNOPSIS
36.Nm
37.Op Fl abc
38.Op Fl d Ar argument
39.Ar file
40.Sh DESCRIPTION
41This is an example manual page for the
42.Nm
43command.
44It is intended that this example can be used as a template
45when writing a new manual page.
46.Pp
47The options are as follows:
51.Bl -tag -width Fl
48.Bl -tag -width ".Fl d Ar argument"
52.It Fl a
53Example optional
54.Fl a
55option.
56.It Fl b
57Example optional
58.Fl b
59option.

--- 12 unchanged lines hidden (view full) ---

72.El
73.Sh ENVIRONMENT
74The
75.Nm
76command ignores the
77.Ev EXAMPLE
78environment variable.
79.Sh FILES
49.It Fl a
50Example optional
51.Fl a
52option.
53.It Fl b
54Example optional
55.Fl b
56option.

--- 12 unchanged lines hidden (view full) ---

69.El
70.Sh ENVIRONMENT
71The
72.Nm
73command ignores the
74.Ev EXAMPLE
75environment variable.
76.Sh FILES
80.Bl -tag -width /dev/null -compact
77.Bl -tag -width ".Pa /dev/null" -compact
81.It Pa /dev/null
82Example of a file in the
83.Sx FILES
84section.
85.El
86.Sh EXAMPLES
87The following is an example of a typical usage
88of the
89.Nm
90command:
91.Pp
78.It Pa /dev/null
79Example of a file in the
80.Sx FILES
81section.
82.El
83.Sh EXAMPLES
84The following is an example of a typical usage
85of the
86.Nm
87command:
88.Pp
92.Dl % example -abc -d xyzzy /dev/null
89.Dl "% example -abc -d xyzzy /dev/null"
93.Sh DIAGNOSTICS
94Exit status is 0 on success, and 1 if the command
90.Sh DIAGNOSTICS
91Exit status is 0 on success, and 1 if the command
95fails for one of the following reasons
92fails for one of the following reasons:
96.Bl -diag
93.Bl -diag
97.It example error message
94.It "example error message"
98An example of an error message.
95An example of an error message.
99.It another example error message.
96.It "another example error message."
100Self explanatory.
101.El
102.Sh COMPATIBILITY
103The
104.Nm
105command has no known compatibility issues.
106.Sh SEE ALSO
107.Xr example 3 ,
108.Xr example 4 ,
109.Xr mdoc 7
110.Rs
97Self explanatory.
98.El
99.Sh COMPATIBILITY
100The
101.Nm
102command has no known compatibility issues.
103.Sh SEE ALSO
104.Xr example 3 ,
105.Xr example 4 ,
106.Xr mdoc 7
107.Rs
111.%A A. B. Author
112.%T Example RFC Title
108.%A "A. B. Author"
109.%T "Example RFC Title"
113.%O RFC0000
114.Re
115.Rs
110.%O RFC0000
111.Re
112.Rs
116.%A A. B. Author
117.%B Example Book Title
113.%A "A. B. Author"
114.%B "Example Book Title"
118.%O ISBN-0-000-00000-0
119.Re
120.Rs
115.%O ISBN-0-000-00000-0
116.Re
117.Rs
121.%A A. B. Author
122.%D January 1997
123.%J Example Journal Name
124.%T Example Article Title
118.%A "A. B. Author"
119.%D "January 1997"
120.%J "Example Journal Name"
121.%T "Example Article Title"
125.Re
126.Sh STANDARDS
127If the command conforms to some standard, such as
128.St -p1003.2
129or
130.St -isoC ,
131it should be noted here.
132.Sh HISTORY

--- 24 unchanged lines hidden ---
122.Re
123.Sh STANDARDS
124If the command conforms to some standard, such as
125.St -p1003.2
126or
127.St -isoC ,
128it should be noted here.
129.Sh HISTORY

--- 24 unchanged lines hidden ---