xref: /freebsd/share/misc/mdoc.template (revision 8af774179d38c56f223b4a95b2c3d271a4ab796c)
1ed0bfbe5SMike Pritchard.\" $FreeBSD$
2ed0bfbe5SMike Pritchard.\"
3afe61c15SRodney W. Grimes.\" The following requests are required for all man pages.
48af77417SRuslan Ermilov.Dd Month day, year
58af77417SRuslan Ermilov.Os [OPERATING_SYSTEM] [version/release]
68af77417SRuslan Ermilov.Dt DOCUMENT_TITLE [section number] [architecture/volume]
7afe61c15SRodney W. Grimes.Sh NAME
80df291eeSMike Pritchard.Nm name
90df291eeSMike Pritchard.Nd one line description of name
108af77417SRuslan Ermilov.\" This next request is for sections 2 and 3 only.
118af77417SRuslan Ermilov.\" .Sh LIBRARY
12afe61c15SRodney W. Grimes.Sh SYNOPSIS
13afe61c15SRodney W. Grimes.Sh DESCRIPTION
14afe61c15SRodney W. Grimes.\" The following requests should be uncommented and used where appropriate.
15ed0bfbe5SMike Pritchard.\" .Sh IMPLEMENTATION NOTES
168af77417SRuslan Ermilov.\" This next request is for sections 2, 3 and 9 function return values only.
17afe61c15SRodney W. Grimes.\" .Sh RETURN VALUES
188af77417SRuslan Ermilov.\" This next request is for sections 1, 6, 7 and 8 only.
19afe61c15SRodney W. Grimes.\" .Sh ENVIRONMENT
20afe61c15SRodney W. Grimes.\" .Sh FILES
21afe61c15SRodney W. Grimes.\" .Sh EXAMPLES
228af77417SRuslan Ermilov.\" This next request is for sections 1, 6, 7, 8 and 9 only
238af77417SRuslan Ermilov.\"     (command return values (to shell) and fprintf/stderr type diagnostics).
24afe61c15SRodney W. Grimes.\" .Sh DIAGNOSTICS
25ed0bfbe5SMike Pritchard.\" .Sh COMPATIBILITY
268af77417SRuslan Ermilov.\" This next request is for sections 2, 3 and 9 error and signal handling only.
27afe61c15SRodney W. Grimes.\" .Sh ERRORS
28afe61c15SRodney W. Grimes.\" .Sh SEE ALSO
29afe61c15SRodney W. Grimes.\" .Sh STANDARDS
30afe61c15SRodney W. Grimes.\" .Sh HISTORY
31afe61c15SRodney W. Grimes.\" .Sh AUTHORS
32afe61c15SRodney W. Grimes.\" .Sh BUGS
33