xref: /freebsd/usr.bin/getaddrinfo/getaddrinfo.1 (revision f126890ac5386406dadf7c4cfa9566cbb56537c5)
1.\"	$NetBSD: getaddrinfo.1,v 1.5 2014/04/22 06:02:06 wiz Exp $
2.\"
3.\" Copyright (c) 2013 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This documentation is derived from text contributed to The NetBSD
7.\" Foundation by Taylor R. Campbell.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd March 20, 2017
31.Dt GETADDRINFO 1
32.Os
33.Sh NAME
34.Nm getaddrinfo
35.Nd resolve names to socket addresses
36.Sh SYNOPSIS
37.Nm
38.Op Fl cNnP
39.Op Fl f Ar family
40.Op Fl p Ar protocol
41.Op Fl s Ar service Ns Op Ns / Ns Ar protocol
42.Op Fl t Ar socktype
43.Op Ar hostname
44.Sh DESCRIPTION
45The
46.Nm
47utility resolves host and service names to socket addresses with
48.Xr getaddrinfo 3
49and prints them to standard output in a user-friendly format.
50.Pp
51The output is a sequence of lines with space-separated fields:
52.Pp
53.Dl socket-type address-family protocol [af-specific data ...]
54.Pp
55For the
56.Dq inet
57and
58.Dq inet6
59address families, the af-specific data are the IP/IPv6 address and port
60number.
61.Pp
62Depending on the settings in
63.Xr nsswitch.conf 5 ,
64.Nm
65might query DNS for answers.
66However, it is not intended to be a general-purpose DNS query utility.
67Use
68.Xr drill 1
69for that.
70.Pp
71These options are available:
72.Bl -tag -width Ds
73.It Fl c
74Look up a canonical name as if with the
75.Dv AI_CANONNAME
76flag to
77.Xr getaddrinfo 3
78and print it on the first line before the socket addresses.
79.It Fl f Ar family
80Specify an address family.
81Address families are named like the
82.Dv AF_...
83constants for address family numbers in the
84.Aq Pa sys/socket.h
85header file but without the
86.Dv AF_
87prefix and lowercase.
88For example,
89.Dq inet
90corresponds with
91.Dv AF_INET .
92.It Fl N
93Treat the service as numeric and do not attempt service name
94resolution, as if with the
95.Dv AI_NUMERICSERV
96flag to
97.Xr getaddrinfo 3 .
98.It Fl n
99Treat the hostname as a numeric address and do not attempt name
100resolution, as if with the
101.Dv AI_NUMERICHOST
102flag to
103.Xr getaddrinfo 3 .
104.It Fl P
105Return socket addresses intended for use with
106.Xr bind 2 ,
107as if with the
108.Dv AI_PASSIVE
109flag to
110.Xr getaddrinfo 3 .
111By default, the socket addresses are intended for use with
112.Xr connect 2 ,
113.Xr sendto 2 ,
114or
115.Xr sendmsg 2 .
116.It Fl p Ar protocol
117Specify a protocol.
118Protocols are numeric or symbolic as listed in
119.Xr protocols 5 .
120.It Fl s Ar service Ns Op Ns / Ns Ar protocol
121Specify a service to look up.
122Services are symbolic or numeric with an optional
123protocol suffix as listed in
124.Xr services 5 .
125If a service is not specified, a hostname is required.
126.It Fl t Ar socktype
127Specify a socket type.
128Socket types are named like the
129.Dv SOCK_...
130constants for socket type numbers in the
131.Aq Pa sys/socket.h
132header file but without the
133.Dv SOCK_
134prefix and lowercase.
135For example,
136.Dq dgram
137corresponds with
138.Dv SOCK_DGRAM .
139.El
140.Sh EXIT STATUS
141.Ex -std getaddrinfo
142.Sh EXAMPLES
143Look up
144.Dq www.NetBSD.org :
145.Bd -literal -offset indent
146$ getaddrinfo www.NetBSD.org
147dgram inet6 udp 2001:4f8:3:7:2e0:81ff:fe52:9ab6 0
148dgram inet udp 149.20.53.67 0
149stream inet6 tcp 2001:4f8:3:7:2e0:81ff:fe52:9ab6 0
150stream inet tcp 149.20.53.67 0
151.Ed
152.Pp
153The port number here is zero because no service was specified.
154.Pp
155Look up
156.Dq morden.NetBSD.org
157for stream sockets on port 80, and show the canonical name:
158.Bd -literal -offset indent
159$ getaddrinfo -c -t stream -s 80 morden.NetBSD.org
160canonname ftp.NetBSD.org
161stream inet6 tcp 2001:470:1f05:3d::21 80
162stream inet tcp 199.233.217.249 80
163.Ed
164.Sh SEE ALSO
165.Xr drill 1 ,
166.Xr getent 1 ,
167.Xr getaddrinfo 3 ,
168.Xr getnameinfo 3 ,
169.Xr resolver 3 ,
170.Xr hosts 5 ,
171.Xr nsswitch.conf 5 ,
172.Xr protocols 5 ,
173.Xr resolv.conf 5 ,
174.Xr services 5
175.Sh HISTORY
176The
177.Nm
178command first appeared in
179.Nx 7.0 .
180