xref: /freebsd/share/misc/mdoc.template (revision 0df291ee25a63dd7ded271dc5e6c9232a1d644ea)
1.\" The following requests are required for all man pages.
2.Dd DATE
3.Os
4.Dt DOCUMENT_TITLE MANUAL_SECTION#
5.Sh NAME
6.Nm name
7.Nd one line description of name
8.Sh SYNOPSIS
9.Sh DESCRIPTION
10.\" The following requests should be uncommented and used where appropriate.
11.\" This next request is for sections 2 and 3 function return values only.
12.\" .Sh RETURN VALUES
13.\" This next request is for sections 1, 6, 7 & 8 only
14.\" .Sh ENVIRONMENT
15.\" .Sh FILES
16.\" .Sh EXAMPLES
17.\" This next request is for sections 1, 6, 7 & 8 only
18.\"     (command return values (to shell) and fprintf/stderr type diagnostics)
19.\" .Sh DIAGNOSTICS
20.\" The next request is for sections 2 and 3 error and signal handling only.
21.\" .Sh ERRORS
22.\" .Sh SEE ALSO
23.\" .Sh STANDARDS
24.\" .Sh HISTORY
25.\" .Sh AUTHORS
26.\" .Sh BUGS
27