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