xref: /openbsd/share/misc/mdoc.template (revision 76d0caae)
1.\"	$OpenBSD: mdoc.template,v 1.15 2014/03/31 00:09:54 dlg Exp $
2.\"
3.\" Copyright (c) YYYY YOUR NAME HERE <user@your.dom.ain>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.\" The following requests are required for all man pages.
18.\"
19.\" Remove `\&' from the line below.
20.Dd $\&Mdocdate$
21.Dt NAME SECTION#
22.Os
23.Sh NAME
24.Nm program
25.Nd one line about what it does
26.Sh SYNOPSIS
27.\" For a program:  program [-abc] file ...
28.Nm program
29.Op Fl abc
30.Ar
31.Sh DESCRIPTION
32The
33.Nm
34utility processes files ...
35.\" The following requests should be uncommented and used where appropriate.
36.\" .Sh CONTEXT
37.\" For section 9 functions only.
38.\" .Sh RETURN VALUES
39.\" For sections 2, 3, and 9 function return values only.
40.\" .Sh ENVIRONMENT
41.\" For sections 1, 6, 7, and 8 only.
42.\" .Sh FILES
43.\" .Sh EXIT STATUS
44.\" For sections 1, 6, and 8 only.
45.\" .Sh EXAMPLES
46.\" .Sh DIAGNOSTICS
47.\" For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.
48.\" .Sh ERRORS
49.\" For sections 2, 3, 4, and 9 errno settings only.
50.\" .Sh SEE ALSO
51.\" .Xr foobar 1
52.\" .Sh STANDARDS
53.\" .Sh HISTORY
54.\" .Sh AUTHORS
55.\" .Sh CAVEATS
56.\" .Sh BUGS
57