share/misc/mdoc.template

   1 .\" $FreeBSD: src/share/misc/mdoc.template,v 1.5 2005/01/16 22:26:05 ru Exp $
   2 .\"
   3 .\" The following requests are required for all man pages.
   4 .Dd Month day, year
   5 .Dt DOCUMENT_TITLE [section number] [architecture/volume]
   6 .Os [OPERATING_SYSTEM] [version/release]
   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 .\" This next request is for sections 1, 6, 7 and 8 only
  22 .\"     (command return values (to shell)).
  23 .\" .Sh EXIT STATUS
  24 .\" .Sh EXAMPLES
  25 .\" This next request is for sections 1, 6, 7, 8 and 9 only
  26 .\"     (fprintf/stderr type diagnostics).
  27 .\" .Sh DIAGNOSTICS
  28 .\" .Sh COMPATIBILITY
  29 .\" This next request is for sections 2, 3 and 9 error and signal handling only.
  30 .\" .Sh ERRORS
  31 .\" .Sh SEE ALSO
  32 .\" .Sh STANDARDS
  33 .\" .Sh HISTORY
  34 .\" .Sh AUTHORS
  35 .\" .Sh BUGS
  36 .\" .Sh SECURITY CONSIDERATIONS