usr.bin/whois/whois.1

   1 .\" Copyright (c) 1985, 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     From: @(#)whois.1       8.1 (Berkeley) 6/6/93
  29 .\"
  30 .Dd August 1, 2019
  31 .Dt WHOIS 1
  32 .Os
  33 .Sh NAME
  34 .Nm whois
  35 .Nd "Internet domain name and network number directory service"
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl aAbfgiIklmPQrRS
  39 .Op Fl c Ar TLD | Fl h Ar host
  40 .Op Fl p Ar port
  41 .Op Fl -
  42 .Ar name ...
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 utility looks up records in the databases maintained by several
  47 Network Information Centers
  48 .Pq Tn NICs .
  49 .Pp
  50 By default
  51 .Nm
  52 starts by querying the Internet Assigned Numbers Authority (IANA) whois server,
  53 and follows referrals to whois servers
  54 that have more specific details about the query
  55 .Ar name .
  56 The IANA whois server knows about
  57 IP address and AS numbers
  58 as well as domain names.
  59 .Pp
  60 There are a few special cases where referrals do not work, so
  61 .Nm
  62 goes directly to the appropriate server.
  63 These include point-of-contact handles for ARIN,
  64 .Pa nic.at ,
  65 NORID, and RIPE,
  66 and domain names under
  67 .Pa ac.uk .
  68 .Pp
  69 The options are as follows:
  70 .Bl -tag -width indent
  71 .It Fl a
  72 Use the American Registry for Internet Numbers
  73 .Pq Tn ARIN
  74 database.
  75 It contains network numbers used in those parts of the world covered neither by
  76 .Tn APNIC , AfriNIC , LACNIC ,
  77 nor by
  78 .Tn RIPE .
  79 The query syntax is documented at
  80 .Pa https://www.arin.net/resources/whoisrws/whois_api.html#nicname
  81 .It Fl A
  82 Use the Asia/Pacific Network Information Center
  83 .Pq Tn APNIC
  84 database.
  85 It contains network numbers used in East Asia, Australia,
  86 New Zealand, and the Pacific islands.
  87 Get query syntax documentation using
  88 .Ic whois -A help
  89 .It Fl b
  90 Use the Network Abuse Clearinghouse database.
  91 It contains addresses to which network abuse should be reported,
  92 indexed by domain name.
  93 .It Fl c Ar TLD
  94 This is the equivalent of using the
  95 .Fl h
  96 option with an argument of
  97 .Qq Ar TLD Ns Li .whois-servers.net .
  98 This can be helpful for locating country-class TLD whois servers.
  99 .It Fl f
 100 Use the African Network Information Centre
 101 .Pq Tn AfriNIC
 102 database.
 103 It contains network numbers used in Africa and the islands of the
 104 western Indian Ocean.
 105 Get query syntax documentation using
 106 .Ic whois -f help
 107 .It Fl g
 108 Use the US non-military federal government database, which contains points of
 109 contact for subdomains of
 110 .Pa .GOV .
 111 .It Fl h Ar host
 112 Use the specified host instead of the default.
 113 Either a host name or an IP address may be specified.
 114 .It Fl i
 115 Use the traditional Network Information Center (InterNIC)
 116 .Pq Pa whois.internic.net
 117 database.
 118 This now contains only registrations for domain names under
 119 .Pa .COM ,
 120 .Pa .NET ,
 121 .Pa .EDU .
 122 You can specify the type of object to search for like
 123 .Ic whois -i ' Ns Ar type Ar name Ns Ic '
 124 where
 125 .Ar type
 126 can be
 127 .Nm domain , nameserver , registrar .
 128 The
 129 .Ar name
 130 can contain
 131 .Li *
 132 wildcards.
 133 .It Fl I
 134 Use the Internet Assigned Numbers Authority
 135 .Pq Tn IANA
 136 database.
 137 .It Fl k
 138 Use the National Internet Development Agency of Korea's
 139 .Pq Tn KRNIC
 140 database.
 141 It contains network numbers and domain contact information
 142 for Korea.
 143 .It Fl l
 144 Use the Latin American and Caribbean IP address Regional Registry
 145 .Pq Tn LACNIC
 146 database.
 147 It contains network numbers used in much of Latin America and the
 148 Caribbean.
 149 .It Fl m
 150 Use the Route Arbiter Database
 151 .Pq Tn RADB
 152 database.
 153 It contains route policy specifications for a large
 154 number of operators' networks.
 155 .It Fl p Ar port
 156 Connect to the whois server on
 157 .Ar port .
 158 If this option is not specified,
 159 .Nm
 160 defaults to port 43.
 161 .It Fl P
 162 Use the PeeringDB database of AS numbers.
 163 It contains details about presence at internet peering points
 164 for many network operators.
 165 .It Fl Q
 166 Do a quick lookup;
 167 .Nm
 168 will not attempt to follow referrals to other whois servers.
 169 This is the default if a server is explicitly specified
 170 using one of the other options or in an environment variable.
 171 See also the
 172 .Fl R
 173 option.
 174 .It Fl r
 175 Use the R\(aaeseaux IP Europ\(aaeens
 176 .Pq Tn RIPE
 177 database.
 178 It contains network numbers and domain contact information
 179 for Europe.
 180 Get query syntax documentation using
 181 .Ic whois -r help
 182 .It Fl R
 183 Do a recursive lookup;
 184 .Nm
 185 will attempt to follow referrals to other whois servers.
 186 This is the default if no server is explicitly specified.
 187 See also the
 188 .Fl Q
 189 option.
 190 .It Fl S
 191 By default
 192 .Nm
 193 adjusts simple queries (without spaces) to produce more useful output
 194 from certain whois servers,
 195 and it suppresses some uninformative output.
 196 With the
 197 .Fl S
 198 option,
 199 .Nm
 200 sends the query and prints the output verbatim.
 201 .El
 202 .Pp
 203 The operands specified to
 204 .Nm
 205 are treated independently and may be used
 206 as queries on different whois servers.
 207 .Sh ENVIRONMENT
 208 .Bl -tag -width WHOIS_SERVER
 209 .It Ev WHOIS_SERVER
 210 The primary default whois server.
 211 If this is unset,
 212 .Nm
 213 uses the
 214 .Ev RA_SERVER
 215 environment variable.
 216 .It Ev RA_SERVER
 217 The secondary default whois server.
 218 If this is unset,
 219 .Nm
 220 will use
 221 .Pa whois.iana.org .
 222 .El
 223 .Sh EXIT STATUS
 224 .Ex -std
 225 .Sh EXAMPLES
 226 To obtain contact information about an
 227 administrator located in the Russian
 228 .Tn TLD
 229 domain
 230 .Qq Li RU ,
 231 use the
 232 .Fl c
 233 option as shown in the following example, where
 234 .Ar CONTACT-ID
 235 is substituted with the actual contact identifier.
 236 .Pp
 237 .Dl Ic whois -c RU CONTACT-ID
 238 .Pp
 239 (Note: This example is specific to the
 240 .Tn TLD
 241 .Qq Li RU ,
 242 but other
 243 .Tn TLDs
 244 can be queried by using a similar syntax.)
 245 .Pp
 246 The following example demonstrates how to query
 247 a whois server using a non-standard port, where
 248 .Dq Li query-data
 249 is the query to be sent to
 250 .Dq Li whois.example.com
 251 on port
 252 .Dq Li rwhois
 253 (written numerically as 4321).
 254 .Pp
 255 .Dl Ic whois -h whois.example.com -p rwhois query-data
 256 .Pp
 257 Some whois servers support complex queries
 258 with dash-letter options.
 259 You can use the
 260 .Fl -
 261 option to separate
 262 .Nm
 263 command options from whois server query options.
 264 A query containing spaces must be quoted as one
 265 argument to the
 266 .Nm
 267 command.
 268 The following example asks the RIPE whois server
 269 to return a brief description of its
 270 .Dq Li domain
 271 object type:
 272 .Pp
 273 .Dl Ic whois -r -- '-t domain'
 274 .Sh STANDARDS
 275 .Rs
 276 .%A K. Harrenstien
 277 .%A M. Stahl
 278 .%A E. Feinler
 279 .%D October 1985
 280 .%R RFC 954
 281 .%T NICNAME/WHOIS
 282 .Re
 283 .Pp
 284 .Rs
 285 .%A L. Daigle
 286 .%D September 2004
 287 .%R RFC 3912
 288 .%T WHOIS Protocol Specification
 289 .Re
 290 .Sh HISTORY
 291 The
 292 .Nm
 293 command appeared in
 294 .Bx 4.3 .