Print this page
12305 typos in dhcp man pages
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man1/dhcpinfo.1
+++ new/usr/src/man/man1/dhcpinfo.1
1 1 '\" te
2 2 .\" Copyright (c) 1992-1996 Competitive Automation, Inc.
3 3 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
4 +.\" Copyright (c) 2020 Peter Tribble
4 5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
5 6 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the
6 7 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
7 -.TH DHCPINFO 1 "May 15, 2009"
8 +.TH DHCPINFO 1 "Feb 13, 2020"
8 9 .SH NAME
9 10 dhcpinfo \- display values of parameters received through DHCP
10 11 .SH SYNOPSIS
11 -.LP
12 12 .nf
13 13 \fBdhcpinfo\fR [\fB-c\fR] [\fB-i\fR \fIinterface\fR] [\fB-n\fR \fIlimit\fR] [\fB-v 4|6\fR] \fIcode\fR
14 14 .fi
15 15
16 16 .LP
17 17 .nf
18 18 \fBdhcpinfo\fR [\fB-c\fR] [\fB-i\fR \fIinterface\fR] [\fB-n\fR \fIlimit\fR] [\fB-v 4|6\fR] \fIidentifier\fR
19 19 .fi
20 20
21 21 .SH DESCRIPTION
22 -.sp
23 -.LP
24 22 The \fBdhcpinfo\fR utility prints the \fBDHCP\fR-supplied value(s) of the
25 23 parameter requested on the command line. The parameter can be identified either
26 24 by its numeric code in the \fBDHCP\fR specification, or by its mnemonic
27 25 identifier, as listed in \fBdhcp_inittab\fR(4). This command is intended to be
28 -used in command substitutions in the shell scripts invoked by \fBinit\fR(1M) at
29 -system boot. It first contacts the \fBDHCP\fR client daemon at system boot or
26 +used in command substitutions in the shell scripts invoked at system boot or
30 27 in event scripts as described in \fBdhcpagent\fR(1M). It first contacts the
31 28 DHCP client daemon \fBdhcpagent\fR(1M) to verify that \fBDHCP\fR has
32 29 successfully completed on the requested interface. If \fBDHCP\fR has
33 30 successfully completed on the requested interface, \fBdhcpinfo\fR retrieves the
34 31 values for the requested parameter. Parameter values echoed by \fBdhcpinfo\fR
35 32 should not be used without checking its exit status. See \fBexit\fR(1).
36 33 .sp
37 34 .LP
38 35 See \fBdhcp_inittab\fR(4) for the list of mnemonic identifier codes for all
39 36 \fBDHCP\fR parameters. See \fIRFC 2132, DHCP Options and BOOTP Vendor
40 37 Extensions\fR for more details on DHCPv4 parameters, and RFC 3315, Dynamic Host
41 38 Configuration Protocol for IPv6 (DHCPv6), for more details on DHCPv6
42 39 parameters.
43 40 .SS "Output Format"
44 -.sp
45 -.LP
46 41 The output from \fBdhcpinfo\fR consists of one or more lines of \fBASCII\fR
47 42 text; the format of the output depends upon the requested parameter. The number
48 43 of values returned per line and the total number of lines output for a given
49 44 parameter are determined by the parameter's \fBgranularity\fR and \fBmaximum\fR
50 45 values, respectively, as defined by \fBdhcp_inittab\fR(4).
51 46 .sp
52 47 .LP
53 48 The format of each individual value is determined by the data type of the
54 49 option, as determined by \fBdhcp_inittab\fR(4). The possible data types and
55 50 their formats are listed below:
56 51 .sp
57 52
58 53 .sp
59 54 .TS
60 55 c c c
61 56 l l l .
62 57 Data Type Format \fBdhcp_inittab\fR(4) type
63 58 Unsigned Number One or more decimal digits T{
64 59 \fBUNUMBER8\fR, \fBUNUMBER16\fR, \fBUNUMBER32\fR, \fBUNUMBER64\fR
65 60 T}
66 61 Signed Number T{
67 62 One or more decimal digits, optionally preceded by a minus sign
68 63 T} T{
69 64 \fBSNUMBER8\fR, \fBSNUMBER16\fR, \fBSNUMBER32\fR, \fBSNUMBER64\fR
70 65 T}
71 66 \fBIP\fR Address Dotted-decimal notation \fBIP\fR
72 67 IPv6 Address Colon-separated notation \fBIPv6\fR
73 68 Octet T{
|
↓ open down ↓ |
18 lines elided |
↑ open up ↑ |
74 69 The string \fB0x\fR followed by a two-digit hexadecimal value
75 70 T} \fBOCTET\fR
76 71 String Zero or more \fBASCII\fR characters \fBASCII\fR
77 72 DUID DHCP Unique Identifier text \fBDUID\fR
78 73 Domain Name T{
79 74 Standard dot-separated domain name, RFC 1035 format
80 75 T} \fBDOMAIN\fR
81 76 .TE
82 77
83 78 .SH OPTIONS
84 -.sp
85 -.LP
86 79 The following options are supported:
87 80 .sp
88 81 .ne 2
89 82 .na
90 83 \fB\fB-c\fR\fR
91 84 .ad
92 85 .RS 16n
93 86 Displays the output in a canonical format. This format is identical to the
94 87 \fBOCTET\fR format with a granularity of \fB1\fR.
95 88 .RE
96 89
97 90 .sp
98 91 .ne 2
99 92 .na
100 93 \fB\fB-i\fR \fIinterface\fR\fR
101 94 .ad
102 95 .RS 16n
103 96 Specifies the interface to retrieve values for \fBDHCP\fR parameters from. If
104 97 this option is not specified, the primary interface is used.
105 98 .sp
106 99 If a primary interface has not been selected for the system by
107 100 \fBifconfig\fR(1M) or for this command by \fB-i\fR, the system automatically
108 101 selects an interface to consider as primary for the current command invocation.
109 102 The selection chooses the interface whose name sorts lexically first, and that
110 103 has DHCP parameters attached. This selection does not affect system state. Use
111 104 \fBifconfig\fR(1M) to set a primary interface.
112 105 .sp
113 106 The recommended practice in the \fBdhcpagent\fR(1M) \fBeventhook\fR scripts is
114 107 to specify the desired interface with \fB-i\fR, rather than relying on primary
115 108 selection.
116 109 .sp
117 110 For DHCPv6, the interface name used should be the name of the physical
118 111 interface, not one of the logical interfaces created by \fBdhcpagent\fR.
119 112 .RE
120 113
121 114 .sp
122 115 .ne 2
|
↓ open down ↓ |
27 lines elided |
↑ open up ↑ |
123 116 .na
124 117 \fB\fB-n\fR \fIlimit\fR\fR
125 118 .ad
126 119 .RS 16n
127 120 Limits the list of values displayed to \fIlimit\fR lines.
128 121 .RE
129 122
130 123 .sp
131 124 .ne 2
132 125 .na
133 -\fB\fB-v\fR\fB4 | 6\fR\fR
126 +\fB\fB-v 4|6\fR\fR
134 127 .ad
135 128 .RS 16n
136 -Specifies the DHCP version to query. Use \fB-v4\fRfor DHCPv4 and \fB-v6\fR for
137 -DHCPv6.
129 +Specifies the DHCP version to query. Use \fB-v 4\fR for DHCPv4 and \fB-v 6\fR
130 +for DHCPv6.
138 131 .RE
139 132
140 133 .SH OPERANDS
141 -.sp
142 -.LP
143 134 The following operands are supported:
144 135 .sp
145 136 .ne 2
146 137 .na
147 138 \fB\fIcode\fR\fR
148 139 .ad
149 140 .RS 14n
150 141 Numeric code for the requested \fBDHCP\fR parameter, as defined by the
151 142 \fBDHCP\fR specification. Vendor options are specified by adding \fB256\fR to
152 143 the actual vendor code for DHCPv4, and \fB65536\fR for DHCPv6.
153 144 .RE
154 145
155 146 .sp
|
↓ open down ↓ |
3 lines elided |
↑ open up ↑ |
156 147 .ne 2
157 148 .na
158 149 \fB\fIidentifier\fR\fR
159 150 .ad
160 151 .RS 14n
161 152 Mnemonic symbol for the requested \fBDHCP\fR parameter, as listed in
162 153 \fBdhcp_inittab\fR(4).
163 154 .RE
164 155
165 156 .SH EXIT STATUS
166 -.sp
167 -.LP
168 157 The following exit values are returned:
169 158 .sp
170 159 .ne 2
171 160 .na
172 161 \fB\fB0\fR\fR
173 162 .ad
174 163 .RS 5n
175 164 Successful operation.
176 165 .RE
177 166
178 167 .sp
179 168 .ne 2
180 169 .na
181 170 \fB\fB2\fR\fR
182 171 .ad
183 172 .RS 5n
184 173 The operation was not successful. The \fBDHCP\fR client daemon might not be
185 174 running, the interface might have failed to configure, or no satisfactory
186 175 \fBDHCP\fR responses were received.
187 176 .RE
188 177
189 178 .sp
190 179 .ne 2
191 180 .na
192 181 \fB\fB3\fR\fR
193 182 .ad
194 183 .RS 5n
195 184 Bad arguments.
196 185 .RE
197 186
198 187 .sp
199 188 .ne 2
200 189 .na
201 190 \fB\fB4\fR\fR
202 191 .ad
203 192 .RS 5n
204 193 The operation timed out.
205 194 .RE
206 195
|
↓ open down ↓ |
29 lines elided |
↑ open up ↑ |
207 196 .sp
208 197 .ne 2
209 198 .na
210 199 \fB\fB6\fR\fR
211 200 .ad
212 201 .RS 5n
213 202 System error (should never occur).
214 203 .RE
215 204
216 205 .SH ATTRIBUTES
217 -.sp
218 -.LP
219 206 See \fBattributes\fR(5) for descriptions of the following attributes:
220 207 .sp
221 208
222 209 .sp
223 210 .TS
224 211 box;
225 212 c | c
226 213 l | l .
227 214 ATTRIBUTE TYPE ATTRIBUTE VALUE
228 215 _
229 216 Interface Stability Committed
230 217 .TE
231 218
232 219 .SH SEE ALSO
233 -.sp
234 -.LP
235 -\fBdhcpagent\fR(1M), \fBifconfig\fR(1M), \fBinit\fR(1M), \fBdhcp_inittab\fR(4),
220 +\fBdhcpagent\fR(1M), \fBifconfig\fR(1M), \fBdhcp_inittab\fR(4),
236 221 \fBattributes\fR(5)
237 222 .sp
238 223 .LP
239 224 Alexander, S., and R. Droms, \fIRFC 2132, DHCP Options and BOOTP Vendor
240 225 Extensions\fR, Silicon Graphics, Inc., Bucknell University, March 1997.
241 226 .sp
242 227 .LP
243 228 Droms, R. , \fIRFC 3315, Dynamic Host Configuration Protocol for IPv6
244 229 (DHCPv6)\fR, Cisco Systems, July 2003.
245 230 .sp
246 231 .LP
247 232 Mockapetris, P.V. , \fIRFC 1035, Domain names - implementation and
248 233 specification\fR, ISI, November 1987.
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX