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 2021 <contributor>
13.\"
14.Dd Month Day, Year
15.Dt ENTRYNAME 9E
16.\" ENTRYNAME should be replaced with the primary entry point 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 entry point will appear in the NAME section below.
20.Os
21.Sh NAME
22.Nm entryname ,
23.Nm entryname2
24.Nd description
25.Sh SYNOPSIS
26.\" .In sys/header.h
27.\" .Ft "return type"
28.\" .Fo entryname
29.\" .Fa "arg 0 type and name"
30.\" .Fa "arg 1 type and name"
31.\" .Fc
32.\" Repeat above for each documented entry
33.Sh INTERFACE LEVEL
34.\" This should be one of the following:
35.\" .Sy Committed
36.\" .Sy Volatile -
37.\" This interface is still evolving in illumos.
38.\" API and ABI stability is not guaranteed.
39.Sh PARAMETERS
40.Bl -tag -width Fa
41.It Fa arg0
42Description of the parameter arg0.
43.It Fa arg1
44Description of the parameter arg1.
45.El
46.Sh DESCRIPTION
47.\" This should include a description of the entry point. This includes
48.\" information such as what framework it is a part of. What it is
49.\" expected to actually do. Any constraints on what it should validate.
50.\" Any concerns around locking or callbacks into the broader
51.\" frameworks. Whether it can be called in parallel by multiple
52.\" threads, etc.
53.Sh CONTEXT
54.\" Indicates the context in which this framework function is called.
55.\" Generally this is one or more of:
56.\" .Sy user
57.\" .Sy kernel
58.\" .Sy interrupt
59.\" However sometimes there may be something specific. Such as this is
60.\" only called or used during attach or detach.
61.Sh RETURN VALUES
62.\" This should indicate what the driver should return on successful
63.\" completion and what it should have done. Otherwise it should
64.\" indicate the class of error returned.
65.Sh ERRORS
66.\" This should be a list of recommended errors and causes. If the
67.\" interface only supports returning DDI_SUCCESS or DDI_FAILURE,
68.\" then this section should not be used. If it should only return these
69.\" specific errors and this section shouldn't be used as a guide,
70.\" indicate that.
71.Bl -tag -width Er
72.It Er ERRNO1
73Description of when to return ERRNO1.
74.It Er ERRNO2
75Description of when to return ERRNO2.
76.El
77.Sh SEE ALSO
78.\" A list of other manual pages related to the general framework or
79.\" section 9f functions they should call.
80