42 .\" Describe how the functions operate and what they do. Provide
  43 .\" background for the reader. Don't assume that they know how
  44 .\" everything works. Be clear about the semantics and the why.
  45 .Sh RETURN VALUES
  46 Upon successful completion, the
  47 .Fn funcname
  48 function returns XXX and <state side effects>. Otherwise XXX is returned
  49 and <if errno is set describe it below>.
  50 .Sh EXAMPLES
  51 .Sh ERRORS
  52 The
  53 .fn funcname
  54 functions will fail if:
  55 .Bl  -tag -width Er
  56 .It Er ERRNO1
  57 A Reason why ERRNO1 could occur.
  58 .It Er ERRNO2
  59 A Reason why ERRNO2 could occur.
  60 .El
  61 .Sh INTERFACE STABILITY
  62 .\" Indicate the stability per attribute(5). One of:
  63 .\" .Sy Committed
  64 .\" .Sy Uncommitted
  65 .\" .Sy Volatile
  66 .\" .Sy Private
  67 .Sh MT-LEVEL
  68 .\" Indicate the MT-Level per attributes(5). If there are exceptions,
  69 .\" start with the level and go from there.
  70 .\" .Sy Safe
  71 .\" .Sy Unsafe
  72 .\" .Sy MT-Safe
  73 .\" .Sy Aysnc-Signal-Safe
  74 .Sh SEE ALSO
  75 .\" A list of mentioned manuals or others that are relevant to this
  76 .\" function. If there is a user command that exercises this, for
  77 .\" example, sleep(1) if documenting sleep(3C), list this here.
  78 .\" Generally an overview page for a library in 3LIB should also be
  79 .\" referenced.

  42 .\" Describe how the functions operate and what they do. Provide
  43 .\" background for the reader. Don't assume that they know how
  44 .\" everything works. Be clear about the semantics and the why.
  45 .Sh RETURN VALUES
  46 Upon successful completion, the
  47 .Fn funcname
  48 function returns XXX and <state side effects>. Otherwise XXX is returned
  49 and <if errno is set describe it below>.
  50 .Sh EXAMPLES
  51 .Sh ERRORS
  52 The
  53 .fn funcname
  54 functions will fail if:
  55 .Bl  -tag -width Er
  56 .It Er ERRNO1
  57 A Reason why ERRNO1 could occur.
  58 .It Er ERRNO2
  59 A Reason why ERRNO2 could occur.
  60 .El
  61 .Sh INTERFACE STABILITY
  62 .\" Indicate the stability per attributes(5). One of:
  63 .\" .Sy Committed
  64 .\" .Sy Uncommitted
  65 .\" .Sy Volatile
  66 .\" .Sy Private
  67 .Sh MT-LEVEL
  68 .\" Indicate the MT-Level per attributes(5). If there are exceptions,
  69 .\" start with the level and go from there.
  70 .\" .Sy Safe
  71 .\" .Sy Unsafe
  72 .\" .Sy MT-Safe
  73 .\" .Sy Aysnc-Signal-Safe
  74 .Sh SEE ALSO
  75 .\" A list of mentioned manuals or others that are relevant to this
  76 .\" function. If there is a user command that exercises this, for
  77 .\" example, sleep(1) if documenting sleep(3C), list this here.
  78 .\" Generally an overview page for a library in 3LIB should also be
  79 .\" referenced.