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 2022 <contributor> 13.\" 14.Dd Month Day, Year 15.Dt FUNCNAME 9F 16.\" FUNCNAME 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.Os 21.Sh NAME 22.Nm funcname , 23.Nm funcname2 24.Nd short description 25.Sh SYNOPSIS 26.\" .In sys/header.h 27.\" .Ft "return type" 28.\" .Fo funcname 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 function, how to use it, 48.\" and why someone might use it. Any concerns around locking or 49.\" callbacks into the broader frameworks. Whether it can be called in 50.\" parallel by multiple threads, etc. 51.Sh CONTEXT 52.\" Indicates the context in which this framework function is called. 53.\" Generally this is one or more of: 54.\" .Sy user 55.\" .Sy kernel 56.\" .Sy interrupt 57.\" However sometimes there may be something specific. Such as this is 58.\" only called or used during attach or detach. 59.Sh EXAMPLES 60.\" Include examples of how someone might use this kernel function. 61.Sh RETURN VALUES 62.\" This should indicate what the function will 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.\" If the function returns a set of errors, often errnos (not the case 67.\" for just returning DDI_SUCCESS/DDI_FAILURE), or any other 68.\" positive/negative indicator, then one should consider including the 69.\" meaning of the errors. 70.Bl -tag -width Er 71.It Er ERRNO1 72Description of what would cause ERRNO1. 73.It Er ERRNO2 74Description of what would cause ERRNO2. 75.El 76.Sh SEE ALSO 77.\" A list of other manual pages related to the general framework or 78.\" section 9f functions they might call. 79