share/misc/mdoc.template

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