freebsd-dev/share/misc/mdoc.template
Mike Pritchard 0df291ee25 Add .Nm and .Nd lines to the template so that anyone starting
a man page from this file will not forget to include them,
since they are not optional..
1996-12-15 23:33:19 +00:00

27 lines
793 B
Plaintext

.\" The following requests are required for all man pages.
.Dd DATE
.Os
.Dt DOCUMENT_TITLE MANUAL_SECTION#
.Sh NAME
.Nm name
.Nd one line description of name
.Sh SYNOPSIS
.Sh DESCRIPTION
.\" The following requests should be uncommented and used where appropriate.
.\" This next request is for sections 2 and 3 function return values only.
.\" .Sh RETURN VALUES
.\" This next request is for sections 1, 6, 7 & 8 only
.\" .Sh ENVIRONMENT
.\" .Sh FILES
.\" .Sh EXAMPLES
.\" This next request is for sections 1, 6, 7 & 8 only
.\" (command return values (to shell) and fprintf/stderr type diagnostics)
.\" .Sh DIAGNOSTICS
.\" The next request is for sections 2 and 3 error and signal handling only.
.\" .Sh ERRORS
.\" .Sh SEE ALSO
.\" .Sh STANDARDS
.\" .Sh HISTORY
.\" .Sh AUTHORS
.\" .Sh BUGS