1 .\"
   2 .\" This file and its contents are supplied under the terms of the
   3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
   4 .\" You may only use this file in accordance with the terms of version
   5 .\" 1.0 of the CDDL.
   6 .\"
   7 .\" A full copy of the text of the CDDL should have accompanied this
   8 .\" source.  A copy of the CDDL is also available via the Internet at
   9 .\" http://www.illumos.org/license/CDDL.
  10 .\"
  11 .\"
  12 .\" Copyright 2020 <contributor>
  13 .\"
  14 .Dd Month Day, Year
  15 .Dt MANUALPAGE 3SECTION
  16 .\" MANUALPAGE should be replaced with the primary function that you are
  17 .\" documenting. If there is more than one function, then you should either
  18 .\" use the primary function of the group or a more general name. Every
  19 .\" documented function will appear in the NAME section below.
  20 .\"
  21 .\" The SECTION generally refers to the name of the library that this
  22 .\" appears in. For example for something in libc this would be 3C. In
  23 .\" general this is the capitalized version of the libraries shared
  24 .\" object name.
  25 .Os
  26 .Sh NAME
  27 .Nm funcname ,
  28 .Nm funcname2
  29 .Nd short description
  30 .Sh LIBRARY
  31 .Lb libname
  32 .Sh SYNOPSIS
  33 .\" Insert any required pre-processor macros with Dv
  34 .\" .In headerfile.h
  35 .\" .Ft return type
  36 .\" .Fo function name
  37 .\" .Fa "func arg 0 type and name"
  38 .\" .Fa "func arg 1 type and name"
  39 .\" .Fc
  40 .\" Repeat above for each function
  41 .Sh DESCRIPTION
  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.