1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the PACKAGE package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: PACKAGE VERSION\n"
10 "POT-Creation-Date: 2013-08-15 19:32+0900\n"
11 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=CHARSET\n"
17 "Content-Transfer-Encoding: 8bit\n"
20 #: build/C/man7/arp.7:13
26 #: build/C/man7/arp.7:13
32 #: build/C/man7/arp.7:13 build/C/man3/cmsg.3:11 build/C/man7/ddp.7:12 build/C/man5/gai.conf.5:19 build/C/man1/getent.1:24 build/C/man3/getipnodebyname.3:26 build/C/man2/getpeername.2:42 build/C/man5/host.conf.5:26 build/C/man7/hostname.7:39 build/C/man5/hosts.5:27 build/C/man5/hosts.equiv.5:6 build/C/man7/icmp.7:12 build/C/man3/inet_ntop.3:26 build/C/man3/inet_pton.3:27 build/C/man7/ip.7:36 build/C/man7/ipv6.7:86 build/C/man7/netdevice.7:18 build/C/man5/nss.5:19 build/C/man5/nsswitch.conf.5:25 build/C/man7/packet.7:12 build/C/man5/protocols.5:29 build/C/man7/raw.7:13 build/C/man3/rcmd.3:43 build/C/man3/rexec.3:41 build/C/man5/services.5:34 build/C/man2/shutdown.2:40 build/C/man7/tcp.7:65 build/C/man7/udp.7:12 build/C/man7/udplite.7:27 build/C/man7/unix.7:18 build/C/man7/x25.7:12
38 #: build/C/man7/arp.7:13 build/C/man3/byteorder.3:32 build/C/man3/cmsg.3:11 build/C/man7/ddp.7:12 build/C/man3/endian.3:28 build/C/man3/ether_aton.3:31 build/C/man5/gai.conf.5:19 build/C/man3/getaddrinfo.3:43 build/C/man3/getaddrinfo_a.3:29 build/C/man3/gethostbyname.3:38 build/C/man3/getipnodebyname.3:26 build/C/man3/getnameinfo.3:10 build/C/man3/getnetent.3:30 build/C/man3/getnetent_r.3:26 build/C/man2/getpeername.2:42 build/C/man3/getprotoent.3:30 build/C/man3/getprotoent_r.3:26 build/C/man3/getservent.3:34 build/C/man3/getservent_r.3:26 build/C/man7/hostname.7:39 build/C/man5/hosts.5:27 build/C/man5/hosts.equiv.5:6 build/C/man7/icmp.7:12 build/C/man3/inet.3:42 build/C/man3/inet_ntop.3:26 build/C/man3/inet_pton.3:27 build/C/man7/ip.7:36 build/C/man7/ipv6.7:86 build/C/man7/netdevice.7:18 build/C/man8/nscd.8:23 build/C/man5/nscd.conf.5:20 build/C/man5/nss.5:19 build/C/man5/nsswitch.conf.5:25 build/C/man7/packet.7:12 build/C/man5/protocols.5:29 build/C/man7/raw.7:13 build/C/man3/rcmd.3:43 build/C/man5/resolv.conf.5:23 build/C/man3/resolver.3:32 build/C/man3/rexec.3:41 build/C/man5/services.5:34 build/C/man3/setnetgrent.3:10 build/C/man2/shutdown.2:40 build/C/man7/tcp.7:65 build/C/man7/udp.7:12 build/C/man7/udplite.7:27 build/C/man7/unix.7:18 build/C/man7/x25.7:12
40 msgid "Linux Programmer's Manual"
44 #: build/C/man7/arp.7:14 build/C/man3/byteorder.3:33 build/C/man3/cmsg.3:12 build/C/man7/ddp.7:13 build/C/man3/endian.3:29 build/C/man3/ether_aton.3:32 build/C/man5/gai.conf.5:20 build/C/man3/getaddrinfo.3:44 build/C/man3/getaddrinfo_a.3:30 build/C/man1/getent.1:25 build/C/man3/gethostbyname.3:39 build/C/man3/getipnodebyname.3:27 build/C/man3/getnameinfo.3:11 build/C/man3/getnetent.3:31 build/C/man3/getnetent_r.3:27 build/C/man2/getpeername.2:43 build/C/man3/getprotoent.3:31 build/C/man3/getprotoent_r.3:27 build/C/man3/getservent.3:35 build/C/man3/getservent_r.3:27 build/C/man5/host.conf.5:27 build/C/man7/hostname.7:40 build/C/man5/hosts.5:28 build/C/man5/hosts.equiv.5:7 build/C/man7/icmp.7:13 build/C/man3/inet.3:43 build/C/man3/inet_ntop.3:27 build/C/man3/inet_pton.3:28 build/C/man7/ip.7:37 build/C/man7/ipv6.7:87 build/C/man7/netdevice.7:19 build/C/man5/networks.5:27 build/C/man8/nscd.8:24 build/C/man5/nscd.conf.5:21 build/C/man5/nss.5:20 build/C/man5/nsswitch.conf.5:26 build/C/man7/packet.7:13 build/C/man5/protocols.5:30 build/C/man7/raw.7:14 build/C/man3/rcmd.3:44 build/C/man5/resolv.conf.5:25 build/C/man3/resolver.3:33 build/C/man3/rexec.3:42 build/C/man5/services.5:35 build/C/man3/setnetgrent.3:11 build/C/man2/shutdown.2:41 build/C/man7/tcp.7:66 build/C/man7/udp.7:13 build/C/man7/udplite.7:28 build/C/man7/unix.7:19 build/C/man7/x25.7:13
50 #: build/C/man7/arp.7:16
51 msgid "arp - Linux ARP kernel module."
55 #: build/C/man7/arp.7:16 build/C/man3/byteorder.3:48 build/C/man3/cmsg.3:37 build/C/man7/ddp.7:23 build/C/man3/endian.3:53 build/C/man3/ether_aton.3:57 build/C/man5/gai.conf.5:22 build/C/man3/getaddrinfo.3:75 build/C/man3/getaddrinfo_a.3:50 build/C/man1/getent.1:30 build/C/man3/gethostbyname.3:118 build/C/man3/getipnodebyname.3:44 build/C/man3/getnameinfo.3:32 build/C/man3/getnetent.3:48 build/C/man3/getnetent_r.3:62 build/C/man2/getpeername.2:50 build/C/man3/getprotoent.3:48 build/C/man3/getprotoent_r.3:59 build/C/man3/getservent.3:52 build/C/man3/getservent_r.3:59 build/C/man5/host.conf.5:29 build/C/man7/hostname.7:42 build/C/man5/hosts.5:32 build/C/man5/hosts.equiv.5:11 build/C/man7/icmp.7:15 build/C/man3/inet.3:75 build/C/man3/inet_ntop.3:36 build/C/man3/inet_pton.3:36 build/C/man7/ip.7:53 build/C/man7/ipv6.7:99 build/C/man7/netdevice.7:25 build/C/man5/networks.5:29 build/C/man8/nscd.8:26 build/C/man5/nscd.conf.5:23 build/C/man5/nss.5:22 build/C/man5/nsswitch.conf.5:28 build/C/man7/packet.7:25 build/C/man5/protocols.5:32 build/C/man7/raw.7:22 build/C/man3/rcmd.3:92 build/C/man5/resolv.conf.5:29 build/C/man3/resolver.3:85 build/C/man3/rexec.3:56 build/C/man5/services.5:37 build/C/man3/setnetgrent.3:44 build/C/man2/shutdown.2:47 build/C/man7/tcp.7:76 build/C/man7/udp.7:23 build/C/man7/udplite.7:38 build/C/man7/unix.7:29 build/C/man7/x25.7:21
61 #: build/C/man7/arp.7:24
63 "This kernel protocol module implements the Address Resolution Protocol "
64 "defined in RFC\\ 826. It is used to convert between Layer2 hardware "
65 "addresses and IPv4 protocol addresses on directly connected networks. The "
66 "user normally doesn't interact directly with this module except to configure "
67 "it; instead it provides a service for other protocols in the kernel."
71 #: build/C/man7/arp.7:37
73 "A user process can receive ARP packets by using B<packet>(7) sockets. "
74 "There is also a mechanism for managing the ARP cache in user-space by using "
75 "B<netlink>(7) sockets. The ARP table can also be controlled via "
76 "B<ioctl>(2) on any B<AF_INET> socket."
80 #: build/C/man7/arp.7:49
82 "The ARP module maintains a cache of mappings between hardware addresses and "
83 "protocol addresses. The cache has a limited size so old and less frequently "
84 "used entries are garbage-collected. Entries which are marked as permanent "
85 "are never deleted by the garbage-collector. The cache can be directly "
86 "manipulated by the use of ioctls and its behavior can be tuned by the "
87 "I</proc> interfaces described below."
91 #: build/C/man7/arp.7:72
93 "When there is no positive feedback for an existing mapping after some time "
94 "(see the I</proc> interfaces below), a neighbor cache entry is considered "
95 "stale. Positive feedback can be gotten from a higher layer; for example "
96 "from a successful TCP ACK. Other protocols can signal forward progress "
97 "using the B<MSG_CONFIRM> flag to B<sendmsg>(2). When there is no forward "
98 "progress, ARP tries to reprobe. It first tries to ask a local arp daemon "
99 "B<app_solicit> times for an updated MAC address. If that fails and an old "
100 "MAC address is known, a unicast probe is sent B<ucast_solicit> times. If "
101 "that fails too, it will broadcast a new ARP request to the network. "
102 "Requests are sent only when there is data queued for sending."
106 #: build/C/man7/arp.7:77
108 "Linux will automatically add a nonpermanent proxy arp entry when it receives "
109 "a request for an address it forwards to and proxy arp is enabled on the "
110 "receiving interface. When there is a reject route for the target, no proxy "
111 "arp entry is added."
115 #: build/C/man7/arp.7:77 build/C/man7/ddp.7:144 build/C/man7/ip.7:1044 build/C/man7/netdevice.7:72 build/C/man7/packet.7:230 build/C/man7/tcp.7:1032 build/C/man7/udp.7:202 build/C/man7/unix.7:282
121 #: build/C/man7/arp.7:84
123 "Three ioctls are available on all B<AF_INET> sockets. They take a pointer "
124 "to a I<struct arpreq> as their argument."
128 #: build/C/man7/arp.7:94
132 " struct sockaddr arp_pa; /* protocol address */\n"
133 " struct sockaddr arp_ha; /* hardware address */\n"
134 " int arp_flags; /* flags */\n"
135 " struct sockaddr arp_netmask; /* netmask of protocol address */\n"
136 " char arp_dev[16];\n"
141 #: build/C/man7/arp.7:103
143 "B<SIOCSARP>, B<SIOCDARP> and B<SIOCGARP> respectively set, delete and get an "
144 "ARP mapping. Setting and deleting ARP maps are privileged operations and "
145 "may be performed only by a process with the B<CAP_NET_ADMIN> capability or "
146 "an effective UID of 0."
150 #: build/C/man7/arp.7:113
152 "I<arp_pa> must be an B<AF_INET> address and I<arp_ha> must have the same "
153 "type as the device which is specified in I<arp_dev>. I<arp_dev> is a "
154 "zero-terminated string which names a device."
158 #: build/C/man7/arp.7:118
160 msgid "I<arp_flags>\n"
164 #: build/C/man7/arp.7:119
166 msgid "flag:meaning\n"
170 #: build/C/man7/arp.7:120
172 msgid "ATF_COM:Lookup complete\n"
176 #: build/C/man7/arp.7:121
178 msgid "ATF_PERM:Permanent entry\n"
182 #: build/C/man7/arp.7:122
184 msgid "ATF_PUBL:Publish entry\n"
188 #: build/C/man7/arp.7:123
190 msgid "ATF_USETRAILERS:Trailers requested\n"
194 #: build/C/man7/arp.7:124
196 msgid "ATF_NETMASK:Use a netmask\n"
200 #: build/C/man7/arp.7:125
202 msgid "ATF_DONTPUB:Don't answer\n"
206 #: build/C/man7/arp.7:138
208 "If the B<ATF_NETMASK> flag is set, then I<arp_netmask> should be valid. "
209 "Linux 2.2 does not support proxy network ARP entries, so this should be set "
210 "to 0xffffffff, or 0 to remove an existing proxy arp entry. "
211 "B<ATF_USETRAILERS> is obsolete and should not be used."
215 #: build/C/man7/arp.7:138 build/C/man7/ddp.7:122 build/C/man7/icmp.7:41 build/C/man7/ip.7:920 build/C/man7/tcp.7:208 build/C/man7/udp.7:137
217 msgid "/proc interfaces"
221 #: build/C/man7/arp.7:151
223 "ARP supports a range of I</proc> interfaces to configure parameters on a "
224 "global or per-interface basis. The interfaces can be accessed by reading or "
225 "writing the I</proc/sys/net/ipv4/neigh/*/*> files. Each interface in the "
226 "system has its own directory in I</proc/sys/net/ipv4/neigh/>. The setting "
227 "in the \"default\" directory is used for all newly created devices. Unless "
228 "otherwise specified, time-related interfaces are specified in seconds."
232 #: build/C/man7/arp.7:151
234 msgid "I<anycast_delay> (since Linux 2.2)"
239 #: build/C/man7/arp.7:158
241 "The maximum number of jiffies to delay before replying to a IPv6 neighbor "
242 "solicitation message. Anycast support is not yet implemented. Defaults to "
247 #: build/C/man7/arp.7:158
249 msgid "I<app_solicit> (since Linux 2.2)"
254 #: build/C/man7/arp.7:165
256 "The maximum number of probes to send to the user space ARP daemon via "
257 "netlink before dropping back to multicast probes (see I<mcast_solicit>). "
262 #: build/C/man7/arp.7:165
264 msgid "I<base_reachable_time> (since Linux 2.2)"
269 #: build/C/man7/arp.7:176
271 "Once a neighbor has been found, the entry is considered to be valid for at "
272 "least a random value between I<base_reachable_time>/2 and "
273 "3*I<base_reachable_time>/2. An entry's validity will be extended if it "
274 "receives positive feedback from higher level protocols. Defaults to 30 "
275 "seconds. This file is now obsolete in favor of I<base_reachable_time_ms>."
279 #: build/C/man7/arp.7:176
281 msgid "I<base_reachable_time_ms> (since Linux 2.6.12)"
285 #: build/C/man7/arp.7:182
287 "As for I<base_reachable_time>, but measures time in milliseconds. Defaults "
288 "to 30000 milliseconds."
292 #: build/C/man7/arp.7:182
294 msgid "I<delay_first_probe_time> (since Linux 2.2)"
299 #: build/C/man7/arp.7:188
301 "Delay before first probe after it has been decided that a neighbor is "
302 "stale. Defaults to 5 seconds."
306 #: build/C/man7/arp.7:188
308 msgid "I<gc_interval> (since Linux 2.2)"
313 #: build/C/man7/arp.7:194
315 "How frequently the garbage collector for neighbor entries should attempt to "
316 "run. Defaults to 30 seconds."
320 #: build/C/man7/arp.7:194
322 msgid "I<gc_stale_time> (since Linux 2.2)"
327 #: build/C/man7/arp.7:201
329 "Determines how often to check for stale neighbor entries. When a neighbor "
330 "entry is considered stale, it is resolved again before sending data to it. "
331 "Defaults to 60 seconds."
335 #: build/C/man7/arp.7:201
337 msgid "I<gc_thresh1> (since Linux 2.2)"
342 #: build/C/man7/arp.7:208
344 "The minimum number of entries to keep in the ARP cache. The garbage "
345 "collector will not run if there are fewer than this number of entries in the "
346 "cache. Defaults to 128."
350 #: build/C/man7/arp.7:208
352 msgid "I<gc_thresh2> (since Linux 2.2)"
357 #: build/C/man7/arp.7:215
359 "The soft maximum number of entries to keep in the ARP cache. The garbage "
360 "collector will allow the number of entries to exceed this for 5 seconds "
361 "before collection will be performed. Defaults to 512."
365 #: build/C/man7/arp.7:215
367 msgid "I<gc_thresh3> (since Linux 2.2)"
372 #: build/C/man7/arp.7:222
374 "The hard maximum number of entries to keep in the ARP cache. The garbage "
375 "collector will always run if there are more than this number of entries in "
376 "the cache. Defaults to 1024."
380 #: build/C/man7/arp.7:222
382 msgid "I<locktime> (since Linux 2.2)"
387 #: build/C/man7/arp.7:229
389 "The minimum number of jiffies to keep an ARP entry in the cache. This "
390 "prevents ARP cache thrashing if there is more than one potential mapping "
391 "(generally due to network misconfiguration). Defaults to 1 second."
395 #: build/C/man7/arp.7:229
397 msgid "I<mcast_solicit> (since Linux 2.2)"
402 #: build/C/man7/arp.7:235
404 "The maximum number of attempts to resolve an address by multicast/broadcast "
405 "before marking the entry as unreachable. Defaults to 3."
409 #: build/C/man7/arp.7:235
411 msgid "I<proxy_delay> (since Linux 2.2)"
416 #: build/C/man7/arp.7:243
418 "When an ARP request for a known proxy-ARP address is received, delay up to "
419 "I<proxy_delay> jiffies before replying. This is used to prevent network "
420 "flooding in some cases. Defaults to 0.8 seconds."
424 #: build/C/man7/arp.7:243
426 msgid "I<proxy_qlen> (since Linux 2.2)"
431 #: build/C/man7/arp.7:248
433 "The maximum number of packets which may be queued to proxy-ARP addresses. "
438 #: build/C/man7/arp.7:248
440 msgid "I<retrans_time> (since Linux 2.2)"
445 #: build/C/man7/arp.7:255
447 "The number of jiffies to delay before retransmitting a request. Defaults to "
448 "1 second. This file is now obsolete in favor of I<retrans_time_ms>."
452 #: build/C/man7/arp.7:255
454 msgid "I<retrans_time_ms> (since Linux 2.6.12)"
458 #: build/C/man7/arp.7:259
460 "The number of milliseconds to delay before retransmitting a request. "
461 "Defaults to 1000 milliseconds."
465 #: build/C/man7/arp.7:259
467 msgid "I<ucast_solicit> (since Linux 2.2)"
472 #: build/C/man7/arp.7:266
474 "The maximum number of attempts to send unicast probes before asking the ARP "
475 "daemon (see I<app_solicit>). Defaults to 3."
479 #: build/C/man7/arp.7:266
481 msgid "I<unres_qlen> (since Linux 2.2)"
486 #: build/C/man7/arp.7:272
488 "The maximum number of packets which may be queued for each unresolved "
489 "address by other network layers. Defaults to 3."
493 #: build/C/man7/arp.7:272 build/C/man7/ddp.7:221 build/C/man3/endian.3:74 build/C/man3/getnameinfo.3:203 build/C/man7/icmp.7:161 build/C/man7/ipv6.7:361 build/C/man7/packet.7:282 build/C/man7/raw.7:175 build/C/man3/rcmd.3:262 build/C/man3/rexec.3:138 build/C/man7/tcp.7:1149 build/C/man7/udp.7:251 build/C/man7/udplite.7:132 build/C/man7/unix.7:399 build/C/man7/x25.7:100
499 #: build/C/man7/arp.7:279
501 "The I<struct arpreq> changed in Linux 2.0 to include the I<arp_dev> member "
502 "and the ioctl numbers changed at the same time. Support for the old ioctls "
503 "was dropped in Linux 2.2."
507 #: build/C/man7/arp.7:285
509 "Support for proxy arp entries for networks (netmask not equal 0xffffffff) "
510 "was dropped in Linux 2.2. It is replaced by automatic proxy arp setup by "
511 "the kernel for all reachable hosts on other interfaces (when forwarding and "
512 "proxy arp is enabled for the interface)."
516 #: build/C/man7/arp.7:289
517 msgid "The I<neigh/*> interfaces did not exist before Linux 2.2."
521 #: build/C/man7/arp.7:289 build/C/man7/ddp.7:244 build/C/man3/ether_aton.3:145 build/C/man3/gethostbyname.3:424 build/C/man3/inet_ntop.3:112 build/C/man3/inet_pton.3:150 build/C/man7/ip.7:1214 build/C/man7/ipv6.7:400 build/C/man7/netdevice.7:328 build/C/man7/packet.7:363 build/C/man7/raw.7:252 build/C/man3/rcmd.3:278 build/C/man3/rexec.3:158 build/C/man2/shutdown.2:104 build/C/man7/tcp.7:1156 build/C/man7/udplite.7:134 build/C/man7/x25.7:102
527 #: build/C/man7/arp.7:293
529 "Some timer settings are specified in jiffies, which is architecture- and "
530 "kernel version-dependent; see B<time>(7)."
534 #: build/C/man7/arp.7:299
536 "There is no way to signal positive feedback from user space. This means "
537 "connection-oriented protocols implemented in user space will generate "
538 "excessive ARP traffic, because ndisc will regularly reprobe the MAC "
539 "address. The same problem applies for some kernel protocols (e.g., NFS over "
544 #: build/C/man7/arp.7:302
546 "This man page mashes IPv4 specific and shared between IPv4 and IPv6 "
547 "functionality together."
551 #: build/C/man7/arp.7:302 build/C/man3/byteorder.3:83 build/C/man3/cmsg.3:217 build/C/man7/ddp.7:249 build/C/man3/endian.3:151 build/C/man3/ether_aton.3:149 build/C/man5/gai.conf.5:93 build/C/man3/getaddrinfo.3:817 build/C/man3/getaddrinfo_a.3:600 build/C/man1/getent.1:368 build/C/man3/gethostbyname.3:429 build/C/man3/getipnodebyname.3:266 build/C/man3/getnameinfo.3:275 build/C/man3/getnetent.3:154 build/C/man3/getnetent_r.3:145 build/C/man2/getpeername.2:143 build/C/man3/getprotoent.3:142 build/C/man3/getprotoent_r.3:237 build/C/man3/getservent.3:159 build/C/man3/getservent_r.3:241 build/C/man5/host.conf.5:199 build/C/man7/hostname.7:85 build/C/man5/hosts.5:115 build/C/man5/hosts.equiv.5:84 build/C/man7/icmp.7:191 build/C/man3/inet.3:297 build/C/man3/inet_ntop.3:118 build/C/man3/inet_pton.3:215 build/C/man7/ip.7:1233 build/C/man7/ipv6.7:411 build/C/man7/netdevice.7:342 build/C/man5/networks.5:74 build/C/man8/nscd.8:85 build/C/man5/nscd.conf.5:232 build/C/man5/nss.5:110 build/C/man5/nsswitch.conf.5:352 build/C/man7/packet.7:394 build/C/man5/protocols.5:81 build/C/man7/raw.7:269 build/C/man3/rcmd.3:285 build/C/man5/resolv.conf.5:287 build/C/man3/resolver.3:274 build/C/man3/rexec.3:167 build/C/man5/services.5:210 build/C/man3/setnetgrent.3:107 build/C/man2/shutdown.2:113 build/C/man7/tcp.7:1168 build/C/man7/udp.7:256 build/C/man7/udplite.7:146 build/C/man7/unix.7:443 build/C/man7/x25.7:118
557 #: build/C/man7/arp.7:305
558 msgid "B<capabilities>(7), B<ip>(7)"
562 #: build/C/man7/arp.7:310
564 "RFC\\ 826 for a description of ARP. RFC\\ 2461 for a description of IPv6 "
565 "neighbor discovery and the base algorithms used. Linux 2.2+ IPv4 ARP uses "
566 "the IPv6 algorithms when applicable."
570 #: build/C/man7/arp.7:310 build/C/man3/byteorder.3:87 build/C/man3/cmsg.3:222 build/C/man7/ddp.7:254 build/C/man3/endian.3:153 build/C/man3/ether_aton.3:151 build/C/man5/gai.conf.5:96 build/C/man3/getaddrinfo.3:827 build/C/man3/getaddrinfo_a.3:607 build/C/man1/getent.1:370 build/C/man3/gethostbyname.3:443 build/C/man3/getipnodebyname.3:271 build/C/man3/getnameinfo.3:308 build/C/man3/getnetent.3:161 build/C/man3/getnetent_r.3:148 build/C/man2/getpeername.2:150 build/C/man3/getprotoent.3:147 build/C/man3/getprotoent_r.3:240 build/C/man3/getservent.3:164 build/C/man3/getservent_r.3:244 build/C/man5/host.conf.5:204 build/C/man7/hostname.7:93 build/C/man5/hosts.5:126 build/C/man5/hosts.equiv.5:88 build/C/man7/icmp.7:195 build/C/man3/inet.3:307 build/C/man3/inet_ntop.3:122 build/C/man3/inet_pton.3:219 build/C/man7/ip.7:1251 build/C/man7/ipv6.7:418 build/C/man7/netdevice.7:347 build/C/man5/networks.5:80 build/C/man8/nscd.8:91 build/C/man5/nscd.conf.5:237 build/C/man5/nss.5:112 build/C/man5/nsswitch.conf.5:355 build/C/man7/packet.7:408 build/C/man5/protocols.5:86 build/C/man7/raw.7:282 build/C/man3/rcmd.3:293 build/C/man5/resolv.conf.5:294 build/C/man3/resolver.3:280 build/C/man3/rexec.3:170 build/C/man5/services.5:222 build/C/man3/setnetgrent.3:111 build/C/man2/shutdown.2:117 build/C/man7/tcp.7:1194 build/C/man7/udp.7:267 build/C/man7/udplite.7:156 build/C/man7/unix.7:452 build/C/man7/x25.7:127
576 #: build/C/man7/arp.7:317 build/C/man3/byteorder.3:94 build/C/man3/cmsg.3:229 build/C/man7/ddp.7:261 build/C/man3/endian.3:160 build/C/man3/ether_aton.3:158 build/C/man5/gai.conf.5:103 build/C/man3/getaddrinfo.3:834 build/C/man3/getaddrinfo_a.3:614 build/C/man1/getent.1:377 build/C/man3/gethostbyname.3:450 build/C/man3/getipnodebyname.3:278 build/C/man3/getnameinfo.3:315 build/C/man3/getnetent.3:168 build/C/man3/getnetent_r.3:155 build/C/man2/getpeername.2:157 build/C/man3/getprotoent.3:154 build/C/man3/getprotoent_r.3:247 build/C/man3/getservent.3:171 build/C/man3/getservent_r.3:251 build/C/man5/host.conf.5:211 build/C/man7/hostname.7:100 build/C/man5/hosts.5:133 build/C/man5/hosts.equiv.5:95 build/C/man7/icmp.7:202 build/C/man3/inet.3:314 build/C/man3/inet_ntop.3:129 build/C/man3/inet_pton.3:226 build/C/man7/ip.7:1258 build/C/man7/ipv6.7:425 build/C/man7/netdevice.7:354 build/C/man5/networks.5:87 build/C/man8/nscd.8:98 build/C/man5/nscd.conf.5:244 build/C/man5/nss.5:119 build/C/man5/nsswitch.conf.5:362 build/C/man7/packet.7:415 build/C/man5/protocols.5:93 build/C/man7/raw.7:289 build/C/man3/rcmd.3:300 build/C/man5/resolv.conf.5:301 build/C/man3/resolver.3:287 build/C/man3/rexec.3:177 build/C/man5/services.5:229 build/C/man3/setnetgrent.3:118 build/C/man2/shutdown.2:124 build/C/man7/tcp.7:1201 build/C/man7/udp.7:274 build/C/man7/udplite.7:163 build/C/man7/unix.7:459 build/C/man7/x25.7:134
578 "This page is part of release 3.53 of the Linux I<man-pages> project. A "
579 "description of the project, and information about reporting bugs, can be "
580 "found at \\%http://www.kernel.org/doc/man-pages/."
584 #: build/C/man3/byteorder.3:32
590 #: build/C/man3/byteorder.3:32
596 #: build/C/man3/byteorder.3:32 build/C/man3/endian.3:28 build/C/man3/ether_aton.3:31 build/C/man3/getaddrinfo.3:43 build/C/man3/getaddrinfo_a.3:29 build/C/man3/getnameinfo.3:10 build/C/man3/getnetent.3:30 build/C/man3/getnetent_r.3:26 build/C/man3/getprotoent.3:30 build/C/man3/getprotoent_r.3:26 build/C/man3/getservent.3:34 build/C/man3/getservent_r.3:26 build/C/man3/inet.3:42 build/C/man8/nscd.8:23 build/C/man5/nscd.conf.5:20 build/C/man3/resolver.3:32 build/C/man3/setnetgrent.3:10
602 #: build/C/man3/byteorder.3:36
604 "htonl, htons, ntohl, ntohs - convert values between host and network byte "
609 #: build/C/man3/byteorder.3:36 build/C/man3/cmsg.3:14 build/C/man7/ddp.7:15 build/C/man3/endian.3:33 build/C/man3/ether_aton.3:35 build/C/man3/getaddrinfo.3:47 build/C/man3/getaddrinfo_a.3:33 build/C/man1/getent.1:27 build/C/man3/gethostbyname.3:46 build/C/man3/getipnodebyname.3:30 build/C/man3/getnameinfo.3:13 build/C/man3/getnetent.3:34 build/C/man3/getnetent_r.3:30 build/C/man2/getpeername.2:45 build/C/man3/getprotoent.3:34 build/C/man3/getprotoent_r.3:30 build/C/man3/getservent.3:38 build/C/man3/getservent_r.3:30 build/C/man5/hosts.5:30 build/C/man3/inet.3:46 build/C/man3/inet_ntop.3:29 build/C/man3/inet_pton.3:30 build/C/man7/ip.7:39 build/C/man7/ipv6.7:89 build/C/man7/netdevice.7:21 build/C/man7/packet.7:15 build/C/man7/raw.7:16 build/C/man3/rcmd.3:48 build/C/man5/resolv.conf.5:27 build/C/man3/resolver.3:36 build/C/man3/rexec.3:44 build/C/man3/setnetgrent.3:14 build/C/man2/shutdown.2:43 build/C/man7/tcp.7:68 build/C/man7/udp.7:15 build/C/man7/udplite.7:30 build/C/man7/unix.7:21 build/C/man7/x25.7:15
615 #: build/C/man3/byteorder.3:39 build/C/man3/inet_ntop.3:32 build/C/man3/inet_pton.3:33
617 msgid "B<#include E<lt>arpa/inet.hE<gt>>\n"
621 #: build/C/man3/byteorder.3:41
623 msgid "B<uint32_t htonl(uint32_t >I<hostlong>B<);>\n"
627 #: build/C/man3/byteorder.3:43
629 msgid "B<uint16_t htons(uint16_t >I<hostshort>B<);>\n"
633 #: build/C/man3/byteorder.3:45
635 msgid "B<uint32_t ntohl(uint32_t >I<netlong>B<);>\n"
639 #: build/C/man3/byteorder.3:47
641 msgid "B<uint16_t ntohs(uint16_t >I<netshort>B<);>\n"
645 #: build/C/man3/byteorder.3:54
647 "The B<htonl>() function converts the unsigned integer I<hostlong> from host "
648 "byte order to network byte order."
652 #: build/C/man3/byteorder.3:60
654 "The B<htons>() function converts the unsigned short integer I<hostshort> "
655 "from host byte order to network byte order."
659 #: build/C/man3/byteorder.3:66
661 "The B<ntohl>() function converts the unsigned integer I<netlong> from "
662 "network byte order to host byte order."
666 #: build/C/man3/byteorder.3:72
668 "The B<ntohs>() function converts the unsigned short integer I<netshort> "
669 "from network byte order to host byte order."
673 #: build/C/man3/byteorder.3:76
675 "On the i386 the host byte order is Least Significant Byte first, whereas the "
676 "network byte order, as used on the Internet, is Most Significant Byte first."
680 #: build/C/man3/byteorder.3:76 build/C/man3/cmsg.3:141 build/C/man3/endian.3:76 build/C/man3/ether_aton.3:143 build/C/man3/getaddrinfo.3:584 build/C/man3/getaddrinfo_a.3:305 build/C/man3/gethostbyname.3:303 build/C/man3/getipnodebyname.3:258 build/C/man3/getnameinfo.3:206 build/C/man3/getnetent.3:145 build/C/man3/getnetent_r.3:141 build/C/man2/getpeername.2:101 build/C/man3/getprotoent.3:140 build/C/man3/getprotoent_r.3:131 build/C/man3/getservent.3:157 build/C/man3/getservent_r.3:130 build/C/man3/inet.3:210 build/C/man3/inet_ntop.3:100 build/C/man3/inet_pton.3:129 build/C/man3/rcmd.3:270 build/C/man3/resolver.3:272 build/C/man3/rexec.3:149 build/C/man3/setnetgrent.3:92 build/C/man2/shutdown.2:91
682 msgid "CONFORMING TO"
686 #: build/C/man3/byteorder.3:78 build/C/man3/inet_pton.3:131
687 msgid "POSIX.1-2001."
691 #: build/C/man3/byteorder.3:83
693 "Some systems require the inclusion of I<E<lt>netinet/in.hE<gt>> instead of "
694 "I<E<lt>arpa/inet.hE<gt>>."
698 #: build/C/man3/byteorder.3:87
699 msgid "B<endian>(3), B<gethostbyname>(3), B<getservent>(3)"
703 #: build/C/man3/cmsg.3:11
709 #: build/C/man3/cmsg.3:11 build/C/man7/ddp.7:12
715 #: build/C/man3/cmsg.3:14
716 msgid "CMSG_ALIGN, CMSG_SPACE, CMSG_NXTHDR, CMSG_FIRSTHDR - access ancillary data"
720 #: build/C/man3/cmsg.3:16 build/C/man7/ddp.7:17 build/C/man2/getpeername.2:47 build/C/man7/ip.7:41 build/C/man7/ipv6.7:91 build/C/man7/raw.7:18 build/C/man2/shutdown.2:45 build/C/man7/tcp.7:70 build/C/man7/udp.7:17 build/C/man7/udplite.7:32 build/C/man7/unix.7:23 build/C/man7/x25.7:17
721 msgid "B<#include E<lt>sys/socket.hE<gt>>"
725 #: build/C/man3/cmsg.3:18
726 msgid "B<struct cmsghdr *CMSG_FIRSTHDR(struct msghdr *>I<msgh>B<);>"
730 #: build/C/man3/cmsg.3:20
732 "B<struct cmsghdr *CMSG_NXTHDR(struct msghdr *>I<msgh>B<, struct cmsghdr "
737 #: build/C/man3/cmsg.3:22
738 msgid "B<size_t CMSG_ALIGN(size_t >I<length>B<);>"
742 #: build/C/man3/cmsg.3:24
743 msgid "B<size_t CMSG_SPACE(size_t >I<length>B<);>"
747 #: build/C/man3/cmsg.3:26
748 msgid "B<size_t CMSG_LEN(size_t >I<length>B<);>"
752 #: build/C/man3/cmsg.3:28
753 msgid "B<unsigned char *CMSG_DATA(struct cmsghdr *>I<cmsg>B<);>"
757 #: build/C/man3/cmsg.3:36
761 " socklen_t cmsg_len; /* data byte count, including header */\n"
762 " int cmsg_level; /* originating protocol */\n"
763 " int cmsg_type; /* protocol-specific type */\n"
764 " /* followed by unsigned char cmsg_data[]; */\n"
769 #: build/C/man3/cmsg.3:51
771 "These macros are used to create and access control messages (also called "
772 "ancillary data) that are not a part of the socket payload. This control "
773 "information may include the interface the packet was received on, various "
774 "rarely used header fields, an extended error description, a set of file "
775 "descriptors or UNIX credentials. For instance, control messages can be used "
776 "to send additional header fields such as IP options. Ancillary data is sent "
777 "by calling B<sendmsg>(2) and received by calling B<recvmsg>(2). See their "
778 "manual pages for more information."
782 #: build/C/man3/cmsg.3:62
784 "Ancillary data is a sequence of I<struct cmsghdr> structures with appended "
785 "data. This sequence should be accessed using only the macros described in "
786 "this manual page and never directly. See the specific protocol man pages "
787 "for the available control message types. The maximum ancillary buffer size "
788 "allowed per socket can be set using I</proc/sys/net/core/optmem_max>; see "
793 #: build/C/man3/cmsg.3:69
795 "B<CMSG_FIRSTHDR>() returns a pointer to the first I<cmsghdr> in the "
796 "ancillary data buffer associated with the passed I<msghdr>."
800 #: build/C/man3/cmsg.3:76
802 "B<CMSG_NXTHDR>() returns the next valid I<cmsghdr> after the passed "
803 "I<cmsghdr>. It returns NULL when there isn't enough space left in the "
808 #: build/C/man3/cmsg.3:81
810 "B<CMSG_ALIGN>(), given a length, returns it including the required "
811 "alignment. This is a constant expression."
815 #: build/C/man3/cmsg.3:86
817 "B<CMSG_SPACE>() returns the number of bytes an ancillary element with "
818 "payload of the passed data length occupies. This is a constant expression."
822 #: build/C/man3/cmsg.3:90
823 msgid "B<CMSG_DATA>() returns a pointer to the data portion of a I<cmsghdr>."
827 #: build/C/man3/cmsg.3:101
829 "B<CMSG_LEN>() returns the value to store in the I<cmsg_len> member of the "
830 "I<cmsghdr> structure, taking into account any necessary alignment. It takes "
831 "the data length as an argument. This is a constant expression."
835 #: build/C/man3/cmsg.3:134
837 "To create ancillary data, first initialize the I<msg_controllen> member of "
838 "the I<msghdr> with the length of the control message buffer. Use "
839 "B<CMSG_FIRSTHDR>() on the I<msghdr> to get the first control message and "
840 "B<CMSG_NXTHDR>() to get all subsequent ones. In each control message, "
841 "initialize I<cmsg_len> (with B<CMSG_LEN>()), the other I<cmsghdr> header "
842 "fields, and the data portion using B<CMSG_DATA>(). Finally, the "
843 "I<msg_controllen> field of the I<msghdr> should be set to the sum of the "
844 "B<CMSG_SPACE>() of the length of all control messages in the buffer. For "
845 "more information on the I<msghdr>, see B<recvmsg>(2)."
849 #: build/C/man3/cmsg.3:141
851 "When the control message buffer is too short to store all messages, the "
852 "B<MSG_CTRUNC> flag is set in the I<msg_flags> member of the I<msghdr>."
856 #: build/C/man3/cmsg.3:146
858 "This ancillary data model conforms to the POSIX.1g draft, 4.4BSD-Lite, the "
859 "IPv6 advanced API described in RFC\\ 2292 and the SUSv2. B<CMSG_ALIGN>() "
860 "is a Linux extension."
864 #: build/C/man3/cmsg.3:146 build/C/man7/ddp.7:226 build/C/man3/endian.3:91 build/C/man3/getaddrinfo.3:589 build/C/man3/getaddrinfo_a.3:308 build/C/man3/gethostbyname.3:327 build/C/man3/getipnodebyname.3:261 build/C/man3/getnameinfo.3:208 build/C/man3/getnetent.3:147 build/C/man2/getpeername.2:105 build/C/man5/host.conf.5:190 build/C/man5/hosts.5:88 build/C/man5/hosts.equiv.5:71 build/C/man7/icmp.7:169 build/C/man3/inet.3:218 build/C/man3/inet_pton.3:131 build/C/man7/ip.7:1152 build/C/man7/ipv6.7:390 build/C/man7/netdevice.7:310 build/C/man8/nscd.8:60 build/C/man5/nsswitch.conf.5:333 build/C/man7/packet.7:300 build/C/man7/raw.7:187 build/C/man3/setnetgrent.3:103 build/C/man2/shutdown.2:95 build/C/man7/unix.7:405
870 #: build/C/man3/cmsg.3:151
872 "For portability, ancillary data should be accessed using only the macros "
873 "described here. B<CMSG_ALIGN>() is a Linux extension and should be not "
874 "used in portable programs."
878 #: build/C/man3/cmsg.3:161
880 "In Linux, B<CMSG_LEN>(), B<CMSG_DATA>(), and B<CMSG_ALIGN>() are constant "
881 "expressions (assuming their argument is constant); this could be used to "
882 "declare the size of global variables. This may be not portable, however."
886 #: build/C/man3/cmsg.3:161 build/C/man3/endian.3:107 build/C/man5/gai.conf.5:74 build/C/man3/getaddrinfo.3:612 build/C/man3/getaddrinfo_a.3:314 build/C/man3/getnameinfo.3:236 build/C/man3/getprotoent_r.3:135 build/C/man3/getservent_r.3:134 build/C/man5/hosts.5:107 build/C/man3/inet.3:254 build/C/man3/inet_ntop.3:115 build/C/man3/inet_pton.3:156 build/C/man5/nss.5:100 build/C/man7/unix.7:435
892 #: build/C/man3/cmsg.3:165
893 msgid "This code looks for the B<IP_TTL> option in a received ancillary buffer:"
897 #: build/C/man3/cmsg.3:172
900 "struct msghdr msgh;\n"
901 "struct cmsghdr *cmsg;\n"
903 "int received_ttl;\n"
907 #: build/C/man3/cmsg.3:189
910 "/* Receive auxiliary data in msgh */\n"
911 "for (cmsg = CMSG_FIRSTHDR(&msgh); cmsg != NULL;\n"
912 " cmsg = CMSG_NXTHDR(&msgh,cmsg)) {\n"
913 " if (cmsg-E<gt>cmsg_level == IPPROTO_IP\n"
914 " && cmsg-E<gt>cmsg_type == IP_TTL) {\n"
915 " ttlptr = (int *) CMSG_DATA(cmsg);\n"
916 " received_ttl = *ttlptr;\n"
920 "if (cmsg == NULL) {\n"
922 " * Error: IP_TTL not enabled or small buffer\n"
929 #: build/C/man3/cmsg.3:195
931 "The code below passes an array of file descriptors over a UNIX domain socket "
932 "using B<SCM_RIGHTS>:"
936 #: build/C/man3/cmsg.3:203
939 "struct msghdr msg = {0};\n"
940 "struct cmsghdr *cmsg;\n"
941 "int myfds[NUM_FD]; /* Contains the file descriptors to pass. */\n"
942 "char buf[CMSG_SPACE(sizeof myfds)]; /* ancillary data buffer */\n"
947 #: build/C/man3/cmsg.3:215
950 "msg.msg_control = buf;\n"
951 "msg.msg_controllen = sizeof buf;\n"
952 "cmsg = CMSG_FIRSTHDR(&msg);\n"
953 "cmsg-E<gt>cmsg_level = SOL_SOCKET;\n"
954 "cmsg-E<gt>cmsg_type = SCM_RIGHTS;\n"
955 "cmsg-E<gt>cmsg_len = CMSG_LEN(sizeof(int) * NUM_FD);\n"
956 "/* Initialize the payload: */\n"
957 "fdptr = (int *) CMSG_DATA(cmsg);\n"
958 "memcpy(fdptr, myfds, NUM_FD * sizeof(int));\n"
959 "/* Sum of the length of all control messages in the buffer: */\n"
960 "msg.msg_controllen = cmsg-E<gt>cmsg_len;\n"
964 #: build/C/man3/cmsg.3:220
965 msgid "B<recvmsg>(2), B<sendmsg>(2)"
969 #: build/C/man3/cmsg.3:222
974 #: build/C/man7/ddp.7:12
980 #: build/C/man7/ddp.7:15
981 msgid "ddp - Linux AppleTalk protocol implementation"
985 #: build/C/man7/ddp.7:19
986 msgid "B<#include E<lt>netatalk/at.hE<gt>>"
990 #: build/C/man7/ddp.7:21
991 msgid "I<ddp_socket>B< = socket(AF_APPLETALK, SOCK_DGRAM, 0);>"
995 #: build/C/man7/ddp.7:23
996 msgid "I<raw_socket>B< = socket(AF_APPLETALK, SOCK_RAW, >I<protocol>B<);>"
1000 #: build/C/man7/ddp.7:34
1002 "Linux implements the Appletalk protocols described in I<Inside Appletalk>. "
1003 "Only the DDP layer and AARP are present in the kernel. They are designed to "
1004 "be used via the B<netatalk> protocol libraries. This page documents the "
1005 "interface for those who wish or need to use the DDP layer directly."
1009 #: build/C/man7/ddp.7:39
1011 "The communication between Appletalk and the user program works using a "
1012 "BSD-compatible socket interface. For more information on sockets, see "
1017 #: build/C/man7/ddp.7:60
1019 "An AppleTalk socket is created by calling the B<socket>(2) function with a "
1020 "B<AF_APPLETALK> socket family argument. Valid socket types are "
1021 "B<SOCK_DGRAM> to open a B<ddp> socket or B<SOCK_RAW> to open a B<raw> "
1022 "socket. I<protocol> is the Appletalk protocol to be received or sent. For "
1023 "B<SOCK_RAW> you must specify B<ATPROTO_DDP>."
1027 #: build/C/man7/ddp.7:65
1029 "Raw sockets may be opened only by a process with effective user ID 0 or when "
1030 "the process has the B<CAP_NET_RAW> capability."
1034 #: build/C/man7/ddp.7:65 build/C/man7/ip.7:123 build/C/man7/ipv6.7:142 build/C/man7/raw.7:93 build/C/man7/udp.7:98 build/C/man7/udplite.7:58 build/C/man7/unix.7:55
1036 msgid "Address format"
1040 #: build/C/man7/ddp.7:68
1042 "An Appletalk socket address is defined as a combination of a network number, "
1043 "a node number, and a port number."
1047 #: build/C/man7/ddp.7:75
1050 "struct at_addr {\n"
1051 " unsigned short s_net;\n"
1052 " unsigned char s_node;\n"
1057 #: build/C/man7/ddp.7:81
1060 "struct sockaddr_atalk {\n"
1061 " sa_family_t sat_family; /* address family */\n"
1062 " unsigned char sat_port; /* port */\n"
1063 " struct at_addr sat_addr; /* net/node */\n"
1067 #. FIXME this doesn't make sense [johnl]
1069 #: build/C/man7/ddp.7:120
1071 "I<sat_family> is always set to B<AF_APPLETALK>. I<sat_port> contains the "
1072 "port. The port numbers below 129 are known as I<reserved ports>. Only "
1073 "processes with the effective user ID 0 or the B<CAP_NET_BIND_SERVICE> "
1074 "capability may B<bind>(2) to these sockets. I<sat_addr> is the host "
1075 "address. The I<net> member of I<struct at_addr> contains the host network "
1076 "in network byte order. The value of B<AT_ANYNET> is a wildcard and also "
1077 "implies \\(lqthis network.\\(rq The I<node> member of I<struct at_addr> "
1078 "contains the host node number. The value of B<AT_ANYNODE> is a wildcard and "
1079 "also implies \\(lqthis node.\\(rq The value of B<ATADDR_BCAST> is a link "
1080 "local broadcast address."
1084 #: build/C/man7/ddp.7:120 build/C/man7/ip.7:224 build/C/man7/ipv6.7:192 build/C/man7/packet.7:179 build/C/man7/raw.7:109 build/C/man7/tcp.7:858 build/C/man7/udp.7:178 build/C/man7/udplite.7:67 build/C/man7/unix.7:135 build/C/man7/x25.7:72
1086 msgid "Socket options"
1090 #: build/C/man7/ddp.7:122
1091 msgid "No protocol-specific socket options are supported."
1095 #: build/C/man7/ddp.7:128
1097 "IP supports a set of I</proc> interfaces to configure some global AppleTalk "
1098 "parameters. The parameters can be accessed by reading or writing files in "
1099 "the directory I</proc/sys/net/atalk/>."
1103 #: build/C/man7/ddp.7:128
1105 msgid "I<aarp-expiry-time>"
1109 #: build/C/man7/ddp.7:131
1110 msgid "The time interval (in seconds) before an AARP cache entry expires."
1114 #: build/C/man7/ddp.7:131
1116 msgid "I<aarp-resolve-time>"
1120 #: build/C/man7/ddp.7:134
1121 msgid "The time interval (in seconds) before an AARP cache entry is resolved."
1125 #: build/C/man7/ddp.7:134
1127 msgid "I<aarp-retransmit-limit>"
1131 #: build/C/man7/ddp.7:138
1133 "The number of retransmissions of an AARP query before the node is declared "
1138 #: build/C/man7/ddp.7:138
1140 msgid "I<aarp-tick-time>"
1144 #: build/C/man7/ddp.7:141
1145 msgid "The timer rate (in seconds) for the timer driving AARP."
1149 #: build/C/man7/ddp.7:144
1151 "The default values match the specification and should never need to be "
1155 #. FIXME Add a section about multicasting
1157 #: build/C/man7/ddp.7:149
1158 msgid "All ioctls described in B<socket>(7) apply to DDP."
1162 #: build/C/man7/ddp.7:149 build/C/man3/gethostbyname.3:278 build/C/man3/getnetent_r.3:129 build/C/man2/getpeername.2:73 build/C/man3/getprotoent_r.3:119 build/C/man3/getservent_r.3:118 build/C/man3/inet_ntop.3:91 build/C/man7/ip.7:1061 build/C/man7/ipv6.7:349 build/C/man7/packet.7:246 build/C/man7/raw.7:144 build/C/man2/shutdown.2:74 build/C/man7/tcp.7:1131 build/C/man7/udp.7:241 build/C/man7/udplite.7:121 build/C/man7/unix.7:320
1168 #: build/C/man7/ddp.7:153 build/C/man7/ip.7:1065 build/C/man7/raw.7:145
1174 #: build/C/man7/ddp.7:160
1176 "The user tried to execute an operation without the necessary permissions. "
1177 "These include sending to a broadcast address without having the broadcast "
1178 "flag set, and trying to bind to a reserved port without effective user ID 0 "
1179 "or B<CAP_NET_BIND_SERVICE>."
1183 #: build/C/man7/ddp.7:160 build/C/man7/ip.7:1081 build/C/man7/unix.7:321
1185 msgid "B<EADDRINUSE>"
1189 #: build/C/man7/ddp.7:163 build/C/man7/ip.7:1084
1190 msgid "Tried to bind to an address already in use."
1194 #: build/C/man7/ddp.7:163 build/C/man7/ip.7:1084 build/C/man7/packet.7:247
1196 msgid "B<EADDRNOTAVAIL>"
1200 #: build/C/man7/ddp.7:167 build/C/man7/ip.7:1088
1202 "A nonexistent interface was requested or the requested source address was "
1207 #: build/C/man7/ddp.7:167 build/C/man7/ip.7:1088
1213 #: build/C/man7/ddp.7:170 build/C/man7/ip.7:1091
1214 msgid "Operation on a nonblocking socket would block."
1218 #: build/C/man7/ddp.7:170 build/C/man7/ip.7:1091
1224 #: build/C/man7/ddp.7:173
1225 msgid "A connection operation on a nonblocking socket is already in progress."
1229 #: build/C/man7/ddp.7:173 build/C/man7/ip.7:1094
1231 msgid "B<ECONNABORTED>"
1235 #: build/C/man7/ddp.7:177 build/C/man7/ip.7:1098
1236 msgid "A connection was closed during an B<accept>(2)."
1240 #: build/C/man7/ddp.7:177 build/C/man7/ip.7:1098
1242 msgid "B<EHOSTUNREACH>"
1246 #: build/C/man7/ddp.7:180
1247 msgid "No routing table entry matches the destination address."
1251 #: build/C/man7/ddp.7:180 build/C/man2/getpeername.2:85 build/C/man7/ip.7:1103 build/C/man7/packet.7:253 build/C/man7/raw.7:152 build/C/man2/shutdown.2:79 build/C/man7/unix.7:337
1257 #: build/C/man7/ddp.7:183
1258 msgid "Invalid argument passed."
1262 #: build/C/man7/ddp.7:183 build/C/man7/ip.7:1109 build/C/man7/unix.7:346
1268 #: build/C/man7/ddp.7:187 build/C/man7/ip.7:1113
1269 msgid "B<connect>(2) was called on an already connected socket."
1273 #: build/C/man7/ddp.7:187 build/C/man7/ip.7:1113 build/C/man7/packet.7:256 build/C/man7/raw.7:155
1279 #: build/C/man7/ddp.7:190
1280 msgid "Datagram is bigger than the DDP MTU."
1284 #: build/C/man7/ddp.7:190 build/C/man7/ipv6.7:351 build/C/man7/packet.7:265
1290 #: build/C/man7/ddp.7:193
1291 msgid "Network device not available or not capable of sending IP."
1295 #: build/C/man7/ddp.7:193 build/C/man3/getnetent_r.3:130 build/C/man3/getprotoent_r.3:120 build/C/man3/getservent_r.3:119 build/C/man7/ip.7:1121 build/C/man7/packet.7:268 build/C/man7/unix.7:351
1301 #: build/C/man7/ddp.7:197 build/C/man7/ip.7:1125
1302 msgid "B<SIOCGSTAMP> was called on a socket where no packet arrived."
1306 #: build/C/man7/ddp.7:197
1308 msgid "B<ENOMEM> and B<ENOBUFS>"
1312 #: build/C/man7/ddp.7:200
1313 msgid "Not enough memory available."
1317 #: build/C/man7/ddp.7:200 build/C/man7/ip.7:1125
1323 #: build/C/man7/ddp.7:203 build/C/man7/ip.7:1128
1324 msgid "A kernel subsystem was not configured."
1328 #: build/C/man7/ddp.7:203 build/C/man7/ip.7:1128
1330 msgid "B<ENOPROTOOPT> and B<EOPNOTSUPP>"
1334 #: build/C/man7/ddp.7:206 build/C/man7/ip.7:1131
1335 msgid "Invalid socket option passed."
1339 #: build/C/man7/ddp.7:206 build/C/man2/getpeername.2:93 build/C/man7/ip.7:1131 build/C/man7/packet.7:271 build/C/man2/shutdown.2:84 build/C/man7/unix.7:359
1345 #: build/C/man7/ddp.7:210 build/C/man7/ip.7:1135
1347 "The operation is defined only on a connected socket, but the socket wasn't "
1352 #: build/C/man7/ddp.7:210 build/C/man7/ip.7:1135 build/C/man7/packet.7:277 build/C/man7/raw.7:166 build/C/man7/unix.7:366
1358 #: build/C/man7/ddp.7:215
1360 "User doesn't have permission to set high priority, make a configuration "
1361 "change, or send signals to the requested process or group."
1365 #: build/C/man7/ddp.7:215 build/C/man7/ip.7:1139 build/C/man7/tcp.7:1138 build/C/man7/unix.7:370
1371 #: build/C/man7/ddp.7:218 build/C/man7/ip.7:1142
1372 msgid "The connection was unexpectedly closed or shut down by the other end."
1376 #: build/C/man7/ddp.7:218 build/C/man7/ip.7:1142 build/C/man7/unix.7:392
1378 msgid "B<ESOCKTNOSUPPORT>"
1382 #: build/C/man7/ddp.7:221
1383 msgid "The socket was unconfigured, or an unknown socket type was requested."
1387 #: build/C/man7/ddp.7:226
1389 "Appletalk is supported by Linux 2.0 or higher. The I</proc> interfaces "
1390 "exist since Linux 2.2."
1394 #: build/C/man7/ddp.7:232
1396 "Be very careful with the B<SO_BROADCAST> option - it is not privileged in "
1397 "Linux. It is easy to overload the network with careless sending to "
1398 "broadcast addresses."
1402 #: build/C/man7/ddp.7:232 build/C/man7/ip.7:1201 build/C/man7/packet.7:331
1404 msgid "Compatibility"
1408 #: build/C/man7/ddp.7:239
1410 "The basic AppleTalk socket interface is compatible with B<netatalk> on "
1411 "BSD-derived systems. Many BSD systems fail to check B<SO_BROADCAST> when "
1412 "sending broadcast frames; this can lead to compatibility problems."
1416 #: build/C/man7/ddp.7:244
1418 "The raw socket mode is unique to Linux and exists to support the alternative "
1419 "CAP package and AppleTalk monitoring tools more easily."
1423 #: build/C/man7/ddp.7:246 build/C/man7/ip.7:1216
1424 msgid "There are too many inconsistent error values."
1428 #: build/C/man7/ddp.7:249
1430 "The ioctls used to configure routing tables, devices, AARP tables and other "
1431 "devices are not yet described."
1435 #: build/C/man7/ddp.7:254
1436 msgid "B<recvmsg>(2), B<sendmsg>(2), B<capabilities>(7), B<socket>(7)"
1440 #: build/C/man3/endian.3:28
1446 #: build/C/man3/endian.3:28 build/C/man3/getnetent_r.3:26 build/C/man3/getprotoent_r.3:26 build/C/man3/getservent_r.3:26
1452 #: build/C/man3/endian.3:33
1454 "htobe16, htole16, be16toh, le16toh, htobe32, htole32, be32toh, le32toh, "
1455 "htobe64, htole64, be64toh, le64toh - convert values between host and "
1456 "big-/little-endian byte order"
1460 #: build/C/man3/endian.3:37
1463 "B<#define _BSD_SOURCE> /* See feature_test_macros(7) */\n"
1464 "B<#include E<lt>endian.hE<gt>>\n"
1468 #: build/C/man3/endian.3:42
1471 "B<uint16_t htobe16(uint16_t >I<host_16bits>B<);>\n"
1472 "B<uint16_t htole16(uint16_t >I<host_16bits>B<);>\n"
1473 "B<uint16_t be16toh(uint16_t >I<big_endian_16bits>B<);>\n"
1474 "B<uint16_t le16toh(uint16_t >I<little_endian_16bits>B<);>\n"
1478 #: build/C/man3/endian.3:47
1481 "B<uint32_t htobe32(uint32_t >I<host_32bits>B<);>\n"
1482 "B<uint32_t htole32(uint32_t >I<host_32bits>B<);>\n"
1483 "B<uint32_t be32toh(uint32_t >I<big_endian_32bits>B<);>\n"
1484 "B<uint32_t le32toh(uint32_t >I<little_endian_32bits>B<);>\n"
1488 #: build/C/man3/endian.3:52
1491 "B<uint64_t htobe64(uint64_t >I<host_64bits>B<);>\n"
1492 "B<uint64_t htole64(uint64_t >I<host_64bits>B<);>\n"
1493 "B<uint64_t be64toh(uint64_t >I<big_endian_64bits>B<);>\n"
1494 "B<uint64_t le64toh(uint64_t >I<little_endian_64bits>B<);>\n"
1498 #: build/C/man3/endian.3:57
1500 "These functions convert the byte encoding of integer values from the byte "
1501 "order that the current CPU (the \"host\") uses, to and from little-endian "
1502 "and big-endian byte order."
1506 #: build/C/man3/endian.3:62
1508 "The number, I<nn>, in the name of each function indicates the size of "
1509 "integer handled by the function, either 16, 32, or 64 bits."
1513 #: build/C/man3/endian.3:65
1515 "The functions with names of the form \"htobeI<nn>\" convert from host byte "
1516 "order to big-endian order."
1520 #: build/C/man3/endian.3:68
1522 "The functions with names of the form \"htoleI<nn>\" convert from host byte "
1523 "order to little-endian order."
1527 #: build/C/man3/endian.3:71
1529 "The functions with names of the form \"beI<nn>toh\" convert from big-endian "
1530 "order to host byte order."
1534 #: build/C/man3/endian.3:74
1536 "The functions with names of the form \"leI<nn>toh\" convert from "
1537 "little-endian order to host byte order."
1541 #: build/C/man3/endian.3:76
1542 msgid "These functions were added to glibc in version 2.9."
1546 #: build/C/man3/endian.3:91
1548 "These functions are nonstandard. Similar functions are present on the BSDs, "
1549 "where the required header file is I<E<lt>sys/endian.hE<gt>> instead of "
1550 "I<E<lt>endian.hE<gt>>. Unfortunately, NetBSD, FreeBSD, and glibc haven't "
1551 "followed the original OpenBSD naming convention for these functions, whereby "
1552 "the I<nn> component always appears at the end of the function name (thus, "
1553 "for example, in NetBSD, FreeBSD, and glibc, the equivalent of OpenBSDs "
1554 "\"betoh32\" is \"be32toh\")."
1558 #: build/C/man3/endian.3:99
1560 "These functions are similar to the older B<byteorder>(3) family of "
1561 "functions. For example, B<be32toh>() is identical to B<ntohl>()B<.>"
1565 #: build/C/man3/endian.3:107
1567 "The advantage of the B<byteorder>(3) functions is that they are standard "
1568 "functions available on all UNIX systems. On the other hand, the fact that "
1569 "they were designed for use in the context of TCP/IP means that they lack the "
1570 "64-bit and little-endian variants described in this page."
1574 #: build/C/man3/endian.3:114
1576 "The program below display the results of converting an integer from host "
1577 "byte order to both little-endian and big-endian byte order. Since host byte "
1578 "order is either little-endian or big-endian, only one of these conversions "
1579 "will have an effect. When we run this program on a little-endian system "
1580 "such as x86-32, we see the following:"
1584 #: build/C/man3/endian.3:121
1588 "x.u32 = 0x44332211\n"
1589 "htole32(x.u32) = 0x44332211\n"
1590 "htobe32(x.u32) = 0x11223344\n"
1594 #: build/C/man3/endian.3:123 build/C/man3/getprotoent_r.3:162 build/C/man3/getservent_r.3:160 build/C/man3/inet.3:270 build/C/man3/inet_pton.3:173
1596 msgid "Program source"
1600 #: build/C/man3/endian.3:130
1603 "#include E<lt>endian.hE<gt>\n"
1604 "#include E<lt>stdint.hE<gt>\n"
1605 "#include E<lt>stdio.hE<gt>\n"
1606 "#include E<lt>stdlib.hE<gt>\n"
1610 #: build/C/man3/endian.3:138
1614 "main(int argc, char *argv[])\n"
1618 "\tuint8_t arr[4];\n"
1623 #: build/C/man3/endian.3:143
1626 " x.arr[0] = 0x11;\t/* Lowest-address byte */\n"
1627 " x.arr[1] = 0x22;\n"
1628 " x.arr[2] = 0x33;\n"
1629 " x.arr[3] = 0x44;\t/* Highest-address byte */\n"
1633 #: build/C/man3/endian.3:147
1636 " printf(\"x.u32 = 0x%x\\en\", x.u32);\n"
1637 " printf(\"htole32(x.u32) = 0x%x\\en\", htole32(x.u32));\n"
1638 " printf(\"htobe32(x.u32) = 0x%x\\en\", htobe32(x.u32));\n"
1642 #: build/C/man3/endian.3:150 build/C/man3/getaddrinfo.3:816 build/C/man3/getprotoent_r.3:236 build/C/man3/getservent_r.3:240 build/C/man3/inet_pton.3:214
1645 " exit(EXIT_SUCCESS);\n"
1650 #: build/C/man3/endian.3:153
1651 msgid "B<byteorder>(3)"
1655 #: build/C/man3/ether_aton.3:31
1661 #: build/C/man3/ether_aton.3:31 build/C/man3/rexec.3:41
1667 #: build/C/man3/ether_aton.3:35
1669 "ether_aton, ether_ntoa, ether_ntohost, ether_hostton, ether_line, "
1670 "ether_ntoa_r, ether_aton_r - Ethernet address manipulation routines"
1674 #: build/C/man3/ether_aton.3:38
1676 msgid "B<#include E<lt>netinet/ether.hE<gt>>\n"
1680 #: build/C/man3/ether_aton.3:40
1682 msgid "B<char *ether_ntoa(const struct ether_addr *>I<addr>B<);>\n"
1686 #: build/C/man3/ether_aton.3:42
1688 msgid "B<struct ether_addr *ether_aton(const char *>I<asc>B<);>\n"
1692 #: build/C/man3/ether_aton.3:44
1695 "B<int ether_ntohost(char *>I<hostname>B<, const struct ether_addr "
1700 #: build/C/man3/ether_aton.3:46
1703 "B<int ether_hostton(const char *>I<hostname>B<, struct ether_addr "
1708 #: build/C/man3/ether_aton.3:49
1711 "B<int ether_line(const char *>I<line>B<, struct ether_addr *>I<addr>B<,>\n"
1712 "B< char *>I<hostname>B<);>\n"
1716 #: build/C/man3/ether_aton.3:51 build/C/man3/gethostbyname.3:70
1718 msgid "/* GNU extensions */\n"
1722 #: build/C/man3/ether_aton.3:53
1725 "B<char *ether_ntoa_r(const struct ether_addr *>I<addr>B<, char "
1730 #: build/C/man3/ether_aton.3:56
1733 "B<struct ether_addr *ether_aton_r(const char *>I<asc>B<,>\n"
1734 "B< struct ether_addr *>I<addr>B<);>\n"
1738 #: build/C/man3/ether_aton.3:67
1740 "B<ether_aton>() converts the 48-bit Ethernet host address I<asc> from the "
1741 "standard hex-digits-and-colons notation into binary data in network byte "
1742 "order and returns a pointer to it in a statically allocated buffer, which "
1743 "subsequent calls will overwrite. B<ether_aton>() returns NULL if the "
1744 "address is invalid."
1748 #: build/C/man3/ether_aton.3:76
1750 "The B<ether_ntoa>() function converts the Ethernet host address I<addr> "
1751 "given in network byte order to a string in standard hex-digits-and-colons "
1752 "notation, omitting leading zeros. The string is returned in a statically "
1753 "allocated buffer, which subsequent calls will overwrite."
1757 #: build/C/man3/ether_aton.3:83
1759 "The B<ether_ntohost>() function maps an Ethernet address to the "
1760 "corresponding hostname in I</etc/ethers> and returns nonzero if it cannot be "
1765 #: build/C/man3/ether_aton.3:90
1767 "The B<ether_hostton>() function maps a hostname to the corresponding "
1768 "Ethernet address in I</etc/ethers> and returns nonzero if it cannot be "
1773 #: build/C/man3/ether_aton.3:102
1775 "The B<ether_line>() function parses a line in I</etc/ethers> format "
1776 "(ethernet address followed by whitespace followed by hostname; \\(aq#\\(aq "
1777 "introduces a comment) and returns an address and hostname pair, or nonzero "
1778 "if it cannot be parsed. The buffer pointed to by I<hostname> must be "
1779 "sufficiently long, for example, have the same length as I<line>."
1783 #: build/C/man3/ether_aton.3:113
1785 "The functions B<ether_ntoa_r>() and B<ether_aton_r>() are reentrant "
1786 "thread-safe versions of B<ether_ntoa>() and B<ether_aton>() respectively, "
1787 "and do not use static buffers."
1791 #: build/C/man3/ether_aton.3:119
1792 msgid "The structure I<ether_addr> is defined in I<E<lt>net/ethernet.hE<gt>> as:"
1796 #: build/C/man3/ether_aton.3:125
1799 "struct ether_addr {\n"
1800 " uint8_t ether_addr_octet[6];\n"
1805 #: build/C/man3/ether_aton.3:127 build/C/man3/rexec.3:142
1811 #: build/C/man3/ether_aton.3:128 build/C/man3/rexec.3:143
1813 msgid "Multithreading (see pthreads(7))"
1817 #: build/C/man3/ether_aton.3:134
1818 msgid "The B<ether_aton>() and B<ether_ntoa>() functions are not thread-safe."
1822 #: build/C/man3/ether_aton.3:143
1824 "The B<ether_ntohost>(), B<ether_hostton>(), B<ether_line>(), "
1825 "B<ether_ntoa_r>() and B<ether_aton_r>() functions are thread-safe."
1829 #: build/C/man3/ether_aton.3:145
1830 msgid "4.3BSD, SunOS."
1834 #: build/C/man3/ether_aton.3:149
1835 msgid "The glibc 2.2.5 implementation of B<ether_line>() is broken."
1839 #: build/C/man3/ether_aton.3:151
1840 msgid "B<ethers>(5)"
1844 #: build/C/man5/gai.conf.5:19
1850 #: build/C/man5/gai.conf.5:19 build/C/man5/nss.5:19
1856 #: build/C/man5/gai.conf.5:22
1857 msgid "gai.conf - getaddrinfo(3) configuration file"
1861 #: build/C/man5/gai.conf.5:36
1863 "A call to B<getaddrinfo>(3) might return multiple answers. According to "
1864 "RFC\\ 3484 these answers must be sorted so that the answer with the highest "
1865 "success rate is first in the list. The RFC provides an algorithm for the "
1866 "sorting. The static rules are not always adequate, though. For this "
1867 "reason, the RFC also requires that system administrators should have the "
1868 "possibility to dynamically change the sorting. For the glibc "
1869 "implementation, this can be achieved with the I</etc/gai.conf> file."
1873 #: build/C/man5/gai.conf.5:40
1875 "Each line in the configuration file consists of a keyword and its "
1876 "parameters. White spaces in any place are ignored. Lines starting with "
1877 "\\(aq#\\(aq are comments and are ignored."
1881 #: build/C/man5/gai.conf.5:42
1882 msgid "The keywords currently recognized are:"
1886 #: build/C/man5/gai.conf.5:42
1888 msgid "B<label> I<netmask> I<precedence>"
1892 #: build/C/man5/gai.conf.5:51
1894 "The value is added to the label table used in the RFC\\ 3484 sorting. If "
1895 "any B<label> definition is present in the configuration file is present, the "
1896 "default table is not used. All the label definitions of the default table "
1897 "which are to be maintained have to be duplicated. Following the keyword, "
1898 "the line has to contain a network mask and a label value."
1902 #: build/C/man5/gai.conf.5:51
1904 msgid "B<precedence> I<netmask> I<precedence>"
1908 #: build/C/man5/gai.conf.5:58
1910 "This keyword is similar to B<label>, but instead the value is added to the "
1911 "precedence table as specified in RFC\\ 3484. Once again, the presence of a "
1912 "single B<precedence> line in the configuration file causes the default table "
1917 #: build/C/man5/gai.conf.5:58
1919 msgid "B<reload> E<lt>B<yes>|B<no>E<gt>"
1923 #: build/C/man5/gai.conf.5:67
1925 "This keyword controls whether a process checks whether the configuration "
1926 "file has been changed since the last time it was read. If the value is "
1927 "\"B<yes>\" the file is re-read. This might cause problems in multithreaded "
1928 "applications and is generally a bad idea. The default is \"B<no>\"."
1932 #: build/C/man5/gai.conf.5:67
1934 msgid "B<scopev4> I<mask> I<value>"
1938 #: build/C/man5/gai.conf.5:72
1940 "Add another rule to the RFC\\ 3484 scope table for IPv4 address. By "
1941 "default, the scope IDs described in section 3.2 in RFC\\ 3438 are used. "
1942 "Changing these defaults should hardly ever be necessary."
1946 #: build/C/man5/gai.conf.5:72 build/C/man3/getaddrinfo.3:582 build/C/man3/gethostbyname.3:293 build/C/man3/getnameinfo.3:197 build/C/man3/getnetent.3:141 build/C/man3/getprotoent.3:134 build/C/man3/getservent.3:153 build/C/man5/host.conf.5:180 build/C/man5/hosts.5:86 build/C/man5/hosts.equiv.5:69 build/C/man5/networks.5:70 build/C/man5/nss.5:98 build/C/man5/nsswitch.conf.5:298 build/C/man5/protocols.5:77 build/C/man5/resolv.conf.5:284 build/C/man3/resolver.3:267 build/C/man5/services.5:185 build/C/man3/setnetgrent.3:88 build/C/man7/udplite.7:126
1952 #: build/C/man5/gai.conf.5:74 build/C/man3/getaddrinfo.3:584
1953 msgid "I</etc/gai.conf>"
1957 #: build/C/man5/gai.conf.5:77
1959 "The default table according to RFC\\ 3484 would be specified with the "
1960 "following configuration file:"
1964 #: build/C/man5/gai.conf.5:89
1969 "label 2002::/16 2\n"
1971 "label ::ffff:0:0/96 4\n"
1972 "precedence ::1/128 50\n"
1973 "precedence ::/0 40\n"
1974 "precedence 2002::/16 30\n"
1975 "precedence ::/96 20\n"
1976 "precedence ::ffff:0:0/96 10\n"
1980 #: build/C/man5/gai.conf.5:96
1981 msgid "B<getaddrinfo(3),> RFC\\ 3484"
1985 #: build/C/man3/getaddrinfo.3:43
1991 #: build/C/man3/getaddrinfo.3:43 build/C/man3/getnameinfo.3:10
1997 #: build/C/man3/getaddrinfo.3:47
1999 "getaddrinfo, freeaddrinfo, gai_strerror - network address and service "
2004 #: build/C/man3/getaddrinfo.3:52 build/C/man3/getipnodebyname.3:35
2007 "B<#include E<lt>sys/types.hE<gt>>\n"
2008 "B<#include E<lt>sys/socket.hE<gt>>\n"
2009 "B<#include E<lt>netdb.hE<gt>>\n"
2013 #: build/C/man3/getaddrinfo.3:56
2016 "B<int getaddrinfo(const char *>I<node>B<, const char *>I<service>B<,>\n"
2017 "B< const struct addrinfo *>I<hints>B<,>\n"
2018 "B< struct addrinfo **>I<res>B<);>\n"
2022 #: build/C/man3/getaddrinfo.3:58
2024 msgid "B<void freeaddrinfo(struct addrinfo *>I<res>B<);>\n"
2028 #: build/C/man3/getaddrinfo.3:60
2030 msgid "B<const char *gai_strerror(int >I<errcode>B<);>\n"
2034 #: build/C/man3/getaddrinfo.3:65 build/C/man3/gethostbyname.3:93 build/C/man3/getnameinfo.3:26 build/C/man3/getnetent_r.3:52 build/C/man3/getprotoent_r.3:49 build/C/man3/getservent_r.3:49 build/C/man3/inet.3:70 build/C/man3/rcmd.3:81 build/C/man3/setnetgrent.3:34
2035 msgid "Feature Test Macro Requirements for glibc (see B<feature_test_macros>(7)):"
2039 #: build/C/man3/getaddrinfo.3:71
2040 msgid "B<getaddrinfo>(), B<freeaddrinfo>(), B<gai_strerror>():"
2044 #: build/C/man3/getaddrinfo.3:73
2045 msgid "_POSIX_C_SOURCE\\ E<gt>=\\ 1 || _XOPEN_SOURCE || _POSIX_SOURCE"
2048 #. .BR getipnodebyname (3),
2049 #. .BR getipnodebyaddr (3),
2051 #: build/C/man3/getaddrinfo.3:100
2053 "Given I<node> and I<service>, which identify an Internet host and a service, "
2054 "B<getaddrinfo>() returns one or more I<addrinfo> structures, each of which "
2055 "contains an Internet address that can be specified in a call to B<bind>(2) "
2056 "or B<connect>(2). The B<getaddrinfo>() function combines the functionality "
2057 "provided by the B<gethostbyname>(3) and B<getservbyname>(3) functions into "
2058 "a single interface, but unlike the latter functions, B<getaddrinfo>() is "
2059 "reentrant and allows programs to eliminate IPv4-versus-IPv6 dependencies."
2063 #: build/C/man3/getaddrinfo.3:106
2065 "The I<addrinfo> structure used by B<getaddrinfo>() contains the following "
2070 #: build/C/man3/getaddrinfo.3:119
2073 "struct addrinfo {\n"
2076 " int ai_socktype;\n"
2077 " int ai_protocol;\n"
2078 " socklen_t ai_addrlen;\n"
2079 " struct sockaddr *ai_addr;\n"
2080 " char *ai_canonname;\n"
2081 " struct addrinfo *ai_next;\n"
2086 #: build/C/man3/getaddrinfo.3:141
2088 "The I<hints> argument points to an I<addrinfo> structure that specifies "
2089 "criteria for selecting the socket address structures returned in the list "
2090 "pointed to by I<res>. If I<hints> is not NULL it points to an I<addrinfo> "
2091 "structure whose I<ai_family>, I<ai_socktype>, and I<ai_protocol> specify "
2092 "criteria that limit the set of socket addresses returned by "
2093 "B<getaddrinfo>(), as follows:"
2097 #: build/C/man3/getaddrinfo.3:141
2099 msgid "I<ai_family>"
2103 #: build/C/man3/getaddrinfo.3:157
2105 "This field specifies the desired address family for the returned addresses. "
2106 "Valid values for this field include B<AF_INET> and B<AF_INET6>. The value "
2107 "B<AF_UNSPEC> indicates that B<getaddrinfo>() should return socket addresses "
2108 "for any address family (either IPv4 or IPv6, for example) that can be used "
2109 "with I<node> and I<service>."
2113 #: build/C/man3/getaddrinfo.3:157
2115 msgid "I<ai_socktype>"
2119 #: build/C/man3/getaddrinfo.3:166
2121 "This field specifies the preferred socket type, for example B<SOCK_STREAM> "
2122 "or B<SOCK_DGRAM>. Specifying 0 in this field indicates that socket "
2123 "addresses of any type can be returned by B<getaddrinfo>()."
2127 #: build/C/man3/getaddrinfo.3:166
2129 msgid "I<ai_protocol>"
2133 #: build/C/man3/getaddrinfo.3:172
2135 "This field specifies the protocol for the returned socket addresses. "
2136 "Specifying 0 in this field indicates that socket addresses with any protocol "
2137 "can be returned by B<getaddrinfo>()."
2141 #: build/C/man3/getaddrinfo.3:172
2147 #: build/C/man3/getaddrinfo.3:176
2149 "This field specifies additional options, described below. Multiple flags "
2150 "are specified by bitwise OR-ing them together."
2154 #: build/C/man3/getaddrinfo.3:194
2156 "All the other fields in the structure pointed to by I<hints> must contain "
2157 "either 0 or a NULL pointer, as appropriate. Specifying I<hints> as NULL is "
2158 "equivalent to setting I<ai_socktype> and I<ai_protocol> to 0; I<ai_family> "
2159 "to B<AF_UNSPEC>; and I<ai_flags> to B<(AI_V4MAPPED\\ |\\ AI_ADDRCONFIG)>."
2163 #: build/C/man3/getaddrinfo.3:212
2165 "I<node> specifies either a numerical network address (for IPv4, "
2166 "numbers-and-dots notation as supported by B<inet_aton>(3); for IPv6, "
2167 "hexadecimal string format as supported by B<inet_pton>(3)), or a network "
2168 "hostname, whose network addresses are looked up and resolved. If "
2169 "I<hints.ai_flags> contains the B<AI_NUMERICHOST> flag then I<node> must be a "
2170 "numerical network address. The B<AI_NUMERICHOST> flag suppresses any "
2171 "potentially lengthy network host address lookups."
2175 #: build/C/man3/getaddrinfo.3:237
2177 "If the B<AI_PASSIVE> flag is specified in I<hints.ai_flags>, and I<node> is "
2178 "NULL, then the returned socket addresses will be suitable for B<bind>(2)ing "
2179 "a socket that will B<accept>(2) connections. The returned socket address "
2180 "will contain the \"wildcard address\" (B<INADDR_ANY> for IPv4 addresses, "
2181 "B<IN6ADDR_ANY_INIT> for IPv6 address). The wildcard address is used by "
2182 "applications (typically servers) that intend to accept connections on any "
2183 "of the hosts's network addresses. If I<node> is not NULL, then the "
2184 "B<AI_PASSIVE> flag is ignored."
2188 #: build/C/man3/getaddrinfo.3:257
2190 "If the B<AI_PASSIVE> flag is not set in I<hints.ai_flags>, then the returned "
2191 "socket addresses will be suitable for use with B<connect>(2), B<sendto>(2), "
2192 "or B<sendmsg>(2). If I<node> is NULL, then the network address will be set "
2193 "to the loopback interface address (B<INADDR_LOOPBACK> for IPv4 addresses, "
2194 "B<IN6ADDR_LOOPBACK_INIT> for IPv6 address); this is used by applications "
2195 "that intend to communicate with peers running on the same host."
2199 #: build/C/man3/getaddrinfo.3:280
2201 "I<service> sets the port in each returned address structure. If this "
2202 "argument is a service name (see B<services>(5)), it is translated to the "
2203 "corresponding port number. This argument can also be specified as a decimal "
2204 "number, which is simply converted to binary. If I<service> is NULL, then "
2205 "the port number of the returned socket addresses will be left "
2206 "uninitialized. If B<AI_NUMERICSERV> is specified in I<hints.ai_flags> and "
2207 "I<service> is not NULL, then I<service> must point to a string containing a "
2208 "numeric port number. This flag is used to inhibit the invocation of a name "
2209 "resolution service in cases where it is known not to be required."
2213 #: build/C/man3/getaddrinfo.3:286
2214 msgid "Either I<node> or I<service>, but not both, may be NULL."
2218 #: build/C/man3/getaddrinfo.3:302
2220 "The B<getaddrinfo>() function allocates and initializes a linked list of "
2221 "I<addrinfo> structures, one for each network address that matches I<node> "
2222 "and I<service>, subject to any restrictions imposed by I<hints>, and returns "
2223 "a pointer to the start of the list in I<res>. The items in the linked list "
2224 "are linked by the I<ai_next> field."
2228 #: build/C/man3/getaddrinfo.3:324
2230 "There are several reasons why the linked list may have more than one "
2231 "I<addrinfo> structure, including: the network host is multihomed, accessible "
2232 "over multiple protocols (e.g., both B<AF_INET> and B<AF_INET6>); or the same "
2233 "service is available from multiple socket types (one B<SOCK_STREAM> address "
2234 "and another B<SOCK_DGRAM> address, for example). Normally, the application "
2235 "should try using the addresses in the order in which they are returned. The "
2236 "sorting function used within B<getaddrinfo>() is defined in RFC\\ 3484; the "
2237 "order can be tweaked for a particular system by editing I</etc/gai.conf> "
2238 "(available since glibc 2.5)."
2241 #. In glibc prior to 2.3.4, the ai_canonname of each addrinfo
2242 #. structure was set pointing to the canonical name; that was
2243 #. more than POSIX.1-2001 specified, or other implementations provided.
2246 #: build/C/man3/getaddrinfo.3:339
2248 "If I<hints.ai_flags> includes the B<AI_CANONNAME> flag, then the "
2249 "I<ai_canonname> field of the first of the I<addrinfo> structures in the "
2250 "returned list is set to point to the official name of the host."
2254 #: build/C/man3/getaddrinfo.3:343
2256 "The remaining fields of each returned I<addrinfo> structure are initialized "
2261 #: build/C/man3/getaddrinfo.3:343 build/C/man3/getaddrinfo.3:366 build/C/man3/getaddrinfo_a.3:191 build/C/man3/getaddrinfo_a.3:195 build/C/man3/getaddrinfo_a.3:197 build/C/man5/nsswitch.conf.5:144 build/C/man5/nsswitch.conf.5:148 build/C/man7/unix.7:74 build/C/man7/unix.7:89 build/C/man7/unix.7:109
2267 #: build/C/man3/getaddrinfo.3:366
2269 "The I<ai_family>, I<ai_socktype>, and I<ai_protocol> fields return the "
2270 "socket creation parameters (i.e., these fields have the same meaning as the "
2271 "corresponding arguments of B<socket>(2)). For example, I<ai_family> might "
2272 "return B<AF_INET> or B<AF_INET6>; I<ai_socktype> might return B<SOCK_DGRAM> "
2273 "or B<SOCK_STREAM>; and I<ai_protocol> returns the protocol for the socket."
2277 #: build/C/man3/getaddrinfo.3:373
2279 "A pointer to the socket address is placed in the I<ai_addr> field, and the "
2280 "length of the socket address, in bytes, is placed in the I<ai_addrlen> "
2285 #: build/C/man3/getaddrinfo.3:385
2287 "If I<hints.ai_flags> includes the B<AI_ADDRCONFIG> flag, then IPv4 addresses "
2288 "are returned in the list pointed to by I<res> only if the local system has "
2289 "at least one IPv4 address configured, and IPv6 addresses are returned only "
2290 "if the local system has at least one IPv6 address configured. The loopback "
2291 "address is not considered for this case as valid as a configured address."
2295 #: build/C/man3/getaddrinfo.3:410
2297 "If I<hints.ai_flags> specifies the B<AI_V4MAPPED> flag, and "
2298 "I<hints.ai_family> was specified as B<AF_INET6>, and no matching IPv6 "
2299 "addresses could be found, then return IPv4-mapped IPv6 addresses in the list "
2300 "pointed to by I<res>. If both B<AI_V4MAPPED> and B<AI_ALL> are specified in "
2301 "I<hints.ai_flags>, then return both IPv6 and IPv4-mapped IPv6 addresses in "
2302 "the list pointed to by I<res>. B<AI_ALL> is ignored if B<AI_V4MAPPED> is "
2303 "not also specified."
2307 #: build/C/man3/getaddrinfo.3:416
2309 "The B<freeaddrinfo>() function frees the memory that was allocated for the "
2310 "dynamically allocated linked list I<res>."
2314 #: build/C/man3/getaddrinfo.3:416
2316 msgid "Extensions to getaddrinfo() for Internationalized Domain Names"
2320 #: build/C/man3/getaddrinfo.3:425
2322 "Starting with glibc 2.3.4, B<getaddrinfo>() has been extended to "
2323 "selectively allow the incoming and outgoing hostnames to be transparently "
2324 "converted to and from the Internationalized Domain Name (IDN) format (see "
2325 "RFC 3490, I<Internationalizing Domain Names in Applications (IDNA)>). Four "
2326 "new flags are defined:"
2330 #: build/C/man3/getaddrinfo.3:425
2336 #: build/C/man3/getaddrinfo.3:431
2338 "If this flag is specified, then the node name given in I<node> is converted "
2339 "to IDN format if necessary. The source encoding is that of the current "
2343 #. Implementation Detail:
2344 #. To minimize effects on system performance the implementation might
2345 #. want to check whether the input string contains any non-ASCII
2346 #. characters. If there are none the IDN step can be skipped completely.
2347 #. On systems which allow not-ASCII safe encodings for a locale this
2348 #. might be a problem.
2350 #: build/C/man3/getaddrinfo.3:443
2352 "If the input name contains non-ASCII characters, then the IDN encoding is "
2353 "used. Those parts of the node name (delimited by dots) that contain "
2354 "non-ASCII characters are encoded using ASCII Compatible Encoding (ACE) "
2355 "before being passed to the name resolution functions."
2359 #: build/C/man3/getaddrinfo.3:443
2361 msgid "B<AI_CANONIDN>"
2365 #: build/C/man3/getaddrinfo.3:455
2367 "After a successful name lookup, and if the B<AI_CANONNAME> flag was "
2368 "specified, B<getaddrinfo>() will return the canonical name of the node "
2369 "corresponding to the I<addrinfo> structure value passed back. The return "
2370 "value is an exact copy of the value returned by the name resolution "
2375 #. Implementation Detail:
2376 #. If no component of the returned name starts with xn\-\- the IDN
2377 #. step can be skipped, therefore avoiding unnecessary slowdowns.
2379 #: build/C/man3/getaddrinfo.3:468
2381 "If the name is encoded using ACE, then it will contain the I<xn--> prefix "
2382 "for one or more components of the name. To convert these components into a "
2383 "readable form the B<AI_CANONIDN> flag can be passed in addition to "
2384 "B<AI_CANONNAME>. The resulting string is encoded using the current locale's "
2389 #: build/C/man3/getaddrinfo.3:468
2391 msgid "B<AI_IDN_ALLOW_UNASSIGNED>, B<AI_IDN_USE_STD3_ASCII_RULES>"
2395 #: build/C/man3/getaddrinfo.3:475 build/C/man3/getnameinfo.3:139
2397 "Setting these flags will enable the IDNA_ALLOW_UNASSIGNED (allow unassigned "
2398 "Unicode code points) and IDNA_USE_STD3_ASCII_RULES (check output to make "
2399 "sure it is a STD3 conforming hostname) flags respectively to be used in the "
2404 #: build/C/man3/getaddrinfo.3:475 build/C/man3/getaddrinfo_a.3:242 build/C/man3/gethostbyname.3:266 build/C/man3/getipnodebyname.3:186 build/C/man3/getnameinfo.3:139 build/C/man3/getnetent.3:130 build/C/man3/getnetent_r.3:118 build/C/man2/getpeername.2:68 build/C/man3/getprotoent.3:123 build/C/man3/getprotoent_r.3:108 build/C/man3/getservent.3:142 build/C/man3/getservent_r.3:107 build/C/man3/inet_ntop.3:83 build/C/man3/inet_pton.3:116 build/C/man3/rcmd.3:239 build/C/man3/resolver.3:245 build/C/man3/setnetgrent.3:86 build/C/man2/shutdown.2:69
2406 msgid "RETURN VALUE"
2409 #. FIXME glibc defines the following additional errors, some which
2410 #. can probably be returned by getaddrinfo(); they need to
2413 #. #define EAI_INPROGRESS -100 /* Processing request in progress. */
2414 #. #define EAI_CANCELED -101 /* Request canceled. */
2415 #. #define EAI_NOTCANCELED -102 /* Request not canceled. */
2416 #. #define EAI_ALLDONE -103 /* All requests done. */
2417 #. #define EAI_INTR -104 /* Interrupted by a signal. */
2418 #. #define EAI_IDN_ENCODE -105 /* IDN encoding failed. */
2421 #: build/C/man3/getaddrinfo.3:489
2423 "B<getaddrinfo>() returns 0 if it succeeds, or one of the following nonzero "
2428 #: build/C/man3/getaddrinfo.3:489
2430 msgid "B<EAI_ADDRFAMILY>"
2435 #: build/C/man3/getaddrinfo.3:494
2437 "The specified network host does not have any network addresses in the "
2438 "requested address family."
2442 #: build/C/man3/getaddrinfo.3:494 build/C/man3/getaddrinfo_a.3:247 build/C/man3/getaddrinfo_a.3:264 build/C/man3/getnameinfo.3:155
2444 msgid "B<EAI_AGAIN>"
2448 #: build/C/man3/getaddrinfo.3:498
2449 msgid "The name server returned a temporary failure indication. Try again later."
2453 #: build/C/man3/getaddrinfo.3:498 build/C/man3/getnameinfo.3:159
2455 msgid "B<EAI_BADFLAGS>"
2459 #: build/C/man3/getaddrinfo.3:508
2461 "I<hints.ai_flags> contains invalid flags; or, I<hints.ai_flags> included "
2462 "B<AI_CANONNAME> and I<name> was NULL."
2466 #: build/C/man3/getaddrinfo.3:508 build/C/man3/getnameinfo.3:164
2472 #: build/C/man3/getaddrinfo.3:511
2473 msgid "The name server returned a permanent failure indication."
2477 #: build/C/man3/getaddrinfo.3:511 build/C/man3/getnameinfo.3:167
2479 msgid "B<EAI_FAMILY>"
2483 #: build/C/man3/getaddrinfo.3:514
2484 msgid "The requested address family is not supported."
2488 #: build/C/man3/getaddrinfo.3:514 build/C/man3/getaddrinfo_a.3:252 build/C/man3/getnameinfo.3:171
2490 msgid "B<EAI_MEMORY>"
2494 #: build/C/man3/getaddrinfo.3:517 build/C/man3/getaddrinfo_a.3:255 build/C/man3/getnameinfo.3:174 build/C/man7/unix.7:359
2495 msgid "Out of memory."
2499 #: build/C/man3/getaddrinfo.3:517
2501 msgid "B<EAI_NODATA>"
2506 #: build/C/man3/getaddrinfo.3:522
2508 "The specified network host exists, but does not have any network addresses "
2513 #: build/C/man3/getaddrinfo.3:522 build/C/man3/getnameinfo.3:174
2515 msgid "B<EAI_NONAME>"
2519 #: build/C/man3/getaddrinfo.3:539
2521 "The I<node> or I<service> is not known; or both I<node> and I<service> are "
2522 "NULL; or B<AI_NUMERICSERV> was specified in I<hints.ai_flags> and I<service> "
2523 "was not a numeric port-number string."
2527 #: build/C/man3/getaddrinfo.3:539
2529 msgid "B<EAI_SERVICE>"
2533 #: build/C/man3/getaddrinfo.3:560
2535 "The requested service is not available for the requested socket type. It "
2536 "may be available through another socket type. For example, this error could "
2537 "occur if I<service> was \"shell\" (a service available only on stream "
2538 "sockets), and either I<hints.ai_protocol> was B<IPPROTO_UDP>, or "
2539 "I<hints.ai_socktype> was B<SOCK_DGRAM>; or the error could occur if "
2540 "I<service> was not NULL, and I<hints.ai_socktype> was B<SOCK_RAW> (a socket "
2541 "type that does not support the concept of services)."
2545 #: build/C/man3/getaddrinfo.3:560
2547 msgid "B<EAI_SOCKTYPE>"
2551 #: build/C/man3/getaddrinfo.3:572
2553 "The requested socket type is not supported. This could occur, for example, "
2554 "if I<hints.ai_socktype> and I<hints.ai_protocol> are inconsistent (e.g., "
2555 "B<SOCK_DGRAM> and B<IPPROTO_TCP>, respectively)."
2559 #: build/C/man3/getaddrinfo.3:572 build/C/man3/getaddrinfo_a.3:255 build/C/man3/getnameinfo.3:187
2561 msgid "B<EAI_SYSTEM>"
2565 #: build/C/man3/getaddrinfo.3:577
2566 msgid "Other system error, check I<errno> for details."
2570 #: build/C/man3/getaddrinfo.3:582
2572 "The B<gai_strerror>() function translates these error codes to a human "
2573 "readable string, suitable for error reporting."
2577 #: build/C/man3/getaddrinfo.3:589
2578 msgid "POSIX.1-2001. The B<getaddrinfo>() function is documented in RFC\\ 2553."
2582 #: build/C/man3/getaddrinfo.3:594
2584 "B<getaddrinfo>() supports the I<address>B<%>I<scope-id> notation for "
2585 "specifying the IPv6 scope-ID."
2589 #: build/C/man3/getaddrinfo.3:602
2591 "B<AI_ADDRCONFIG>, B<AI_ALL>, and B<AI_V4MAPPED> are available since glibc "
2592 "2.3.3. B<AI_NUMERICSERV> is available since glibc 2.3.4."
2596 #: build/C/man3/getaddrinfo.3:612
2598 "According to POSIX.1-2001, specifying I<hints> as NULL should cause "
2599 "I<ai_flags> to be assumed as 0. The GNU C library instead assumes a value "
2600 "of B<(AI_V4MAPPED\\ |\\ AI_ADDRCONFIG)> for this case, since this value is "
2601 "considered an improvement on the specification."
2604 #. getnameinfo.3 refers to this example
2605 #. socket.2 refers to this example
2606 #. bind.2 refers to this example
2607 #. connect.2 refers to this example
2608 #. recvfrom.2 refers to this example
2609 #. sendto.2 refers to this example
2611 #: build/C/man3/getaddrinfo.3:626
2613 "The following programs demonstrate the use of B<getaddrinfo>(), "
2614 "B<gai_strerror>(), B<freeaddrinfo>(), and B<getnameinfo>(3). The programs "
2615 "are an echo server and client for UDP datagrams."
2619 #: build/C/man3/getaddrinfo.3:626
2621 msgid "Server program"
2625 #: build/C/man3/getaddrinfo.3:636
2628 "#include E<lt>sys/types.hE<gt>\n"
2629 "#include E<lt>stdio.hE<gt>\n"
2630 "#include E<lt>stdlib.hE<gt>\n"
2631 "#include E<lt>unistd.hE<gt>\n"
2632 "#include E<lt>string.hE<gt>\n"
2633 "#include E<lt>sys/socket.hE<gt>\n"
2634 "#include E<lt>netdb.hE<gt>\n"
2638 #: build/C/man3/getaddrinfo.3:638 build/C/man3/getaddrinfo.3:733
2640 msgid "#define BUF_SIZE 500\n"
2644 #: build/C/man3/getaddrinfo.3:649
2648 "main(int argc, char *argv[])\n"
2650 " struct addrinfo hints;\n"
2651 " struct addrinfo *result, *rp;\n"
2653 " struct sockaddr_storage peer_addr;\n"
2654 " socklen_t peer_addr_len;\n"
2656 " char buf[BUF_SIZE];\n"
2660 #: build/C/man3/getaddrinfo.3:654
2663 " if (argc != 2) {\n"
2664 " fprintf(stderr, \"Usage: %s port\\en\", argv[0]);\n"
2665 " exit(EXIT_FAILURE);\n"
2670 #: build/C/man3/getaddrinfo.3:663
2673 " memset(&hints, 0, sizeof(struct addrinfo));\n"
2674 " hints.ai_family = AF_UNSPEC; /* Allow IPv4 or IPv6 */\n"
2675 " hints.ai_socktype = SOCK_DGRAM; /* Datagram socket */\n"
2676 " hints.ai_flags = AI_PASSIVE; /* For wildcard IP address */\n"
2677 " hints.ai_protocol = 0; /* Any protocol */\n"
2678 " hints.ai_canonname = NULL;\n"
2679 " hints.ai_addr = NULL;\n"
2680 " hints.ai_next = NULL;\n"
2684 #: build/C/man3/getaddrinfo.3:669
2687 " s = getaddrinfo(NULL, argv[1], &hints, &result);\n"
2689 " fprintf(stderr, \"getaddrinfo: %s\\en\", gai_strerror(s));\n"
2690 " exit(EXIT_FAILURE);\n"
2695 #: build/C/man3/getaddrinfo.3:674
2698 " /* getaddrinfo() returns a list of address structures.\n"
2699 " Try each address until we successfully bind(2).\n"
2700 " If socket(2) (or bind(2)) fails, we (close the socket\n"
2701 " and) try the next address. */\n"
2705 #: build/C/man3/getaddrinfo.3:680
2708 " for (rp = result; rp != NULL; rp = rp-E<gt>ai_next) {\n"
2709 " sfd = socket(rp-E<gt>ai_family, rp-E<gt>ai_socktype,\n"
2710 " rp-E<gt>ai_protocol);\n"
2716 #: build/C/man3/getaddrinfo.3:683
2719 " if (bind(sfd, rp-E<gt>ai_addr, rp-E<gt>ai_addrlen) == 0)\n"
2720 " break; /* Success */\n"
2724 #: build/C/man3/getaddrinfo.3:686 build/C/man3/getaddrinfo.3:779
2732 #: build/C/man3/getaddrinfo.3:691
2735 " if (rp == NULL) { /* No address succeeded */\n"
2736 " fprintf(stderr, \"Could not bind\\en\");\n"
2737 " exit(EXIT_FAILURE);\n"
2742 #: build/C/man3/getaddrinfo.3:693 build/C/man3/getaddrinfo.3:786
2744 msgid " freeaddrinfo(result); /* No longer needed */\n"
2748 #: build/C/man3/getaddrinfo.3:695
2750 msgid " /* Read datagrams and echo them back to sender */\n"
2754 #: build/C/man3/getaddrinfo.3:702
2758 " peer_addr_len = sizeof(struct sockaddr_storage);\n"
2759 " nread = recvfrom(sfd, buf, BUF_SIZE, 0,\n"
2760 " (struct sockaddr *) &peer_addr, &peer_addr_len);\n"
2761 " if (nread == -1)\n"
2762 " continue; /* Ignore failed request */\n"
2766 #: build/C/man3/getaddrinfo.3:704
2768 msgid " char host[NI_MAXHOST], service[NI_MAXSERV];\n"
2772 #: build/C/man3/getaddrinfo.3:713
2775 " s = getnameinfo((struct sockaddr *) &peer_addr,\n"
2776 " peer_addr_len, host, NI_MAXHOST,\n"
2777 " service, NI_MAXSERV, NI_NUMERICSERV);\n"
2779 " printf(\"Received %ld bytes from %s:%s\\en\",\n"
2780 " (long) nread, host, service);\n"
2782 " fprintf(stderr, \"getnameinfo: %s\\en\", gai_strerror(s));\n"
2786 #: build/C/man3/getaddrinfo.3:720
2789 " if (sendto(sfd, buf, nread, 0,\n"
2790 " (struct sockaddr *) &peer_addr,\n"
2791 " peer_addr_len) != nread)\n"
2792 " fprintf(stderr, \"Error sending response\\en\");\n"
2798 #: build/C/man3/getaddrinfo.3:721
2800 msgid "Client program"
2804 #: build/C/man3/getaddrinfo.3:731
2807 "#include E<lt>sys/types.hE<gt>\n"
2808 "#include E<lt>sys/socket.hE<gt>\n"
2809 "#include E<lt>netdb.hE<gt>\n"
2810 "#include E<lt>stdio.hE<gt>\n"
2811 "#include E<lt>stdlib.hE<gt>\n"
2812 "#include E<lt>unistd.hE<gt>\n"
2813 "#include E<lt>string.hE<gt>\n"
2817 #: build/C/man3/getaddrinfo.3:743
2821 "main(int argc, char *argv[])\n"
2823 " struct addrinfo hints;\n"
2824 " struct addrinfo *result, *rp;\n"
2828 " char buf[BUF_SIZE];\n"
2832 #: build/C/man3/getaddrinfo.3:748
2835 " if (argc E<lt> 3) {\n"
2836 " fprintf(stderr, \"Usage: %s host port msg...\\en\", argv[0]);\n"
2837 " exit(EXIT_FAILURE);\n"
2842 #: build/C/man3/getaddrinfo.3:750
2844 msgid " /* Obtain address(es) matching host/port */\n"
2848 #: build/C/man3/getaddrinfo.3:756
2851 " memset(&hints, 0, sizeof(struct addrinfo));\n"
2852 " hints.ai_family = AF_UNSPEC; /* Allow IPv4 or IPv6 */\n"
2853 " hints.ai_socktype = SOCK_DGRAM; /* Datagram socket */\n"
2854 " hints.ai_flags = 0;\n"
2855 " hints.ai_protocol = 0; /* Any protocol */\n"
2859 #: build/C/man3/getaddrinfo.3:762
2862 " s = getaddrinfo(argv[1], argv[2], &hints, &result);\n"
2864 " fprintf(stderr, \"getaddrinfo: %s\\en\", gai_strerror(s));\n"
2865 " exit(EXIT_FAILURE);\n"
2870 #: build/C/man3/getaddrinfo.3:767
2873 " /* getaddrinfo() returns a list of address structures.\n"
2874 " Try each address until we successfully connect(2).\n"
2875 " If socket(2) (or connect(2)) fails, we (close the socket\n"
2876 " and) try the next address. */\n"
2880 #: build/C/man3/getaddrinfo.3:773
2883 " for (rp = result; rp != NULL; rp = rp-E<gt>ai_next) {\n"
2884 " sfd = socket(rp-E<gt>ai_family, rp-E<gt>ai_socktype,\n"
2885 " rp-E<gt>ai_protocol);\n"
2891 #: build/C/man3/getaddrinfo.3:776
2894 " if (connect(sfd, rp-E<gt>ai_addr, rp-E<gt>ai_addrlen) != -1)\n"
2895 " break; /* Success */\n"
2899 #: build/C/man3/getaddrinfo.3:784
2902 " if (rp == NULL) { /* No address succeeded */\n"
2903 " fprintf(stderr, \"Could not connect\\en\");\n"
2904 " exit(EXIT_FAILURE);\n"
2909 #: build/C/man3/getaddrinfo.3:789
2912 " /* Send remaining command-line arguments as separate\n"
2913 " datagrams, and read responses from server */\n"
2917 #: build/C/man3/getaddrinfo.3:793
2920 " for (j = 3; j E<lt> argc; j++) {\n"
2921 " len = strlen(argv[j]) + 1;\n"
2922 " /* +1 for terminating null byte */\n"
2926 #: build/C/man3/getaddrinfo.3:799
2929 " if (len + 1 E<gt> BUF_SIZE) {\n"
2930 " fprintf(stderr,\n"
2931 " \"Ignoring long message in argument %d\\en\", j);\n"
2937 #: build/C/man3/getaddrinfo.3:804
2940 " if (write(sfd, argv[j], len) != len) {\n"
2941 " fprintf(stderr, \"partial/failed write\\en\");\n"
2942 " exit(EXIT_FAILURE);\n"
2947 #: build/C/man3/getaddrinfo.3:810
2950 " nread = read(sfd, buf, BUF_SIZE);\n"
2951 " if (nread == -1) {\n"
2952 " perror(\"read\");\n"
2953 " exit(EXIT_FAILURE);\n"
2958 #: build/C/man3/getaddrinfo.3:813
2961 " printf(\"Received %ld bytes: %s\\en\", (long) nread, buf);\n"
2965 #. .BR getipnodebyaddr (3),
2966 #. .BR getipnodebyname (3),
2968 #: build/C/man3/getaddrinfo.3:827
2970 "B<getaddrinfo_a>(3), B<gethostbyname>(3), B<getnameinfo>(3), B<inet>(3), "
2971 "B<gai.conf>(5), B<hostname>(7), B<ip>(7)"
2975 #: build/C/man3/getaddrinfo_a.3:29
2977 msgid "GETADDRINFO_A"
2981 #: build/C/man3/getaddrinfo_a.3:29
2987 #: build/C/man3/getaddrinfo_a.3:33
2989 "getaddrinfo_a, gai_suspend, gai_error, gai_cancel - asynchronous network "
2990 "address and service translation"
2994 #: build/C/man3/getaddrinfo_a.3:37
2997 "B<#define _GNU_SOURCE> /* See feature_test_macros(7) */\n"
2998 "B<#include E<lt>netdb.hE<gt>>\n"
3002 #: build/C/man3/getaddrinfo_a.3:40
3005 "B<int getaddrinfo_a(int >I<mode>B<, struct gaicb *>I<list[]>B<,>\n"
3006 "B< int >I<nitems>B<, struct sigevent *>I<sevp>B<);>\n"
3010 #: build/C/man3/getaddrinfo_a.3:43
3013 "B<int gai_suspend(struct gaicb *>I<list[]>B<, int >I<nitems>B<,>\n"
3014 "B< struct timespec *>I<timeout>B<);>\n"
3018 #: build/C/man3/getaddrinfo_a.3:45
3020 msgid "B<int gai_error(struct gaicb *>I<req>B<);>\n"
3024 #: build/C/man3/getaddrinfo_a.3:47
3026 msgid "B<int gai_cancel(struct gaicb *>I<req>B<);>\n"
3030 #: build/C/man3/getaddrinfo_a.3:49
3032 msgid "Link with I<-lanl>.\n"
3036 #: build/C/man3/getaddrinfo_a.3:57
3038 "The B<getaddrinfo_a>() function performs the same task as "
3039 "B<getaddrinfo>(3), but allows multiple name look-ups to be performed "
3040 "asynchronously, with optional notification on completion of look-up "
3045 #: build/C/man3/getaddrinfo_a.3:61
3046 msgid "The I<mode> argument has one of the following values:"
3050 #: build/C/man3/getaddrinfo_a.3:61
3056 #: build/C/man3/getaddrinfo_a.3:65
3058 "Perform the look-ups synchronously. The call blocks until the look-ups have "
3063 #: build/C/man3/getaddrinfo_a.3:65
3065 msgid "B<GAI_NOWAIT>"
3069 #: build/C/man3/getaddrinfo_a.3:73
3071 "Perform the look-ups asynchronously. The call returns immediately, and the "
3072 "requests are resolved in the background. See the discussion of the I<sevp> "
3077 #: build/C/man3/getaddrinfo_a.3:88
3079 "The array I<list> specifies the look-up requests to process. The I<nitems> "
3080 "argument specifies the number of elements in I<list>. The requested look-up "
3081 "operations are started in parallel. NULL elements in I<list> are ignored. "
3082 "Each request is described by a I<gaicb> structure, defined as follows:"
3086 #: build/C/man3/getaddrinfo_a.3:97
3090 " const char *ar_name;\n"
3091 " const char *ar_service;\n"
3092 " const struct addrinfo *ar_request;\n"
3093 " struct addrinfo *ar_result;\n"
3098 #: build/C/man3/getaddrinfo_a.3:128
3100 "The elements of this structure correspond to the arguments of "
3101 "B<getaddrinfo>(3). Thus, I<ar_name> corresponds to the I<node> argument and "
3102 "I<ar_service> to the I<service> argument, identifying an Internet host and a "
3103 "service. The I<ar_request> element corresponds to the I<hints> argument, "
3104 "specifying the criteria for selecting the returned socket address "
3105 "structures. Finally, I<ar_result> corresponds to the I<res> argument; you "
3106 "do not need to initialize this element, it will be automatically set when "
3107 "the request is resolved. The I<addrinfo> structure referenced by the last "
3108 "two elements is described in B<getaddrinfo>(3)."
3112 #: build/C/man3/getaddrinfo_a.3:144
3114 "When I<mode> is specified as B<GAI_NOWAIT>, notifications about resolved "
3115 "requests can be obtained by employing the I<sigevent> structure pointed to "
3116 "by the I<sevp> argument. For the definition and general details of this "
3117 "structure, see B<sigevent>(7). The I<sevp-E<gt>sigev_notify> field can have "
3118 "the following values:"
3122 #: build/C/man3/getaddrinfo_a.3:144
3124 msgid "B<SIGEV_NONE>"
3128 #: build/C/man3/getaddrinfo_a.3:147
3129 msgid "Don't provide any notification."
3133 #: build/C/man3/getaddrinfo_a.3:147
3135 msgid "B<SIGEV_SIGNAL>"
3138 #. si_pid and si_uid are also set, to the values of the calling process,
3139 #. which doesn't provide useful information, so we'll skip mentioning it.
3141 #: build/C/man3/getaddrinfo_a.3:163
3143 "When a look-up completes, generate the signal I<sigev_signo> for the "
3144 "process. See B<sigevent>(7) for general details. The I<si_code> field of "
3145 "the I<siginfo_t> structure will be set to B<SI_ASYNCNL>."
3149 #: build/C/man3/getaddrinfo_a.3:163
3151 msgid "B<SIGEV_THREAD>"
3155 #: build/C/man3/getaddrinfo_a.3:171
3157 "When a look-up completes, invoke I<sigev_notify_function> as if it were the "
3158 "start function of a new thread. See B<sigevent>(7) for details."
3162 #: build/C/man3/getaddrinfo_a.3:180
3164 "For B<SIGEV_SIGNAL> and B<SIGEV_THREAD>, it may be useful to point "
3165 "I<sevp-E<gt>sigev_value.sival_ptr> to I<list>."
3169 #: build/C/man3/getaddrinfo_a.3:191
3171 "The B<gai_suspend>() function suspends execution of the calling thread, "
3172 "waiting for the completion of one or more requests in the array I<list>. "
3173 "The I<nitems> argument specifies the size of the array I<list>. The call "
3174 "blocks until one of the following occurs:"
3178 #: build/C/man3/getaddrinfo_a.3:195
3179 msgid "One or more of the operations in I<list> completes."
3183 #: build/C/man3/getaddrinfo_a.3:197
3184 msgid "The call is interrupted by a signal that is caught."
3188 #: build/C/man3/getaddrinfo_a.3:210
3190 "The time interval specified in I<timeout> elapses. This argument specifies "
3191 "a timeout in seconds plus nanoseconds (see B<nanosleep>(2) for details of "
3192 "the I<timespec> structure). If I<timeout> is NULL, then the call blocks "
3193 "indefinitely (until one of the events above occurs)."
3197 #: build/C/man3/getaddrinfo_a.3:215
3199 "No explicit indication of which request was completed is given; you must "
3200 "determine which request(s) have completed by iterating with B<gai_error>() "
3201 "over the list of requests."
3205 #: build/C/man3/getaddrinfo_a.3:225
3207 "The B<gai_error>() function returns the status of the request I<req>: "
3208 "either B<EAI_INPROGRESS> if the request was not completed yet, 0 if it was "
3209 "handled successfully, or an error code if the request could not be resolved."
3213 #: build/C/man3/getaddrinfo_a.3:242
3215 "The B<gai_cancel>() function cancels the request I<req>. If the request "
3216 "has been canceled successfully, the error status of the request will be set "
3217 "to B<EAI_CANCELLED> and normal asynchronous notification will be performed. "
3218 "The request cannot be canceled if it is currently being processed; in that "
3219 "case, it will be handled as if B<gai_cancel>() has never been called. If "
3220 "I<req> is NULL, an attempt is made to cancel all outstanding requests that "
3221 "the process has made."
3225 #: build/C/man3/getaddrinfo_a.3:247
3227 "The B<getaddrinfo_a>() function returns 0 if all of the requests have been "
3228 "enqueued successfully, or one of the following nonzero error codes:"
3232 #: build/C/man3/getaddrinfo_a.3:252
3234 "The resources necessary to enqueue the look-up requests were not available. "
3235 "The application may check the error status of each request to determine "
3236 "which ones failed."
3240 #: build/C/man3/getaddrinfo_a.3:259
3241 msgid "I<mode> is invalid."
3245 #: build/C/man3/getaddrinfo_a.3:264
3247 "The B<gai_suspend>() function returns 0 if at least one of the listed "
3248 "requests has been completed. Otherwise, it returns one of the following "
3249 "nonzero error codes:"
3253 #: build/C/man3/getaddrinfo_a.3:267
3254 msgid "The given timeout expired before any of the requests could be completed."
3258 #: build/C/man3/getaddrinfo_a.3:267 build/C/man3/getaddrinfo_a.3:297
3260 msgid "B<EAI_ALLDONE>"
3264 #: build/C/man3/getaddrinfo_a.3:270
3265 msgid "There were no actual requests given to the function."
3269 #: build/C/man3/getaddrinfo_a.3:270
3275 #: build/C/man3/getaddrinfo_a.3:275
3277 "A signal has interrupted the function. Note that this interruption might "
3278 "have been caused by signal notification of some completed look-up request."
3282 #: build/C/man3/getaddrinfo_a.3:287
3284 "The B<gai_error>() function can return B<EAI_INPROGRESS> for an unfinished "
3285 "look-up request, 0 for a successfully completed look-up (as described "
3286 "above), one of the error codes that could be returned by B<getaddrinfo>(3), "
3287 "or the error code B<EAI_CANCELLED> if the request has been canceled "
3288 "explicitly before it could be finished."
3292 #: build/C/man3/getaddrinfo_a.3:291
3293 msgid "The B<gai_cancel>() function can return one of these values:"
3297 #: build/C/man3/getaddrinfo_a.3:291
3299 msgid "B<EAI_CANCELLED>"
3303 #: build/C/man3/getaddrinfo_a.3:294
3304 msgid "The request has been canceled successfully."
3308 #: build/C/man3/getaddrinfo_a.3:294
3310 msgid "B<EAI_NOTCANCELLED>"
3314 #: build/C/man3/getaddrinfo_a.3:297
3315 msgid "The request has not been canceled."
3319 #: build/C/man3/getaddrinfo_a.3:300
3320 msgid "The request has already completed."
3324 #: build/C/man3/getaddrinfo_a.3:305 build/C/man3/getnameinfo.3:197
3326 "The B<gai_strerror>(3) function translates these error codes to a human "
3327 "readable string, suitable for error reporting."
3331 #: build/C/man3/getaddrinfo_a.3:308
3333 "These functions are GNU extensions; they first appeared in glibc in version "
3338 #: build/C/man3/getaddrinfo_a.3:314
3340 "The interface of B<getaddrinfo_a>() was modeled after the B<lio_listio>(3) "
3345 #: build/C/man3/getaddrinfo_a.3:318
3347 "Two examples are provided: a simple example that resolves several requests "
3348 "in parallel synchronously, and a complex example showing some of the "
3349 "asynchronous capabilities."
3353 #: build/C/man3/getaddrinfo_a.3:318
3355 msgid "Synchronous example"
3359 #: build/C/man3/getaddrinfo_a.3:323
3361 "The program below simply resolves several hostnames in parallel, giving a "
3362 "speed-up compared to resolving the hostnames sequentially using "
3363 "B<getaddrinfo>(3). The program might be used like this:"
3367 #: build/C/man3/getaddrinfo_a.3:330
3370 "$ B<./a.out ftp.us.kernel.org enoent.linuxfoundation.org gnu.cz>\n"
3371 "ftp.us.kernel.org: 128.30.2.36\n"
3372 "enoent.linuxfoundation.org: Name or service not known\n"
3373 "gnu.cz: 87.236.197.13\n"
3377 #: build/C/man3/getaddrinfo_a.3:334
3378 msgid "Here is the program source code"
3382 #: build/C/man3/getaddrinfo_a.3:341 build/C/man3/getaddrinfo_a.3:430
3385 "#define _GNU_SOURCE\n"
3386 "#include E<lt>netdb.hE<gt>\n"
3387 "#include E<lt>stdio.hE<gt>\n"
3388 "#include E<lt>stdlib.hE<gt>\n"
3389 "#include E<lt>string.hE<gt>\n"
3393 #: build/C/man3/getaddrinfo_a.3:349
3397 "main(int argc, char *argv[])\n"
3400 " struct gaicb *reqs[argc - 1];\n"
3401 " char host[NI_MAXHOST];\n"
3402 " struct addrinfo *res;\n"
3406 #: build/C/man3/getaddrinfo_a.3:354
3409 " if (argc E<lt> 2) {\n"
3410 " fprintf(stderr, \"Usage: %s HOST...\\en\", argv[0]);\n"
3411 " exit(EXIT_FAILURE);\n"
3416 #: build/C/man3/getaddrinfo_a.3:364
3419 " for (i = 0; i E<lt> argc - 1; i++) {\n"
3420 " reqs[i] = malloc(sizeof(*reqs[0]));\n"
3421 " if (reqs[i] == NULL) {\n"
3422 " perror(\"malloc\");\n"
3423 " exit(EXIT_FAILURE);\n"
3425 " memset(reqs[i], 0, sizeof(*reqs[0]));\n"
3426 " reqs[i]-E<gt>ar_name = argv[i + 1];\n"
3431 #: build/C/man3/getaddrinfo_a.3:371
3434 " ret = getaddrinfo_a(GAI_WAIT, reqs, argc - 1, NULL);\n"
3435 " if (ret != 0) {\n"
3436 " fprintf(stderr, \"getaddrinfo_a() failed: %s\\en\",\n"
3437 " gai_strerror(ret));\n"
3438 " exit(EXIT_FAILURE);\n"
3443 #: build/C/man3/getaddrinfo_a.3:377
3446 " for (i = 0; i E<lt> argc - 1; i++) {\n"
3447 " printf(\"%s: \", reqs[i]-E<gt>ar_name);\n"
3448 " ret = gai_error(reqs[i]);\n"
3449 " if (ret == 0) {\n"
3450 " res = reqs[i]-E<gt>ar_result;\n"
3454 #: build/C/man3/getaddrinfo_a.3:387
3457 " ret = getnameinfo(res-E<gt>ai_addr, res-E<gt>ai_addrlen,\n"
3458 " host, sizeof(host),\n"
3459 " NULL, 0, NI_NUMERICHOST);\n"
3460 " if (ret != 0) {\n"
3461 " fprintf(stderr, \"getnameinfo() failed: %s\\en\",\n"
3462 " gai_strerror(ret));\n"
3463 " exit(EXIT_FAILURE);\n"
3469 #: build/C/man3/getaddrinfo_a.3:394
3473 " puts(gai_strerror(ret));\n"
3476 " exit(EXIT_SUCCESS);\n"
3481 #: build/C/man3/getaddrinfo_a.3:395
3483 msgid "Asynchronous example"
3487 #: build/C/man3/getaddrinfo_a.3:400
3489 "This example shows a simple interactive B<getaddrinfo_a>() front-end. The "
3490 "notification facility is not demonstrated."
3494 #: build/C/man3/getaddrinfo_a.3:402
3495 msgid "An example session might look like this:"
3499 #: build/C/man3/getaddrinfo_a.3:419
3503 "E<gt> a ftp.us.kernel.org enoent.linuxfoundation.org gnu.cz\n"
3505 "[2] gnu.cz: Request not canceled\n"
3507 "[00] ftp.us.kernel.org: Finished\n"
3509 "[00] ftp.us.kernel.org: 216.165.129.139\n"
3510 "[01] enoent.linuxfoundation.org: Processing request in progress\n"
3511 "[02] gnu.cz: 87.236.197.13\n"
3513 "[00] ftp.us.kernel.org: 216.165.129.139\n"
3514 "[01] enoent.linuxfoundation.org: Name or service not known\n"
3515 "[02] gnu.cz: 87.236.197.13\n"
3519 #: build/C/man3/getaddrinfo_a.3:423
3520 msgid "The program source is as follows:"
3524 #: build/C/man3/getaddrinfo_a.3:433
3527 "static struct gaicb **reqs = NULL;\n"
3528 "static int nreqs = 0;\n"
3532 #: build/C/man3/getaddrinfo_a.3:438
3538 " static char buf[256];\n"
3542 #: build/C/man3/getaddrinfo_a.3:442
3545 " fputs(\"E<gt> \", stdout); fflush(stdout);\n"
3546 " if (fgets(buf, sizeof(buf), stdin) == NULL)\n"
3551 #: build/C/man3/getaddrinfo_a.3:445
3554 " if (buf[strlen(buf) - 1] == \\(aq\\en\\(aq)\n"
3555 " buf[strlen(buf) - 1] = 0;\n"
3559 #: build/C/man3/getaddrinfo_a.3:448
3567 #: build/C/man3/getaddrinfo_a.3:456
3570 "/* Add requests for specified hostnames */\n"
3572 "add_requests(void)\n"
3574 " int nreqs_base = nreqs;\n"
3580 #: build/C/man3/getaddrinfo_a.3:460
3583 " while ((host = strtok(NULL, \" \"))) {\n"
3585 " reqs = realloc(reqs, nreqs * sizeof(reqs[0]));\n"
3589 #: build/C/man3/getaddrinfo_a.3:464
3592 " reqs[nreqs - 1] = calloc(1, sizeof(*reqs[0]));\n"
3593 " reqs[nreqs - 1]-E<gt>ar_name = strdup(host);\n"
3598 #: build/C/man3/getaddrinfo_a.3:466
3600 msgid " /* Queue nreqs_base..nreqs requests. */\n"
3604 #: build/C/man3/getaddrinfo_a.3:475
3607 " ret = getaddrinfo_a(GAI_NOWAIT, &reqs[nreqs_base],\n"
3608 " nreqs - nreqs_base, NULL);\n"
3610 " fprintf(stderr, \"getaddrinfo_a() failed: %s\\en\",\n"
3611 " gai_strerror(ret));\n"
3612 " exit(EXIT_FAILURE);\n"
3618 #: build/C/man3/getaddrinfo_a.3:484
3621 "/* Wait until at least one of specified requests completes */\n"
3623 "wait_requests(void)\n"
3627 " struct gaicb const **wait_reqs = calloc(nreqs, sizeof(*wait_reqs));\n"
3628 " /* NULL elements are ignored by gai_suspend(). */\n"
3632 #: build/C/man3/getaddrinfo_a.3:487 build/C/man3/getaddrinfo_a.3:524
3635 " while ((id = strtok(NULL, \" \")) != NULL) {\n"
3640 #: build/C/man3/getaddrinfo_a.3:492 build/C/man3/getaddrinfo_a.3:529
3643 " if (n E<gt>= nreqs) {\n"
3644 " printf(\"Bad request number: %s\\en\", id);\n"
3650 #: build/C/man3/getaddrinfo_a.3:495
3653 " wait_reqs[n] = reqs[n];\n"
3658 #: build/C/man3/getaddrinfo_a.3:501
3661 " ret = gai_suspend(wait_reqs, nreqs, NULL);\n"
3663 " printf(\"gai_suspend(): %s\\en\", gai_strerror(ret));\n"
3669 #: build/C/man3/getaddrinfo_a.3:505
3672 " for (i = 0; i E<lt> nreqs; i++) {\n"
3673 " if (wait_reqs[i] == NULL)\n"
3678 #: build/C/man3/getaddrinfo_a.3:509
3681 " ret = gai_error(reqs[i]);\n"
3682 " if (ret == EAI_INPROGRESS)\n"
3687 #: build/C/man3/getaddrinfo_a.3:514
3690 " printf(\"[%02d] %s: %s\\en\", i, reqs[i]-E<gt>ar_name,\n"
3691 " ret == 0 ? \"Finished\" : gai_strerror(ret));\n"
3697 #: build/C/man3/getaddrinfo_a.3:521
3700 "/* Cancel specified requests */\n"
3702 "cancel_requests(void)\n"
3709 #: build/C/man3/getaddrinfo_a.3:535
3712 " ret = gai_cancel(reqs[n]);\n"
3713 " printf(\"[%s] %s: %s\\en\", id, reqs[atoi(id)]-E<gt>ar_name,\n"
3714 " gai_strerror(ret));\n"
3720 #: build/C/man3/getaddrinfo_a.3:543
3723 "/* List all requests */\n"
3725 "list_requests(void)\n"
3728 " char host[NI_MAXHOST];\n"
3729 " struct addrinfo *res;\n"
3733 #: build/C/man3/getaddrinfo_a.3:547
3736 " for (i = 0; i E<lt> nreqs; i++) {\n"
3737 " printf(\"[%02d] %s: \", i, reqs[i]-E<gt>ar_name);\n"
3738 " ret = gai_error(reqs[i]);\n"
3742 #: build/C/man3/getaddrinfo_a.3:550
3746 " res = reqs[i]-E<gt>ar_result;\n"
3750 #: build/C/man3/getaddrinfo_a.3:565
3753 " ret = getnameinfo(res-E<gt>ai_addr, res-E<gt>ai_addrlen,\n"
3754 " host, sizeof(host),\n"
3755 " NULL, 0, NI_NUMERICHOST);\n"
3757 " fprintf(stderr, \"getnameinfo() failed: %s\\en\",\n"
3758 " gai_strerror(ret));\n"
3759 " exit(EXIT_FAILURE);\n"
3763 " puts(gai_strerror(ret));\n"
3770 #: build/C/man3/getaddrinfo_a.3:571
3774 "main(int argc, char *argv[])\n"
3781 #: build/C/man3/getaddrinfo_a.3:574
3784 " while ((cmdline = getcmd()) != NULL) {\n"
3785 " cmd = strtok(cmdline, \" \");\n"
3789 #: build/C/man3/getaddrinfo_a.3:599
3792 " if (cmd == NULL) {\n"
3793 " list_requests();\n"
3795 " switch (cmd[0]) {\n"
3796 " case \\(aqa\\(aq:\n"
3797 " add_requests();\n"
3799 " case \\(aqw\\(aq:\n"
3800 " wait_requests();\n"
3802 " case \\(aqc\\(aq:\n"
3803 " cancel_requests();\n"
3805 " case \\(aql\\(aq:\n"
3806 " list_requests();\n"
3809 " fprintf(stderr, \"Bad command: %c\\en\", cmd[0]);\n"
3814 " exit(EXIT_SUCCESS);\n"
3819 #: build/C/man3/getaddrinfo_a.3:607
3821 "B<getaddrinfo>(3), B<inet>(3), B<lio_listio>(3), B<hostname>(7), B<ip>(7), "
3826 #: build/C/man1/getent.1:24
3832 #: build/C/man1/getent.1:24
3838 #: build/C/man1/getent.1:24
3840 msgid "User Commands"
3844 #: build/C/man1/getent.1:27
3845 msgid "getent - get entries from Name Service Switch libraries"
3849 #: build/C/man1/getent.1:30
3850 msgid "B<getent> I<database> [I<key> ...]"
3854 #: build/C/man1/getent.1:45
3856 "The B<getent> command displays entries from databases supported by the Name "
3857 "Service Switch libraries, which are configured in I</etc/nsswitch.conf>. If "
3858 "one or more I<key> arguments are provided, then only the entries that match "
3859 "the supplied keys will be displayed. Otherwise, if no I<key> is provided, "
3860 "all entries will be displayed (unless the database does not support "
3865 #: build/C/man1/getent.1:49
3867 "The I<database> may be any of those supported by the GNU C Library, listed "
3872 #: build/C/man1/getent.1:50
3878 #: build/C/man1/getent.1:71
3880 "When no I<key> is provided, use B<sethostent>(3), B<gethostent>(3), and "
3881 "B<endhostent>(3) to enumerate the hosts database. This is identical to "
3882 "using B<hosts>. When one or more I<key> arguments are provided, pass each "
3883 "I<key> in succession to B<getaddrinfo>(3) with the address family "
3884 "B<AF_UNSPEC>, enumerating each socket address structure returned."
3888 #: build/C/man1/getent.1:71
3894 #: build/C/man1/getent.1:77
3895 msgid "Same as B<ahosts>, but use the address family B<AF_INET>."
3899 #: build/C/man1/getent.1:77
3905 #: build/C/man1/getent.1:88
3907 "Same as B<ahosts>, but use the address family B<AF_INET6>. The call to "
3908 "B<getaddrinfo>(3) in this case includes the B<AI_V4MAPPED> flag."
3912 #: build/C/man1/getent.1:88 build/C/man5/nsswitch.conf.5:44
3918 #: build/C/man1/getent.1:105
3920 "When no I<key> is provided, use B<setaliasent>(3), B<getaliasent>(3), and "
3921 "B<endaliasent>(3) to enumerate the aliases database. When one or more "
3922 "I<key> arguments are provided, pass each I<key> in succession to "
3923 "B<getaliasbyname>(3) and display the result."
3927 #: build/C/man1/getent.1:105 build/C/man5/nsswitch.conf.5:49
3933 #: build/C/man1/getent.1:121
3935 "When one or more I<key> arguments are provided, pass each I<key> in "
3936 "succession to B<ether_aton>(3) and B<ether_hostton>(3) until a result is "
3937 "obtained, and display the result. Enumeration is not supported on "
3938 "B<ethers>, so a I<key> must be provided."
3942 #: build/C/man1/getent.1:121 build/C/man5/nsswitch.conf.5:52
3948 #: build/C/man1/getent.1:142
3950 "When no I<key> is provided, use B<setgrent>(3), B<getgrent>(3), and "
3951 "B<endgrent>(3) to enumerate the group database. When one or more I<key> "
3952 "arguments are provided, pass each numeric I<key> to B<getgrgid>(3) and each "
3953 "nonnumeric I<key> to B<getgrnam>(3) and display the result."
3957 #: build/C/man1/getent.1:142
3963 #: build/C/man1/getent.1:159
3965 "When no I<key> is provided, use B<setsgent>(3), B<getsgent>(3), and "
3966 "B<endsgent>(3) to enumerate the gshadow database. When one or more I<key> "
3967 "arguments are provided, pass each I<key> in succession to B<getsgnam>(3) "
3968 "and display the result."
3972 #: build/C/man1/getent.1:159 build/C/man5/nsswitch.conf.5:57
3978 #: build/C/man1/getent.1:182
3980 "When no I<key> is provided, use B<sethostent>(3), B<gethostent>(3), and "
3981 "B<endhostent>(3) to enumerate the hosts database. When one or more I<key> "
3982 "arguments are provided, pass each I<key> to B<gethostbyaddr>(3) or "
3983 "B<gethostbyname2>(3), depending on whether a call to B<inet_pton>(3) "
3984 "indicates that the I<key> is an IPv6 or IPv4 address or not, and display the "
3989 #: build/C/man1/getent.1:182 build/C/man5/nsswitch.conf.5:62
3991 msgid "B<initgroups>"
3995 #: build/C/man1/getent.1:196
3997 "When one or more I<key> arguments are provided, pass each I<key> in "
3998 "succession to B<getgrouplist>(3) and display the result. Enumeration is "
3999 "not supported on B<initgroups>, so a I<key> must be provided."
4003 #: build/C/man1/getent.1:196 build/C/man5/nsswitch.conf.5:67
4009 #: build/C/man1/getent.1:222
4011 "When one I<key> is provided, pass the I<key> to B<setnetgrent>(3) and, "
4012 "using B<getnetgrent>(3) display the resulting string triple (I<hostname>, "
4013 "I<username>, I<domainname>). Alternatively, three I<keys> may be provided, "
4014 "which are interpreted as the I<hostname>, I<username> and I<domainname> to "
4015 "match to a netgroup name via B<innetgr>(3). Enumeration is not supported on "
4016 "B<netgroup>, so either one or three I<keys> must be provided."
4020 #: build/C/man1/getent.1:222 build/C/man5/nsswitch.conf.5:71
4026 #: build/C/man1/getent.1:243
4028 "When no I<key> is provided, use B<setnetent>(3), B<getnetent>(3), and "
4029 "B<endnetent>(3) to enumerate the networks database. When one or more "
4030 "I<key> arguments are provided, pass each numeric I<key> to "
4031 "B<getnetbyaddr>(3) and each nonnumeric I<key> to B<getnetbyname>(3) and "
4032 "display the result."
4036 #: build/C/man1/getent.1:243 build/C/man5/nsswitch.conf.5:76
4042 #: build/C/man1/getent.1:264
4044 "When no I<key> is provided, use B<setpwent>(3), B<getpwent>(3), and "
4045 "B<endpwent>(3) to enumerate the passwd database. When one or more I<key> "
4046 "arguments are provided, pass each numeric I<key> to B<getpwuid>(3) and each "
4047 "nonnumeric I<key> to B<getpwnam>(3) and display the result."
4051 #: build/C/man1/getent.1:264 build/C/man5/nsswitch.conf.5:81
4053 msgid "B<protocols>"
4057 #: build/C/man1/getent.1:285
4059 "When no I<key> is provided, use B<setprotoent>(3), B<getprotoent>(3), and "
4060 "B<endprotoent>(3) to enumerate the protocols database. When one or more "
4061 "I<key> arguments are provided, pass each numeric I<key> to "
4062 "B<getprotobynumber>(3) and each nonnumeric I<key> to B<getprotobyname>(3) "
4063 "and display the result."
4067 #: build/C/man1/getent.1:285 build/C/man5/nsswitch.conf.5:89
4073 #: build/C/man1/getent.1:306
4075 "When no I<key> is provided, use B<setrpcent>(3), B<getrpcent>(3), and "
4076 "B<endrpcent>(3) to enumerate the rpc database. When one or more I<key> "
4077 "arguments are provided, pass each numeric I<key> to B<getrpcbynumber>(3) "
4078 "and each nonnumeric I<key> to B<getrpcbyname>(3) and display the result."
4082 #: build/C/man1/getent.1:306 build/C/man5/nsswitch.conf.5:94
4088 #: build/C/man1/getent.1:327
4090 "When no I<key> is provided, use B<setservent>(3), B<getservent>(3), and "
4091 "B<endservent>(3) to enumerate the services database. When one or more "
4092 "I<key> arguments are provided, pass each numeric I<key> to "
4093 "B<getservbynumber>(3) and each nonnumeric I<key> to B<getservbyname>(3) "
4094 "and display the result."
4098 #: build/C/man1/getent.1:327 build/C/man5/nsswitch.conf.5:99
4104 #: build/C/man1/getent.1:344
4106 "When no I<key> is provided, use B<setspent>(3), B<getspent>(3), and "
4107 "B<endspent>(3) to enumerate the shadow database. When one or more I<key> "
4108 "arguments are provided, pass each I<key> in succession to B<getspnam>(3) "
4109 "and display the result."
4113 #: build/C/man1/getent.1:345
4119 #: build/C/man1/getent.1:348
4120 msgid "One of the following exit values can be returned by B<getent>:"
4124 #: build/C/man1/getent.1:349
4130 #: build/C/man1/getent.1:352
4131 msgid "Command completed successfully."
4135 #: build/C/man1/getent.1:352
4141 #: build/C/man1/getent.1:357
4142 msgid "Missing arguments, or I<database> unknown."
4146 #: build/C/man1/getent.1:357
4152 #: build/C/man1/getent.1:363
4153 msgid "One or more supplied I<key> could not be found in the I<database>."
4157 #: build/C/man1/getent.1:363
4163 #: build/C/man1/getent.1:367
4164 msgid "Enumeration not supported on this I<database>."
4168 #: build/C/man1/getent.1:370
4169 msgid "B<nsswitch.conf>(5)"
4173 #: build/C/man3/gethostbyname.3:38
4175 msgid "GETHOSTBYNAME"
4179 #: build/C/man3/gethostbyname.3:38
4185 #: build/C/man3/gethostbyname.3:46
4187 "gethostbyname, gethostbyaddr, sethostent, gethostent, endhostent, h_errno, "
4188 "herror, hstrerror, gethostbyaddr_r, gethostbyname2, gethostbyname2_r, "
4189 "gethostbyname_r, gethostent_r - get network host entry"
4193 #: build/C/man3/gethostbyname.3:50
4196 "B<#include E<lt>netdb.hE<gt>>\n"
4197 "B<extern int h_errno;>\n"
4201 #: build/C/man3/gethostbyname.3:52
4203 msgid "B<struct hostent *gethostbyname(const char *>I<name>B<);>\n"
4207 #: build/C/man3/gethostbyname.3:56
4210 "B<#include E<lt>sys/socket.hE<gt>> /* for AF_INET */\n"
4211 "B<struct hostent *gethostbyaddr(const void *>I<addr>B<,>\n"
4212 "B< socklen_t >I<len>B<, int >I<type>B<);>\n"
4216 #: build/C/man3/gethostbyname.3:58
4218 msgid "B<void sethostent(int >I<stayopen>B<);>\n"
4222 #: build/C/man3/gethostbyname.3:60
4224 msgid "B<void endhostent(void);>\n"
4228 #: build/C/man3/gethostbyname.3:62
4230 msgid "B<void herror(const char *>I<s>B<);>\n"
4234 #: build/C/man3/gethostbyname.3:64
4236 msgid "B<const char *hstrerror(int >I<err>B<);>\n"
4240 #: build/C/man3/gethostbyname.3:66
4242 msgid "/* System V/POSIX extension */\n"
4246 #: build/C/man3/gethostbyname.3:68
4248 msgid "B<struct hostent *gethostent(void);>\n"
4252 #: build/C/man3/gethostbyname.3:72
4254 msgid "B<struct hostent *gethostbyname2(const char *>I<name>B<, int >I<af>B<);>\n"
4258 #: build/C/man3/gethostbyname.3:76
4261 "B<int gethostent_r(>\n"
4262 "B< struct hostent *>I<ret>B<, char *>I<buf>B<, size_t "
4264 "B< struct hostent **>I<result>B<, int *>I<h_errnop>B<);>\n"
4268 #: build/C/man3/gethostbyname.3:80
4271 "B<int gethostbyaddr_r(const void *>I<addr>B<, socklen_t >I<len>B<, int "
4273 "B< struct hostent *>I<ret>B<, char *>I<buf>B<, size_t "
4275 "B< struct hostent **>I<result>B<, int *>I<h_errnop>B<);>\n"
4279 #: build/C/man3/gethostbyname.3:84
4282 "B<int gethostbyname_r(const char *>I<name>B<,>\n"
4283 "B< struct hostent *>I<ret>B<, char *>I<buf>B<, size_t "
4285 "B< struct hostent **>I<result>B<, int *>I<h_errnop>B<);>\n"
4289 #: build/C/man3/gethostbyname.3:88
4292 "B<int gethostbyname2_r(const char *>I<name>B<, int >I<af,>\n"
4293 "B< struct hostent *>I<ret>B<, char *>I<buf>B<, size_t "
4295 "B< struct hostent **>I<result>B<, int *>I<h_errnop>B<);>\n"
4299 #: build/C/man3/gethostbyname.3:102
4301 "B<gethostbyname2>(), B<gethostent_r>(), B<gethostbyaddr_r>(), "
4302 "B<gethostbyname_r>(), B<gethostbyname2_r>():"
4306 #: build/C/man3/gethostbyname.3:104 build/C/man3/getnetent_r.3:60 build/C/man3/getprotoent_r.3:57 build/C/man3/getservent_r.3:57
4307 msgid "_BSD_SOURCE || _SVID_SOURCE"
4311 #: build/C/man3/gethostbyname.3:108
4312 msgid "B<herror>(), B<hstrerror>():"
4316 #: build/C/man3/gethostbyname.3:109
4318 msgid "Since glibc 2.8:"
4322 #: build/C/man3/gethostbyname.3:112
4323 msgid "_BSD_SOURCE || _SVID_SOURCE || _GNU_SOURCE"
4327 #: build/C/man3/gethostbyname.3:112
4329 msgid "Before glibc 2.8:"
4333 #: build/C/man3/gethostbyname.3:115
4338 #: build/C/man3/gethostbyname.3:129
4340 "The B<gethostbyname*>() and B<gethostbyaddr*>() functions are obsolete. "
4341 "Applications should use B<getaddrinfo>(3) and B<getnameinfo>(3) instead."
4345 #: build/C/man3/gethostbyname.3:170
4347 "The B<gethostbyname>() function returns a structure of type I<hostent> for "
4348 "the given host I<name>. Here I<name> is either a hostname, or an IPv4 "
4349 "address in standard dot notation (as for B<inet_addr>(3)), or an IPv6 "
4350 "address in colon (and possibly dot) notation. (See RFC\\ 1884 for the "
4351 "description of IPv6 addresses.) If I<name> is an IPv4 or IPv6 address, no "
4352 "lookup is performed and B<gethostbyname>() simply copies I<name> into the "
4353 "I<h_name> field and its I<struct in_addr> equivalent into the "
4354 "I<h_addr_list[0]> field of the returned I<hostent> structure. If I<name> "
4355 "doesn't end in a dot and the environment variable B<HOSTALIASES> is set, the "
4356 "alias file pointed to by B<HOSTALIASES> will first be searched for I<name> "
4357 "(see B<hostname>(7) for the file format). The current domain and its "
4358 "parents are searched unless I<name> ends in a dot."
4362 #: build/C/man3/gethostbyname.3:186
4364 "The B<gethostbyaddr>() function returns a structure of type I<hostent> for "
4365 "the given host address I<addr> of length I<len> and address type I<type>. "
4366 "Valid address types are B<AF_INET> and B<AF_INET6>. The host address "
4367 "argument is a pointer to a struct of a type depending on the address type, "
4368 "for example a I<struct in_addr *> (probably obtained via a call to "
4369 "B<inet_addr>(3)) for address type B<AF_INET>."
4373 #: build/C/man3/gethostbyname.3:193
4375 "The B<sethostent>() function specifies, if I<stayopen> is true (1), that a "
4376 "connected TCP socket should be used for the name server queries and that the "
4377 "connection should remain open during successive queries. Otherwise, name "
4378 "server queries will use UDP datagrams."
4382 #: build/C/man3/gethostbyname.3:198
4384 "The B<endhostent>() function ends the use of a TCP connection for name "
4389 #: build/C/man3/gethostbyname.3:203
4391 "The (obsolete) B<herror>() function prints the error message associated "
4392 "with the current value of I<h_errno> on I<stderr>."
4396 #: build/C/man3/gethostbyname.3:208
4398 "The (obsolete) B<hstrerror>() function takes an error number (typically "
4399 "I<h_errno>) and returns the corresponding message string."
4403 #. .BR resolv+ (8)).
4405 #: build/C/man3/gethostbyname.3:225
4407 "The domain name queries carried out by B<gethostbyname>() and "
4408 "B<gethostbyaddr>() use a combination of any or all of the name server "
4409 "B<named>(8), a broken out line from I</etc/hosts>, and the Network "
4410 "Information Service (NIS or YP), depending upon the contents of the I<order> "
4411 "line in I</etc/host.conf>. The default action is to query B<named>(8), "
4412 "followed by I</etc/hosts>."
4416 #: build/C/man3/gethostbyname.3:227
4417 msgid "The I<hostent> structure is defined in I<E<lt>netdb.hE<gt>> as follows:"
4421 #: build/C/man3/gethostbyname.3:239
4424 "struct hostent {\n"
4425 " char *h_name; /* official name of host */\n"
4426 " char **h_aliases; /* alias list */\n"
4427 " int h_addrtype; /* host address type */\n"
4428 " int h_length; /* length of address */\n"
4429 " char **h_addr_list; /* list of addresses */\n"
4431 "#define h_addr h_addr_list[0] /* for backward compatibility */\n"
4435 #: build/C/man3/gethostbyname.3:243
4436 msgid "The members of the I<hostent> structure are:"
4440 #: build/C/man3/gethostbyname.3:243 build/C/man3/getipnodebyname.3:210
4446 #: build/C/man3/gethostbyname.3:246
4447 msgid "The official name of the host."
4451 #: build/C/man3/gethostbyname.3:246 build/C/man3/getipnodebyname.3:213
4453 msgid "I<h_aliases>"
4457 #: build/C/man3/gethostbyname.3:249
4458 msgid "An array of alternative names for the host, terminated by a NULL pointer."
4462 #: build/C/man3/gethostbyname.3:249 build/C/man3/getipnodebyname.3:217
4464 msgid "I<h_addrtype>"
4468 #: build/C/man3/gethostbyname.3:256
4469 msgid "The type of address; always B<AF_INET> or B<AF_INET6> at present."
4473 #: build/C/man3/gethostbyname.3:256 build/C/man3/getipnodebyname.3:239
4479 #: build/C/man3/gethostbyname.3:259
4480 msgid "The length of the address in bytes."
4484 #: build/C/man3/gethostbyname.3:259 build/C/man3/getipnodebyname.3:253
4486 msgid "I<h_addr_list>"
4490 #: build/C/man3/gethostbyname.3:263
4492 "An array of pointers to network addresses for the host (in network byte "
4493 "order), terminated by a NULL pointer."
4497 #: build/C/man3/gethostbyname.3:263
4503 #: build/C/man3/gethostbyname.3:266
4504 msgid "The first address in I<h_addr_list> for backward compatibility."
4508 #: build/C/man3/gethostbyname.3:278
4510 "The B<gethostbyname>() and B<gethostbyaddr>() functions return the "
4511 "I<hostent> structure or a NULL pointer if an error occurs. On error, the "
4512 "I<h_errno> variable holds an error number. When non-NULL, the return value "
4513 "may point at static data, see the notes below."
4517 #: build/C/man3/gethostbyname.3:280
4518 msgid "The variable I<h_errno> can have the following values:"
4522 #: build/C/man3/gethostbyname.3:280 build/C/man3/getipnodebyname.3:190
4524 msgid "B<HOST_NOT_FOUND>"
4528 #: build/C/man3/gethostbyname.3:283
4529 msgid "The specified host is unknown."
4533 #: build/C/man3/gethostbyname.3:283
4535 msgid "B<NO_ADDRESS> or B<NO_DATA>"
4539 #: build/C/man3/gethostbyname.3:286
4540 msgid "The requested name is valid but does not have an IP address."
4544 #: build/C/man3/gethostbyname.3:286 build/C/man3/getipnodebyname.3:199
4546 msgid "B<NO_RECOVERY>"
4550 #: build/C/man3/gethostbyname.3:289
4551 msgid "A nonrecoverable name server error occurred."
4555 #: build/C/man3/gethostbyname.3:289 build/C/man3/getipnodebyname.3:202
4557 msgid "B<TRY_AGAIN>"
4561 #: build/C/man3/gethostbyname.3:293
4563 "A temporary error occurred on an authoritative name server. Try again "
4568 #: build/C/man3/gethostbyname.3:294 build/C/man5/host.conf.5:181
4570 msgid "I</etc/host.conf>"
4574 #: build/C/man3/gethostbyname.3:297
4575 msgid "resolver configuration file"
4579 #: build/C/man3/gethostbyname.3:297 build/C/man5/host.conf.5:187 build/C/man5/hosts.5:88
4581 msgid "I</etc/hosts>"
4585 #: build/C/man3/gethostbyname.3:300
4586 msgid "host database file"
4590 #: build/C/man3/gethostbyname.3:300 build/C/man5/nsswitch.conf.5:306 build/C/man3/setnetgrent.3:92
4592 msgid "I</etc/nsswitch.conf>"
4596 #: build/C/man3/gethostbyname.3:303
4597 msgid "name service switch configuration"
4601 #: build/C/man3/gethostbyname.3:327
4603 "POSIX.1-2001 specifies B<gethostbyname>(), B<gethostbyaddr>(), "
4604 "B<sethostent>(), B<endhostent>(), B<gethostent>(), and I<h_errno>; "
4605 "B<gethostbyname>(), B<gethostbyaddr>(), and I<h_errno> are marked "
4606 "obsolescent in that standard. POSIX.1-2008 removes the specifications of "
4607 "B<gethostbyname>(), B<gethostbyaddr>(), and I<h_errno>, recommending the use "
4608 "of B<getaddrinfo>(3) and B<getnameinfo>(3) instead."
4612 #: build/C/man3/gethostbyname.3:337
4614 "The functions B<gethostbyname>() and B<gethostbyaddr>() may return "
4615 "pointers to static data, which may be overwritten by later calls. Copying "
4616 "the I<struct hostent> does not suffice, since it contains pointers; a deep "
4621 #: build/C/man3/gethostbyname.3:361
4623 "In the original BSD implementation the I<len> argument of B<gethostbyname>() "
4624 "was an I<int>. The SUSv2 standard is buggy and declares the I<len> argument "
4625 "of B<gethostbyaddr>() to be of type I<size_t>. (That is wrong, because it "
4626 "has to be I<int>, and I<size_t> is not. POSIX.1-2001 makes it I<socklen_t>, "
4627 "which is OK.) See also B<accept>(2)."
4631 #: build/C/man3/gethostbyname.3:367
4633 "The BSD prototype for B<gethostbyaddr>() uses I<const char\\ *> for the "
4638 #: build/C/man3/gethostbyname.3:367
4640 msgid "System V/POSIX extension"
4643 #. e.g., Linux, FreeBSD, UnixWare, HP-UX
4644 #. e.g., FreeBSD, AIX
4646 #: build/C/man3/gethostbyname.3:384
4648 "POSIX requires the B<gethostent>() call, that should return the next entry "
4649 "in the host data base. When using DNS/BIND this does not make much sense, "
4650 "but it may be reasonable if the host data base is a file that can be read "
4651 "line by line. On many systems a routine of this name reads from the file "
4652 "I</etc/hosts>. It may be available only when the library was built without "
4653 "DNS support. The glibc version will ignore ipv6 entries. This function is "
4654 "not reentrant, and glibc adds a reentrant version B<gethostent_r>()."
4658 #: build/C/man3/gethostbyname.3:384
4660 msgid "GNU extensions"
4664 #: build/C/man3/gethostbyname.3:390
4666 "Glibc2 also has a B<gethostbyname2>() that works like B<gethostbyname>(), "
4667 "but permits to specify the address family to which the address must belong."
4671 #: build/C/man3/gethostbyname.3:424
4673 "Glibc2 also has reentrant versions B<gethostent_r>(), B<gethostbyaddr_r>(), "
4674 "B<gethostbyname_r>() and B<gethostbyname2_r>(). The caller supplies a "
4675 "I<hostent> structure I<ret> which will be filled in on success, and a "
4676 "temporary work buffer I<buf> of size I<buflen>. After the call, I<result> "
4677 "will point to the result on success. In case of an error or if no entry is "
4678 "found I<result> will be NULL. The functions return 0 on success and a "
4679 "nonzero error number on failure. In addition to the errors returned by the "
4680 "nonreentrant versions of these functions, if I<buf> is too small, the "
4681 "functions will return B<ERANGE>, and the call should be retried with a "
4682 "larger buffer. The global variable I<h_errno> is not modified, but the "
4683 "address of a variable in which to store error numbers is passed in "
4687 #. http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=482973
4689 #: build/C/man3/gethostbyname.3:429
4691 "B<gethostbyname>() does not recognize components of a dotted IPv4 address "
4692 "string that are expressed in hexadecimal."
4695 #. .BR getipnodebyaddr (3),
4696 #. .BR getipnodebyname (3),
4699 #: build/C/man3/gethostbyname.3:443
4701 "B<getaddrinfo>(3), B<getnameinfo>(3), B<inet>(3), B<inet_ntop>(3), "
4702 "B<inet_pton>(3), B<resolver>(3), B<hosts>(5), B<nsswitch.conf>(5), "
4703 "B<hostname>(7), B<named>(8)"
4707 #: build/C/man3/getipnodebyname.3:26
4709 msgid "GETIPNODEBYNAME"
4713 #: build/C/man3/getipnodebyname.3:26
4719 #: build/C/man3/getipnodebyname.3:30
4721 "getipnodebyname, getipnodebyaddr, freehostent - get network hostnames and "
4726 #: build/C/man3/getipnodebyname.3:38
4729 "B<struct hostent *getipnodebyname(const char *>I<name>B<, int >I<af>B<,>\n"
4730 "B< int >I<flags>B<, int *>I<error_num>B<);>\n"
4734 #: build/C/man3/getipnodebyname.3:41
4737 "B<struct hostent *getipnodebyaddr(const void *>I<addr>B<, size_t "
4739 "B< int >I<af>B<, int *>I<error_num>B<);>\n"
4743 #: build/C/man3/getipnodebyname.3:43
4745 msgid "B<void freehostent(struct hostent *>I<ip>B<);>\n"
4749 #: build/C/man3/getipnodebyname.3:51
4751 "These functions are deprecated (and unavailable in glibc). Use "
4752 "B<getaddrinfo>(3) and B<getnameinfo>(3) instead."
4756 #: build/C/man3/getipnodebyname.3:59
4758 "The B<getipnodebyname>() and B<getipnodebyaddr>() functions return the "
4759 "names and addresses of a network host. These functions return a pointer to "
4760 "the following structure:"
4764 #: build/C/man3/getipnodebyname.3:69
4767 "struct hostent {\n"
4769 " char **h_aliases;\n"
4770 " int h_addrtype;\n"
4772 " char **h_addr_list;\n"
4777 #: build/C/man3/getipnodebyname.3:82
4779 "These functions replace the B<gethostbyname>(3) and B<gethostbyaddr>(3) "
4780 "functions, which could access only the IPv4 network address family. The "
4781 "B<getipnodebyname>() and B<getipnodebyaddr>() functions can access "
4782 "multiple network address families."
4786 #: build/C/man3/getipnodebyname.3:93
4788 "Unlike the B<gethostby> functions, these functions return pointers to "
4789 "dynamically allocated memory. The B<freehostent>() function is used to "
4790 "release the dynamically allocated memory after the caller no longer needs "
4791 "the I<hostent> structure."
4795 #: build/C/man3/getipnodebyname.3:93
4797 msgid "getipnodebyname() arguments"
4801 #: build/C/man3/getipnodebyname.3:104
4803 "The B<getipnodebyname>() function looks up network addresses for the host "
4804 "specified by the I<name> argument. The I<af> argument specifies one of the "
4809 #: build/C/man3/getipnodebyname.3:104 build/C/man3/getipnodebyname.3:166 build/C/man3/inet_ntop.3:57 build/C/man3/inet_pton.3:53
4815 #: build/C/man3/getipnodebyname.3:110
4817 "The I<name> argument points to a dotted-quad IPv4 address or a name of an "
4818 "IPv4 network host."
4822 #: build/C/man3/getipnodebyname.3:110 build/C/man3/getipnodebyname.3:176 build/C/man3/inet_ntop.3:70 build/C/man3/inet_pton.3:67
4828 #: build/C/man3/getipnodebyname.3:116
4830 "The I<name> argument points to a hexadecimal IPv6 address or a name of an "
4831 "IPv6 network host."
4835 #: build/C/man3/getipnodebyname.3:125
4837 "The I<flags> argument specifies additional options. More than one option "
4838 "can be specified by bitwise OR-ing them together. I<flags> should be set to "
4839 "0 if no options are desired."
4843 #: build/C/man3/getipnodebyname.3:125
4845 msgid "B<AI_V4MAPPED>"
4849 #: build/C/man3/getipnodebyname.3:132
4851 "This flag is used with B<AF_INET6> to request a query for IPv4 addresses "
4852 "instead of IPv6 addresses; the IPv4 addresses will be mapped to IPv6 "
4857 #: build/C/man3/getipnodebyname.3:132
4863 #: build/C/man3/getipnodebyname.3:138
4865 "This flag is used with B<AI_V4MAPPED> to request a query for both IPv4 and "
4866 "IPv6 addresses. Any IPv4 address found will be mapped to an IPv6 address."
4870 #: build/C/man3/getipnodebyname.3:138
4872 msgid "B<AI_ADDRCONFIG>"
4876 #: build/C/man3/getipnodebyname.3:150
4878 "This flag is used with B<AF_INET6> to further request that queries for IPv6 "
4879 "addresses should not be made unless the system has at least one IPv6 address "
4880 "assigned to a network interface, and that queries for IPv4 addresses should "
4881 "not be made unless the system has at least one IPv4 address assigned to a "
4882 "network interface. This flag may be used by itself or with the "
4883 "B<AI_V4MAPPED> flag."
4887 #: build/C/man3/getipnodebyname.3:150
4889 msgid "B<AI_DEFAULT>"
4893 #: build/C/man3/getipnodebyname.3:154
4894 msgid "This flag is equivalent to B<(AI_ADDRCONFIG | AI_V4MAPPED)>."
4898 #: build/C/man3/getipnodebyname.3:154
4900 msgid "getipnodebyaddr() arguments"
4904 #: build/C/man3/getipnodebyname.3:166
4906 "The B<getipnodebyaddr>() function looks up the name of the host whose "
4907 "network address is specified by the I<addr> argument. The I<af> argument "
4908 "specifies one of the following values:"
4912 #: build/C/man3/getipnodebyname.3:176
4914 "The I<addr> argument points to a I<struct in_addr> and I<len> must be set to "
4915 "I<sizeof(struct in_addr)>."
4919 #: build/C/man3/getipnodebyname.3:186
4921 "The I<addr> argument points to a I<struct in6_addr> and I<len> must be set "
4922 "to I<sizeof(struct in6_addr)>."
4926 #: build/C/man3/getipnodebyname.3:190
4928 "A NULL pointer is returned if an error occurred, and I<error_num> will "
4929 "contain an error code from the following list:"
4933 #: build/C/man3/getipnodebyname.3:193
4934 msgid "The hostname or network address was not found."
4938 #: build/C/man3/getipnodebyname.3:193
4940 msgid "B<NO_ADDRESS>"
4944 #: build/C/man3/getipnodebyname.3:199
4946 "The domain name server recognized the network address or name, but no answer "
4947 "was returned. This can happen if the network host has only IPv4 addresses "
4948 "and a request has been made for IPv6 information only, or vice versa."
4952 #: build/C/man3/getipnodebyname.3:202
4953 msgid "The domain name server returned a permanent failure response."
4957 #: build/C/man3/getipnodebyname.3:206
4959 "The domain name server returned a temporary failure response. You might "
4960 "have better luck next time."
4964 #: build/C/man3/getipnodebyname.3:210
4966 "A successful query returns a pointer to a I<hostent> structure that contains "
4967 "the following fields:"
4971 #: build/C/man3/getipnodebyname.3:213
4972 msgid "This is the official name of this network host."
4976 #: build/C/man3/getipnodebyname.3:217
4978 "This is an array of pointers to unofficial aliases for the same host. The "
4979 "array is terminated by a NULL pointer."
4983 #: build/C/man3/getipnodebyname.3:239
4985 "This is a copy of the I<af> argument to B<getipnodebyname>() or "
4986 "B<getipnodebyaddr>(). I<h_addrtype> will always be B<AF_INET> if the I<af> "
4987 "argument was B<AF_INET>. I<h_addrtype> will always be B<AF_INET6> if the "
4988 "I<af> argument was B<AF_INET6>."
4992 #: build/C/man3/getipnodebyname.3:253
4994 "This field will be set to I<sizeof(struct in_addr)> if I<h_addrtype> is "
4995 "B<AF_INET>, and to I<sizeof(struct in6_addr)> if I<h_addrtype> is "
5000 #: build/C/man3/getipnodebyname.3:258
5002 "This is an array of one or more pointers to network address structures for "
5003 "the network host. The array is terminated by a NULL pointer."
5006 #. Not in POSIX.1-2001.
5008 #: build/C/man3/getipnodebyname.3:261
5013 #: build/C/man3/getipnodebyname.3:266
5015 "These functions were present in glibc 2.1.91-95, but were removed again. "
5016 "Several UNIX-like systems support them, but all call them deprecated."
5020 #: build/C/man3/getipnodebyname.3:271
5021 msgid "B<getaddrinfo>(3), B<getnameinfo>(3), B<inet_ntop>(3), B<inet_pton>(3)"
5025 #: build/C/man3/getnameinfo.3:10
5031 #: build/C/man3/getnameinfo.3:13
5032 msgid "getnameinfo - address-to-name translation in protocol-independent manner"
5036 #: build/C/man3/getnameinfo.3:17
5039 "B<#include E<lt>sys/socket.hE<gt>>\n"
5040 "B<#include E<lt>netdb.hE<gt>>\n"
5044 #: build/C/man3/getnameinfo.3:21
5047 "B<int getnameinfo(const struct sockaddr *>I<sa>B<, socklen_t >I<salen>B<,>\n"
5048 "B< char *>I<host>B<, size_t >I<hostlen>B<,>\n"
5049 "B< char *>I<serv>B<, size_t >I<servlen>B<, int "
5054 #: build/C/man3/getnameinfo.3:31
5056 "B<getnameinfo>(): _POSIX_C_SOURCE\\ E<gt>=\\ 1 || _XOPEN_SOURCE || "
5061 #: build/C/man3/getnameinfo.3:47
5063 "The B<getnameinfo>() function is the inverse of B<getaddrinfo>(3): it "
5064 "converts a socket address to a corresponding host and service, in a "
5065 "protocol-independent manner. It combines the functionality of "
5066 "B<gethostbyaddr>(3) and B<getservbyport>(3), but unlike those functions, "
5067 "B<getnameinfo>() is reentrant and allows programs to eliminate "
5068 "IPv4-versus-IPv6 dependencies."
5072 #: build/C/man3/getnameinfo.3:70
5074 "The I<sa> argument is a pointer to a generic socket address structure (of "
5075 "type I<sockaddr_in> or I<sockaddr_in6>) of size I<salen> that holds the "
5076 "input IP address and port number. The arguments I<host> and I<serv> are "
5077 "pointers to caller-allocated buffers (of size I<hostlen> and I<servlen> "
5078 "respectively) into which B<getnameinfo>() places null-terminated strings "
5079 "containing the host and service names respectively."
5083 #: build/C/man3/getnameinfo.3:83
5085 "The caller can specify that no hostname (or no service name) is required by "
5086 "providing a NULL I<host> (or I<serv>) argument or a zero I<hostlen> (or "
5087 "I<servlen>) argument. However, at least one of hostname or service name "
5088 "must be requested."
5092 #: build/C/man3/getnameinfo.3:89
5093 msgid "The I<flags> argument modifies the behavior of B<getnameinfo>() as follows:"
5097 #: build/C/man3/getnameinfo.3:89
5099 msgid "B<NI_NAMEREQD>"
5103 #: build/C/man3/getnameinfo.3:92
5104 msgid "If set, then an error is returned if the hostname cannot be determined."
5108 #: build/C/man3/getnameinfo.3:92
5114 #: build/C/man3/getnameinfo.3:98
5116 "If set, then the service is datagram (UDP) based rather than stream (TCP) "
5117 "based. This is required for the few ports (512-514) that have different "
5118 "services for UDP and TCP."
5122 #: build/C/man3/getnameinfo.3:98
5124 msgid "B<NI_NOFQDN>"
5128 #: build/C/man3/getnameinfo.3:102
5130 "If set, return only the hostname part of the fully qualified domain name for "
5135 #: build/C/man3/getnameinfo.3:102
5137 msgid "B<NI_NUMERICHOST>"
5140 #. For example, by calling
5143 #. .BR gethostbyaddr ().
5144 #. POSIX.1-2003 has NI_NUMERICSCOPE, but glibc doesn't have it.
5146 #: build/C/man3/getnameinfo.3:112
5148 "If set, then the numeric form of the hostname is returned. (When not set, "
5149 "this will still happen in case the node's name cannot be determined.)"
5153 #: build/C/man3/getnameinfo.3:112
5155 msgid "B<NI_NUMERICSERV>"
5159 #: build/C/man3/getnameinfo.3:117
5161 "If set, then the numeric form of the service address is returned. (When not "
5162 "set, this will still happen in case the service's name cannot be "
5167 #: build/C/man3/getnameinfo.3:117
5169 msgid "Extensions to getnameinfo() for Internationalized Domain Names"
5173 #: build/C/man3/getnameinfo.3:126
5175 "Starting with glibc 2.3.4, B<getnameinfo>() has been extended to "
5176 "selectively allow hostnames to be transparently converted to and from the "
5177 "Internationalized Domain Name (IDN) format (see RFC 3490, "
5178 "I<Internationalizing Domain Names in Applications (IDNA)>). Three new flags "
5183 #: build/C/man3/getnameinfo.3:126
5189 #: build/C/man3/getnameinfo.3:132
5191 "If this flag is used, then the name found in the lookup process is converted "
5192 "from IDN format to the locale's encoding if necessary. ASCII-only names are "
5193 "not affected by the conversion, which makes this flag usable in existing "
5194 "programs and environments."
5198 #: build/C/man3/getnameinfo.3:132
5200 msgid "B<NI_IDN_ALLOW_UNASSIGNED>, B<NI_IDN_USE_STD3_ASCII_RULES>"
5203 #. FIXME glibc defines the following additional errors, some which
5204 #. can probably be returned by getnameinfo(); they need to
5207 #. #define EAI_INPROGRESS -100 /* Processing request in progress. */
5208 #. #define EAI_CANCELED -101 /* Request canceled. */
5209 #. #define EAI_NOTCANCELED -102 /* Request not canceled. */
5210 #. #define EAI_ALLDONE -103 /* All requests done. */
5211 #. #define EAI_INTR -104 /* Interrupted by a signal. */
5212 #. #define EAI_IDN_ENCODE -105 /* IDN encoding failed. */
5215 #: build/C/man3/getnameinfo.3:155
5217 "On success 0 is returned, and node and service names, if requested, are "
5218 "filled with null-terminated strings, possibly truncated to fit the specified "
5219 "buffer lengths. On error one of the following nonzero error codes is "
5224 #: build/C/man3/getnameinfo.3:159
5225 msgid "The name could not be resolved at this time. Try again later."
5229 #: build/C/man3/getnameinfo.3:164
5230 msgid "The I<flags> argument has an invalid value."
5234 #: build/C/man3/getnameinfo.3:167
5235 msgid "A nonrecoverable error occurred."
5239 #: build/C/man3/getnameinfo.3:171
5241 "The address family was not recognized, or the address length was invalid for "
5242 "the specified family."
5246 #: build/C/man3/getnameinfo.3:180
5248 "The name does not resolve for the supplied arguments. B<NI_NAMEREQD> is set "
5249 "and the host's name cannot be located, or neither hostname nor service name "
5254 #: build/C/man3/getnameinfo.3:180
5256 msgid "B<EAI_OVERFLOW>"
5260 #: build/C/man3/getnameinfo.3:187
5261 msgid "The buffer pointed to by I<host> or I<serv> was too small."
5265 #: build/C/man3/getnameinfo.3:192
5266 msgid "A system error occurred. The error code can be found in I<errno>."
5270 #: build/C/man3/getnameinfo.3:199
5275 #: build/C/man3/getnameinfo.3:201
5276 msgid "/etc/nsswitch.conf"
5280 #: build/C/man3/getnameinfo.3:203
5281 msgid "/etc/resolv.conf"
5285 #: build/C/man3/getnameinfo.3:206
5286 msgid "B<getnameinfo>() is provided in glibc since version 2.1."
5290 #: build/C/man3/getnameinfo.3:208
5291 msgid "RFC\\ 2553, POSIX.1-2001."
5295 #: build/C/man3/getnameinfo.3:213
5297 "In order to assist the programmer in choosing reasonable sizes for the "
5298 "supplied buffers, I<E<lt>netdb.hE<gt>> defines the constants"
5302 #: build/C/man3/getnameinfo.3:218
5305 "#define NI_MAXHOST 1025\n"
5306 "#define NI_MAXSERV 32\n"
5310 #: build/C/man3/getnameinfo.3:228
5312 "Since glibc 2.8, these definitions are exposed only if one of the feature "
5313 "test macros B<_BSD_SOURCE>, B<_SVID_SOURCE>, or B<_GNU_SOURCE> is defined."
5317 #: build/C/man3/getnameinfo.3:236
5319 "The former is the constant B<MAXDNAME> in recent versions of BIND's "
5320 "I<E<lt>arpa/nameser.hE<gt>> header file. The latter is a guess based on the "
5321 "services listed in the current Assigned Numbers RFC."
5325 #: build/C/man3/getnameinfo.3:241
5327 "The following code tries to get the numeric hostname and service name, for a "
5328 "given socket address. Note that there is no hardcoded reference to a "
5329 "particular address family."
5333 #: build/C/man3/getnameinfo.3:247
5336 "struct sockaddr *sa; /* input */\n"
5337 "socklen_t len; /* input */\n"
5338 "char hbuf[NI_MAXHOST], sbuf[NI_MAXSERV];\n"
5342 #: build/C/man3/getnameinfo.3:251
5345 "if (getnameinfo(sa, len, hbuf, sizeof(hbuf), sbuf,\n"
5346 " sizeof(sbuf), NI_NUMERICHOST | NI_NUMERICSERV) == 0)\n"
5347 " printf(\"host=%s, serv=%s\\en\", hbuf, sbuf);\n"
5351 #: build/C/man3/getnameinfo.3:256
5353 "The following version checks if the socket address has a reverse address "
5358 #: build/C/man3/getnameinfo.3:262
5361 "struct sockaddr *sa; /* input */\n"
5362 "socklen_t len; /* input */\n"
5363 "char hbuf[NI_MAXHOST];\n"
5367 #: build/C/man3/getnameinfo.3:268
5370 "if (getnameinfo(sa, len, hbuf, sizeof(hbuf),\n"
5371 " NULL, 0, NI_NAMEREQD))\n"
5372 " printf(\"could not resolve hostname\");\n"
5374 " printf(\"host=%s\\en\", hbuf);\n"
5378 #: build/C/man3/getnameinfo.3:275
5380 "An example program using B<getnameinfo>() can be found in "
5381 "B<getaddrinfo>(3)."
5385 #: build/C/man3/getnameinfo.3:290
5387 "B<accept>(2), B<getpeername>(2), B<getsockname>(2), B<recvfrom>(2), "
5388 "B<socket>(2), B<getaddrinfo>(3), B<gethostbyaddr>(3), B<getservbyname>(3), "
5389 "B<getservbyport>(3), B<inet_ntop>(3), B<hosts>(5), B<services>(5), "
5390 "B<hostname>(7), B<named>(8)"
5394 #: build/C/man3/getnameinfo.3:294
5396 "R. Gilligan, S. Thomson, J. Bound and W. Stevens, I<Basic Socket Interface "
5397 "Extensions for IPv6>, RFC\\ 2553, March 1999."
5401 #: build/C/man3/getnameinfo.3:300
5403 "Tatsuya Jinmei and Atsushi Onoe, I<An Extension of Format for IPv6 Scoped "
5404 "Addresses>, internet draft, work in progress E<.UR "
5405 "ftp://ftp.ietf.org\\:/internet-drafts\\:/draft-ietf-ipngwg-scopedaddr-format-02.txt> "
5410 #: build/C/man3/getnameinfo.3:305
5412 "Craig Metz, I<Protocol Independence Using the Sockets API>, Proceedings of "
5413 "the freenix track: 2000 USENIX annual technical conference, June 2000"
5417 #: build/C/man3/getnameinfo.3:308
5420 "http://www.usenix.org\\:/publications\\:/library\\:/proceedings\\:/usenix2000\\:/freenix\\:/metzprotocol.html> "
5425 #: build/C/man3/getnetent.3:30
5431 #: build/C/man3/getnetent.3:30 build/C/man3/getprotoent.3:30 build/C/man3/getservent.3:34
5437 #: build/C/man3/getnetent.3:34
5439 "getnetent, getnetbyname, getnetbyaddr, setnetent, endnetent - get network "
5444 #: build/C/man3/getnetent.3:37 build/C/man3/getnetent_r.3:33 build/C/man3/getprotoent.3:37 build/C/man3/getprotoent_r.3:33 build/C/man3/getservent.3:41 build/C/man3/getservent_r.3:33 build/C/man3/setnetgrent.3:17
5446 msgid "B<#include E<lt>netdb.hE<gt>>\n"
5450 #: build/C/man3/getnetent.3:39
5452 msgid "B<struct netent *getnetent(void);>\n"
5456 #: build/C/man3/getnetent.3:41
5458 msgid "B<struct netent *getnetbyname(const char *>I<name>B<);>\n"
5462 #: build/C/man3/getnetent.3:43
5464 msgid "B<struct netent *getnetbyaddr(uint32_t >I<net>B<, int >I<type>B<);>\n"
5468 #: build/C/man3/getnetent.3:45
5470 msgid "B<void setnetent(int >I<stayopen>B<);>\n"
5474 #: build/C/man3/getnetent.3:47
5476 msgid "B<void endnetent(void);>\n"
5480 #: build/C/man3/getnetent.3:57
5482 "The B<getnetent>() function reads the next entry from the networks database "
5483 "and returns a I<netent> structure containing the broken-out fields from the "
5484 "entry. A connection is opened to the database if necessary."
5488 #: build/C/man3/getnetent.3:66
5490 "The B<getnetbyname>() function returns a I<netent> structure for the entry "
5491 "from the database that matches the network I<name>."
5495 #: build/C/man3/getnetent.3:80
5497 "The B<getnetbyaddr>() function returns a I<netent> structure for the entry "
5498 "from the database that matches the network number I<net> of type I<type>. "
5499 "The I<net> argument must be in host byte order."
5503 #: build/C/man3/getnetent.3:92
5505 "The B<setnetent>() function opens a connection to the database, and sets "
5506 "the next entry to the first entry. If I<stayopen> is nonzero, then the "
5507 "connection to the database will not be closed between calls to one of the "
5508 "B<getnet*>() functions."
5512 #: build/C/man3/getnetent.3:96
5513 msgid "The B<endnetent>() function closes the connection to the database."
5517 #: build/C/man3/getnetent.3:102
5518 msgid "The I<netent> structure is defined in I<E<lt>netdb.hE<gt>> as follows:"
5522 #: build/C/man3/getnetent.3:111
5526 " char *n_name; /* official network name */\n"
5527 " char **n_aliases; /* alias list */\n"
5528 " int n_addrtype; /* net address type */\n"
5529 " uint32_t n_net; /* network number */\n"
5534 #: build/C/man3/getnetent.3:117
5535 msgid "The members of the I<netent> structure are:"
5539 #: build/C/man3/getnetent.3:117
5545 #: build/C/man3/getnetent.3:120
5546 msgid "The official name of the network."
5550 #: build/C/man3/getnetent.3:120
5552 msgid "I<n_aliases>"
5556 #: build/C/man3/getnetent.3:123
5557 msgid "A NULL-terminated list of alternative names for the network."
5561 #: build/C/man3/getnetent.3:123
5563 msgid "I<n_addrtype>"
5567 #: build/C/man3/getnetent.3:127
5568 msgid "The type of the network number; always B<AF_INET>."
5572 #: build/C/man3/getnetent.3:127
5578 #: build/C/man3/getnetent.3:130
5579 msgid "The network number in host byte order."
5583 #: build/C/man3/getnetent.3:141
5585 "The B<getnetent>(), B<getnetbyname>() and B<getnetbyaddr>() functions "
5586 "return a pointer to a statically allocated I<netent> structure, or a NULL "
5587 "pointer if an error occurs or the end of the file is reached."
5591 #: build/C/man3/getnetent.3:142 build/C/man5/networks.5:71
5593 msgid "I</etc/networks>"
5597 #: build/C/man3/getnetent.3:145
5598 msgid "networks database file"
5602 #: build/C/man3/getnetent.3:147 build/C/man3/getprotoent.3:142 build/C/man3/getservent.3:159
5603 msgid "4.3BSD, POSIX.1-2001."
5607 #: build/C/man3/getnetent.3:154
5609 "In glibc versions before 2.2, the I<net> argument of B<getnetbyaddr>() was "
5615 #: build/C/man3/getnetent.3:159
5616 msgid "B<getnetent_r>(3), B<getprotoent>(3), B<getservent>(3)"
5620 #: build/C/man3/getnetent.3:161
5625 #: build/C/man3/getnetent_r.3:26
5631 #: build/C/man3/getnetent_r.3:30
5632 msgid "getnetent_r, getnetbyname_r, getnetbyaddr_r - get network entry (reentrant)"
5636 #: build/C/man3/getnetent_r.3:37
5639 "B<int getnetent_r(struct netent *>I<result_buf>B<, char *>I<buf>B<,>\n"
5640 "B< size_t >I<buflen>B<, struct netent **>I<result>B<,>\n"
5641 "B< int *>I<h_errnop>B<);>\n"
5645 #: build/C/man3/getnetent_r.3:42
5648 "B<int getnetbyname_r(const char *>I<name>B<,>\n"
5649 "B< struct netent *>I<result_buf>B<, char *>I<buf>B<,>\n"
5650 "B< size_t >I<buflen>B<, struct netent **>I<result>B<,>\n"
5651 "B< int *>I<h_errnop>B<);>\n"
5655 #: build/C/man3/getnetent_r.3:47
5658 "B<int getnetbyaddr_r(uint32_t >I<net>B<, int >I<type>B<,>\n"
5659 "B< struct netent *>I<result_buf>B<, char *>I<buf>B<,>\n"
5660 "B< size_t >I<buflen>B<, struct netent **>I<result>B<,>\n"
5661 "B< int *>I<h_errnop>B<);>\n"
5665 #: build/C/man3/getnetent_r.3:58
5666 msgid "B<getnetent_r>(), B<getnetbyname_r>(), B<getnetbyaddr_r>():"
5670 #: build/C/man3/getnetent_r.3:79
5672 "The B<getnetent_r>(), B<getnetbyname_r>(), and B<getnetbyaddr_r>() "
5673 "functions are the reentrant equivalents of, respectively, B<getnetent>(3), "
5674 "B<getnetbyname>(3), and B<getnetbynumber>(3). They differ in the way that "
5675 "the I<netent> structure is returned, and in the function calling signature "
5676 "and return value. This manual page describes just the differences from the "
5677 "nonreentrant functions."
5681 #: build/C/man3/getnetent_r.3:85
5683 "Instead of returning a pointer to a statically allocated I<netent> structure "
5684 "as the function result, these functions copy the structure into the location "
5685 "pointed to by I<result_buf>."
5688 #. I can find no information on the required/recommended buffer size;
5689 #. the nonreentrant functions use a 1024 byte buffer -- mtk.
5691 #: build/C/man3/getnetent_r.3:102
5693 "The I<buf> array is used to store the string fields pointed to by the "
5694 "returned I<netent> structure. (The nonreentrant functions allocate these "
5695 "strings in static storage.) The size of this array is specified in "
5696 "I<buflen>. If I<buf> is too small, the call fails with the error B<ERANGE>, "
5697 "and the caller must try again with a larger buffer. (A buffer of length "
5698 "1024 bytes should be sufficient for most applications.)"
5702 #: build/C/man3/getnetent_r.3:110
5704 "If the function call successfully obtains a network record, then I<*result> "
5705 "is set pointing to I<result_buf>; otherwise, I<*result> is set to NULL."
5708 #. getnetent.3 doesn't document any use of h_errno, but nevertheless
5709 #. the nonreentrant functions no seem to set h_errno.
5711 #: build/C/man3/getnetent_r.3:118
5713 "The buffer pointed to by I<h_errnop> is used to return the value that would "
5714 "be stored in the global variable I<h_errno> by the nonreentrant versions of "
5719 #: build/C/man3/getnetent_r.3:121 build/C/man3/getprotoent_r.3:111
5721 "On success, these functions return 0. On error, they return one of the "
5722 "positive error numbers listed in ERRORS."
5726 #: build/C/man3/getnetent_r.3:129
5728 "On error, record not found (B<getnetbyname_r>(), B<getnetbyaddr_r>()), or "
5729 "end of input (B<getnetent_r>()) I<result> is set to NULL."
5733 #: build/C/man3/getnetent_r.3:134
5734 msgid "(B<getnetent_r>()) No more records in database."
5738 #: build/C/man3/getnetent_r.3:134 build/C/man3/getprotoent_r.3:124 build/C/man3/getservent_r.3:123
5744 #: build/C/man3/getnetent_r.3:141 build/C/man3/getprotoent_r.3:131 build/C/man3/getservent_r.3:130
5746 "I<buf> is too small. Try again with a larger buffer (and increased "
5751 #: build/C/man3/getnetent_r.3:145 build/C/man3/getprotoent_r.3:135 build/C/man3/getservent_r.3:134
5753 "These functions are GNU extensions. Functions with similar names exist on "
5754 "some other systems, though typically with different calling signatures."
5758 #: build/C/man3/getnetent_r.3:148
5759 msgid "B<getnetent>(3), B<networks>(5)"
5763 #: build/C/man2/getpeername.2:42
5769 #: build/C/man2/getpeername.2:42 build/C/man5/nscd.conf.5:20 build/C/man5/nsswitch.conf.5:25
5775 #: build/C/man2/getpeername.2:45
5776 msgid "getpeername - get name of connected peer socket"
5780 #: build/C/man2/getpeername.2:50
5782 "B<int getpeername(int >I<sockfd>B<, struct sockaddr *>I<addr>B<, socklen_t "
5787 #: build/C/man2/getpeername.2:63
5789 "B<getpeername>() returns the address of the peer connected to the socket "
5790 "I<sockfd>, in the buffer pointed to by I<addr>. The I<addrlen> argument "
5791 "should be initialized to indicate the amount of space pointed to by "
5792 "I<addr>. On return it contains the actual size of the name returned (in "
5793 "bytes). The name is truncated if the buffer provided is too small."
5797 #: build/C/man2/getpeername.2:68
5799 "The returned address is truncated if the buffer provided is too small; in "
5800 "this case, I<addrlen> will return a value greater than was supplied to the "
5805 #: build/C/man2/getpeername.2:73 build/C/man2/shutdown.2:74
5807 "On success, zero is returned. On error, -1 is returned, and I<errno> is set "
5812 #: build/C/man2/getpeername.2:74 build/C/man2/shutdown.2:75
5818 #: build/C/man2/getpeername.2:79
5819 msgid "The argument I<sockfd> is not a valid descriptor."
5823 #: build/C/man2/getpeername.2:79 build/C/man7/packet.7:250 build/C/man7/raw.7:149 build/C/man7/unix.7:334
5829 #: build/C/man2/getpeername.2:85
5831 "The I<addr> argument points to memory not in a valid part of the process "
5836 #: build/C/man2/getpeername.2:89
5837 msgid "I<addrlen> is invalid (e.g., is negative)."
5841 #: build/C/man2/getpeername.2:89 build/C/man7/packet.7:262
5847 #: build/C/man2/getpeername.2:93
5849 "Insufficient resources were available in the system to perform the "
5854 #: build/C/man2/getpeername.2:96
5855 msgid "The socket is not connected."
5859 #: build/C/man2/getpeername.2:96 build/C/man2/shutdown.2:87
5865 #: build/C/man2/getpeername.2:101
5866 msgid "The argument I<sockfd> is a file, not a socket."
5870 #: build/C/man2/getpeername.2:105
5872 "SVr4, 4.4BSD (the B<getpeername>() function call first appeared in 4.2BSD), "
5877 #: build/C/man2/getpeername.2:116
5879 "The third argument of B<getpeername>() is in reality an I<int\\ *> (and "
5880 "this is what 4.x BSD and libc4 and libc5 have). Some POSIX confusion "
5881 "resulted in the present I<socklen_t>, also used by glibc. See also "
5886 #: build/C/man2/getpeername.2:143
5888 "For stream sockets, once a B<connect>(2) has been performed, either socket "
5889 "can call B<getpeername>() to obtain the address of the peer socket. On the "
5890 "other hand, datagram sockets are connectionless. Calling B<connect>(2) on "
5891 "a datagram socket merely sets the peer address for outgoing datagrams sent "
5892 "with B<write>(2) or B<recv>(2). The caller of B<connect>(2) can use "
5893 "B<getpeername>() to obtain the peer address that it earlier set for the "
5894 "socket. However, the peer socket is unaware of this information, and "
5895 "calling B<getpeername>() on the peer socket will return no useful "
5896 "information (unless a B<connect>(2) call was also executed on the peer). "
5897 "Note also that the receiver of a datagram can obtain the address of the "
5898 "sender when using B<recvfrom>(2)."
5902 #: build/C/man2/getpeername.2:150
5904 "B<accept>(2), B<bind>(2), B<getsockname>(2), B<ip>(7), B<socket>(7), "
5909 #: build/C/man3/getprotoent.3:30
5915 #: build/C/man3/getprotoent.3:34
5917 "getprotoent, getprotobyname, getprotobynumber, setprotoent, endprotoent - "
5918 "get protocol entry"
5922 #: build/C/man3/getprotoent.3:39
5924 msgid "B<struct protoent *getprotoent(void);>\n"
5928 #: build/C/man3/getprotoent.3:41
5930 msgid "B<struct protoent *getprotobyname(const char *>I<name>B<);>\n"
5934 #: build/C/man3/getprotoent.3:43
5936 msgid "B<struct protoent *getprotobynumber(int >I<proto>B<);>\n"
5940 #: build/C/man3/getprotoent.3:45
5942 msgid "B<void setprotoent(int >I<stayopen>B<);>\n"
5946 #: build/C/man3/getprotoent.3:47
5948 msgid "B<void endprotoent(void);>\n"
5952 #: build/C/man3/getprotoent.3:58
5954 "The B<getprotoent>() function reads the next entry from the protocols "
5955 "database (see B<protocols>(5)) and returns a I<protoent> structure "
5956 "containing the broken-out fields from the entry. A connection is opened to "
5957 "the database if necessary."
5961 #: build/C/man3/getprotoent.3:68
5963 "The B<getprotobyname>() function returns a I<protoent> structure for the "
5964 "entry from the database that matches the protocol name I<name>. A "
5965 "connection is opened to the database if necessary."
5969 #: build/C/man3/getprotoent.3:78
5971 "The B<getprotobynumber>() function returns a I<protoent> structure for the "
5972 "entry from the database that matches the protocol number I<number>. A "
5973 "connection is opened to the database if necessary."
5977 #: build/C/man3/getprotoent.3:90
5979 "The B<setprotoent>() function opens a connection to the database, and sets "
5980 "the next entry to the first entry. If I<stayopen> is nonzero, then the "
5981 "connection to the database will not be closed between calls to one of the "
5982 "B<getproto*>() functions."
5986 #: build/C/man3/getprotoent.3:94
5987 msgid "The B<endprotoent>() function closes the connection to the database."
5991 #: build/C/man3/getprotoent.3:100
5992 msgid "The I<protoent> structure is defined in I<E<lt>netdb.hE<gt>> as follows:"
5996 #: build/C/man3/getprotoent.3:108
5999 "struct protoent {\n"
6000 " char *p_name; /* official protocol name */\n"
6001 " char **p_aliases; /* alias list */\n"
6002 " int p_proto; /* protocol number */\n"
6007 #: build/C/man3/getprotoent.3:114
6008 msgid "The members of the I<protoent> structure are:"
6012 #: build/C/man3/getprotoent.3:114
6018 #: build/C/man3/getprotoent.3:117
6019 msgid "The official name of the protocol."
6023 #: build/C/man3/getprotoent.3:117
6025 msgid "I<p_aliases>"
6029 #: build/C/man3/getprotoent.3:120
6030 msgid "A NULL-terminated list of alternative names for the protocol."
6034 #: build/C/man3/getprotoent.3:120
6040 #: build/C/man3/getprotoent.3:123
6041 msgid "The protocol number."
6045 #: build/C/man3/getprotoent.3:134
6047 "The B<getprotoent>(), B<getprotobyname>() and B<getprotobynumber>() "
6048 "functions return a pointer to a statically allocated I<protoent> structure, "
6049 "or a NULL pointer if an error occurs or the end of the file is reached."
6053 #: build/C/man3/getprotoent.3:136 build/C/man5/protocols.5:78
6055 msgid "I</etc/protocols>"
6059 #: build/C/man3/getprotoent.3:139
6060 msgid "protocol database file"
6064 #: build/C/man3/getprotoent.3:147
6065 msgid "B<getnetent>(3), B<getprotoent_r>(3), B<getservent>(3), B<protocols>(5)"
6069 #: build/C/man3/getprotoent_r.3:26
6071 msgid "GETPROTOENT_R"
6075 #: build/C/man3/getprotoent_r.3:30
6077 "getprotoent_r, getprotobyname_r, getprotobynumber_r - get protocol entry "
6082 #: build/C/man3/getprotoent_r.3:36
6085 "B<int getprotoent_r(struct protoent *>I<result_buf>B<, char *>I<buf>B<,>\n"
6086 "B< size_t >I<buflen>B<, struct protoent **>I<result>B<);>\n"
6090 #: build/C/man3/getprotoent_r.3:40
6093 "B<int getprotobyname_r(const char *>I<name>B<,>\n"
6094 "B< struct protoent *>I<result_buf>B<, char *>I<buf>B<,>\n"
6095 "B< size_t >I<buflen>B<, struct protoent **>I<result>B<);>\n"
6099 #: build/C/man3/getprotoent_r.3:44
6102 "B<int getprotobynumber_r(int >I<proto>B<,>\n"
6103 "B< struct protoent *>I<result_buf>B<, char *>I<buf>B<,>\n"
6104 "B< size_t >I<buflen>B<, struct protoent **>I<result>B<);>\n"
6108 #: build/C/man3/getprotoent_r.3:55
6109 msgid "B<getprotoent_r>(), B<getprotobyname_r>(), B<getprotobynumber_r>():"
6113 #: build/C/man3/getprotoent_r.3:76
6115 "The B<getprotoent_r>(), B<getprotobyname_r>(), and B<getprotobynumber_r>() "
6116 "functions are the reentrant equivalents of, respectively, B<getprotoent>(3), "
6117 "B<getprotobyname>(3), and B<getprotobynumber>(3). They differ in the way "
6118 "that the I<protoent> structure is returned, and in the function calling "
6119 "signature and return value. This manual page describes just the differences "
6120 "from the nonreentrant functions."
6124 #: build/C/man3/getprotoent_r.3:82
6126 "Instead of returning a pointer to a statically allocated I<protoent> "
6127 "structure as the function result, these functions copy the structure into "
6128 "the location pointed to by I<result_buf>."
6131 #. I can find no information on the required/recommended buffer size;
6132 #. the nonreentrant functions use a 1024 byte buffer.
6133 #. The 1024 byte value is also what the Solaris man page suggests. -- mtk
6135 #: build/C/man3/getprotoent_r.3:100
6137 "The I<buf> array is used to store the string fields pointed to by the "
6138 "returned I<protoent> structure. (The nonreentrant functions allocate these "
6139 "strings in static storage.) The size of this array is specified in "
6140 "I<buflen>. If I<buf> is too small, the call fails with the error B<ERANGE>, "
6141 "and the caller must try again with a larger buffer. (A buffer of length "
6142 "1024 bytes should be sufficient for most applications.)"
6146 #: build/C/man3/getprotoent_r.3:108
6148 "If the function call successfully obtains a protocol record, then I<*result> "
6149 "is set pointing to I<result_buf>; otherwise, I<*result> is set to NULL."
6153 #: build/C/man3/getprotoent_r.3:119
6155 "On error, record not found (B<getprotobyname_r>(), B<getprotobynumber_r>()), "
6156 "or end of input (B<getprotoent_r>()) I<result> is set to NULL."
6160 #: build/C/man3/getprotoent_r.3:124
6161 msgid "(B<getprotoent_r>()) No more records in database."
6165 #: build/C/man3/getprotoent_r.3:149
6167 "The program below uses B<getprotobyname_r>() to retrieve the protocol "
6168 "record for the protocol named in its first command-line argument. If a "
6169 "second (integer) command-line argument is supplied, it is used as the "
6170 "initial value for I<buflen>; if B<getprotobyname_r>() fails with the error "
6171 "B<ERANGE>, the program retries with larger buffer sizes. The following "
6172 "shell session shows a couple of sample runs:"
6176 #: build/C/man3/getprotoent_r.3:160
6179 "$B< ./a.out tcp 1>\n"
6180 "ERANGE! Retrying with larger buffer\n"
6181 "getprotobyname_r() returned: 0 (success) (buflen=78)\n"
6182 "p_name=tcp; p_proto=6; aliases=TCP\n"
6183 "$B< ./a.out xxx 1>\n"
6184 "ERANGE! Retrying with larger buffer\n"
6185 "getprotobyname_r() returned: 0 (success) (buflen=100)\n"
6186 "Call failed/record not found\n"
6190 #: build/C/man3/getprotoent_r.3:172 build/C/man3/getservent_r.3:170
6193 "#define _GNU_SOURCE\n"
6194 "#include E<lt>ctype.hE<gt>\n"
6195 "#include E<lt>netdb.hE<gt>\n"
6196 "#include E<lt>stdlib.hE<gt>\n"
6197 "#include E<lt>stdio.hE<gt>\n"
6198 "#include E<lt>errno.hE<gt>\n"
6199 "#include E<lt>string.hE<gt>\n"
6203 #: build/C/man3/getprotoent_r.3:174 build/C/man3/getservent_r.3:172
6205 msgid "#define MAX_BUF 10000\n"
6209 #: build/C/man3/getprotoent_r.3:183
6213 "main(int argc, char *argv[])\n"
6215 " int buflen, erange_cnt, s;\n"
6216 " struct protoent result_buf;\n"
6217 " struct protoent *result;\n"
6218 " char buf[MAX_BUF];\n"
6223 #: build/C/man3/getprotoent_r.3:188
6226 " if (argc E<lt> 2) {\n"
6227 " printf(\"Usage: %s proto-name [buflen]\\en\", argv[0]);\n"
6228 " exit(EXIT_FAILURE);\n"
6233 #: build/C/man3/getprotoent_r.3:192
6237 " if (argc E<gt> 2)\n"
6238 " buflen = atoi(argv[2]);\n"
6242 #: build/C/man3/getprotoent_r.3:197 build/C/man3/getservent_r.3:200
6245 " if (buflen E<gt> MAX_BUF) {\n"
6246 " printf(\"Exceeded buffer limit (%d)\\en\", MAX_BUF);\n"
6247 " exit(EXIT_FAILURE);\n"
6252 #: build/C/man3/getprotoent_r.3:206
6255 " erange_cnt = 0;\n"
6257 " s = getprotobyname_r(argv[1], &result_buf,\n"
6258 " buf, buflen, &result);\n"
6259 " if (s == ERANGE) {\n"
6260 " if (erange_cnt == 0)\n"
6261 " printf(\"ERANGE! Retrying with larger buffer\\en\");\n"
6266 #: build/C/man3/getprotoent_r.3:209 build/C/man3/getservent_r.3:212
6269 " /* Increment a byte at a time so we can see exactly\n"
6270 " what size buffer was required */\n"
6274 #: build/C/man3/getprotoent_r.3:211 build/C/man3/getservent_r.3:214
6276 msgid " buflen++;\n"
6280 #: build/C/man3/getprotoent_r.3:218 build/C/man3/getservent_r.3:221
6283 " if (buflen E<gt> MAX_BUF) {\n"
6284 " printf(\"Exceeded buffer limit (%d)\\en\", MAX_BUF);\n"
6285 " exit(EXIT_FAILURE);\n"
6288 " } while (s == ERANGE);\n"
6292 #: build/C/man3/getprotoent_r.3:222
6295 " printf(\"getprotobyname_r() returned: %s (buflen=%d)\\en\",\n"
6296 " (s == 0) ? \"0 (success)\" : (s == ENOENT) ? \"ENOENT\" :\n"
6297 " strerror(s), buflen);\n"
6301 #: build/C/man3/getprotoent_r.3:227 build/C/man3/getservent_r.3:230
6304 " if (s != 0 || result == NULL) {\n"
6305 " printf(\"Call failed/record not found\\en\");\n"
6306 " exit(EXIT_FAILURE);\n"
6311 #: build/C/man3/getprotoent_r.3:233
6314 " printf(\"p_name=%s; p_proto=%d; aliases=\",\n"
6315 " result_buf.p_name, result_buf.p_proto);\n"
6316 " for (p = result_buf.p_aliases; *p != NULL; p++)\n"
6317 " printf(\"%s \", *p);\n"
6318 " printf(\"\\en\");\n"
6322 #: build/C/man3/getprotoent_r.3:240
6323 msgid "B<getprotoent>(3), B<protocols>(5)"
6327 #: build/C/man3/getservent.3:34
6333 #: build/C/man3/getservent.3:38
6335 "getservent, getservbyname, getservbyport, setservent, endservent - get "
6340 #: build/C/man3/getservent.3:43
6342 msgid "B<struct servent *getservent(void);>\n"
6346 #: build/C/man3/getservent.3:45
6349 "B<struct servent *getservbyname(const char *>I<name>B<, const char "
6354 #: build/C/man3/getservent.3:47
6356 msgid "B<struct servent *getservbyport(int >I<port>B<, const char *>I<proto>B<);>\n"
6360 #: build/C/man3/getservent.3:49
6362 msgid "B<void setservent(int >I<stayopen>B<);>\n"
6366 #: build/C/man3/getservent.3:51
6368 msgid "B<void endservent(void);>\n"
6372 #: build/C/man3/getservent.3:62
6374 "The B<getservent>() function reads the next entry from the services "
6375 "database (see B<services>(5)) and returns a I<servent> structure containing "
6376 "the broken-out fields from the entry. A connection is opened to the "
6377 "database if necessary."
6381 #: build/C/man3/getservent.3:77
6383 "The B<getservbyname>() function returns a I<servent> structure for the "
6384 "entry from the database that matches the service I<name> using protocol "
6385 "I<proto>. If I<proto> is NULL, any protocol will be matched. A connection "
6386 "is opened to the database if necessary."
6390 #: build/C/man3/getservent.3:93
6392 "The B<getservbyport>() function returns a I<servent> structure for the "
6393 "entry from the database that matches the port I<port> (given in network byte "
6394 "order) using protocol I<proto>. If I<proto> is NULL, any protocol will be "
6395 "matched. A connection is opened to the database if necessary."
6399 #: build/C/man3/getservent.3:105
6401 "The B<setservent>() function opens a connection to the database, and sets "
6402 "the next entry to the first entry. If I<stayopen> is nonzero, then the "
6403 "connection to the database will not be closed between calls to one of the "
6404 "B<getserv*>() functions."
6408 #: build/C/man3/getservent.3:109
6409 msgid "The B<endservent>() function closes the connection to the database."
6413 #: build/C/man3/getservent.3:115
6414 msgid "The I<servent> structure is defined in I<E<lt>netdb.hE<gt>> as follows:"
6418 #: build/C/man3/getservent.3:124
6421 "struct servent {\n"
6422 " char *s_name; /* official service name */\n"
6423 " char **s_aliases; /* alias list */\n"
6424 " int s_port; /* port number */\n"
6425 " char *s_proto; /* protocol to use */\n"
6430 #: build/C/man3/getservent.3:130
6431 msgid "The members of the I<servent> structure are:"
6435 #: build/C/man3/getservent.3:130
6441 #: build/C/man3/getservent.3:133
6442 msgid "The official name of the service."
6446 #: build/C/man3/getservent.3:133
6448 msgid "I<s_aliases>"
6452 #: build/C/man3/getservent.3:136
6453 msgid "A NULL-terminated list of alternative names for the service."
6457 #: build/C/man3/getservent.3:136
6463 #: build/C/man3/getservent.3:139
6464 msgid "The port number for the service given in network byte order."
6468 #: build/C/man3/getservent.3:139
6474 #: build/C/man3/getservent.3:142
6475 msgid "The name of the protocol to use with this service."
6479 #: build/C/man3/getservent.3:153
6481 "The B<getservent>(), B<getservbyname>() and B<getservbyport>() functions "
6482 "return a pointer to a statically allocated I<servent> structure, or a NULL "
6483 "pointer if an error occurs or the end of the file is reached."
6487 #: build/C/man3/getservent.3:154 build/C/man5/services.5:186
6489 msgid "I</etc/services>"
6493 #: build/C/man3/getservent.3:157
6494 msgid "services database file"
6498 #: build/C/man3/getservent.3:164
6499 msgid "B<getnetent>(3), B<getprotoent>(3), B<getservent_r>(3), B<services>(5)"
6503 #: build/C/man3/getservent_r.3:26
6505 msgid "GETSERVENT_R"
6509 #: build/C/man3/getservent_r.3:30
6511 "getservent_r, getservbyname_r, getservbyport_r - get service entry "
6516 #: build/C/man3/getservent_r.3:36
6519 "B<int getservent_r(struct servent *>I<result_buf>B<, char *>I<buf>B<,>\n"
6520 "B< size_t >I<buflen>B<, struct servent **>I<result>B<);>\n"
6524 #: build/C/man3/getservent_r.3:40
6527 "B<int getservbyname_r(const char *>I<name>B<, const char *>I<proto>B<,>\n"
6528 "B< struct servent *>I<result_buf>B<, char *>I<buf>B<,>\n"
6529 "B< size_t >I<buflen>B<, struct servent **>I<result>B<);>\n"
6533 #: build/C/man3/getservent_r.3:44
6536 "B<int getservbyport_r(int >I<port>B<, const char *>I<proto>B<,>\n"
6537 "B< struct servent *>I<result_buf>B<, char *>I<buf>B<,>\n"
6538 "B< size_t >I<buflen>B<, struct servent **>I<result>B<);>\n"
6542 #: build/C/man3/getservent_r.3:55
6543 msgid "B<getservent_r>(), B<getservbyname_r>(), B<getservbyport_r>():"
6547 #: build/C/man3/getservent_r.3:76
6549 "The B<getservent_r>(), B<getservbyname_r>(), and B<getservbyport_r>() "
6550 "functions are the reentrant equivalents of, respectively, B<getservent>(3), "
6551 "B<getservbyname>(3), and B<getservbyport>(3). They differ in the way that "
6552 "the I<servent> structure is returned, and in the function calling signature "
6553 "and return value. This manual page describes just the differences from the "
6554 "nonreentrant functions."
6558 #: build/C/man3/getservent_r.3:82
6560 "Instead of returning a pointer to a statically allocated I<servent> "
6561 "structure as the function result, these functions copy the structure into "
6562 "the location pointed to by I<result_buf>."
6565 #. I can find no information on the required/recommended buffer size;
6566 #. the nonreentrant functions use a 1024 byte buffer -- mtk.
6568 #: build/C/man3/getservent_r.3:99
6570 "The I<buf> array is used to store the string fields pointed to by the "
6571 "returned I<servent> structure. (The nonreentrant functions allocate these "
6572 "strings in static storage.) The size of this array is specified in "
6573 "I<buflen>. If I<buf> is too small, the call fails with the error B<ERANGE>, "
6574 "and the caller must try again with a larger buffer. (A buffer of length "
6575 "1024 bytes should be sufficient for most applications.)"
6579 #: build/C/man3/getservent_r.3:107
6581 "If the function call successfully obtains a service record, then I<*result> "
6582 "is set pointing to I<result_buf>; otherwise, I<*result> is set to NULL."
6586 #: build/C/man3/getservent_r.3:110
6588 "On success, these functions return 0. On error, they return one of the "
6589 "positive error numbers listed in errors."
6593 #: build/C/man3/getservent_r.3:118
6595 "On error, record not found (B<getservbyname_r>(), B<getservbyport_r>()), or "
6596 "end of input (B<getservent_r>()) I<result> is set to NULL."
6600 #: build/C/man3/getservent_r.3:123
6601 msgid "(B<getservent_r>()) No more records in database."
6605 #: build/C/man3/getservent_r.3:148
6607 "The program below uses B<getservbyport_r>() to retrieve the service record "
6608 "for the port and protocol named in its first command-line argument. If a "
6609 "third (integer) command-line argument is supplied, it is used as the initial "
6610 "value for I<buflen>; if B<getservbyport_r>() fails with the error "
6611 "B<ERANGE>, the program retries with larger buffer sizes. The following "
6612 "shell session shows a couple of sample runs:"
6616 #: build/C/man3/getservent_r.3:158
6619 "$B< ./a.out 7 tcp 1>\n"
6620 "ERANGE! Retrying with larger buffer\n"
6621 "getservbyport_r() returned: 0 (success) (buflen=87)\n"
6622 "s_name=echo; s_proto=tcp; s_port=7; aliases=\n"
6623 "$B< ./a.out 77777 tcp>\n"
6624 "getservbyport_r() returned: 0 (success) (buflen=1024)\n"
6625 "Call failed/record not found\n"
6629 #: build/C/man3/getservent_r.3:182
6633 "main(int argc, char *argv[])\n"
6635 " int buflen, erange_cnt, port, s;\n"
6636 " struct servent result_buf;\n"
6637 " struct servent *result;\n"
6638 " char buf[MAX_BUF];\n"
6644 #: build/C/man3/getservent_r.3:187
6647 " if (argc E<lt> 3) {\n"
6648 " printf(\"Usage: %s port-num proto-name [buflen]\\en\", argv[0]);\n"
6649 " exit(EXIT_FAILURE);\n"
6654 #: build/C/man3/getservent_r.3:191
6657 " port = htons(atoi(argv[1]));\n"
6658 " protop = (strcmp(argv[2], \"null\") == 0 ||\n"
6659 "\t strcmp(argv[2], \"NULL\") == 0) ? NULL : argv[2];\n"
6663 #: build/C/man3/getservent_r.3:195
6667 " if (argc E<gt> 3)\n"
6668 " buflen = atoi(argv[3]);\n"
6672 #: build/C/man3/getservent_r.3:209
6675 " erange_cnt = 0;\n"
6677 " s = getservbyport_r(port, protop, &result_buf,\n"
6678 " buf, buflen, &result);\n"
6679 " if (s == ERANGE) {\n"
6680 " if (erange_cnt == 0)\n"
6681 " printf(\"ERANGE! Retrying with larger buffer\\en\");\n"
6686 #: build/C/man3/getservent_r.3:225
6689 " printf(\"getservbyport_r() returned: %s (buflen=%d)\\en\",\n"
6690 " (s == 0) ? \"0 (success)\" : (s == ENOENT) ? \"ENOENT\" :\n"
6691 " strerror(s), buflen);\n"
6695 #: build/C/man3/getservent_r.3:237
6698 " printf(\"s_name=%s; s_proto=%s; s_port=%d; aliases=\",\n"
6699 " result_buf.s_name, result_buf.s_proto,\n"
6700 " ntohs(result_buf.s_port));\n"
6701 " for (p = result_buf.s_aliases; *p != NULL; p++)\n"
6702 " printf(\"%s \", *p);\n"
6703 " printf(\"\\en\");\n"
6707 #: build/C/man3/getservent_r.3:244
6708 msgid "B<getservent>(3), B<services>(5)"
6712 #: build/C/man5/host.conf.5:26
6718 #: build/C/man5/host.conf.5:26
6724 #: build/C/man5/host.conf.5:26 build/C/man5/networks.5:26
6726 msgid "Linux System Administration"
6730 #: build/C/man5/host.conf.5:29
6731 msgid "host.conf - resolver configuration file"
6735 #: build/C/man5/host.conf.5:38
6737 "The file I</etc/host.conf> contains configuration information specific to "
6738 "the resolver library. It should contain one configuration keyword per line, "
6739 "followed by appropriate configuration information. The keywords recognized "
6740 "are I<order>, I<trim>, I<multi>, I<nospoof>, I<spoof>, and I<reorder>. "
6741 "These keywords are described below."
6745 #: build/C/man5/host.conf.5:38
6751 #: build/C/man5/host.conf.5:44
6753 "This keyword specifies how host lookups are to be performed. It should be "
6754 "followed by one or more lookup methods, separated by commas. Valid methods "
6755 "are I<bind>, I<hosts>, and I<nis>."
6759 #: build/C/man5/host.conf.5:44
6765 #: build/C/man5/host.conf.5:61
6767 "This keyword may be listed more than once. Each time it should be followed "
6768 "by a list of domains, separated by colons (\\(aq:\\(aq), semicolons "
6769 "(\\(aq;\\(aq) or commas (\\(aq,\\(aq), with the leading dot. When set, the "
6770 "resolv+ library will automatically trim the given domain name from the end "
6771 "of any hostname resolved via DNS. This is intended for use with local hosts "
6772 "and domains. (Related note: trim will not affect hostnames gathered via NIS "
6773 "or the hosts file. Care should be taken to ensure that the first hostname "
6774 "for each entry in the hosts file is fully qualified or unqualified, as "
6775 "appropriate for the local installation.)"
6779 #: build/C/man5/host.conf.5:61
6785 #: build/C/man5/host.conf.5:76
6787 "Valid values are I<on> and I<off>. If set to I<on>, the resolv+ library "
6788 "will return all valid addresses for a host that appears in the I</etc/hosts> "
6789 "file, instead of only the first. This is I<off> by default, as it may cause "
6790 "a substantial performance loss at sites with large hosts files."
6794 #: build/C/man5/host.conf.5:76
6800 #: build/C/man5/host.conf.5:91
6802 "Valid values are I<on> and I<off>. If set to I<on>, the resolv+ library "
6803 "will attempt to prevent hostname spoofing to enhance the security of "
6804 "B<rlogin> and B<rsh>. It works as follows: after performing a host address "
6805 "lookup, resolv+ will perform a hostname lookup for that address. If the two "
6806 "hostnames do not match, the query will fail. The default value is I<off>."
6810 #: build/C/man5/host.conf.5:91
6812 msgid "I<spoofalert>"
6816 #: build/C/man5/host.conf.5:103
6818 "Valid values are I<on> and I<off>. If this option is set to I<on> and the "
6819 "I<nospoof> option is also set, resolv+ will log a warning of the error via "
6820 "the syslog facility. The default value is I<off>."
6824 #: build/C/man5/host.conf.5:103
6830 #: build/C/man5/host.conf.5:122
6832 "Valid values are I<off>, I<nowarn> and I<warn>. If this option is set to "
6833 "I<off>, spoofed addresses are permitted and no warnings will be emitted via "
6834 "the syslog facility. If this option is set to I<warn>, resolv+ will attempt "
6835 "to prevent hostname spoofing to enhance the security and log a warning of "
6836 "the error via the syslog facility. If this option is set to I<nowarn>, the "
6837 "resolv+ library will attempt to prevent hostname spoofing to enhance the "
6838 "security but not emit warnings via the syslog facility. Setting this option "
6839 "to anything else is equal to setting it to I<nowarn>."
6843 #: build/C/man5/host.conf.5:122
6849 #: build/C/man5/host.conf.5:135
6851 "Valid values are I<on> and I<off>. If set to I<on>, resolv+ will attempt to "
6852 "reorder host addresses so that local addresses (i.e., on the same subnet) "
6853 "are listed first when a B<gethostbyname>(3) is performed. Reordering is "
6854 "done for all lookup methods. The default value is I<off>."
6858 #: build/C/man5/host.conf.5:135
6864 #: build/C/man5/host.conf.5:139
6866 "There are six environment variables that can be used to allow users to "
6867 "override the behavior which is configured in I</etc/host.conf>."
6871 #: build/C/man5/host.conf.5:139
6873 msgid "B<RESOLV_HOST_CONF>"
6877 #: build/C/man5/host.conf.5:143
6879 "If set this variable points to a file that should be read instead of "
6880 "I</etc/host.conf>."
6884 #: build/C/man5/host.conf.5:143
6886 msgid "B<RESOLV_SERV_ORDER>"
6890 #: build/C/man5/host.conf.5:148
6891 msgid "Overrides the I<order> command."
6895 #: build/C/man5/host.conf.5:148
6897 msgid "B<RESOLV_SPOOF_CHECK>"
6901 #: build/C/man5/host.conf.5:157
6903 "Overrides the I<nospoof>, I<spoofalert> and I<spoof> commands in the same "
6904 "way as the I<spoof> command is parsed. Valid values are I<off>, I<nowarn> "
6909 #: build/C/man5/host.conf.5:157
6911 msgid "B<RESOLV_MULTI>"
6915 #: build/C/man5/host.conf.5:162
6916 msgid "Overrides the I<multi> command."
6920 #: build/C/man5/host.conf.5:162
6922 msgid "B<RESOLV_REORDER>"
6926 #: build/C/man5/host.conf.5:167
6927 msgid "Overrides the I<reorder> command."
6931 #: build/C/man5/host.conf.5:167
6933 msgid "B<RESOLV_ADD_TRIM_DOMAINS>"
6937 #: build/C/man5/host.conf.5:172
6939 "A list of domains, separated by colons (\\(aq:\\(aq), semicolons "
6940 "(\\(aq;\\(aq) or commas (\\(aq,\\(aq), with the leading dot, which will be "
6941 "added to the list of domains that should be trimmed."
6945 #: build/C/man5/host.conf.5:172
6947 msgid "B<RESOLV_OVERRIDE_TRIM_DOMAINS>"
6951 #: build/C/man5/host.conf.5:180
6953 "A list of domains, separated by colons (\\(aq:\\(aq), semicolons "
6954 "(\\(aq;\\(aq) or commas (\\(aq,\\(aq), with the leading dot, which will "
6955 "replace the list of domains that should be trimmed. Overrides the I<trim> "
6960 #: build/C/man5/host.conf.5:184 build/C/man5/host.conf.5:187
6961 msgid "Resolver configuration file"
6965 #: build/C/man5/host.conf.5:184
6967 msgid "I</etc/resolv.conf>"
6971 #: build/C/man5/host.conf.5:190
6972 msgid "Local hosts database"
6976 #: build/C/man5/host.conf.5:199
6978 "The following differences exist compared to the original implementation. A "
6979 "new command I<spoof> and a new environment variable B<RESOLV_SPOOF_CHECK> "
6980 "can take arguments like I<off>, I<nowarn> and I<warn>. Line comments can "
6981 "appear anywhere and not only at the beginning of a line."
6985 #: build/C/man5/host.conf.5:204
6986 msgid "B<gethostbyname>(3), B<hostname>(7), B<named>(8), B<resolv+>(8)"
6990 #: build/C/man7/hostname.7:39
6996 #: build/C/man7/hostname.7:39
7002 #: build/C/man7/hostname.7:42
7003 msgid "hostname - hostname resolution description"
7007 #: build/C/man7/hostname.7:46
7009 "Hostnames are domains, where a domain is a hierarchical, dot-separated list "
7010 "of subdomains; for example, the machine monet, in the Berkeley subdomain of "
7011 "the EDU domain would be represented as \"monet.Berkeley.EDU\"."
7015 #: build/C/man7/hostname.7:55
7017 "Hostnames are often used with network client and server programs, which must "
7018 "generally translate the name to an address for use. (This task is generally "
7019 "performed by either B<getaddrinfo>(3) or the obsolete B<gethostbyname>(3).) "
7020 "Hostnames are resolved by the Internet name resolver in the following "
7025 #: build/C/man7/hostname.7:68
7027 "If the name consists of a single component, that is, contains no dot, and if "
7028 "the environment variable B<HOSTALIASES> is set to the name of a file, that "
7029 "file is searched for any string matching the input hostname. The file "
7030 "should consist of lines made up of two white-space separated strings, the "
7031 "first of which is the hostname alias, and the second of which is the "
7032 "complete hostname to be substituted for that alias. If a case-insensitive "
7033 "match is found between the hostname to be resolved and the first field of a "
7034 "line in the file, the substituted name is looked up with no further "
7039 #: build/C/man7/hostname.7:72
7041 "If the input name ends with a trailing dot, the trailing dot is removed, and "
7042 "the remaining name is looked up with no further processing."
7046 #: build/C/man7/hostname.7:85
7048 "If the input name does not end with a trailing dot, it is looked up by "
7049 "searching through a list of domains until a match is found. The default "
7050 "search list includes first the local domain, then its parent domains with at "
7051 "least 2 name components (longest first). For example, in the domain "
7052 "CS.Berkeley.EDU, the name lithium.CChem will be checked first as "
7053 "lithium.CChem.CS.Berkeley.EDU and then as lithium.CChem.Berkeley.EDU. "
7054 "Lithium.CChem.EDU will not be tried, as there is only one component "
7055 "remaining from the local domain. The search path can be changed from the "
7056 "default by a system-wide configuration file (see B<resolver>(5))."
7060 #. Hostname appeared in
7063 #: build/C/man7/hostname.7:93
7064 msgid "B<gethostbyname>(3), B<resolver>(5), B<mailaddr>(7), B<named>(8)"
7068 #: build/C/man5/hosts.5:27
7074 #: build/C/man5/hosts.5:27
7080 #: build/C/man5/hosts.5:30
7081 msgid "hosts - static table lookup for hostnames"
7085 #: build/C/man5/hosts.5:32
7086 msgid "B</etc/hosts>"
7090 #: build/C/man5/hosts.5:40
7092 "This manual page describes the format of the I</etc/hosts> file. This file "
7093 "is a simple text file that associates IP addresses with hostnames, one line "
7094 "per IP address. For each host a single line should be present with the "
7095 "following information:"
7099 #: build/C/man5/hosts.5:43
7100 msgid "IP_address canonical_hostname [aliases...]"
7104 #: build/C/man5/hosts.5:56
7106 "Fields of the entry are separated by any number of blanks and/or tab "
7107 "characters. Text from a \"#\" character until the end of the line is a "
7108 "comment, and is ignored. Host names may contain only alphanumeric "
7109 "characters, minus signs (\"-\"), and periods (\".\"). They must begin with "
7110 "an alphabetic character and end with an alphanumeric character. Optional "
7111 "aliases provide for name changes, alternate spellings, shorter hostnames, or "
7112 "generic hostnames (for example, I<localhost>)."
7116 #: build/C/man5/hosts.5:64
7118 "The Berkeley Internet Name Domain (BIND) Server implements the Internet name "
7119 "server for UNIX systems. It augments or replaces the I</etc/hosts> file or "
7120 "hostname lookup, and frees a host from relying on I</etc/hosts> being up to "
7121 "date and complete."
7125 #: build/C/man5/hosts.5:67
7127 "In modern systems, even though the host table has been superseded by DNS, it "
7128 "is still widely used for:"
7132 #: build/C/man5/hosts.5:67
7134 msgid "B<bootstrapping>"
7138 #: build/C/man5/hosts.5:73
7140 "Most systems have a small host table containing the name and address "
7141 "information for important hosts on the local network. This is useful when "
7142 "DNS is not running, for example during system bootup."
7146 #: build/C/man5/hosts.5:73
7152 #: build/C/man5/hosts.5:79
7154 "Sites that use NIS use the host table as input to the NIS host database. "
7155 "Even though NIS can be used with DNS, most NIS sites still use the host "
7156 "table with an entry for all local hosts as a backup."
7160 #: build/C/man5/hosts.5:79
7162 msgid "B<isolated nodes>"
7166 #: build/C/man5/hosts.5:86
7168 "Very small sites that are isolated from the network use the host table "
7169 "instead of DNS. If the local information rarely changes, and the network is "
7170 "not connected to the Internet, DNS offers little advantage."
7174 #: build/C/man5/hosts.5:91
7176 "Modifications to this file normally take effect immediately, except in cases "
7177 "where the file is cached by applications."
7181 #: build/C/man5/hosts.5:91
7183 msgid "Historical notes"
7187 #: build/C/man5/hosts.5:94
7189 "RFC\\ 952 gave the original format for the host table, though it has since "
7194 #: build/C/man5/hosts.5:107
7196 "Before the advent of DNS, the host table was the only way of resolving "
7197 "hostnames on the fledgling Internet. Indeed, this file could be created "
7198 "from the official host data base maintained at the Network Information "
7199 "Control Center (NIC), though local changes were often required to bring it "
7200 "up to date regarding unofficial aliases and/or unknown hosts. The NIC no "
7201 "longer maintains the hosts.txt files, though looking around at the time of "
7202 "writing (circa 2000), there are historical hosts.txt files on the WWW. I "
7203 "just found three, from 92, 94, and 95."
7207 #: build/C/man5/hosts.5:114
7210 "127.0.0.1 localhost\n"
7211 "192.168.1.10 foo.mydomain.org foo\n"
7212 "192.168.1.13 bar.mydomain.org bar\n"
7213 "146.82.138.7 master.debian.org master\n"
7214 "209.237.226.90 www.opensource.org\n"
7218 #: build/C/man5/hosts.5:121
7219 msgid "B<hostname>(1), B<resolver>(3), B<resolver>(5), B<hostname>(7), B<named>(8)"
7223 #. This manual page was written by Manoj Srivastava <srivasta@debian.org>,
7224 #. for the Debian GNU/Linux system.
7226 #: build/C/man5/hosts.5:126
7227 msgid "Internet RFC\\ 952"
7231 #: build/C/man5/hosts.equiv.5:6
7237 #: build/C/man5/hosts.equiv.5:6
7243 #: build/C/man5/hosts.equiv.5:11
7245 "/etc/hosts.equiv - list of hosts and users that are granted \"trusted\" B<r> "
7246 "command access to your system"
7250 #: build/C/man5/hosts.equiv.5:22
7252 "The B<hosts.equiv> file allows or denies hosts and users to use the "
7253 "B<r>-commands (e.g., B<rlogin>, B<rsh> or B<rcp>) without supplying a "
7258 #: build/C/man5/hosts.equiv.5:24
7259 msgid "The file uses the following format:"
7263 #: build/C/man5/hosts.equiv.5:24
7265 msgid "I<[ + | - ]> I<[hostname]> I<[username]>"
7269 #: build/C/man5/hosts.equiv.5:43
7271 "The I<hostname> is the name of a host which is logically equivalent to the "
7272 "local host. Users logged into that host are allowed to access like-named "
7273 "user accounts on the local host without supplying a password. The "
7274 "I<hostname> may be (optionally) preceded by a plus (+) sign. If the plus "
7275 "sign is used alone it allows any host to access your system. You can "
7276 "explicitly deny access to a host by preceding the I<hostname> by a minus (-) "
7277 "sign. Users from that host must always supply a password. For security "
7278 "reasons you should always use the FQDN of the hostname and not the short "
7283 #: build/C/man5/hosts.equiv.5:61
7285 "The I<username> entry grants a specific user access to all user accounts "
7286 "(except root) without supplying a password. That means the user is NOT "
7287 "restricted to like-named accounts. The I<username> may be (optionally) "
7288 "preceded by a plus (+) sign. You can also explicitly deny access to a "
7289 "specific user by preceding the I<username> with a minus (-) sign. This says "
7290 "that the user is not trusted no matter what other entries for that host "
7295 #: build/C/man5/hosts.equiv.5:63
7296 msgid "Netgroups can be specified by preceding the netgroup by an @ sign."
7300 #: build/C/man5/hosts.equiv.5:69
7302 "Be extremely careful when using the plus (+) sign. A simple typographical "
7303 "error could result in a standalone plus sign. A standalone plus sign is a "
7304 "wildcard character that means \"any host\"!"
7308 #: build/C/man5/hosts.equiv.5:71
7309 msgid "I</etc/hosts.equiv>"
7313 #: build/C/man5/hosts.equiv.5:76
7315 "Some systems will honor the contents of this file only when it has owner "
7316 "root and no write permission for anybody else. Some exceptionally paranoid "
7317 "systems even require that there be no other hard links to the file."
7321 #: build/C/man5/hosts.equiv.5:84
7323 "Modern systems use the Pluggable Authentication Modules library (PAM). With "
7324 "PAM a standalone plus sign is considered a wildcard character which means "
7325 "\"any host\" only when the word I<promiscuous> is added to the auth "
7326 "component line in your PAM file for the particular service (e.g., "
7331 #: build/C/man5/hosts.equiv.5:88
7332 msgid "B<rhosts>(5), B<rlogind>(8), B<rshd>(8)"
7336 #: build/C/man7/icmp.7:12
7342 #: build/C/man7/icmp.7:12 build/C/man8/nscd.8:23 build/C/man7/packet.7:12 build/C/man7/raw.7:13 build/C/man7/unix.7:18
7348 #: build/C/man7/icmp.7:15
7349 msgid "icmp - Linux IPv4 ICMP kernel module."
7353 #: build/C/man7/icmp.7:23
7355 "This kernel protocol module implements the Internet Control Message Protocol "
7356 "defined in RFC\\ 792. It is used to signal error conditions and for "
7357 "diagnosis. The user doesn't interact directly with this module; instead it "
7358 "communicates with the other protocols in the kernel and these pass the ICMP "
7359 "errors to the application layers. The kernel ICMP module also answers ICMP "
7364 #: build/C/man7/icmp.7:35
7366 "A user protocol may receive ICMP packets for all local sockets by opening a "
7367 "raw socket with the protocol B<IPPROTO_ICMP>. See B<raw>(7) for more "
7368 "information. The types of ICMP packets passed to the socket can be filtered "
7369 "using the B<ICMP_FILTER> socket option. ICMP packets are always processed "
7370 "by the kernel too, even when passed to a user socket."
7374 #: build/C/man7/icmp.7:41
7376 "Linux limits the rate of ICMP error packets to each destination. "
7377 "B<ICMP_REDIRECT> and B<ICMP_DEST_UNREACH> are also limited by the "
7378 "destination route of the incoming packets."
7381 #. FIXME better description needed
7383 #: build/C/man7/icmp.7:54
7385 "ICMP supports a set of I</proc> interfaces to configure some global IP "
7386 "parameters. The parameters can be accessed by reading or writing files in "
7387 "the directory I</proc/sys/net/ipv4/>. Most of these parameters are rate "
7388 "limitations for specific ICMP types. Linux 2.2 uses a token bucket filter "
7389 "to limit ICMPs. The value is the timeout in jiffies until the token bucket "
7390 "filter is cleared after a burst. A jiffy is a system dependent unit, "
7391 "usually 10ms on i386 and about 1ms on alpha and ia64."
7395 #: build/C/man7/icmp.7:54
7397 msgid "I<icmp_destunreach_rate> (Linux 2.2 to 2.4.9)"
7400 #. Precisely: from 2.1.102
7402 #: build/C/man7/icmp.7:63
7404 "Maximum rate to send ICMP Destination Unreachable packets. This limits the "
7405 "rate at which packets are sent to any individual route or destination. The "
7406 "limit does not affect sending of B<ICMP_FRAG_NEEDED> packets needed for path "
7411 #: build/C/man7/icmp.7:63
7413 msgid "I<icmp_echo_ignore_all> (since Linux 2.2)"
7416 #. Precisely: 2.1.68
7418 #: build/C/man7/icmp.7:69
7419 msgid "If this value is nonzero, Linux will ignore all B<ICMP_ECHO> requests."
7423 #: build/C/man7/icmp.7:69
7425 msgid "I<icmp_echo_ignore_broadcasts> (since Linux 2.2)"
7428 #. Precisely: from 2.1.68
7430 #: build/C/man7/icmp.7:75
7432 "If this value is nonzero, Linux will ignore all B<ICMP_ECHO> packets sent to "
7433 "broadcast addresses."
7437 #: build/C/man7/icmp.7:75
7439 msgid "I<icmp_echoreply_rate> (Linux 2.2 to 2.4.9)"
7442 #. Precisely: from 2.1.102
7444 #: build/C/man7/icmp.7:83
7446 "Maximum rate for sending B<ICMP_ECHOREPLY> packets in response to "
7447 "B<ICMP_ECHOREQUEST> packets."
7451 #: build/C/man7/icmp.7:83
7454 "I<icmp_errors_use_inbound_ifaddr> (Boolean; default: disabled; since Linux "
7458 #. The following taken from 2.6.28-rc4 Documentation/networking/ip-sysctl.txt
7460 #: build/C/man7/icmp.7:88
7462 "If disabled, ICMP error messages are sent with the primary address of the "
7463 "exiting interface."
7467 #: build/C/man7/icmp.7:94
7469 "If enabled, the message will be sent with the primary address of the "
7470 "interface that received the packet that caused the ICMP error. This is the "
7471 "behavior that many network administrators will expect from a router. And it "
7472 "can make debugging complicated network layouts much easier."
7476 #: build/C/man7/icmp.7:98
7478 "Note that if no primary address exists for the interface selected, then the "
7479 "primary address of the first non-loopback interface that has one will be "
7480 "used regardless of this setting."
7484 #: build/C/man7/icmp.7:98
7487 "I<icmp_ignore_bogus_error_responses> (Boolean; default: disabled; since "
7491 #. precisely: since 2.1.32
7492 #. The following taken from 2.6.28-rc4 Documentation/networking/ip-sysctl.txt
7494 #: build/C/man7/icmp.7:106
7496 "Some routers violate RFC1122 by sending bogus responses to broadcast "
7497 "frames. Such violations are normally logged via a kernel warning. If this "
7498 "parameter is enabled, the kernel will not give such warnings, which will "
7499 "avoid log file clutter."
7503 #: build/C/man7/icmp.7:106
7505 msgid "I<icmp_paramprob_rate> (Linux 2.2 to 2.4.9)"
7508 #. Precisely: from 2.1.102
7510 #: build/C/man7/icmp.7:113
7512 "Maximum rate for sending B<ICMP_PARAMETERPROB> packets. These packets are "
7513 "sent when a packet arrives with an invalid IP header."
7517 #: build/C/man7/icmp.7:113
7519 msgid "I<icmp_ratelimit> (integer; default: 1000; since Linux 2.4.10)"
7522 #. The following taken from 2.6.28-rc4 Documentation/networking/ip-sysctl.txt
7524 #: build/C/man7/icmp.7:121
7526 "Limit the maximum rates for sending ICMP packets whose type matches "
7527 "I<icmp_ratemask> (see below) to specific targets. 0 to disable any "
7528 "limiting, otherwise the minimum space between responses in milliseconds."
7532 #: build/C/man7/icmp.7:121
7534 msgid "I<icmp_ratemask> (integer; default: see below; since Linux 2.4.10)"
7537 #. The following taken from 2.6.28-rc4 Documentation/networking/ip-sysctl.txt
7539 #: build/C/man7/icmp.7:125
7540 msgid "Mask made of ICMP types for which rates are being limited."
7544 #: build/C/man7/icmp.7:127
7545 msgid "Significant bits: IHGFEDCBA9876543210"
7549 #: build/C/man7/icmp.7:129
7550 msgid "Default mask: 0000001100000011000 (0x1818)"
7554 #: build/C/man7/icmp.7:132
7555 msgid "Bit definitions (see the Linux kernel source file I<include/linux/icmp.h>):"
7559 #: build/C/man7/icmp.7:136
7561 msgid "0 Echo Reply\n"
7565 #: build/C/man7/icmp.7:137
7567 msgid "3 Destination Unreachable *\n"
7571 #: build/C/man7/icmp.7:138
7573 msgid "4 Source Quench *\n"
7577 #: build/C/man7/icmp.7:139
7579 msgid "5 Redirect\n"
7583 #: build/C/man7/icmp.7:140
7585 msgid "8 Echo Request\n"
7589 #: build/C/man7/icmp.7:141
7591 msgid "B Time Exceeded *\n"
7595 #: build/C/man7/icmp.7:142
7597 msgid "C Parameter Problem *\n"
7601 #: build/C/man7/icmp.7:143
7603 msgid "D Timestamp Request\n"
7607 #: build/C/man7/icmp.7:144
7609 msgid "E Timestamp Reply\n"
7613 #: build/C/man7/icmp.7:145
7615 msgid "F Info Request\n"
7619 #: build/C/man7/icmp.7:146
7621 msgid "G Info Reply\n"
7625 #: build/C/man7/icmp.7:147
7627 msgid "H Address Mask Request\n"
7631 #: build/C/man7/icmp.7:148
7633 msgid "I Address Mask Reply\n"
7637 #: build/C/man7/icmp.7:154
7639 "The bits marked with an asterisk are rate limited by default (see the "
7640 "default mask above)."
7644 #: build/C/man7/icmp.7:154
7646 msgid "I<icmp_timeexceed_rate> (Linux 2.2 to 2.4.9)"
7650 #: build/C/man7/icmp.7:161
7652 "Maximum rate for sending B<ICMP_TIME_EXCEEDED> packets. These packets are "
7653 "sent to prevent loops when a packet has crossed too many hops."
7657 #: build/C/man7/icmp.7:165
7658 msgid "Support for the B<ICMP_ADDRESS> request was removed in 2.2."
7662 #: build/C/man7/icmp.7:169
7663 msgid "Support for B<ICMP_SOURCE_QUENCH> was removed in Linux 2.2."
7666 #. not really true ATM
7668 #. Linux ICMP should be compliant to RFC 1122.
7670 #: build/C/man7/icmp.7:177
7672 "As many other implementations don't support B<IPPROTO_ICMP> raw sockets, "
7673 "this feature should not be relied on in portable programs."
7677 #: build/C/man7/icmp.7:182
7679 "B<ICMP_REDIRECT> packets are not sent when Linux is not acting as a router. "
7680 "They are also accepted only from the old gateway defined in the routing "
7681 "table and the redirect routes are expired after some time."
7685 #: build/C/man7/icmp.7:186
7687 "The 64-bit timestamp returned by B<ICMP_TIMESTAMP> is in milliseconds since "
7688 "the Epoch, 1970-01-01 00:00:00 +0000 (UTC)."
7692 #: build/C/man7/icmp.7:191
7694 "Linux ICMP internally uses a raw socket to send ICMPs. This raw socket may "
7695 "appear in B<netstat>(8) output with a zero inode."
7699 #: build/C/man7/icmp.7:193
7704 #: build/C/man7/icmp.7:195
7705 msgid "RFC\\ 792 for a description of the ICMP protocol."
7709 #: build/C/man3/inet.3:42
7715 #: build/C/man3/inet.3:42
7721 #: build/C/man3/inet.3:46
7723 "inet_aton, inet_addr, inet_network, inet_ntoa, inet_makeaddr, inet_lnaof, "
7724 "inet_netof - Internet address manipulation routines"
7728 #: build/C/man3/inet.3:51
7731 "B<#include E<lt>sys/socket.hE<gt>>\n"
7732 "B<#include E<lt>netinet/in.hE<gt>>\n"
7733 "B<#include E<lt>arpa/inet.hE<gt>>\n"
7737 #: build/C/man3/inet.3:53
7739 msgid "B<int inet_aton(const char *>I<cp>B<, struct in_addr *>I<inp>B<);>\n"
7743 #: build/C/man3/inet.3:55
7745 msgid "B<in_addr_t inet_addr(const char *>I<cp>B<);>\n"
7749 #: build/C/man3/inet.3:57
7751 msgid "B<in_addr_t inet_network(const char *>I<cp>B<);>\n"
7755 #: build/C/man3/inet.3:59
7757 msgid "B<char *inet_ntoa(struct in_addr >I<in>B<);>\n"
7761 #: build/C/man3/inet.3:61
7763 msgid "B<struct in_addr inet_makeaddr(int >I<net>B<, int >I<host>B<);>\n"
7767 #: build/C/man3/inet.3:63
7769 msgid "B<in_addr_t inet_lnaof(struct in_addr >I<in>B<);>\n"
7773 #: build/C/man3/inet.3:65
7775 msgid "B<in_addr_t inet_netof(struct in_addr >I<in>B<);>\n"
7779 #: build/C/man3/inet.3:75
7780 msgid "B<inet_aton>(), B<inet_ntoa>(): _BSD_SOURCE || _SVID_SOURCE"
7784 #: build/C/man3/inet.3:85
7786 "B<inet_aton>() converts the Internet host address I<cp> from the IPv4 "
7787 "numbers-and-dots notation into binary form (in network byte order) and "
7788 "stores it in the structure that I<inp> points to. B<inet_aton>() returns "
7789 "nonzero if the address is valid, zero if not. The address supplied in I<cp> "
7790 "can have one of the following forms:"
7794 #: build/C/man3/inet.3:85
7800 #: build/C/man3/inet.3:89
7802 "Each of the four numeric parts specifies a byte of the address; the bytes "
7803 "are assigned in left-to-right order to produce the binary address."
7807 #: build/C/man3/inet.3:89
7813 #: build/C/man3/inet.3:102
7815 "Parts I<a> and I<b> specify the first two bytes of the binary address. Part "
7816 "I<c> is interpreted as a 16-bit value that defines the rightmost two bytes "
7817 "of the binary address. This notation is suitable for specifying (outmoded) "
7818 "Class B network addresses."
7822 #: build/C/man3/inet.3:102
7828 #: build/C/man3/inet.3:113
7830 "Part I<a> specifies the first byte of the binary address. Part I<b> is "
7831 "interpreted as a 24-bit value that defines the rightmost three bytes of the "
7832 "binary address. This notation is suitable for specifying (outmoded) Class C "
7833 "network addresses."
7837 #: build/C/man3/inet.3:113
7843 #: build/C/man3/inet.3:119
7845 "The value I<a> is interpreted as a 32-bit value that is stored directly into "
7846 "the binary address without any byte rearrangement."
7850 #: build/C/man3/inet.3:132
7852 "In all of the above forms, components of the dotted address can be specified "
7853 "in decimal, octal (with a leading I<0>), or hexadecimal, with a leading "
7854 "I<0X>). Addresses in any of these forms are collectively termed I<IPV4 "
7855 "numbers-and-dots notation>. The form that uses exactly four decimal numbers "
7856 "is referred to as I<IPv4 dotted-decimal notation> (or sometimes: I<IPv4 "
7857 "dotted-quad notation>)."
7861 #: build/C/man3/inet.3:149
7863 "The B<inet_addr>() function converts the Internet host address I<cp> from "
7864 "IPv4 numbers-and-dots notation into binary data in network byte order. If "
7865 "the input is invalid, B<INADDR_NONE> (usually -1) is returned. Use of this "
7866 "function is problematic because -1 is a valid address (255.255.255.255). "
7867 "Avoid its use in favor of B<inet_aton>(), B<inet_pton>(3), or "
7868 "B<getaddrinfo>(3) which provide a cleaner way to indicate error return."
7872 #: build/C/man3/inet.3:159
7874 "The B<inet_network>() function converts I<cp>, a string in IPv4 "
7875 "numbers-and-dots notation, into a number in host byte order suitable for use "
7876 "as an Internet network address. On success, the converted address is "
7877 "returned. If the input is invalid, -1 is returned."
7881 #: build/C/man3/inet.3:167
7883 "The B<inet_ntoa>() function converts the Internet host address I<in>, given "
7884 "in network byte order, to a string in IPv4 dotted-decimal notation. The "
7885 "string is returned in a statically allocated buffer, which subsequent calls "
7890 #: build/C/man3/inet.3:173
7892 "The B<inet_lnaof>() function returns the local network address part of the "
7893 "Internet address I<in>. The returned value is in host byte order."
7897 #: build/C/man3/inet.3:179
7899 "The B<inet_netof>() function returns the network number part of the "
7900 "Internet address I<in>. The returned value is in host byte order."
7904 #: build/C/man3/inet.3:190
7906 "The B<inet_makeaddr>() function is the converse of B<inet_netof>() and "
7907 "B<inet_lnaof>(). It returns an Internet host address in network byte order, "
7908 "created by combining the network number I<net> with the local address "
7909 "I<host>, both in host byte order."
7913 #: build/C/man3/inet.3:200
7915 "The structure I<in_addr> as used in B<inet_ntoa>(), B<inet_makeaddr>(), "
7916 "B<inet_lnaof>() and B<inet_netof>() is defined in "
7917 "I<E<lt>netinet/in.hE<gt>> as:"
7921 #: build/C/man3/inet.3:204
7923 msgid "typedef uint32_t in_addr_t;\n"
7927 #: build/C/man3/inet.3:208
7930 "struct in_addr {\n"
7931 " in_addr_t s_addr;\n"
7936 #: build/C/man3/inet.3:218
7938 "4.3BSD. B<inet_addr>() and B<inet_ntoa>() are specified in POSIX.1-2001. "
7939 "B<inet_aton>() is not specified in POSIX.1-2001, but is available on most "
7944 #: build/C/man3/inet.3:222
7946 "On the i386 the host byte order is Least Significant Byte first (little "
7947 "endian), whereas the network byte order, as used on the Internet, is Most "
7948 "Significant Byte first (big endian)."
7952 #: build/C/man3/inet.3:231
7954 "B<inet_lnaof>(), B<inet_netof>(), and B<inet_makeaddr>() are legacy "
7955 "functions that assume they are dealing with I<classful network addresses>. "
7956 "Classful networking divides IPv4 network addresses into host and network "
7957 "components at byte boundaries, as follows:"
7961 #: build/C/man3/inet.3:231
7967 #: build/C/man3/inet.3:237
7969 "This address type is indicated by the value 0 in the most significant bit of "
7970 "the (network byte ordered) address. The network address is contained in the "
7971 "most significant byte, and the host address occupies the remaining three "
7976 #: build/C/man3/inet.3:237
7982 #: build/C/man3/inet.3:243
7984 "This address type is indicated by the binary value 10 in the most "
7985 "significant two bits of the address. The network address is contained in "
7986 "the two most significant bytes, and the host address occupies the remaining "
7991 #: build/C/man3/inet.3:243
7997 #: build/C/man3/inet.3:249
7999 "This address type is indicated by the binary value 110 in the most "
8000 "significant three bits of the address. The network address is contained in "
8001 "the three most significant bytes, and the host address occupies the "
8006 #: build/C/man3/inet.3:254
8008 "Classful network addresses are now obsolete, having been superseded by "
8009 "Classless Inter-Domain Routing (CIDR), which divides addresses into network "
8010 "and host components at arbitrary bit (rather than byte) boundaries."
8014 #: build/C/man3/inet.3:261
8016 "An example of the use of B<inet_aton>() and B<inet_ntoa>() is shown "
8017 "below. Here are some example runs:"
8021 #: build/C/man3/inet.3:268
8024 "$B< ./a.out 226.000.000.037> # Last byte is in octal\n"
8026 "$B< ./a.out 0x7f.1 > # First byte is in hex\n"
8031 #: build/C/man3/inet.3:277
8034 "#define _BSD_SOURCE\n"
8035 "#include E<lt>arpa/inet.hE<gt>\n"
8036 "#include E<lt>stdio.hE<gt>\n"
8037 "#include E<lt>stdlib.hE<gt>\n"
8041 #: build/C/man3/inet.3:282
8045 "main(int argc, char *argv[])\n"
8047 " struct in_addr addr;\n"
8051 #: build/C/man3/inet.3:287
8054 " if (argc != 2) {\n"
8055 " fprintf(stderr, \"%s E<lt>dotted-addressE<gt>\\en\", argv[0]);\n"
8056 " exit(EXIT_FAILURE);\n"
8061 #: build/C/man3/inet.3:292
8064 " if (inet_aton(argv[1], &addr) == 0) {\n"
8065 " fprintf(stderr, \"Invalid address\\en\");\n"
8066 " exit(EXIT_FAILURE);\n"
8071 #: build/C/man3/inet.3:296
8074 " printf(\"%s\\en\", inet_ntoa(addr));\n"
8075 " exit(EXIT_SUCCESS);\n"
8080 #: build/C/man3/inet.3:307
8082 "B<byteorder>(3), B<getaddrinfo>(3), B<gethostbyname>(3), B<getnameinfo>(3), "
8083 "B<getnetent>(3), B<inet_ntop>(3), B<inet_pton>(3), B<hosts>(5), "
8088 #: build/C/man3/inet_ntop.3:26
8094 #: build/C/man3/inet_ntop.3:26
8100 #: build/C/man3/inet_ntop.3:29
8101 msgid "inet_ntop - convert IPv4 and IPv6 addresses from binary to text form"
8105 #: build/C/man3/inet_ntop.3:35
8108 "B<const char *inet_ntop(int >I<af>B<, const void *>I<src>B<,>\n"
8109 "B< char *>I<dst>B<, socklen_t >I<size>B<);>\n"
8113 #: build/C/man3/inet_ntop.3:48
8115 "This function converts the network address structure I<src> in the I<af> "
8116 "address family into a character string. The resulting string is copied to "
8117 "the buffer pointed to by I<dst>, which must be a non-NULL pointer. The "
8118 "caller specifies the number of bytes available in this buffer in the "
8123 #: build/C/man3/inet_ntop.3:57
8125 "B<inet_ntop>() extends the B<inet_ntoa>(3) function to support multiple "
8126 "address families, B<inet_ntoa>(3) is now considered to be deprecated in "
8127 "favor of B<inet_ntop>(). The following address families are currently "
8132 #: build/C/man3/inet_ntop.3:70
8134 "I<src> points to a I<struct in_addr> (in network byte order) which is "
8135 "converted to an IPv4 network address in the dotted-decimal format, "
8136 "\"I<ddd.ddd.ddd.ddd>\". The buffer I<dst> must be at least "
8137 "B<INET_ADDRSTRLEN> bytes long."
8141 #: build/C/man3/inet_ntop.3:83
8143 "I<src> points to a I<struct in6_addr> (in network byte order) which is "
8144 "converted to a representation of this address in the most appropriate IPv6 "
8145 "network address format for this address. The buffer I<dst> must be at least "
8146 "B<INET6_ADDRSTRLEN> bytes long."
8150 #: build/C/man3/inet_ntop.3:91
8152 "On success, B<inet_ntop>() returns a non-NULL pointer to I<dst>. NULL is "
8153 "returned if there was an error, with I<errno> set to indicate the error."
8157 #: build/C/man3/inet_ntop.3:92
8159 msgid "B<EAFNOSUPPORT>"
8163 #: build/C/man3/inet_ntop.3:96
8164 msgid "I<af> was not a valid address family."
8168 #: build/C/man3/inet_ntop.3:96
8174 #: build/C/man3/inet_ntop.3:100
8175 msgid "The converted address string would exceed the size given by I<size>."
8178 #. 2.1.3: size_t, 2.1.91: socklen_t
8180 #: build/C/man3/inet_ntop.3:112
8182 "POSIX.1-2001. Note that RFC\\ 2553 defines a prototype where the last "
8183 "argument I<size> is of type I<size_t>. Many systems follow RFC\\ 2553. "
8184 "Glibc 2.0 and 2.1 have I<size_t>, but 2.2 and later have I<socklen_t>."
8188 #: build/C/man3/inet_ntop.3:115
8189 msgid "B<AF_INET6> converts IPv4-mapped IPv6 addresses into an IPv6 format."
8193 #: build/C/man3/inet_ntop.3:118
8194 msgid "See B<inet_pton>(3)."
8198 #: build/C/man3/inet_ntop.3:122
8199 msgid "B<getnameinfo>(3), B<inet>(3), B<inet_pton>(3)"
8203 #: build/C/man3/inet_pton.3:27
8209 #: build/C/man3/inet_pton.3:27
8215 #: build/C/man3/inet_pton.3:30
8216 msgid "inet_pton - convert IPv4 and IPv6 addresses from text to binary form"
8220 #: build/C/man3/inet_pton.3:35
8222 msgid "B<int inet_pton(int >I<af>B<, const char *>I<src>B<, void *>I<dst>B<);>\n"
8226 #: build/C/man3/inet_pton.3:51
8228 "This function converts the character string I<src> into a network address "
8229 "structure in the I<af> address family, then copies the network address "
8230 "structure to I<dst>. The I<af> argument must be either B<AF_INET> or "
8235 #: build/C/man3/inet_pton.3:53
8236 msgid "The following address families are currently supported:"
8240 #: build/C/man3/inet_pton.3:67
8242 "I<src> points to a character string containing an IPv4 network address in "
8243 "dotted-decimal format, \"I<ddd.ddd.ddd.ddd>\", where I<ddd> is a decimal "
8244 "number of up to three digits in the range 0 to 255. The address is "
8245 "converted to a I<struct in_addr> and copied to I<dst>, which must be "
8246 "I<sizeof(struct in_addr)> (4) bytes (32 bits) long."
8250 #: build/C/man3/inet_pton.3:79
8252 "I<src> points to a character string containing an IPv6 network address. The "
8253 "address is converted to a I<struct in6_addr> and copied to I<dst>, which "
8254 "must be I<sizeof(struct in6_addr)> (16) bytes (128 bits) long. The allowed "
8255 "formats for IPv6 addresses follow these rules:"
8259 #: build/C/man3/inet_pton.3:80
8265 #: build/C/man3/inet_pton.3:87
8267 "The preferred format is I<x:x:x:x:x:x:x:x>. This form consists of eight "
8268 "hexadecimal numbers, each of which expresses a 16-bit value (i.e., each I<x> "
8269 "can be up to 4 hex digits)."
8273 #: build/C/man3/inet_pton.3:87
8279 #: build/C/man3/inet_pton.3:100
8281 "A series of contiguous zero values in the preferred format can be "
8282 "abbreviated to I<::>. Only one instance of I<::> can occur in an address. "
8283 "For example, the loopback address I<0:0:0:0:0:0:0:1> can be abbreviated as "
8284 "I<::1>. The wildcard address, consisting of all zeros, can be written as "
8289 #: build/C/man3/inet_pton.3:100
8295 #: build/C/man3/inet_pton.3:113
8297 "An alternate format is useful for expressing IPv4-mapped IPv6 addresses. "
8298 "This form is written as I<x:x:x:x:x:x:d.d.d.d>, where the six leading I<x>s "
8299 "are hexadecimal values that define the six most-significant 16-bit pieces of "
8300 "the address (i.e., 96 bits), and the I<d>s express a value in dotted-decimal "
8301 "notation that defines the least significant 32 bits of the address. An "
8302 "example of such an address is I<::FFFF:204.152.189.116>."
8306 #: build/C/man3/inet_pton.3:116
8307 msgid "See RFC 2373 for further details on the representation of IPv6 addresses."
8311 #: build/C/man3/inet_pton.3:129
8313 "B<inet_pton>() returns 1 on success (network address was successfully "
8314 "converted). 0 is returned if I<src> does not contain a character string "
8315 "representing a valid network address in the specified address family. If "
8316 "I<af> does not contain a valid address family, -1 is returned and I<errno> "
8317 "is set to B<EAFNOSUPPORT>."
8321 #: build/C/man3/inet_pton.3:150
8323 "Unlike B<inet_aton>(3) and B<inet_addr>(3), B<inet_pton>() supports IPv6 "
8324 "addresses. On the other hand, B<inet_pton>() accepts only IPv4 addresses "
8325 "in dotted-decimal notation, whereas B<inet_aton>(3) and B<inet_addr>(3) "
8326 "allow the more general numbers-and-dots notation (hexadecimal and octal "
8327 "number formats, and formats that don't require all four bytes to be "
8328 "explicitly written). For an interface that handles both IPv6 addresses, and "
8329 "IPv4 addresses in numbers-and-dots notation, see B<getaddrinfo>(3)."
8333 #: build/C/man3/inet_pton.3:156
8335 "B<AF_INET6> does not recognize IPv4 addresses. An explicit IPv4-mapped IPv6 "
8336 "address must be supplied in I<src> instead."
8340 #: build/C/man3/inet_pton.3:162
8342 "The program below demonstrates the use of B<inet_pton>() and "
8343 "B<inet_ntop>(3). Here are some example runs:"
8347 #: build/C/man3/inet_pton.3:171
8350 "$B< ./a.out i6 0:0:0:0:0:0:0:0>\n"
8352 "$B< ./a.out i6 1:0:0:0:0:0:0:8>\n"
8354 "$B< ./a.out i6 0:0:0:0:0:FFFF:204.152.189.116>\n"
8355 "::ffff:204.152.189.116\n"
8359 #: build/C/man3/inet_pton.3:180
8362 "#include E<lt>arpa/inet.hE<gt>\n"
8363 "#include E<lt>stdio.hE<gt>\n"
8364 "#include E<lt>stdlib.hE<gt>\n"
8365 "#include E<lt>string.hE<gt>\n"
8369 #: build/C/man3/inet_pton.3:187
8373 "main(int argc, char *argv[])\n"
8375 " unsigned char buf[sizeof(struct in6_addr)];\n"
8377 " char str[INET6_ADDRSTRLEN];\n"
8381 #: build/C/man3/inet_pton.3:192
8384 " if (argc != 3) {\n"
8385 " fprintf(stderr, \"Usage: %s {i4|i6|E<lt>numE<gt>} string\\en\", "
8387 " exit(EXIT_FAILURE);\n"
8392 #: build/C/man3/inet_pton.3:195
8395 " domain = (strcmp(argv[1], \"i4\") == 0) ? AF_INET :\n"
8396 " (strcmp(argv[1], \"i6\") == 0) ? AF_INET6 : atoi(argv[1]);\n"
8400 #: build/C/man3/inet_pton.3:204
8403 " s = inet_pton(domain, argv[2], buf);\n"
8404 " if (s E<lt>= 0) {\n"
8406 " fprintf(stderr, \"Not in presentation format\");\n"
8408 " perror(\"inet_pton\");\n"
8409 " exit(EXIT_FAILURE);\n"
8414 #: build/C/man3/inet_pton.3:209
8417 " if (inet_ntop(domain, buf, str, INET6_ADDRSTRLEN) == NULL) {\n"
8418 " perror(\"inet_ntop\");\n"
8419 " exit(EXIT_FAILURE);\n"
8424 #: build/C/man3/inet_pton.3:211
8426 msgid " printf(\"%s\\en\", str);\n"
8430 #: build/C/man3/inet_pton.3:219
8431 msgid "B<getaddrinfo>(3), B<inet>(3), B<inet_ntop>(3)"
8435 #: build/C/man7/ip.7:36
8441 #: build/C/man7/ip.7:36
8447 #: build/C/man7/ip.7:39
8448 msgid "ip - Linux IPv4 protocol implementation"
8452 #: build/C/man7/ip.7:45 build/C/man7/ipv6.7:93 build/C/man7/raw.7:20 build/C/man7/tcp.7:72 build/C/man7/udp.7:19
8453 msgid "B<#include E<lt>netinet/in.hE<gt>>"
8457 #: build/C/man7/ip.7:47
8458 msgid "B<#include E<lt>netinet/ip.hE<gt> >/* superset of previous */"
8462 #: build/C/man7/ip.7:49
8463 msgid "I<tcp_socket>B< = socket(AF_INET, SOCK_STREAM, 0);>"
8467 #: build/C/man7/ip.7:51
8468 msgid "I<udp_socket>B< = socket(AF_INET, SOCK_DGRAM, 0);>"
8472 #: build/C/man7/ip.7:53
8473 msgid "I<raw_socket>B< = socket(AF_INET, SOCK_RAW, >I<protocol>B<);>"
8476 #. FIXME has someone verified that 2.1 is really 1812 compliant?
8478 #: build/C/man7/ip.7:60
8480 "Linux implements the Internet Protocol, version 4, described in RFC\\ 791 "
8481 "and RFC\\ 1122. B<ip> contains a level 2 multicasting implementation "
8482 "conforming to RFC\\ 1112. It also contains an IP router including a packet "
8487 #: build/C/man7/ip.7:64
8489 "The programming interface is BSD-sockets compatible. For more information "
8490 "on sockets, see B<socket>(7)."
8494 #: build/C/man7/ip.7:95
8496 "An IP socket is created by calling the B<socket>(2) function as "
8497 "B<socket(AF_INET, >I<socket_type>B<, >I<protocol>B<)>. Valid socket types "
8498 "are B<SOCK_STREAM> to open a B<tcp>(7) socket, B<SOCK_DGRAM> to open a "
8499 "B<udp>(7) socket, or B<SOCK_RAW> to open a B<raw>(7) socket to access the "
8500 "IP protocol directly. I<protocol> is the IP protocol in the IP header to be "
8501 "received or sent. The only valid values for I<protocol> are 0 and "
8502 "B<IPPROTO_TCP> for TCP sockets, and 0 and B<IPPROTO_UDP> for UDP sockets. "
8503 "For B<SOCK_RAW> you may specify a valid IANA IP protocol defined in RFC\\ "
8504 "1700 assigned numbers."
8508 #: build/C/man7/ip.7:117
8510 "When a process wants to receive new incoming packets or connections, it "
8511 "should bind a socket to a local interface address using B<bind>(2). In this "
8512 "case, only one IP socket may be bound to any given local (address, port) "
8513 "pair. When B<INADDR_ANY> is specified in the bind call, the socket will be "
8514 "bound to I<all> local interfaces. When B<listen>(2) is called on an "
8515 "unbound socket, the socket is automatically bound to a random free port with "
8516 "the local address set to B<INADDR_ANY>. When B<connect>(2) is called on an "
8517 "unbound socket, the socket is automatically bound to a random free port or "
8518 "to a usable shared port with the local address set to B<INADDR_ANY>."
8522 #: build/C/man7/ip.7:123
8524 "A TCP local socket address that has been bound is unavailable for some time "
8525 "after closing, unless the B<SO_REUSEADDR> flag has been set. Care should be "
8526 "taken when using this flag as it makes TCP less reliable."
8530 #: build/C/man7/ip.7:134
8532 "An IP socket address is defined as a combination of an IP interface address "
8533 "and a 16-bit port number. The basic IP protocol does not supply port "
8534 "numbers, they are implemented by higher level protocols like B<udp>(7) and "
8535 "B<tcp>(7). On raw sockets I<sin_port> is set to the IP protocol."
8539 #: build/C/man7/ip.7:142
8542 "struct sockaddr_in {\n"
8543 " sa_family_t sin_family; /* address family: AF_INET */\n"
8544 " in_port_t sin_port; /* port in network byte order */\n"
8545 " struct in_addr sin_addr; /* internet address */\n"
8550 #: build/C/man7/ip.7:147
8553 "/* Internet address. */\n"
8554 "struct in_addr {\n"
8555 " uint32_t s_addr; /* address in network byte order */\n"
8560 #: build/C/man7/ip.7:172
8562 "I<sin_family> is always set to B<AF_INET>. This is required; in Linux 2.2 "
8563 "most networking functions return B<EINVAL> when this setting is missing. "
8564 "I<sin_port> contains the port in network byte order. The port numbers below "
8565 "1024 are called I<privileged ports> (or sometimes: I<reserved ports>). Only "
8566 "privileged processes (i.e., those having the B<CAP_NET_BIND_SERVICE> "
8567 "capability) may B<bind>(2) to these sockets. Note that the raw IPv4 "
8568 "protocol as such has no concept of a port, they are implemented only by "
8569 "higher protocols like B<tcp>(7) and B<udp>(7)."
8573 #: build/C/man7/ip.7:191
8575 "I<sin_addr> is the IP host address. The I<s_addr> member of I<struct "
8576 "in_addr> contains the host interface address in network byte order. "
8577 "I<in_addr> should be assigned one of the B<INADDR_*> values (e.g., "
8578 "B<INADDR_ANY>) or set using the B<inet_aton>(3), B<inet_addr>(3), "
8579 "B<inet_makeaddr>(3) library functions or directly with the name resolver "
8580 "(see B<gethostbyname>(3))."
8583 #. Leave a loophole for XTP @)
8585 #: build/C/man7/ip.7:203
8587 "IPv4 addresses are divided into unicast, broadcast and multicast addresses. "
8588 "Unicast addresses specify a single interface of a host, broadcast addresses "
8589 "specify all hosts on a network and multicast addresses address all hosts in "
8590 "a multicast group. Datagrams to broadcast addresses can be sent or received "
8591 "only when the B<SO_BROADCAST> socket flag is set. In the current "
8592 "implementation, connection-oriented sockets are allowed to use only unicast "
8597 #: build/C/man7/ip.7:211
8599 "Note that the address and the port are always stored in network byte order. "
8600 "In particular, this means that you need to call B<htons>(3) on the number "
8601 "that is assigned to a port. All address/port manipulation functions in the "
8602 "standard library work in network byte order."
8606 #: build/C/man7/ip.7:224
8608 "There are several special addresses: B<INADDR_LOOPBACK> (127.0.0.1) always "
8609 "refers to the local host via the loopback device; B<INADDR_ANY> (0.0.0.0) "
8610 "means any address for binding; B<INADDR_BROADCAST> (255.255.255.255) means "
8611 "any host and has the same effect on bind as B<INADDR_ANY> for historical "
8615 #. or SOL_IP on Linux
8617 #: build/C/man7/ip.7:233
8619 "IP supports some protocol-specific socket options that can be set with "
8620 "B<setsockopt>(2) and read with B<getsockopt>(2). The socket option level "
8621 "for IP is B<IPPROTO_IP>. A boolean integer flag is zero when it is false, "
8626 #: build/C/man7/ip.7:233
8628 msgid "B<IP_ADD_MEMBERSHIP> (since Linux 1.2)"
8632 #: build/C/man7/ip.7:239
8633 msgid "Join a multicast group. Argument is an I<ip_mreqn> structure."
8637 #: build/C/man7/ip.7:249
8640 "struct ip_mreqn {\n"
8641 " struct in_addr imr_multiaddr; /* IP multicast group\n"
8643 " struct in_addr imr_address; /* IP address of local\n"
8645 " int imr_ifindex; /* interface index */\n"
8649 #. (i.e., within the 224.0.0.0-239.255.255.255 range)
8651 #: build/C/man7/ip.7:270
8653 "I<imr_multiaddr> contains the address of the multicast group the application "
8654 "wants to join or leave. It must be a valid multicast address (or "
8655 "B<setsockopt>(2) fails with the error B<EINVAL>). I<imr_address> is the "
8656 "address of the local interface with which the system should join the "
8657 "multicast group; if it is equal to B<INADDR_ANY> an appropriate interface is "
8658 "chosen by the system. I<imr_ifindex> is the interface index of the "
8659 "interface that should join/leave the I<imr_multiaddr> group, or 0 to "
8660 "indicate any interface."
8664 #: build/C/man7/ip.7:285
8666 "The I<ip_mreqn> structure is available only since Linux 2.2. For "
8667 "compatibility, the old I<ip_mreq> structure (present since Linux 1.2) is "
8668 "still supported; it differs from I<ip_mreqn> only by not including the "
8669 "I<imr_ifindex> field. Only valid as a B<setsockopt>(2)."
8673 #: build/C/man7/ip.7:285
8675 msgid "B<IP_ADD_SOURCE_MEMBERSHIP> (since Linux 2.4.22 / 2.5.68)"
8679 #: build/C/man7/ip.7:292
8681 "Join a multicast group and allow receiving data only from a specified "
8682 "source. Argument is an I<ip_mreq_source> structure."
8686 #: build/C/man7/ip.7:303
8689 "struct ip_mreq_source {\n"
8690 " struct in_addr imr_multiaddr; /* IP multicast group\n"
8692 " struct in_addr imr_interface; /* IP address of local\n"
8694 " struct in_addr imr_sourceaddr; /* IP address of\n"
8695 " multicast source */\n"
8700 #: build/C/man7/ip.7:324
8702 "The I<ip_mreq_source> structure is similar to I<ip_mreqn> described under "
8703 "B<IP_ADD_MEMBERSIP>. The I<imr_multiaddr> field contains the address of the "
8704 "multicast group the application wants to join or leave. The "
8705 "I<imr_interface> field is the address of the local interface with which the "
8706 "system should join the multicast group. Finally, the I<imr_sourceaddr> "
8707 "field contains the address of the source the application wants to receive "
8712 #: build/C/man7/ip.7:327
8714 "This option can be used multiple times to allow receiving data from more "
8719 #: build/C/man7/ip.7:327
8721 msgid "B<IP_BLOCK_SOURCE> (since Linux 2.4.22 / 2.5.68)"
8725 #: build/C/man7/ip.7:335
8727 "Stop receiving multicast data from a specific source in a given group. This "
8728 "is valid only after the application has subscribed to the multicast group "
8729 "using either B<IP_ADD_MEMBERSHIP> or B<IP_ADD_SOURCE_MEMBERSHIP>."
8733 #: build/C/man7/ip.7:340 build/C/man7/ip.7:362 build/C/man7/ip.7:920
8735 "Argument is an I<ip_mreq_source> structure as described under "
8736 "B<IP_ADD_SOURCE_MEMBERSHIP>."
8740 #: build/C/man7/ip.7:340
8742 msgid "B<IP_DROP_MEMBERSHIP> (since Linux 1.2)"
8746 #: build/C/man7/ip.7:349
8748 "Leave a multicast group. Argument is an I<ip_mreqn> or I<ip_mreq> structure "
8749 "similar to B<IP_ADD_MEMBERSHIP>."
8753 #: build/C/man7/ip.7:349
8755 msgid "B<IP_DROP_SOURCE_MEMBERSHIP> (since Linux 2.4.22 / 2.5.68)"
8759 #: build/C/man7/ip.7:357
8761 "Leave a source-specific group\\(emthat is, stop receiving data from a given "
8762 "multicast group that come from a given source. If the application has "
8763 "subscribed to multiple sources within the same group, data from the "
8764 "remaining sources will still be delivered. To stop receiving data from all "
8765 "sources at once, use B<IP_LEAVE_GROUP>."
8769 #: build/C/man7/ip.7:362
8771 msgid "B<IP_FREEBIND> (since Linux 2.4)"
8774 #. Precisely: 2.4.0-test10
8776 #: build/C/man7/ip.7:375
8778 "If enabled, this boolean option allows binding to an IP address that is "
8779 "nonlocal or does not (yet) exist. This permits listening on a socket, "
8780 "without requiring the underlying network interface or the specified dynamic "
8781 "IP address to be up at the time that the application is trying to bind to "
8782 "it. This option is the per-socket equivalent of the I<ip_nonlocal_bind> "
8783 "I</proc> interface described below."
8787 #: build/C/man7/ip.7:375
8789 msgid "B<IP_HDRINCL> (since Linux 2.0)"
8793 #: build/C/man7/ip.7:391
8795 "If enabled, the user supplies an IP header in front of the user data. Only "
8796 "valid for B<SOCK_RAW> sockets. See B<raw>(7) for more information. When "
8797 "this flag is enabled the values set by B<IP_OPTIONS>, B<IP_TTL> and "
8798 "B<IP_TOS> are ignored."
8802 #: build/C/man7/ip.7:391
8804 msgid "B<IP_MSFILTER> (since Linux 2.4.22 / 2.5.68)"
8808 #: build/C/man7/ip.7:397
8810 "This option provides access to the advanced full-state filtering API. "
8811 "Argument is an I<ip_msfilter> structure."
8815 #: build/C/man7/ip.7:406
8818 "struct ip_msfilter {\n"
8819 " struct in_addr imsf_multiaddr; /* IP multicast group\n"
8821 " struct in_addr imsf_interface; /* IP address of local\n"
8823 " uint32_t imsf_fmode; /* Filter-mode */\n"
8827 #: build/C/man7/ip.7:412
8830 " uint32_t imsf_numsrc; /* Number of sources in\n"
8831 " the following array */\n"
8832 " struct in_addr imsf_slist[1]; /* Array of source\n"
8838 #: build/C/man7/ip.7:427
8840 "There are two macros, B<MCAST_INCLUDE> and B<MCAST_EXCLUDE>, which can be "
8841 "used to specify the filtering mode. Additionally, the "
8842 "B<IP_MSFILTER_SIZE>(n) macro exists to determine how much memory is needed "
8843 "to store I<ip_msfilter> structure with I<n> sources in the source list."
8847 #: build/C/man7/ip.7:430
8848 msgid "For the full description of multicast source filtering refer to RFC 3376."
8852 #: build/C/man7/ip.7:430
8854 msgid "B<IP_MTU> (since Linux 2.2)"
8857 #. Precisely: 2.1.124
8859 #: build/C/man7/ip.7:438
8861 "Retrieve the current known path MTU of the current socket. Valid only when "
8862 "the socket has been connected. Returns an integer. Only valid as a "
8867 #: build/C/man7/ip.7:438
8869 msgid "B<IP_MTU_DISCOVER> (since Linux 2.2)"
8872 #. Precisely: 2.1.124
8874 #: build/C/man7/ip.7:459
8876 "Set or receive the Path MTU Discovery setting for a socket. When enabled, "
8877 "Linux will perform Path MTU Discovery as defined in RFC\\ 1191 on "
8878 "B<SOCK_STREAM> sockets. For non-B<SOCK_STREAM> sockets, B<IP_PMTUDISC_DO> "
8879 "forces the don't-fragment flag to be set on all outgoing packets. It is the "
8880 "user's responsibility to packetize the data in MTU-sized chunks and to do "
8881 "the retransmits if necessary. The kernel will reject (with B<EMSGSIZE>) "
8882 "datagrams that are bigger than the known path MTU. B<IP_PMTUDISC_WANT> will "
8883 "fragment a datagram if needed according to the path MTU, or will set the "
8884 "don't-fragment flag otherwise."
8888 #: build/C/man7/ip.7:467
8890 "The system-wide default can be toggled between B<IP_PMTUDISC_WANT> and "
8891 "B<IP_PMTUDISC_DONT> by writing (respectively, zero and nonzero values) to "
8892 "the I</proc/sys/net/ipv4/ip_no_pmtu_disc> file."
8896 #: build/C/man7/ip.7:471
8898 msgid "Path MTU discovery value:Meaning\n"
8902 #: build/C/man7/ip.7:472
8904 msgid "IP_PMTUDISC_WANT:Use per-route settings.\n"
8908 #: build/C/man7/ip.7:473
8910 msgid "IP_PMTUDISC_DONT:Never do Path MTU Discovery.\n"
8914 #: build/C/man7/ip.7:474
8916 msgid "IP_PMTUDISC_DO:Always do Path MTU Discovery.\n"
8920 #: build/C/man7/ip.7:475
8922 msgid "IP_PMTUDISC_PROBE:Set DF but ignore Path MTU.\n"
8926 #: build/C/man7/ip.7:493
8928 "When PMTU discovery is enabled, the kernel automatically keeps track of the "
8929 "path MTU per destination host. When it is connected to a specific peer with "
8930 "B<connect>(2), the currently known path MTU can be retrieved conveniently "
8931 "using the B<IP_MTU> socket option (e.g., after an B<EMSGSIZE> error "
8932 "occurred). The path MTU may change over time. For connectionless sockets "
8933 "with many destinations, the new MTU for a given destination can also be "
8934 "accessed using the error queue (see B<IP_RECVERR>). A new error will be "
8935 "queued for every incoming MTU update."
8939 #: build/C/man7/ip.7:498
8941 "While MTU discovery is in progress, initial packets from datagram sockets "
8942 "may be dropped. Applications using UDP should be aware of this and not take "
8943 "it into account for their packet retransmit strategy."
8946 #. FIXME this is an ugly hack
8948 #: build/C/man7/ip.7:503
8950 "To bootstrap the path MTU discovery process on unconnected sockets, it is "
8951 "possible to start with a big datagram size (up to 64K-headers bytes long) "
8952 "and let it shrink by updates of the path MTU."
8956 #: build/C/man7/ip.7:512
8958 "To get an initial estimate of the path MTU, connect a datagram socket to the "
8959 "destination address using B<connect>(2) and retrieve the MTU by calling "
8960 "B<getsockopt>(2) with the B<IP_MTU> option."
8964 #: build/C/man7/ip.7:524
8966 "It is possible to implement RFC 4821 MTU probing with B<SOCK_DGRAM> or "
8967 "B<SOCK_RAW> sockets by setting a value of B<IP_PMTUDISC_PROBE> (available "
8968 "since Linux 2.6.22). This is also particularly useful for diagnostic tools "
8969 "such as B<tracepath>(8) that wish to deliberately send probe packets larger "
8970 "than the observed Path MTU."
8974 #: build/C/man7/ip.7:524
8976 msgid "B<IP_MULTICAST_ALL> (since Linux 2.6.31)"
8980 #: build/C/man7/ip.7:538
8982 "This option can be used to modify the delivery policy of multicast messages "
8983 "to sockets bound to the wildcard B<INADDR_ANY> address. The argument is a "
8984 "boolean integer (defaults to 1). If set to 1, the socket will receive "
8985 "messages from all the groups that have been joined globally on the whole "
8986 "system. Otherwise, it will deliver messages only from the groups that have "
8987 "been explicitly joined (for example via the B<IP_ADD_MEMBERSHIP> option) on "
8988 "this particular socket."
8992 #: build/C/man7/ip.7:538
8994 msgid "B<IP_MULTICAST_IF> (since Linux 1.2)"
8998 #: build/C/man7/ip.7:547
9000 "Set the local device for a multicast socket. Argument is an I<ip_mreqn> or "
9001 "I<ip_mreq> structure similar to B<IP_ADD_MEMBERSHIP>."
9005 #: build/C/man7/ip.7:551
9006 msgid "When an invalid socket option is passed, B<ENOPROTOOPT> is returned."
9010 #: build/C/man7/ip.7:551
9012 msgid "B<IP_MULTICAST_LOOP> (since Linux 1.2)"
9016 #: build/C/man7/ip.7:555
9018 "Set or read a boolean integer argument that determines whether sent "
9019 "multicast packets should be looped back to the local sockets."
9023 #: build/C/man7/ip.7:555
9025 msgid "B<IP_MULTICAST_TTL> (since Linux 1.2)"
9029 #: build/C/man7/ip.7:563
9031 "Set or read the time-to-live value of outgoing multicast packets for this "
9032 "socket. It is very important for multicast packets to set the smallest TTL "
9033 "possible. The default is 1 which means that multicast packets don't leave "
9034 "the local network unless the user program explicitly requests it. Argument "
9039 #: build/C/man7/ip.7:563
9041 msgid "B<IP_NODEFRAG> (since Linux 2.6.36)"
9045 #: build/C/man7/ip.7:571
9047 "If enabled (argument is nonzero), the reassembly of outgoing packets is "
9048 "disabled in the netfilter layer. This option is valid only for B<SOCK_RAW> "
9049 "sockets. The argument is an integer."
9053 #: build/C/man7/ip.7:571
9055 msgid "B<IP_OPTIONS> (since Linux 2.0)"
9058 #. Precisely: 1.3.30
9060 #: build/C/man7/ip.7:600
9062 "Set or get the IP options to be sent with every packet from this socket. "
9063 "The arguments are a pointer to a memory buffer containing the options and "
9064 "the option length. The B<setsockopt>(2) call sets the IP options "
9065 "associated with a socket. The maximum option size for IPv4 is 40 bytes. "
9066 "See RFC\\ 791 for the allowed options. When the initial connection request "
9067 "packet for a B<SOCK_STREAM> socket contains IP options, the IP options will "
9068 "be set automatically to the options from the initial packet with routing "
9069 "headers reversed. Incoming packets are not allowed to change options after "
9070 "the connection is established. The processing of all incoming source "
9071 "routing options is disabled by default and can be enabled by using the "
9072 "I<accept_source_route> I</proc> interface. Other options like timestamps "
9073 "are still handled. For datagram sockets, IP options can be only set by the "
9074 "local user. Calling B<getsockopt>(2) with B<IP_OPTIONS> puts the current "
9075 "IP options used for sending into the supplied buffer."
9079 #: build/C/man7/ip.7:600
9081 msgid "B<IP_PKTINFO> (since Linux 2.2)"
9084 #. Precisely: 2.1.68
9086 #: build/C/man7/ip.7:617
9088 "Pass an B<IP_PKTINFO> ancillary message that contains a I<pktinfo> structure "
9089 "that supplies some information about the incoming packet. This only works "
9090 "for datagram oriented sockets. The argument is a flag that tells the socket "
9091 "whether the B<IP_PKTINFO> message should be passed or not. The message "
9092 "itself can only be sent/retrieved as control message with a packet using "
9093 "B<recvmsg>(2) or B<sendmsg>(2)."
9097 #: build/C/man7/ip.7:626
9100 "struct in_pktinfo {\n"
9101 " unsigned int ipi_ifindex; /* Interface index */\n"
9102 " struct in_addr ipi_spec_dst; /* Local address */\n"
9103 " struct in_addr ipi_addr; /* Header Destination\n"
9108 #. FIXME elaborate on that.
9109 #. This field is grossly misnamed
9111 #: build/C/man7/ip.7:651
9113 "I<ipi_ifindex> is the unique index of the interface the packet was received "
9114 "on. I<ipi_spec_dst> is the local address of the packet and I<ipi_addr> is "
9115 "the destination address in the packet header. If B<IP_PKTINFO> is passed to "
9116 "B<sendmsg>(2) and I<ipi_spec_dst> is not zero, then it is used as the local "
9117 "source address for the routing table lookup and for setting up IP source "
9118 "route options. When I<ipi_ifindex> is not zero, the primary local address "
9119 "of the interface specified by the index overwrites I<ipi_spec_dst> for the "
9120 "routing table lookup."
9124 #: build/C/man7/ip.7:651
9126 msgid "B<IP_RECVERR> (since Linux 2.2)"
9129 #. Precisely: 2.1.15
9130 #. or SOL_IP on Linux
9132 #: build/C/man7/ip.7:673
9134 "Enable extended reliable error message passing. When enabled on a datagram "
9135 "socket, all generated errors will be queued in a per-socket error queue. "
9136 "When the user receives an error from a socket operation, the errors can be "
9137 "received by calling B<recvmsg>(2) with the B<MSG_ERRQUEUE> flag set. The "
9138 "I<sock_extended_err> structure describing the error will be passed in an "
9139 "ancillary message with the type B<IP_RECVERR> and the level B<IPPROTO_IP>. "
9140 "This is useful for reliable error handling on unconnected sockets. The "
9141 "received data portion of the error queue contains the error packet."
9145 #: build/C/man7/ip.7:679
9146 msgid "The B<IP_RECVERR> control message contains a I<sock_extended_err> structure:"
9150 #: build/C/man7/ip.7:687
9153 "#define SO_EE_ORIGIN_NONE 0\n"
9154 "#define SO_EE_ORIGIN_LOCAL 1\n"
9155 "#define SO_EE_ORIGIN_ICMP 2\n"
9156 "#define SO_EE_ORIGIN_ICMP6 3\n"
9160 #: build/C/man7/ip.7:698
9163 "struct sock_extended_err {\n"
9164 " uint32_t ee_errno; /* error number */\n"
9165 " uint8_t ee_origin; /* where the error originated */\n"
9166 " uint8_t ee_type; /* type */\n"
9167 " uint8_t ee_code; /* code */\n"
9168 " uint8_t ee_pad;\n"
9169 " uint32_t ee_info; /* additional information */\n"
9170 " uint32_t ee_data; /* other data */\n"
9171 " /* More data may follow */\n"
9176 #: build/C/man7/ip.7:700
9178 msgid "struct sockaddr *SO_EE_OFFENDER(struct sock_extended_err *);\n"
9182 #: build/C/man7/ip.7:723
9184 "I<ee_errno> contains the I<errno> number of the queued error. I<ee_origin> "
9185 "is the origin code of where the error originated. The other fields are "
9186 "protocol-specific. The macro B<SO_EE_OFFENDER> returns a pointer to the "
9187 "address of the network object where the error originated from given a "
9188 "pointer to the ancillary message. If this address is not known, the "
9189 "I<sa_family> member of the I<sockaddr> contains B<AF_UNSPEC> and the other "
9190 "fields of the I<sockaddr> are undefined."
9193 #. FIXME . Is it a good idea to document that? It is a dubious feature.
9198 #. has slightly different semantics. Instead of
9199 #. saving the errors for the next timeout, it passes all incoming
9200 #. errors immediately to the user.
9201 #. This might be useful for very short-lived TCP connections which
9202 #. need fast error handling. Use this option with care:
9203 #. it makes TCP unreliable
9204 #. by not allowing it to recover properly from routing
9205 #. shifts and other normal
9206 #. conditions and breaks the protocol specification.
9208 #: build/C/man7/ip.7:782
9210 "IP uses the I<sock_extended_err> structure as follows: I<ee_origin> is set "
9211 "to B<SO_EE_ORIGIN_ICMP> for errors received as an ICMP packet, or "
9212 "B<SO_EE_ORIGIN_LOCAL> for locally generated errors. Unknown values should "
9213 "be ignored. I<ee_type> and I<ee_code> are set from the type and code fields "
9214 "of the ICMP header. I<ee_info> contains the discovered MTU for B<EMSGSIZE> "
9215 "errors. The message also contains the I<sockaddr_in of the node> caused the "
9216 "error, which can be accessed with the B<SO_EE_OFFENDER> macro. The "
9217 "I<sin_family> field of the B<SO_EE_OFFENDER> address is B<AF_UNSPEC> when "
9218 "the source was unknown. When the error originated from the network, all IP "
9219 "options (B<IP_OPTIONS>, B<IP_TTL>, etc.) enabled on the socket and contained "
9220 "in the error packet are passed as control messages. The payload of the "
9221 "packet causing the error is returned as normal payload. Note that TCP has "
9222 "no error queue; B<MSG_ERRQUEUE> is not permitted on B<SOCK_STREAM> sockets. "
9223 "B<IP_RECVERR> is valid for TCP, but all errors are returned by socket "
9224 "function return or B<SO_ERROR> only."
9228 #: build/C/man7/ip.7:787
9230 "For raw sockets, B<IP_RECVERR> enables passing of all received ICMP errors "
9231 "to the application, otherwise errors are only reported on connected sockets"
9235 #: build/C/man7/ip.7:791
9237 "It sets or retrieves an integer boolean flag. B<IP_RECVERR> defaults to "
9242 #: build/C/man7/ip.7:791
9244 msgid "B<IP_RECVOPTS> (since Linux 2.2)"
9247 #. Precisely: 2.1.15
9249 #: build/C/man7/ip.7:802
9251 "Pass all incoming IP options to the user in a B<IP_OPTIONS> control "
9252 "message. The routing header and other options are already filled in for the "
9253 "local host. Not supported for B<SOCK_STREAM> sockets."
9257 #: build/C/man7/ip.7:802
9259 msgid "B<IP_RECVORIGDSTADDR> (since Linux 2.6.29)"
9262 #. commit e8b2dfe9b4501ed0047459b2756ba26e5a940a69
9264 #: build/C/man7/ip.7:813
9266 "This boolean option enables the B<IP_ORIGDSTADDR> ancillary message in "
9267 "B<recvmsg>(2), in which the kernel returns the original destination address "
9268 "of the datagram being received. The ancillary message contains a I<struct "
9273 #: build/C/man7/ip.7:813
9275 msgid "B<IP_RECVTOS> (since Linux 2.2)"
9278 #. Precisely: 2.1.68
9280 #: build/C/man7/ip.7:822
9282 "If enabled the B<IP_TOS> ancillary message is passed with incoming packets. "
9283 "It contains a byte which specifies the Type of Service/Precedence field of "
9284 "the packet header. Expects a boolean integer flag."
9288 #: build/C/man7/ip.7:822
9290 msgid "B<IP_RECVTTL> (since Linux 2.2)"
9293 #. Precisely: 2.1.68
9295 #: build/C/man7/ip.7:832
9297 "When this flag is set, pass a B<IP_TTL> control message with the time to "
9298 "live field of the received packet as a byte. Not supported for "
9299 "B<SOCK_STREAM> sockets."
9303 #: build/C/man7/ip.7:832
9305 msgid "B<IP_RETOPTS> (since Linux 2.2)"
9308 #. Precisely: 2.1.15
9310 #: build/C/man7/ip.7:839
9312 "Identical to B<IP_RECVOPTS>, but returns raw unprocessed options with "
9313 "timestamp and route record options not filled in for this hop."
9317 #: build/C/man7/ip.7:839
9319 msgid "B<IP_ROUTER_ALERT> (since Linux 2.2)"
9322 #. Precisely: 2.1.68
9324 #: build/C/man7/ip.7:851
9326 "Pass all to-be forwarded packets with the IP Router Alert option set to this "
9327 "socket. Only valid for raw sockets. This is useful, for instance, for "
9328 "user-space RSVP daemons. The tapped packets are not forwarded by the "
9329 "kernel; it is the user's responsibility to send them out again. Socket "
9330 "binding is ignored, such packets are only filtered by protocol. Expects an "
9335 #: build/C/man7/ip.7:851
9337 msgid "B<IP_TOS> (since Linux 1.0)"
9340 #. FIXME elaborate on this
9341 #. Needs CAP_NET_ADMIN
9343 #. Since Linux 2.6.27
9344 #. Author: KOVACS Krisztian <hidden@sch.bme.hu>
9345 #. http://lwn.net/Articles/252545/
9347 #: build/C/man7/ip.7:885
9349 "Set or receive the Type-Of-Service (TOS) field that is sent with every IP "
9350 "packet originating from this socket. It is used to prioritize packets on "
9351 "the network. TOS is a byte. There are some standard TOS flags defined: "
9352 "B<IPTOS_LOWDELAY> to minimize delays for interactive traffic, "
9353 "B<IPTOS_THROUGHPUT> to optimize throughput, B<IPTOS_RELIABILITY> to optimize "
9354 "for reliability, B<IPTOS_MINCOST> should be used for \"filler data\" where "
9355 "slow transmission doesn't matter. At most one of these TOS values can be "
9356 "specified. Other bits are invalid and shall be cleared. Linux sends "
9357 "B<IPTOS_LOWDELAY> datagrams first by default, but the exact behavior depends "
9358 "on the configured queueing discipline. Some high priority levels may "
9359 "require superuser privileges (the B<CAP_NET_ADMIN> capability). The "
9360 "priority can also be set in a protocol independent way by the "
9361 "(B<SOL_SOCKET>, B<SO_PRIORITY>) socket option (see B<socket>(7))."
9365 #: build/C/man7/ip.7:885
9367 msgid "B<IP_TRANSPARENT> (since Linux 2.6.24)"
9370 #. commit f5715aea4564f233767ea1d944b2637a5fd7cd2e
9371 #. This patch introduces the IP_TRANSPARENT socket option: enabling that
9372 #. will make the IPv4 routing omit the non-local source address check on
9373 #. output. Setting IP_TRANSPARENT requires NET_ADMIN capability.
9374 #. http://lwn.net/Articles/252545/
9376 #: build/C/man7/ip.7:902
9378 "Setting this boolean option enables transparent proxying on this socket. "
9379 "This socket option allows the calling application to bind to a nonlocal IP "
9380 "address and operate both as a client and a server with the foreign address "
9381 "as the local endpoint. NOTE: this requires that routing be set up in a way "
9382 "that packets going to the foreign address are routed through the TProxy "
9383 "box. Enabling this socket option requires superuser privileges (the "
9384 "B<CAP_NET_ADMIN> capability)."
9388 #: build/C/man7/ip.7:905
9390 "TProxy redirection with the iptables TPROXY target also requires that this "
9391 "option be set on the redirected socket."
9395 #: build/C/man7/ip.7:905
9397 msgid "B<IP_TTL> (since Linux 1.0)"
9401 #: build/C/man7/ip.7:909
9403 "Set or retrieve the current time-to-live field that is used in every packet "
9404 "sent from this socket."
9408 #: build/C/man7/ip.7:909
9410 msgid "B<IP_UNBLOCK_SOURCE> (since Linux 2.4.22 / 2.5.68)"
9414 #: build/C/man7/ip.7:915
9416 "Unblock previously blocked multicast source. Returns B<EADDRNOTAVAIL> when "
9417 "given source is not being blocked."
9420 #. FIXME As at 2.6.12, 14 Jun 2005, the following are undocumented:
9424 #: build/C/man7/ip.7:936
9426 "The IP protocol supports a set of I</proc> interfaces to configure some "
9427 "global parameters. The parameters can be accessed by reading or writing "
9428 "files in the directory I</proc/sys/net/ipv4/>. Interfaces described as "
9429 "I<Boolean> take an integer value, with a nonzero value (\"true\") meaning "
9430 "that the corresponding option is enabled, and a zero value (\"false\") "
9431 "meaning that the option is disabled."
9435 #: build/C/man7/ip.7:936
9437 msgid "I<ip_always_defrag> (Boolean; since Linux 2.2.13)"
9441 #: build/C/man7/ip.7:942
9443 "[New with kernel 2.2.13; in earlier kernel versions this feature was "
9444 "controlled at compile time by the B<CONFIG_IP_ALWAYS_DEFRAG> option; this "
9445 "option is not present in 2.4.x and later]"
9449 #: build/C/man7/ip.7:949
9451 "When this boolean flag is enabled (not equal 0), incoming fragments (parts "
9452 "of IP packets that arose when some host between origin and destination "
9453 "decided that the packets were too large and cut them into pieces) will be "
9454 "reassembled (defragmented) before being processed, even if they are about to "
9459 #: build/C/man7/ip.7:956
9461 "Only enable if running either a firewall that is the sole link to your "
9462 "network or a transparent proxy; never ever use it for a normal router or "
9463 "host. Otherwise fragmented communication can be disturbed if the fragments "
9464 "travel over different links. Defragmentation also has a large memory and "
9469 #: build/C/man7/ip.7:960
9471 "This is automagically turned on when masquerading or transparent proxying "
9476 #: build/C/man7/ip.7:960
9478 msgid "I<ip_autoconfig> (since Linux 2.2 to 2.6.17)"
9481 #. Precisely: since 2.1.68
9482 #. FIXME document ip_autoconfig
9484 #: build/C/man7/ip.7:966
9485 msgid "Not documented."
9489 #: build/C/man7/ip.7:966
9491 msgid "I<ip_default_ttl> (integer; default: 64; since Linux 2.2)"
9494 #. Precisely: 2.1.15
9496 #: build/C/man7/ip.7:974
9498 "Set the default time-to-live value of outgoing packets. This can be changed "
9499 "per socket with the B<IP_TTL> option."
9503 #: build/C/man7/ip.7:974
9505 msgid "I<ip_dynaddr> (Boolean; default: disabled; since Linux 2.0.31)"
9509 #: build/C/man7/ip.7:981
9511 "Enable dynamic socket address and masquerading entry rewriting on interface "
9512 "address change. This is useful for dialup interface with changing IP "
9513 "addresses. 0 means no rewriting, 1 turns it on and 2 enables verbose mode."
9517 #: build/C/man7/ip.7:981
9519 msgid "I<ip_forward> (Boolean; default: disabled; since Linux 1.2)"
9523 #: build/C/man7/ip.7:986
9525 "Enable IP forwarding with a boolean flag. IP forwarding can be also set on "
9526 "a per-interface basis."
9530 #: build/C/man7/ip.7:986
9532 msgid "I<ip_local_port_range> (since Linux 2.2)"
9535 #. Precisely: since 2.1.68
9537 #: build/C/man7/ip.7:1000
9539 "Contains two integers that define the default local port range allocated to "
9540 "sockets. Allocation starts with the first number and ends with the second "
9541 "number. Note that these should not conflict with the ports used by "
9542 "masquerading (although the case is handled). Also arbitrary choices may "
9543 "cause problems with some firewall packet filters that make assumptions about "
9544 "the local ports in use. First number should be at least greater than 1024, "
9545 "or better, greater than 4096, to avoid clashes with well known ports and to "
9546 "minimize firewall problems."
9550 #: build/C/man7/ip.7:1000
9552 msgid "I<ip_no_pmtu_disc> (Boolean; default: disabled; since Linux 2.2)"
9555 #. Precisely: 2.1.15
9557 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
9559 #: build/C/man7/ip.7:1012
9561 "If enabled, don't do Path MTU Discovery for TCP sockets by default. Path "
9562 "MTU discovery may fail if misconfigured firewalls (that drop all ICMP "
9563 "packets) or misconfigured interfaces (e.g., a point-to-point link where the "
9564 "both ends don't agree on the MTU) are on the path. It is better to fix the "
9565 "broken routers on the path than to turn off Path MTU Discovery globally, "
9566 "because not doing it incurs a high cost to the network."
9570 #: build/C/man7/ip.7:1012
9572 msgid "I<ip_nonlocal_bind> (Boolean; default: disabled; since Linux 2.4)"
9575 #. Precisely: patch-2.4.0-test10
9577 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
9579 #: build/C/man7/ip.7:1021
9581 "If set, allows processes to B<bind>(2) to nonlocal IP addresses, which can "
9582 "be quite useful, but may break some applications."
9586 #: build/C/man7/ip.7:1021
9588 msgid "I<ip6frag_time> (integer; default: 30)"
9592 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
9594 #: build/C/man7/ip.7:1026
9595 msgid "Time in seconds to keep an IPv6 fragment in memory."
9599 #: build/C/man7/ip.7:1026
9601 msgid "I<ip6frag_secret_interval> (integer; default: 600)"
9605 #: build/C/man7/ip.7:1030
9607 "Regeneration interval (in seconds) of the hash secret (or lifetime for the "
9608 "hash secret) for IPv6 fragments."
9612 #: build/C/man7/ip.7:1030
9614 msgid "I<ipfrag_high_thresh> (integer), I<ipfrag_low_thresh> (integer)"
9618 #: build/C/man7/ip.7:1037
9620 "If the amount of queued IP fragments reaches I<ipfrag_high_thresh>, the "
9621 "queue is pruned down to I<ipfrag_low_thresh>. Contains an integer with the "
9626 #: build/C/man7/ip.7:1037
9631 #. FIXME Document the conf/*/* interfaces
9632 #. FIXME Document the route/* interfaces
9633 #. FIXME document them all
9635 #: build/C/man7/ip.7:1044
9636 msgid "See B<arp>(7)."
9640 #. commented out the following because ipchains is obsolete
9642 #. The ioctls to configure firewalling are documented in
9648 #: build/C/man7/ip.7:1057
9649 msgid "All ioctls described in B<socket>(7) apply to B<ip>."
9652 #. FIXME Add a discussion of multicasting
9654 #: build/C/man7/ip.7:1061
9656 "Ioctls to configure generic device parameters are described in "
9661 #: build/C/man7/ip.7:1081
9663 "The user tried to execute an operation without the necessary permissions. "
9664 "These include: sending a packet to a broadcast address without having the "
9665 "B<SO_BROADCAST> flag set; sending a packet via a I<prohibit> route; "
9666 "modifying firewall settings without superuser privileges (the "
9667 "B<CAP_NET_ADMIN> capability); binding to a privileged port without superuser "
9668 "privileges (the B<CAP_NET_BIND_SERVICE> capability)."
9672 #: build/C/man7/ip.7:1094
9673 msgid "An connection operation on a nonblocking socket is already in progress."
9677 #: build/C/man7/ip.7:1103
9679 "No valid routing table entry matches the destination address. This error "
9680 "can be caused by a ICMP message from a remote router or for the local "
9685 #: build/C/man7/ip.7:1109
9687 "Invalid argument passed. For send operations this can be caused by sending "
9688 "to a I<blackhole> route."
9692 #: build/C/man7/ip.7:1116
9693 msgid "Datagram is bigger than an MTU on the path and it cannot be fragmented."
9697 #: build/C/man7/ip.7:1116
9699 msgid "B<ENOBUFS>, B<ENOMEM>"
9703 #: build/C/man7/ip.7:1121
9705 "Not enough free memory. This often means that the memory allocation is "
9706 "limited by the socket buffer limits, not by the system memory, but this is "
9707 "not 100% consistent."
9711 #: build/C/man7/ip.7:1139
9713 "User doesn't have permission to set high priority, change configuration, or "
9714 "send signals to the requested process or group."
9718 #: build/C/man7/ip.7:1145
9719 msgid "The socket is not configured or an unknown socket type was requested."
9723 #: build/C/man7/ip.7:1152
9725 "Other errors may be generated by the overlaying protocols; see B<tcp>(7), "
9726 "B<raw>(7), B<udp>(7) and B<socket>(7)."
9729 #. IP_PASSSEC is Linux-specific
9730 #. IP_XFRM_POLICY is Linux-specific
9731 #. IP_IPSEC_POLICY is a nonstandard extension, also present on some BSDs
9733 #: build/C/man7/ip.7:1167
9735 "B<IP_FREEBIND>, B<IP_MSFILTER>, B<IP_MTU>, B<IP_MTU_DISCOVER>, "
9736 "B<IP_RECVORIGDSTADDR>, B<IP_PKTINFO>, B<IP_RECVERR>, B<IP_ROUTER_ALERT>, and "
9737 "B<IP_TRANSPARENT> are Linux-specific."
9741 #: build/C/man7/ip.7:1176
9743 "Be very careful with the B<SO_BROADCAST> option - it is not privileged in "
9744 "Linux. It is easy to overload the network with careless broadcasts. For "
9745 "new application protocols it is better to use a multicast group instead of "
9746 "broadcasting. Broadcasting is discouraged."
9750 #: build/C/man7/ip.7:1186
9752 "Some other BSD sockets implementations provide B<IP_RCVDSTADDR> and "
9753 "B<IP_RECVIF> socket options to get the destination address and the interface "
9754 "of received datagrams. Linux has the more general B<IP_PKTINFO> for the "
9759 #: build/C/man7/ip.7:1195
9761 "Some BSD sockets implementations also provide an B<IP_RECVTTL> option, but "
9762 "an ancillary message with type B<IP_RECVTTL> is passed with the incoming "
9763 "packet. This is different from the B<IP_TTL> option used in Linux."
9767 #: build/C/man7/ip.7:1201
9769 "Using B<SOL_IP> socket options level isn't portable, BSD-based stacks use "
9770 "B<IPPROTO_IP> level."
9774 #: build/C/man7/ip.7:1214
9776 "For compatibility with Linux 2.0, the obsolete B<socket(AF_INET, "
9777 "SOCK_PACKET, >I<protocol>B<)> syntax is still supported to open a "
9778 "B<packet>(7) socket. This is deprecated and should be replaced by "
9779 "B<socket(AF_PACKET, SOCK_RAW, >I<protocol>B<)> instead. The main difference "
9780 "is the new I<sockaddr_ll> address structure for generic link layer "
9781 "information instead of the old B<sockaddr_pkt>."
9785 #: build/C/man7/ip.7:1219
9787 "The ioctls to configure IP-specific interface options and ARP tables are not "
9792 #: build/C/man7/ip.7:1223
9794 "Some versions of glibc forget to declare I<in_pktinfo>. Workaround "
9795 "currently is to copy it into your program from this man page."
9799 #. This man page was written by Andi Kleen.
9801 #: build/C/man7/ip.7:1233
9803 "Receiving the original destination address with B<MSG_ERRQUEUE> in "
9804 "I<msg_name> by B<recvmsg>(2) does not work in some 2.2 kernels."
9808 #: build/C/man7/ip.7:1246
9810 "B<recvmsg>(2), B<sendmsg>(2), B<byteorder>(3), B<ipfw>(4), "
9811 "B<capabilities>(7), B<icmp>(7), B<ipv6>(7), B<netlink>(7), B<raw>(7), "
9812 "B<socket>(7), B<tcp>(7), B<udp>(7)"
9815 #. FIXME autobind INADDR REUSEADDR
9817 #: build/C/man7/ip.7:1251
9819 "RFC\\ 791 for the original IP specification. RFC\\ 1122 for the IPv4 host "
9820 "requirements. RFC\\ 1812 for the IPv4 router requirements."
9824 #: build/C/man7/ipv6.7:86
9830 #: build/C/man7/ipv6.7:86
9836 #: build/C/man7/ipv6.7:89
9837 msgid "ipv6 - Linux IPv6 protocol implementation"
9841 #: build/C/man7/ipv6.7:95
9842 msgid "I<tcp6_socket>B< = socket(AF_INET6, SOCK_STREAM, 0);>"
9846 #: build/C/man7/ipv6.7:97
9847 msgid "I<raw6_socket>B< = socket(AF_INET6, SOCK_RAW, >I<protocol>B<);>"
9851 #: build/C/man7/ipv6.7:99
9852 msgid "I<udp6_socket>B< = socket(AF_INET6, SOCK_DGRAM, >I<protocol>B<);>"
9856 #: build/C/man7/ipv6.7:106
9858 "Linux 2.2 optionally implements the Internet Protocol, version 6. This man "
9859 "page contains a description of the IPv6 basic API as implemented by the "
9860 "Linux kernel and glibc 2.1. The interface is based on the BSD sockets "
9861 "interface; see B<socket>(7)."
9865 #: build/C/man7/ipv6.7:111
9867 "The IPv6 API aims to be mostly compatible with the IPv4 API (see B<ip>(7)). "
9868 "Only differences are described in this man page."
9872 #: build/C/man7/ipv6.7:123
9874 "To bind an B<AF_INET6> socket to any process, the local address should be "
9875 "copied from the I<in6addr_any> variable which has I<in6_addr> type. In "
9876 "static initializations, B<IN6ADDR_ANY_INIT> may also be used, which expands "
9877 "to a constant expression. Both of them are in network byte order."
9881 #: build/C/man7/ipv6.7:130
9883 "The IPv6 loopback address (::1) is available in the global "
9884 "I<in6addr_loopback> variable. For initializations, B<IN6ADDR_LOOPBACK_INIT> "
9889 #: build/C/man7/ipv6.7:137
9891 "IPv4 connections can be handled with the v6 API by using the v4-mapped-on-v6 "
9892 "address type; thus a program only needs to support this API type to support "
9893 "both protocols. This is handled transparently by the address handling "
9894 "functions in the C library."
9898 #: build/C/man7/ipv6.7:142
9900 "IPv4 and IPv6 share the local port space. When you get an IPv4 connection "
9901 "or packet to a IPv6 socket, its source address will be mapped to v6 and it "
9902 "will be mapped to v6."
9906 #: build/C/man7/ipv6.7:152
9909 "struct sockaddr_in6 {\n"
9910 " sa_family_t sin6_family; /* AF_INET6 */\n"
9911 " in_port_t sin6_port; /* port number */\n"
9912 " uint32_t sin6_flowinfo; /* IPv6 flow information */\n"
9913 " struct in6_addr sin6_addr; /* IPv6 address */\n"
9914 " uint32_t sin6_scope_id; /* Scope ID (new in 2.4) */\n"
9919 #: build/C/man7/ipv6.7:156
9922 "struct in6_addr {\n"
9923 " unsigned char s6_addr[16]; /* IPv6 address */\n"
9928 #: build/C/man7/ipv6.7:178
9930 "I<sin6_family> is always set to B<AF_INET6>; I<sin6_port> is the protocol "
9931 "port (see I<sin_port> in B<ip>(7)); I<sin6_flowinfo> is the IPv6 flow "
9932 "identifier; I<sin6_addr> is the 128-bit IPv6 address. I<sin6_scope_id> is "
9933 "an ID depending on the scope of the address. It is new in Linux 2.4. Linux "
9934 "supports it only for link-local addresses, in that case I<sin6_scope_id> "
9935 "contains the interface index (see B<netdevice>(7))"
9939 #: build/C/man7/ipv6.7:184
9941 "IPv6 supports several address types: unicast to address a single host, "
9942 "multicast to address a group of hosts, anycast to address the nearest member "
9943 "of a group of hosts (not implemented in Linux), IPv4-on-IPv6 to address a "
9944 "IPv4 host, and other reserved address types."
9948 #: build/C/man7/ipv6.7:190
9950 "The address notation for IPv6 is a group of 8 4-digit hexadecimal numbers, "
9951 "separated with a \\(aq:\\(aq. \\&\"::\" stands for a string of 0 bits. "
9952 "Special addresses are ::1 for loopback and ::FFFF:E<lt>IPv4 addressE<gt> for "
9953 "IPv4-mapped-on-IPv6."
9957 #: build/C/man7/ipv6.7:192
9958 msgid "The port space of IPv6 is shared with IPv4."
9962 #: build/C/man7/ipv6.7:200
9964 "IPv6 supports some protocol-specific socket options that can be set with "
9965 "B<setsockopt>(2) and read with B<getsockopt>(2). The socket option level "
9966 "for IPv6 is B<IPPROTO_IPV6>. A boolean integer flag is zero when it is "
9967 "false, otherwise true."
9971 #: build/C/man7/ipv6.7:200
9973 msgid "B<IPV6_ADDRFORM>"
9977 #: build/C/man7/ipv6.7:214
9979 "Turn an B<AF_INET6> socket into a socket of a different address family. "
9980 "Only B<AF_INET> is currently supported for that. It is allowed only for "
9981 "IPv6 sockets that are connected and bound to a v4-mapped-on-v6 address. The "
9982 "argument is a pointer to an integer containing B<AF_INET>. This is useful "
9983 "to pass v4-mapped sockets as file descriptors to programs that don't know "
9984 "how to deal with the IPv6 API."
9988 #: build/C/man7/ipv6.7:214
9990 msgid "B<IPV6_ADD_MEMBERSHIP, IPV6_DROP_MEMBERSHIP>"
9994 #: build/C/man7/ipv6.7:219
9996 "Control membership in multicast groups. Argument is a pointer to a I<struct "
10001 #: build/C/man7/ipv6.7:219
10003 msgid "B<IPV6_MTU>"
10006 #. type: Plain text
10007 #: build/C/man7/ipv6.7:225
10009 "B<getsockopt>(): Retrieve the current known path MTU of the current socket. "
10010 "Only valid when the socket has been connected. Returns an integer."
10013 #. type: Plain text
10014 #: build/C/man7/ipv6.7:231
10016 "B<setsockopt>(): Set the MTU to be used for the socket. The MTU is limited "
10017 "by the device MTU or the path MTU when path MTU discovery is enabled. "
10018 "Argument is a pointer to integer."
10022 #: build/C/man7/ipv6.7:231
10024 msgid "B<IPV6_MTU_DISCOVER>"
10027 #. type: Plain text
10028 #: build/C/man7/ipv6.7:239
10030 "Control path-MTU discovery on the socket. See B<IP_MTU_DISCOVER> in "
10031 "B<ip>(7) for details."
10035 #: build/C/man7/ipv6.7:239
10037 msgid "B<IPV6_MULTICAST_HOPS>"
10040 #. type: Plain text
10041 #: build/C/man7/ipv6.7:246
10043 "Set the multicast hop limit for the socket. Argument is a pointer to an "
10044 "integer. -1 in the value means use the route default, otherwise it should "
10045 "be between 0 and 255."
10049 #: build/C/man7/ipv6.7:246
10051 msgid "B<IPV6_MULTICAST_IF>"
10054 #. type: Plain text
10055 #: build/C/man7/ipv6.7:257
10057 "Set the device for outgoing multicast packets on the socket. This is "
10058 "allowed only for B<SOCK_DGRAM> and B<SOCK_RAW> socket. The argument is a "
10059 "pointer to an interface index (see B<netdevice>(7)) in an integer."
10063 #: build/C/man7/ipv6.7:257
10065 msgid "B<IPV6_MULTICAST_LOOP>"
10068 #. type: Plain text
10069 #: build/C/man7/ipv6.7:261
10071 "Control whether the socket sees multicast packets that it has send itself. "
10072 "Argument is a pointer to boolean."
10076 #: build/C/man7/ipv6.7:261
10078 msgid "B<IPV6_RECVPKTINFO> (since Linux 2.6.14)"
10081 #. type: Plain text
10082 #: build/C/man7/ipv6.7:275
10084 "Set delivery of the B<IPV6_PKTINFO> control message on incoming datagrams. "
10085 "Such control messages contain a I<struct in6_pktinfo>, as per RFC 3542. "
10086 "Only allowed for B<SOCK_DGRAM> or B<SOCK_RAW> sockets. Argument is a "
10087 "pointer to a boolean value in an integer."
10090 #. type: Plain text
10091 #: build/C/man7/ipv6.7:278
10093 "B<IPV6_RTHDR, IPV6_AUTHHDR, IPV6_DSTOPTS, IPV6_HOPOPTS, IPV6_FLOWINFO, "
10097 #. type: Plain text
10098 #: build/C/man7/ipv6.7:303
10100 "Set delivery of control messages for incoming datagrams containing extension "
10101 "headers from the received packet. B<IPV6_RTHDR> delivers the routing "
10102 "header, B<IPV6_AUTHHDR> delivers the authentication header, B<IPV6_DSTOPTS> "
10103 "delivers the destination options, B<IPV6_HOPOPTS> delivers the hop options, "
10104 "B<IPV6_FLOWINFO> delivers an integer containing the flow ID, "
10105 "B<IPV6_HOPLIMIT> delivers an integer containing the hop count of the "
10106 "packet. The control messages have the same type as the socket option. All "
10107 "these header options can also be set for outgoing packets by putting the "
10108 "appropriate control message into the control buffer of B<sendmsg>(2). Only "
10109 "allowed for B<SOCK_DGRAM> or B<SOCK_RAW> sockets. Argument is a pointer to "
10114 #: build/C/man7/ipv6.7:303
10116 msgid "B<IPV6_RECVERR>"
10119 #. type: Plain text
10120 #: build/C/man7/ipv6.7:312
10122 "Control receiving of asynchronous error options. See B<IP_RECVERR> in "
10123 "B<ip>(7) for details. Argument is a pointer to boolean."
10127 #: build/C/man7/ipv6.7:312
10129 msgid "B<IPV6_ROUTER_ALERT>"
10132 #. type: Plain text
10133 #: build/C/man7/ipv6.7:325
10135 "Pass forwarded packets containing a router alert hop-by-hop option to this "
10136 "socket. Only allowed for SOCK_RAW sockets. The tapped packets are not "
10137 "forwarded by the kernel, it is the user's responsibility to send them out "
10138 "again. Argument is a pointer to an integer. A positive integer indicates a "
10139 "router alert option value to intercept. Packets carrying a router alert "
10140 "option with a value field containing this integer will be delivered to the "
10141 "socket. A negative integer disables delivery of packets with router alert "
10142 "options to this socket."
10146 #: build/C/man7/ipv6.7:325
10148 msgid "B<IPV6_UNICAST_HOPS>"
10151 #. type: Plain text
10152 #: build/C/man7/ipv6.7:331
10154 "Set the unicast hop limit for the socket. Argument is a pointer to an "
10155 "integer. -1 in the value means use the route default, otherwise it should "
10156 "be between 0 and 255."
10160 #: build/C/man7/ipv6.7:331
10162 msgid "B<IPV6_V6ONLY> (since Linux 2.4.21 and 2.6)"
10166 #. type: Plain text
10167 #: build/C/man7/ipv6.7:338
10169 "If this flag is set to true (nonzero), then the socket is restricted to "
10170 "sending and receiving IPv6 packets only. In this case, an IPv4 and an IPv6 "
10171 "application can bind to a single port at the same time."
10174 #. type: Plain text
10175 #: build/C/man7/ipv6.7:342
10177 "If this flag is set to false (zero), then the socket can be used to send and "
10178 "receive packets to and from an IPv6 address or an IPv4-mapped IPv6 address."
10181 #. type: Plain text
10182 #: build/C/man7/ipv6.7:344
10183 msgid "The argument is a pointer to a boolean value in an integer."
10186 #. FLOWLABEL_MGR, FLOWINFO_SEND
10187 #. type: Plain text
10188 #: build/C/man7/ipv6.7:349
10190 "The default value for this flag is defined by the contents of the file "
10191 "I</proc/sys/net/ipv6/bindv6only>. The default value for that file is 0 "
10195 #. type: Plain text
10196 #: build/C/man7/ipv6.7:361
10198 "The user tried to B<bind>(2) to a link-local IPv6 address, but the "
10199 "I<sin6_scope_id> in the supplied I<sockaddr_in6> structure is not a valid "
10203 #. type: Plain text
10204 #: build/C/man7/ipv6.7:366
10206 "The older I<libinet6> libc5 based IPv6 API implementation for Linux is not "
10207 "described here and may vary in details."
10210 #. type: Plain text
10211 #: build/C/man7/ipv6.7:382
10213 "Linux 2.4 will break binary compatibility for the I<sockaddr_in6> for 64-bit "
10214 "hosts by changing the alignment of I<in6_addr> and adding an additional "
10215 "I<sin6_scope_id> field. The kernel interfaces stay compatible, but a "
10216 "program including I<sockaddr_in6> or I<in6_addr> into other structures may "
10217 "not be. This is not a problem for 32-bit hosts like i386."
10220 #. type: Plain text
10221 #: build/C/man7/ipv6.7:390
10223 "The I<sin6_flowinfo> field is new in Linux 2.4. It is transparently "
10224 "passed/read by the kernel when the passed address length contains it. Some "
10225 "programs that pass a longer address buffer and then check the outgoing "
10226 "address length may break."
10229 #. type: Plain text
10230 #: build/C/man7/ipv6.7:400
10232 "The I<sockaddr_in6> structure is bigger than the generic I<sockaddr>. "
10233 "Programs that assume that all address types can be stored safely in a "
10234 "I<struct sockaddr> need to be changed to use I<struct sockaddr_storage> for "
10238 #. type: Plain text
10239 #: build/C/man7/ipv6.7:405
10241 "The IPv6 extended API as in RFC\\ 2292 is currently only partly implemented; "
10242 "although the 2.2 kernel has near complete support for receiving options, the "
10243 "macros for generating IPv6 options are missing in glibc 2.1."
10246 #. type: Plain text
10247 #: build/C/man7/ipv6.7:407
10248 msgid "IPSec support for EH and AH headers is missing."
10251 #. type: Plain text
10252 #: build/C/man7/ipv6.7:409
10253 msgid "Flow label management is not complete and not documented here."
10256 #. type: Plain text
10257 #: build/C/man7/ipv6.7:411
10258 msgid "This man page is not complete."
10261 #. type: Plain text
10262 #: build/C/man7/ipv6.7:414
10263 msgid "B<cmsg>(3), B<ip>(7)"
10266 #. type: Plain text
10267 #: build/C/man7/ipv6.7:418
10269 "RFC\\ 2553: IPv6 BASIC API; Linux tries to be compliant to this. RFC\\ "
10270 "2460: IPv6 specification."
10274 #: build/C/man7/netdevice.7:18
10280 #: build/C/man7/netdevice.7:18
10285 #. type: Plain text
10286 #: build/C/man7/netdevice.7:21
10287 msgid "netdevice - low-level access to Linux network devices"
10290 #. type: Plain text
10291 #: build/C/man7/netdevice.7:23
10292 msgid "B<#include E<lt>sys/ioctl.hE<gt>>"
10295 #. type: Plain text
10296 #: build/C/man7/netdevice.7:25
10297 msgid "B<#include E<lt>net/if.hE<gt>>"
10300 #. type: Plain text
10301 #: build/C/man7/netdevice.7:28
10303 "This man page describes the sockets interface which is used to configure "
10307 #. type: Plain text
10308 #: build/C/man7/netdevice.7:35
10310 "Linux supports some standard ioctls to configure network devices. They can "
10311 "be used on any socket's file descriptor regardless of the family or type. "
10312 "They pass an I<ifreq> structure:"
10315 #. type: Plain text
10316 #: build/C/man7/netdevice.7:56
10320 " char ifr_name[IFNAMSIZ]; /* Interface name */\n"
10322 " struct sockaddr ifr_addr;\n"
10323 " struct sockaddr ifr_dstaddr;\n"
10324 " struct sockaddr ifr_broadaddr;\n"
10325 " struct sockaddr ifr_netmask;\n"
10326 " struct sockaddr ifr_hwaddr;\n"
10327 " short ifr_flags;\n"
10328 " int ifr_ifindex;\n"
10329 " int ifr_metric;\n"
10331 " struct ifmap ifr_map;\n"
10332 " char ifr_slave[IFNAMSIZ];\n"
10333 " char ifr_newname[IFNAMSIZ];\n"
10334 " char *ifr_data;\n"
10339 #. type: Plain text
10340 #: build/C/man7/netdevice.7:64
10343 "struct ifconf {\n"
10344 " int ifc_len; /* size of buffer */\n"
10346 " char *ifc_buf; /* buffer address */\n"
10347 " struct ifreq *ifc_req; /* array of structures */\n"
10352 #. type: Plain text
10353 #: build/C/man7/netdevice.7:72
10355 "Normally, the user specifies which device to affect by setting I<ifr_name> "
10356 "to the name of the interface. All other members of the structure may share "
10360 #. type: Plain text
10361 #: build/C/man7/netdevice.7:80
10363 "If an ioctl is marked as privileged then using it requires an effective user "
10364 "ID of 0 or the B<CAP_NET_ADMIN> capability. If this is not the case "
10365 "B<EPERM> will be returned."
10369 #: build/C/man7/netdevice.7:80
10371 msgid "B<SIOCGIFNAME>"
10374 #. type: Plain text
10375 #: build/C/man7/netdevice.7:88
10377 "Given the I<ifr_ifindex>, return the name of the interface in I<ifr_name>. "
10378 "This is the only ioctl which returns its result in I<ifr_name>."
10382 #: build/C/man7/netdevice.7:88
10384 msgid "B<SIOCGIFINDEX>"
10387 #. type: Plain text
10388 #: build/C/man7/netdevice.7:92
10389 msgid "Retrieve the interface index of the interface into I<ifr_ifindex>."
10393 #: build/C/man7/netdevice.7:92
10395 msgid "B<SIOCGIFFLAGS>, B<SIOCSIFFLAGS>"
10398 #. Do not right adjust text blocks in tables
10399 #. type: Plain text
10400 #: build/C/man7/netdevice.7:98
10402 "Get or set the active flag word of the device. I<ifr_flags> contains a bit "
10403 "mask of the following values:"
10407 #: build/C/man7/netdevice.7:103
10409 msgid "Device flags\n"
10413 #: build/C/man7/netdevice.7:104
10415 msgid "IFF_UP:Interface is running.\n"
10419 #: build/C/man7/netdevice.7:105
10421 msgid "IFF_BROADCAST:Valid broadcast address set.\n"
10425 #: build/C/man7/netdevice.7:106
10427 msgid "IFF_DEBUG:Internal debugging flag.\n"
10431 #: build/C/man7/netdevice.7:107
10433 msgid "IFF_LOOPBACK:Interface is a loopback interface.\n"
10437 #: build/C/man7/netdevice.7:108
10439 msgid "IFF_POINTOPOINT:Interface is a point-to-point link.\n"
10443 #: build/C/man7/netdevice.7:109
10445 msgid "IFF_RUNNING:Resources allocated.\n"
10449 #: build/C/man7/netdevice.7:110
10451 msgid "IFF_NOARP:T{\n"
10455 #: build/C/man7/netdevice.7:111
10457 msgid "No arp protocol, L2 destination address not set.\n"
10461 #: build/C/man7/netdevice.7:112 build/C/man7/netdevice.7:123
10467 #: build/C/man7/netdevice.7:113
10469 msgid "IFF_PROMISC:Interface is in promiscuous mode.\n"
10473 #: build/C/man7/netdevice.7:114
10475 msgid "IFF_NOTRAILERS:Avoid use of trailers.\n"
10479 #: build/C/man7/netdevice.7:115
10481 msgid "IFF_ALLMULTI:Receive all multicast packets.\n"
10485 #: build/C/man7/netdevice.7:116
10487 msgid "IFF_MASTER:Master of a load balancing bundle.\n"
10491 #: build/C/man7/netdevice.7:117
10493 msgid "IFF_SLAVE:Slave of a load balancing bundle.\n"
10497 #: build/C/man7/netdevice.7:118
10499 msgid "IFF_MULTICAST:Supports multicast\n"
10503 #: build/C/man7/netdevice.7:119
10505 msgid "IFF_PORTSEL:Is able to select media type via ifmap.\n"
10509 #: build/C/man7/netdevice.7:120
10511 msgid "IFF_AUTOMEDIA:Auto media selection active.\n"
10515 #: build/C/man7/netdevice.7:121
10517 msgid "IFF_DYNAMIC:T{\n"
10521 #: build/C/man7/netdevice.7:122
10523 msgid "The addresses are lost when the interface goes down.\n"
10527 #: build/C/man7/netdevice.7:124
10529 msgid "IFF_LOWER_UP:Driver signals L1 up (since Linux 2.6.17)\n"
10533 #: build/C/man7/netdevice.7:125
10535 msgid "IFF_DORMANT:Driver signals dormant (since Linux 2.6.17)\n"
10539 #: build/C/man7/netdevice.7:126
10541 msgid "IFF_ECHO:Echo sent packets (since Linux 2.6.25)\n"
10544 #. type: Plain text
10545 #: build/C/man7/netdevice.7:132
10547 "Setting the active flag word is a privileged operation, but any process may "
10552 #: build/C/man7/netdevice.7:132
10554 msgid "B<SIOCGIFPFLAGS>, B<SIOCSIFPFLAGS>"
10557 #. type: Plain text
10558 #: build/C/man7/netdevice.7:137
10560 "Get or set extended (private) flags for the device. I<ifr_flags> contains a "
10561 "bit mask of the following values:"
10565 #: build/C/man7/netdevice.7:141
10567 msgid "Private flags\n"
10571 #: build/C/man7/netdevice.7:142
10573 msgid "IFF_802_1Q_VLAN:Interface is 802.1Q VLAN device.\n"
10577 #: build/C/man7/netdevice.7:143
10579 msgid "IFF_EBRIDGE:Interface is Ethernet bridging device.\n"
10583 #: build/C/man7/netdevice.7:144
10585 msgid "IFF_SLAVE_INACTIVE:Interface is inactive bonding slave.\n"
10589 #: build/C/man7/netdevice.7:145
10591 msgid "IFF_MASTER_8023AD:Interface is 802.3ad bonding master.\n"
10595 #: build/C/man7/netdevice.7:146
10597 msgid "IFF_MASTER_ALB:Interface is balanced-alb bonding master.\n"
10601 #: build/C/man7/netdevice.7:147
10603 msgid "IFF_BONDING:Interface is a bonding master or slave.\n"
10607 #: build/C/man7/netdevice.7:148
10609 msgid "IFF_SLAVE_NEEDARP:Interface needs ARPs for validation.\n"
10613 #: build/C/man7/netdevice.7:149
10615 msgid "IFF_ISATAP:Interface is RFC4214 ISATAP interface.\n"
10618 #. type: Plain text
10619 #: build/C/man7/netdevice.7:153
10620 msgid "Setting the extended (private) interface flags is a privileged operation."
10624 #: build/C/man7/netdevice.7:153
10626 msgid "B<SIOCGIFADDR>, B<SIOCSIFADDR>"
10629 #. type: Plain text
10630 #: build/C/man7/netdevice.7:161
10632 "Get or set the address of the device using I<ifr_addr>. Setting the "
10633 "interface address is a privileged operation. For compatibility, only "
10634 "B<AF_INET> addresses are accepted or returned."
10638 #: build/C/man7/netdevice.7:161
10640 msgid "B<SIOCGIFDSTADDR>, B<SIOCSIFDSTADDR>"
10643 #. type: Plain text
10644 #: build/C/man7/netdevice.7:169
10646 "Get or set the destination address of a point-to-point device using "
10647 "I<ifr_dstaddr>. For compatibility, only B<AF_INET> addresses are accepted "
10648 "or returned. Setting the destination address is a privileged operation."
10652 #: build/C/man7/netdevice.7:169
10654 msgid "B<SIOCGIFBRDADDR>, B<SIOCSIFBRDADDR>"
10657 #. type: Plain text
10658 #: build/C/man7/netdevice.7:177
10660 "Get or set the broadcast address for a device using I<ifr_brdaddr>. For "
10661 "compatibility, only B<AF_INET> addresses are accepted or returned. Setting "
10662 "the broadcast address is a privileged operation."
10666 #: build/C/man7/netdevice.7:177
10668 msgid "B<SIOCGIFNETMASK>, B<SIOCSIFNETMASK>"
10671 #. type: Plain text
10672 #: build/C/man7/netdevice.7:185
10674 "Get or set the network mask for a device using I<ifr_netmask>. For "
10675 "compatibility, only B<AF_INET> addresses are accepted or returned. Setting "
10676 "the network mask is a privileged operation."
10680 #: build/C/man7/netdevice.7:185
10682 msgid "B<SIOCGIFMETRIC>, B<SIOCSIFMETRIC>"
10685 #. type: Plain text
10686 #: build/C/man7/netdevice.7:194
10688 "Get or set the metric of the device using I<ifr_metric>. This is currently "
10689 "not implemented; it sets I<ifr_metric> to 0 if you attempt to read it and "
10690 "returns B<EOPNOTSUPP> if you attempt to set it."
10694 #: build/C/man7/netdevice.7:194
10696 msgid "B<SIOCGIFMTU>, B<SIOCSIFMTU>"
10699 #. type: Plain text
10700 #: build/C/man7/netdevice.7:201
10702 "Get or set the MTU (Maximum Transfer Unit) of a device using I<ifr_mtu>. "
10703 "Setting the MTU is a privileged operation. Setting the MTU to too small "
10704 "values may cause kernel crashes."
10708 #: build/C/man7/netdevice.7:201
10710 msgid "B<SIOCGIFHWADDR>, B<SIOCSIFHWADDR>"
10713 #. type: Plain text
10714 #: build/C/man7/netdevice.7:212
10716 "Get or set the hardware address of a device using I<ifr_hwaddr>. The "
10717 "hardware address is specified in a struct I<sockaddr>. I<sa_family> "
10718 "contains the ARPHRD_* device type, I<sa_data> the L2 hardware address "
10719 "starting from byte 0. Setting the hardware address is a privileged "
10724 #: build/C/man7/netdevice.7:212
10726 msgid "B<SIOCSIFHWBROADCAST>"
10729 #. type: Plain text
10730 #: build/C/man7/netdevice.7:217
10732 "Set the hardware broadcast address of a device from I<ifr_hwaddr>. This is "
10733 "a privileged operation."
10737 #: build/C/man7/netdevice.7:217
10739 msgid "B<SIOCGIFMAP>, B<SIOCSIFMAP>"
10742 #. type: Plain text
10743 #: build/C/man7/netdevice.7:222
10745 "Get or set the interface's hardware parameters using I<ifr_map>. Setting "
10746 "the parameters is a privileged operation."
10749 #. type: Plain text
10750 #: build/C/man7/netdevice.7:233
10754 " unsigned long mem_start;\n"
10755 " unsigned long mem_end;\n"
10756 " unsigned short base_addr;\n"
10757 " unsigned char irq;\n"
10758 " unsigned char dma;\n"
10759 " unsigned char port;\n"
10763 #. type: Plain text
10764 #: build/C/man7/netdevice.7:238
10766 "The interpretation of the ifmap structure depends on the device driver and "
10767 "the architecture."
10771 #: build/C/man7/netdevice.7:238
10773 msgid "B<SIOCADDMULTI>, B<SIOCDELMULTI>"
10776 #. type: Plain text
10777 #: build/C/man7/netdevice.7:247
10779 "Add an address to or delete an address from the device's link layer "
10780 "multicast filters using I<ifr_hwaddr>. These are privileged operations. "
10781 "See also B<packet>(7) for an alternative."
10785 #: build/C/man7/netdevice.7:247
10787 msgid "B<SIOCGIFTXQLEN>, B<SIOCSIFTXQLEN>"
10790 #. type: Plain text
10791 #: build/C/man7/netdevice.7:252
10793 "Get or set the transmit queue length of a device using I<ifr_qlen>. Setting "
10794 "the transmit queue length is a privileged operation."
10798 #: build/C/man7/netdevice.7:252
10800 msgid "B<SIOCSIFNAME>"
10803 #. type: Plain text
10804 #: build/C/man7/netdevice.7:261
10806 "Changes the name of the interface specified in I<ifr_name> to "
10807 "I<ifr_newname>. This is a privileged operation. It is allowed only when "
10808 "the interface is not up."
10812 #: build/C/man7/netdevice.7:261
10814 msgid "B<SIOCGIFCONF>"
10817 #. Slaving isn't supported in 2.2
10820 #. .BR SIOCGIFSLAVE ", " SIOCSIFSLAVE
10821 #. Get or set the slave device using
10823 #. Setting the slave device is a privileged operation.
10825 #. FIXME add amateur radio stuff.
10826 #. type: Plain text
10827 #: build/C/man7/netdevice.7:301
10829 "Return a list of interface (transport layer) addresses. This currently "
10830 "means only addresses of the B<AF_INET> (IPv4) family for compatibility. The "
10831 "user passes a I<ifconf> structure as argument to the ioctl. It contains a "
10832 "pointer to an array of I<ifreq> structures in I<ifc_req> and its length in "
10833 "bytes in I<ifc_len>. The kernel fills the ifreqs with all current L3 "
10834 "interface addresses that are running: I<ifr_name> contains the interface "
10835 "name (eth0:1 etc.), I<ifr_addr> the address. The kernel returns with the "
10836 "actual length in I<ifc_len>. If I<ifc_len> is equal to the original length "
10837 "the buffer probably has overflowed and you should retry with a bigger buffer "
10838 "to get all addresses. When no error occurs the ioctl returns 0; otherwise "
10839 "-1. Overflow is not an error."
10842 #. type: Plain text
10843 #: build/C/man7/netdevice.7:307
10845 "Most protocols support their own ioctls to configure protocol-specific "
10846 "interface options. See the protocol man pages for a description. For "
10847 "configuring IP addresses see B<ip>(7)."
10850 #. type: Plain text
10851 #: build/C/man7/netdevice.7:310
10853 "In addition some devices support private ioctls. These are not described "
10857 #. type: Plain text
10858 #: build/C/man7/netdevice.7:318
10860 "Strictly speaking, B<SIOCGIFCONF> and the other ioctls that accept or return "
10861 "only B<AF_INET> socket addresses, are IP specific and belong in B<ip>(7)."
10864 #. type: Plain text
10865 #: build/C/man7/netdevice.7:323
10867 "The names of interfaces with no addresses or that don't have the "
10868 "B<IFF_RUNNING> flag set can be found via I</proc/net/dev>."
10871 #. type: Plain text
10872 #: build/C/man7/netdevice.7:328
10874 "Local IPv6 IP addresses can be found via I</proc/net> or via "
10878 #. type: Plain text
10879 #: build/C/man7/netdevice.7:334
10881 "glibc 2.1 is missing the I<ifr_newname> macro in I<E<lt>net/if.hE<gt>>. Add "
10882 "the following to your program as a workaround:"
10885 #. type: Plain text
10886 #: build/C/man7/netdevice.7:340
10889 "#ifndef ifr_newname\n"
10890 "#define ifr_newname ifr_ifru.ifru_slave\n"
10894 #. type: Plain text
10895 #: build/C/man7/netdevice.7:347
10896 msgid "B<proc>(5), B<capabilities>(7), B<ip>(7), B<rtnetlink>(7)"
10900 #: build/C/man5/networks.5:26
10906 #: build/C/man5/networks.5:26
10912 #: build/C/man5/networks.5:26
10917 #. type: Plain text
10918 #: build/C/man5/networks.5:29
10919 msgid "networks - network name information"
10922 #. type: Plain text
10923 #: build/C/man5/networks.5:35
10925 "The file I</etc/networks> is a plain ASCII file that describes known DARPA "
10926 "networks and symbolic names for these networks. Each line represents a "
10927 "network and has the following structure:"
10930 #. type: Plain text
10931 #: build/C/man5/networks.5:38
10932 msgid "I<name number aliases ...>"
10935 #. type: Plain text
10936 #: build/C/man5/networks.5:46
10938 "where the fields are delimited by spaces or tabs. Empty lines are ignored. "
10939 "The hash character (B<#>) indicates the start of a comment: this character, "
10940 "and the remaining characters up to the end of the current line, are ignored "
10941 "by library functions that process the file."
10944 #. type: Plain text
10945 #: build/C/man5/networks.5:48 build/C/man5/protocols.5:59
10946 msgid "The field descriptions are:"
10950 #: build/C/man5/networks.5:48
10955 #. type: Plain text
10956 #: build/C/man5/networks.5:53
10958 "The symbolic name for the network. Network names can contain any printable "
10959 "characters execept white-space characters or the comment character."
10963 #: build/C/man5/networks.5:53 build/C/man5/protocols.5:67
10968 #. type: Plain text
10969 #: build/C/man5/networks.5:58
10971 "The official number for this network in numbers-and-dots notation (see "
10972 "B<inet>(3)). The trailing \".0\" (for the host component of the network "
10973 "address) may be omitted."
10977 #: build/C/man5/networks.5:58 build/C/man5/protocols.5:71 build/C/man5/services.5:120
10982 #. type: Plain text
10983 #: build/C/man5/networks.5:61
10984 msgid "Optional aliases for the network."
10987 #. type: Plain text
10988 #: build/C/man5/networks.5:70
10990 "This file is read by the B<route>(8) and B<netstat>(8) utilities. Only "
10991 "Class A, B or C networks are supported, partitioned networks (i.e., "
10992 "network/26 or network/28) are not supported by this facility."
10995 #. type: Plain text
10996 #: build/C/man5/networks.5:74
10997 msgid "The networks definition file."
11000 #. type: Plain text
11001 #: build/C/man5/networks.5:80
11003 "B<getnetbyaddr>(3), B<getnetbyname>(3), B<getnetent>(3), B<netstat>(8), "
11008 #: build/C/man8/nscd.8:23
11013 #. type: Plain text
11014 #: build/C/man8/nscd.8:26
11015 msgid "nscd - name service cache daemon"
11018 #. type: Plain text
11019 #: build/C/man8/nscd.8:34
11021 "Nscd is a daemon that provides a cache for the most common name service "
11022 "requests. The default configuration file, I</etc/nscd.conf>, determines the "
11023 "behavior of the cache daemon. See B<nscd.conf>(5)."
11026 #. type: Plain text
11027 #: build/C/man8/nscd.8:47
11029 "Nscd provides caching for accesses of the B<passwd>(5), B<group>(5), and "
11030 "B<hosts>(5) databases through standard libc interfaces, such as "
11031 "B<getpwnam>(3), B<getpwuid>(3), B<getgrnam>(3), B<getgrgid>(3), "
11032 "B<gethostbyname>(3), and others."
11035 #. type: Plain text
11036 #: build/C/man8/nscd.8:56
11038 "There are two caches for each database: a positive one for items found, and "
11039 "a negative one for items not found. Each cache has a separate TTL "
11040 "(time-to-live) period for its data. Note that the shadow file is "
11041 "specifically not cached. B<getspnam>(3) calls remain uncached as a result."
11045 #: build/C/man8/nscd.8:56
11051 #: build/C/man8/nscd.8:57
11056 #. type: Plain text
11057 #: build/C/man8/nscd.8:60
11058 msgid "will give you a list with all options and what they do."
11061 #. type: Plain text
11062 #: build/C/man8/nscd.8:83
11064 "The daemon will try to watch for changes in configuration files appropriate "
11065 "for each database (e.g., I</etc/passwd> for the I<passwd> database or "
11066 "I</etc/hosts> and I</etc/resolv.conf> for the I<hosts> database), and flush "
11067 "the cache when these are changed. However, this will happen only after a "
11068 "short delay (unless the B<inotify>(7) mechanism is available and glibc 2.9 "
11069 "or later is available), and this auto-detection does not cover configuration "
11070 "files required by nonstandard NSS modules, if any are specified in "
11071 "I</etc/nsswitch.conf>. In that case, you need to run the following command "
11072 "after changing the configuration file of the database so that B<nscd> "
11073 "invalidates its cache:"
11076 #. type: Plain text
11077 #: build/C/man8/nscd.8:85
11079 msgid " $ B<nscd -i> I<E<lt>databaseE<gt>>\n"
11084 #. was written by Thorsten Kukuk and Ulrich Drepper.
11085 #. type: Plain text
11086 #: build/C/man8/nscd.8:91
11087 msgid "B<nscd.conf>(5), B<nsswitch.conf>(5)"
11091 #: build/C/man5/nscd.conf.5:20
11096 #. type: Plain text
11097 #: build/C/man5/nscd.conf.5:23
11098 msgid "/etc/nscd.conf - name service cache daemon configuration file"
11101 #. type: Plain text
11102 #: build/C/man5/nscd.conf.5:36
11104 "The file I</etc/nscd.conf> is read from B<nscd>(8) at startup. Each line "
11105 "specifies either an attribute and a value, or an attribute, service, and a "
11106 "value. Fields are separated either by SPACE or TAB characters. A "
11107 "\\(aq#\\(aq (number sign) indicates the beginning of a comment; following "
11108 "characters, up to the end of the line, are not interpreted by nscd."
11111 #. type: Plain text
11112 #: build/C/man5/nscd.conf.5:39
11114 "Valid services are I<passwd>, I<group>, I<hosts>, I<services> or "
11118 #. type: Plain text
11119 #: build/C/man5/nscd.conf.5:42
11120 msgid "B<logfile> I<debug-file-name>"
11123 #. type: Plain text
11124 #: build/C/man5/nscd.conf.5:44
11125 msgid "Specifies name of the file to which debug info should be written."
11128 #. type: Plain text
11129 #: build/C/man5/nscd.conf.5:48
11130 msgid "B<debug-level> I<value>"
11133 #. type: Plain text
11134 #: build/C/man5/nscd.conf.5:51
11135 msgid "Sets the desired debug level. The default is 0."
11138 #. type: Plain text
11139 #: build/C/man5/nscd.conf.5:55
11140 msgid "B<threads> I<number>"
11143 #. type: Plain text
11144 #: build/C/man5/nscd.conf.5:59
11146 "This is the number of threads that are started to wait for requests. At "
11147 "least five threads will always be created."
11150 #. type: Plain text
11151 #: build/C/man5/nscd.conf.5:63
11152 msgid "B<max-threads> I<number>"
11155 #. type: Plain text
11156 #: build/C/man5/nscd.conf.5:66
11157 msgid "Specifies the maximum number of threads. The default is 32."
11160 #. type: Plain text
11161 #: build/C/man5/nscd.conf.5:70
11162 msgid "B<server-user> I<user>"
11165 #. type: Plain text
11166 #: build/C/man5/nscd.conf.5:74
11168 "If this option is set, nscd will run as this user and not as root. If a "
11169 "separate cache for every user is used (-S parameter), this option is "
11173 #. type: Plain text
11174 #: build/C/man5/nscd.conf.5:78
11175 msgid "B<stat-user> I<user>"
11178 #. type: Plain text
11179 #: build/C/man5/nscd.conf.5:80
11180 msgid "Specifies the user who is allowed to request statistics."
11183 #. type: Plain text
11184 #: build/C/man5/nscd.conf.5:85
11185 msgid "B<reload-count> unlimited | I<number>"
11188 #. type: Plain text
11189 #: build/C/man5/nscd.conf.5:89
11191 "Limit on the number of times a cached entry gets reloaded without being used "
11192 "before it gets removed. The default is 5."
11195 #. type: Plain text
11196 #: build/C/man5/nscd.conf.5:93
11197 msgid "B<paranoia> I<E<lt>yes|noE<gt>>"
11200 #. type: Plain text
11201 #: build/C/man5/nscd.conf.5:96
11203 "Enabling paranoia mode causes nscd to restart itself periodically. The "
11207 #. type: Plain text
11208 #: build/C/man5/nscd.conf.5:100
11209 msgid "B<restart-interval> I<time>"
11212 #. type: Plain text
11213 #: build/C/man5/nscd.conf.5:108
11215 "Sets the restart interval to I<time> seconds if periodic restart is enabled "
11216 "by enabling B<paranoia> mode. The default is 3600."
11219 #. type: Plain text
11220 #: build/C/man5/nscd.conf.5:113
11221 msgid "B<enable-cache> I<service> I<E<lt>yes|noE<gt>>"
11224 #. type: Plain text
11225 #: build/C/man5/nscd.conf.5:118
11226 msgid "Enables or disables the specified I<service> cache. The default is no."
11229 #. type: Plain text
11230 #: build/C/man5/nscd.conf.5:123
11231 msgid "B<positive-time-to-live> I<service> I<value>"
11234 #. type: Plain text
11235 #: build/C/man5/nscd.conf.5:131
11237 "Sets the TTL (time-to-live) for positive entries (successful queries) in "
11238 "the specified cache for I<service>. I<Value> is in seconds. Larger values "
11239 "increase cache hit rates and reduce mean response times, but increase "
11240 "problems with cache coherence."
11243 #. type: Plain text
11244 #: build/C/man5/nscd.conf.5:136
11245 msgid "B<negative-time-to-live> I<service> I<value>"
11248 #. type: Plain text
11249 #: build/C/man5/nscd.conf.5:146
11251 "Sets the TTL (time-to-live) for negative entries (unsuccessful queries) in "
11252 "the specified cache for I<service>. I<Value> is in seconds. Can result in "
11253 "significant performance improvements if there are several files owned by "
11254 "UIDs (user IDs) not in system databases (for example untarring the Linux "
11255 "kernel sources as root); should be kept small to reduce cache coherency "
11259 #. type: Plain text
11260 #: build/C/man5/nscd.conf.5:151
11261 msgid "B<suggested-size> I<service> I<value>"
11264 #. type: Plain text
11265 #: build/C/man5/nscd.conf.5:156
11267 "This is the internal hash table size, I<value> should remain a prime number "
11268 "for optimum efficiency. The default is 211."
11271 #. type: Plain text
11272 #: build/C/man5/nscd.conf.5:161
11273 msgid "B<check-files> I<service> I<E<lt>yes|noE<gt>>"
11276 #. type: Plain text
11277 #: build/C/man5/nscd.conf.5:173
11279 "Enables or disables checking the file belonging to the specified I<service> "
11280 "for changes. The files are I</etc/passwd>, I</etc/group>, I</etc/hosts>, "
11281 "I</etc/services> and I</etc/netgroup>. The default is yes."
11284 #. type: Plain text
11285 #: build/C/man5/nscd.conf.5:178
11286 msgid "B<persistent> I<service> I<E<lt>yes|noE<gt>>"
11289 #. type: Plain text
11290 #: build/C/man5/nscd.conf.5:185
11292 "Keep the content of the cache for I<service> over server restarts; useful "
11293 "when B<paranoia> mode is set. The default is no."
11296 #. type: Plain text
11297 #: build/C/man5/nscd.conf.5:190
11298 msgid "B<shared> I<service> I<E<lt>yes|noE<gt>>"
11301 #. type: Plain text
11302 #: build/C/man5/nscd.conf.5:197
11304 "The memory mapping of the nscd databases for I<service> is shared with the "
11305 "clients so that they can directly search in them instead of having to ask "
11306 "the daemon over the socket each time a lookup is performed. The default is "
11310 #. type: Plain text
11311 #: build/C/man5/nscd.conf.5:202
11312 msgid "B<max-db-size> I<service> I<bytes>"
11315 #. type: Plain text
11316 #: build/C/man5/nscd.conf.5:206
11318 "The maximum allowable size, in bytes, of the database files for the "
11319 "I<service>. The default is 33554432."
11322 #. type: Plain text
11323 #: build/C/man5/nscd.conf.5:211
11324 msgid "B<auto-propagate> I<service> I<E<lt>yes|noE<gt>>"
11327 #. type: Plain text
11328 #: build/C/man5/nscd.conf.5:231
11330 "When set to I<no> for I<passwd> or I<group> service, then the I<.byname> "
11331 "requests are not added to I<passwd.byuid> or I<group.bygid> cache. This can "
11332 "help with tables containing multiple records for the same ID. The default "
11333 "is yes. This option is valid only for services I<passwd> and I<group>."
11338 #. was written by Thorsten Kukuk and Ulrich Drepper.
11339 #. type: Plain text
11340 #: build/C/man5/nscd.conf.5:237
11345 #: build/C/man5/nss.5:19
11350 #. type: Plain text
11351 #: build/C/man5/nss.5:22
11352 msgid "nss - Name Service Switch configuration file"
11355 #. type: Plain text
11356 #: build/C/man5/nss.5:29
11358 "Each call to a function which retrieves data from a system database like the "
11359 "password or group database is handled by the Name Service Switch "
11360 "implementation in the GNU C library. The various services provided are "
11361 "implemented by independent modules, each of which naturally varies widely "
11365 #. type: Plain text
11366 #: build/C/man5/nss.5:38
11368 "The default implementations coming with the GNU C library are by default "
11369 "conservative and do not use unsafe data. This might be very costly in some "
11370 "situations, especially when the databases are large. Some modules allow the "
11371 "system administrator to request taking shortcuts if these are known to be "
11372 "safe. It is then the system administrator's responsibility to ensure the "
11373 "assumption is correct."
11376 #. type: Plain text
11377 #: build/C/man5/nss.5:42
11379 "There are other modules where the implementation changed over time. If an "
11380 "implementation used to sacrifice speed for memory consumption it might "
11381 "create problems if the preference is switched."
11384 #. type: Plain text
11385 #: build/C/man5/nss.5:51
11387 "The I</etc/default/nss> file contains a number of variable assignments. "
11388 "Each variable controls the behavior of one or more NSS modules. White "
11389 "spaces are ignored. Lines beginning with \\(aq#\\(aq are treated as "
11393 #. type: Plain text
11394 #: build/C/man5/nss.5:53
11395 msgid "The variables currently recognized are:"
11399 #: build/C/man5/nss.5:53
11401 msgid "B<NETID_AUTHORITATIVE => I<TRUE>|I<FALSE>"
11404 #. type: Plain text
11405 #: build/C/man5/nss.5:68
11407 "If set to TRUE, the NIS backend for the B<initgroups>(3) function will "
11408 "accept the information from the I<netid.byname> NIS map as authoritative. "
11409 "This can speed up the function significantly if the I<group.byname> map is "
11410 "large. The content of the I<netid.byname> map is used B<as is>. The system "
11411 "administrator has to make sure it is correctly generated."
11415 #: build/C/man5/nss.5:68
11417 msgid "B<SERVICES_AUTHORITATIVE => I<TRUE>|I<FALSE>"
11420 #. type: Plain text
11421 #: build/C/man5/nss.5:80
11423 "If set to TRUE, the NIS backend for the B<getservbyname>(3) and "
11424 "B<getservbyname_r>(3) functions will assume that the "
11425 "I<services.byservicename> NIS map exists and is authoritative, particularly "
11426 "that it contains both keys with /proto and without /proto for both primary "
11427 "service names and service aliases. The system administrator has to make "
11428 "sure it is correctly generated."
11432 #: build/C/man5/nss.5:80
11434 msgid "B<SETENT_BATCH_READ => I<TRUE>|I<FALSE>"
11437 #. type: Plain text
11438 #: build/C/man5/nss.5:98
11440 "If set to TRUE, the NIS backend for the B<setpwent>(3) and B<setgrent>(3) "
11441 "functions will read the entire database at once and then hand out the "
11442 "requests one by one from memory with every corresponding B<getpwent>(3) or "
11443 "B<getgrent>(3) call respectively. Otherwise each B<getpwent>(3) or "
11444 "B<getgrent>(3) call might result in a network communication with the server "
11445 "to get the next entry."
11448 #. type: Plain text
11449 #: build/C/man5/nss.5:100
11450 msgid "I</etc/default/nss>"
11453 #. type: Plain text
11454 #: build/C/man5/nss.5:102
11455 msgid "The default configuration corresponds to the following configuration file:"
11459 #. Ulrich Drepper <drepper@redhat.com>
11460 #. type: Plain text
11461 #: build/C/man5/nss.5:110
11464 "NETID_AUTHORITATIVE=FALSE\n"
11465 "SERVICES_AUTHORITATIVE=FALSE\n"
11466 "SETENT_BATCH_READ=FALSE\n"
11469 #. type: Plain text
11470 #: build/C/man5/nss.5:112
11471 msgid "I<nsswitch.conf>"
11475 #: build/C/man5/nsswitch.conf.5:25
11477 msgid "NSSWITCH.CONF"
11480 #. type: Plain text
11481 #: build/C/man5/nsswitch.conf.5:28
11482 msgid "nsswitch.conf - Name Service Switch configuration file"
11485 #. type: Plain text
11486 #: build/C/man5/nsswitch.conf.5:36
11488 "The Name Service Switch (NSS) configuration file, I</etc/nsswitch.conf>, is "
11489 "used by the GNU C Library to determine the sources from which to obtain "
11490 "name-service information in a range of categories, and in what order. Each "
11491 "category of information is identified by a database name."
11494 #. type: Plain text
11495 #: build/C/man5/nsswitch.conf.5:42
11497 "The file is plain ASCII text, with columns separated by spaces or tab "
11498 "characters. The first column specifies the database name. The remaining "
11499 "columns describe the order of sources to query and a limited set of actions "
11500 "that can be performed by lookup result."
11503 #. type: Plain text
11504 #: build/C/man5/nsswitch.conf.5:44
11505 msgid "The following databases are understood by the GNU C Library:"
11508 #. type: Plain text
11509 #: build/C/man5/nsswitch.conf.5:49
11510 msgid "Mail aliases, used by B<getaliasent>(3) and related functions."
11513 #. type: Plain text
11514 #: build/C/man5/nsswitch.conf.5:52
11515 msgid "Ethernet numbers."
11518 #. type: Plain text
11519 #: build/C/man5/nsswitch.conf.5:57
11520 msgid "Groups of users, used by B<getgrent>(3) and related functions."
11523 #. type: Plain text
11524 #: build/C/man5/nsswitch.conf.5:62
11525 msgid "Host names and numbers, used by B<gethostbyname>(3) and related functions."
11528 #. type: Plain text
11529 #: build/C/man5/nsswitch.conf.5:67
11530 msgid "Supplementary group access list, used by B<getgrouplist>(3) function."
11533 #. type: Plain text
11534 #: build/C/man5/nsswitch.conf.5:71
11536 "Network-wide list of hosts and users, used for access rules. C libraries "
11537 "before glibc 2.1 supported netgroups only over NIS."
11540 #. type: Plain text
11541 #: build/C/man5/nsswitch.conf.5:76
11542 msgid "Network names and numbers, used by B<getnetent>(3) and related functions."
11545 #. type: Plain text
11546 #: build/C/man5/nsswitch.conf.5:81
11547 msgid "User passwords, used by B<getpwent>(3) and related functions."
11550 #. type: Plain text
11551 #: build/C/man5/nsswitch.conf.5:86
11552 msgid "Network protocols, used by B<getprotoent>(3) and related functions."
11556 #: build/C/man5/nsswitch.conf.5:86
11558 msgid "B<publickey>"
11561 #. type: Plain text
11562 #: build/C/man5/nsswitch.conf.5:89
11563 msgid "Public and secret keys for Secure_RPC used by NFS and NIS+."
11566 #. type: Plain text
11567 #: build/C/man5/nsswitch.conf.5:94
11569 "Remote procedure call names and numbers, used by B<getrpcbyname>(3) and "
11570 "related functions."
11573 #. type: Plain text
11574 #: build/C/man5/nsswitch.conf.5:99
11575 msgid "Network services, used by B<getservent>(3) and related functions."
11578 #. type: Plain text
11579 #: build/C/man5/nsswitch.conf.5:104
11580 msgid "Shadow user passwords, used by B<getspnam>(3) and related functions."
11583 #. type: Plain text
11584 #: build/C/man5/nsswitch.conf.5:108
11585 msgid "Here is an example I</etc/nsswitch.conf> file:"
11589 #: build/C/man5/nsswitch.conf.5:111
11594 #. type: Plain text
11595 #: build/C/man5/nsswitch.conf.5:114 build/C/man5/nsswitch.conf.5:117 build/C/man5/nsswitch.conf.5:120
11600 #: build/C/man5/nsswitch.conf.5:114
11606 #: build/C/man5/nsswitch.conf.5:117
11612 #: build/C/man5/nsswitch.conf.5:121
11617 #. type: Plain text
11618 #: build/C/man5/nsswitch.conf.5:124
11619 msgid "dns [!UNAVAIL=return] files"
11623 #: build/C/man5/nsswitch.conf.5:124
11628 #. type: Plain text
11629 #: build/C/man5/nsswitch.conf.5:127 build/C/man5/nsswitch.conf.5:130 build/C/man5/nsswitch.conf.5:133 build/C/man5/nsswitch.conf.5:136 build/C/man5/nsswitch.conf.5:139
11630 msgid "nis [NOTFOUND=return] files"
11634 #: build/C/man5/nsswitch.conf.5:127
11640 #: build/C/man5/nsswitch.conf.5:130
11646 #: build/C/man5/nsswitch.conf.5:133
11652 #: build/C/man5/nsswitch.conf.5:136
11657 #. type: Plain text
11658 #: build/C/man5/nsswitch.conf.5:144
11659 msgid "The first column is the database name. The remaining columns specify:"
11662 #. type: Plain text
11663 #: build/C/man5/nsswitch.conf.5:148
11665 "One or more service specifications e.g., \"files\", \"db\", or \"nis\". The "
11666 "order of the services on the line determines the order in which those "
11667 "services will be queried, in turn, until a result is found."
11670 #. type: Plain text
11671 #: build/C/man5/nsswitch.conf.5:151
11673 "Optional actions to perform if a particular result is obtained from the "
11674 "preceding service, e.g., \"[NOTFOUND=return]\"."
11677 #. type: Plain text
11678 #: build/C/man5/nsswitch.conf.5:177
11680 "The service specifications supported on your system depend on the presence "
11681 "of shared libraries, and are therefore extensible. Libraries called "
11682 "I</lib/libnss_SERVICE.so.>B<X> will provide the named I<SERVICE>. On a "
11683 "standard installation, you can use \"files\", \"db\", \"nis\", and "
11684 "\"nisplus\". For the B<hosts> database, you can additionally specify "
11685 "\"dns\". For the B<passwd>, B<group>, and B<shadow> databases, you can "
11686 "additionally specify \"compat\" (see B<Compatibility mode> below). The "
11687 "version number B<X> may be 1 for glibc 2.0, or 2 for glibc 2.1 and later. "
11688 "On systems with additional libraries installed, you may have access to "
11689 "further services such as \"hesiod\", \"ldap\", \"winbind\" and \"wins\"."
11692 #. type: Plain text
11693 #: build/C/man5/nsswitch.conf.5:182
11695 "An action may also be specified following a service specification. The "
11696 "action modifies the behavior following a result obtained from the preceding "
11697 "data source. Action items take the general form:"
11700 #. type: Plain text
11701 #: build/C/man5/nsswitch.conf.5:185
11702 msgid "[I<STATUS>=I<ACTION>]"
11705 #. type: Plain text
11706 #: build/C/man5/nsswitch.conf.5:187
11707 msgid "[!I<STATUS>=I<ACTION>]"
11710 #. type: Plain text
11711 #: build/C/man5/nsswitch.conf.5:190
11715 #. type: Plain text
11716 #: build/C/man5/nsswitch.conf.5:201
11717 msgid "I<STATUS> =E<gt> B<success> | B<notfound> | B<unavail> | B<tryagain>"
11720 #. type: Plain text
11721 #: build/C/man5/nsswitch.conf.5:207
11722 msgid "I<ACTION> =E<gt> B<return> | B<continue>"
11725 #. type: Plain text
11726 #: build/C/man5/nsswitch.conf.5:212
11728 "The ! negates the test, matching all possible results except the one "
11729 "specified. The case of the keywords is not significant."
11732 #. type: Plain text
11733 #: build/C/man5/nsswitch.conf.5:217
11735 "The I<STATUS> value is matched against the result of the lookup function "
11736 "called by the preceding service specification, and can be one of:"
11740 #: build/C/man5/nsswitch.conf.5:218
11745 #. type: Plain text
11746 #: build/C/man5/nsswitch.conf.5:222
11748 "No error occurred and the requested entry is returned. The default action "
11749 "for this condition is \"return\"."
11753 #: build/C/man5/nsswitch.conf.5:222
11755 msgid "B<notfound>"
11758 #. type: Plain text
11759 #: build/C/man5/nsswitch.conf.5:226
11761 "The lookup succeeded, but the requested entry was not found. The default "
11762 "action for this condition is \"continue\"."
11766 #: build/C/man5/nsswitch.conf.5:226
11771 #. type: Plain text
11772 #: build/C/man5/nsswitch.conf.5:233
11774 "The service is permanently unavailable. This can mean either that the "
11775 "required file cannot be read, or, for network services, that the server is "
11776 "not available or does not allow queries. The default action for this "
11777 "condition is \"continue\"."
11781 #: build/C/man5/nsswitch.conf.5:233
11783 msgid "B<tryagain>"
11786 #. type: Plain text
11787 #: build/C/man5/nsswitch.conf.5:239
11789 "The service is temporarily unavailable. This could mean a file is locked or "
11790 "a server currently cannot accept more connections. The default action for "
11791 "this condition is \"continue\"."
11794 #. type: Plain text
11795 #: build/C/man5/nsswitch.conf.5:244
11796 msgid "The I<ACTION> value can be one of:"
11800 #: build/C/man5/nsswitch.conf.5:245
11805 #. type: Plain text
11806 #: build/C/man5/nsswitch.conf.5:257
11808 "Return a result now. Do not call any further lookup functions. However, "
11809 "for compatibility reasons, if this is the selected action for the B<group> "
11810 "database and the B<notfound> status, and the configuration file does not "
11811 "contain the B<initgroups> line, the next lookup function is always called, "
11812 "without affecting the search result."
11816 #: build/C/man5/nsswitch.conf.5:257
11818 msgid "B<continue>"
11821 #. type: Plain text
11822 #: build/C/man5/nsswitch.conf.5:260
11823 msgid "Call the next lookup function."
11827 #: build/C/man5/nsswitch.conf.5:261
11829 msgid "Compatibility mode (compat)"
11832 #. type: Plain text
11833 #: build/C/man5/nsswitch.conf.5:267
11835 "The NSS \"compat\" service is similar to \"files\" except that it "
11836 "additionally permits special entries in I</etc/passwd> for granting users or "
11837 "members of netgroups access to the system. The following entries are valid "
11842 #: build/C/man5/nsswitch.conf.5:268
11844 msgid "B<+>I<user>"
11847 #. type: Plain text
11848 #: build/C/man5/nsswitch.conf.5:273
11849 msgid "Include the specified I<user> from the NIS passwd map."
11853 #: build/C/man5/nsswitch.conf.5:273
11855 msgid "B<+@>I<netgroup>"
11858 #. type: Plain text
11859 #: build/C/man5/nsswitch.conf.5:277
11860 msgid "Include all users in the given I<netgroup>."
11864 #: build/C/man5/nsswitch.conf.5:277
11866 msgid "B<->I<user>"
11869 #. type: Plain text
11870 #: build/C/man5/nsswitch.conf.5:282
11871 msgid "Exclude the specified I<user> from the NIS passwd map."
11875 #: build/C/man5/nsswitch.conf.5:282
11877 msgid "B<-@>I<netgroup>"
11880 #. type: Plain text
11881 #: build/C/man5/nsswitch.conf.5:286
11882 msgid "Exclude all users in the given I<netgroup>."
11886 #: build/C/man5/nsswitch.conf.5:286
11891 #. type: Plain text
11892 #: build/C/man5/nsswitch.conf.5:290
11894 "Include every user, except previously excluded ones, from the NIS passwd "
11898 #. type: Plain text
11899 #: build/C/man5/nsswitch.conf.5:298
11901 "By default the source is \"nis\", but this may be overridden by specifying "
11902 "\"nisplus\" as the source for the pseudo-databases B<passwd_compat>, "
11903 "B<group_compat>, and B<shadow_compat>."
11906 #. type: Plain text
11907 #: build/C/man5/nsswitch.conf.5:305
11909 "A service named I<SERVICE> is implemented by a shared object library named "
11910 "I<libnss_SERVICE.so.>B<X> that resides in I</lib>."
11913 #. type: Plain text
11914 #: build/C/man5/nsswitch.conf.5:310
11915 msgid "NSS configuration file."
11919 #: build/C/man5/nsswitch.conf.5:310
11921 msgid "I</lib/libnss_compat.so.>B<X>"
11924 #. type: Plain text
11925 #: build/C/man5/nsswitch.conf.5:313
11926 msgid "implements \"compat\" source."
11930 #: build/C/man5/nsswitch.conf.5:313
11932 msgid "I</lib/libnss_db.so.>B<X>"
11935 #. type: Plain text
11936 #: build/C/man5/nsswitch.conf.5:316
11937 msgid "implements \"db\" source."
11941 #: build/C/man5/nsswitch.conf.5:316
11943 msgid "I</lib/libnss_dns.so.>B<X>"
11946 #. type: Plain text
11947 #: build/C/man5/nsswitch.conf.5:319
11948 msgid "implements \"dns\" source."
11952 #: build/C/man5/nsswitch.conf.5:319
11954 msgid "I</lib/libnss_files.so.>B<X>"
11957 #. type: Plain text
11958 #: build/C/man5/nsswitch.conf.5:322
11959 msgid "implements \"files\" source."
11963 #: build/C/man5/nsswitch.conf.5:322
11965 msgid "I</lib/libnss_hesiod.so.>B<X>"
11968 #. type: Plain text
11969 #: build/C/man5/nsswitch.conf.5:325
11970 msgid "implements \"hesiod\" source."
11974 #: build/C/man5/nsswitch.conf.5:325
11976 msgid "I</lib/libnss_nis.so.>B<X>"
11979 #. type: Plain text
11980 #: build/C/man5/nsswitch.conf.5:328
11981 msgid "implements \"nis\" source."
11985 #: build/C/man5/nsswitch.conf.5:328
11987 msgid "I</lib/libnss_nisplus.so.>B<X>"
11990 #. type: Plain text
11991 #: build/C/man5/nsswitch.conf.5:331
11992 msgid "implements \"nisplus\" source."
11995 #. type: Plain text
11996 #: build/C/man5/nsswitch.conf.5:339
11998 "Within each process that uses B<nsswitch.conf>, the entire file is read only "
11999 "once. If the file is later changed, the process will continue using the old "
12003 #. type: Plain text
12004 #: build/C/man5/nsswitch.conf.5:352
12006 "Traditionally, there was only a single source for service information, often "
12007 "in the form of a single configuration file (e.g., I</etc/passwd>). However, "
12008 "as other name services, such as the Network Information Service (NIS) and "
12009 "the Domain Name Service (DNS), became popular, a method was needed that "
12010 "would be more flexible than fixed search orders coded into the C library. "
12011 "The Name Service Switch mechanism, which was based on the mechanism used by "
12012 "Sun Microsystems in the Solaris 2 C library, introduced a cleaner solution "
12016 #. type: Plain text
12017 #: build/C/man5/nsswitch.conf.5:355
12018 msgid "B<getent>(1), B<nss>(5)"
12022 #: build/C/man7/packet.7:12
12027 #. type: Plain text
12028 #: build/C/man7/packet.7:15
12029 msgid "packet - packet interface on device level."
12032 #. type: Plain text
12033 #: build/C/man7/packet.7:18
12035 msgid "B<#include E<lt>sys/socket.hE<gt>>\n"
12038 #. type: Plain text
12039 #: build/C/man7/packet.7:20
12041 msgid "B<#include E<lt>netpacket/packet.hE<gt>>\n"
12044 #. type: Plain text
12045 #: build/C/man7/packet.7:22
12047 msgid "B<#include E<lt>net/ethernet.hE<gt> /* the L2 protocols */>\n"
12050 #. type: Plain text
12051 #: build/C/man7/packet.7:24
12054 "B<packet_socket = socket(AF_PACKET, int >I<socket_type>B<, int "
12055 ">I<protocol>B<);>\n"
12058 #. type: Plain text
12059 #: build/C/man7/packet.7:30
12061 "Packet sockets are used to receive or send raw packets at the device driver "
12062 "(OSI Layer 2) level. They allow the user to implement protocol modules in "
12063 "user space on top of the physical layer."
12066 #. type: Plain text
12067 #: build/C/man7/packet.7:52
12069 "The I<socket_type> is either B<SOCK_RAW> for raw packets including the link "
12070 "level header or B<SOCK_DGRAM> for cooked packets with the link level header "
12071 "removed. The link level header information is available in a common format "
12072 "in a I<sockaddr_ll>. I<protocol> is the IEEE 802.3 protocol number in "
12073 "network order. See the I<E<lt>linux/if_ether.hE<gt>> include file for a "
12074 "list of allowed protocols. When protocol is set to B<htons(ETH_P_ALL)> then "
12075 "all protocols are received. All incoming packets of that protocol type will "
12076 "be passed to the packet socket before they are passed to the protocols "
12077 "implemented in the kernel."
12080 #. type: Plain text
12081 #: build/C/man7/packet.7:56
12083 "Only processes with effective UID 0 or the B<CAP_NET_RAW> capability may "
12084 "open packet sockets."
12087 #. type: Plain text
12088 #: build/C/man7/packet.7:74
12090 "B<SOCK_RAW> packets are passed to and from the device driver without any "
12091 "changes in the packet data. When receiving a packet, the address is still "
12092 "parsed and passed in a standard I<sockaddr_ll> address structure. When "
12093 "transmitting a packet, the user supplied buffer should contain the physical "
12094 "layer header. That packet is then queued unmodified to the network driver "
12095 "of the interface defined by the destination address. Some device drivers "
12096 "always add other headers. B<SOCK_RAW> is similar to but not compatible with "
12097 "the obsolete B<AF_INET/SOCK_PACKET> of Linux 2.0."
12100 #. type: Plain text
12101 #: build/C/man7/packet.7:84
12103 "B<SOCK_DGRAM> operates on a slightly higher level. The physical header is "
12104 "removed before the packet is passed to the user. Packets sent through a "
12105 "B<SOCK_DGRAM> packet socket get a suitable physical layer header based on "
12106 "the information in the I<sockaddr_ll> destination address before they are "
12110 #. type: Plain text
12111 #: build/C/man7/packet.7:97
12113 "By default all packets of the specified protocol type are passed to a packet "
12114 "socket. To get packets only from a specific interface use B<bind>(2) "
12115 "specifying an address in a I<struct sockaddr_ll> to bind the packet socket "
12116 "to an interface. Only the I<sll_protocol> and the I<sll_ifindex> address "
12117 "fields are used for purposes of binding."
12120 #. type: Plain text
12121 #: build/C/man7/packet.7:101
12122 msgid "The B<connect>(2) operation is not supported on packet sockets."
12125 #. type: Plain text
12126 #: build/C/man7/packet.7:110
12128 "When the B<MSG_TRUNC> flag is passed to B<recvmsg>(2), B<recv>(2), "
12129 "B<recvfrom>(2) the real length of the packet on the wire is always "
12130 "returned, even when it is longer than the buffer."
12134 #: build/C/man7/packet.7:110
12136 msgid "Address types"
12139 #. type: Plain text
12140 #: build/C/man7/packet.7:112
12141 msgid "The sockaddr_ll is a device independent physical layer address."
12144 #. type: Plain text
12145 #: build/C/man7/packet.7:124
12148 "struct sockaddr_ll {\n"
12149 " unsigned short sll_family; /* Always AF_PACKET */\n"
12150 " unsigned short sll_protocol; /* Physical layer protocol */\n"
12151 " int sll_ifindex; /* Interface number */\n"
12152 " unsigned short sll_hatype; /* ARP hardware type */\n"
12153 " unsigned char sll_pkttype; /* Packet type */\n"
12154 " unsigned char sll_halen; /* Length of address */\n"
12155 " unsigned char sll_addr[8]; /* Physical layer address */\n"
12159 #. type: Plain text
12160 #: build/C/man7/packet.7:163
12162 "I<sll_protocol> is the standard ethernet protocol type in network order as "
12163 "defined in the I<E<lt>linux/if_ether.hE<gt>> include file. It defaults to "
12164 "the socket's protocol. I<sll_ifindex> is the interface index of the "
12165 "interface (see B<netdevice>(7)); 0 matches any interface (only permitted for "
12166 "binding). I<sll_hatype> is an ARP type as defined in the "
12167 "I<E<lt>linux/if_arp.hE<gt>> include file. I<sll_pkttype> contains the "
12168 "packet type. Valid types are B<PACKET_HOST> for a packet addressed to the "
12169 "local host, B<PACKET_BROADCAST> for a physical layer broadcast packet, "
12170 "B<PACKET_MULTICAST> for a packet sent to a physical layer multicast address, "
12171 "B<PACKET_OTHERHOST> for a packet to some other host that has been caught by "
12172 "a device driver in promiscuous mode, and B<PACKET_OUTGOING> for a packet "
12173 "originated from the local host that is looped back to a packet socket. "
12174 "These types make sense only for receiving. I<sll_addr> and I<sll_halen> "
12175 "contain the physical layer (e.g., IEEE 802.3) address and its length. The "
12176 "exact interpretation depends on the device."
12179 #. type: Plain text
12180 #: build/C/man7/packet.7:179
12182 "When you send packets it is enough to specify I<sll_family>, I<sll_addr>, "
12183 "I<sll_halen>, I<sll_ifindex>. The other fields should be 0. I<sll_hatype> "
12184 "and I<sll_pkttype> are set on received packets for your information. For "
12185 "bind only I<sll_protocol> and I<sll_ifindex> are used."
12188 #. type: Plain text
12189 #: build/C/man7/packet.7:194
12191 "Packet sockets can be used to configure physical layer multicasting and "
12192 "promiscuous mode. It works by calling B<setsockopt>(2) on a packet socket "
12193 "for B<SOL_PACKET> and one of the options B<PACKET_ADD_MEMBERSHIP> to add a "
12194 "binding or B<PACKET_DROP_MEMBERSHIP> to drop it. They both expect a "
12195 "B<packet_mreq> structure as argument:"
12198 #. type: Plain text
12199 #: build/C/man7/packet.7:203
12202 "struct packet_mreq {\n"
12203 " int mr_ifindex; /* interface index */\n"
12204 " unsigned short mr_type; /* action */\n"
12205 " unsigned short mr_alen; /* address length */\n"
12206 " unsigned char mr_address[8]; /* physical layer address */\n"
12210 #. type: Plain text
12211 #: build/C/man7/packet.7:224
12213 "B<mr_ifindex> contains the interface index for the interface whose status "
12214 "should be changed. The B<mr_type> parameter specifies which action to "
12215 "perform. B<PACKET_MR_PROMISC> enables receiving all packets on a shared "
12216 "medium (often known as \"promiscuous mode\"), B<PACKET_MR_MULTICAST> binds "
12217 "the socket to the physical layer multicast group specified in B<mr_address> "
12218 "and B<mr_alen>, and B<PACKET_MR_ALLMULTI> sets the socket up to receive all "
12219 "multicast packets arriving at the interface."
12222 #. type: Plain text
12223 #: build/C/man7/packet.7:230
12225 "In addition the traditional ioctls B<SIOCSIFFLAGS>, B<SIOCADDMULTI>, "
12226 "B<SIOCDELMULTI> can be used for the same purpose."
12229 #. FIXME Document SIOCGSTAMPNS
12230 #. type: Plain text
12231 #: build/C/man7/packet.7:236
12233 "B<SIOCGSTAMP> can be used to receive the timestamp of the last received "
12234 "packet. Argument is a I<struct timeval.>"
12237 #. type: Plain text
12238 #: build/C/man7/packet.7:242
12240 "In addition all standard ioctls defined in B<netdevice>(7) and B<socket>(7) "
12241 "are valid on packet sockets."
12245 #: build/C/man7/packet.7:242 build/C/man7/raw.7:131 build/C/man7/tcp.7:1115 build/C/man7/udp.7:103
12247 msgid "Error handling"
12250 #. type: Plain text
12251 #: build/C/man7/packet.7:246
12253 "Packet sockets do no error handling other than errors occurred while passing "
12254 "the packet to the device driver. They don't have the concept of a pending "
12258 #. type: Plain text
12259 #: build/C/man7/packet.7:250
12260 msgid "Unknown multicast group address passed."
12263 #. type: Plain text
12264 #: build/C/man7/packet.7:253
12265 msgid "User passed invalid memory address."
12268 #. type: Plain text
12269 #: build/C/man7/packet.7:256 build/C/man7/raw.7:155
12270 msgid "Invalid argument."
12273 #. type: Plain text
12274 #: build/C/man7/packet.7:259
12275 msgid "Packet is bigger than interface MTU."
12279 #: build/C/man7/packet.7:259
12281 msgid "B<ENETDOWN>"
12284 #. type: Plain text
12285 #: build/C/man7/packet.7:262
12286 msgid "Interface is not up."
12289 #. type: Plain text
12290 #: build/C/man7/packet.7:265
12291 msgid "Not enough memory to allocate the packet."
12294 #. type: Plain text
12295 #: build/C/man7/packet.7:268
12296 msgid "Unknown device name or interface index specified in interface address."
12299 #. type: Plain text
12300 #: build/C/man7/packet.7:271
12301 msgid "No packet received."
12304 #. type: Plain text
12305 #: build/C/man7/packet.7:274
12306 msgid "No interface address passed."
12310 #: build/C/man7/packet.7:274
12315 #. type: Plain text
12316 #: build/C/man7/packet.7:277
12317 msgid "Interface address contained an invalid interface index."
12320 #. type: Plain text
12321 #: build/C/man7/packet.7:280
12322 msgid "User has insufficient privileges to carry out this operation."
12325 #. type: Plain text
12326 #: build/C/man7/packet.7:282
12327 msgid "In addition other errors may be generated by the low-level driver."
12330 #. type: Plain text
12331 #: build/C/man7/packet.7:287
12333 "B<AF_PACKET> is a new feature in Linux 2.2. Earlier Linux versions "
12334 "supported only B<SOCK_PACKET>."
12337 #. type: Plain text
12338 #: build/C/man7/packet.7:292
12340 "The include file I<E<lt>netpacket/packet.hE<gt>> is present since glibc "
12341 "2.1. Older systems need:"
12344 #. type: Plain text
12345 #: build/C/man7/packet.7:298
12348 "#include E<lt>asm/types.hE<gt>\n"
12349 "#include E<lt>linux/if_packet.hE<gt>\n"
12350 "#include E<lt>linux/if_ether.hE<gt> /* The L2 protocols */\n"
12353 #. type: Plain text
12354 #: build/C/man7/packet.7:308
12356 "For portable programs it is suggested to use B<AF_PACKET> via B<pcap>(3); "
12357 "although this covers only a subset of the B<AF_PACKET> features."
12360 #. type: Plain text
12361 #: build/C/man7/packet.7:329
12363 "The B<SOCK_DGRAM> packet sockets make no attempt to create or parse the IEEE "
12364 "802.2 LLC header for a IEEE 802.3 frame. When B<ETH_P_802_3> is specified "
12365 "as protocol for sending the kernel creates the 802.3 frame and fills out the "
12366 "length field; the user has to supply the LLC header to get a fully "
12367 "conforming packet. Incoming 802.3 packets are not multiplexed on the "
12368 "DSAP/SSAP protocol fields; instead they are supplied to the user as protocol "
12369 "B<ETH_P_802_2> with the LLC header prepended. It is thus not possible to "
12370 "bind to B<ETH_P_802_3>; bind to B<ETH_P_802_2> instead and do the protocol "
12371 "multiplex yourself. The default for sending is the standard Ethernet DIX "
12372 "encapsulation with the protocol filled in."
12375 #. type: Plain text
12376 #: build/C/man7/packet.7:331
12377 msgid "Packet sockets are not subject to the input or output firewall chains."
12380 #. type: Plain text
12381 #: build/C/man7/packet.7:341
12383 "In Linux 2.0, the only way to get a packet socket was by calling "
12384 "B<socket(AF_INET, SOCK_PACKET, >I<protocol>B<)>. This is still supported "
12385 "but strongly deprecated. The main difference between the two methods is "
12386 "that B<SOCK_PACKET> uses the old I<struct sockaddr_pkt> to specify an "
12387 "interface, which doesn't provide physical layer independence."
12390 #. type: Plain text
12391 #: build/C/man7/packet.7:349
12394 "struct sockaddr_pkt {\n"
12395 " unsigned short spkt_family;\n"
12396 " unsigned char spkt_device[14];\n"
12397 " unsigned short spkt_protocol;\n"
12401 #. type: Plain text
12402 #: build/C/man7/packet.7:361
12404 "I<spkt_family> contains the device type, I<spkt_protocol> is the IEEE 802.3 "
12405 "protocol type as defined in I<E<lt>sys/if_ether.hE<gt>> and I<spkt_device> "
12406 "is the device name as a null-terminated string, for example, eth0."
12409 #. type: Plain text
12410 #: build/C/man7/packet.7:363
12411 msgid "This structure is obsolete and should not be used in new code."
12414 #. type: Plain text
12415 #: build/C/man7/packet.7:367
12417 "glibc 2.1 does not have a define for B<SOL_PACKET>. The suggested "
12418 "workaround is to use:"
12421 #. type: Plain text
12422 #: build/C/man7/packet.7:373
12425 "#ifndef SOL_PACKET\n"
12426 "#define SOL_PACKET 263\n"
12430 #. type: Plain text
12431 #: build/C/man7/packet.7:378
12433 "This is fixed in later glibc versions and also does not occur on libc5 "
12437 #. type: Plain text
12438 #: build/C/man7/packet.7:380
12439 msgid "The IEEE 802.2/803.3 LLC handling could be considered as a bug."
12442 #. type: Plain text
12443 #: build/C/man7/packet.7:382
12444 msgid "Socket filters are not documented."
12448 #. This man page was written by Andi Kleen with help from Matthew Wilcox.
12449 #. AF_PACKET in Linux 2.2 was implemented
12450 #. by Alexey Kuznetsov, based on code by Alan Cox and others.
12451 #. type: Plain text
12452 #: build/C/man7/packet.7:394
12454 "The B<MSG_TRUNC> B<recvmsg>(2) extension is an ugly hack and should be "
12455 "replaced by a control message. There is currently no way to get the "
12456 "original destination address of packets via B<SOCK_DGRAM>."
12459 #. type: Plain text
12460 #: build/C/man7/packet.7:401
12462 "B<socket>(2), B<pcap>(3), B<capabilities>(7), B<ip>(7), B<raw>(7), "
12466 #. type: Plain text
12467 #: build/C/man7/packet.7:404
12469 "RFC\\ 894 for the standard IP Ethernet encapsulation. RFC\\ 1700 for the "
12470 "IEEE 802.3 IP encapsulation."
12473 #. type: Plain text
12474 #: build/C/man7/packet.7:408
12475 msgid "The I<E<lt>linux/if_ether.hE<gt>> include file for physical layer protocols."
12479 #: build/C/man5/protocols.5:29
12485 #: build/C/man5/protocols.5:29 build/C/man7/x25.7:12
12490 #. type: Plain text
12491 #: build/C/man5/protocols.5:32
12492 msgid "protocols - protocols definition file"
12495 #. type: Plain text
12496 #: build/C/man5/protocols.5:40
12498 "This file is a plain ASCII file, describing the various DARPA internet "
12499 "protocols that are available from the TCP/IP subsystem. It should be "
12500 "consulted instead of using the numbers in the ARPA include files, or, even "
12501 "worse, just guessing them. These numbers will occur in the protocol field "
12502 "of any IP header."
12505 #. .. by the DDN Network Information Center.
12506 #. type: Plain text
12507 #: build/C/man5/protocols.5:46
12509 "Keep this file untouched since changes would result in incorrect IP "
12510 "packages. Protocol numbers and names are specified by the IANA (Internet "
12511 "Assigned Numbers Authority)."
12514 #. type: Plain text
12515 #: build/C/man5/protocols.5:48
12516 msgid "Each line is of the following format:"
12519 #. type: Plain text
12520 #: build/C/man5/protocols.5:51
12521 msgid "I<protocol number aliases ...>"
12524 #. type: Plain text
12525 #: build/C/man5/protocols.5:57
12527 "where the fields are delimited by spaces or tabs. Empty lines are ignored. "
12528 "If a line contains a hash mark (#), the hash mark and the part of the line "
12529 "following it are ignored."
12533 #: build/C/man5/protocols.5:59 build/C/man5/services.5:109
12535 msgid "I<protocol>"
12538 #. type: Plain text
12539 #: build/C/man5/protocols.5:67
12540 msgid "the native name for the protocol. For example I<ip>, I<tcp>, or I<udp>."
12543 #. type: Plain text
12544 #: build/C/man5/protocols.5:71
12546 "the official number for this protocol as it will appear within the IP "
12550 #. type: Plain text
12551 #: build/C/man5/protocols.5:74
12552 msgid "optional aliases for the protocol."
12555 #. The following is not true as at glibc 2.8 (a line with a comma is
12556 #. ignored by getservent()); it's not clear if/when it was ever true.
12557 #. As a backward compatibility feature, the slash (/) between the
12561 #. name can in fact be either a slash or a comma (,).
12562 #. Use of the comma in
12563 #. modern installations is deprecated.
12564 #. type: Plain text
12565 #: build/C/man5/protocols.5:77 build/C/man5/services.5:165
12567 "This file might be distributed over a network using a network-wide naming "
12568 "service like Yellow Pages/NIS or BIND/Hesiod."
12571 #. type: Plain text
12572 #: build/C/man5/protocols.5:81
12573 msgid "The protocols definition file."
12576 #. type: Plain text
12577 #: build/C/man5/protocols.5:83
12578 msgid "B<getprotoent>(3)"
12581 #. type: Plain text
12582 #: build/C/man5/protocols.5:86
12583 msgid "E<.UR http://www.iana.org\\:/assignments\\:/protocol-numbers> E<.UE>"
12587 #: build/C/man7/raw.7:13
12592 #. type: Plain text
12593 #: build/C/man7/raw.7:16
12594 msgid "raw - Linux IPv4 raw sockets"
12597 #. type: Plain text
12598 #: build/C/man7/raw.7:22
12599 msgid "B<raw_socket = socket(AF_INET, SOCK_RAW, int >I<protocol>B<);>"
12602 #. type: Plain text
12603 #: build/C/man7/raw.7:26
12605 "Raw sockets allow new IPv4 protocols to be implemented in user space. A raw "
12606 "socket receives or sends the raw datagram not including link level headers."
12609 #. type: Plain text
12610 #: build/C/man7/raw.7:32
12612 "The IPv4 layer generates an IP header when sending a packet unless the "
12613 "B<IP_HDRINCL> socket option is enabled on the socket. When it is enabled, "
12614 "the packet must contain an IP header. For receiving the IP header is always "
12615 "included in the packet."
12618 #. type: Plain text
12619 #: build/C/man7/raw.7:36
12621 "Only processes with an effective user ID of 0 or the B<CAP_NET_RAW> "
12622 "capability are allowed to open raw sockets."
12625 #. type: Plain text
12626 #: build/C/man7/raw.7:43
12628 "All packets or errors matching the I<protocol> number specified for the raw "
12629 "socket are passed to this socket. For a list of the allowed protocols see "
12630 "RFC\\ 1700 assigned numbers and B<getprotobyname>(3)."
12633 #. type: Plain text
12634 #: build/C/man7/raw.7:53
12636 "A protocol of B<IPPROTO_RAW> implies enabled B<IP_HDRINCL> and is able to "
12637 "send any IP protocol that is specified in the passed header. Receiving of "
12638 "all IP protocols via B<IPPROTO_RAW> is not possible using raw sockets."
12642 #: build/C/man7/raw.7:58
12644 msgid "IP Header fields modified on sending by B<IP_HDRINCL>\n"
12648 #: build/C/man7/raw.7:59
12650 msgid "IP Checksum:Always filled in.\n"
12654 #: build/C/man7/raw.7:60
12656 msgid "Source Address:Filled in when zero.\n"
12660 #: build/C/man7/raw.7:61
12662 msgid "Packet Id:Filled in when zero.\n"
12666 #: build/C/man7/raw.7:62
12668 msgid "Total Length:Always filled in.\n"
12671 #. type: Plain text
12672 #: build/C/man7/raw.7:76
12674 "If B<IP_HDRINCL> is specified and the IP header has a nonzero destination "
12675 "address then the destination address of the socket is used to route the "
12676 "packet. When B<MSG_DONTROUTE> is specified, the destination address should "
12677 "refer to a local interface, otherwise a routing table lookup is done anyway "
12678 "but gatewayed routes are ignored."
12681 #. type: Plain text
12682 #: build/C/man7/raw.7:84
12684 "If B<IP_HDRINCL> isn't set, then IP header options can be set on raw sockets "
12685 "with B<setsockopt>(2); see B<ip>(7) for more information."
12688 #. type: Plain text
12689 #: build/C/man7/raw.7:89
12691 "In Linux 2.2, all IP header fields and options can be set using IP socket "
12692 "options. This means raw sockets are usually needed only for new protocols "
12693 "or protocols with no user interface (like ICMP)."
12696 #. type: Plain text
12697 #: build/C/man7/raw.7:93
12699 "When a packet is received, it is passed to any raw sockets which have been "
12700 "bound to its protocol before it is passed to other protocol handlers (e.g., "
12701 "kernel protocol modules)."
12704 #. type: Plain text
12705 #: build/C/man7/raw.7:109
12707 "Raw sockets use the standard I<sockaddr_in> address structure defined in "
12708 "B<ip>(7). The I<sin_port> field could be used to specify the IP protocol "
12709 "number, but it is ignored for sending in Linux 2.2 and should be always set "
12710 "to 0 (see BUGS). For incoming packets, I<sin_port> is set to the protocol "
12711 "of the packet. See the I<E<lt>netinet/in.hE<gt>> include file for valid IP "
12715 #. Or SOL_RAW on Linux
12716 #. type: Plain text
12717 #: build/C/man7/raw.7:118
12719 "Raw socket options can be set with B<setsockopt>(2) and read with "
12720 "B<getsockopt>(2) by passing the B<IPPROTO_RAW> family flag."
12724 #: build/C/man7/raw.7:118
12726 msgid "B<ICMP_FILTER>"
12729 #. type: Plain text
12730 #: build/C/man7/raw.7:126
12732 "Enable a special filter for raw sockets bound to the B<IPPROTO_ICMP> "
12733 "protocol. The value has a bit set for each ICMP message type which should "
12734 "be filtered out. The default is to filter no ICMP messages."
12737 #. type: Plain text
12738 #: build/C/man7/raw.7:131
12740 "In addition, all B<ip>(7) B<IPPROTO_IP> socket options valid for datagram "
12741 "sockets are supported."
12744 #. type: Plain text
12745 #: build/C/man7/raw.7:144
12747 "Errors originating from the network are passed to the user only when the "
12748 "socket is connected or the B<IP_RECVERR> flag is enabled. For connected "
12749 "sockets, only B<EMSGSIZE> and B<EPROTO> are passed for compatibility. With "
12750 "B<IP_RECVERR>, all network errors are saved in the error queue."
12753 #. type: Plain text
12754 #: build/C/man7/raw.7:149
12756 "User tried to send to a broadcast address without having the broadcast flag "
12757 "set on the socket."
12760 #. type: Plain text
12761 #: build/C/man7/raw.7:152
12762 msgid "An invalid memory address was supplied."
12765 #. type: Plain text
12766 #: build/C/man7/raw.7:162
12768 "Packet too big. Either Path MTU Discovery is enabled (the "
12769 "B<IP_MTU_DISCOVER> socket flag) or the packet size exceeds the maximum "
12770 "allowed IPv4 packet size of 64KB."
12774 #: build/C/man7/raw.7:162 build/C/man7/unix.7:362
12776 msgid "B<EOPNOTSUPP>"
12779 #. type: Plain text
12780 #: build/C/man7/raw.7:166
12781 msgid "Invalid flag has been passed to a socket call (like B<MSG_OOB>)."
12784 #. type: Plain text
12785 #: build/C/man7/raw.7:172
12787 "The user doesn't have permission to open raw sockets. Only processes with "
12788 "an effective user ID of 0 or the B<CAP_NET_RAW> attribute may do that."
12792 #: build/C/man7/raw.7:172
12797 #. type: Plain text
12798 #: build/C/man7/raw.7:175
12799 msgid "An ICMP error has arrived reporting a parameter problem."
12802 #. type: Plain text
12803 #: build/C/man7/raw.7:181
12805 "B<IP_RECVERR> and B<ICMP_FILTER> are new in Linux 2.2. They are Linux "
12806 "extensions and should not be used in portable programs."
12809 #. type: Plain text
12810 #: build/C/man7/raw.7:187
12812 "Linux 2.0 enabled some bug-to-bug compatibility with BSD in the raw socket "
12813 "code when the B<SO_BSDCOMPAT> socket option was set \\(em since Linux 2.2, "
12814 "this option no longer has that effect."
12817 #. type: Plain text
12818 #: build/C/man7/raw.7:205
12820 "By default, raw sockets do path MTU (Maximum Transmission Unit) discovery. "
12821 "This means the kernel will keep track of the MTU to a specific target IP "
12822 "address and return B<EMSGSIZE> when a raw packet write exceeds it. When "
12823 "this happens, the application should decrease the packet size. Path MTU "
12824 "discovery can be also turned off using the B<IP_MTU_DISCOVER> socket option "
12825 "or the I</proc/sys/net/ipv4/ip_no_pmtu_disc> file, see B<ip>(7) for "
12826 "details. When turned off, raw sockets will fragment outgoing packets that "
12827 "exceed the interface MTU. However, disabling it is not recommended for "
12828 "performance and reliability reasons."
12831 #. type: Plain text
12832 #: build/C/man7/raw.7:214
12834 "A raw socket can be bound to a specific local address using the B<bind>(2) "
12835 "call. If it isn't bound, all packets with the specified IP protocol are "
12836 "received. In addition, a RAW socket can be bound to a specific network "
12837 "device using B<SO_BINDTODEVICE>; see B<socket>(7)."
12840 #. type: Plain text
12841 #: build/C/man7/raw.7:225
12843 "An B<IPPROTO_RAW> socket is send only. If you really want to receive all IP "
12844 "packets, use a B<packet>(7) socket with the B<ETH_P_IP> protocol. Note "
12845 "that packet sockets don't reassemble IP fragments, unlike raw sockets."
12848 #. type: Plain text
12849 #: build/C/man7/raw.7:231
12851 "If you want to receive all ICMP packets for a datagram socket, it is often "
12852 "better to use B<IP_RECVERR> on that particular socket; see B<ip>(7)."
12855 #. type: Plain text
12856 #: build/C/man7/raw.7:238
12858 "Raw sockets may tap all IP protocols in Linux, even protocols like ICMP or "
12859 "TCP which have a protocol module in the kernel. In this case, the packets "
12860 "are passed to both the kernel module and the raw socket(s). This should not "
12861 "be relied upon in portable programs, many other BSD socket implementation "
12862 "have limitations here."
12865 #. type: Plain text
12866 #: build/C/man7/raw.7:243
12868 "Linux never changes headers passed from the user (except for filling in some "
12869 "zeroed fields as described for B<IP_HDRINCL>). This differs from many other "
12870 "implementations of raw sockets."
12873 #. type: Plain text
12874 #: build/C/man7/raw.7:246
12876 "RAW sockets are generally rather unportable and should be avoided in "
12877 "programs intended to be portable."
12880 #. type: Plain text
12881 #: build/C/man7/raw.7:252
12883 "Sending on raw sockets should take the IP protocol from I<sin_port>; this "
12884 "ability was lost in Linux 2.2. The workaround is to use B<IP_HDRINCL>."
12887 #. type: Plain text
12888 #: build/C/man7/raw.7:254
12889 msgid "Transparent proxy extensions are not described."
12892 #. type: Plain text
12893 #: build/C/man7/raw.7:259
12895 "When the B<IP_HDRINCL> option is set, datagrams will not be fragmented and "
12896 "are limited to the interface MTU."
12900 #. This man page was written by Andi Kleen.
12901 #. type: Plain text
12902 #: build/C/man7/raw.7:269
12904 "Setting the IP protocol for sending in I<sin_port> got lost in Linux 2.2. "
12905 "The protocol that the socket was bound to or that was specified in the "
12906 "initial B<socket>(2) call is always used."
12909 #. type: Plain text
12910 #: build/C/man7/raw.7:275
12911 msgid "B<recvmsg>(2), B<sendmsg>(2), B<capabilities>(7), B<ip>(7), B<socket>(7)"
12914 #. type: Plain text
12915 #: build/C/man7/raw.7:282
12917 "B<RFC\\ 1191> for path MTU discovery. B<RFC\\ 791> and the "
12918 "I<E<lt>linux/ip.hE<gt>> header file for the IP protocol."
12922 #: build/C/man3/rcmd.3:43
12928 #: build/C/man3/rcmd.3:43
12933 #. type: Plain text
12934 #: build/C/man3/rcmd.3:48
12936 "rcmd, rresvport, iruserok, ruserok, rcmd_af, rresvport_af, iruserok_af, "
12937 "ruserok_af - routines for returning a stream to a remote command"
12940 #. type: Plain text
12941 #: build/C/man3/rcmd.3:51
12944 "B<#include E<lt>netdb.hE<gt> \\ \\ >/* Or E<lt>unistd.hE<gt> on some systems "
12948 #. type: Plain text
12949 #: build/C/man3/rcmd.3:54
12952 "B<int rcmd(char **>I<ahost>B<, int >I<inport>B<, const char *>I<locuser>B<, "
12954 "B< const char *>I<remuser>B<, const char *>I<cmd>B<, int "
12958 #. type: Plain text
12959 #: build/C/man3/rcmd.3:56
12961 msgid "B<int rresvport(int *>I<port>B<);>\n"
12964 #. type: Plain text
12965 #: build/C/man3/rcmd.3:59
12968 "B<int iruserok(uint32_t >I<raddr>B<, int >I<superuser>B<, >\n"
12969 "B< const char *>I<ruser>B<, const char *>I<luser>B<);>\n"
12972 #. type: Plain text
12973 #: build/C/man3/rcmd.3:62
12976 "B<int ruserok(const char *>I<rhost>B<, int >I<superuser>B<, >\n"
12977 "B< const char *>I<ruser>B<, const char *>I<luser>B<);>\n"
12980 #. type: Plain text
12981 #: build/C/man3/rcmd.3:66
12984 "B<int rcmd_af(char **>I<ahost>B<, int >I<inport>B<, const char "
12985 "*>I<locuser>B<, >\n"
12986 "B< const char *>I<remuser>B<, const char *>I<cmd>B<, int "
12988 "B< sa_family_t >I<af>B<);>\n"
12991 #. type: Plain text
12992 #: build/C/man3/rcmd.3:68
12994 msgid "B<int rresvport_af(int *>I<port>B<, sa_family_t >I<af>B<);>\n"
12997 #. type: Plain text
12998 #: build/C/man3/rcmd.3:72
13001 "B<int iruserok_af(uint32_t >I<raddr>B<, int >I<superuser>B<, >\n"
13002 "B< const char *>I<ruser>B<, const char *>I<luser>B<, "
13003 "sa_family_t >I<af>B<);>\n"
13006 #. type: Plain text
13007 #: build/C/man3/rcmd.3:76
13010 "B<int ruserok_af(const char *>I<rhost>B<, int >I<superuser>B<, >\n"
13011 "B< const char *>I<ruser>B<, const char *>I<luser>B<, "
13012 "sa_family_t >I<af>B<);>\n"
13015 #. type: Plain text
13016 #: build/C/man3/rcmd.3:92
13018 "B<rcmd>(), B<rcmd_af>(), B<rresvport>(), B<rresvport_af>(), B<iruserok>(), "
13019 "B<iruserok_af>(), B<ruserok>(), B<ruserok_af>(): _BSD_SOURCE"
13022 #. type: Plain text
13023 #: build/C/man3/rcmd.3:113
13025 "The B<rcmd>() function is used by the superuser to execute a command on a "
13026 "remote machine using an authentication scheme based on privileged port "
13027 "numbers. The B<rresvport>() function returns a descriptor to a socket with "
13028 "an address in the privileged port space. The B<iruserok>() and "
13029 "B<ruserok>() functions are used by servers to authenticate clients "
13030 "requesting service with B<rcmd>(). All four functions are used by the "
13031 "B<rshd>(8) server (among others)."
13035 #: build/C/man3/rcmd.3:113
13040 #. type: Plain text
13041 #: build/C/man3/rcmd.3:129
13043 "The B<rcmd>() function looks up the host I<*ahost> using "
13044 "B<gethostbyname>(3), returning -1 if the host does not exist. Otherwise "
13045 "I<*ahost> is set to the standard name of the host and a connection is "
13046 "established to a server residing at the well-known Internet port I<inport>."
13049 #. type: Plain text
13050 #: build/C/man3/rcmd.3:158
13052 "If the connection succeeds, a socket in the Internet domain of type "
13053 "B<SOCK_STREAM> is returned to the caller, and given to the remote command as "
13054 "I<stdin> and I<stdout>. If I<fd2p> is nonzero, then an auxiliary channel to "
13055 "a control process will be set up, and a descriptor for it will be placed in "
13056 "I<*fd2p>. The control process will return diagnostic output from the "
13057 "command (unit 2) on this channel, and will also accept bytes on this channel "
13058 "as being UNIX signal numbers, to be forwarded to the process group of the "
13059 "command. If I<fd2p> is 0, then the I<stderr> (unit 2 of the remote command) "
13060 "will be made the same as the I<stdout> and no provision is made for sending "
13061 "arbitrary signals to the remote process, although you may be able to get its "
13062 "attention by using out-of-band data."
13065 #. type: Plain text
13066 #: build/C/man3/rcmd.3:161
13067 msgid "The protocol is described in detail in B<rshd>(8)."
13071 #: build/C/man3/rcmd.3:161
13073 msgid "rresvport()"
13076 #. type: Plain text
13077 #: build/C/man3/rcmd.3:183
13079 "The B<rresvport>() function is used to obtain a socket with a privileged "
13080 "port bound to it. This socket is suitable for use by B<rcmd>() and several "
13081 "other functions. Privileged ports are those in the range 0 to 1023. Only a "
13082 "privileged process (B<CAP_NET_BIND_SERVICE>) is allowed to bind to a "
13083 "privileged port. In the glibc implementation, this function restricts its "
13084 "search to the ports from 512 to 1023. The I<port> argument is value-result: "
13085 "the value it supplies to the call is used as the starting point for a "
13086 "circular search of the port range; on (successful) return, it contains the "
13087 "port number that was bound to."
13091 #: build/C/man3/rcmd.3:183
13093 msgid "iruserok() and ruserok()"
13096 #. type: Plain text
13097 #: build/C/man3/rcmd.3:201
13099 "The B<iruserok>() and B<ruserok>() functions take a remote host's IP "
13100 "address or name, respectively, two usernames and a flag indicating whether "
13101 "the local user's name is that of the superuser. Then, if the user is I<not> "
13102 "the superuser, it checks the I</etc/hosts.equiv> file. If that lookup is "
13103 "not done, or is unsuccessful, the I<.rhosts> in the local user's home "
13104 "directory is checked to see if the request for service is allowed."
13107 #. type: Plain text
13108 #: build/C/man3/rcmd.3:217
13110 "If this file does not exist, is not a regular file, is owned by anyone other "
13111 "than the user or the superuser, or is writable by anyone other than the "
13112 "owner, the check automatically fails. Zero is returned if the machine name "
13113 "is listed in the I<hosts.equiv> file, or the host and remote username are "
13114 "found in the I<.rhosts> file; otherwise B<iruserok>() and B<ruserok>() "
13115 "return -1. If the local domain (as obtained from B<gethostname>(2)) is the "
13116 "same as the remote domain, only the machine name need be specified."
13119 #. type: Plain text
13120 #: build/C/man3/rcmd.3:223
13122 "If the IP address of the remote host is known, B<iruserok>() should be used "
13123 "in preference to B<ruserok>(), as it does not require trusting the DNS "
13124 "server for the remote host's domain."
13128 #: build/C/man3/rcmd.3:223
13130 msgid "*_af() variants"
13133 #. type: Plain text
13134 #: build/C/man3/rcmd.3:239
13136 "All of the functions described above work with IPv4 (B<AF_INET>) sockets. "
13137 "The \"_af\" variants take an extra argument that allows the socket address "
13138 "family to be specified. For these functions, the I<af> argument can be "
13139 "specified as B<AF_INET> or B<AF_INET6>. In addition, B<rcmd_af>() supports "
13140 "the use of B<AF_UNSPEC>."
13143 #. type: Plain text
13144 #: build/C/man3/rcmd.3:245
13146 "The B<rcmd>() function returns a valid socket descriptor on success. It "
13147 "returns -1 on error and prints a diagnostic message on the standard error."
13150 #. type: Plain text
13151 #: build/C/man3/rcmd.3:256
13153 "The B<rresvport>() function returns a valid, bound socket descriptor on "
13154 "success. It returns -1 on error with the global value I<errno> set "
13155 "according to the reason for failure. The error code B<EAGAIN> is overloaded "
13156 "to mean \"All network ports in use.\""
13159 #. type: Plain text
13160 #: build/C/man3/rcmd.3:262
13162 "For information on the return from B<ruserok>() and B<iruserok>(), see "
13166 #. type: Plain text
13167 #: build/C/man3/rcmd.3:270
13169 "The functions B<iruserok_af>(), B<rcmd_af>(), B<rresvport_af>(), and "
13170 "B<ruserok_af>() functions are provide in glibc since version 2.2."
13173 #. type: Plain text
13174 #: build/C/man3/rcmd.3:278
13176 "Not in POSIX.1-2001. Present on the BSDs, Solaris, and many other systems. "
13177 "These functions appeared in 4.2BSD. The \"_af\" variants are more recent "
13178 "additions, and are not present on as wide a range of systems."
13181 #. Bug filed 25 Nov 2007:
13182 #. http://sources.redhat.com/bugzilla/show_bug.cgi?id=5399
13183 #. type: Plain text
13184 #: build/C/man3/rcmd.3:285
13186 "B<iruserok>() and B<iruserok_af>() are declared in glibc headers only "
13187 "since version 2.12."
13190 #. type: Plain text
13191 #: build/C/man3/rcmd.3:293
13193 "B<rlogin>(1), B<rsh>(1), B<intro>(2), B<rexec>(3), B<rexecd>(8), "
13194 "B<rlogind>(8), B<rshd>(8)"
13198 #: build/C/man5/resolv.conf.5:23
13200 msgid "RESOLV.CONF"
13204 #: build/C/man5/resolv.conf.5:23 build/C/man7/udp.7:12
13209 #. type: Plain text
13210 #: build/C/man5/resolv.conf.5:27
13211 msgid "resolv.conf - resolver configuration file"
13214 #. type: Plain text
13215 #: build/C/man5/resolv.conf.5:29
13216 msgid "B</etc/resolv.conf>"
13219 #. type: Plain text
13220 #: build/C/man5/resolv.conf.5:38
13222 "The I<resolver> is a set of routines in the C library that provide access to "
13223 "the Internet Domain Name System (DNS). The resolver configuration file "
13224 "contains information that is read by the resolver routines the first time "
13225 "they are invoked by a process. The file is designed to be human readable "
13226 "and contains a list of keywords with values that provide various types of "
13227 "resolver information."
13230 #. type: Plain text
13231 #: build/C/man5/resolv.conf.5:43
13233 "If this file does not exist, only the name server on the local machine will "
13234 "be queried; the domain name is determined from the hostname and the domain "
13235 "search path is constructed from the domain name."
13238 #. type: Plain text
13239 #: build/C/man5/resolv.conf.5:45
13240 msgid "The different configuration options are:"
13244 #: build/C/man5/resolv.conf.5:45
13246 msgid "B<nameserver> Name server IP address"
13249 #. type: Plain text
13250 #: build/C/man5/resolv.conf.5:62
13252 "Internet address of a name server that the resolver should query, either an "
13253 "IPv4 address (in dot notation), or an IPv6 address in colon (and possibly "
13254 "dot) notation as per RFC 2373. Up to B<MAXNS> (currently 3, see "
13255 "I<E<lt>resolv.hE<gt>>) name servers may be listed, one per keyword. If "
13256 "there are multiple servers, the resolver library queries them in the order "
13257 "listed. If no B<nameserver> entries are present, the default is to use the "
13258 "name server on the local machine. (The algorithm used is to try a name "
13259 "server, and if the query times out, try the next, until out of name servers, "
13260 "then repeat trying all the name servers until a maximum number of retries "
13265 #: build/C/man5/resolv.conf.5:62
13267 msgid "B<domain> Local domain name."
13270 #. type: Plain text
13271 #: build/C/man5/resolv.conf.5:73
13273 "Most queries for names within this domain can use short names relative to "
13274 "the local domain. If set to \\(aq.\\(aq, the root domain is considered. If "
13275 "no B<domain> entry is present, the domain is determined from the local "
13276 "hostname returned by B<gethostname>(2); the domain part is taken to be "
13277 "everything after the first \\(aq.\\(aq. Finally, if the hostname does not "
13278 "contain a domain part, the root domain is assumed."
13282 #: build/C/man5/resolv.conf.5:73
13284 msgid "B<search> Search list for host-name lookup."
13287 #. When having a resolv.conv with a line
13288 #. search subdomain.domain.tld domain.tld
13289 #. and doing a hostlookup, for example by
13290 #. ping host.anothersubdomain
13291 #. it sends dns-requests for
13292 #. host.anothersubdomain.
13293 #. host.anothersubdomain.subdomain.domain.tld.
13294 #. host.anothersubdomain.domain.tld.
13295 #. thus not only causing unnecessary traffic for the root-dns-servers
13296 #. but broadcasting information to the outside and making man-in-the-middle
13297 #. attacks possible.
13298 #. type: Plain text
13299 #: build/C/man5/resolv.conf.5:103
13301 "The search list is normally determined from the local domain name; by "
13302 "default, it contains only the local domain name. This may be changed by "
13303 "listing the desired domain search path following the I<search> keyword with "
13304 "spaces or tabs separating the names. Resolver queries having fewer than "
13305 "I<ndots> dots (default is 1) in them will be attempted using each component "
13306 "of the search path in turn until a match is found. For environments with "
13307 "multiple subdomains please read B<options ndots:>I<n> below to avoid "
13308 "man-in-the-middle attacks and unnecessary traffic for the root-dns-servers. "
13309 "Note that this process may be slow and will generate a lot of network "
13310 "traffic if the servers for the listed domains are not local, and that "
13311 "queries will time out if no server is available for one of the domains."
13314 #. type: Plain text
13315 #: build/C/man5/resolv.conf.5:106
13317 "The search list is currently limited to six domains with a total of 256 "
13322 #: build/C/man5/resolv.conf.5:106
13324 msgid "B<sortlist>"
13327 #. type: Plain text
13328 #: build/C/man5/resolv.conf.5:119
13330 "This option allows addresses returned by B<gethostbyname>(3) to be sorted. "
13331 "A sortlist is specified by IP-address-netmask pairs. The netmask is "
13332 "optional and defaults to the natural netmask of the net. The IP address and "
13333 "optional network pairs are separated by slashes. Up to 10 pairs may be "
13334 "specified. Here is an example:"
13337 #. type: Plain text
13338 #: build/C/man5/resolv.conf.5:122
13339 msgid "sortlist 130.155.160.0/255.255.240.0 130.155.0.0"
13343 #: build/C/man5/resolv.conf.5:124
13348 #. type: Plain text
13349 #: build/C/man5/resolv.conf.5:128
13351 "Options allows certain internal resolver variables to be modified. The "
13355 #. type: Plain text
13356 #: build/C/man5/resolv.conf.5:131
13357 msgid "B<options> I<option> I<...>"
13360 #. type: Plain text
13361 #: build/C/man5/resolv.conf.5:133
13362 msgid "where I<option> is one of the following:"
13366 #: build/C/man5/resolv.conf.5:133
13371 #. Since glibc 2.2?
13372 #. type: Plain text
13373 #: build/C/man5/resolv.conf.5:142
13375 "sets B<RES_DEBUG> in I<_res.options> (effective only if glibc was built with "
13376 "debug support; see B<resolver>(3))."
13380 #: build/C/man5/resolv.conf.5:142
13382 msgid "B<ndots:>I<n>"
13386 #. type: Plain text
13387 #: build/C/man5/resolv.conf.5:156
13389 "sets a threshold for the number of dots which must appear in a name given to "
13390 "B<res_query>(3) (see B<resolver>(3)) before an I<initial absolute query> "
13391 "will be made. The default for I<n> is 1, meaning that if there are any dots "
13392 "in a name, the name will be tried first as an absolute name before any "
13393 "I<search list> elements are appended to it. The value for this option is "
13394 "silently capped to 15."
13398 #: build/C/man5/resolv.conf.5:156
13400 msgid "B<timeout:>I<n>"
13404 #. type: Plain text
13405 #: build/C/man5/resolv.conf.5:167
13407 "sets the amount of time the resolver will wait for a response from a remote "
13408 "name server before retrying the query via a different name server. Measured "
13409 "in seconds, the default is B<RES_TIMEOUT> (currently 5, see "
13410 "I<E<lt>resolv.hE<gt>>). The value for this option is silently capped to 30."
13414 #: build/C/man5/resolv.conf.5:167
13416 msgid "B<attempts:>I<n>"
13419 #. type: Plain text
13420 #: build/C/man5/resolv.conf.5:176
13422 "sets the number of times the resolver will send a query to its name servers "
13423 "before giving up and returning an error to the calling application. The "
13424 "default is B<RES_DFLRETRY> (currently 2, see I<E<lt>resolv.hE<gt>>). The "
13425 "value for this option is silently capped to 5."
13429 #: build/C/man5/resolv.conf.5:176
13435 #. type: Plain text
13436 #: build/C/man5/resolv.conf.5:186
13438 "sets B<RES_ROTATE> in I<_res.options>, which causes round-robin selection of "
13439 "nameservers from among those listed. This has the effect of spreading the "
13440 "query load among all listed servers, rather than having all clients try the "
13441 "first listed server first every time."
13445 #: build/C/man5/resolv.conf.5:186
13447 msgid "B<no-check-names>"
13451 #. type: Plain text
13452 #: build/C/man5/resolv.conf.5:196
13454 "sets B<RES_NOCHECKNAME> in I<_res.options>, which disables the modern BIND "
13455 "checking of incoming hostnames and mail names for invalid characters such as "
13456 "underscore (_), non-ASCII, or control characters."
13460 #: build/C/man5/resolv.conf.5:196
13466 #. type: Plain text
13467 #: build/C/man5/resolv.conf.5:207
13469 "sets B<RES_USE_INET6> in I<_res.options>. This has the effect of trying a "
13470 "AAAA query before an A query inside the B<gethostbyname>(3) function, and "
13471 "of mapping IPv4 responses in IPv6 \"tunneled form\" if no AAAA records are "
13472 "found but an A record set exists."
13476 #: build/C/man5/resolv.conf.5:207
13478 msgid "B<ip6-bytestring> (since glibc 2.3.4)"
13481 #. type: Plain text
13482 #: build/C/man5/resolv.conf.5:216
13484 "sets B<RES_USE_BSTRING> in I<_res.options>. This causes reverse IPv6 "
13485 "lookups to be made using the bit-label format described in RFC\\ 2673; if "
13486 "this option is not set, then nibble format is used."
13490 #: build/C/man5/resolv.conf.5:216
13492 msgid "B<ip6-dotint>/B<no-ip6-dotint> (since glibc 2.3.4)"
13495 #. type: Plain text
13496 #: build/C/man5/resolv.conf.5:233
13498 "Clear/set B<RES_NOIP6DOTINT> in I<_res.options>. When this option is clear "
13499 "(B<ip6-dotint>), reverse IPv6 lookups are made in the (deprecated) "
13500 "I<ip6.int> zone; when this option is set (B<no-ip6-dotint>), reverse IPv6 "
13501 "lookups are made in the I<ip6.arpa> zone by default. This option is set by "
13506 #: build/C/man5/resolv.conf.5:233
13508 msgid "B<edns0> (since glibc 2.6)"
13511 #. type: Plain text
13512 #: build/C/man5/resolv.conf.5:240
13514 "sets B<RES_USE_EDNSO> in I<_res.options>. This enables support for the DNS "
13515 "extensions described in RFC\\ 2671."
13519 #: build/C/man5/resolv.conf.5:240
13521 msgid "B<single-request> (since glibc 2.10)"
13524 #. type: Plain text
13525 #: build/C/man5/resolv.conf.5:253
13527 "sets B<RES_SNGLKUP> in I<_res.options>. By default, glibc performs IPv4 and "
13528 "IPv6 lookups in parallel since version 2.9. Some appliance DNS servers "
13529 "cannot handle these queries properly and make the requests time out. This "
13530 "option disables the behavior and makes glibc perform the IPv6 and IPv4 "
13531 "requests sequentially (at the cost of some slowdown of the resolving "
13536 #: build/C/man5/resolv.conf.5:253
13538 msgid "B<single-request-reopen> (since glibc 2.9)"
13541 #. type: Plain text
13542 #: build/C/man5/resolv.conf.5:261
13544 "The resolver uses the same socket for the A and AAAA requests. Some "
13545 "hardware mistakenly sends back only one reply. When that happens the client "
13546 "system will sit and wait for the second reply. Turning this option on "
13547 "changes this behavior so that if two requests from the same port are not "
13548 "handled correctly it will close the socket and open a new one before sending "
13549 "the second request."
13552 #. type: Plain text
13553 #: build/C/man5/resolv.conf.5:266
13555 "The I<domain> and I<search> keywords are mutually exclusive. If more than "
13556 "one instance of these keywords is present, the last instance wins."
13559 #. type: Plain text
13560 #: build/C/man5/resolv.conf.5:271
13562 "The I<search> keyword of a system's I<resolv.conf> file can be overridden on "
13563 "a per-process basis by setting the environment variable B<LOCALDOMAIN> to a "
13564 "space-separated list of search domains."
13567 #. type: Plain text
13568 #: build/C/man5/resolv.conf.5:277
13570 "The I<options> keyword of a system's I<resolv.conf> file can be amended on a "
13571 "per-process basis by setting the environment variable B<RES_OPTIONS> to a "
13572 "space-separated list of resolver options as explained above under "
13576 #. type: Plain text
13577 #: build/C/man5/resolv.conf.5:281
13579 "The keyword and value must appear on a single line, and the keyword (e.g., "
13580 "B<nameserver>) must start the line. The value follows the keyword, "
13581 "separated by white space."
13584 #. type: Plain text
13585 #: build/C/man5/resolv.conf.5:284
13587 "Lines that contain a semicolon (;) or hash character (#) in the first "
13588 "column are treated as comments."
13591 #. type: Plain text
13592 #: build/C/man5/resolv.conf.5:287
13593 msgid "I</etc/resolv.conf>, I<E<lt>resolv.hE<gt>>"
13596 #. type: Plain text
13597 #: build/C/man5/resolv.conf.5:292
13598 msgid "B<gethostbyname>(3), B<resolver>(3), B<hostname>(7), B<named>(8)"
13601 #. type: Plain text
13602 #: build/C/man5/resolv.conf.5:294
13603 msgid "Name Server Operations Guide for BIND"
13607 #: build/C/man3/resolver.3:32
13613 #: build/C/man3/resolver.3:32
13618 #. type: Plain text
13619 #: build/C/man3/resolver.3:36
13621 "res_init, res_query, res_search, res_querydomain, res_mkquery, res_send, "
13622 "dn_comp, dn_expand - resolver routines"
13625 #. type: Plain text
13626 #: build/C/man3/resolver.3:42
13629 "B<#include E<lt>netinet/in.hE<gt>>\n"
13630 "B<#include E<lt>arpa/nameser.hE<gt>>\n"
13631 "B<#include E<lt>resolv.hE<gt>>\n"
13632 "B<extern struct state _res;>\n"
13635 #. type: Plain text
13636 #: build/C/man3/resolver.3:44
13638 msgid "B<int res_init(void);>\n"
13641 #. type: Plain text
13642 #: build/C/man3/resolver.3:46
13644 msgid "B<int res_query(const char *>I<dname>B<, int >I<class>B<, int >I<type>B<,>\n"
13647 #. type: Plain text
13648 #: build/C/man3/resolver.3:48 build/C/man3/resolver.3:53
13650 msgid "B<unsigned char *>I<answer>B<, int >I<anslen>B<);>\n"
13653 #. type: Plain text
13654 #: build/C/man3/resolver.3:51
13657 "B<int res_search(const char *>I<dname>B<, int >I<class>B<, int "
13661 #. type: Plain text
13662 #: build/C/man3/resolver.3:56
13664 msgid "B<int res_querydomain(const char *>I<name>B<, const char *>I<domain>B<,>\n"
13667 #. type: Plain text
13668 #: build/C/man3/resolver.3:59
13671 "B<int >I<class>B<, int >I<type>B<, unsigned char *>I<answer>B<,>\n"
13672 "B<int >I<anslen>B<);>\n"
13675 #. type: Plain text
13676 #: build/C/man3/resolver.3:62
13678 msgid "B<int res_mkquery(int >I<op>B<, const char *>I<dname>B<, int >I<class>B<,>\n"
13681 #. type: Plain text
13682 #: build/C/man3/resolver.3:65
13685 "B<int >I<type>B<, char *>I<data>B<, int >I<datalen>B<, struct rrec "
13687 "B<char *>I<buf>B<, int >I<buflen>B<);>\n"
13690 #. type: Plain text
13691 #: build/C/man3/resolver.3:68
13694 "B<int res_send(const char *>I<msg>B<, int >I<msglen>B<, char "
13695 "*>I<answer>B<,>\n"
13698 #. type: Plain text
13699 #: build/C/man3/resolver.3:70
13701 msgid "B<int >I<anslen>B<);>\n"
13704 #. type: Plain text
13705 #: build/C/man3/resolver.3:73
13707 msgid "B<int dn_comp(unsigned char *>I<exp_dn>B<, unsigned char *>I<comp_dn>B<,>\n"
13710 #. type: Plain text
13711 #: build/C/man3/resolver.3:75
13714 "B<int >I<length>B<, unsigned char **>I<dnptrs>B<, unsigned char "
13715 "**>I<lastdnptr>B<);>\n"
13718 #. type: Plain text
13719 #: build/C/man3/resolver.3:78
13721 msgid "B<int dn_expand(unsigned char *>I<msg>B<, unsigned char *>I<eomorig>B<,>\n"
13724 #. type: Plain text
13725 #: build/C/man3/resolver.3:81
13728 "B<unsigned char *>I<comp_dn>B<, char *>I<exp_dn>B<,>\n"
13729 "B<int >I<length>B<);>\n"
13732 #. type: Plain text
13733 #: build/C/man3/resolver.3:85
13734 msgid "Link with I<-lresolv>."
13737 #. type: Plain text
13738 #: build/C/man3/resolver.3:88
13740 "These functions make queries to and interpret the responses from Internet "
13741 "domain name servers."
13744 #. type: Plain text
13745 #: build/C/man3/resolver.3:102
13747 "The B<res_init>() function reads the configuration files (see "
13748 "B<resolv.conf>(5)) to get the default domain name, search order and name "
13749 "server address(es). If no server is given, the local host is tried. If no "
13750 "domain is given, that associated with the local host is used. It can be "
13751 "overridden with the environment variable B<LOCALDOMAIN>. B<res_init>() is "
13752 "normally executed by the first call to one of the other functions."
13755 #. type: Plain text
13756 #: build/C/man3/resolver.3:110
13758 "The B<res_query>() function queries the name server for the fully qualified "
13759 "domain name I<name> of specified I<type> and I<class>. The reply is left in "
13760 "the buffer I<answer> of length I<anslen> supplied by the caller."
13763 #. type: Plain text
13764 #: build/C/man3/resolver.3:123
13766 "The B<res_search>() function makes a query and waits for the response like "
13767 "B<res_query>(), but in addition implements the default and search rules "
13768 "controlled by B<RES_DEFNAMES> and B<RES_DNSRCH> (see description of I<_res> "
13772 #. type: Plain text
13773 #: build/C/man3/resolver.3:129
13775 "The B<res_querydomain>() function makes a query using B<res_query>() on "
13776 "the concatenation of I<name> and I<domain>."
13779 #. type: Plain text
13780 #: build/C/man3/resolver.3:132
13781 msgid "The following functions are lower-level routines used by B<res_query>()."
13784 #. type: Plain text
13785 #: build/C/man3/resolver.3:143
13787 "The B<res_mkquery>() function constructs a query message in I<buf> of "
13788 "length I<buflen> for the domain name I<dname>. The query type I<op> is "
13789 "usually B<QUERY>, but can be any of the types defined in "
13790 "I<E<lt>arpa/nameser.hE<gt>>. I<newrr> is currently unused."
13793 #. type: Plain text
13794 #: build/C/man3/resolver.3:153
13796 "The B<res_send>() function sends a preformatted query given in I<msg> of "
13797 "length I<msglen> and returns the answer in I<answer> which is of length "
13798 "I<anslen>. It will call B<res_init>(), if it has not already been called."
13801 #. type: Plain text
13802 #: build/C/man3/resolver.3:166
13804 "The B<dn_comp>() function compresses the domain name I<exp_dn> and stores "
13805 "it in the buffer I<comp_dn> of length I<length>. The compression uses an "
13806 "array of pointers I<dnptrs> to previously compressed names in the current "
13807 "message. The first pointer points to the beginning of the message and the "
13808 "list ends with NULL. The limit of the array is specified by I<lastdnptr>. "
13809 "If I<dnptr> is NULL, domain names are not compressed. If I<lastdnptr> is "
13810 "NULL, the list of labels is not updated."
13813 #. type: Plain text
13814 #: build/C/man3/resolver.3:175
13816 "The B<dn_expand>() function expands the compressed domain name I<comp_dn> "
13817 "to a full domain name, which is placed in the buffer I<exp_dn> of size "
13818 "I<length>. The compressed name is contained in a query or reply message, "
13819 "and I<msg> points to the beginning of the message."
13822 #. type: Plain text
13823 #: build/C/man3/resolver.3:183
13825 "The resolver routines use global configuration and state information "
13826 "contained in the structure I<_res>, which is defined in "
13827 "I<E<lt>resolv.hE<gt>>. The only field that is normally manipulated by the "
13828 "user is I<_res.options>. This field can contain the bitwise \"OR\" of the "
13829 "following options:"
13833 #: build/C/man3/resolver.3:183
13835 msgid "B<RES_INIT>"
13838 #. type: Plain text
13839 #: build/C/man3/resolver.3:188
13840 msgid "True if B<res_init>() has been called."
13844 #: build/C/man3/resolver.3:188
13846 msgid "B<RES_DEBUG>"
13849 #. See resolv/README.
13850 #. Support for RES_DEBUG was made conditional in glibc 2.2.
13851 #. type: Plain text
13852 #: build/C/man3/resolver.3:195
13854 "Print debugging messages. This option is available only if glibc was built "
13855 "with debugging enabled, which is not the default."
13859 #: build/C/man3/resolver.3:195
13861 msgid "B<RES_AAONLY>"
13864 #. type: Plain text
13865 #: build/C/man3/resolver.3:202
13867 "Accept authoritative answers only. B<res_send>() continues until it finds "
13868 "an authoritative answer or returns an error. [Not currently implemented]."
13872 #: build/C/man3/resolver.3:202
13874 msgid "B<RES_USEVC>"
13877 #. type: Plain text
13878 #: build/C/man3/resolver.3:205
13879 msgid "Use TCP connections for queries rather than UDP datagrams."
13883 #: build/C/man3/resolver.3:205
13885 msgid "B<RES_PRIMARY>"
13888 #. type: Plain text
13889 #: build/C/man3/resolver.3:208
13890 msgid "Query primary domain name server only."
13894 #: build/C/man3/resolver.3:208
13896 msgid "B<RES_IGNTC>"
13899 #. type: Plain text
13900 #: build/C/man3/resolver.3:213
13902 "Ignore truncation errors. Don't retry with TCP. [Not currently "
13907 #: build/C/man3/resolver.3:213
13909 msgid "B<RES_RECURSE>"
13912 #. type: Plain text
13913 #: build/C/man3/resolver.3:220
13915 "Set the recursion desired bit in queries. Recursion is carried out by the "
13916 "domain name server, not by B<res_send>(). [Enabled by default]."
13920 #: build/C/man3/resolver.3:220
13922 msgid "B<RES_DEFNAMES>"
13925 #. type: Plain text
13926 #: build/C/man3/resolver.3:227
13928 "If set, B<res_search>() will append the default domain name to single "
13929 "component names, i.e., those that do not contain a dot. [Enabled by "
13934 #: build/C/man3/resolver.3:227
13936 msgid "B<RES_STAYOPEN>"
13939 #. type: Plain text
13940 #: build/C/man3/resolver.3:232
13941 msgid "Used with B<RES_USEVC> to keep the TCP connection open between queries."
13945 #: build/C/man3/resolver.3:232
13947 msgid "B<RES_DNSRCH>"
13950 #. type: Plain text
13951 #: build/C/man3/resolver.3:241
13953 "If set, B<res_search>() will search for hostnames in the current domain and "
13954 "in parent domains. This option is used by B<gethostbyname>(3). [Enabled by "
13958 #. type: Plain text
13959 #: build/C/man3/resolver.3:245
13961 "This list is not complete. You can find some other flags described in "
13962 "B<resolv.conf>(5)."
13965 #. type: Plain text
13966 #: build/C/man3/resolver.3:250
13967 msgid "The B<res_init>() function returns 0 on success, or -1 if an error occurs."
13970 #. type: Plain text
13971 #: build/C/man3/resolver.3:260
13973 "The B<res_query>(), B<res_search>(), B<res_querydomain>(), B<res_mkquery>() "
13974 "and B<res_send>() functions return the length of the response, or -1 if an "
13978 #. type: Plain text
13979 #: build/C/man3/resolver.3:267
13981 "The B<dn_comp>() and B<dn_expand>() functions return the length of the "
13982 "compressed name, or -1 if an error occurs."
13985 #. type: Plain text
13986 #: build/C/man3/resolver.3:271
13989 "/etc/resolv.conf resolver configuration file\n"
13990 "/etc/host.conf resolver configuration file\n"
13993 #. type: Plain text
13994 #: build/C/man3/resolver.3:274
13998 #. type: Plain text
13999 #: build/C/man3/resolver.3:280
14001 "B<gethostbyname>(3), B<resolv.conf>(5), B<resolver>(5), B<hostname>(7), "
14006 #: build/C/man3/rexec.3:41
14011 #. type: Plain text
14012 #: build/C/man3/rexec.3:44
14013 msgid "rexec, rexec_af - return stream to a remote command"
14016 #. type: Plain text
14017 #: build/C/man3/rexec.3:48
14020 "B<#define _BSD_SOURCE> /* See feature_test_macros(7) */\n"
14021 "B<#include E<lt>netdb.hE<gt>>\n"
14024 #. type: Plain text
14025 #: build/C/man3/rexec.3:51
14028 "B<int rexec(char **>I<ahost>B<, int >I<inport>B<, char *>I<user>B<, >\n"
14029 "B< char *>I<passwd>B<, char *>I<cmd>B<, int *>I<fd2p>B<);>\n"
14032 #. type: Plain text
14033 #: build/C/man3/rexec.3:55
14036 "B<int rexec_af(char **>I<ahost>B<, int >I<inport>B<, char *>I<user>B<, >\n"
14037 "B< char *>I<passwd>B<, char *>I<cmd>B<, int *>I<fd2p>B<,>\n"
14038 "B< sa_family_t >I<af>B<);>\n"
14041 #. type: Plain text
14042 #: build/C/man3/rexec.3:59
14043 msgid "This interface is obsoleted by B<rcmd>(3)."
14046 #. type: Plain text
14047 #: build/C/man3/rexec.3:78
14049 "The B<rexec>() function looks up the host I<*ahost> using "
14050 "B<gethostbyname>(3), returning -1 if the host does not exist. Otherwise "
14051 "I<*ahost> is set to the standard name of the host. If a username and "
14052 "password are both specified, then these are used to authenticate to the "
14053 "foreign host; otherwise the environment and then the user's I<.netrc> file "
14054 "in his home directory are searched for appropriate information. If all this "
14055 "fails, the user is prompted for the information."
14058 #. type: Plain text
14059 #: build/C/man3/rexec.3:89
14061 "The port I<inport> specifies which well-known DARPA Internet port to use for "
14062 "the connection; the call I<getservbyname(\"exec\", \"tcp\")> (see "
14063 "B<getservent>(3)) will return a pointer to a structure that contains the "
14064 "necessary port. The protocol for connection is described in detail in "
14068 #. type: Plain text
14069 #: build/C/man3/rexec.3:122
14071 "If the connection succeeds, a socket in the Internet domain of type "
14072 "B<SOCK_STREAM> is returned to the caller, and given to the remote command as "
14073 "I<stdin> and I<stdout>. If I<fd2p> is nonzero, then an auxiliary channel to "
14074 "a control process will be setup, and a descriptor for it will be placed in "
14075 "I<*fd2p>. The control process will return diagnostic output from the "
14076 "command (unit 2) on this channel, and will also accept bytes on this channel "
14077 "as being UNIX signal numbers, to be forwarded to the process group of the "
14078 "command. The diagnostic information returned does not include remote "
14079 "authorization failure, as the secondary connection is set up after "
14080 "authorization has been verified. If I<fd2p> is 0, then the I<stderr> (unit "
14081 "2 of the remote command) will be made the same as the I<stdout> and no "
14082 "provision is made for sending arbitrary signals to the remote process, "
14083 "although you may be able to get its attention by using out-of-band data."
14087 #: build/C/man3/rexec.3:122
14092 #. type: Plain text
14093 #: build/C/man3/rexec.3:138
14095 "The B<rexec>() function works over IPv4 (B<AF_INET>). By contrast, the "
14096 "B<rexec_af>() function provides an extra argument, I<af>, that allows the "
14097 "caller to select the protocol. This argument can be specified as "
14098 "B<AF_INET>, B<AF_INET6>, or B<AF_UNSPEC> (to allow the implementation to "
14099 "select the protocol)."
14102 #. type: Plain text
14103 #: build/C/man3/rexec.3:142
14104 msgid "The B<rexec_af>() function was added to glibc in version 2.2."
14107 #. type: Plain text
14108 #: build/C/man3/rexec.3:149
14109 msgid "The B<rexec>() and B<rexec_af>() functions are not thread-safe."
14112 #. type: Plain text
14113 #: build/C/man3/rexec.3:158
14115 "These functions are not in POSIX.1-2001. The B<rexec>() function first "
14116 "appeared in 4.2BSD, and is present on the BSDs, Solaris, and many other "
14117 "systems. The B<rexec_af>() function is more recent, and less widespread."
14120 #. type: Plain text
14121 #: build/C/man3/rexec.3:162
14122 msgid "The B<rexec>() function sends the unencrypted password across the network."
14125 #. type: Plain text
14126 #: build/C/man3/rexec.3:167
14128 "The underlying service is considered a big security hole and therefore not "
14129 "enabled on many sites; see B<rexecd>(8) for explanations."
14132 #. type: Plain text
14133 #: build/C/man3/rexec.3:170
14134 msgid "B<rcmd>(3), B<rexecd>(8)"
14138 #: build/C/man5/services.5:34
14144 #: build/C/man5/services.5:34
14149 #. type: Plain text
14150 #: build/C/man5/services.5:37
14151 msgid "services - Internet network services list"
14154 #. type: Plain text
14155 #: build/C/man5/services.5:52
14157 "B<services> is a plain ASCII file providing a mapping between human-friendly "
14158 "textual names for internet services, and their underlying assigned port "
14159 "numbers and protocol types. Every networking program should look into this "
14160 "file to get the port number (and protocol) for its service. The C library "
14161 "routines B<getservent>(3), B<getservbyname>(3), B<getservbyport>(3), "
14162 "B<setservent>(3), and B<endservent>(3) support querying this file from "
14166 #. type: Plain text
14167 #: build/C/man5/services.5:58
14169 "Port numbers are assigned by the IANA (Internet Assigned Numbers Authority), "
14170 "and their current policy is to assign both TCP and UDP protocols when "
14171 "assigning a port number. Therefore, most entries will have two entries, "
14172 "even for TCP-only services."
14175 #. type: Plain text
14176 #: build/C/man5/services.5:70
14178 "Port numbers below 1024 (so-called \"low numbered\" ports) can be bound to "
14179 "only by root (see B<bind>(2), B<tcp>(7), and B<udp>(7)). This is so clients "
14180 "connecting to low numbered ports can trust that the service running on the "
14181 "port is the standard implementation, and not a rogue service run by a user "
14182 "of the machine. Well-known port numbers specified by the IANA are normally "
14183 "located in this root-only space."
14186 #. type: Plain text
14187 #: build/C/man5/services.5:85
14189 "The presence of an entry for a service in the B<services> file does not "
14190 "necessarily mean that the service is currently running on the machine. See "
14191 "B<inetd.conf>(5) for the configuration of Internet services offered. Note "
14192 "that not all networking services are started by B<inetd>(8), and so won't "
14193 "appear in B<inetd.conf>(5). In particular, news (NNTP) and mail (SMTP) "
14194 "servers are often initialized from the system boot scripts."
14197 #. type: Plain text
14198 #: build/C/man5/services.5:94
14200 "The location of the B<services> file is defined by B<_PATH_SERVICES> in "
14201 "I<E<lt>netdb.hE<gt>>. This is usually set to I</etc/services>."
14204 #. type: Plain text
14205 #: build/C/man5/services.5:96
14206 msgid "Each line describes one service, and is of the form:"
14209 #. type: Plain text
14210 #: build/C/man5/services.5:98
14211 msgid "I<service-name\\ \\ \\ port>B</>I<protocol\\ \\ \\ >[I<aliases ...>]"
14215 #: build/C/man5/services.5:98
14221 #: build/C/man5/services.5:100
14223 msgid "I<service-name>"
14226 #. type: Plain text
14227 #: build/C/man5/services.5:106
14229 "is the friendly name the service is known by and looked up under. It is "
14230 "case sensitive. Often, the client program is named after the "
14235 #: build/C/man5/services.5:106
14240 #. type: Plain text
14241 #: build/C/man5/services.5:109
14242 msgid "is the port number (in decimal) to use for this service."
14245 #. type: Plain text
14246 #: build/C/man5/services.5:120
14248 "is the type of protocol to be used. This field should match an entry in the "
14249 "B<protocols>(5) file. Typical values include B<tcp> and B<udp>."
14252 #. type: Plain text
14253 #: build/C/man5/services.5:126
14255 "is an optional space or tab separated list of other names for this service. "
14256 "Again, the names are case sensitive."
14259 #. type: Plain text
14260 #: build/C/man5/services.5:128
14261 msgid "Either spaces or tabs may be used to separate the fields."
14264 #. type: Plain text
14265 #: build/C/man5/services.5:132
14267 "Comments are started by the hash sign (#) and continue until the end of the "
14268 "line. Blank lines are skipped."
14271 #. type: Plain text
14272 #: build/C/man5/services.5:143
14274 "The I<service-name> should begin in the first column of the file, since "
14275 "leading spaces are not stripped. I<service-names> can be any printable "
14276 "characters excluding space and tab. However, a conservative choice of "
14277 "characters should be used to minimize compatibility problems. E.g., a-z, "
14278 "0-9, and hyphen (-) would seem a sensible choice."
14281 #. type: Plain text
14282 #: build/C/man5/services.5:152
14284 "Lines not matching this format should not be present in the file. "
14285 "(Currently, they are silently skipped by B<getservent>(3), "
14286 "B<getservbyname>(3), and B<getservbyport>(3). However, this behavior should "
14287 "not be relied on.)"
14290 #. type: Plain text
14291 #: build/C/man5/services.5:169
14292 msgid "A sample B<services> file might look like this:"
14295 #. type: Plain text
14296 #: build/C/man5/services.5:182
14299 "CW<netstat 15/tcp\n"
14300 "qotd 17/tcp quote\n"
14301 "msp 18/tcp # message send protocol\n"
14302 "msp 18/udp # message send protocol\n"
14303 "chargen 19/tcp ttytst source\n"
14304 "chargen 19/udp ttytst source\n"
14306 "# 22 - unassigned\n"
14310 #. type: Plain text
14311 #: build/C/man5/services.5:189
14312 msgid "The Internet network services list"
14316 #: build/C/man5/services.5:189
14318 msgid "I<E<lt>netdb.hE<gt>>"
14322 #. It's not clear when/if the following was ever true;
14323 #. it isn't true for glibc 2.8:
14324 #. There is a maximum of 35 aliases, due to the way the
14325 #. .BR getservent (3)
14326 #. code is written.
14328 #. It's not clear when/if the following was ever true;
14329 #. it isn't true for glibc 2.8:
14330 #. Lines longer than
14332 #. (currently 1024) characters will be ignored by
14333 #. .BR getservent (3),
14334 #. .BR getservbyname (3),
14336 #. .BR getservbyport (3).
14337 #. However, this will also cause the next line to be mis-parsed.
14338 #. type: Plain text
14339 #: build/C/man5/services.5:210
14340 msgid "Definition of B<_PATH_SERVICES>"
14343 #. type: Plain text
14344 #: build/C/man5/services.5:220
14346 "B<listen>(2), B<endservent>(3), B<getservbyname>(3), B<getservbyport>(3), "
14347 "B<getservent>(3), B<setservent>(3), B<inetd.conf>(5), B<protocols>(5), "
14351 #. type: Plain text
14352 #: build/C/man5/services.5:222
14353 msgid "Assigned Numbers RFC, most recently RFC\\ 1700, (AKA STD0002)."
14357 #: build/C/man3/setnetgrent.3:10
14359 msgid "SETNETGRENT"
14363 #: build/C/man3/setnetgrent.3:10
14368 #. type: Plain text
14369 #: build/C/man3/setnetgrent.3:14
14371 "setnetgrent, endnetgrent, getnetgrent, getnetgrent_r, innetgr - handle "
14372 "network group entries"
14375 #. type: Plain text
14376 #: build/C/man3/setnetgrent.3:19
14378 msgid "B<int setnetgrent(const char *>I<netgroup>B<);>\n"
14381 #. type: Plain text
14382 #: build/C/man3/setnetgrent.3:21
14384 msgid "B<void endnetgrent(void);>\n"
14387 #. type: Plain text
14388 #: build/C/man3/setnetgrent.3:23
14391 "B<int getnetgrent(char **>I<host>B<, char **>I<user>B<, char "
14392 "**>I<domain>B<);>\n"
14395 #. type: Plain text
14396 #: build/C/man3/setnetgrent.3:26
14399 "B<int getnetgrent_r(char **>I<host>B<, char **>I<user>B<,>\n"
14400 "B< char **>I<domain>B<, char *>I<buf>B<, int "
14401 ">I<buflen>B<);>\n"
14404 #. type: Plain text
14405 #: build/C/man3/setnetgrent.3:29
14408 "B<int innetgr(const char *>I<netgroup>B<, const char *>I<host>B<,>\n"
14409 "B< const char *>I<user>B<, const char *>I<domain>B<);>\n"
14412 #. type: Plain text
14413 #: build/C/man3/setnetgrent.3:43
14415 "B<setnetgrent>(), B<endnetgrent>(), B<getnetgrent>(), B<getnetgrent_r>(), "
14416 "B<innetgr>(): _BSD_SOURCE || _SVID_SOURCE"
14419 #. type: Plain text
14420 #: build/C/man3/setnetgrent.3:57
14422 "The I<netgroup> is a SunOS invention. A netgroup database is a list of "
14423 "string triples (I<hostname>, I<username>, I<domainname>) or other netgroup "
14424 "names. Any of the elements in a triple can be empty, which means that "
14425 "anything matches. The functions described here allow access to the netgroup "
14426 "databases. The file I</etc/nsswitch.conf> defines what database is "
14430 #. type: Plain text
14431 #: build/C/man3/setnetgrent.3:77
14433 "The B<setnetgrent>() call defines the netgroup that will be searched by "
14434 "subsequent B<getnetgrent>() calls. The B<getnetgrent>() function "
14435 "retrieves the next netgroup entry, and returns pointers in I<host>, I<user>, "
14436 "I<domain>. A NULL pointer means that the corresponding entry matches any "
14437 "string. The pointers are valid only as long as there is no call to other "
14438 "netgroup-related functions. To avoid this problem you can use the GNU "
14439 "function B<getnetgrent_r>() that stores the strings in the supplied "
14440 "buffer. To free all allocated buffers use B<endnetgrent>()."
14443 #. type: Plain text
14444 #: build/C/man3/setnetgrent.3:86
14446 "In most cases you want to check only if the triplet (I<hostname>, "
14447 "I<username>, I<domainname>) is a member of a netgroup. The function "
14448 "B<innetgr>() can be used for this without calling the above three "
14449 "functions. Again, a NULL pointer is a wildcard and matches any string. The "
14450 "function is thread-safe."
14453 #. type: Plain text
14454 #: build/C/man3/setnetgrent.3:88
14455 msgid "These functions return 1 on success and 0 for failure."
14458 #. type: Plain text
14459 #: build/C/man3/setnetgrent.3:90
14460 msgid "I</etc/netgroup>"
14463 #. getnetgrent_r() is on Solaris 8 and AIX 5.1, but not the BSDs.
14464 #. type: Plain text
14465 #: build/C/man3/setnetgrent.3:103
14467 "These functions are not in POSIX.1-2001, but B<setnetgrent>(), "
14468 "B<endnetgrent>(), B<getnetgrent>(), and B<innetgr>() are available on most "
14469 "UNIX systems. B<getnetgrent_r>() is not widely available on other systems."
14472 #. type: Plain text
14473 #: build/C/man3/setnetgrent.3:107
14474 msgid "In the BSD implementation, B<setnetgrent>() returns void."
14477 #. type: Plain text
14478 #: build/C/man3/setnetgrent.3:111
14479 msgid "B<sethostent>(3), B<setprotoent>(3), B<setservent>(3)"
14483 #: build/C/man2/shutdown.2:40
14489 #: build/C/man2/shutdown.2:40
14494 #. type: Plain text
14495 #: build/C/man2/shutdown.2:43
14496 msgid "shutdown - shut down part of a full-duplex connection"
14499 #. type: Plain text
14500 #: build/C/man2/shutdown.2:47
14501 msgid "B<int shutdown(int >I<sockfd>B<, int >I<how>B<);>"
14504 #. type: Plain text
14505 #: build/C/man2/shutdown.2:69
14507 "The B<shutdown>() call causes all or part of a full-duplex connection on "
14508 "the socket associated with I<sockfd> to be shut down. If I<how> is "
14509 "B<SHUT_RD>, further receptions will be disallowed. If I<how> is B<SHUT_WR>, "
14510 "further transmissions will be disallowed. If I<how> is B<SHUT_RDWR>, "
14511 "further receptions and transmissions will be disallowed."
14514 #. type: Plain text
14515 #: build/C/man2/shutdown.2:79
14516 msgid "I<sockfd> is not a valid descriptor."
14519 #. type: Plain text
14520 #: build/C/man2/shutdown.2:84
14521 msgid "An invalid value was specified in I<how> (but see BUGS)."
14524 #. type: Plain text
14525 #: build/C/man2/shutdown.2:87
14526 msgid "The specified socket is not connected."
14529 #. type: Plain text
14530 #: build/C/man2/shutdown.2:91
14531 msgid "I<sockfd> is a file, not a socket."
14534 #. type: Plain text
14535 #: build/C/man2/shutdown.2:95
14537 "POSIX.1-2001, 4.4BSD (the B<shutdown>() function call first appeared in "
14541 #. type: Plain text
14542 #: build/C/man2/shutdown.2:104
14544 "The constants B<SHUT_RD>, B<SHUT_WR>, B<SHUT_RDWR> have the value 0, 1, 2, "
14545 "respectively, and are defined in I<E<lt>sys/socket.hE<gt>> since "
14550 #. https://bugzilla.kernel.org/show_bug.cgi?id=47111
14551 #. type: Plain text
14552 #: build/C/man2/shutdown.2:113
14554 "As currently implemented, checks for the validity of I<how> are done in "
14555 "domain-specific code, and not all domains perform these checks. Most "
14556 "notably, UNIX domain sockets simply ignore invalid values; this may change "
14560 #. type: Plain text
14561 #: build/C/man2/shutdown.2:117
14562 msgid "B<connect>(2), B<socket>(2), B<socket>(7)"
14566 #: build/C/man7/tcp.7:65
14572 #: build/C/man7/tcp.7:65
14577 #. type: Plain text
14578 #: build/C/man7/tcp.7:68
14579 msgid "tcp - TCP protocol"
14582 #. type: Plain text
14583 #: build/C/man7/tcp.7:74
14584 msgid "B<#include E<lt>netinet/tcp.hE<gt>>"
14587 #. type: Plain text
14588 #: build/C/man7/tcp.7:76
14589 msgid "B<tcp_socket = socket(AF_INET, SOCK_STREAM, 0);>"
14592 #. type: Plain text
14593 #: build/C/man7/tcp.7:89
14595 "This is an implementation of the TCP protocol defined in RFC\\ 793, RFC\\ "
14596 "1122 and RFC\\ 2001 with the NewReno and SACK extensions. It provides a "
14597 "reliable, stream-oriented, full-duplex connection between two sockets on top "
14598 "of B<ip>(7), for both v4 and v6 versions. TCP guarantees that the data "
14599 "arrives in order and retransmits lost packets. It generates and checks a "
14600 "per-packet checksum to catch transmission errors. TCP does not preserve "
14601 "record boundaries."
14604 #. type: Plain text
14605 #: build/C/man7/tcp.7:108
14607 "A newly created TCP socket has no remote or local address and is not fully "
14608 "specified. To create an outgoing TCP connection use B<connect>(2) to "
14609 "establish a connection to another TCP socket. To receive new incoming "
14610 "connections, first B<bind>(2) the socket to a local address and port and "
14611 "then call B<listen>(2) to put the socket into the listening state. After "
14612 "that a new socket for each incoming connection can be accepted using "
14613 "B<accept>(2). A socket which has had B<accept>(2) or B<connect>(2) "
14614 "successfully called on it is fully specified and may transmit data. Data "
14615 "cannot be transmitted on listening or not yet connected sockets."
14618 #. type: Plain text
14619 #: build/C/man7/tcp.7:128
14621 "Linux supports RFC\\ 1323 TCP high performance extensions. These include "
14622 "Protection Against Wrapped Sequence Numbers (PAWS), Window Scaling and "
14623 "Timestamps. Window scaling allows the use of large (E<gt> 64K) TCP windows "
14624 "in order to support links with high latency or bandwidth. To make use of "
14625 "them, the send and receive buffer sizes must be increased. They can be set "
14626 "globally with the I</proc/sys/net/ipv4/tcp_wmem> and "
14627 "I</proc/sys/net/ipv4/tcp_rmem> files, or on individual sockets by using the "
14628 "B<SO_SNDBUF> and B<SO_RCVBUF> socket options with the B<setsockopt>(2) "
14632 #. type: Plain text
14633 #: build/C/man7/tcp.7:159
14635 "The maximum sizes for socket buffers declared via the B<SO_SNDBUF> and "
14636 "B<SO_RCVBUF> mechanisms are limited by the values in the "
14637 "I</proc/sys/net/core/rmem_max> and I</proc/sys/net/core/wmem_max> files. "
14638 "Note that TCP actually allocates twice the size of the buffer requested in "
14639 "the B<setsockopt>(2) call, and so a succeeding B<getsockopt>(2) call will "
14640 "not return the same size of buffer as requested in the B<setsockopt>(2) "
14641 "call. TCP uses the extra space for administrative purposes and internal "
14642 "kernel structures, and the I</proc> file values reflect the larger sizes "
14643 "compared to the actual TCP windows. On individual connections, the socket "
14644 "buffer size must be set prior to the B<listen>(2) or B<connect>(2) calls "
14645 "in order to have it take effect. See B<socket>(7) for more information."
14648 #. type: Plain text
14649 #: build/C/man7/tcp.7:191
14651 "TCP supports urgent data. Urgent data is used to signal the receiver that "
14652 "some important message is part of the data stream and that it should be "
14653 "processed as soon as possible. To send urgent data specify the B<MSG_OOB> "
14654 "option to B<send>(2). When urgent data is received, the kernel sends a "
14655 "B<SIGURG> signal to the process or process group that has been set as the "
14656 "socket \"owner\" using the B<SIOCSPGRP> or B<FIOSETOWN> ioctls (or the "
14657 "POSIX.1-2001-specified B<fcntl>(2) B<F_SETOWN> operation). When the "
14658 "B<SO_OOBINLINE> socket option is enabled, urgent data is put into the normal "
14659 "data stream (a program can test for its location using the B<SIOCATMARK> "
14660 "ioctl described below), otherwise it can be received only when the "
14661 "B<MSG_OOB> flag is set for B<recv>(2) or B<recvmsg>(2)."
14664 #. type: Plain text
14665 #: build/C/man7/tcp.7:199
14667 "Linux 2.4 introduced a number of changes for improved throughput and "
14668 "scaling, as well as enhanced functionality. Some of these features include "
14669 "support for zero-copy B<sendfile>(2), Explicit Congestion Notification, new "
14670 "management of TIME_WAIT sockets, keep-alive socket options and support for "
14671 "Duplicate SACK extensions."
14675 #: build/C/man7/tcp.7:199
14677 msgid "Address formats"
14680 #. type: Plain text
14681 #: build/C/man7/tcp.7:208
14683 "TCP is built on top of IP (see B<ip>(7)). The address formats defined by "
14684 "B<ip>(7) apply to TCP. TCP supports point-to-point communication only; "
14685 "broadcasting and multicasting are not supported."
14688 #. type: Plain text
14689 #: build/C/man7/tcp.7:220
14691 "System-wide TCP parameter settings can be accessed by files in the directory "
14692 "I</proc/sys/net/ipv4/>. In addition, most IP I</proc> interfaces also apply "
14693 "to TCP; see B<ip>(7). Variables described as I<Boolean> take an integer "
14694 "value, with a nonzero value (\"true\") meaning that the corresponding option "
14695 "is enabled, and a zero value (\"false\") meaning that the option is "
14700 #: build/C/man7/tcp.7:220
14702 msgid "I<tcp_abc> (Integer; default: 0; since Linux 2.6.15)"
14705 #. The following is from 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
14706 #. type: Plain text
14707 #: build/C/man7/tcp.7:228
14709 "Control the Appropriate Byte Count (ABC), defined in RFC 3465. ABC is a way "
14710 "of increasing the congestion window (I<cwnd>) more slowly in response to "
14711 "partial acknowledgments. Possible values are:"
14715 #: build/C/man7/tcp.7:229 build/C/man7/tcp.7:398 build/C/man7/tcp.7:419 build/C/man7/tcp.7:563
14720 #. type: Plain text
14721 #: build/C/man7/tcp.7:233
14722 msgid "increase I<cwnd> once per acknowledgment (no ABC)"
14726 #: build/C/man7/tcp.7:233 build/C/man7/tcp.7:400 build/C/man7/tcp.7:426 build/C/man7/tcp.7:565
14731 #. type: Plain text
14732 #: build/C/man7/tcp.7:237
14733 msgid "increase I<cwnd> once per acknowledgment of full sized segment"
14737 #: build/C/man7/tcp.7:237 build/C/man7/tcp.7:402 build/C/man7/tcp.7:433 build/C/man7/tcp.7:567
14742 #. type: Plain text
14743 #: build/C/man7/tcp.7:242
14745 "allow increase I<cwnd> by two if acknowledgment is of two segments to "
14746 "compensate for delayed acknowledgments."
14750 #: build/C/man7/tcp.7:243
14752 msgid "I<tcp_abort_on_overflow> (Boolean; default: disabled; since Linux 2.4)"
14756 #. type: Plain text
14757 #: build/C/man7/tcp.7:255
14759 "Enable resetting connections if the listening service is too slow and unable "
14760 "to keep up and accept them. It means that if overflow occurred due to a "
14761 "burst, the connection will recover. Enable this option I<only> if you are "
14762 "really sure that the listening daemon cannot be tuned to accept connections "
14763 "faster. Enabling this option can harm the clients of your server."
14767 #: build/C/man7/tcp.7:255
14769 msgid "I<tcp_adv_win_scale> (integer; default: 2; since Linux 2.4)"
14772 #. Since 2.4.0-test7
14773 #. type: Plain text
14774 #: build/C/man7/tcp.7:267
14776 "Count buffering overhead as I<bytes/2^tcp_adv_win_scale>, if "
14777 "I<tcp_adv_win_scale> is greater than 0; or "
14778 "I<bytes-bytes/2^(-tcp_adv_win_scale)>, if I<tcp_adv_win_scale> is less than "
14779 "or equal to zero."
14782 #. type: Plain text
14783 #: build/C/man7/tcp.7:280
14785 "The socket receive buffer space is shared between the application and "
14786 "kernel. TCP maintains part of the buffer as the TCP window, this is the "
14787 "size of the receive window advertised to the other end. The rest of the "
14788 "space is used as the \"application\" buffer, used to isolate the network "
14789 "from scheduling and application latencies. The I<tcp_adv_win_scale> default "
14790 "value of 2 implies that the space used for the application buffer is one "
14791 "fourth that of the total."
14795 #: build/C/man7/tcp.7:280
14798 "I<tcp_allowed_congestion_control> (String; default: see text; since Linux "
14802 #. The following is from 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
14803 #. FIXME How are the items in this delimited? Null bytes, spaces, commas?
14804 #. type: Plain text
14805 #: build/C/man7/tcp.7:292
14807 "Show/set the congestion control algorithm choices available to unprivileged "
14808 "processes (see the description of the B<TCP_CONGESTION> socket option). The "
14809 "list is a subset of those listed in I<tcp_available_congestion_control>. "
14810 "The default value for this list is \"reno\" plus the default setting of "
14811 "I<tcp_congestion_control>."
14815 #: build/C/man7/tcp.7:292
14817 msgid "I<tcp_available_congestion_control> (String; read-only; since Linux 2.4.20)"
14820 #. The following is from 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
14821 #. FIXME How are the items in this delimited? Null bytes, spaces, commas?
14822 #. type: Plain text
14823 #: build/C/man7/tcp.7:302
14825 "Show a list of the congestion-control algorithms that are registered. This "
14826 "list is a limiting set for the list in I<tcp_allowed_congestion_control>. "
14827 "More congestion-control algorithms may be available as modules, but not "
14832 #: build/C/man7/tcp.7:302
14834 msgid "I<tcp_app_win> (integer; default: 31; since Linux 2.4)"
14837 #. Since 2.4.0-test7
14838 #. type: Plain text
14839 #: build/C/man7/tcp.7:307
14841 "This variable defines how many bytes of the TCP window are reserved for "
14842 "buffering overhead."
14846 #. The following is from 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
14847 #. type: Plain text
14848 #: build/C/man7/tcp.7:313
14850 "A maximum of (I<window/2^tcp_app_win>, mss) bytes in the window are reserved "
14851 "for the application buffer. A value of 0 implies that no amount is "
14856 #: build/C/man7/tcp.7:313
14858 msgid "I<tcp_base_mss> (Integer; default: 512; since Linux 2.6.17)"
14862 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
14863 #. type: Plain text
14864 #: build/C/man7/tcp.7:322
14866 "The initial value of I<search_low> to be used by the packetization layer "
14867 "Path MTU discovery (MTU probing). If MTU probing is enabled, this is the "
14868 "initial MSS used by the connection."
14872 #: build/C/man7/tcp.7:322
14874 msgid "I<tcp_bic> (Boolean; default: disabled; Linux 2.4.27/2.6.6 to 2.6.13)"
14878 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
14879 #. type: Plain text
14880 #: build/C/man7/tcp.7:336
14882 "Enable BIC TCP congestion control algorithm. BIC-TCP is a sender-side only "
14883 "change that ensures a linear RTT fairness under large windows while offering "
14884 "both scalability and bounded TCP-friendliness. The protocol combines two "
14885 "schemes called additive increase and binary search increase. When the "
14886 "congestion window is large, additive increase with a large increment ensures "
14887 "linear RTT fairness as well as good scalability. Under small congestion "
14888 "windows, binary search increase provides TCP friendliness."
14892 #: build/C/man7/tcp.7:336
14894 msgid "I<tcp_bic_low_window> (integer; default: 14; Linux 2.4.27/2.6.6 to 2.6.13)"
14898 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
14899 #. type: Plain text
14900 #: build/C/man7/tcp.7:343
14902 "Set the threshold window (in packets) where BIC TCP starts to adjust the "
14903 "congestion window. Below this threshold BIC TCP behaves the same as the "
14904 "default TCP Reno."
14908 #: build/C/man7/tcp.7:343
14911 "I<tcp_bic_fast_convergence> (Boolean; default: enabled; Linux 2.4.27/2.6.6 "
14915 #. type: Plain text
14916 #: build/C/man7/tcp.7:347
14918 "Force BIC TCP to more quickly respond to changes in congestion window. "
14919 "Allows two flows sharing the same connection to converge more rapidly."
14923 #: build/C/man7/tcp.7:347
14925 msgid "I<tcp_congestion_control> (String; default: see text; since Linux 2.4.13)"
14928 #. The following is from 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
14929 #. type: Plain text
14930 #: build/C/man7/tcp.7:354
14932 "Set the default congestion-control algorithm to be used for new "
14933 "connections. The algorithm \"reno\" is always available, but additional "
14934 "choices may be available depending on kernel configuration. The default "
14935 "value for this file is set as part of kernel configuration."
14939 #: build/C/man7/tcp.7:354
14941 msgid "I<tcp_dma_copybreak> (integer; default: 4096; since Linux 2.6.24)"
14944 #. type: Plain text
14945 #: build/C/man7/tcp.7:361
14947 "Lower limit, in bytes, of the size of socket reads that will be offloaded to "
14948 "a DMA copy engine, if one is present in the system and the kernel was "
14949 "configured with the B<CONFIG_NET_DMA> option."
14953 #: build/C/man7/tcp.7:361
14955 msgid "I<tcp_dsack> (Boolean; default: enabled; since Linux 2.4)"
14958 #. Since 2.4.0-test7
14959 #. type: Plain text
14960 #: build/C/man7/tcp.7:365
14961 msgid "Enable RFC\\ 2883 TCP Duplicate SACK support."
14965 #: build/C/man7/tcp.7:365
14967 msgid "I<tcp_ecn> (Boolean; default: disabled; since Linux 2.4)"
14970 #. Since 2.4.0-test7
14971 #. type: Plain text
14972 #: build/C/man7/tcp.7:372
14974 "Enable RFC\\ 2884 Explicit Congestion Notification. When enabled, "
14975 "connectivity to some destinations could be affected due to older, "
14976 "misbehaving routers along the path causing connections to be dropped."
14980 #: build/C/man7/tcp.7:372
14982 msgid "I<tcp_fack> (Boolean; default: enabled; since Linux 2.2)"
14986 #. type: Plain text
14987 #: build/C/man7/tcp.7:376
14988 msgid "Enable TCP Forward Acknowledgement support."
14992 #: build/C/man7/tcp.7:376
14994 msgid "I<tcp_fin_timeout> (integer; default: 60; since Linux 2.2)"
14999 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
15000 #. type: Plain text
15001 #: build/C/man7/tcp.7:386
15003 "This specifies how many seconds to wait for a final FIN packet before the "
15004 "socket is forcibly closed. This is strictly a violation of the TCP "
15005 "specification, but required to prevent denial-of-service attacks. In Linux "
15006 "2.2, the default value was 180."
15010 #: build/C/man7/tcp.7:386
15012 msgid "I<tcp_frto> (integer; default: 0; since Linux 2.4.21/2.6)"
15015 #. Since 2.4.21/2.5.43
15016 #. type: Plain text
15017 #: build/C/man7/tcp.7:395
15019 "Enable F-RTO, an enhanced recovery algorithm for TCP retransmission timeouts "
15020 "(RTOs). It is particularly beneficial in wireless environments where packet "
15021 "loss is typically due to random radio interference rather than intermediate "
15022 "router congestion. See RFC 4138 for more details."
15025 #. type: Plain text
15026 #: build/C/man7/tcp.7:397
15027 msgid "This file can have one of the following values:"
15030 #. type: Plain text
15031 #: build/C/man7/tcp.7:400
15035 #. type: Plain text
15036 #: build/C/man7/tcp.7:402
15037 msgid "The basic version F-RTO algorithm is enabled."
15040 #. type: Plain text
15041 #: build/C/man7/tcp.7:407
15043 "Enable SACK-enhanced F-RTO if flow uses SACK. The basic version can be used "
15044 "also when SACK is in use though in that case scenario(s) exists where F-RTO "
15045 "interacts badly with the packet counting of the SACK-enabled TCP flow."
15048 #. type: Plain text
15049 #: build/C/man7/tcp.7:411
15051 "Before Linux 2.6.22, this parameter was a Boolean value, supporting just "
15052 "values 0 and 1 above."
15056 #: build/C/man7/tcp.7:411
15058 msgid "I<tcp_frto_response> (integer; default: 0; since Linux 2.6.22)"
15061 #. type: Plain text
15062 #: build/C/man7/tcp.7:418
15064 "When F-RTO has detected that a TCP retransmission timeout was spurious (i.e, "
15065 "the timeout would have been avoided had TCP set a longer retransmission "
15066 "timeout), TCP has several options concerning what to do next. Possible "
15070 #. type: Plain text
15071 #: build/C/man7/tcp.7:426
15073 "Rate halving based; a smooth and conservative response, results in halved "
15074 "congestion window (I<cwnd>) and slow-start threshold (I<ssthresh>) after "
15078 #. type: Plain text
15079 #: build/C/man7/tcp.7:433
15081 "Very conservative response; not recommended because even though being valid, "
15082 "it interacts poorly with the rest of Linux TCP; halves I<cwnd> and "
15083 "I<ssthresh> immediately."
15086 #. type: Plain text
15087 #: build/C/man7/tcp.7:442
15089 "Aggressive response; undoes congestion-control measures that are now known "
15090 "to be unnecessary (ignoring the possibility of a lost retransmission that "
15091 "would require TCP to be more cautious); I<cwnd> and I<ssthresh> are restored "
15092 "to the values prior to timeout."
15096 #: build/C/man7/tcp.7:443
15098 msgid "I<tcp_keepalive_intvl> (integer; default: 75; since Linux 2.4)"
15102 #. type: Plain text
15103 #: build/C/man7/tcp.7:447
15104 msgid "The number of seconds between TCP keep-alive probes."
15108 #: build/C/man7/tcp.7:447
15110 msgid "I<tcp_keepalive_probes> (integer; default: 9; since Linux 2.2)"
15114 #. type: Plain text
15115 #: build/C/man7/tcp.7:453
15117 "The maximum number of TCP keep-alive probes to send before giving up and "
15118 "killing the connection if no response is obtained from the other end."
15122 #: build/C/man7/tcp.7:453
15124 msgid "I<tcp_keepalive_time> (integer; default: 7200; since Linux 2.2)"
15128 #. type: Plain text
15129 #: build/C/man7/tcp.7:465
15131 "The number of seconds a connection needs to be idle before TCP begins "
15132 "sending out keep-alive probes. Keep-alives are sent only when the "
15133 "B<SO_KEEPALIVE> socket option is enabled. The default value is 7200 seconds "
15134 "(2 hours). An idle connection is terminated after approximately an "
15135 "additional 11 minutes (9 probes an interval of 75 seconds apart) when "
15136 "keep-alive is enabled."
15140 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
15141 #. type: Plain text
15142 #: build/C/man7/tcp.7:470
15144 "Note that underlying connection tracking mechanisms and application timeouts "
15145 "may be much shorter."
15149 #: build/C/man7/tcp.7:470
15151 msgid "I<tcp_low_latency> (Boolean; default: disabled; since Linux 2.4.21/2.6)"
15154 #. Since 2.4.21/2.5.60
15155 #. type: Plain text
15156 #: build/C/man7/tcp.7:478
15158 "If enabled, the TCP stack makes decisions that prefer lower latency as "
15159 "opposed to higher throughput. It this option is disabled, then higher "
15160 "throughput is preferred. An example of an application where this default "
15161 "should be changed would be a Beowulf compute cluster."
15165 #: build/C/man7/tcp.7:478
15167 msgid "I<tcp_max_orphans> (integer; default: see below; since Linux 2.4)"
15171 #. type: Plain text
15172 #: build/C/man7/tcp.7:492
15174 "The maximum number of orphaned (not attached to any user file handle) TCP "
15175 "sockets allowed in the system. When this number is exceeded, the orphaned "
15176 "connection is reset and a warning is printed. This limit exists only to "
15177 "prevent simple denial-of-service attacks. Lowering this limit is not "
15178 "recommended. Network conditions might require you to increase the number of "
15179 "orphans allowed, but note that each orphan can eat up to ~64K of unswappable "
15180 "memory. The default initial value is set equal to the kernel parameter "
15181 "NR_FILE. This initial default is adjusted depending on the memory in the "
15186 #: build/C/man7/tcp.7:492
15188 msgid "I<tcp_max_syn_backlog> (integer; default: see below; since Linux 2.2)"
15192 #. type: Plain text
15193 #: build/C/man7/tcp.7:509
15195 "The maximum number of queued connection requests which have still not "
15196 "received an acknowledgement from the connecting client. If this number is "
15197 "exceeded, the kernel will begin dropping requests. The default value of 256 "
15198 "is increased to 1024 when the memory present in the system is adequate or "
15199 "greater (E<gt>= 128Mb), and reduced to 128 for those systems with very low "
15200 "memory (E<lt>= 32Mb). It is recommended that if this needs to be increased "
15201 "above 1024, TCP_SYNQ_HSIZE in I<include/net/tcp.h> be modified to keep "
15202 "TCP_SYNQ_HSIZE*16E<lt>=tcp_max_syn_backlog, and the kernel be recompiled."
15206 #: build/C/man7/tcp.7:509
15208 msgid "I<tcp_max_tw_buckets> (integer; default: see below; since Linux 2.4)"
15212 #. type: Plain text
15213 #: build/C/man7/tcp.7:519
15215 "The maximum number of sockets in TIME_WAIT state allowed in the system. "
15216 "This limit exists only to prevent simple denial-of-service attacks. The "
15217 "default value of NR_FILE*2 is adjusted depending on the memory in the "
15218 "system. If this number is exceeded, the socket is closed and a warning is "
15223 #: build/C/man7/tcp.7:519
15225 msgid "I<tcp_moderate_rcvbuf> (Boolean; default: enabled; since Linux 2.4.17/2.6.7)"
15228 #. The following is from 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
15229 #. type: Plain text
15230 #: build/C/man7/tcp.7:526
15232 "If enabled, TCP performs receive buffer auto-tuning, attempting to "
15233 "automatically size the buffer (no greater than I<tcp_rmem[2]>) to match the "
15234 "size required by the path for full throughput."
15238 #: build/C/man7/tcp.7:526
15240 msgid "I<tcp_mem> (since Linux 2.4)"
15243 #. Since 2.4.0-test7
15244 #. type: Plain text
15245 #: build/C/man7/tcp.7:538
15247 "This is a vector of 3 integers: [low, pressure, high]. These bounds, "
15248 "measured in units of the system page size, are used by TCP to track its "
15249 "memory usage. The defaults are calculated at boot time from the amount of "
15250 "available memory. (TCP can only use I<low memory> for this, which is "
15251 "limited to around 900 megabytes on 32-bit systems. 64-bit systems do not "
15252 "suffer this limitation.)"
15256 #: build/C/man7/tcp.7:539
15261 #. type: Plain text
15262 #: build/C/man7/tcp.7:543
15264 "TCP doesn't regulate its memory allocation when the number of pages it has "
15265 "allocated globally is below this number."
15269 #: build/C/man7/tcp.7:543 build/C/man7/udp.7:151
15271 msgid "I<pressure>"
15274 #. type: Plain text
15275 #: build/C/man7/tcp.7:552
15277 "When the amount of memory allocated by TCP exceeds this number of pages, TCP "
15278 "moderates its memory consumption. This memory pressure state is exited once "
15279 "the number of pages allocated falls below the I<low> mark."
15283 #: build/C/man7/tcp.7:552
15288 #. type: Plain text
15289 #: build/C/man7/tcp.7:556
15291 "The maximum number of pages, globally, that TCP will allocate. This value "
15292 "overrides any other limits imposed by the kernel."
15296 #: build/C/man7/tcp.7:557
15298 msgid "I<tcp_mtu_probing> (integer; default: 0; since Linux 2.6.17)"
15301 #. The following is from 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
15302 #. type: Plain text
15303 #: build/C/man7/tcp.7:562
15305 "This parameter controls TCP Packetization-Layer Path MTU Discovery. The "
15306 "following values may be assigned to the file:"
15309 #. type: Plain text
15310 #: build/C/man7/tcp.7:565
15314 #. type: Plain text
15315 #: build/C/man7/tcp.7:567
15316 msgid "Disabled by default, enabled when an ICMP black hole detected"
15319 #. type: Plain text
15320 #: build/C/man7/tcp.7:570
15321 msgid "Always enabled, use initial MSS of I<tcp_base_mss>."
15325 #: build/C/man7/tcp.7:571
15327 msgid "I<tcp_no_metrics_save> (Boolean; default: disabled; since Linux 2.6.6)"
15330 #. The following is from 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
15331 #. type: Plain text
15332 #: build/C/man7/tcp.7:582
15334 "By default, TCP saves various connection metrics in the route cache when the "
15335 "connection closes, so that connections established in the near future can "
15336 "use these to set initial conditions. Usually, this increases overall "
15337 "performance, but it may sometimes cause performance degradation. If "
15338 "I<tcp_no_metrics_save> is enabled, TCP will not cache metrics on closing "
15343 #: build/C/man7/tcp.7:582
15345 msgid "I<tcp_orphan_retries> (integer; default: 8; since Linux 2.4)"
15349 #. type: Plain text
15350 #: build/C/man7/tcp.7:587
15352 "The maximum number of attempts made to probe the other end of a connection "
15353 "which has been closed by our end."
15357 #: build/C/man7/tcp.7:587
15359 msgid "I<tcp_reordering> (integer; default: 3; since Linux 2.4)"
15362 #. Since 2.4.0-test7
15363 #. type: Plain text
15364 #: build/C/man7/tcp.7:596
15366 "The maximum a packet can be reordered in a TCP packet stream without TCP "
15367 "assuming packet loss and going into slow start. It is not advisable to "
15368 "change this number. This is a packet reordering detection metric designed "
15369 "to minimize unnecessary back off and retransmits provoked by reordering of "
15370 "packets on a connection."
15374 #: build/C/man7/tcp.7:596
15376 msgid "I<tcp_retrans_collapse> (Boolean; default: enabled; since Linux 2.2)"
15380 #. type: Plain text
15381 #: build/C/man7/tcp.7:600
15382 msgid "Try to send full-sized packets during retransmit."
15386 #: build/C/man7/tcp.7:600
15388 msgid "I<tcp_retries1> (integer; default: 3; since Linux 2.2)"
15392 #. type: Plain text
15393 #: build/C/man7/tcp.7:610
15395 "The number of times TCP will attempt to retransmit a packet on an "
15396 "established connection normally, without the extra effort of getting the "
15397 "network layers involved. Once we exceed this number of retransmits, we "
15398 "first have the network layer update the route if possible before each new "
15399 "retransmit. The default is the RFC specified minimum of 3."
15403 #: build/C/man7/tcp.7:610
15405 msgid "I<tcp_retries2> (integer; default: 15; since Linux 2.2)"
15409 #. type: Plain text
15410 #: build/C/man7/tcp.7:620
15412 "The maximum number of times a TCP packet is retransmitted in established "
15413 "state before giving up. The default value is 15, which corresponds to a "
15414 "duration of approximately between 13 to 30 minutes, depending on the "
15415 "retransmission timeout. The RFC\\ 1122 specified minimum limit of 100 "
15416 "seconds is typically deemed too short."
15420 #: build/C/man7/tcp.7:620
15422 msgid "I<tcp_rfc1337> (Boolean; default: disabled; since Linux 2.2)"
15426 #. type: Plain text
15427 #: build/C/man7/tcp.7:628
15429 "Enable TCP behavior conformant with RFC\\ 1337. When disabled, if a RST is "
15430 "received in TIME_WAIT state, we close the socket immediately without waiting "
15431 "for the end of the TIME_WAIT period."
15435 #: build/C/man7/tcp.7:628
15437 msgid "I<tcp_rmem> (since Linux 2.4)"
15440 #. Since 2.4.0-test7
15441 #. type: Plain text
15442 #: build/C/man7/tcp.7:636
15444 "This is a vector of 3 integers: [min, default, max]. These parameters are "
15445 "used by TCP to regulate receive buffer sizes. TCP dynamically adjusts the "
15446 "size of the receive buffer from the defaults listed below, in the range of "
15447 "these values, depending on memory available in the system."
15451 #: build/C/man7/tcp.7:637 build/C/man7/tcp.7:813 build/C/man7/udp.7:145
15456 #. type: Plain text
15457 #: build/C/man7/tcp.7:652
15459 "minimum size of the receive buffer used by each TCP socket. The default "
15460 "value is the system page size. (On Linux 2.4, the default value is 4K, "
15461 "lowered to B<PAGE_SIZE> bytes in low-memory systems.) This value is used to "
15462 "ensure that in memory pressure mode, allocations below this size will still "
15463 "succeed. This is not used to bound the size of the receive buffer declared "
15464 "using B<SO_RCVBUF> on a socket."
15468 #: build/C/man7/tcp.7:652 build/C/man7/tcp.7:823
15473 #. type: Plain text
15474 #: build/C/man7/tcp.7:666
15476 "the default size of the receive buffer for a TCP socket. This value "
15477 "overwrites the initial default buffer size from the generic global "
15478 "I<net.core.rmem_default> defined for all protocols. The default value is "
15479 "87380 bytes. (On Linux 2.4, this will be lowered to 43689 in low-memory "
15480 "systems.) If larger receive buffer sizes are desired, this value should be "
15481 "increased (to affect all sockets). To employ large TCP windows, the "
15482 "I<net.ipv4.tcp_window_scaling> must be enabled (default)."
15486 #: build/C/man7/tcp.7:666 build/C/man7/tcp.7:837 build/C/man7/udp.7:157
15491 #. type: Plain text
15492 #: build/C/man7/tcp.7:675
15494 "the maximum size of the receive buffer used by each TCP socket. This value "
15495 "does not override the global I<net.core.rmem_max>. This is not used to "
15496 "limit the size of the receive buffer declared using B<SO_RCVBUF> on a "
15497 "socket. The default value is calculated using the formula"
15500 #. type: Plain text
15501 #: build/C/man7/tcp.7:677
15503 msgid " max(87380, min(4MB, I<tcp_mem>[1]*PAGE_SIZE/128))\n"
15506 #. type: Plain text
15507 #: build/C/man7/tcp.7:680
15509 "(On Linux 2.4, the default is 87380*2 bytes, lowered to 87380 in low-memory "
15514 #: build/C/man7/tcp.7:681
15516 msgid "I<tcp_sack> (Boolean; default: enabled; since Linux 2.2)"
15520 #. type: Plain text
15521 #: build/C/man7/tcp.7:685
15522 msgid "Enable RFC\\ 2018 TCP Selective Acknowledgements."
15526 #: build/C/man7/tcp.7:685
15528 msgid "I<tcp_slow_start_after_idle> (Boolean; default: enabled; since Linux 2.6.18)"
15531 #. The following is from 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
15532 #. type: Plain text
15533 #: build/C/man7/tcp.7:693
15535 "If enabled, provide RFC 2861 behavior and time out the congestion window "
15536 "after an idle period. An idle period is defined as the current RTO "
15537 "(retransmission timeout). If disabled, the congestion window will not be "
15538 "timed out after an idle period."
15542 #: build/C/man7/tcp.7:693
15544 msgid "I<tcp_stdurg> (Boolean; default: disabled; since Linux 2.2)"
15548 #. RFC 793 was ambiguous in its specification of the meaning of the
15549 #. urgent pointer. RFC 1122 (and RFC 961) fixed on a particular
15550 #. resolution of this ambiguity (unfortunately the "wrong" one).
15551 #. type: Plain text
15552 #: build/C/man7/tcp.7:707
15554 "If this option is enabled, then use the RFC\\ 1122 interpretation of the TCP "
15555 "urgent-pointer field. According to this interpretation, the urgent pointer "
15556 "points to the last byte of urgent data. If this option is disabled, then "
15557 "use the BSD-compatible interpretation of the urgent pointer: the urgent "
15558 "pointer points to the first byte after the urgent data. Enabling this "
15559 "option may lead to interoperability problems."
15563 #: build/C/man7/tcp.7:707
15565 msgid "I<tcp_syn_retries> (integer; default: 5; since Linux 2.2)"
15569 #. type: Plain text
15570 #: build/C/man7/tcp.7:714
15572 "The maximum number of times initial SYNs for an active TCP connection "
15573 "attempt will be retransmitted. This value should not be higher than 255. "
15574 "The default value is 5, which corresponds to approximately 180 seconds."
15578 #: build/C/man7/tcp.7:714
15580 msgid "I<tcp_synack_retries> (integer; default: 5; since Linux 2.2)"
15584 #. type: Plain text
15585 #: build/C/man7/tcp.7:720
15587 "The maximum number of times a SYN/ACK segment for a passive TCP connection "
15588 "will be retransmitted. This number should not be higher than 255."
15592 #: build/C/man7/tcp.7:720
15594 msgid "I<tcp_syncookies> (Boolean; since Linux 2.2)"
15598 #. type: Plain text
15599 #: build/C/man7/tcp.7:740
15601 "Enable TCP syncookies. The kernel must be compiled with "
15602 "B<CONFIG_SYN_COOKIES>. Send out syncookies when the syn backlog queue of a "
15603 "socket overflows. The syncookies feature attempts to protect a socket from "
15604 "a SYN flood attack. This should be used as a last resort, if at all. This "
15605 "is a violation of the TCP protocol, and conflicts with other areas of TCP "
15606 "such as TCP extensions. It can cause problems for clients and relays. It "
15607 "is not recommended as a tuning mechanism for heavily loaded servers to help "
15608 "with overloaded or misconfigured conditions. For recommended alternatives "
15609 "see I<tcp_max_syn_backlog>, I<tcp_synack_retries>, and "
15610 "I<tcp_abort_on_overflow>."
15614 #: build/C/man7/tcp.7:740
15616 msgid "I<tcp_timestamps> (Boolean; default: enabled; since Linux 2.2)"
15620 #. type: Plain text
15621 #: build/C/man7/tcp.7:744
15622 msgid "Enable RFC\\ 1323 TCP timestamps."
15626 #: build/C/man7/tcp.7:744
15628 msgid "I<tcp_tso_win_divisor> (integer; default: 3; since Linux 2.6.9)"
15631 #. type: Plain text
15632 #: build/C/man7/tcp.7:750
15634 "This parameter controls what percentage of the congestion window can be "
15635 "consumed by a single TCP Segmentation Offload (TSO) frame. The setting of "
15636 "this parameter is a tradeoff between burstiness and building larger TSO "
15641 #: build/C/man7/tcp.7:750
15643 msgid "I<tcp_tw_recycle> (Boolean; default: disabled; since Linux 2.4)"
15648 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
15649 #. type: Plain text
15650 #: build/C/man7/tcp.7:759
15652 "Enable fast recycling of TIME_WAIT sockets. Enabling this option is not "
15653 "recommended since this causes problems when working with NAT (Network "
15654 "Address Translation)."
15658 #: build/C/man7/tcp.7:759
15660 msgid "I<tcp_tw_reuse> (Boolean; default: disabled; since Linux 2.4.19/2.6)"
15663 #. Since 2.4.19/2.5.43
15665 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
15666 #. type: Plain text
15667 #: build/C/man7/tcp.7:767
15669 "Allow to reuse TIME_WAIT sockets for new connections when it is safe from "
15670 "protocol viewpoint. It should not be changed without advice/request of "
15671 "technical experts."
15675 #: build/C/man7/tcp.7:767
15677 msgid "I<tcp_vegas_cong_avoid> (Boolean; default: disabled; Linux 2.2 to 2.6.13)"
15680 #. Since 2.1.8; removed in 2.6.13
15682 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
15683 #. type: Plain text
15684 #: build/C/man7/tcp.7:778
15686 "Enable TCP Vegas congestion avoidance algorithm. TCP Vegas is a sender-side "
15687 "only change to TCP that anticipates the onset of congestion by estimating "
15688 "the bandwidth. TCP Vegas adjusts the sending rate by modifying the "
15689 "congestion window. TCP Vegas should provide less packet loss, but it is not "
15690 "as aggressive as TCP Reno."
15694 #: build/C/man7/tcp.7:778
15696 msgid "I<tcp_westwood> (Boolean; default: disabled; Linux 2.4.26/2.6.3 to 2.6.13)"
15699 #. type: Plain text
15700 #: build/C/man7/tcp.7:790
15702 "Enable TCP Westwood+ congestion control algorithm. TCP Westwood+ is a "
15703 "sender-side only modification of the TCP Reno protocol stack that optimizes "
15704 "the performance of TCP congestion control. It is based on end-to-end "
15705 "bandwidth estimation to set congestion window and slow start threshold after "
15706 "a congestion episode. Using this estimation, TCP Westwood+ adaptively sets "
15707 "a slow start threshold and a congestion window which takes into account the "
15708 "bandwidth used at the time congestion is experienced. TCP Westwood+ "
15709 "significantly increases fairness with respect to TCP Reno in wired networks "
15710 "and throughput over wireless links."
15714 #: build/C/man7/tcp.7:790
15716 msgid "I<tcp_window_scaling> (Boolean; default: enabled; since Linux 2.2)"
15720 #. type: Plain text
15721 #: build/C/man7/tcp.7:804
15723 "Enable RFC\\ 1323 TCP window scaling. This feature allows the use of a "
15724 "large window (E<gt> 64K) on a TCP connection, should the other end support "
15725 "it. Normally, the 16 bit window length field in the TCP header limits the "
15726 "window size to less than 64K bytes. If larger windows are desired, "
15727 "applications can increase the size of their socket buffers and the window "
15728 "scaling option will be employed. If I<tcp_window_scaling> is disabled, TCP "
15729 "will not negotiate the use of window scaling with the other end during "
15730 "connection setup."
15734 #: build/C/man7/tcp.7:804
15736 msgid "I<tcp_wmem> (since Linux 2.4)"
15739 #. Since 2.4.0-test7
15740 #. type: Plain text
15741 #: build/C/man7/tcp.7:812
15743 "This is a vector of 3 integers: [min, default, max]. These parameters are "
15744 "used by TCP to regulate send buffer sizes. TCP dynamically adjusts the size "
15745 "of the send buffer from the default values listed below, in the range of "
15746 "these values, depending on memory available."
15749 #. type: Plain text
15750 #: build/C/man7/tcp.7:823
15752 "Minimum size of the send buffer used by each TCP socket. The default value "
15753 "is the system page size. (On Linux 2.4, the default value is 4K bytes.) "
15754 "This value is used to ensure that in memory pressure mode, allocations below "
15755 "this size will still succeed. This is not used to bound the size of the "
15756 "send buffer declared using B<SO_SNDBUF> on a socket."
15759 #. True in Linux 2.4 and 2.6
15760 #. type: Plain text
15761 #: build/C/man7/tcp.7:837
15763 "The default size of the send buffer for a TCP socket. This value overwrites "
15764 "the initial default buffer size from the generic global "
15765 "I</proc/sys/net/core/wmem_default> defined for all protocols. The default "
15766 "value is 16K bytes. If larger send buffer sizes are desired, this value "
15767 "should be increased (to affect all sockets). To employ large TCP windows, "
15768 "the I</proc/sys/net/ipv4/tcp_window_scaling> must be set to a nonzero value "
15772 #. type: Plain text
15773 #: build/C/man7/tcp.7:846
15775 "The maximum size of the send buffer used by each TCP socket. This value "
15776 "does not override the value in I</proc/sys/net/core/wmem_max>. This is not "
15777 "used to limit the size of the send buffer declared using B<SO_SNDBUF> on a "
15778 "socket. The default value is calculated using the formula"
15781 #. type: Plain text
15782 #: build/C/man7/tcp.7:848
15784 msgid " max(65536, min(4MB, I<tcp_mem>[1]*PAGE_SIZE/128))\n"
15787 #. type: Plain text
15788 #: build/C/man7/tcp.7:851
15790 "(On Linux 2.4, the default value is 128K bytes, lowered 64K depending on "
15791 "low-memory systems.)"
15795 #: build/C/man7/tcp.7:852
15798 "I<tcp_workaround_signed_windows> (Boolean; default: disabled; since Linux "
15802 #. type: Plain text
15803 #: build/C/man7/tcp.7:858
15805 "If enabled, assume that no receipt of a window-scaling option means that the "
15806 "remote TCP is broken and treats the window as a signed quantity. If "
15807 "disabled, assume that the remote TCP is not broken even if we do not receive "
15808 "a window scaling option from it."
15811 #. or SOL_TCP on Linux
15812 #. type: Plain text
15813 #: build/C/man7/tcp.7:876
15815 "To set or get a TCP socket option, call B<getsockopt>(2) to read or "
15816 "B<setsockopt>(2) to write the option with the option level argument set to "
15817 "B<IPPROTO_TCP>. Unless otherwise noted, I<optval> is a pointer to an "
15818 "I<int>. In addition, most B<IPPROTO_IP> socket options are valid on TCP "
15819 "sockets. For more information see B<ip>(7)."
15823 #: build/C/man7/tcp.7:876
15825 msgid "B<TCP_CORK> (since Linux 2.2)"
15828 #. precisely: since 2.1.127
15829 #. type: Plain text
15830 #: build/C/man7/tcp.7:892
15832 "If set, don't send out partial frames. All queued partial frames are sent "
15833 "when the option is cleared again. This is useful for prepending headers "
15834 "before calling B<sendfile>(2), or for throughput optimization. As currently "
15835 "implemented, there is a 200 millisecond ceiling on the time for which output "
15836 "is corked by B<TCP_CORK>. If this ceiling is reached, then queued data is "
15837 "automatically transmitted. This option can be combined with B<TCP_NODELAY> "
15838 "only since Linux 2.5.71. This option should not be used in code intended to "
15843 #: build/C/man7/tcp.7:892
15845 msgid "B<TCP_DEFER_ACCEPT> (since Linux 2.4)"
15848 #. Precisely: since 2.3.38
15849 #. type: Plain text
15850 #: build/C/man7/tcp.7:900
15852 "Allow a listener to be awakened only when data arrives on the socket. Takes "
15853 "an integer value (seconds), this can bound the maximum number of attempts "
15854 "TCP will make to complete the connection. This option should not be used in "
15855 "code intended to be portable."
15859 #: build/C/man7/tcp.7:900
15861 msgid "B<TCP_INFO> (since Linux 2.4)"
15864 #. type: Plain text
15865 #: build/C/man7/tcp.7:906
15867 "Used to collect information about this socket. The kernel returns a "
15868 "I<struct tcp_info> as defined in the file I</usr/include/linux/tcp.h>. This "
15869 "option should not be used in code intended to be portable."
15873 #: build/C/man7/tcp.7:906
15875 msgid "B<TCP_KEEPCNT> (since Linux 2.4)"
15878 #. Precisely: since 2.3.18
15879 #. type: Plain text
15880 #: build/C/man7/tcp.7:913
15882 "The maximum number of keepalive probes TCP should send before dropping the "
15883 "connection. This option should not be used in code intended to be portable."
15887 #: build/C/man7/tcp.7:913
15889 msgid "B<TCP_KEEPIDLE> (since Linux 2.4)"
15892 #. Precisely: since 2.3.18
15893 #. type: Plain text
15894 #: build/C/man7/tcp.7:922
15896 "The time (in seconds) the connection needs to remain idle before TCP starts "
15897 "sending keepalive probes, if the socket option B<SO_KEEPALIVE> has been set "
15898 "on this socket. This option should not be used in code intended to be "
15903 #: build/C/man7/tcp.7:922
15905 msgid "B<TCP_KEEPINTVL> (since Linux 2.4)"
15908 #. Precisely: since 2.3.18
15909 #. type: Plain text
15910 #: build/C/man7/tcp.7:927
15912 "The time (in seconds) between individual keepalive probes. This option "
15913 "should not be used in code intended to be portable."
15917 #: build/C/man7/tcp.7:927
15919 msgid "B<TCP_LINGER2> (since Linux 2.4)"
15922 #. Precisely: since 2.3.41
15923 #. type: Plain text
15924 #: build/C/man7/tcp.7:939
15926 "The lifetime of orphaned FIN_WAIT2 state sockets. This option can be used "
15927 "to override the system-wide setting in the file "
15928 "I</proc/sys/net/ipv4/tcp_fin_timeout> for this socket. This is not to be "
15929 "confused with the B<socket>(7) level option B<SO_LINGER>. This option "
15930 "should not be used in code intended to be portable."
15934 #: build/C/man7/tcp.7:939
15936 msgid "B<TCP_MAXSEG>"
15939 #. Present in Linux 1.0
15940 #. type: Plain text
15941 #: build/C/man7/tcp.7:949
15943 "The maximum segment size for outgoing TCP packets. In Linux 2.2 and "
15944 "earlier, and in Linux 2.6.28 and later, if this option is set before "
15945 "connection establishment, it also changes the MSS value announced to the "
15946 "other end in the initial packet. Values greater than the (eventual) "
15947 "interface MTU have no effect. TCP will also impose its minimum and maximum "
15948 "bounds over the value provided."
15952 #: build/C/man7/tcp.7:949
15954 msgid "B<TCP_NODELAY>"
15957 #. Present in Linux 1.0
15958 #. type: Plain text
15959 #: build/C/man7/tcp.7:966
15961 "If set, disable the Nagle algorithm. This means that segments are always "
15962 "sent as soon as possible, even if there is only a small amount of data. "
15963 "When not set, data is buffered until there is a sufficient amount to send "
15964 "out, thereby avoiding the frequent sending of small packets, which results "
15965 "in poor utilization of the network. This option is overridden by "
15966 "B<TCP_CORK>; however, setting this option forces an explicit flush of "
15967 "pending output, even if B<TCP_CORK> is currently set."
15971 #: build/C/man7/tcp.7:966
15973 msgid "B<TCP_QUICKACK> (since Linux 2.4.4)"
15976 #. type: Plain text
15977 #: build/C/man7/tcp.7:981
15979 "Enable quickack mode if set or disable quickack mode if cleared. In "
15980 "quickack mode, acks are sent immediately, rather than delayed if needed in "
15981 "accordance to normal TCP operation. This flag is not permanent, it only "
15982 "enables a switch to or from quickack mode. Subsequent operation of the TCP "
15983 "protocol will once again enter/leave quickack mode depending on internal "
15984 "protocol processing and factors such as delayed ack timeouts occurring and "
15985 "data transfer. This option should not be used in code intended to be "
15990 #: build/C/man7/tcp.7:981
15992 msgid "B<TCP_SYNCNT> (since Linux 2.4)"
15995 #. Precisely: since 2.3.18
15996 #. type: Plain text
15997 #: build/C/man7/tcp.7:988
15999 "Set the number of SYN retransmits that TCP should send before aborting the "
16000 "attempt to connect. It cannot exceed 255. This option should not be used "
16001 "in code intended to be portable."
16005 #: build/C/man7/tcp.7:988
16007 msgid "B<TCP_WINDOW_CLAMP> (since Linux 2.4)"
16010 #. Precisely: since 2.3.41
16011 #. type: Plain text
16012 #: build/C/man7/tcp.7:995
16014 "Bound the size of the advertised window to this value. The kernel imposes a "
16015 "minimum size of SOCK_MIN_RCVBUF/2. This option should not be used in code "
16016 "intended to be portable."
16020 #: build/C/man7/tcp.7:995 build/C/man7/unix.7:175
16022 msgid "Sockets API"
16025 #. type: Plain text
16026 #: build/C/man7/tcp.7:1004
16028 "TCP provides limited support for out-of-band data, in the form of (a single "
16029 "byte of) urgent data. In Linux this means if the other end sends newer "
16030 "out-of-band data the older urgent data is inserted as normal data into the "
16031 "stream (even when B<SO_OOBINLINE> is not set). This differs from BSD-based "
16035 #. type: Plain text
16036 #: build/C/man7/tcp.7:1011
16038 "Linux uses the BSD compatible interpretation of the urgent pointer field by "
16039 "default. This violates RFC\\ 1122, but is required for interoperability "
16040 "with other stacks. It can be changed via I</proc/sys/net/ipv4/tcp_stdurg>."
16043 #. type: Plain text
16044 #: build/C/man7/tcp.7:1016
16046 "It is possible to peek at out-of-band data using the I<recv>(2) B<MSG_PEEK> "
16050 #. type: Plain text
16051 #: build/C/man7/tcp.7:1032
16053 "Since version 2.4, Linux supports the use of B<MSG_TRUNC> in the I<flags> "
16054 "argument of B<recv>(2) (and B<recvmsg>(2)). This flag causes the received "
16055 "bytes of data to be discarded, rather than passed back in a caller-supplied "
16056 "buffer. Since Linux 2.4.4, B<MSG_PEEK> also has this effect when used in "
16057 "conjunction with B<MSG_OOB> to receive out-of-band data."
16060 #. type: Plain text
16061 #: build/C/man7/tcp.7:1038 build/C/man7/unix.7:288
16063 "The following B<ioctl>(2) calls return information in I<value>. The "
16064 "correct syntax is:"
16067 #. type: Plain text
16068 #: build/C/man7/tcp.7:1043
16071 "B<int>I< value>B<;>\n"
16072 "I<error>B< = ioctl(>I<tcp_socket>B<, >I<ioctl_type>B<, &>I<value>B<);>\n"
16075 #. type: Plain text
16076 #: build/C/man7/tcp.7:1048
16077 msgid "I<ioctl_type> is one of the following:"
16081 #: build/C/man7/tcp.7:1048 build/C/man7/unix.7:298
16086 #. FIXME http://sources.redhat.com/bugzilla/show_bug.cgi?id=12002,
16087 #. filed 2010-09-10, may cause SIOCINQ to be defined in glibc headers
16088 #. SIOCOUTQ also has an effect for UNIX domain sockets, but not
16089 #. quite what userland might expect. It seems to return the number
16090 #. of bytes allocated for buffers containing pending output.
16091 #. That number is normally larger than the number of bytes of pending
16092 #. output. Since this info is, from userland's point of view, imprecise,
16093 #. and it may well change, probably best not to document this now.
16094 #. type: Plain text
16095 #: build/C/man7/tcp.7:1064 build/C/man7/unix.7:320
16097 "Returns the amount of queued unread data in the receive buffer. The socket "
16098 "must not be in LISTEN state, otherwise an error (B<EINVAL>) is returned. "
16099 "B<SIOCINQ> is defined in I<E<lt>linux/sockios.hE<gt>>. Alternatively, you "
16100 "can use the synonymous B<FIONREAD>, defined in I<E<lt>sys/ioctl.hE<gt>>."
16104 #: build/C/man7/tcp.7:1064
16106 msgid "B<SIOCATMARK>"
16109 #. type: Plain text
16110 #: build/C/man7/tcp.7:1069
16112 "Returns true (i.e., I<value> is nonzero) if the inbound data stream is at "
16116 #. type: Plain text
16117 #: build/C/man7/tcp.7:1085
16119 "If the B<SO_OOBINLINE> socket option is set, and B<SIOCATMARK> returns true, "
16120 "then the next read from the socket will return the urgent data. If the "
16121 "B<SO_OOBINLINE> socket option is not set, and B<SIOCATMARK> returns true, "
16122 "then the next read from the socket will return the bytes following the "
16123 "urgent data (to actually read the urgent data requires the B<recv(MSG_OOB)> "
16127 #. type: Plain text
16128 #: build/C/man7/tcp.7:1099
16130 "Note that a read never reads across the urgent mark. If an application is "
16131 "informed of the presence of urgent data via B<select>(2) (using the "
16132 "I<exceptfds> argument) or through delivery of a B<SIGURG> signal, then it "
16133 "can advance up to the mark using a loop which repeatedly tests B<SIOCATMARK> "
16134 "and performs a read (requesting any number of bytes) as long as "
16135 "B<SIOCATMARK> returns false."
16139 #: build/C/man7/tcp.7:1099
16141 msgid "B<SIOCOUTQ>"
16144 #. FIXME http://sources.redhat.com/bugzilla/show_bug.cgi?id=12002,
16145 #. filed 2010-09-10, may cause SIOCOUTQ to be defined in glibc headers
16146 #. type: Plain text
16147 #: build/C/man7/tcp.7:1115
16149 "Returns the amount of unsent data in the socket send queue. The socket must "
16150 "not be in LISTEN state, otherwise an error (B<EINVAL>) is returned. "
16151 "B<SIOCOUTQ> is defined in I<E<lt>linux/sockios.hE<gt>>. Alternatively, you "
16152 "can use the synonymous B<TIOCOUTQ>, defined in I<E<lt>sys/ioctl.hE<gt>>."
16155 #. type: Plain text
16156 #: build/C/man7/tcp.7:1120
16158 "When a network error occurs, TCP tries to resend the packet. If it doesn't "
16159 "succeed after some time, either B<ETIMEDOUT> or the last received error on "
16160 "this connection is reported."
16163 #. type: Plain text
16164 #: build/C/man7/tcp.7:1131
16166 "Some applications require a quicker error notification. This can be enabled "
16167 "with the B<IPPROTO_IP> level B<IP_RECVERR> socket option. When this option "
16168 "is enabled, all incoming errors are immediately passed to the user program. "
16169 "Use this option with care \\(em it makes TCP less tolerant to routing "
16170 "changes and other normal network conditions."
16174 #: build/C/man7/tcp.7:1132
16176 msgid "B<EAFNOTSUPPORT>"
16179 #. type: Plain text
16180 #: build/C/man7/tcp.7:1138
16181 msgid "Passed socket address type in I<sin_family> was not B<AF_INET>."
16184 #. type: Plain text
16185 #: build/C/man7/tcp.7:1142
16187 "The other end closed the socket unexpectedly or a read is executed on a shut "
16192 #: build/C/man7/tcp.7:1142
16194 msgid "B<ETIMEDOUT>"
16197 #. type: Plain text
16198 #: build/C/man7/tcp.7:1145
16199 msgid "The other end didn't acknowledge retransmitted data after some time."
16202 #. type: Plain text
16203 #: build/C/man7/tcp.7:1149
16205 "Any errors defined for B<ip>(7) or the generic socket layer may also be "
16206 "returned for TCP."
16209 #. type: Plain text
16210 #: build/C/man7/tcp.7:1156
16212 "Support for Explicit Congestion Notification, zero-copy B<sendfile>(2), "
16213 "reordering support and some SACK extensions (DSACK) were introduced in 2.4. "
16214 "Support for forward acknowledgement (FACK), TIME_WAIT recycling, and "
16215 "per-connection keepalive socket options were introduced in 2.3."
16218 #. type: Plain text
16219 #: build/C/man7/tcp.7:1158
16220 msgid "Not all errors are documented."
16223 #. Only a single Linux kernel version is described
16224 #. Info for 2.2 was lost. Should be added again,
16225 #. or put into a separate page.
16227 #. This man page was originally written by Andi Kleen.
16228 #. It was updated for 2.4 by Nivedita Singhvi with input from
16229 #. Alexey Kuznetsov's Documentation/networking/ip-sysctl.txt
16231 #. type: Plain text
16232 #: build/C/man7/tcp.7:1168
16233 msgid "IPv6 is not described."
16236 #. type: Plain text
16237 #: build/C/man7/tcp.7:1180
16239 "B<accept>(2), B<bind>(2), B<connect>(2), B<getsockopt>(2), B<listen>(2), "
16240 "B<recvmsg>(2), B<sendfile>(2), B<sendmsg>(2), B<socket>(2), B<ip>(7), "
16244 #. type: Plain text
16245 #: build/C/man7/tcp.7:1182
16246 msgid "RFC\\ 793 for the TCP specification."
16249 #. type: Plain text
16250 #: build/C/man7/tcp.7:1184
16252 "RFC\\ 1122 for the TCP requirements and a description of the Nagle "
16256 #. type: Plain text
16257 #: build/C/man7/tcp.7:1186
16258 msgid "RFC\\ 1323 for TCP timestamp and window scaling options."
16261 #. type: Plain text
16262 #: build/C/man7/tcp.7:1188
16263 msgid "RFC\\ 1337 for a description of TIME_WAIT assassination hazards."
16266 #. type: Plain text
16267 #: build/C/man7/tcp.7:1190
16268 msgid "RFC\\ 3168 for a description of Explicit Congestion Notification."
16271 #. type: Plain text
16272 #: build/C/man7/tcp.7:1192
16273 msgid "RFC\\ 2581 for TCP congestion control algorithms."
16276 #. type: Plain text
16277 #: build/C/man7/tcp.7:1194
16278 msgid "RFC\\ 2018 and RFC\\ 2883 for SACK and extensions to SACK."
16282 #: build/C/man7/udp.7:12
16287 #. type: Plain text
16288 #: build/C/man7/udp.7:15
16289 msgid "udp - User Datagram Protocol for IPv4"
16292 #. type: Plain text
16293 #: build/C/man7/udp.7:21
16294 msgid "B<#include E<lt>netinet/udp.hE<gt>>"
16297 #. type: Plain text
16298 #: build/C/man7/udp.7:23
16299 msgid "B<udp_socket = socket(AF_INET, SOCK_DGRAM, 0);>"
16302 #. type: Plain text
16303 #: build/C/man7/udp.7:29
16305 "This is an implementation of the User Datagram Protocol described in RFC\\ "
16306 "768. It implements a connectionless, unreliable datagram packet service. "
16307 "Packets may be reordered or duplicated before they arrive. UDP generates "
16308 "and checks checksums to catch transmission errors."
16311 #. type: Plain text
16312 #: build/C/man7/udp.7:58
16314 "When a UDP socket is created, its local and remote addresses are "
16315 "unspecified. Datagrams can be sent immediately using B<sendto>(2) or "
16316 "B<sendmsg>(2) with a valid destination address as an argument. When "
16317 "B<connect>(2) is called on the socket, the default destination address is "
16318 "set and datagrams can now be sent using B<send>(2) or B<write>(2) without "
16319 "specifying a destination address. It is still possible to send to other "
16320 "destinations by passing an address to B<sendto>(2) or B<sendmsg>(2). In "
16321 "order to receive packets, the socket can be bound to a local address first "
16322 "by using B<bind>(2). Otherwise the socket layer will automatically assign a "
16323 "free local port out of the range defined by "
16324 "I</proc/sys/net/ipv4/ip_local_port_range> and bind the socket to "
16328 #. type: Plain text
16329 #: build/C/man7/udp.7:66
16331 "All receive operations return only one packet. When the packet is smaller "
16332 "than the passed buffer, only that much data is returned; when it is bigger, "
16333 "the packet is truncated and the B<MSG_TRUNC> flag is set. B<MSG_WAITALL> is "
16337 #. type: Plain text
16338 #: build/C/man7/udp.7:75
16340 "IP options may be sent or received using the socket options described in "
16341 "B<ip>(7). They are processed by the kernel only when the appropriate "
16342 "I</proc> parameter is enabled (but still passed to the user even when it is "
16343 "turned off). See B<ip>(7)."
16346 #. type: Plain text
16347 #: build/C/man7/udp.7:80
16349 "When the B<MSG_DONTROUTE> flag is set on sending, the destination address "
16350 "must refer to a local interface address and the packet is sent only to that "
16354 #. type: Plain text
16355 #: build/C/man7/udp.7:98
16357 "By default, Linux UDP does path MTU (Maximum Transmission Unit) discovery. "
16358 "This means the kernel will keep track of the MTU to a specific target IP "
16359 "address and return B<EMSGSIZE> when a UDP packet write exceeds it. When "
16360 "this happens, the application should decrease the packet size. Path MTU "
16361 "discovery can be also turned off using the B<IP_MTU_DISCOVER> socket option "
16362 "or the I</proc/sys/net/ipv4/ip_no_pmtu_disc> file; see B<ip>(7) for "
16363 "details. When turned off, UDP will fragment outgoing UDP packets that "
16364 "exceed the interface MTU. However, disabling it is not recommended for "
16365 "performance and reliability reasons."
16368 #. type: Plain text
16369 #: build/C/man7/udp.7:103
16370 msgid "UDP uses the IPv4 I<sockaddr_in> address format described in B<ip>(7)."
16373 #. type: Plain text
16374 #: build/C/man7/udp.7:114
16376 "All fatal errors will be passed to the user as an error return even when the "
16377 "socket is not connected. This includes asynchronous errors received from "
16378 "the network. You may get an error for an earlier packet that was sent on "
16379 "the same socket. This behavior differs from many other BSD socket "
16380 "implementations which don't pass any errors unless the socket is connected. "
16381 "Linux's behavior is mandated by B<RFC\\ 1122>."
16384 #. type: Plain text
16385 #: build/C/man7/udp.7:128
16387 "For compatibility with legacy code, in Linux 2.0 and 2.2 it was possible to "
16388 "set the B<SO_BSDCOMPAT> B<SOL_SOCKET> option to receive remote errors only "
16389 "when the socket has been connected (except for B<EPROTO> and B<EMSGSIZE>). "
16390 "Locally generated errors are always passed. Support for this socket option "
16391 "was removed in later kernels; see B<socket>(7) for further information."
16394 #. type: Plain text
16395 #: build/C/man7/udp.7:137
16397 "When the B<IP_RECVERR> option is enabled, all errors are stored in the "
16398 "socket error queue, and can be received by B<recvmsg>(2) with the "
16399 "B<MSG_ERRQUEUE> flag set."
16402 #. type: Plain text
16403 #: build/C/man7/udp.7:140
16405 "System-wide UDP parameter settings can be accessed by files in the directory "
16406 "I</proc/sys/net/ipv4/>."
16410 #: build/C/man7/udp.7:140
16412 msgid "I<udp_mem> (since Linux 2.6.25)"
16415 #. type: Plain text
16416 #: build/C/man7/udp.7:144
16418 "This is a vector of three integers governing the number of pages allowed for "
16419 "queueing by all UDP sockets."
16422 #. type: Plain text
16423 #: build/C/man7/udp.7:151
16425 "Below this number of pages, UDP is not bothered about its memory appetite. "
16426 "When the amount of memory allocated by UDP exceeds this number, UDP starts "
16427 "to moderate memory usage."
16430 #. type: Plain text
16431 #: build/C/man7/udp.7:157
16433 "This value was introduced to follow the format of I<tcp_mem> (see "
16437 #. type: Plain text
16438 #: build/C/man7/udp.7:160
16439 msgid "Number of pages allowed for queueing by all UDP sockets."
16442 #. type: Plain text
16443 #: build/C/man7/udp.7:164
16445 "Defaults values for these three items are calculated at boot time from the "
16446 "amount of available memory."
16450 #: build/C/man7/udp.7:164
16452 msgid "I<udp_rmem_min> (integer; default value: PAGE_SIZE; since Linux 2.6.25)"
16455 #. type: Plain text
16456 #: build/C/man7/udp.7:171
16458 "Minimal size, in bytes, of receive buffers used by UDP sockets in "
16459 "moderation. Each UDP socket is able to use the size for receiving data, "
16460 "even if total pages of UDP sockets exceed I<udp_mem> pressure."
16464 #: build/C/man7/udp.7:171
16466 msgid "I<udp_wmem_min> (integer; default value: PAGE_SIZE; since Linux 2.6.25)"
16469 #. type: Plain text
16470 #: build/C/man7/udp.7:178
16472 "Minimal size, in bytes, of send buffer used by UDP sockets in moderation. "
16473 "Each UDP socket is able to use the size for sending data, even if total "
16474 "pages of UDP sockets exceed I<udp_mem> pressure."
16477 #. type: Plain text
16478 #: build/C/man7/udp.7:189
16480 "To set or get a UDP socket option, call B<getsockopt>(2) to read or "
16481 "B<setsockopt>(2) to write the option with the option level argument set to "
16482 "B<IPPROTO_UDP>. Unless otherwise noted, I<optval> is a pointer to an "
16487 #: build/C/man7/udp.7:189
16489 msgid "B<UDP_CORK> (since Linux 2.5.44)"
16492 #. FIXME document UDP_ENCAP (new in kernel 2.5.67)
16493 #. From include/linux/udp.h:
16494 #. /* UDP encapsulation types */
16495 #. #define UDP_ENCAP_ESPINUDP_NON_IKE 1 /* draft-ietf-ipsec-nat-t-ike-00/01 */
16496 #. #define UDP_ENCAP_ESPINUDP 2 /* draft-ietf-ipsec-udp-encaps-06 */
16497 #. #define UDP_ENCAP_L2TPINUDP 3 /* rfc2661 */
16498 #. type: Plain text
16499 #: build/C/man7/udp.7:202
16501 "If this option is enabled, then all data output on this socket is "
16502 "accumulated into a single datagram that is transmitted when the option is "
16503 "disabled. This option should not be used in code intended to be portable."
16506 #. type: Plain text
16507 #: build/C/man7/udp.7:206
16508 msgid "These ioctls can be accessed using B<ioctl>(2). The correct syntax is:"
16511 #. type: Plain text
16512 #: build/C/man7/udp.7:211
16515 "B<int>I< value>B<;>\n"
16516 "I<error>B< = ioctl(>I<udp_socket>B<, >I<ioctl_type>B<, &>I<value>B<);>\n"
16520 #: build/C/man7/udp.7:213
16522 msgid "B<FIONREAD> (B<SIOCINQ>)"
16525 #. See http://www.securiteam.com/unixfocus/5KP0I15IKO.html
16526 #. "GNUnet DoS (UDP Socket Unreachable)", 14 May 2006
16527 #. type: Plain text
16528 #: build/C/man7/udp.7:231
16530 "Gets a pointer to an integer as argument. Returns the size of the next "
16531 "pending datagram in the integer in bytes, or 0 when no datagram is pending. "
16532 "B<Warning:> Using B<FIONREAD>, it is impossible to distinguish the case "
16533 "where no datagram is pending from the case where the next pending datagram "
16534 "contains zero bytes of data. It is safer to use B<select>(2), B<poll>(2), "
16535 "or B<epoll>(7) to distinguish these cases."
16539 #: build/C/man7/udp.7:231
16541 msgid "B<TIOCOUTQ> (B<SIOCOUTQ>)"
16544 #. type: Plain text
16545 #: build/C/man7/udp.7:235
16547 "Returns the number of data bytes in the local send queue. Only supported "
16548 "with Linux 2.4 and above."
16551 #. type: Plain text
16552 #: build/C/man7/udp.7:241
16554 "In addition all ioctls documented in B<ip>(7) and B<socket>(7) are "
16558 #. type: Plain text
16559 #: build/C/man7/udp.7:247
16561 "All errors documented for B<socket>(7) or B<ip>(7) may be returned by a "
16562 "send or receive on a UDP socket."
16566 #: build/C/man7/udp.7:247 build/C/man7/unix.7:325
16568 msgid "B<ECONNREFUSED>"
16571 #. type: Plain text
16572 #: build/C/man7/udp.7:251
16574 "No receiver was associated with the destination address. This might be "
16575 "caused by a previous packet sent over the socket."
16579 #. This man page was written by Andi Kleen.
16580 #. type: Plain text
16581 #: build/C/man7/udp.7:256
16582 msgid "B<IP_RECVERR> is a new feature in Linux 2.2."
16585 #. type: Plain text
16586 #: build/C/man7/udp.7:261
16587 msgid "B<ip>(7), B<raw>(7), B<socket>(7), B<udplite>(7)"
16590 #. type: Plain text
16591 #: build/C/man7/udp.7:263
16592 msgid "RFC\\ 768 for the User Datagram Protocol."
16595 #. type: Plain text
16596 #: build/C/man7/udp.7:265
16597 msgid "RFC\\ 1122 for the host requirements."
16600 #. type: Plain text
16601 #: build/C/man7/udp.7:267
16602 msgid "RFC\\ 1191 for a description of path MTU discovery."
16606 #: build/C/man7/udplite.7:27
16612 #: build/C/man7/udplite.7:27
16617 #. type: Plain text
16618 #: build/C/man7/udplite.7:30
16619 msgid "udplite - Lightweight User Datagram Protocol"
16622 #. type: Plain text
16623 #: build/C/man7/udplite.7:38
16624 msgid "B<sockfd = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDPLITE);>"
16627 #. type: Plain text
16628 #: build/C/man7/udplite.7:41
16630 "This is an implementation of the Lightweight User Datagram Protocol "
16631 "(UDP-Lite), as described in RFC\\ 3828."
16634 #. type: Plain text
16635 #: build/C/man7/udplite.7:47
16637 "UDP-Lite is an extension of UDP (RFC\\ 768) to support variable-length "
16638 "checksums. This has advantages for some types of multimedia transport that "
16639 "may be able to make use of slightly damaged datagrams, rather than having "
16640 "them discarded by lower-layer protocols."
16643 #. type: Plain text
16644 #: build/C/man7/udplite.7:53
16646 "The variable-length checksum coverage is set via a B<setsockopt>(2) "
16647 "option. If this option is not set, the only difference to UDP is in using a "
16648 "different IP protocol identifier (IANA number 136)."
16651 #. type: Plain text
16652 #: build/C/man7/udplite.7:58
16654 "The UDP-Lite implementation is a full extension of B<udp>(7), i.e., it "
16655 "shares the same API and API behaviour, and in addition offers two socket "
16656 "options to control the checksum coverage."
16659 #. type: Plain text
16660 #: build/C/man7/udplite.7:67
16662 "UDP-Litev4 uses the I<sockaddr_in> address format described in B<ip>(7). "
16663 "UDP-Litev6 uses the I<sockaddr_in6> address format described in B<ipv6>(7)."
16666 #. type: Plain text
16667 #: build/C/man7/udplite.7:80
16669 "To set or get a UDP-Lite socket option, call B<getsockopt>(2) to read or "
16670 "B<setsockopt>(2) to write the option with the option level argument set to "
16671 "B<IPPROTO_UDPLITE>. In addition, all B<IPPROTO_UDP> socket options are "
16672 "valid on a UDP-Lite socket. See B<udp>(7) for more information."
16675 #. type: Plain text
16676 #: build/C/man7/udplite.7:82
16677 msgid "The following two options are specific to UDP-Lite."
16681 #: build/C/man7/udplite.7:82
16683 msgid "B<UDPLITE_SEND_CSCOV>"
16686 #. type: Plain text
16687 #: build/C/man7/udplite.7:87
16689 "This option sets the sender checksum coverage and takes an I<int> as "
16690 "argument, with a checksum coverage value in the range 0..2^16-1."
16693 #. type: Plain text
16694 #: build/C/man7/udplite.7:91
16696 "A value of 0 means that the entire datagram is always covered. Values from "
16697 "1-7 are illegal (RFC\\ 3828, 3.1) and are rounded up to the minimum coverage "
16701 #. type: Plain text
16702 #: build/C/man7/udplite.7:97
16704 "With regard to IPv6 jumbograms (RFC\\ 2675), the UDP-Litev6 checksum "
16705 "coverage is limited to the first 2^16-1 octets, as per RFC\\ 3828, 3.5. "
16706 "Higher values are therefore silently truncated to 2^16-1. If in doubt, the "
16707 "current coverage value can always be queried using B<getsockopt>(2)."
16711 #: build/C/man7/udplite.7:97
16713 msgid "B<UDPLITE_RECV_CSCOV>"
16716 #. type: Plain text
16717 #: build/C/man7/udplite.7:108
16719 "This is the receiver-side analogue and uses the same argument format and "
16720 "value range as B<UDPLITE_SEND_CSCOV>. This option is not required to enable "
16721 "traffic with partial checksum coverage. Its function is that of a traffic "
16722 "filter: when enabled, it instructs the kernel to drop all packets which have "
16723 "a coverage I<less> than the specified coverage value."
16726 #. SO_NO_CHECK exists and is supported by UDPv4, but is
16727 #. commented out in socket(7), hence also commented out here
16729 #. Since UDP-Lite mandates checksums, checksumming can not be disabled
16734 #. type: Plain text
16735 #: build/C/man7/udplite.7:121
16737 "When the value of B<UDPLITE_RECV_CSCOV> exceeds the actual packet coverage, "
16738 "incoming packets are silently dropped, but may generate a warning message in "
16742 #. type: Plain text
16743 #: build/C/man7/udplite.7:126
16745 "All errors documented for B<udp>(7) may be returned. UDP-Lite does not add "
16749 #. type: Plain text
16750 #: build/C/man7/udplite.7:129
16751 msgid "I</proc/net/snmp> - basic UDP-Litev4 statistics counters."
16754 #. type: Plain text
16755 #: build/C/man7/udplite.7:132
16756 msgid "I</proc/net/snmp6> - basic UDP-Litev6 statistics counters."
16759 #. type: Plain text
16760 #: build/C/man7/udplite.7:134
16761 msgid "UDP-Litev4/v6 first appeared in Linux 2.6.20."
16764 #. FIXME . remove this section once glibc supports UDP-Lite
16765 #. type: Plain text
16766 #: build/C/man7/udplite.7:137
16767 msgid "Where glibc support is missing, the following definitions are needed:"
16770 #. The following two are defined in the kernel in linux/net/udplite.h
16771 #. type: Plain text
16772 #: build/C/man7/udplite.7:144
16775 "#define IPPROTO_UDPLITE 136\n"
16776 "#define UDPLITE_SEND_CSCOV 10\n"
16777 "#define UDPLITE_RECV_CSCOV 11\n"
16780 #. type: Plain text
16781 #: build/C/man7/udplite.7:151
16782 msgid "B<ip>(7), B<ipv6>(7), B<socket>(7), B<udp>(7)"
16785 #. type: Plain text
16786 #: build/C/man7/udplite.7:153
16787 msgid "RFC\\ 3828 for the Lightweight User Datagram Protocol (UDP-Lite)."
16790 #. type: Plain text
16791 #: build/C/man7/udplite.7:156
16792 msgid "I<Documentation/networking/udplite.txt> in the Linux kernel source tree"
16796 #: build/C/man7/unix.7:18
16801 #. type: Plain text
16802 #: build/C/man7/unix.7:21
16803 msgid "unix - sockets for local interprocess communication"
16806 #. type: Plain text
16807 #: build/C/man7/unix.7:25
16808 msgid "B<#include E<lt>sys/un.hE<gt>>"
16811 #. type: Plain text
16812 #: build/C/man7/unix.7:27
16813 msgid "I<unix_socket>B< = socket(AF_UNIX, type, 0);>"
16816 #. type: Plain text
16817 #: build/C/man7/unix.7:29
16818 msgid "I<error>B< = socketpair(AF_UNIX, type, 0, int *>I<sv>B<);>"
16821 #. type: Plain text
16822 #: build/C/man7/unix.7:40
16824 "The B<AF_UNIX> (also known as B<AF_LOCAL>) socket family is used to "
16825 "communicate between processes on the same machine efficiently. "
16826 "Traditionally, UNIX domain sockets can be either unnamed, or bound to a file "
16827 "system pathname (marked as being of type socket). Linux also supports an "
16828 "abstract namespace which is independent of the file system."
16831 #. type: Plain text
16832 #: build/C/man7/unix.7:52
16834 "Valid types are: B<SOCK_STREAM>, for a stream-oriented socket and "
16835 "B<SOCK_DGRAM>, for a datagram-oriented socket that preserves message "
16836 "boundaries (as on most UNIX implementations, UNIX domain datagram sockets "
16837 "are always reliable and don't reorder datagrams); and (since Linux 2.6.4) "
16838 "B<SOCK_SEQPACKET>, for a connection-oriented socket that preserves message "
16839 "boundaries and delivers messages in the order that they were sent."
16842 #. type: Plain text
16843 #: build/C/man7/unix.7:55
16845 "UNIX domain sockets support passing file descriptors or process credentials "
16846 "to other processes using ancillary data."
16849 #. type: Plain text
16850 #: build/C/man7/unix.7:57
16851 msgid "A UNIX domain socket address is represented in the following structure:"
16854 #. type: Plain text
16855 #: build/C/man7/unix.7:61
16857 msgid "#define UNIX_PATH_MAX 108\n"
16860 #. type: Plain text
16861 #: build/C/man7/unix.7:66
16864 "struct sockaddr_un {\n"
16865 " sa_family_t sun_family; /* AF_UNIX */\n"
16866 " char sun_path[UNIX_PATH_MAX]; /* pathname */\n"
16870 #. type: Plain text
16871 #: build/C/man7/unix.7:72
16872 msgid "I<sun_family> always contains B<AF_UNIX>."
16875 #. type: Plain text
16876 #: build/C/man7/unix.7:74
16877 msgid "Three types of address are distinguished in this structure:"
16880 #. type: Plain text
16881 #: build/C/man7/unix.7:89
16883 "I<pathname>: a UNIX domain socket can be bound to a null-terminated file "
16884 "system pathname using B<bind>(2). When the address of the socket is "
16885 "returned by B<getsockname>(2), B<getpeername>(2), and B<accept>(2), its "
16886 "length is I<offsetof(struct sockaddr_un, sun_path) + strlen(sun_path) + 1>, "
16887 "and I<sun_path> contains the null-terminated pathname."
16890 #. There is quite some variation across implementations: FreeBSD
16891 #. says the length is 16 bytes, HP-UX 11 says it's zero bytes.
16892 #. type: Plain text
16893 #: build/C/man7/unix.7:109
16895 "I<unnamed>: A stream socket that has not been bound to a pathname using "
16896 "B<bind>(2) has no name. Likewise, the two sockets created by "
16897 "B<socketpair>(2) are unnamed. When the address of an unnamed socket is "
16898 "returned by B<getsockname>(2), B<getpeername>(2), and B<accept>(2), its "
16899 "length is I<sizeof(sa_family_t)>, and I<sun_path> should not be inspected."
16902 #. type: Plain text
16903 #: build/C/man7/unix.7:135
16905 "I<abstract>: an abstract socket address is distinguished by the fact that "
16906 "I<sun_path[0]> is a null byte (\\(aq\\e0\\(aq). The socket's address in "
16907 "this namespace is given by the additional bytes in I<sun_path> that are "
16908 "covered by the specified length of the address structure. (Null bytes in "
16909 "the name have no special significance.) The name has no connection with "
16910 "file system pathnames. When the address of an abstract socket is returned "
16911 "by B<getsockname>(2), B<getpeername>(2), and B<accept>(2), the returned "
16912 "I<addrlen> is greater than I<sizeof(sa_family_t)> (i.e., greater than 2), "
16913 "and the name of the socket is contained in the first I<(addrlen - "
16914 "sizeof(sa_family_t))> bytes of I<sun_path>. The abstract socket namespace "
16915 "is a nonportable Linux extension."
16918 #. type: Plain text
16919 #: build/C/man7/unix.7:148
16921 "For historical reasons these socket options are specified with a "
16922 "B<SOL_SOCKET> type even though they are B<AF_UNIX> specific. They can be "
16923 "set with B<setsockopt>(2) and read with B<getsockopt>(2) by specifying "
16924 "B<SOL_SOCKET> as the socket family."
16928 #: build/C/man7/unix.7:148
16930 msgid "B<SO_PASSCRED>"
16933 #. type: Plain text
16934 #: build/C/man7/unix.7:155
16936 "Enables the receiving of the credentials of the sending process in an "
16937 "ancillary message. When this option is set and the socket is not yet "
16938 "connected a unique name in the abstract namespace will be generated "
16939 "automatically. Expects an integer boolean flag."
16943 #: build/C/man7/unix.7:155
16945 msgid "Autobind feature"
16948 #. i.e. sizeof(short)
16949 #. type: Plain text
16950 #: build/C/man7/unix.7:175
16952 "If a B<bind>(2) call specifies I<addrlen> as I<sizeof(sa_family_t)>, or the "
16953 "B<SO_PASSCRED> socket option was specified for a socket that was not "
16954 "explicitly bound to an address, then the socket is autobound to an abstract "
16955 "address. The address consists of a null byte followed by 5 bytes in the "
16956 "character set I<[0-9a-f]>. Thus, there is a limit of 2^20 autobind "
16957 "addresses. (From Linux 2.1.15, when the autobind feature was added, 8 bytes "
16958 "were used, and the limit was thus 2^32 autobind addresses. The change to 5 "
16959 "bytes came in Linux 2.3.15.)"
16962 #. type: Plain text
16963 #: build/C/man7/unix.7:178
16965 "The following paragraphs describe domain-specific details and unsupported "
16966 "features of the sockets API for UNIX domain sockets on Linux."
16969 #. type: Plain text
16970 #: build/C/man7/unix.7:186
16972 "UNIX domain sockets do not support the transmission of out-of-band data (the "
16973 "B<MSG_OOB> flag for B<send>(2) and B<recv>(2))."
16976 #. type: Plain text
16977 #: build/C/man7/unix.7:191
16978 msgid "The B<send>(2) B<MSG_MORE> flag is not supported by UNIX domain sockets."
16981 #. type: Plain text
16982 #: build/C/man7/unix.7:199
16984 "The use of B<MSG_TRUNC> in the I<flags> argument of B<recv>(2) is not "
16985 "supported by UNIX domain sockets."
16988 #. type: Plain text
16989 #: build/C/man7/unix.7:211
16991 "The B<SO_SNDBUF> socket option does have an effect for UNIX domain sockets, "
16992 "but the B<SO_RCVBUF> option does not. For datagram sockets, the "
16993 "B<SO_SNDBUF> value imposes an upper limit on the size of outgoing "
16994 "datagrams. This limit is calculated as the doubled (see B<socket>(7)) "
16995 "option value less 32 bytes used for overhead."
16999 #: build/C/man7/unix.7:211
17001 msgid "Ancillary messages"
17004 #. type: Plain text
17005 #: build/C/man7/unix.7:233
17007 "Ancillary data is sent and received using B<sendmsg>(2) and B<recvmsg>(2). "
17008 "For historical reasons the ancillary message types listed below are "
17009 "specified with a B<SOL_SOCKET> type even though they are B<AF_UNIX> "
17010 "specific. To send them set the I<cmsg_level> field of the struct I<cmsghdr> "
17011 "to B<SOL_SOCKET> and the I<cmsg_type> field to the type. For more "
17012 "information see B<cmsg>(3)."
17016 #: build/C/man7/unix.7:233
17018 msgid "B<SCM_RIGHTS>"
17021 #. type: Plain text
17022 #: build/C/man7/unix.7:239
17024 "Send or receive a set of open file descriptors from another process. The "
17025 "data portion contains an integer array of the file descriptors. The passed "
17026 "file descriptors behave as though they have been created with B<dup>(2)."
17030 #: build/C/man7/unix.7:239
17032 msgid "B<SCM_CREDENTIALS>"
17035 #. type: Plain text
17036 #: build/C/man7/unix.7:249
17038 "Send or receive UNIX credentials. This can be used for authentication. The "
17039 "credentials are passed as a I<struct ucred> ancillary message. Thus "
17040 "structure is defined in I<E<lt>sys/socket.hE<gt>> as follows:"
17043 #. type: Plain text
17044 #: build/C/man7/unix.7:257
17048 " pid_t pid; /* process ID of the sending process */\n"
17049 " uid_t uid; /* user ID of the sending process */\n"
17050 " gid_t gid; /* group ID of the sending process */\n"
17054 #. type: Plain text
17055 #: build/C/man7/unix.7:266
17057 "Since glibc 2.8, the B<_GNU_SOURCE> feature test macro must be defined "
17058 "(before including I<any> header files) in order to obtain the definition of "
17062 #. type: Plain text
17063 #: build/C/man7/unix.7:282
17065 "The credentials which the sender specifies are checked by the kernel. A "
17066 "process with effective user ID 0 is allowed to specify values that do not "
17067 "match its own. The sender must specify its own process ID (unless it has "
17068 "the capability B<CAP_SYS_ADMIN>), its user ID, effective user ID, or saved "
17069 "set-user-ID (unless it has B<CAP_SETUID>), and its group ID, effective group "
17070 "ID, or saved set-group-ID (unless it has B<CAP_SETGID>). To receive a "
17071 "I<struct ucred> message the B<SO_PASSCRED> option must be enabled on the "
17075 #. type: Plain text
17076 #: build/C/man7/unix.7:293
17079 "B<int>I< value>B<;>\n"
17080 "I<error>B< = ioctl(>I<unix_socket>B<, >I<ioctl_type>B<, &>I<value>B<);>\n"
17083 #. type: Plain text
17084 #: build/C/man7/unix.7:298
17085 msgid "I<ioctl_type> can be:"
17088 #. type: Plain text
17089 #: build/C/man7/unix.7:325
17091 "The specified local address is already in use or the file system socket "
17092 "object already exists."
17095 #. type: Plain text
17096 #: build/C/man7/unix.7:331
17098 "The remote address specified by B<connect>(2) was not a listening socket. "
17099 "This error can also occur if the target filename is not a socket."
17103 #: build/C/man7/unix.7:331
17105 msgid "B<ECONNRESET>"
17108 #. type: Plain text
17109 #: build/C/man7/unix.7:334
17110 msgid "Remote socket was unexpectedly closed."
17113 #. type: Plain text
17114 #: build/C/man7/unix.7:337
17115 msgid "User memory address was not valid."
17118 #. type: Plain text
17119 #: build/C/man7/unix.7:346
17121 "Invalid argument passed. A common cause is that the value B<AF_UNIX> was "
17122 "not specified in the I<sun_type> field of passed addresses, or the socket "
17123 "was in an invalid state for the applied operation."
17126 #. type: Plain text
17127 #: build/C/man7/unix.7:351
17129 "B<connect>(2) called on an already connected socket or a target address was "
17130 "specified on a connected socket."
17133 #. type: Plain text
17134 #: build/C/man7/unix.7:356
17136 "The pathname in the remote address specified to B<connect>(2) did not "
17141 #: build/C/man7/unix.7:356
17146 #. type: Plain text
17147 #: build/C/man7/unix.7:362
17148 msgid "Socket operation needs a target address, but the socket is not connected."
17151 #. type: Plain text
17152 #: build/C/man7/unix.7:366
17154 "Stream operation called on non-stream oriented socket or tried to use the "
17155 "out-of-band data option."
17158 #. type: Plain text
17159 #: build/C/man7/unix.7:370
17160 msgid "The sender passed invalid credentials in the I<struct ucred>."
17163 #. type: Plain text
17164 #: build/C/man7/unix.7:382
17166 "Remote socket was closed on a stream socket. If enabled, a B<SIGPIPE> is "
17167 "sent as well. This can be avoided by passing the B<MSG_NOSIGNAL> flag to "
17168 "B<sendmsg>(2) or B<recvmsg>(2)."
17172 #: build/C/man7/unix.7:382
17174 msgid "B<EPROTONOSUPPORT>"
17177 #. type: Plain text
17178 #: build/C/man7/unix.7:386
17179 msgid "Passed protocol is not B<AF_UNIX>."
17183 #: build/C/man7/unix.7:386
17185 msgid "B<EPROTOTYPE>"
17188 #. type: Plain text
17189 #: build/C/man7/unix.7:392
17191 "Remote socket does not match the local socket type (B<SOCK_DGRAM> versus "
17195 #. type: Plain text
17196 #: build/C/man7/unix.7:395
17197 msgid "Unknown socket type."
17200 #. type: Plain text
17201 #: build/C/man7/unix.7:399
17203 "Other errors can be generated by the generic socket layer or by the file "
17204 "system while generating a file system socket object. See the appropriate "
17205 "manual pages for more information."
17208 #. type: Plain text
17209 #: build/C/man7/unix.7:405
17211 "B<SCM_CREDENTIALS> and the abstract namespace were introduced with Linux 2.2 "
17212 "and should not be used in portable programs. (Some BSD-derived systems also "
17213 "support credential passing, but the implementation details differ.)"
17216 #. type: Plain text
17217 #: build/C/man7/unix.7:416
17219 "In the Linux implementation, sockets which are visible in the file system "
17220 "honor the permissions of the directory they are in. Their owner, group and "
17221 "their permissions can be changed. Creation of a new socket will fail if the "
17222 "process does not have write and search (execute) permission on the directory "
17223 "the socket is created in. Connecting to the socket object requires "
17224 "read/write permission. This behavior differs from many BSD-derived systems "
17225 "which ignore permissions for UNIX domain sockets. Portable programs should "
17226 "not rely on this feature for security."
17229 #. type: Plain text
17230 #: build/C/man7/unix.7:424
17232 "Binding to a socket with a filename creates a socket in the file system that "
17233 "must be deleted by the caller when it is no longer needed (using "
17234 "B<unlink>(2)). The usual UNIX close-behind semantics apply; the socket can "
17235 "be unlinked at any time and will be finally removed from the file system "
17236 "when the last reference to it is closed."
17239 #. type: Plain text
17240 #: build/C/man7/unix.7:433
17242 "To pass file descriptors or credentials over a B<SOCK_STREAM>, you need to "
17243 "send or receive at least one byte of nonancillary data in the same "
17244 "B<sendmsg>(2) or B<recvmsg>(2) call."
17247 #. type: Plain text
17248 #: build/C/man7/unix.7:435
17249 msgid "UNIX domain stream sockets do not support the notion of out-of-band data."
17252 #. type: Plain text
17253 #: build/C/man7/unix.7:438
17254 msgid "See B<bind>(2)."
17257 #. type: Plain text
17258 #: build/C/man7/unix.7:443
17259 msgid "For an example of the use of B<SCM_RIGHTS> see B<cmsg>(3)."
17262 #. type: Plain text
17263 #: build/C/man7/unix.7:452
17265 "B<recvmsg>(2), B<sendmsg>(2), B<socket>(2), B<socketpair>(2), B<cmsg>(3), "
17266 "B<capabilities>(7), B<credentials>(7), B<socket>(7)"
17270 #: build/C/man7/x25.7:12
17275 #. type: Plain text
17276 #: build/C/man7/x25.7:15
17277 msgid "x25 - ITU-T X.25 / ISO-8208 protocol interface."
17280 #. type: Plain text
17281 #: build/C/man7/x25.7:19
17282 msgid "B<#include E<lt>linux/x25.hE<gt>>"
17285 #. type: Plain text
17286 #: build/C/man7/x25.7:21
17287 msgid "B<x25_socket = socket(AF_X25, SOCK_SEQPACKET, 0);>"
17290 #. type: Plain text
17291 #: build/C/man7/x25.7:30
17293 "X25 sockets provide an interface to the X.25 packet layer protocol. This "
17294 "allows applications to communicate over a public X.25 data network as "
17295 "standardized by International Telecommunication Union's recommendation X.25 "
17296 "(X.25 DTE-DCE mode). X25 sockets can also be used for communication without "
17297 "an intermediate X.25 network (X.25 DTE-DTE mode) as described in ISO-8208."
17300 #. type: Plain text
17301 #: build/C/man7/x25.7:47
17303 "Message boundaries are preserved \\(em a B<read>(2) from a socket will "
17304 "retrieve the same chunk of data as output with the corresponding B<write>(2) "
17305 "to the peer socket. When necessary, the kernel takes care of segmenting and "
17306 "reassembling long messages by means of the X.25 M-bit. There is no "
17307 "hard-coded upper limit for the message size. However, reassembling of a "
17308 "long message might fail if there is a temporary lack of system resources or "
17309 "when other constraints (such as socket memory or buffer size limits) become "
17310 "effective. If that occurs, the X.25 connection will be reset."
17314 #: build/C/man7/x25.7:47
17316 msgid "Socket addresses"
17319 #. type: Plain text
17320 #: build/C/man7/x25.7:54
17322 "The B<AF_X25> socket address family uses the I<struct sockaddr_x25> for "
17323 "representing network addresses as defined in ITU-T recommendation X.121."
17326 #. type: Plain text
17327 #: build/C/man7/x25.7:61
17330 "struct sockaddr_x25 {\n"
17331 " sa_family_t sx25_family; /* must be AF_X25 */\n"
17332 " x25_address sx25_addr; /* X.121 Address */\n"
17336 #. type: Plain text
17337 #: build/C/man7/x25.7:72
17339 "I<sx25_addr> contains a char array I<x25_addr[]> to be interpreted as a "
17340 "null-terminated string. I<sx25_addr.x25_addr[]> consists of up to 15 (not "
17341 "counting the terminating null byte) ASCII characters forming the X.121 "
17342 "address. Only the decimal digit characters from \\(aq0\\(aq to \\(aq9\\(aq "
17346 #. type: Plain text
17347 #: build/C/man7/x25.7:81
17349 "The following X.25-specific socket options can be set by using "
17350 "B<setsockopt>(2) and read with B<getsockopt>(2) with the I<level> argument "
17351 "set to B<SOL_X25>."
17355 #: build/C/man7/x25.7:81
17357 msgid "B<X25_QBITINCL>"
17360 #. type: Plain text
17361 #: build/C/man7/x25.7:100
17363 "Controls whether the X.25 Q-bit (Qualified Data Bit) is accessible by the "
17364 "user. It expects an integer argument. If set to 0 (default), the Q-bit is "
17365 "never set for outgoing packets and the Q-bit of incoming packets is "
17366 "ignored. If set to 1, an additional first byte is prepended to each message "
17367 "read from or written to the socket. For data read from the socket, a 0 "
17368 "first byte indicates that the Q-bits of the corresponding incoming data "
17369 "packets were not set. A first byte with value 1 indicates that the Q-bit of "
17370 "the corresponding incoming data packets was set. If the first byte of the "
17371 "data written to the socket is 1 the Q-bit of the corresponding outgoing data "
17372 "packets will be set. If the first byte is 0 the Q-bit will not be set."
17375 #. type: Plain text
17376 #: build/C/man7/x25.7:102
17377 msgid "The AF_X25 protocol family is a new feature of Linux 2.2."
17380 #. type: Plain text
17381 #: build/C/man7/x25.7:105
17382 msgid "Plenty, as the X.25 PLP implementation is B<CONFIG_EXPERIMENTAL>."
17385 #. type: Plain text
17386 #: build/C/man7/x25.7:107
17387 msgid "This man page is incomplete."
17390 #. type: Plain text
17391 #: build/C/man7/x25.7:114
17393 "There is no dedicated application programmer's header file yet; you need to "
17394 "include the kernel header file I<E<lt>linux/x25.hE<gt>>. "
17395 "B<CONFIG_EXPERIMENTAL> might also imply that future versions of the "
17396 "interface are not binary compatible."
17399 #. type: Plain text
17400 #: build/C/man7/x25.7:118
17402 "X.25 N-Reset events are not propagated to the user process yet. Thus, if a "
17403 "reset occurred, data might be lost without notice."
17406 #. type: Plain text
17407 #: build/C/man7/x25.7:121
17408 msgid "B<socket>(2), B<socket>(7)"
17411 #. type: Plain text
17412 #: build/C/man7/x25.7:127
17414 "Jonathan Simon Naylor: \\(lqThe Re-Analysis and Re-Implementation of "
17415 "X.25.\\(rq The URL is E<.UR "
17416 "ftp://ftp.pspt.fi\\:/pub\\:/ham\\:/linux\\:/ax25\\:/x25doc.tgz> E<.UE .>"