Print this page
12305 typos in dhcp man pages
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man1/dhcpinfo.1.man.txt
+++ new/usr/src/man/man1/dhcpinfo.1.man.txt
1 1 DHCPINFO(1) User Commands DHCPINFO(1)
2 2
3 3
4 4
5 5 NAME
6 6 dhcpinfo - display values of parameters received through DHCP
7 7
8 8 SYNOPSIS
9 9 dhcpinfo [-c] [-i interface] [-n limit] [-v 4|6] code
|
↓ open down ↓ |
9 lines elided |
↑ open up ↑ |
10 10
11 11
12 12 dhcpinfo [-c] [-i interface] [-n limit] [-v 4|6] identifier
13 13
14 14
15 15 DESCRIPTION
16 16 The dhcpinfo utility prints the DHCP-supplied value(s) of the parameter
17 17 requested on the command line. The parameter can be identified either
18 18 by its numeric code in the DHCP specification, or by its mnemonic
19 19 identifier, as listed in dhcp_inittab(4). This command is intended to
20 - be used in command substitutions in the shell scripts invoked by
21 - init(1M) at system boot. It first contacts the DHCP client daemon at
22 - system boot or in event scripts as described in dhcpagent(1M). It first
20 + be used in command substitutions in the shell scripts invoked at system
21 + boot or in event scripts as described in dhcpagent(1M). It first
23 22 contacts the DHCP client daemon dhcpagent(1M) to verify that DHCP has
24 23 successfully completed on the requested interface. If DHCP has
25 24 successfully completed on the requested interface, dhcpinfo retrieves
26 25 the values for the requested parameter. Parameter values echoed by
27 26 dhcpinfo should not be used without checking its exit status. See
28 27 exit(1).
29 28
30 29
31 30 See dhcp_inittab(4) for the list of mnemonic identifier codes for all
32 31 DHCP parameters. See RFC 2132, DHCP Options and BOOTP Vendor Extensions
33 32 for more details on DHCPv4 parameters, and RFC 3315, Dynamic Host
34 33 Configuration Protocol for IPv6 (DHCPv6), for more details on DHCPv6
35 34 parameters.
36 35
37 36 Output Format
38 37 The output from dhcpinfo consists of one or more lines of ASCII text;
39 38 the format of the output depends upon the requested parameter. The
40 39 number of values returned per line and the total number of lines output
41 40 for a given parameter are determined by the parameter's granularity and
42 41 maximum values, respectively, as defined by dhcp_inittab(4).
43 42
44 43
45 44 The format of each individual value is determined by the data type of
46 45 the option, as determined by dhcp_inittab(4). The possible data types
47 46 and their formats are listed below:
48 47
49 48
50 49
51 50
52 51 Data Type Format dhcp_inittab(4) type
53 52 Unsigned Number One or more decimal digits UNUMBER8, UNUMBER16,
54 53 UNUMBER32, UNUMBER64
55 54 Signed Number One or more decimal digits, SNUMBER8, SNUMBER16,
56 55 optionally preceded by a SNUMBER32, SNUMBER64
57 56 minus sign
58 57 IP Address Dotted-decimal notation IP
59 58 IPv6 Address Colon-separated notation IPv6
60 59 Octet The string 0x followed by a OCTET
61 60 two-digit hexadecimal value
62 61 String Zero or more ASCII characters ASCII
63 62 DUID DHCP Unique Identifier text DUID
64 63 Domain Name Standard dot-separated domain DOMAIN
65 64 name, RFC 1035 format
66 65
67 66
68 67 OPTIONS
69 68 The following options are supported:
70 69
71 70 -c
72 71 Displays the output in a canonical format. This format
73 72 is identical to the OCTET format with a granularity of
74 73 1.
75 74
76 75
77 76 -i interface
78 77 Specifies the interface to retrieve values for DHCP
79 78 parameters from. If this option is not specified, the
80 79 primary interface is used.
81 80
82 81 If a primary interface has not been selected for the
83 82 system by ifconfig(1M) or for this command by -i, the
84 83 system automatically selects an interface to consider
85 84 as primary for the current command invocation. The
86 85 selection chooses the interface whose name sorts
87 86 lexically first, and that has DHCP parameters attached.
88 87 This selection does not affect system state. Use
89 88 ifconfig(1M) to set a primary interface.
90 89
91 90 The recommended practice in the dhcpagent(1M) eventhook
92 91 scripts is to specify the desired interface with -i,
93 92 rather than relying on primary selection.
|
↓ open down ↓ |
61 lines elided |
↑ open up ↑ |
94 93
95 94 For DHCPv6, the interface name used should be the name
96 95 of the physical interface, not one of the logical
97 96 interfaces created by dhcpagent.
98 97
99 98
100 99 -n limit
101 100 Limits the list of values displayed to limit lines.
102 101
103 102
104 - -v4 | 6
105 - Specifies the DHCP version to query. Use -v4for DHCPv4
106 - and -v6 for DHCPv6.
103 + -v 4|6
104 + Specifies the DHCP version to query. Use -v 4 for
105 + DHCPv4 and -v 6 for DHCPv6.
107 106
108 107
109 108 OPERANDS
110 109 The following operands are supported:
111 110
112 111 code
113 112 Numeric code for the requested DHCP parameter, as defined
114 113 by the DHCP specification. Vendor options are specified
115 114 by adding 256 to the actual vendor code for DHCPv4, and
116 115 65536 for DHCPv6.
117 116
118 117
119 118 identifier
120 119 Mnemonic symbol for the requested DHCP parameter, as
121 120 listed in dhcp_inittab(4).
122 121
123 122
124 123 EXIT STATUS
125 124 The following exit values are returned:
126 125
127 126 0
128 127 Successful operation.
129 128
130 129
131 130 2
132 131 The operation was not successful. The DHCP client daemon might not
133 132 be running, the interface might have failed to configure, or no
134 133 satisfactory DHCP responses were received.
135 134
136 135
137 136 3
138 137 Bad arguments.
139 138
140 139
141 140 4
142 141 The operation timed out.
143 142
144 143
145 144 6
146 145 System error (should never occur).
147 146
148 147
149 148 ATTRIBUTES
150 149 See attributes(5) for descriptions of the following attributes:
151 150
|
↓ open down ↓ |
35 lines elided |
↑ open up ↑ |
152 151
153 152
154 153
155 154 +--------------------+-----------------+
156 155 | ATTRIBUTE TYPE | ATTRIBUTE VALUE |
157 156 +--------------------+-----------------+
158 157 |Interface Stability | Committed |
159 158 +--------------------+-----------------+
160 159
161 160 SEE ALSO
162 - dhcpagent(1M), ifconfig(1M), init(1M), dhcp_inittab(4), attributes(5)
161 + dhcpagent(1M), ifconfig(1M), dhcp_inittab(4), attributes(5)
163 162
164 163
165 164 Alexander, S., and R. Droms, RFC 2132, DHCP Options and BOOTP Vendor
166 165 Extensions, Silicon Graphics, Inc., Bucknell University, March 1997.
167 166
168 167
169 168 Droms, R. , RFC 3315, Dynamic Host Configuration Protocol for IPv6
170 169 (DHCPv6), Cisco Systems, July 2003.
171 170
172 171
173 172 Mockapetris, P.V. , RFC 1035, Domain names - implementation and
174 173 specification, ISI, November 1987.
175 174
176 175
177 176
178 - May 15, 2009 DHCPINFO(1)
177 + February 13, 2020 DHCPINFO(1)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX