xref: /freebsd/share/misc/mdoc.template (revision 397e83df75e0fcd0d3fcb95ae4d794cb7600fc89)
1.\"
2.\" The following requests are required for all man pages.
3.Dd Month day, year
4.Dt DOCUMENT_TITLE [section number] [architecture/volume]
5.Os [OPERATING_SYSTEM] [version/release]
6.Sh NAME
7.Nm name
8.Nd one line description of name
9.\" This next request is for sections 2 and 3 only.
10.\" .Sh LIBRARY
11.Sh SYNOPSIS
12.Sh DESCRIPTION
13.\" The following requests should be uncommented and used where appropriate.
14.\" .Sh IMPLEMENTATION NOTES
15.\" This next request is for sections 2, 3 and 9 function return values only.
16.\" .Sh RETURN VALUES
17.\" This next request is for sections 1, 6, 7 and 8 only.
18.\" .Sh ENVIRONMENT
19.\" .Sh FILES
20.\" This next request is for sections 1, 6, 7 and 8 only
21.\"     (command return values (to shell)).
22.\" .Sh EXIT STATUS
23.\" .Sh EXAMPLES
24.\" This next request is for sections 1, 6, 7, 8 and 9 only
25.\"     (fprintf/stderr type diagnostics).
26.\" .Sh DIAGNOSTICS
27.\" .Sh COMPATIBILITY
28.\" This next request is for sections 2, 3 and 9 error and signal handling only.
29.\" .Sh ERRORS
30.\" .Sh SEE ALSO
31.\" .Sh STANDARDS
32.\" .Sh HISTORY
33.\" .Sh AUTHORS
34.\" .Sh BUGS
35.\" .Sh SECURITY CONSIDERATIONS
36