share/misc/mdoc.template

   1 .\" $FreeBSD: src/share/misc/mdoc.template,v 1.5 2005/01/16 22:26:05 ru Exp $
   2 .\" $DragonFly: src/share/misc/mdoc.template,v 1.2 2003/06/17 04: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 .\" This next request is for sections 1, 6, 7 and 8 only
  23 .\"     (command return values (to shell)).
  24 .\" .Sh EXIT STATUS
  25 .\" .Sh EXAMPLES
  26 .\" This next request is for sections 1, 6, 7, 8 and 9 only
  27 .\"     (fprintf/stderr type diagnostics).
  28 .\" .Sh DIAGNOSTICS
  29 .\" .Sh COMPATIBILITY
  30 .\" This next request is for sections 2, 3 and 9 error and signal handling only.
  31 .\" .Sh ERRORS
  32 .\" .Sh SEE ALSO
  33 .\" .Sh STANDARDS
  34 .\" .Sh HISTORY
  35 .\" .Sh AUTHORS
  36 .\" .Sh BUGS