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