Print this page
13507 some man pages need update following 13405
6308 some man pages are obsolete after moving to ksh builtins
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/prototypes/prototype.man1
+++ new/usr/src/prototypes/prototype.man1
1 1 .\"
2 2 .\" This file and its contents are supplied under the terms of the
3 3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
4 4 .\" You may only use this file in accordance with the terms of version
5 5 .\" 1.0 of the CDDL.
6 6 .\"
7 7 .\" A full copy of the text of the CDDL should have accompanied this
8 8 .\" source. A copy of the CDDL is also available via the Internet at
9 9 .\" http://www.illumos.org/license/CDDL.
10 10 .\"
11 11 .\"
12 12 .\" Copyright 2021 <contributor>
13 13 .\"
14 14 .Dd Month Day, Year
15 15 .Dt COMMAND 1
16 16 .\" Here and in other places "COMMAND" and "command" are place holders
17 17 .\" that should be replaced with the name of the actual command that
18 18 .\" this is documenting.
19 19 .Os
20 20 .Sh NAME
21 21 .Nm command
22 22 .Nd short description
23 23 .Sh SYNOPSIS
24 24 .Nm
25 25 .\" Each of the following lines should use the Fl and Ar options to
26 26 .\" indicate the set of supported options and flags. There should be one
27 27 .\" option and argument per line. If there are independent ways of
28 28 .\" invoking the command or independent sub-commands ala zfs(1M) or
29 29 .\" dladm(1M), there should be a fresh '.Nm' to indicate that and the
30 30 .\" sub-command should use .Cm.
31 31 .Sh DESCRIPTION
32 32 .\" Describe the purpose of the utility, what it does and how it
33 33 .\" operates. If there are certain privileges or other considerations
34 34 .\" for using this, indicate that here.
35 35 .Sh OPTIONS
36 36 The following options are supported:
37 37 .Bl -tag -width Ar
38 38 .It Fl flag1
39 39 Description of the above flag1
40 40 .It Fl flag2
41 41 Description of the above flag2
42 42 .El
43 43 .Sh OPERANDS
44 44 .\" This should be a list of non-flag arguments that are supported
45 45 .\" and what they do in the following form.
46 46 The following operands are supported:
47 47 .Bl -tag -width Ar
↓ open down ↓ |
47 lines elided |
↑ open up ↑ |
48 48 .It Ar oper1
49 49 Description of what oper1 is.
50 50 .It Ar oper2
51 51 Description of what oper2 is.
52 52 .El
53 53 .Sh EXIT STATUS
54 54 .\" This section should indicate the set of exit codes one can expect.
55 55 .\" In general, do not use the '.Ex' macro and instead call out the
56 56 .\" different error values. One would expect at least a difference
57 57 .\" between an error during execution and an error in the usage.
58 +.\" The following exit values are returned:
59 +.\" .Bl -tag -width Ds
60 +.\" .It Sy 0
61 +.\" All input files were successfully processed.
62 +.\" .It Sy >0
63 +.\" An error occurred.
64 +.\" .El
58 65 .Sh EXAMPLES
59 66 .\" There should be multiple examples present that describe how to use
60 67 .\" different parts of the command. This section should not be skipped
61 68 .\" and it's good to have a number of them.
62 -.\" .Sh ENVIRONMENT
69 +.\" .Bl -tag -width 6
70 +.\" .It Sy Example 1 No description of example
71 +.\" .Pp
72 +.\" Introduction
73 +.\" .Bd -literal
74 +.\" $ command
75 +.\" .Ed
76 +.\" .El
77 +.\" .Sh ENVIRONMENT VARIABLES
63 78 .\" If the program reacts to environment variables, most often locale
64 79 .\" related ones, document those here. If they are just the standard
65 80 .\" locale ones, use the following text, adjusting it for the exact set
66 81 .\" of locale specific values that impact it:
67 82 .\" See
68 83 .\" .Xr environ 5
69 84 .\" for descriptions of the following environment variables
70 85 .\" that affect the execution of
71 86 .\" .Nm :
72 87 .\" .Ev LANG ,
73 88 .\" .Ev LC_ALL ,
74 89 .\" .Ev LC_MESSAGES ,
75 90 .\" .Ev LC_NUMERIC ,
76 91 .\" and
77 92 .\" .Ev NLSPATH .
78 93 .\" .Sh CODE SET INDEPENDENCE
79 94 .\" If there are issues around the code set, indicate so here. See
80 95 .\" attributes(5).
81 96 .Sh INTERFACE STABILITY
82 97 .\" When documenting the stability of commands it's useful to
83 98 .\" distinguish between the stability of the options and the command's
84 99 .\" actual output. For most commands, output stability should only be
85 100 .\" guaranteed if there's an explicit parseable option that controls the
86 101 .\" type of data. You can use the following template:
87 102 .\" The command line interface of
88 103 .\" .Nm
89 104 .\" is
90 105 .\" .Sy Committed .
91 106 .\" .Sy Evolving .
92 107 .\" .Sy Volatile .
93 108 .\" .Sy Private .
94 109 .\" The output of
95 110 .\" .Nm
96 111 .\" is
97 112 .\" .Sy Not-An-Interface
98 113 .\" and may change at any time.
99 114 .Sh SEE ALSO
100 115 .\" List other commands that are related to this. For programs that are
101 116 .\" are primarily wrappers around libc functionality or a particular
102 117 .\" library, it's helpful to mention those here so the reader has an
103 118 .\" idea of what is used to implement this. For example, the sleep
104 119 .\" command would mention nanosleep(3C).
↓ open down ↓ |
32 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX