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