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 COMMAND 1
16.\" Here and in other places "COMMAND" and "command" are place holders
17.\" that should be replaced with the name of the actual command that
18.\" this is documenting.
19.Os
20.Sh NAME
21.Nm command
22.Nd short description
23.Sh SYNOPSIS
24.Nm
25.\" Each of the following lines should use the Fl and Ar options to
26.\" indicate the set of supported options and flags. There should be one
27.\" option and argument per line. If there are independent ways of
28.\" invoking the command or independent sub-commands ala zfs(1M) or
29.\" dladm(1M), there should be a fresh '.Nm' to indicate that and the
30.\" sub-command should use .Cm.
31.Sh DESCRIPTION
32.\" Describe the purpose of the utility, what it does and how it
33.\" operates. If there are certain privileges or other considerations
34.\" for using this, indicate that here.
35.Sh OPTIONS
36The following options are supported:
37.Bl -tag -width Ar
38.It Fl flag1
39Description of the above flag1
40.It Fl flag2
41Description of the above flag2
42.El
43.Sh OPERANDS
44.\" This should be a list of non-flag arguments that are supported
45.\" and what they do in the following form.
46The following operands are supported:
47.Bl -tag -width Ar
48.It Ar oper1
49Description of what oper1 is.
50.It Ar oper2
51Description of what oper2 is.
52.El
53.Sh EXIT STATUS
54.\" This section should indicate the set of exit codes one can expect.
55.\" In general, do not use the '.Ex' macro and instead call out the
56.\" different error values. One would expect at least a difference
57.\" between an error during execution and an error in the usage.
58.Sh EXAMPLES
59.\" There should be multiple examples present that describe how to use
60.\" different parts of the command. This section should not be skipped
61.\" and it's good to have a number of them.
62.\" .Sh ENVIRONMENT
63.\" If the program reacts to environment variables, most often locale
64.\" related ones, document those here. If they are just the standard
65.\" locale ones, use the following text, adjusting it for the exact set
66.\" of locale specific values that impact it:
67.\" See
68.\" .Xr environ 5
69.\" for descriptions of the following environment variables
70.\" that affect the execution of
71.\" .Nm :
72.\" .Ev LANG ,
73.\" .Ev LC_ALL ,
74.\" .Ev LC_MESSAGES ,
75.\" .Ev LC_NUMERIC ,
76.\" and
77.\" .Ev NLSPATH .
78.\" .Sh CODE SET INDEPENDENCE
79.\" If there are issues around the code set, indicate so here. See
80.\" attributes(5).
81.Sh INTERFACE STABILITY
82.\" When documenting the stability of commands it's useful to
83.\" distinguish between the stability of the options and the command's
84.\" actual output. For most commands, output stability should only be
85.\" guaranteed if there's an explicit parseable option that controls the
86.\" type of data. You can use the following template:
87.\" The command line interface of
88.\" .Nm
89.\" is
90.\" .Sy Committed .
91.\" .Sy Evolving .
92.\" .Sy Volatile .
93.\" .Sy Private .
94.\" The output of
95.\" .Nm
96.\" is
97.\" .Sy Not-An-Interface
98.\" and may change at any time.
99.Sh SEE ALSO
100.\" List other commands that are related to this. For programs that are
101.\" are primarily wrappers around libc functionality or a particular
102.\" library, it's helpful to mention those here so the reader has an
103.\" idea of what is used to implement this. For example, the sleep
104.\" command would mention nanosleep(3C).
105