xref: /illumos-gate/usr/src/prototypes/prototype.man4d (revision b0bb0d63258be430b0e22afcb1581974bd7b568e)
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 2023 <contributor>
13.\"
14.Dd Month Day, Year
15.Dt DRIVERNAME 4D
16.\" Here and in other places "DRIVERNAME" and "drivername" are place
17.\" holders that should be replaced with the name of the actual driver
18.\" that this is documenting.
19.Os
20.Sh NAME
21.Nm drivername
22.Nd driverdesc
23.Sh SYNOPSIS
24.Pa /dev/node/path
25.Sh DESCRIPTION
26The
27.Nm
28driver <fill out what it does and what devices it supports>. <Describe
29the functionality supported by the driver, e.g. for a NIC TSO, etc.>.
30.\" .Sh APPLICATION PROGRAMMING INTERFACE
31.\" If the user may interact with this driver in a specific way,
32.\" document it. The user may not because this driver is part of a
33.\" broader framework.
34.\" .Sh IOCTLS
35.\" If the driver has a non-standard ioctl interface, document it. If it
36.\" just implements the ones to support a framework, leave this out.
37.\" .Sh CONFIGURATION
38.\" If there is a driver.conf file, please describe the different
39.\" options that can be set and their expected stability.
40.\" .Sh ARCHITECTURE
41.\" If this driver is supported on particular architectures (usually not
42.\" the case for pseudo-devices), then include that.
43.Sh FILES
44.\" List the actual installation path of the driver and a configuration
45.\" file.
46.Sh SEE ALSO
47.\" This list should include user programs or libraries that are relevant to
48.\" the program. A nic might have dladm, a storage device, diskinfo, a
49.\" sensor, fmtopo.
50