All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
$FreeBSD: stable/10/share/examples/mdoc/example.1 307403 2016-10-16 22:02:50Z sevan $
Note: The date here should be updated whenever a non-trivial
change is made to the manual page.
.Dd December 8, 1999 .Dt EXAMPLE 1 .Os .Sh NAME .Nm example .Nd "example command manual page" .Sh SYNOPSIS .Nm .Op Fl abc .Op Fl d Ar argument .Ar file .Sh DESCRIPTION This is an example manual page for the .Nm command. It is intended that this example can be used as a template when writing a new manual page.
p The options are as follows: l -tag -width ".Fl d Ar argument" t Fl a Example optional .Fl a option. t Fl b Example optional .Fl b option. t Fl c Example optional .Fl c option. t Fl d Ar argument Example optional .Fl d option with required argument .Ar argument . t Ar file Required argument .Ar file . .El .Sh ENVIRONMENT The .Nm command ignores the .Ev EXAMPLE environment variable. .Sh FILES l -tag -width ".Pa /dev/null" -compact t Pa /dev/null Example of a file in the .Sx FILES section. .El .Sh EXIT STATUS .Ex -std .Sh EXAMPLES The following is an example of a typical usage of the .Nm command:
p .Dl "example -abc -d xyzzy /dev/null" .Sh DIAGNOSTICS The command may fail for one of the following reasons: l -diag t "example error message" An example of an error message. t "another example error message." Self explanatory. .El .Sh COMPATIBILITY The .Nm command has no known compatibility issues. .Sh SEE ALSO .Xr example 3 , .Xr example 4 , .Xr mdoc 7 , .Xr example 9 .Rs .%A "A. B. Author" .%T "Example RFC Title" .%O RFC0000 .Re .Rs .%A "A. B. Author" .%B "Example Book Title" .%O ISBN-0-000-00000-0 .Re .Rs .%A "A. B. Author" .%D "January 1997" .%J "Example Journal Name" .%T "Example Article Title" .Re .Sh STANDARDS If the command conforms to some standard, such as .St -p1003.2 or .St -isoC , it should be noted here. .Sh HISTORY The .Nm manual page example first appeared in .Fx 2.2 .
p Some other common .Sx HISTORY section examples are:
p The .Nm manual page example first appeared in x 4.4 .
p The .Nm manual page example first appeared in .At v6 . .Sh AUTHORS This manual page was written by .An Mike Pritchard Aq Mt mpp@FreeBSD.org . .Sh BUGS The actual code for this command is vaporware.