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: 2012-05-28 07:16+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:9
26 #: build/C/man7/arp.7:9
32 #: build/C/man7/arp.7:9 build/C/man3/cmsg.3:7 build/C/man7/ddp.7:7 build/C/man1/getent.1:23 build/C/man3/getipnodebyname.3:24 build/C/man2/getpeername.2:40 build/C/man5/host.conf.5:26 build/C/man7/hostname.7:37 build/C/man5/hosts.5:27 build/C/man5/hosts.equiv.5:3 build/C/man7/icmp.7:7 build/C/man3/inet_ntop.3:24 build/C/man3/inet_pton.3:25 build/C/man7/ip.7:12 build/C/man7/ipv6.7:7 build/C/man7/netdevice.7:15 build/C/man5/nsswitch.conf.5:24 build/C/man7/packet.7:7 build/C/man5/protocols.5:28 build/C/man7/raw.7:9 build/C/man3/rcmd.3:41 build/C/man3/rexec.3:39 build/C/man5/services.5:34 build/C/man2/shutdown.2:38 build/C/man7/tcp.7:16 build/C/man7/udp.7:8 build/C/man7/udplite.7:25 build/C/man7/unix.7:15 build/C/man7/x25.7:7
38 #: build/C/man7/arp.7:9 build/C/man3/byteorder.3:30 build/C/man3/cmsg.3:7 build/C/man7/ddp.7:7 build/C/man3/endian.3:26 build/C/man3/ether_aton.3:31 build/C/man3/getaddrinfo.3:41 build/C/man3/getaddrinfo_a.3:27 build/C/man3/gethostbyname.3:36 build/C/man3/getipnodebyname.3:24 build/C/man3/getnameinfo.3:7 build/C/man3/getnetent.3:28 build/C/man3/getnetent_r.3:24 build/C/man2/getpeername.2:40 build/C/man3/getprotoent.3:28 build/C/man3/getprotoent_r.3:24 build/C/man3/getservent.3:32 build/C/man3/getservent_r.3:24 build/C/man7/hostname.7:37 build/C/man5/hosts.5:27 build/C/man5/hosts.equiv.5:3 build/C/man7/icmp.7:7 build/C/man3/inet.3:42 build/C/man3/inet_ntop.3:24 build/C/man3/inet_pton.3:25 build/C/man7/ip.7:12 build/C/man7/ipv6.7:7 build/C/man7/netdevice.7:15 build/C/man8/nscd.8:23 build/C/man5/nscd.conf.5:20 build/C/man5/nsswitch.conf.5:24 build/C/man7/packet.7:7 build/C/man5/protocols.5:28 build/C/man7/raw.7:9 build/C/man3/rcmd.3:41 build/C/man5/resolv.conf.5:21 build/C/man3/resolver.3:30 build/C/man3/rexec.3:39 build/C/man5/services.5:34 build/C/man3/setnetgrent.3:5 build/C/man2/shutdown.2:38 build/C/man7/tcp.7:16 build/C/man7/udp.7:8 build/C/man7/udplite.7:25 build/C/man7/unix.7:15 build/C/man7/x25.7:7
40 msgid "Linux Programmer's Manual"
44 #: build/C/man7/arp.7:10 build/C/man3/byteorder.3:31 build/C/man3/cmsg.3:8 build/C/man7/ddp.7:8 build/C/man3/endian.3:27 build/C/man3/ether_aton.3:32 build/C/man3/getaddrinfo.3:42 build/C/man3/getaddrinfo_a.3:28 build/C/man1/getent.1:24 build/C/man3/gethostbyname.3:37 build/C/man3/getipnodebyname.3:25 build/C/man3/getnameinfo.3:8 build/C/man3/getnetent.3:29 build/C/man3/getnetent_r.3:25 build/C/man2/getpeername.2:41 build/C/man3/getprotoent.3:29 build/C/man3/getprotoent_r.3:25 build/C/man3/getservent.3:33 build/C/man3/getservent_r.3:25 build/C/man5/host.conf.5:27 build/C/man7/hostname.7:38 build/C/man5/hosts.5:28 build/C/man5/hosts.equiv.5:4 build/C/man7/icmp.7:8 build/C/man3/inet.3:43 build/C/man3/inet_ntop.3:25 build/C/man3/inet_pton.3:26 build/C/man7/ip.7:13 build/C/man7/ipv6.7:8 build/C/man7/netdevice.7:16 build/C/man5/networks.5:25 build/C/man8/nscd.8:24 build/C/man5/nscd.conf.5:21 build/C/man5/nsswitch.conf.5:25 build/C/man7/packet.7:8 build/C/man5/protocols.5:29 build/C/man7/raw.7:10 build/C/man3/rcmd.3:42 build/C/man5/resolv.conf.5:23 build/C/man3/resolver.3:31 build/C/man3/rexec.3:40 build/C/man5/services.5:35 build/C/man3/setnetgrent.3:6 build/C/man2/shutdown.2:39 build/C/man7/tcp.7:17 build/C/man7/udp.7:9 build/C/man7/udplite.7:26 build/C/man7/unix.7:16 build/C/man7/x25.7:8
50 #: build/C/man7/arp.7:12
51 msgid "arp - Linux ARP kernel module."
55 #: build/C/man7/arp.7:12 build/C/man3/byteorder.3:46 build/C/man3/cmsg.3:33 build/C/man7/ddp.7:18 build/C/man3/endian.3:51 build/C/man3/ether_aton.3:57 build/C/man3/getaddrinfo.3:73 build/C/man3/getaddrinfo_a.3:48 build/C/man1/getent.1:29 build/C/man3/gethostbyname.3:116 build/C/man3/getipnodebyname.3:42 build/C/man3/getnameinfo.3:29 build/C/man3/getnetent.3:46 build/C/man3/getnetent_r.3:60 build/C/man2/getpeername.2:48 build/C/man3/getprotoent.3:46 build/C/man3/getprotoent_r.3:57 build/C/man3/getservent.3:50 build/C/man3/getservent_r.3:57 build/C/man5/host.conf.5:29 build/C/man7/hostname.7:40 build/C/man5/hosts.5:32 build/C/man5/hosts.equiv.5:7 build/C/man7/icmp.7:10 build/C/man3/inet.3:75 build/C/man3/inet_ntop.3:34 build/C/man3/inet_pton.3:34 build/C/man7/ip.7:29 build/C/man7/ipv6.7:20 build/C/man7/netdevice.7:22 build/C/man5/networks.5:27 build/C/man8/nscd.8:26 build/C/man5/nscd.conf.5:23 build/C/man5/nsswitch.conf.5:27 build/C/man7/packet.7:20 build/C/man5/protocols.5:31 build/C/man7/raw.7:18 build/C/man3/rcmd.3:90 build/C/man5/resolv.conf.5:27 build/C/man3/resolver.3:83 build/C/man3/rexec.3:54 build/C/man5/services.5:37 build/C/man3/setnetgrent.3:39 build/C/man2/shutdown.2:45 build/C/man7/tcp.7:27 build/C/man7/udp.7:17 build/C/man7/udplite.7:36 build/C/man7/unix.7:27 build/C/man7/x25.7:16
61 #: build/C/man7/arp.7:20
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:33
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:45
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:68
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 only sent when there is data queued for sending."
106 #: build/C/man7/arp.7:73
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:73 build/C/man7/ddp.7:139 build/C/man7/ip.7:898 build/C/man7/netdevice.7:69 build/C/man7/packet.7:225 build/C/man7/tcp.7:997 build/C/man7/udp.7:192 build/C/man7/unix.7:280
121 #: build/C/man7/arp.7:80
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:90
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:99
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 only be performed by a process with the B<CAP_NET_ADMIN> capability or "
146 "an effective UID of 0."
150 #: build/C/man7/arp.7:109
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:114
160 msgid "I<arp_flags>\n"
164 #: build/C/man7/arp.7:115
166 msgid "flag:meaning\n"
170 #: build/C/man7/arp.7:116
172 msgid "ATF_COM:Lookup complete\n"
176 #: build/C/man7/arp.7:117
178 msgid "ATF_PERM:Permanent entry\n"
182 #: build/C/man7/arp.7:118
184 msgid "ATF_PUBL:Publish entry\n"
188 #: build/C/man7/arp.7:119
190 msgid "ATF_USETRAILERS:Trailers requested\n"
194 #: build/C/man7/arp.7:120
196 msgid "ATF_NETMASK:Use a netmask\n"
200 #: build/C/man7/arp.7:121
202 msgid "ATF_DONTPUB:Don't answer\n"
206 #: build/C/man7/arp.7:135
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:135 build/C/man7/ddp.7:117 build/C/man7/icmp.7:36 build/C/man7/ip.7:774 build/C/man7/tcp.7:159 build/C/man7/udp.7:131
217 msgid "/proc interfaces"
221 #: build/C/man7/arp.7:148
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:148
234 msgid "I<anycast_delay> (since Linux 2.2)"
239 #: build/C/man7/arp.7:155
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:155
249 msgid "I<app_solicit> (since Linux 2.2)"
254 #: build/C/man7/arp.7:162
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:162
264 msgid "I<base_reachable_time> (since Linux 2.2)"
269 #: build/C/man7/arp.7:173
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:173
281 msgid "I<base_reachable_time_ms> (since Linux 2.6.12)"
285 #: build/C/man7/arp.7:179
287 "As for I<base_reachable_time>, but measures time in milliseconds. Defaults "
288 "to 30000 milliseconds."
292 #: build/C/man7/arp.7:179
294 msgid "I<delay_first_probe_time> (since Linux 2.2)"
299 #: build/C/man7/arp.7:185
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:185
308 msgid "I<gc_interval> (since Linux 2.2)"
313 #: build/C/man7/arp.7:191
315 "How frequently the garbage collector for neighbor entries should attempt to "
316 "run. Defaults to 30 seconds."
320 #: build/C/man7/arp.7:191
322 msgid "I<gc_stale_time> (since Linux 2.2)"
327 #: build/C/man7/arp.7:198
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:198
337 msgid "I<gc_thresh1> (since Linux 2.2)"
342 #: build/C/man7/arp.7:205
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:205
352 msgid "I<gc_thresh2> (since Linux 2.2)"
357 #: build/C/man7/arp.7:212
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:212
367 msgid "I<gc_thresh3> (since Linux 2.2)"
372 #: build/C/man7/arp.7:219
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:219
382 msgid "I<locktime> (since Linux 2.2)"
387 #: build/C/man7/arp.7:226
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:226
397 msgid "I<mcast_solicit> (since Linux 2.2)"
402 #: build/C/man7/arp.7:232
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:232
411 msgid "I<proxy_delay> (since Linux 2.2)"
416 #: build/C/man7/arp.7:240
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:240
426 msgid "I<proxy_qlen> (since Linux 2.2)"
431 #: build/C/man7/arp.7:245
433 "The maximum number of packets which may be queued to proxy-ARP addresses. "
438 #: build/C/man7/arp.7:245
440 msgid "I<retrans_time> (since Linux 2.2)"
445 #: build/C/man7/arp.7:252
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:252
454 msgid "I<retrans_time_ms> (since Linux 2.6.12)"
458 #: build/C/man7/arp.7:256
460 "The number of milliseconds to delay before retransmitting a request. "
461 "Defaults to 1000 milliseconds."
465 #: build/C/man7/arp.7:256
467 msgid "I<ucast_solicit> (since Linux 2.2)"
472 #: build/C/man7/arp.7:263
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:263
481 msgid "I<unres_qlen> (since Linux 2.2)"
486 #: build/C/man7/arp.7:269
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:269 build/C/man7/ddp.7:216 build/C/man3/endian.3:72 build/C/man3/getnameinfo.3:200 build/C/man7/icmp.7:155 build/C/man7/ipv6.7:282 build/C/man7/packet.7:277 build/C/man7/raw.7:171 build/C/man3/rcmd.3:260 build/C/man3/rexec.3:136 build/C/man7/tcp.7:1114 build/C/man7/udp.7:241 build/C/man7/udplite.7:142 build/C/man7/unix.7:397 build/C/man7/x25.7:95
499 #: build/C/man7/arp.7:276
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:282
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:286
517 msgid "The I<neigh/*> interfaces did not exist before Linux 2.2."
521 #: build/C/man7/arp.7:286 build/C/man7/ddp.7:239 build/C/man3/ether_aton.3:125 build/C/man3/gethostbyname.3:422 build/C/man3/inet_ntop.3:110 build/C/man3/inet_pton.3:148 build/C/man7/ip.7:1067 build/C/man7/ipv6.7:321 build/C/man7/netdevice.7:321 build/C/man7/packet.7:358 build/C/man7/raw.7:248 build/C/man3/rcmd.3:276 build/C/man3/rexec.3:149 build/C/man7/tcp.7:1121 build/C/man7/udplite.7:124 build/C/man7/x25.7:97
527 #: build/C/man7/arp.7:290
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:296
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:299
546 "This man page mashes IPv4 specific and shared between IPv4 and IPv6 "
547 "functionality together."
551 #: build/C/man7/arp.7:299 build/C/man3/byteorder.3:77 build/C/man3/cmsg.3:213 build/C/man7/ddp.7:244 build/C/man3/endian.3:149 build/C/man3/ether_aton.3:129 build/C/man3/getaddrinfo.3:815 build/C/man3/getaddrinfo_a.3:600 build/C/man1/getent.1:367 build/C/man3/gethostbyname.3:427 build/C/man3/getipnodebyname.3:264 build/C/man3/getnameinfo.3:272 build/C/man3/getnetent.3:133 build/C/man3/getnetent_r.3:143 build/C/man2/getpeername.2:114 build/C/man3/getprotoent.3:122 build/C/man3/getprotoent_r.3:235 build/C/man3/getservent.3:131 build/C/man3/getservent_r.3:239 build/C/man5/host.conf.5:199 build/C/man7/hostname.7:83 build/C/man5/hosts.5:115 build/C/man5/hosts.equiv.5:62 build/C/man7/icmp.7:185 build/C/man3/inet.3:297 build/C/man3/inet_ntop.3:116 build/C/man3/inet_pton.3:213 build/C/man7/ip.7:1086 build/C/man7/ipv6.7:332 build/C/man7/netdevice.7:335 build/C/man5/networks.5:73 build/C/man8/nscd.8:85 build/C/man5/nscd.conf.5:186 build/C/man5/nsswitch.conf.5:339 build/C/man7/packet.7:389 build/C/man5/protocols.5:80 build/C/man7/raw.7:265 build/C/man3/rcmd.3:283 build/C/man5/resolv.conf.5:273 build/C/man3/resolver.3:267 build/C/man3/rexec.3:158 build/C/man5/services.5:209 build/C/man3/setnetgrent.3:102 build/C/man2/shutdown.2:97 build/C/man7/tcp.7:1133 build/C/man7/udp.7:246 build/C/man7/udplite.7:144 build/C/man7/unix.7:441 build/C/man7/x25.7:113
557 #: build/C/man7/arp.7:302
558 msgid "B<capabilities>(7), B<ip>(7)"
562 #: build/C/man7/arp.7:304
563 msgid "RFC\\ 826 for a description of ARP."
567 #: build/C/man7/arp.7:307
569 "RFC\\ 2461 for a description of IPv6 neighbor discovery and the base "
574 #: build/C/man7/arp.7:309
575 msgid "Linux 2.2+ IPv4 ARP uses the IPv6 algorithms when applicable."
579 #: build/C/man7/arp.7:309 build/C/man3/byteorder.3:81 build/C/man3/cmsg.3:218 build/C/man7/ddp.7:249 build/C/man3/endian.3:151 build/C/man3/ether_aton.3:131 build/C/man3/getaddrinfo.3:824 build/C/man3/getaddrinfo_a.3:607 build/C/man1/getent.1:369 build/C/man3/gethostbyname.3:441 build/C/man3/getipnodebyname.3:269 build/C/man3/getnameinfo.3:303 build/C/man3/getnetent.3:140 build/C/man3/getnetent_r.3:146 build/C/man2/getpeername.2:121 build/C/man3/getprotoent.3:127 build/C/man3/getprotoent_r.3:238 build/C/man3/getservent.3:136 build/C/man3/getservent_r.3:242 build/C/man5/host.conf.5:204 build/C/man7/hostname.7:91 build/C/man5/hosts.5:125 build/C/man5/hosts.equiv.5:66 build/C/man7/icmp.7:189 build/C/man3/inet.3:307 build/C/man3/inet_ntop.3:120 build/C/man3/inet_pton.3:217 build/C/man7/ip.7:1104 build/C/man7/ipv6.7:340 build/C/man7/netdevice.7:340 build/C/man5/networks.5:79 build/C/man8/nscd.8:91 build/C/man5/nscd.conf.5:191 build/C/man5/nsswitch.conf.5:342 build/C/man7/packet.7:404 build/C/man5/protocols.5:84 build/C/man7/raw.7:279 build/C/man3/rcmd.3:291 build/C/man5/resolv.conf.5:280 build/C/man3/resolver.3:273 build/C/man3/rexec.3:161 build/C/man5/services.5:221 build/C/man3/setnetgrent.3:106 build/C/man2/shutdown.2:101 build/C/man7/tcp.7:1159 build/C/man7/udp.7:257 build/C/man7/udplite.7:153 build/C/man7/unix.7:450 build/C/man7/x25.7:123
585 #: build/C/man7/arp.7:316 build/C/man3/byteorder.3:88 build/C/man3/cmsg.3:225 build/C/man7/ddp.7:256 build/C/man3/endian.3:158 build/C/man3/ether_aton.3:138 build/C/man3/getaddrinfo.3:831 build/C/man3/getaddrinfo_a.3:614 build/C/man1/getent.1:376 build/C/man3/gethostbyname.3:448 build/C/man3/getipnodebyname.3:276 build/C/man3/getnameinfo.3:310 build/C/man3/getnetent.3:147 build/C/man3/getnetent_r.3:153 build/C/man2/getpeername.2:128 build/C/man3/getprotoent.3:134 build/C/man3/getprotoent_r.3:245 build/C/man3/getservent.3:143 build/C/man3/getservent_r.3:249 build/C/man5/host.conf.5:211 build/C/man7/hostname.7:98 build/C/man5/hosts.5:132 build/C/man5/hosts.equiv.5:73 build/C/man7/icmp.7:196 build/C/man3/inet.3:314 build/C/man3/inet_ntop.3:127 build/C/man3/inet_pton.3:224 build/C/man7/ip.7:1111 build/C/man7/ipv6.7:347 build/C/man7/netdevice.7:347 build/C/man5/networks.5:86 build/C/man8/nscd.8:98 build/C/man5/nscd.conf.5:198 build/C/man5/nsswitch.conf.5:349 build/C/man7/packet.7:411 build/C/man5/protocols.5:91 build/C/man7/raw.7:286 build/C/man3/rcmd.3:298 build/C/man5/resolv.conf.5:287 build/C/man3/resolver.3:280 build/C/man3/rexec.3:168 build/C/man5/services.5:228 build/C/man3/setnetgrent.3:113 build/C/man2/shutdown.2:108 build/C/man7/tcp.7:1166 build/C/man7/udp.7:264 build/C/man7/udplite.7:160 build/C/man7/unix.7:457 build/C/man7/x25.7:130
587 "This page is part of release 3.41 of the Linux I<man-pages> project. A "
588 "description of the project, and information about reporting bugs, can be "
589 "found at http://www.kernel.org/doc/man-pages/."
593 #: build/C/man3/byteorder.3:30
599 #: build/C/man3/byteorder.3:30
605 #: build/C/man3/byteorder.3:30 build/C/man3/endian.3:26 build/C/man3/ether_aton.3:31 build/C/man3/getaddrinfo.3:41 build/C/man3/getaddrinfo_a.3:27 build/C/man3/getnameinfo.3:7 build/C/man3/getnetent.3:28 build/C/man3/getnetent_r.3:24 build/C/man3/getprotoent.3:28 build/C/man3/getprotoent_r.3:24 build/C/man3/getservent.3:32 build/C/man3/getservent_r.3:24 build/C/man3/inet.3:42 build/C/man8/nscd.8:23 build/C/man5/nscd.conf.5:20 build/C/man3/resolver.3:30 build/C/man3/setnetgrent.3:5
611 #: build/C/man3/byteorder.3:34
613 "htonl, htons, ntohl, ntohs - convert values between host and network byte "
618 #: build/C/man3/byteorder.3:34 build/C/man3/cmsg.3:10 build/C/man7/ddp.7:10 build/C/man3/endian.3:31 build/C/man3/ether_aton.3:35 build/C/man3/getaddrinfo.3:45 build/C/man3/getaddrinfo_a.3:31 build/C/man1/getent.1:26 build/C/man3/gethostbyname.3:44 build/C/man3/getipnodebyname.3:28 build/C/man3/getnameinfo.3:10 build/C/man3/getnetent.3:32 build/C/man3/getnetent_r.3:28 build/C/man2/getpeername.2:43 build/C/man3/getprotoent.3:32 build/C/man3/getprotoent_r.3:28 build/C/man3/getservent.3:36 build/C/man3/getservent_r.3:28 build/C/man5/hosts.5:30 build/C/man3/inet.3:46 build/C/man3/inet_ntop.3:27 build/C/man3/inet_pton.3:28 build/C/man7/ip.7:15 build/C/man7/ipv6.7:10 build/C/man7/netdevice.7:18 build/C/man7/packet.7:10 build/C/man7/raw.7:12 build/C/man3/rcmd.3:46 build/C/man5/resolv.conf.5:25 build/C/man3/resolver.3:34 build/C/man3/rexec.3:42 build/C/man3/setnetgrent.3:9 build/C/man2/shutdown.2:41 build/C/man7/tcp.7:19 build/C/man7/udp.7:11 build/C/man7/udplite.7:28 build/C/man7/unix.7:19 build/C/man7/x25.7:10
624 #: build/C/man3/byteorder.3:37 build/C/man3/inet_ntop.3:30 build/C/man3/inet_pton.3:31
626 msgid "B<#include E<lt>arpa/inet.hE<gt>>\n"
630 #: build/C/man3/byteorder.3:39
632 msgid "B<uint32_t htonl(uint32_t >I<hostlong>B<);>\n"
636 #: build/C/man3/byteorder.3:41
638 msgid "B<uint16_t htons(uint16_t >I<hostshort>B<);>\n"
642 #: build/C/man3/byteorder.3:43
644 msgid "B<uint32_t ntohl(uint32_t >I<netlong>B<);>\n"
648 #: build/C/man3/byteorder.3:45
650 msgid "B<uint16_t ntohs(uint16_t >I<netshort>B<);>\n"
654 #: build/C/man3/byteorder.3:51
656 "The B<htonl>() function converts the unsigned integer I<hostlong> from host "
657 "byte order to network byte order."
661 #: build/C/man3/byteorder.3:56
663 "The B<htons>() function converts the unsigned short integer I<hostshort> "
664 "from host byte order to network byte order."
668 #: build/C/man3/byteorder.3:61
670 "The B<ntohl>() function converts the unsigned integer I<netlong> from "
671 "network byte order to host byte order."
675 #: build/C/man3/byteorder.3:66
677 "The B<ntohs>() function converts the unsigned short integer I<netshort> "
678 "from network byte order to host byte order."
682 #: build/C/man3/byteorder.3:70
684 "On the i386 the host byte order is Least Significant Byte first, whereas the "
685 "network byte order, as used on the Internet, is Most Significant Byte first."
689 #: build/C/man3/byteorder.3:70 build/C/man3/cmsg.3:137 build/C/man3/endian.3:74 build/C/man3/ether_aton.3:123 build/C/man3/getaddrinfo.3:582 build/C/man3/getaddrinfo_a.3:303 build/C/man3/gethostbyname.3:301 build/C/man3/getipnodebyname.3:256 build/C/man3/getnameinfo.3:203 build/C/man3/getnetent.3:124 build/C/man3/getnetent_r.3:139 build/C/man2/getpeername.2:99 build/C/man3/getprotoent.3:120 build/C/man3/getprotoent_r.3:129 build/C/man3/getservent.3:129 build/C/man3/getservent_r.3:128 build/C/man3/inet.3:210 build/C/man3/inet_ntop.3:98 build/C/man3/inet_pton.3:127 build/C/man3/rcmd.3:268 build/C/man3/resolver.3:265 build/C/man3/rexec.3:140 build/C/man3/setnetgrent.3:87 build/C/man2/shutdown.2:84
691 msgid "CONFORMING TO"
695 #: build/C/man3/byteorder.3:72 build/C/man3/inet_pton.3:129
696 msgid "POSIX.1-2001."
700 #: build/C/man3/byteorder.3:77
702 "Some systems require the inclusion of I<E<lt>netinet/in.hE<gt>> instead of "
703 "I<E<lt>arpa/inet.hE<gt>>."
707 #: build/C/man3/byteorder.3:81
708 msgid "B<endian>(3), B<gethostbyname>(3), B<getservent>(3)"
712 #: build/C/man3/cmsg.3:7
718 #: build/C/man3/cmsg.3:7 build/C/man7/ddp.7:7
724 #: build/C/man3/cmsg.3:10
725 msgid "CMSG_ALIGN, CMSG_SPACE, CMSG_NXTHDR, CMSG_FIRSTHDR - Access ancillary data"
729 #: build/C/man3/cmsg.3:12 build/C/man7/ddp.7:12 build/C/man2/getpeername.2:45 build/C/man7/ip.7:17 build/C/man7/ipv6.7:12 build/C/man7/raw.7:14 build/C/man2/shutdown.2:43 build/C/man7/tcp.7:21 build/C/man7/udp.7:13 build/C/man7/udplite.7:30 build/C/man7/unix.7:21 build/C/man7/x25.7:12
730 msgid "B<#include E<lt>sys/socket.hE<gt>>"
734 #: build/C/man3/cmsg.3:14
735 msgid "B<struct cmsghdr *CMSG_FIRSTHDR(struct msghdr *>I<msgh>B<);>"
739 #: build/C/man3/cmsg.3:16
741 "B<struct cmsghdr *CMSG_NXTHDR(struct msghdr *>I<msgh>B<, struct cmsghdr "
746 #: build/C/man3/cmsg.3:18
747 msgid "B<size_t CMSG_ALIGN(size_t >I<length>B<);>"
751 #: build/C/man3/cmsg.3:20
752 msgid "B<size_t CMSG_SPACE(size_t >I<length>B<);>"
756 #: build/C/man3/cmsg.3:22
757 msgid "B<size_t CMSG_LEN(size_t >I<length>B<);>"
761 #: build/C/man3/cmsg.3:24
762 msgid "B<unsigned char *CMSG_DATA(struct cmsghdr *>I<cmsg>B<);>"
766 #: build/C/man3/cmsg.3:32
770 " socklen_t cmsg_len; /* data byte count, including header */\n"
771 " int cmsg_level; /* originating protocol */\n"
772 " int cmsg_type; /* protocol-specific type */\n"
773 " /* followed by unsigned char cmsg_data[]; */\n"
778 #: build/C/man3/cmsg.3:47
780 "These macros are used to create and access control messages (also called "
781 "ancillary data) that are not a part of the socket payload. This control "
782 "information may include the interface the packet was received on, various "
783 "rarely used header fields, an extended error description, a set of file "
784 "descriptors or UNIX credentials. For instance, control messages can be used "
785 "to send additional header fields such as IP options. Ancillary data is sent "
786 "by calling B<sendmsg>(2) and received by calling B<recvmsg>(2). See their "
787 "manual pages for more information."
791 #: build/C/man3/cmsg.3:58
793 "Ancillary data is a sequence of I<struct cmsghdr> structures with appended "
794 "data. This sequence should only be accessed using the macros described in "
795 "this manual page and never directly. See the specific protocol man pages "
796 "for the available control message types. The maximum ancillary buffer size "
797 "allowed per socket can be set using I</proc/sys/net/core/optmem_max>; see "
802 #: build/C/man3/cmsg.3:65
804 "B<CMSG_FIRSTHDR>() returns a pointer to the first I<cmsghdr> in the "
805 "ancillary data buffer associated with the passed I<msghdr>."
809 #: build/C/man3/cmsg.3:72
811 "B<CMSG_NXTHDR>() returns the next valid I<cmsghdr> after the passed "
812 "I<cmsghdr>. It returns NULL when there isn't enough space left in the "
817 #: build/C/man3/cmsg.3:77
819 "B<CMSG_ALIGN>(), given a length, returns it including the required "
820 "alignment. This is a constant expression."
824 #: build/C/man3/cmsg.3:82
826 "B<CMSG_SPACE>() returns the number of bytes an ancillary element with "
827 "payload of the passed data length occupies. This is a constant expression."
831 #: build/C/man3/cmsg.3:86
832 msgid "B<CMSG_DATA>() returns a pointer to the data portion of a I<cmsghdr>."
836 #: build/C/man3/cmsg.3:97
838 "B<CMSG_LEN>() returns the value to store in the I<cmsg_len> member of the "
839 "I<cmsghdr> structure, taking into account any necessary alignment. It takes "
840 "the data length as an argument. This is a constant expression."
844 #: build/C/man3/cmsg.3:130
846 "To create ancillary data, first initialize the I<msg_controllen> member of "
847 "the I<msghdr> with the length of the control message buffer. Use "
848 "B<CMSG_FIRSTHDR>() on the I<msghdr> to get the first control message and "
849 "B<CMSG_NXTHDR>() to get all subsequent ones. In each control message, "
850 "initialize I<cmsg_len> (with B<CMSG_LEN>()), the other I<cmsghdr> header "
851 "fields, and the data portion using B<CMSG_DATA>(). Finally, the "
852 "I<msg_controllen> field of the I<msghdr> should be set to the sum of the "
853 "B<CMSG_SPACE>() of the length of all control messages in the buffer. For "
854 "more information on the I<msghdr>, see B<recvmsg>(2)."
858 #: build/C/man3/cmsg.3:137
860 "When the control message buffer is too short to store all messages, the "
861 "B<MSG_CTRUNC> flag is set in the I<msg_flags> member of the I<msghdr>."
865 #: build/C/man3/cmsg.3:142
867 "This ancillary data model conforms to the POSIX.1g draft, 4.4BSD-Lite, the "
868 "IPv6 advanced API described in RFC\\ 2292 and the SUSv2. B<CMSG_ALIGN>() "
869 "is a Linux extension."
873 #: build/C/man3/cmsg.3:142 build/C/man7/ddp.7:221 build/C/man3/endian.3:89 build/C/man3/getaddrinfo.3:587 build/C/man3/getaddrinfo_a.3:306 build/C/man3/gethostbyname.3:325 build/C/man3/getipnodebyname.3:259 build/C/man3/getnameinfo.3:205 build/C/man3/getnetent.3:126 build/C/man2/getpeername.2:103 build/C/man5/host.conf.5:190 build/C/man5/hosts.5:88 build/C/man5/hosts.equiv.5:49 build/C/man7/icmp.7:163 build/C/man3/inet.3:218 build/C/man3/inet_pton.3:129 build/C/man7/ip.7:1006 build/C/man7/ipv6.7:311 build/C/man7/netdevice.7:303 build/C/man8/nscd.8:60 build/C/man5/nsswitch.conf.5:320 build/C/man7/packet.7:295 build/C/man7/raw.7:183 build/C/man3/setnetgrent.3:98 build/C/man2/shutdown.2:88 build/C/man7/unix.7:403
879 #: build/C/man3/cmsg.3:147
881 "For portability, ancillary data should be accessed only using the macros "
882 "described here. B<CMSG_ALIGN>() is a Linux extension and should be not "
883 "used in portable programs."
887 #: build/C/man3/cmsg.3:157
889 "In Linux, B<CMSG_LEN>(), B<CMSG_DATA>(), and B<CMSG_ALIGN>() are constant "
890 "expressions (assuming their argument is constant); this could be used to "
891 "declare the size of global variables. This may be not portable, however."
895 #: build/C/man3/cmsg.3:157 build/C/man3/endian.3:105 build/C/man3/getaddrinfo.3:610 build/C/man3/getaddrinfo_a.3:312 build/C/man3/getnameinfo.3:233 build/C/man3/getprotoent_r.3:133 build/C/man3/getservent_r.3:132 build/C/man5/hosts.5:107 build/C/man3/inet.3:254 build/C/man3/inet_ntop.3:113 build/C/man3/inet_pton.3:154 build/C/man7/unix.7:433
901 #: build/C/man3/cmsg.3:161
902 msgid "This code looks for the B<IP_TTL> option in a received ancillary buffer:"
906 #: build/C/man3/cmsg.3:168
909 "struct msghdr msgh;\n"
910 "struct cmsghdr *cmsg;\n"
912 "int received_ttl;\n"
916 #: build/C/man3/cmsg.3:185
919 "/* Receive auxiliary data in msgh */\n"
920 "for (cmsg = CMSG_FIRSTHDR(&msgh); cmsg != NULL;\n"
921 " cmsg = CMSG_NXTHDR(&msgh,cmsg)) {\n"
922 " if (cmsg-E<gt>cmsg_level == IPPROTO_IP\n"
923 " && cmsg-E<gt>cmsg_type == IP_TTL) {\n"
924 " ttlptr = (int *) CMSG_DATA(cmsg);\n"
925 " received_ttl = *ttlptr;\n"
929 "if (cmsg == NULL) {\n"
931 " * Error: IP_TTL not enabled or small buffer\n"
938 #: build/C/man3/cmsg.3:191
940 "The code below passes an array of file descriptors over a UNIX domain socket "
941 "using B<SCM_RIGHTS>:"
945 #: build/C/man3/cmsg.3:199
948 "struct msghdr msg = {0};\n"
949 "struct cmsghdr *cmsg;\n"
950 "int myfds[NUM_FD]; /* Contains the file descriptors to pass. */\n"
951 "char buf[CMSG_SPACE(sizeof myfds)]; /* ancillary data buffer */\n"
956 #: build/C/man3/cmsg.3:211
959 "msg.msg_control = buf;\n"
960 "msg.msg_controllen = sizeof buf;\n"
961 "cmsg = CMSG_FIRSTHDR(&msg);\n"
962 "cmsg-E<gt>cmsg_level = SOL_SOCKET;\n"
963 "cmsg-E<gt>cmsg_type = SCM_RIGHTS;\n"
964 "cmsg-E<gt>cmsg_len = CMSG_LEN(sizeof(int) * NUM_FD);\n"
965 "/* Initialize the payload: */\n"
966 "fdptr = (int *) CMSG_DATA(cmsg);\n"
967 "memcpy(fdptr, myfds, NUM_FD * sizeof(int));\n"
968 "/* Sum of the length of all control messages in the buffer: */\n"
969 "msg.msg_controllen = cmsg-E<gt>cmsg_len;\n"
973 #: build/C/man3/cmsg.3:216
974 msgid "B<recvmsg>(2), B<sendmsg>(2)"
978 #: build/C/man3/cmsg.3:218
983 #: build/C/man7/ddp.7:7
989 #: build/C/man7/ddp.7:10
990 msgid "ddp - Linux AppleTalk protocol implementation"
994 #: build/C/man7/ddp.7:14
995 msgid "B<#include E<lt>netatalk/at.hE<gt>>"
999 #: build/C/man7/ddp.7:16
1000 msgid "I<ddp_socket>B< = socket(AF_APPLETALK, SOCK_DGRAM, 0);>"
1004 #: build/C/man7/ddp.7:18
1005 msgid "I<raw_socket>B< = socket(AF_APPLETALK, SOCK_RAW, >I<protocol>B<);>"
1009 #: build/C/man7/ddp.7:29
1011 "Linux implements the Appletalk protocols described in I<Inside Appletalk>. "
1012 "Only the DDP layer and AARP are present in the kernel. They are designed to "
1013 "be used via the B<netatalk> protocol libraries. This page documents the "
1014 "interface for those who wish or need to use the DDP layer directly."
1018 #: build/C/man7/ddp.7:34
1020 "The communication between Appletalk and the user program works using a "
1021 "BSD-compatible socket interface. For more information on sockets, see "
1026 #: build/C/man7/ddp.7:55
1028 "An AppleTalk socket is created by calling the B<socket>(2) function with a "
1029 "B<AF_APPLETALK> socket family argument. Valid socket types are "
1030 "B<SOCK_DGRAM> to open a B<ddp> socket or B<SOCK_RAW> to open a B<raw> "
1031 "socket. I<protocol> is the Appletalk protocol to be received or sent. For "
1032 "B<SOCK_RAW> you must specify B<ATPROTO_DDP>."
1036 #: build/C/man7/ddp.7:60
1038 "Raw sockets may be only opened by a process with effective user ID 0 or when "
1039 "the process has the B<CAP_NET_RAW> capability."
1043 #: build/C/man7/ddp.7:60 build/C/man7/ip.7:96 build/C/man7/ipv6.7:63 build/C/man7/raw.7:89 build/C/man7/udp.7:92 build/C/man7/udplite.7:56 build/C/man7/unix.7:53
1045 msgid "Address Format"
1049 #: build/C/man7/ddp.7:63
1051 "An Appletalk socket address is defined as a combination of a network number, "
1052 "a node number, and a port number."
1056 #: build/C/man7/ddp.7:70
1059 "struct at_addr {\n"
1060 " unsigned short s_net;\n"
1061 " unsigned char s_node;\n"
1066 #: build/C/man7/ddp.7:76
1069 "struct sockaddr_atalk {\n"
1070 " sa_family_t sat_family; /* address family */\n"
1071 " unsigned char sat_port; /* port */\n"
1072 " struct at_addr sat_addr; /* net/node */\n"
1076 #. FIXME this doesn't make sense [johnl]
1078 #: build/C/man7/ddp.7:115
1080 "I<sat_family> is always set to B<AF_APPLETALK>. I<sat_port> contains the "
1081 "port. The port numbers below 129 are known as I<reserved ports>. Only "
1082 "processes with the effective user ID 0 or the B<CAP_NET_BIND_SERVICE> "
1083 "capability may B<bind>(2) to these sockets. I<sat_addr> is the host "
1084 "address. The I<net> member of I<struct at_addr> contains the host network "
1085 "in network byte order. The value of B<AT_ANYNET> is a wildcard and also "
1086 "implies \\(lqthis network.\\(rq The I<node> member of I<struct at_addr> "
1087 "contains the host node number. The value of B<AT_ANYNODE> is a wildcard and "
1088 "also implies \\(lqthis node.\\(rq The value of B<ATADDR_BCAST> is a link "
1089 "local broadcast address."
1093 #: build/C/man7/ddp.7:115 build/C/man7/ip.7:197 build/C/man7/ipv6.7:113 build/C/man7/packet.7:174 build/C/man7/raw.7:105 build/C/man7/tcp.7:809 build/C/man7/udp.7:172 build/C/man7/udplite.7:65 build/C/man7/unix.7:133 build/C/man7/x25.7:67
1095 msgid "Socket Options"
1099 #: build/C/man7/ddp.7:117
1100 msgid "No protocol-specific socket options are supported."
1104 #: build/C/man7/ddp.7:123
1106 "IP supports a set of I</proc> interfaces to configure some global AppleTalk "
1107 "parameters. The parameters can be accessed by reading or writing files in "
1108 "the directory I</proc/sys/net/atalk/>."
1112 #: build/C/man7/ddp.7:123
1114 msgid "I<aarp-expiry-time>"
1118 #: build/C/man7/ddp.7:126
1119 msgid "The time interval (in seconds) before an AARP cache entry expires."
1123 #: build/C/man7/ddp.7:126
1125 msgid "I<aarp-resolve-time>"
1129 #: build/C/man7/ddp.7:129
1130 msgid "The time interval (in seconds) before an AARP cache entry is resolved."
1134 #: build/C/man7/ddp.7:129
1136 msgid "I<aarp-retransmit-limit>"
1140 #: build/C/man7/ddp.7:133
1142 "The number of retransmissions of an AARP query before the node is declared "
1147 #: build/C/man7/ddp.7:133
1149 msgid "I<aarp-tick-time>"
1153 #: build/C/man7/ddp.7:136
1154 msgid "The timer rate (in seconds) for the timer driving AARP."
1158 #: build/C/man7/ddp.7:139
1160 "The default values match the specification and should never need to be "
1164 #. FIXME Add a section about multicasting
1166 #: build/C/man7/ddp.7:144
1167 msgid "All ioctls described in B<socket>(7) apply to DDP."
1171 #: build/C/man7/ddp.7:144 build/C/man3/gethostbyname.3:276 build/C/man3/getnetent_r.3:127 build/C/man2/getpeername.2:71 build/C/man3/getprotoent_r.3:117 build/C/man3/getservent_r.3:116 build/C/man3/inet_ntop.3:89 build/C/man7/ip.7:915 build/C/man7/ipv6.7:270 build/C/man7/packet.7:241 build/C/man7/raw.7:140 build/C/man2/shutdown.2:72 build/C/man7/tcp.7:1096 build/C/man7/udp.7:231 build/C/man7/udplite.7:119 build/C/man7/unix.7:318
1177 #: build/C/man7/ddp.7:148 build/C/man7/ip.7:919 build/C/man7/raw.7:141
1183 #: build/C/man7/ddp.7:155
1185 "The user tried to execute an operation without the necessary permissions. "
1186 "These include sending to a broadcast address without having the broadcast "
1187 "flag set, and trying to bind to a reserved port without effective user ID 0 "
1188 "or B<CAP_NET_BIND_SERVICE>."
1192 #: build/C/man7/ddp.7:155 build/C/man7/ip.7:935 build/C/man7/unix.7:319
1194 msgid "B<EADDRINUSE>"
1198 #: build/C/man7/ddp.7:158 build/C/man7/ip.7:938
1199 msgid "Tried to bind to an address already in use."
1203 #: build/C/man7/ddp.7:158 build/C/man7/ip.7:938 build/C/man7/packet.7:242
1205 msgid "B<EADDRNOTAVAIL>"
1209 #: build/C/man7/ddp.7:162 build/C/man7/ip.7:942
1211 "A nonexistent interface was requested or the requested source address was "
1216 #: build/C/man7/ddp.7:162 build/C/man7/ip.7:942
1222 #: build/C/man7/ddp.7:165 build/C/man7/ip.7:945
1223 msgid "Operation on a nonblocking socket would block."
1227 #: build/C/man7/ddp.7:165 build/C/man7/ip.7:945
1233 #: build/C/man7/ddp.7:168
1234 msgid "A connection operation on a nonblocking socket is already in progress."
1238 #: build/C/man7/ddp.7:168 build/C/man7/ip.7:948
1240 msgid "B<ECONNABORTED>"
1244 #: build/C/man7/ddp.7:172 build/C/man7/ip.7:952
1245 msgid "A connection was closed during an B<accept>(2)."
1249 #: build/C/man7/ddp.7:172 build/C/man7/ip.7:952
1251 msgid "B<EHOSTUNREACH>"
1255 #: build/C/man7/ddp.7:175
1256 msgid "No routing table entry matches the destination address."
1260 #: build/C/man7/ddp.7:175 build/C/man2/getpeername.2:83 build/C/man7/ip.7:957 build/C/man7/packet.7:248 build/C/man7/raw.7:148 build/C/man7/unix.7:335
1266 #: build/C/man7/ddp.7:178
1267 msgid "Invalid argument passed."
1271 #: build/C/man7/ddp.7:178 build/C/man7/ip.7:963 build/C/man7/unix.7:344
1277 #: build/C/man7/ddp.7:182 build/C/man7/ip.7:967
1278 msgid "B<connect>(2) was called on an already connected socket."
1282 #: build/C/man7/ddp.7:182 build/C/man7/ip.7:967 build/C/man7/packet.7:251 build/C/man7/raw.7:151
1288 #: build/C/man7/ddp.7:185
1289 msgid "Datagram is bigger than the DDP MTU."
1293 #: build/C/man7/ddp.7:185 build/C/man7/ipv6.7:272 build/C/man7/packet.7:260
1299 #: build/C/man7/ddp.7:188
1300 msgid "Network device not available or not capable of sending IP."
1304 #: build/C/man7/ddp.7:188 build/C/man3/getnetent_r.3:128 build/C/man3/getprotoent_r.3:118 build/C/man3/getservent_r.3:117 build/C/man7/ip.7:975 build/C/man7/packet.7:263 build/C/man7/unix.7:349
1310 #: build/C/man7/ddp.7:192 build/C/man7/ip.7:979
1311 msgid "B<SIOCGSTAMP> was called on a socket where no packet arrived."
1315 #: build/C/man7/ddp.7:192
1317 msgid "B<ENOMEM> and B<ENOBUFS>"
1321 #: build/C/man7/ddp.7:195
1322 msgid "Not enough memory available."
1326 #: build/C/man7/ddp.7:195 build/C/man7/ip.7:979
1332 #: build/C/man7/ddp.7:198 build/C/man7/ip.7:982
1333 msgid "A kernel subsystem was not configured."
1337 #: build/C/man7/ddp.7:198 build/C/man7/ip.7:982
1339 msgid "B<ENOPROTOOPT> and B<EOPNOTSUPP>"
1343 #: build/C/man7/ddp.7:201 build/C/man7/ip.7:985
1344 msgid "Invalid socket option passed."
1348 #: build/C/man7/ddp.7:201 build/C/man2/getpeername.2:91 build/C/man7/ip.7:985 build/C/man7/packet.7:266 build/C/man2/shutdown.2:77 build/C/man7/unix.7:357
1354 #: build/C/man7/ddp.7:205 build/C/man7/ip.7:989
1356 "The operation is only defined on a connected socket, but the socket wasn't "
1361 #: build/C/man7/ddp.7:205 build/C/man7/ip.7:989 build/C/man7/packet.7:272 build/C/man7/raw.7:162 build/C/man7/unix.7:364
1367 #: build/C/man7/ddp.7:210
1369 "User doesn't have permission to set high priority, make a configuration "
1370 "change, or send signals to the requested process or group,"
1374 #: build/C/man7/ddp.7:210 build/C/man7/ip.7:993 build/C/man7/tcp.7:1103 build/C/man7/unix.7:368
1380 #: build/C/man7/ddp.7:213 build/C/man7/ip.7:996
1381 msgid "The connection was unexpectedly closed or shut down by the other end."
1385 #: build/C/man7/ddp.7:213 build/C/man7/ip.7:996 build/C/man7/unix.7:390
1387 msgid "B<ESOCKTNOSUPPORT>"
1391 #: build/C/man7/ddp.7:216
1392 msgid "The socket was unconfigured, or an unknown socket type was requested."
1396 #: build/C/man7/ddp.7:221
1398 "Appletalk is supported by Linux 2.0 or higher. The I</proc> interfaces "
1399 "exist since Linux 2.2."
1403 #: build/C/man7/ddp.7:227
1405 "Be very careful with the B<SO_BROADCAST> option - it is not privileged in "
1406 "Linux. It is easy to overload the network with careless sending to "
1407 "broadcast addresses."
1411 #: build/C/man7/ddp.7:227 build/C/man7/ip.7:1054 build/C/man7/packet.7:326
1413 msgid "Compatibility"
1417 #: build/C/man7/ddp.7:234
1419 "The basic AppleTalk socket interface is compatible with B<netatalk> on "
1420 "BSD-derived systems. Many BSD systems fail to check B<SO_BROADCAST> when "
1421 "sending broadcast frames; this can lead to compatibility problems."
1425 #: build/C/man7/ddp.7:239
1427 "The raw socket mode is unique to Linux and exists to support the alternative "
1428 "CAP package and AppleTalk monitoring tools more easily."
1432 #: build/C/man7/ddp.7:241 build/C/man7/ip.7:1069
1433 msgid "There are too many inconsistent error values."
1437 #: build/C/man7/ddp.7:244
1439 "The ioctls used to configure routing tables, devices, AARP tables and other "
1440 "devices are not yet described."
1444 #: build/C/man7/ddp.7:249
1445 msgid "B<recvmsg>(2), B<sendmsg>(2), B<capabilities>(7), B<socket>(7)"
1449 #: build/C/man3/endian.3:26
1455 #: build/C/man3/endian.3:26 build/C/man3/getnetent_r.3:24 build/C/man3/getprotoent_r.3:24 build/C/man3/getservent_r.3:24
1461 #: build/C/man3/endian.3:31
1463 "htobe16, htole16, be16toh, le16toh, htobe32, htole32, be32toh, le32toh, "
1464 "htobe64, htole64, be64toh, le64toh - convert values between host and "
1465 "big-/little-endian byte order"
1469 #: build/C/man3/endian.3:35
1472 "B<#define _BSD_SOURCE> /* See feature_test_macros(7) */\n"
1473 "B<#include E<lt>endian.hE<gt>>\n"
1477 #: build/C/man3/endian.3:40
1480 "B<uint16_t htobe16(uint16_t >I<host_16bits>B<);>\n"
1481 "B<uint16_t htole16(uint16_t >I<host_16bits>B<);>\n"
1482 "B<uint16_t be16toh(uint16_t >I<big_endian_16bits>B<);>\n"
1483 "B<uint16_t le16toh(uint16_t >I<little_endian_16bits>B<);>\n"
1487 #: build/C/man3/endian.3:45
1490 "B<uint32_t htobe32(uint32_t >I<host_32bits>B<);>\n"
1491 "B<uint32_t htole32(uint32_t >I<host_32bits>B<);>\n"
1492 "B<uint32_t be32toh(uint32_t >I<big_endian_32bits>B<);>\n"
1493 "B<uint32_t le32toh(uint32_t >I<little_endian_32bits>B<);>\n"
1497 #: build/C/man3/endian.3:50
1500 "B<uint64_t htobe64(uint64_t >I<host_64bits>B<);>\n"
1501 "B<uint64_t htole64(uint64_t >I<host_64bits>B<);>\n"
1502 "B<uint64_t be64toh(uint64_t >I<big_endian_64bits>B<);>\n"
1503 "B<uint64_t le64toh(uint64_t >I<little_endian_64bits>B<);>\n"
1507 #: build/C/man3/endian.3:55
1509 "These functions convert the byte encoding of integer values from the byte "
1510 "order that the current CPU (the \"host\") uses, to and from little-endian "
1511 "and big-endian byte order."
1515 #: build/C/man3/endian.3:60
1517 "The number, I<nn>, in the name of each function indicates the size of "
1518 "integer handled by the function, either 16, 32, or 64 bits."
1522 #: build/C/man3/endian.3:63
1524 "The functions with names of the form \"htobeI<nn>\" convert from host byte "
1525 "order to big-endian order."
1529 #: build/C/man3/endian.3:66
1531 "The functions with names of the form \"htoleI<nn>\" convert from host byte "
1532 "order to little-endian order."
1536 #: build/C/man3/endian.3:69
1538 "The functions with names of the form \"beI<nn>toh\" convert from big-endian "
1539 "order to host byte order."
1543 #: build/C/man3/endian.3:72
1545 "The functions with names of the form \"leI<nn>toh\" convert from "
1546 "little-endian order to host byte order."
1550 #: build/C/man3/endian.3:74
1551 msgid "These functions were added to glibc in version 2.9."
1555 #: build/C/man3/endian.3:89
1557 "These functions are nonstandard. Similar functions are present on the BSDs, "
1558 "where the required header file is I<E<lt>sys/endian.hE<gt>> instead of "
1559 "I<E<lt>endian.hE<gt>>. Unfortunately, NetBSD, FreeBSD, and glibc haven't "
1560 "followed the original OpenBSD naming convention for these functions, whereby "
1561 "the I<nn> component always appears at the end of the function name (thus, "
1562 "for example, in NetBSD, FreeBSD, and glibc, the equivalent of OpenBSDs "
1563 "\"betoh32\" is \"be32toh\")."
1567 #: build/C/man3/endian.3:97
1569 "These functions are similar to the older B<byteorder>(3) family of "
1570 "functions. For example, B<be32toh>() is identical to B<ntohl>()B<.>"
1574 #: build/C/man3/endian.3:105
1576 "The advantage of the B<byteorder>(3) functions is that they are standard "
1577 "functions available on all UNIX systems. On the other hand, the fact that "
1578 "they were designed for use in the context of TCP/IP means that they lack the "
1579 "64-bit and little-endian variants described in this page."
1583 #: build/C/man3/endian.3:112
1585 "The program below display the results of converting an integer from host "
1586 "byte order to both little-endian and big-endian byte order. Since host byte "
1587 "order is either little-endian or big-endian, only one of these conversions "
1588 "will have an effect. When we run this program on a little-endian system "
1589 "such as x86-32, we see the following:"
1593 #: build/C/man3/endian.3:119
1597 "x.u32 = 0x44332211\n"
1598 "htole32(x.u32) = 0x44332211\n"
1599 "htobe32(x.u32) = 0x11223344\n"
1603 #: build/C/man3/endian.3:121 build/C/man3/getprotoent_r.3:160 build/C/man3/getservent_r.3:158 build/C/man3/inet.3:270 build/C/man3/inet_pton.3:171
1605 msgid "Program source"
1609 #: build/C/man3/endian.3:128
1612 "#include E<lt>endian.hE<gt>\n"
1613 "#include E<lt>stdint.hE<gt>\n"
1614 "#include E<lt>stdio.hE<gt>\n"
1615 "#include E<lt>stdlib.hE<gt>\n"
1619 #: build/C/man3/endian.3:136
1623 "main(int argc, char *argv[])\n"
1627 "\tuint8_t arr[4];\n"
1632 #: build/C/man3/endian.3:141
1635 " x.arr[0] = 0x11;\t/* Lowest-address byte */\n"
1636 " x.arr[1] = 0x22;\n"
1637 " x.arr[2] = 0x33;\n"
1638 " x.arr[3] = 0x44;\t/* Highest-address byte */\n"
1642 #: build/C/man3/endian.3:145
1645 " printf(\"x.u32 = 0x%x\\en\", x.u32);\n"
1646 " printf(\"htole32(x.u32) = 0x%x\\en\", htole32(x.u32));\n"
1647 " printf(\"htobe32(x.u32) = 0x%x\\en\", htobe32(x.u32));\n"
1651 #: build/C/man3/endian.3:148 build/C/man3/getaddrinfo.3:814 build/C/man3/getprotoent_r.3:234 build/C/man3/getservent_r.3:238 build/C/man3/inet_pton.3:212
1654 " exit(EXIT_SUCCESS);\n"
1659 #: build/C/man3/endian.3:151
1660 msgid "B<byteorder>(3)"
1664 #: build/C/man3/ether_aton.3:31
1670 #: build/C/man3/ether_aton.3:31
1676 #: build/C/man3/ether_aton.3:35
1678 "ether_aton, ether_ntoa, ether_ntohost, ether_hostton, ether_line, "
1679 "ether_ntoa_r, ether_aton_r - Ethernet address manipulation routines"
1683 #: build/C/man3/ether_aton.3:38
1685 msgid "B<#include E<lt>netinet/ether.hE<gt>>\n"
1689 #: build/C/man3/ether_aton.3:40
1691 msgid "B<char *ether_ntoa(const struct ether_addr *>I<addr>B<);>\n"
1695 #: build/C/man3/ether_aton.3:42
1697 msgid "B<struct ether_addr *ether_aton(const char *>I<asc>B<);>\n"
1701 #: build/C/man3/ether_aton.3:44
1704 "B<int ether_ntohost(char *>I<hostname>B<, const struct ether_addr "
1709 #: build/C/man3/ether_aton.3:46
1712 "B<int ether_hostton(const char *>I<hostname>B<, struct ether_addr "
1717 #: build/C/man3/ether_aton.3:49
1720 "B<int ether_line(const char *>I<line>B<, struct ether_addr *>I<addr>B<,>\n"
1721 "B< char *>I<hostname>B<);>\n"
1725 #: build/C/man3/ether_aton.3:51 build/C/man3/gethostbyname.3:68
1727 msgid "/* GNU extensions */\n"
1731 #: build/C/man3/ether_aton.3:53
1734 "B<char *ether_ntoa_r(const struct ether_addr *>I<addr>B<, char "
1739 #: build/C/man3/ether_aton.3:56
1742 "B<struct ether_addr *ether_aton_r(const char *>I<asc>B<,>\n"
1743 "B< struct ether_addr *>I<addr>B<);>\n"
1747 #: build/C/man3/ether_aton.3:66
1749 "B<ether_aton>() converts the 48-bit Ethernet host address I<asc> from the "
1750 "standard hex-digits-and-colons notation into binary data in network byte "
1751 "order and returns a pointer to it in a statically allocated buffer, which "
1752 "subsequent calls will overwrite. B<ether_aton>() returns NULL if the "
1753 "address is invalid."
1757 #: build/C/man3/ether_aton.3:74
1759 "The B<ether_ntoa>() function converts the Ethernet host address I<addr> "
1760 "given in network byte order to a string in standard hex-digits-and-colons "
1761 "notation, omitting leading zeros. The string is returned in a statically "
1762 "allocated buffer, which subsequent calls will overwrite."
1766 #: build/C/man3/ether_aton.3:81
1768 "The B<ether_ntohost>() function maps an Ethernet address to the "
1769 "corresponding hostname in I</etc/ethers> and returns nonzero if it cannot be "
1774 #: build/C/man3/ether_aton.3:88
1776 "The B<ether_hostton>() function maps a hostname to the corresponding "
1777 "Ethernet address in I</etc/ethers> and returns nonzero if it cannot be "
1782 #: build/C/man3/ether_aton.3:100
1784 "The B<ether_line>() function parses a line in I</etc/ethers> format "
1785 "(ethernet address followed by whitespace followed by hostname; \\(aq#\\(aq "
1786 "introduces a comment) and returns an address and hostname pair, or nonzero "
1787 "if it cannot be parsed. The buffer pointed to by I<hostname> must be "
1788 "sufficiently long, for example, have the same length as I<line>."
1792 #: build/C/man3/ether_aton.3:111
1794 "The functions B<ether_ntoa_r>() and B<ether_aton_r>() are reentrant "
1795 "thread-safe versions of B<ether_ntoa>() and B<ether_aton>() respectively, "
1796 "and do not use static buffers."
1800 #: build/C/man3/ether_aton.3:115
1801 msgid "The structure I<ether_addr> is defined in I<E<lt>net/ethernet.hE<gt>> as:"
1805 #: build/C/man3/ether_aton.3:121
1808 "struct ether_addr {\n"
1809 " uint8_t ether_addr_octet[6];\n"
1814 #: build/C/man3/ether_aton.3:125
1815 msgid "4.3BSD, SunOS."
1819 #: build/C/man3/ether_aton.3:129
1820 msgid "The glibc 2.2.5 implementation of B<ether_line>() is broken."
1824 #: build/C/man3/ether_aton.3:131
1825 msgid "B<ethers>(5)"
1829 #: build/C/man3/getaddrinfo.3:41
1835 #: build/C/man3/getaddrinfo.3:41
1841 #: build/C/man3/getaddrinfo.3:45
1843 "getaddrinfo, freeaddrinfo, gai_strerror - network address and service "
1848 #: build/C/man3/getaddrinfo.3:50 build/C/man3/getipnodebyname.3:33
1851 "B<#include E<lt>sys/types.hE<gt>>\n"
1852 "B<#include E<lt>sys/socket.hE<gt>>\n"
1853 "B<#include E<lt>netdb.hE<gt>>\n"
1857 #: build/C/man3/getaddrinfo.3:54
1860 "B<int getaddrinfo(const char *>I<node>B<, const char *>I<service>B<,>\n"
1861 "B< const struct addrinfo *>I<hints>B<,>\n"
1862 "B< struct addrinfo **>I<res>B<);>\n"
1866 #: build/C/man3/getaddrinfo.3:56
1868 msgid "B<void freeaddrinfo(struct addrinfo *>I<res>B<);>\n"
1872 #: build/C/man3/getaddrinfo.3:58
1874 msgid "B<const char *gai_strerror(int >I<errcode>B<);>\n"
1878 #: build/C/man3/getaddrinfo.3:63 build/C/man3/gethostbyname.3:91 build/C/man3/getnameinfo.3:23 build/C/man3/getnetent_r.3:50 build/C/man3/getprotoent_r.3:47 build/C/man3/getservent_r.3:47 build/C/man3/inet.3:70 build/C/man3/rcmd.3:79 build/C/man3/setnetgrent.3:29
1879 msgid "Feature Test Macro Requirements for glibc (see B<feature_test_macros>(7)):"
1883 #: build/C/man3/getaddrinfo.3:69
1884 msgid "B<getaddrinfo>(), B<freeaddrinfo>(), B<gai_strerror>():"
1888 #: build/C/man3/getaddrinfo.3:71
1889 msgid "_POSIX_C_SOURCE\\ E<gt>=\\ 1 || _XOPEN_SOURCE || _POSIX_SOURCE"
1892 #. .BR getipnodebyname (3),
1893 #. .BR getipnodebyaddr (3),
1895 #: build/C/man3/getaddrinfo.3:98
1897 "Given I<node> and I<service>, which identify an Internet host and a service, "
1898 "B<getaddrinfo>() returns one or more I<addrinfo> structures, each of which "
1899 "contains an Internet address that can be specified in a call to B<bind>(2) "
1900 "or B<connect>(2). The B<getaddrinfo>() function combines the functionality "
1901 "provided by the B<getservbyname>(3) and B<getservbyport>(3) functions into "
1902 "a single interface, but unlike the latter functions, B<getaddrinfo>() is "
1903 "reentrant and allows programs to eliminate IPv4-versus-IPv6 dependencies."
1907 #: build/C/man3/getaddrinfo.3:104
1909 "The I<addrinfo> structure used by B<getaddrinfo>() contains the following "
1914 #: build/C/man3/getaddrinfo.3:117
1917 "struct addrinfo {\n"
1920 " int ai_socktype;\n"
1921 " int ai_protocol;\n"
1922 " socklen_t ai_addrlen;\n"
1923 " struct sockaddr *ai_addr;\n"
1924 " char *ai_canonname;\n"
1925 " struct addrinfo *ai_next;\n"
1930 #: build/C/man3/getaddrinfo.3:139
1932 "The I<hints> argument points to an I<addrinfo> structure that specifies "
1933 "criteria for selecting the socket address structures returned in the list "
1934 "pointed to by I<res>. If I<hints> is not NULL it points to an I<addrinfo> "
1935 "structure whose I<ai_family>, I<ai_socktype>, and I<ai_protocol> specify "
1936 "criteria that limit the set of socket addresses returned by "
1937 "B<getaddrinfo>(), as follows:"
1941 #: build/C/man3/getaddrinfo.3:139
1943 msgid "I<ai_family>"
1947 #: build/C/man3/getaddrinfo.3:155
1949 "This field specifies the desired address family for the returned addresses. "
1950 "Valid values for this field include B<AF_INET> and B<AF_INET6>. The value "
1951 "B<AF_UNSPEC> indicates that B<getaddrinfo>() should return socket addresses "
1952 "for any address family (either IPv4 or IPv6, for example) that can be used "
1953 "with I<node> and I<service>."
1957 #: build/C/man3/getaddrinfo.3:155
1959 msgid "I<ai_socktype>"
1963 #: build/C/man3/getaddrinfo.3:164
1965 "This field specifies the preferred socket type, for example B<SOCK_STREAM> "
1966 "or B<SOCK_DGRAM>. Specifying 0 in this field indicates that socket "
1967 "addresses of any type can be returned by B<getaddrinfo>()."
1971 #: build/C/man3/getaddrinfo.3:164
1973 msgid "I<ai_protocol>"
1977 #: build/C/man3/getaddrinfo.3:170
1979 "This field specifies the protocol for the returned socket addresses. "
1980 "Specifying 0 in this field indicates that socket addresses with any protocol "
1981 "can be returned by B<getaddrinfo>()."
1985 #: build/C/man3/getaddrinfo.3:170
1991 #: build/C/man3/getaddrinfo.3:174
1993 "This field specifies additional options, described below. Multiple flags "
1994 "are specified by bitwise OR-ing them together."
1998 #: build/C/man3/getaddrinfo.3:192
2000 "All the other fields in the structure pointed to by I<hints> must contain "
2001 "either 0 or a NULL pointer, as appropriate. Specifying I<hints> as NULL is "
2002 "equivalent to setting I<ai_socktype> and I<ai_protocol> to 0; I<ai_family> "
2003 "to B<AF_UNSPEC>; and I<ai_flags> to B<(AI_V4MAPPED\\ |\\ AI_ADDRCONFIG)>."
2007 #: build/C/man3/getaddrinfo.3:210
2009 "I<node> specifies either a numerical network address (for IPv4, "
2010 "numbers-and-dots notation as supported by B<inet_aton>(3); for IPv6, "
2011 "hexadecimal string format as supported by B<inet_pton>(3)), or a network "
2012 "hostname, whose network addresses are looked up and resolved. If "
2013 "I<hints.ai_flags> contains the B<AI_NUMERICHOST> flag then I<node> must be a "
2014 "numerical network address. The B<AI_NUMERICHOST> flag suppresses any "
2015 "potentially lengthy network host address lookups."
2019 #: build/C/man3/getaddrinfo.3:235
2021 "If the B<AI_PASSIVE> flag is specified in I<hints.ai_flags>, and I<node> is "
2022 "NULL, then the returned socket addresses will be suitable for B<bind>(2)ing "
2023 "a socket that will B<accept>(2) connections. The returned socket address "
2024 "will contain the \"wildcard address\" (B<INADDR_ANY> for IPv4 addresses, "
2025 "B<IN6ADDR_ANY_INIT> for IPv6 address). The wildcard address is used by "
2026 "applications (typically servers) that intend to accept connections on any "
2027 "of the hosts's network addresses. If I<node> is not NULL, then the "
2028 "B<AI_PASSIVE> flag is ignored."
2032 #: build/C/man3/getaddrinfo.3:255
2034 "If the B<AI_PASSIVE> flag is not set in I<hints.ai_flags>, then the returned "
2035 "socket addresses will be suitable for use with B<connect>(2), B<sendto>(2), "
2036 "or B<sendmsg>(2). If I<node> is NULL, then the network address will be set "
2037 "to the loopback interface address (B<INADDR_LOOPBACK> for IPv4 addresses, "
2038 "B<IN6ADDR_LOOPBACK_INIT> for IPv6 address); this is used by applications "
2039 "that intend to communicate with peers running on the same host."
2043 #: build/C/man3/getaddrinfo.3:278
2045 "I<service> sets the port in each returned address structure. If this "
2046 "argument is a service name (see B<services>(5)), it is translated to the "
2047 "corresponding port number. This argument can also be specified as a decimal "
2048 "number, which is simply converted to binary. If I<service> is NULL, then "
2049 "the port number of the returned socket addresses will be left "
2050 "uninitialized. If B<AI_NUMERICSERV> is specified in I<hints.ai_flags> and "
2051 "I<service> is not NULL, then I<service> must point to a string containing a "
2052 "numeric port number. This flag is used to inhibit the invocation of a name "
2053 "resolution service in cases where it is known not to be required."
2057 #: build/C/man3/getaddrinfo.3:284
2058 msgid "Either I<node> or I<service>, but not both, may be NULL."
2062 #: build/C/man3/getaddrinfo.3:300
2064 "The B<getaddrinfo>() function allocates and initializes a linked list of "
2065 "I<addrinfo> structures, one for each network address that matches I<node> "
2066 "and I<service>, subject to any restrictions imposed by I<hints>, and returns "
2067 "a pointer to the start of the list in I<res>. The items in the linked list "
2068 "are linked by the I<ai_next> field."
2072 #: build/C/man3/getaddrinfo.3:322
2074 "There are several reasons why the linked list may have more than one "
2075 "I<addrinfo> structure, including: the network host is multihomed, accessible "
2076 "over multiple protocols (e.g., both B<AF_INET> and B<AF_INET6>); or the same "
2077 "service is available from multiple socket types (one B<SOCK_STREAM> address "
2078 "and another B<SOCK_DGRAM> address, for example). Normally, the application "
2079 "should try using the addresses in the order in which they are returned. The "
2080 "sorting function used within B<getaddrinfo>() is defined in RFC\\ 3484; the "
2081 "order can be tweaked for a particular system by editing I</etc/gai.conf> "
2082 "(available since glibc 2.5)."
2085 #. In glibc prior to 2.3.4, the ai_canonname of each addrinfo
2086 #. structure was set pointing to the canonical name; that was
2087 #. more than POSIX.1-2001 specified, or other implementations provided.
2090 #: build/C/man3/getaddrinfo.3:337
2092 "If I<hints.ai_flags> includes the B<AI_CANONNAME> flag, then the "
2093 "I<ai_canonname> field of the first of the I<addrinfo> structures in the "
2094 "returned list is set to point to the official name of the host."
2098 #: build/C/man3/getaddrinfo.3:341
2100 "The remaining fields of each returned I<addrinfo> structure are initialized "
2105 #: build/C/man3/getaddrinfo.3:341 build/C/man3/getaddrinfo.3:364 build/C/man3/getaddrinfo_a.3:189 build/C/man3/getaddrinfo_a.3:193 build/C/man3/getaddrinfo_a.3:195 build/C/man5/nsswitch.conf.5:138 build/C/man5/nsswitch.conf.5:142 build/C/man7/unix.7:72 build/C/man7/unix.7:87 build/C/man7/unix.7:107
2111 #: build/C/man3/getaddrinfo.3:364
2113 "The I<ai_family>, I<ai_socktype>, and I<ai_protocol> fields return the "
2114 "socket creation parameters (i.e., these fields have the same meaning as the "
2115 "corresponding arguments of B<socket>(2)). For example, I<ai_family> might "
2116 "return B<AF_INET> or B<AF_INET6>; I<ai_socktype> might return B<SOCK_DGRAM> "
2117 "or B<SOCK_STREAM>; and I<ai_protocol> returns the protocol for the socket."
2121 #: build/C/man3/getaddrinfo.3:371
2123 "A pointer to the socket address is placed in the I<ai_addr> field, and the "
2124 "length of the socket address, in bytes, is placed in the I<ai_addrlen> "
2129 #: build/C/man3/getaddrinfo.3:383
2131 "If I<hints.ai_flags> includes the B<AI_ADDRCONFIG> flag, then IPv4 addresses "
2132 "are returned in the list pointed to by I<res> only if the local system has "
2133 "at least one IPv4 address configured, and IPv6 addresses are only returned "
2134 "if the local system has at least one IPv6 address configured. The loopback "
2135 "address is not considered for this case as valid as a configured address."
2139 #: build/C/man3/getaddrinfo.3:408
2141 "If I<hint.ai_flags> specifies the B<AI_V4MAPPED> flag, and "
2142 "I<hints.ai_family> was specified as B<AF_INET6>, and no matching IPv6 "
2143 "addresses could be found, then return IPv4-mapped IPv6 addresses in the list "
2144 "pointed to by I<res>. If both B<AI_V4MAPPED> and B<AI_ALL> are specified in "
2145 "I<hints.ai_flags>, then return both IPv6 and IPv4-mapped IPv6 addresses in "
2146 "the list pointed to by I<res>. B<AI_ALL> is ignored if B<AI_V4MAPPED> is "
2147 "not also specified."
2151 #: build/C/man3/getaddrinfo.3:414
2153 "The B<freeaddrinfo>() function frees the memory that was allocated for the "
2154 "dynamically allocated linked list I<res>."
2158 #: build/C/man3/getaddrinfo.3:414 build/C/man3/getnameinfo.3:114
2160 msgid "Extensions to getaddrinfo() for Internationalized Domain Names"
2164 #: build/C/man3/getaddrinfo.3:423
2166 "Starting with glibc 2.3.4, B<getaddrinfo>() has been extended to "
2167 "selectively allow the incoming and outgoing hostnames to be transparently "
2168 "converted to and from the Internationalized Domain Name (IDN) format (see "
2169 "RFC 3490, I<Internationalizing Domain Names in Applications (IDNA)>). Four "
2170 "new flags are defined:"
2174 #: build/C/man3/getaddrinfo.3:423
2180 #: build/C/man3/getaddrinfo.3:429
2182 "If this flag is specified, then the node name given in I<node> is converted "
2183 "to IDN format if necessary. The source encoding is that of the current "
2187 #. Implementation Detail:
2188 #. To minimize effects on system performance the implementation might
2189 #. want to check whether the input string contains any non-ASCII
2190 #. characters. If there are none the IDN step can be skipped completely.
2191 #. On systems which allow not-ASCII safe encodings for a locale this
2192 #. might be a problem.
2194 #: build/C/man3/getaddrinfo.3:441
2196 "If the input name contains non-ASCII characters, then the IDN encoding is "
2197 "used. Those parts of the node name (delimited by dots) that contain "
2198 "non-ASCII characters are encoded using ASCII Compatible Encoding (ACE) "
2199 "before being passed to the name resolution functions."
2203 #: build/C/man3/getaddrinfo.3:441
2205 msgid "B<AI_CANONIDN>"
2209 #: build/C/man3/getaddrinfo.3:453
2211 "After a successful name lookup, and if the B<AI_CANONNAME> flag was "
2212 "specified, B<getaddrinfo>() will return the canonical name of the node "
2213 "corresponding to the I<addrinfo> structure value passed back. The return "
2214 "value is an exact copy of the value returned by the name resolution "
2219 #. Implementation Detail:
2220 #. If no component of the returned name starts with xn\-\- the IDN
2221 #. step can be skipped, therefore avoiding unnecessary slowdowns.
2223 #: build/C/man3/getaddrinfo.3:466
2225 "If the name is encoded using ACE, then it will contain the I<xn--> prefix "
2226 "for one or more components of the name. To convert these components into a "
2227 "readable form the B<AI_CANONIDN> flag can be passed in addition to "
2228 "B<AI_CANONNAME>. The resulting string is encoded using the current locale's "
2233 #: build/C/man3/getaddrinfo.3:466
2235 msgid "B<AI_IDN_ALLOW_UNASSIGNED>, B<AI_IDN_USE_STD3_ASCII_RULES>"
2239 #: build/C/man3/getaddrinfo.3:473 build/C/man3/getnameinfo.3:136
2241 "Setting these flags will enable the IDNA_ALLOW_UNASSIGNED (allow unassigned "
2242 "Unicode code points) and IDNA_USE_STD3_ASCII_RULES (check output to make "
2243 "sure it is a STD3 conforming hostname) flags respectively to be used in the "
2248 #: build/C/man3/getaddrinfo.3:473 build/C/man3/getaddrinfo_a.3:240 build/C/man3/gethostbyname.3:264 build/C/man3/getipnodebyname.3:184 build/C/man3/getnameinfo.3:136 build/C/man3/getnetent.3:111 build/C/man3/getnetent_r.3:116 build/C/man2/getpeername.2:66 build/C/man3/getprotoent.3:105 build/C/man3/getprotoent_r.3:106 build/C/man3/getservent.3:116 build/C/man3/getservent_r.3:105 build/C/man3/inet_ntop.3:81 build/C/man3/inet_pton.3:114 build/C/man3/rcmd.3:237 build/C/man3/resolver.3:238 build/C/man3/setnetgrent.3:81 build/C/man2/shutdown.2:67
2250 msgid "RETURN VALUE"
2253 #. FIXME glibc defines the following additional errors, some which
2254 #. can probably be returned by getaddrinfo(); they need to
2257 #. #define EAI_INPROGRESS -100 /* Processing request in progress. */
2258 #. #define EAI_CANCELED -101 /* Request canceled. */
2259 #. #define EAI_NOTCANCELED -102 /* Request not canceled. */
2260 #. #define EAI_ALLDONE -103 /* All requests done. */
2261 #. #define EAI_INTR -104 /* Interrupted by a signal. */
2262 #. #define EAI_IDN_ENCODE -105 /* IDN encoding failed. */
2265 #: build/C/man3/getaddrinfo.3:487
2267 "B<getaddrinfo>() returns 0 if it succeeds, or one of the following nonzero "
2272 #: build/C/man3/getaddrinfo.3:487
2274 msgid "B<EAI_ADDRFAMILY>"
2279 #: build/C/man3/getaddrinfo.3:492
2281 "The specified network host does not have any network addresses in the "
2282 "requested address family."
2286 #: build/C/man3/getaddrinfo.3:492 build/C/man3/getaddrinfo_a.3:245 build/C/man3/getaddrinfo_a.3:262 build/C/man3/getnameinfo.3:152
2288 msgid "B<EAI_AGAIN>"
2292 #: build/C/man3/getaddrinfo.3:496
2293 msgid "The name server returned a temporary failure indication. Try again later."
2297 #: build/C/man3/getaddrinfo.3:496 build/C/man3/getnameinfo.3:156
2299 msgid "B<EAI_BADFLAGS>"
2303 #: build/C/man3/getaddrinfo.3:506
2305 "I<hints.ai_flags> contains invalid flags; or, I<hints.ai_flags> included "
2306 "B<AI_CANONNAME> and I<name> was NULL."
2310 #: build/C/man3/getaddrinfo.3:506 build/C/man3/getnameinfo.3:161
2316 #: build/C/man3/getaddrinfo.3:509
2317 msgid "The name server returned a permanent failure indication."
2321 #: build/C/man3/getaddrinfo.3:509 build/C/man3/getnameinfo.3:164
2323 msgid "B<EAI_FAMILY>"
2327 #: build/C/man3/getaddrinfo.3:512
2328 msgid "The requested address family is not supported."
2332 #: build/C/man3/getaddrinfo.3:512 build/C/man3/getaddrinfo_a.3:250 build/C/man3/getnameinfo.3:168
2334 msgid "B<EAI_MEMORY>"
2338 #: build/C/man3/getaddrinfo.3:515 build/C/man3/getaddrinfo_a.3:253 build/C/man3/getnameinfo.3:171 build/C/man7/unix.7:357
2339 msgid "Out of memory."
2343 #: build/C/man3/getaddrinfo.3:515
2345 msgid "B<EAI_NODATA>"
2350 #: build/C/man3/getaddrinfo.3:520
2352 "The specified network host exists, but does not have any network addresses "
2357 #: build/C/man3/getaddrinfo.3:520 build/C/man3/getnameinfo.3:171
2359 msgid "B<EAI_NONAME>"
2363 #: build/C/man3/getaddrinfo.3:537
2365 "The I<node> or I<service> is not known; or both I<node> and I<service> are "
2366 "NULL; or B<AI_NUMERICSERV> was specified in I<hints.ai_flags> and I<service> "
2367 "was not a numeric port-number string."
2371 #: build/C/man3/getaddrinfo.3:537
2373 msgid "B<EAI_SERVICE>"
2377 #: build/C/man3/getaddrinfo.3:558
2379 "The requested service is not available for the requested socket type. It "
2380 "may be available through another socket type. For example, this error could "
2381 "occur if I<service> was \"shell\" (a service only available on stream "
2382 "sockets), and either I<hints.ai_protocol> was B<IPPROTO_UDP>, or "
2383 "I<hints.ai_socktype> was B<SOCK_DGRAM>; or the error could occur if "
2384 "I<service> was not NULL, and I<hints.ai_socktype> was B<SOCK_RAW> (a socket "
2385 "type that does not support the concept of services)."
2389 #: build/C/man3/getaddrinfo.3:558
2391 msgid "B<EAI_SOCKTYPE>"
2395 #: build/C/man3/getaddrinfo.3:570
2397 "The requested socket type is not supported. This could occur, for example, "
2398 "if I<hints.ai_socktype> and I<hints.ai_protocol> are inconsistent (e.g., "
2399 "B<SOCK_DGRAM> and B<IPPROTO_TCP>, respectively)."
2403 #: build/C/man3/getaddrinfo.3:570 build/C/man3/getaddrinfo_a.3:253 build/C/man3/getnameinfo.3:184
2405 msgid "B<EAI_SYSTEM>"
2409 #: build/C/man3/getaddrinfo.3:575
2410 msgid "Other system error, check I<errno> for details."
2414 #: build/C/man3/getaddrinfo.3:580
2416 "The B<gai_strerror>() function translates these error codes to a human "
2417 "readable string, suitable for error reporting."
2421 #: build/C/man3/getaddrinfo.3:580 build/C/man3/gethostbyname.3:291 build/C/man3/getnameinfo.3:194 build/C/man3/getnetent.3:120 build/C/man3/getprotoent.3:114 build/C/man3/getservent.3:125 build/C/man5/host.conf.5:180 build/C/man5/hosts.5:86 build/C/man5/hosts.equiv.5:47 build/C/man5/networks.5:69 build/C/man5/nsswitch.conf.5:285 build/C/man5/protocols.5:76 build/C/man5/resolv.conf.5:270 build/C/man3/resolver.3:260 build/C/man5/services.5:184 build/C/man3/setnetgrent.3:83 build/C/man7/udplite.7:136
2427 #: build/C/man3/getaddrinfo.3:582
2428 msgid "I</etc/gai.conf>"
2432 #: build/C/man3/getaddrinfo.3:587
2433 msgid "POSIX.1-2001. The B<getaddrinfo>() function is documented in RFC\\ 2553."
2437 #: build/C/man3/getaddrinfo.3:592
2439 "B<getaddrinfo>() supports the I<address>B<%>I<scope-id> notation for "
2440 "specifying the IPv6 scope-ID."
2444 #: build/C/man3/getaddrinfo.3:600
2446 "B<AI_ADDRCONFIG>, B<AI_ALL>, and B<AI_V4MAPPED> are available since glibc "
2447 "2.3.3. B<AI_NUMERICSERV> is available since glibc 2.3.4."
2451 #: build/C/man3/getaddrinfo.3:610
2453 "According to POSIX.1-2001, specifying I<hints> as NULL should cause "
2454 "I<ai_flags> to be assumed as 0. The GNU C library instead assumes a value "
2455 "of B<(AI_V4MAPPED\\ |\\ AI_ADDRCONFIG)> for this case, since this value is "
2456 "considered an improvement on the specification."
2459 #. getnameinfo.3 refers to this example
2460 #. socket.2 refers to this example
2461 #. bind.2 refers to this example
2462 #. connect.2 refers to this example
2463 #. recvfrom.2 refers to this example
2464 #. sendto.2 refers to this example
2466 #: build/C/man3/getaddrinfo.3:624
2468 "The following programs demonstrate the use of B<getaddrinfo>(), "
2469 "B<gai_strerror>(), B<freeaddrinfo>(), and B<getnameinfo>(3). The programs "
2470 "are an echo server and client for UDP datagrams."
2474 #: build/C/man3/getaddrinfo.3:624
2476 msgid "Server program"
2480 #: build/C/man3/getaddrinfo.3:634
2483 "#include E<lt>sys/types.hE<gt>\n"
2484 "#include E<lt>stdio.hE<gt>\n"
2485 "#include E<lt>stdlib.hE<gt>\n"
2486 "#include E<lt>unistd.hE<gt>\n"
2487 "#include E<lt>string.hE<gt>\n"
2488 "#include E<lt>sys/socket.hE<gt>\n"
2489 "#include E<lt>netdb.hE<gt>\n"
2493 #: build/C/man3/getaddrinfo.3:636 build/C/man3/getaddrinfo.3:731
2495 msgid "#define BUF_SIZE 500\n"
2499 #: build/C/man3/getaddrinfo.3:647
2503 "main(int argc, char *argv[])\n"
2505 " struct addrinfo hints;\n"
2506 " struct addrinfo *result, *rp;\n"
2508 " struct sockaddr_storage peer_addr;\n"
2509 " socklen_t peer_addr_len;\n"
2511 " char buf[BUF_SIZE];\n"
2515 #: build/C/man3/getaddrinfo.3:652
2518 " if (argc != 2) {\n"
2519 " fprintf(stderr, \"Usage: %s port\\en\", argv[0]);\n"
2520 " exit(EXIT_FAILURE);\n"
2525 #: build/C/man3/getaddrinfo.3:661
2528 " memset(&hints, 0, sizeof(struct addrinfo));\n"
2529 " hints.ai_family = AF_UNSPEC; /* Allow IPv4 or IPv6 */\n"
2530 " hints.ai_socktype = SOCK_DGRAM; /* Datagram socket */\n"
2531 " hints.ai_flags = AI_PASSIVE; /* For wildcard IP address */\n"
2532 " hints.ai_protocol = 0; /* Any protocol */\n"
2533 " hints.ai_canonname = NULL;\n"
2534 " hints.ai_addr = NULL;\n"
2535 " hints.ai_next = NULL;\n"
2539 #: build/C/man3/getaddrinfo.3:667
2542 " s = getaddrinfo(NULL, argv[1], &hints, &result);\n"
2544 " fprintf(stderr, \"getaddrinfo: %s\\en\", gai_strerror(s));\n"
2545 " exit(EXIT_FAILURE);\n"
2550 #: build/C/man3/getaddrinfo.3:672
2553 " /* getaddrinfo() returns a list of address structures.\n"
2554 " Try each address until we successfully bind(2).\n"
2555 " If socket(2) (or bind(2)) fails, we (close the socket\n"
2556 " and) try the next address. */\n"
2560 #: build/C/man3/getaddrinfo.3:678
2563 " for (rp = result; rp != NULL; rp = rp-E<gt>ai_next) {\n"
2564 " sfd = socket(rp-E<gt>ai_family, rp-E<gt>ai_socktype,\n"
2565 " rp-E<gt>ai_protocol);\n"
2571 #: build/C/man3/getaddrinfo.3:681
2574 " if (bind(sfd, rp-E<gt>ai_addr, rp-E<gt>ai_addrlen) == 0)\n"
2575 " break; /* Success */\n"
2579 #: build/C/man3/getaddrinfo.3:684 build/C/man3/getaddrinfo.3:777
2587 #: build/C/man3/getaddrinfo.3:689
2590 " if (rp == NULL) { /* No address succeeded */\n"
2591 " fprintf(stderr, \"Could not bind\\en\");\n"
2592 " exit(EXIT_FAILURE);\n"
2597 #: build/C/man3/getaddrinfo.3:691 build/C/man3/getaddrinfo.3:784
2599 msgid " freeaddrinfo(result); /* No longer needed */\n"
2603 #: build/C/man3/getaddrinfo.3:693
2605 msgid " /* Read datagrams and echo them back to sender */\n"
2609 #: build/C/man3/getaddrinfo.3:700
2613 " peer_addr_len = sizeof(struct sockaddr_storage);\n"
2614 " nread = recvfrom(sfd, buf, BUF_SIZE, 0,\n"
2615 " (struct sockaddr *) &peer_addr, &peer_addr_len);\n"
2616 " if (nread == -1)\n"
2617 " continue; /* Ignore failed request */\n"
2621 #: build/C/man3/getaddrinfo.3:702
2623 msgid " char host[NI_MAXHOST], service[NI_MAXSERV];\n"
2627 #: build/C/man3/getaddrinfo.3:711
2630 " s = getnameinfo((struct sockaddr *) &peer_addr,\n"
2631 " peer_addr_len, host, NI_MAXHOST,\n"
2632 " service, NI_MAXSERV, NI_NUMERICSERV);\n"
2634 " printf(\"Received %ld bytes from %s:%s\\en\",\n"
2635 " (long) nread, host, service);\n"
2637 " fprintf(stderr, \"getnameinfo: %s\\en\", gai_strerror(s));\n"
2641 #: build/C/man3/getaddrinfo.3:718
2644 " if (sendto(sfd, buf, nread, 0,\n"
2645 " (struct sockaddr *) &peer_addr,\n"
2646 " peer_addr_len) != nread)\n"
2647 " fprintf(stderr, \"Error sending response\\en\");\n"
2653 #: build/C/man3/getaddrinfo.3:719
2655 msgid "Client program"
2659 #: build/C/man3/getaddrinfo.3:729
2662 "#include E<lt>sys/types.hE<gt>\n"
2663 "#include E<lt>sys/socket.hE<gt>\n"
2664 "#include E<lt>netdb.hE<gt>\n"
2665 "#include E<lt>stdio.hE<gt>\n"
2666 "#include E<lt>stdlib.hE<gt>\n"
2667 "#include E<lt>unistd.hE<gt>\n"
2668 "#include E<lt>string.hE<gt>\n"
2672 #: build/C/man3/getaddrinfo.3:741
2676 "main(int argc, char *argv[])\n"
2678 " struct addrinfo hints;\n"
2679 " struct addrinfo *result, *rp;\n"
2683 " char buf[BUF_SIZE];\n"
2687 #: build/C/man3/getaddrinfo.3:746
2690 " if (argc E<lt> 3) {\n"
2691 " fprintf(stderr, \"Usage: %s host port msg...\\en\", argv[0]);\n"
2692 " exit(EXIT_FAILURE);\n"
2697 #: build/C/man3/getaddrinfo.3:748
2699 msgid " /* Obtain address(es) matching host/port */\n"
2703 #: build/C/man3/getaddrinfo.3:754
2706 " memset(&hints, 0, sizeof(struct addrinfo));\n"
2707 " hints.ai_family = AF_UNSPEC; /* Allow IPv4 or IPv6 */\n"
2708 " hints.ai_socktype = SOCK_DGRAM; /* Datagram socket */\n"
2709 " hints.ai_flags = 0;\n"
2710 " hints.ai_protocol = 0; /* Any protocol */\n"
2714 #: build/C/man3/getaddrinfo.3:760
2717 " s = getaddrinfo(argv[1], argv[2], &hints, &result);\n"
2719 " fprintf(stderr, \"getaddrinfo: %s\\en\", gai_strerror(s));\n"
2720 " exit(EXIT_FAILURE);\n"
2725 #: build/C/man3/getaddrinfo.3:765
2728 " /* getaddrinfo() returns a list of address structures.\n"
2729 " Try each address until we successfully connect(2).\n"
2730 " If socket(2) (or connect(2)) fails, we (close the socket\n"
2731 " and) try the next address. */\n"
2735 #: build/C/man3/getaddrinfo.3:771
2738 " for (rp = result; rp != NULL; rp = rp-E<gt>ai_next) {\n"
2739 " sfd = socket(rp-E<gt>ai_family, rp-E<gt>ai_socktype,\n"
2740 " rp-E<gt>ai_protocol);\n"
2746 #: build/C/man3/getaddrinfo.3:774
2749 " if (connect(sfd, rp-E<gt>ai_addr, rp-E<gt>ai_addrlen) != -1)\n"
2750 " break; /* Success */\n"
2754 #: build/C/man3/getaddrinfo.3:782
2757 " if (rp == NULL) { /* No address succeeded */\n"
2758 " fprintf(stderr, \"Could not connect\\en\");\n"
2759 " exit(EXIT_FAILURE);\n"
2764 #: build/C/man3/getaddrinfo.3:787
2767 " /* Send remaining command-line arguments as separate\n"
2768 " datagrams, and read responses from server */\n"
2772 #: build/C/man3/getaddrinfo.3:791
2775 " for (j = 3; j E<lt> argc; j++) {\n"
2776 " len = strlen(argv[j]) + 1;\n"
2777 " /* +1 for terminating null byte */\n"
2781 #: build/C/man3/getaddrinfo.3:797
2784 " if (len + 1 E<gt> BUF_SIZE) {\n"
2785 " fprintf(stderr,\n"
2786 " \"Ignoring long message in argument %d\\en\", j);\n"
2792 #: build/C/man3/getaddrinfo.3:802
2795 " if (write(sfd, argv[j], len) != len) {\n"
2796 " fprintf(stderr, \"partial/failed write\\en\");\n"
2797 " exit(EXIT_FAILURE);\n"
2802 #: build/C/man3/getaddrinfo.3:808
2805 " nread = read(sfd, buf, BUF_SIZE);\n"
2806 " if (nread == -1) {\n"
2807 " perror(\"read\");\n"
2808 " exit(EXIT_FAILURE);\n"
2813 #: build/C/man3/getaddrinfo.3:811
2816 " printf(\"Received %ld bytes: %s\\en\", (long) nread, buf);\n"
2820 #. .BR getipnodebyaddr (3),
2821 #. .BR getipnodebyname (3),
2823 #: build/C/man3/getaddrinfo.3:824
2825 "B<getaddrinfo_a>(3), B<gethostbyname>(3), B<getnameinfo>(3), B<inet>(3), "
2826 "B<hostname>(7), B<ip>(7)"
2830 #: build/C/man3/getaddrinfo_a.3:27
2832 msgid "GETADDRINFO_A"
2836 #: build/C/man3/getaddrinfo_a.3:27
2842 #: build/C/man3/getaddrinfo_a.3:31
2844 "getaddrinfo_a, gai_suspend, gai_error, gai_cancel - asynchronous network "
2845 "address and service translation"
2849 #: build/C/man3/getaddrinfo_a.3:35
2852 "B<#define _GNU_SOURCE> /* See feature_test_macros(7) */\n"
2853 "B<#include E<lt>netdb.hE<gt>>\n"
2857 #: build/C/man3/getaddrinfo_a.3:38
2860 "B<int getaddrinfo_a(int >I<mode>B<, struct gaicb *>I<list[]>B<,>\n"
2861 "B< int >I<nitems>B<, struct sigevent *>I<sevp>B<);>\n"
2865 #: build/C/man3/getaddrinfo_a.3:41
2868 "B<int gai_suspend(struct gaicb *>I<list[]>B<, int >I<nitems>B<,>\n"
2869 "B< struct timespec *>I<timeout>B<);>\n"
2873 #: build/C/man3/getaddrinfo_a.3:43
2875 msgid "B<int gai_error(struct gaicb *>I<req>B<);>\n"
2879 #: build/C/man3/getaddrinfo_a.3:45
2881 msgid "B<int gai_cancel(struct gaicb *>I<req>B<);>\n"
2885 #: build/C/man3/getaddrinfo_a.3:47
2887 msgid "Link with I<-lanl>.\n"
2891 #: build/C/man3/getaddrinfo_a.3:55
2893 "The B<getaddrinfo_a>() function performs the same task as "
2894 "B<getaddrinfo>(3), but allows multiple name look-ups to be performed "
2895 "asynchronously, with optional notification on completion of look-up "
2900 #: build/C/man3/getaddrinfo_a.3:59
2901 msgid "The I<mode> argument has one of the following values:"
2905 #: build/C/man3/getaddrinfo_a.3:59
2911 #: build/C/man3/getaddrinfo_a.3:63
2913 "Perform the look-ups synchronously. The call blocks until the look-ups have "
2918 #: build/C/man3/getaddrinfo_a.3:63
2920 msgid "B<GAI_NOWAIT>"
2924 #: build/C/man3/getaddrinfo_a.3:71
2926 "Perform the look-ups asynchronously. The call returns immediately, and the "
2927 "requests are resolved in the background. See the discussion of the I<sevp> "
2932 #: build/C/man3/getaddrinfo_a.3:86
2934 "The array I<list> specifies the look-up requests to process. The I<nitems> "
2935 "argument specifies the number of elements in I<list>. The requested look-up "
2936 "operations are started in parallel. NULL elements in I<list> are ignored. "
2937 "Each request is described by a I<gaicb> structure, defined as follows:"
2941 #: build/C/man3/getaddrinfo_a.3:95
2945 " const char *ar_name;\n"
2946 " const char *ar_service;\n"
2947 " const struct addrinfo *ar_request;\n"
2948 " struct addrinfo *ar_result;\n"
2953 #: build/C/man3/getaddrinfo_a.3:126
2955 "The elements of this structure correspond to the arguments of "
2956 "B<getaddrinfo>(3). Thus, I<ar_name> corresponds to the I<node> argument and "
2957 "I<ar_service> to the I<service> argument, identifying an Internet host and a "
2958 "service. The I<ar_request> element corresponds to the I<hints> argument, "
2959 "specifying the criteria for selecting the returned socket address "
2960 "structures. Finally, I<ar_result> corresponds to the I<res> argument; you "
2961 "do not need to initialize this element, it will be automatically set when "
2962 "the request is resolved. The I<addrinfo> structure referenced by the last "
2963 "two elements is described in B<getaddrinfo>(3)."
2967 #: build/C/man3/getaddrinfo_a.3:142
2969 "When I<mode> is specified as B<GAI_NOWAIT>, notifications about resolved "
2970 "requests can be obtained by employing the I<sigevent> structure pointed to "
2971 "by the I<sevp> argument. For the definition and general details of this "
2972 "structure, see B<sigevent>(7). The I<sevp-E<gt>sigev_notify> field can have "
2973 "the following values:"
2977 #: build/C/man3/getaddrinfo_a.3:142
2979 msgid "B<SIGEV_NONE>"
2983 #: build/C/man3/getaddrinfo_a.3:145
2984 msgid "Don't provide any notification."
2988 #: build/C/man3/getaddrinfo_a.3:145
2990 msgid "B<SIGEV_SIGNAL>"
2993 #. si_pid and si_uid are also set, to the values of the calling process,
2994 #. which doesn't provide useful information, so we'll skip mentioning it.
2996 #: build/C/man3/getaddrinfo_a.3:161
2998 "When a look-up completes, generate the signal I<sigev_signo> for the "
2999 "process. See B<sigevent>(7) for general details. The I<si_code> field of "
3000 "the I<siginfo_t> structure will be set to B<SI_ASYNCNL>."
3004 #: build/C/man3/getaddrinfo_a.3:161
3006 msgid "B<SIGEV_THREAD>"
3010 #: build/C/man3/getaddrinfo_a.3:169
3012 "When a look-up completes, invoke I<sigev_notify_function> as if it were the "
3013 "start function of a new thread. See B<sigevent>(7) for details."
3017 #: build/C/man3/getaddrinfo_a.3:178
3019 "For B<SIGEV_SIGNAL> and B<SIGEV_THREAD>, it may be useful to point "
3020 "I<sevp-E<gt>sigev_value.sival_ptr> to I<list>."
3024 #: build/C/man3/getaddrinfo_a.3:189
3026 "The B<gai_suspend>() function suspends execution of the calling thread, "
3027 "waiting for the completion of one or more requests in the array I<list>. "
3028 "The I<nitems> argument specifies the size of the array I<list>. The call "
3029 "blocks until one of the following occurs:"
3033 #: build/C/man3/getaddrinfo_a.3:193
3034 msgid "One or more of the operations in I<list> completes."
3038 #: build/C/man3/getaddrinfo_a.3:195
3039 msgid "The call is interrupted by a signal that is caught."
3043 #: build/C/man3/getaddrinfo_a.3:208
3045 "The time interval specified in I<timeout> elapses. This argument specifies "
3046 "a timeout in seconds plus nanoseconds (see B<nanosleep>(2) for details of "
3047 "the I<timespec> structure). If I<timeout> is NULL, then the call blocks "
3048 "indefinitely (until one of the events above occurs)."
3052 #: build/C/man3/getaddrinfo_a.3:213
3054 "No explicit indication of which request was completed is given; you must "
3055 "determine which request(s) have completed by iterating with B<gai_error>() "
3056 "over the list of requests."
3060 #: build/C/man3/getaddrinfo_a.3:223
3062 "The B<gai_error>() function returns the status of the request I<req>: "
3063 "either B<EAI_INPROGRESS> if the request was not completed yet, 0 if it was "
3064 "handled successfully, or an error code if the request could not be resolved."
3068 #: build/C/man3/getaddrinfo_a.3:240
3070 "The B<gai_cancel>() function cancels the request I<req>. If the request "
3071 "has been canceled successfully, the error status of the request will be set "
3072 "to B<EAI_CANCELLED> and normal asynchronous notification will be performed. "
3073 "The request cannot be canceled if it is currently being processed; in that "
3074 "case, it will be handled as if B<gai_cancel>() has never been called. If "
3075 "I<req> is NULL, an attempt is made to cancel all outstanding requests that "
3076 "the process has made."
3080 #: build/C/man3/getaddrinfo_a.3:245
3082 "The B<getaddrinfo_a>() function returns 0 if all of the requests have been "
3083 "enqueued successfully, or one of the following nonzero error codes:"
3087 #: build/C/man3/getaddrinfo_a.3:250
3089 "The resources necessary to enqueue the look-up requests were not available. "
3090 "The application may check the error status of each request to determine "
3091 "which ones failed."
3095 #: build/C/man3/getaddrinfo_a.3:257
3096 msgid "I<mode> is invalid."
3100 #: build/C/man3/getaddrinfo_a.3:262
3102 "The B<gai_suspend>() function returns 0 if at least one of the listed "
3103 "requests has been completed. Otherwise, it returns one of the following "
3104 "nonzero error codes:"
3108 #: build/C/man3/getaddrinfo_a.3:265
3109 msgid "The given timeout expired before any of the requests could be completed."
3113 #: build/C/man3/getaddrinfo_a.3:265 build/C/man3/getaddrinfo_a.3:295
3115 msgid "B<EAI_ALLDONE>"
3119 #: build/C/man3/getaddrinfo_a.3:268
3120 msgid "There were no actual requests given to the function."
3124 #: build/C/man3/getaddrinfo_a.3:268
3130 #: build/C/man3/getaddrinfo_a.3:273
3132 "A signal has interrupted the function. Note that this interruption might "
3133 "have been caused by signal notification of some completed look-up request."
3137 #: build/C/man3/getaddrinfo_a.3:285
3139 "The B<gai_error>() function can return B<EAI_INPROGRESS> for an unfinished "
3140 "look-up request, 0 for a successfully completed look-up (as described "
3141 "above), one of the error codes that could be returned by B<getaddrinfo>(3), "
3142 "or the error code B<EAI_CANCELLED> if the request has been canceled "
3143 "explicitly before it could be finished."
3147 #: build/C/man3/getaddrinfo_a.3:289
3148 msgid "The B<gai_cancel>() function can return one of these values:"
3152 #: build/C/man3/getaddrinfo_a.3:289
3154 msgid "B<EAI_CANCELLED>"
3158 #: build/C/man3/getaddrinfo_a.3:292
3159 msgid "The request has been canceled successfully."
3163 #: build/C/man3/getaddrinfo_a.3:292
3165 msgid "B<EAI_NOTCANCELLED>"
3169 #: build/C/man3/getaddrinfo_a.3:295
3170 msgid "The request has not been canceled."
3174 #: build/C/man3/getaddrinfo_a.3:298
3175 msgid "The request has already completed."
3179 #: build/C/man3/getaddrinfo_a.3:303 build/C/man3/getnameinfo.3:194
3181 "The B<gai_strerror>(3) function translates these error codes to a human "
3182 "readable string, suitable for error reporting."
3186 #: build/C/man3/getaddrinfo_a.3:306
3188 "These functions are GNU extensions; they first appeared in glibc in version "
3193 #: build/C/man3/getaddrinfo_a.3:312
3195 "The interface of B<getaddrinfo_a>() was modeled after the B<lio_listio>(3) "
3200 #: build/C/man3/getaddrinfo_a.3:316
3202 "Two examples are provided: a simple example that resolves several requests "
3203 "in parallel synchronously, and a complex example showing some of the "
3204 "asynchronous capabilities."
3208 #: build/C/man3/getaddrinfo_a.3:316
3210 msgid "Synchronous Example"
3214 #: build/C/man3/getaddrinfo_a.3:321
3216 "The program below simply resolves several hostnames in parallel, giving a "
3217 "speed-up compared to resolving the hostnames sequentially using "
3218 "B<getaddrinfo>(3). The program might be used like this:"
3222 #: build/C/man3/getaddrinfo_a.3:328
3225 "$ B<./a.out ftp.us.kernel.org enoent.linuxfoundation.org gnu.cz>\n"
3226 "ftp.us.kernel.org: 128.30.2.36\n"
3227 "enoent.linuxfoundation.org: Name or service not known\n"
3228 "gnu.cz: 87.236.197.13\n"
3232 #: build/C/man3/getaddrinfo_a.3:332
3233 msgid "Here is the program source code"
3237 #: build/C/man3/getaddrinfo_a.3:339 build/C/man3/getaddrinfo_a.3:430
3240 "#define _GNU_SOURCE\n"
3241 "#include E<lt>netdb.hE<gt>\n"
3242 "#include E<lt>stdio.hE<gt>\n"
3243 "#include E<lt>stdlib.hE<gt>\n"
3244 "#include E<lt>string.hE<gt>\n"
3248 #: build/C/man3/getaddrinfo_a.3:347
3252 "main(int argc, char *argv[])\n"
3255 " struct gaicb *reqs[argc - 1];\n"
3256 " char host[NI_MAXHOST];\n"
3257 " struct addrinfo *res;\n"
3261 #: build/C/man3/getaddrinfo_a.3:352
3264 " if (argc E<lt> 2) {\n"
3265 " fprintf(stderr, \"Usage: %s HOST...\\en\", argv[0]);\n"
3266 " exit(EXIT_FAILURE);\n"
3271 #: build/C/man3/getaddrinfo_a.3:362
3274 " for (i = 0; i E<lt> argc - 1; i++) {\n"
3275 " reqs[i] = malloc(sizeof(*reqs[0]));\n"
3276 " if (reqs[i] == NULL) {\n"
3277 " perror(\"malloc\");\n"
3278 " exit(EXIT_FAILURE);\n"
3280 " memset(reqs[i], 0, sizeof(*reqs[0]));\n"
3281 " reqs[i]-E<gt>ar_name = argv[i + 1];\n"
3286 #: build/C/man3/getaddrinfo_a.3:369
3289 " ret = getaddrinfo_a(GAI_WAIT, reqs, argc - 1, NULL);\n"
3290 " if (ret != 0) {\n"
3291 " fprintf(stderr, \"getaddrinfo_a() failed: %s\\en\",\n"
3292 " gai_strerror(ret));\n"
3293 " exit(EXIT_FAILURE);\n"
3298 #: build/C/man3/getaddrinfo_a.3:375
3301 " for (i = 0; i E<lt> argc - 1; i++) {\n"
3302 " printf(\"%s: \", reqs[i]-E<gt>ar_name);\n"
3303 " ret = gai_error(reqs[i]);\n"
3304 " if (ret == 0) {\n"
3305 " res = reqs[i]-E<gt>ar_result;\n"
3309 #: build/C/man3/getaddrinfo_a.3:385
3312 " ret = getnameinfo(res-E<gt>ai_addr, res-E<gt>ai_addrlen,\n"
3313 " host, sizeof(host),\n"
3314 " NULL, 0, NI_NUMERICHOST);\n"
3315 " if (ret != 0) {\n"
3316 " fprintf(stderr, \"getnameinfo() failed: %s\\en\",\n"
3317 " gai_strerror(ret));\n"
3318 " exit(EXIT_FAILURE);\n"
3324 #: build/C/man3/getaddrinfo_a.3:392
3328 " puts(gai_strerror(ret));\n"
3331 " exit(EXIT_SUCCESS);\n"
3336 #: build/C/man3/getaddrinfo_a.3:394
3338 msgid "Asynchronous Example"
3342 #: build/C/man3/getaddrinfo_a.3:399
3344 "This example shows a simple interactive B<getaddrinfo_a>() front-end. The "
3345 "notification facility is not demonstrated."
3349 #: build/C/man3/getaddrinfo_a.3:401
3350 msgid "An example session might look like this:"
3354 #: build/C/man3/getaddrinfo_a.3:418
3358 "E<gt> a ftp.us.kernel.org enoent.linuxfoundation.org gnu.cz\n"
3360 "[2] gnu.cz: Request not canceled\n"
3362 "[00] ftp.us.kernel.org: Finished\n"
3364 "[00] ftp.us.kernel.org: 216.165.129.139\n"
3365 "[01] enoent.linuxfoundation.org: Processing request in progress\n"
3366 "[02] gnu.cz: 87.236.197.13\n"
3368 "[00] ftp.us.kernel.org: 216.165.129.139\n"
3369 "[01] enoent.linuxfoundation.org: Name or service not known\n"
3370 "[02] gnu.cz: 87.236.197.13\n"
3374 #: build/C/man3/getaddrinfo_a.3:422
3375 msgid "The program source goes as follows:"
3379 #: build/C/man3/getaddrinfo_a.3:433
3382 "static struct gaicb **reqs = NULL;\n"
3383 "static int nreqs = 0;\n"
3387 #: build/C/man3/getaddrinfo_a.3:438
3393 " static char buf[256];\n"
3397 #: build/C/man3/getaddrinfo_a.3:442
3400 " fputs(\"E<gt> \", stdout); fflush(stdout);\n"
3401 " if (fgets(buf, sizeof(buf), stdin) == NULL)\n"
3406 #: build/C/man3/getaddrinfo_a.3:445
3409 " if (buf[strlen(buf) - 1] == \\(aq\\en\\(aq)\n"
3410 " buf[strlen(buf) - 1] = 0;\n"
3414 #: build/C/man3/getaddrinfo_a.3:448
3422 #: build/C/man3/getaddrinfo_a.3:456
3425 "/* Add requests for specified hostnames */\n"
3427 "add_requests(void)\n"
3429 " int nreqs_base = nreqs;\n"
3435 #: build/C/man3/getaddrinfo_a.3:460
3438 " while ((host = strtok(NULL, \" \"))) {\n"
3440 " reqs = realloc(reqs, nreqs * sizeof(reqs[0]));\n"
3444 #: build/C/man3/getaddrinfo_a.3:464
3447 " reqs[nreqs - 1] = calloc(1, sizeof(*reqs[0]));\n"
3448 " reqs[nreqs - 1]-E<gt>ar_name = strdup(host);\n"
3453 #: build/C/man3/getaddrinfo_a.3:466
3455 msgid " /* Queue nreqs_base..nreqs requests. */\n"
3459 #: build/C/man3/getaddrinfo_a.3:475
3462 " ret = getaddrinfo_a(GAI_NOWAIT, &reqs[nreqs_base],\n"
3463 " nreqs - nreqs_base, NULL);\n"
3465 " fprintf(stderr, \"getaddrinfo_a() failed: %s\\en\",\n"
3466 " gai_strerror(ret));\n"
3467 " exit(EXIT_FAILURE);\n"
3473 #: build/C/man3/getaddrinfo_a.3:484
3476 "/* Wait until at least one of specified requests completes */\n"
3478 "wait_requests(void)\n"
3482 " struct gaicb const **wait_reqs = calloc(nreqs, sizeof(*wait_reqs));\n"
3483 " /* NULL elements are ignored by gai_suspend(). */\n"
3487 #: build/C/man3/getaddrinfo_a.3:487 build/C/man3/getaddrinfo_a.3:524
3490 " while ((id = strtok(NULL, \" \")) != NULL) {\n"
3495 #: build/C/man3/getaddrinfo_a.3:492 build/C/man3/getaddrinfo_a.3:529
3498 " if (n E<gt>= nreqs) {\n"
3499 " printf(\"Bad request number: %s\\en\", id);\n"
3505 #: build/C/man3/getaddrinfo_a.3:495
3508 " wait_reqs[n] = reqs[n];\n"
3513 #: build/C/man3/getaddrinfo_a.3:501
3516 " ret = gai_suspend(wait_reqs, nreqs, NULL);\n"
3518 " printf(\"gai_suspend(): %s\\en\", gai_strerror(ret));\n"
3524 #: build/C/man3/getaddrinfo_a.3:505
3527 " for (i = 0; i E<lt> nreqs; i++) {\n"
3528 " if (wait_reqs[i] == NULL)\n"
3533 #: build/C/man3/getaddrinfo_a.3:509
3536 " ret = gai_error(reqs[i]);\n"
3537 " if (ret == EAI_INPROGRESS)\n"
3542 #: build/C/man3/getaddrinfo_a.3:514
3545 " printf(\"[%02d] %s: %s\\en\", i, reqs[i]-E<gt>ar_name,\n"
3546 " ret == 0 ? \"Finished\" : gai_strerror(ret));\n"
3552 #: build/C/man3/getaddrinfo_a.3:521
3555 "/* Cancel specified requests */\n"
3557 "cancel_requests(void)\n"
3564 #: build/C/man3/getaddrinfo_a.3:535
3567 " ret = gai_cancel(reqs[n]);\n"
3568 " printf(\"[%s] %s: %s\\en\", id, reqs[atoi(id)]-E<gt>ar_name,\n"
3569 " gai_strerror(ret));\n"
3575 #: build/C/man3/getaddrinfo_a.3:543
3578 "/* List all requests */\n"
3580 "list_requests(void)\n"
3583 " char host[NI_MAXHOST];\n"
3584 " struct addrinfo *res;\n"
3588 #: build/C/man3/getaddrinfo_a.3:547
3591 " for (i = 0; i E<lt> nreqs; i++) {\n"
3592 " printf(\"[%02d] %s: \", i, reqs[i]-E<gt>ar_name);\n"
3593 " ret = gai_error(reqs[i]);\n"
3597 #: build/C/man3/getaddrinfo_a.3:550
3601 " res = reqs[i]-E<gt>ar_result;\n"
3605 #: build/C/man3/getaddrinfo_a.3:565
3608 " ret = getnameinfo(res-E<gt>ai_addr, res-E<gt>ai_addrlen,\n"
3609 " host, sizeof(host),\n"
3610 " NULL, 0, NI_NUMERICHOST);\n"
3612 " fprintf(stderr, \"getnameinfo() failed: %s\\en\",\n"
3613 " gai_strerror(ret));\n"
3614 " exit(EXIT_FAILURE);\n"
3618 " puts(gai_strerror(ret));\n"
3625 #: build/C/man3/getaddrinfo_a.3:571
3629 "main(int argc, char *argv[])\n"
3636 #: build/C/man3/getaddrinfo_a.3:574
3639 " while ((cmdline = getcmd()) != NULL) {\n"
3640 " cmd = strtok(cmdline, \" \");\n"
3644 #: build/C/man3/getaddrinfo_a.3:599
3647 " if (cmd == NULL) {\n"
3648 " list_requests();\n"
3650 " switch (cmd[0]) {\n"
3651 " case \\(aqa\\(aq:\n"
3652 " add_requests();\n"
3654 " case \\(aqw\\(aq:\n"
3655 " wait_requests();\n"
3657 " case \\(aqc\\(aq:\n"
3658 " cancel_requests();\n"
3660 " case \\(aql\\(aq:\n"
3661 " list_requests();\n"
3664 " fprintf(stderr, \"Bad command: %c\\en\", cmd[0]);\n"
3669 " exit(EXIT_SUCCESS);\n"
3674 #: build/C/man3/getaddrinfo_a.3:607
3676 "B<getaddrinfo>(3), B<inet>(3), B<lio_listio>(3), B<hostname>(7), B<ip>(7), "
3681 #: build/C/man1/getent.1:23
3687 #: build/C/man1/getent.1:23
3693 #: build/C/man1/getent.1:23
3695 msgid "User Commands"
3699 #: build/C/man1/getent.1:26
3700 msgid "getent - get entries from Name Service Switch libraries"
3704 #: build/C/man1/getent.1:29
3705 msgid "B<getent> I<database> [I<key> ...]"
3709 #: build/C/man1/getent.1:44
3711 "The B<getent> command displays entries from databases supported by the Name "
3712 "Service Switch libraries, which are configured in I</etc/nsswitch.conf>. If "
3713 "one or more I<key> arguments are provided, then only the entries that match "
3714 "the supplied keys will be displayed. Otherwise, if no I<key> is provided, "
3715 "all entries will be displayed (unless the database does not support "
3720 #: build/C/man1/getent.1:48
3722 "The I<database> may be any of those supported by the GNU C Library, listed "
3727 #: build/C/man1/getent.1:49
3733 #: build/C/man1/getent.1:70
3735 "When no I<key> is provided, use B<sethostent>(3), B<gethostent>(3), and "
3736 "B<endhostent>(3) to enumerate the hosts database. This is identical to "
3737 "using B<hosts>. When one or more I<key> arguments are provided, pass each "
3738 "I<key> in succession to B<getaddrinfo>(3) with the address family "
3739 "B<AF_UNSPEC>, enumerating each socket address structure returned."
3743 #: build/C/man1/getent.1:70
3749 #: build/C/man1/getent.1:76
3750 msgid "Same as B<ahosts>, but use the address family B<AF_INET>."
3754 #: build/C/man1/getent.1:76
3760 #: build/C/man1/getent.1:87
3762 "Same as B<ahosts>, but use the address family B<AF_INET6>. The call to "
3763 "B<getaddrinfo>(3) in this case includes the B<AI_V4MAPPED> flag."
3767 #: build/C/man1/getent.1:87 build/C/man5/nsswitch.conf.5:43
3773 #: build/C/man1/getent.1:104
3775 "When no I<key> is provided, use B<setaliasent>(3), B<getaliasent>(3), and "
3776 "B<endaliasent>(3) to enumerate the aliases database. When one or more "
3777 "I<key> arguments are provided, pass each I<key> in succession to "
3778 "B<getaliasbyname>(3) and display the result."
3782 #: build/C/man1/getent.1:104 build/C/man5/nsswitch.conf.5:48
3788 #: build/C/man1/getent.1:120
3790 "When one or more I<key> arguments are provided, pass each I<key> in "
3791 "succession to B<ether_aton>(3) and B<ether_hostton>(3) until a result is "
3792 "obtained, and display the result. Enumeration is not supported on "
3793 "B<ethers>, so a I<key> must be provided."
3797 #: build/C/man1/getent.1:120 build/C/man5/nsswitch.conf.5:51
3803 #: build/C/man1/getent.1:141
3805 "When no I<key> is provided, use B<setgrent>(3), B<getgrent>(3), and "
3806 "B<endgrent>(3) to enumerate the group database. When one or more I<key> "
3807 "arguments are provided, pass each numeric I<key> to B<getgrgid>(3) and each "
3808 "nonnumeric I<key> to B<getgrnam>(3) and display the result."
3812 #: build/C/man1/getent.1:141
3818 #: build/C/man1/getent.1:158
3820 "When no I<key> is provided, use B<setsgent>(3), B<getsgent>(3), and "
3821 "B<endsgent>(3) to enumerate the gshadow database. When one or more I<key> "
3822 "arguments are provided, pass each I<key> in succession to B<getsgnam>(3) "
3823 "and display the result."
3827 #: build/C/man1/getent.1:158 build/C/man5/nsswitch.conf.5:56
3833 #: build/C/man1/getent.1:181
3835 "When no I<key> is provided, use B<sethostent>(3), B<gethostent>(3), and "
3836 "B<endhostent>(3) to enumerate the hosts database. When one or more I<key> "
3837 "arguments are provided, pass each I<key> to B<gethostbyaddr>(3) or "
3838 "B<gethostbyname2>(3), depending on whether a call to B<inet_pton>(3) "
3839 "indicates that the I<key> is an IPv6 or IPv4 address or not, and display the "
3844 #: build/C/man1/getent.1:181
3846 msgid "B<initgroups>"
3850 #: build/C/man1/getent.1:195
3852 "When one or more I<key> arguments are provided, pass each I<key> in "
3853 "succession to B<getgrouplist>(3) and display the result. Enumeration is "
3854 "not supported on B<initgroups>, so a I<key> must be provided."
3858 #: build/C/man1/getent.1:195 build/C/man5/nsswitch.conf.5:61
3864 #: build/C/man1/getent.1:221
3866 "When one I<key> is provided, pass the I<key> to B<setnetgrent>(3) and, "
3867 "using B<getnetgrent>(3) display the resulting string triple (I<hostname>, "
3868 "I<username>, I<domainname>). Alternatively, three I<keys> may be provided, "
3869 "which are interpreted as the I<hostname>, I<username> and I<domainname> to "
3870 "match to a netgroup name via B<innetgr>(3). Enumeration is not supported on "
3871 "B<initgroups>, so either one or three I<keys> must be provided."
3875 #: build/C/man1/getent.1:221 build/C/man5/nsswitch.conf.5:65
3881 #: build/C/man1/getent.1:242
3883 "When no I<key> is provided, use B<setnetent>(3), B<getnetent>(3), and "
3884 "B<endnetent>(3) to enumerate the networks database. When one or more "
3885 "I<key> arguments are provided, pass each numeric I<key> to "
3886 "B<getnetbyaddr>(3) and each nonnumeric I<key> to B<getnetbyname>(3) and "
3887 "display the result."
3891 #: build/C/man1/getent.1:242 build/C/man5/nsswitch.conf.5:70
3897 #: build/C/man1/getent.1:263
3899 "When no I<key> is provided, use B<setpwent>(3), B<getpwent>(3), and "
3900 "B<endpwent>(3) to enumerate the passwd database. When one or more I<key> "
3901 "arguments are provided, pass each numeric I<key> to B<getpwuid>(3) and each "
3902 "nonnumeric I<key> to B<getpwnam>(3) and display the result."
3906 #: build/C/man1/getent.1:263 build/C/man5/nsswitch.conf.5:75
3908 msgid "B<protocols>"
3912 #: build/C/man1/getent.1:284
3914 "When no I<key> is provided, use B<setprotoent>(3), B<getprotoent>(3), and "
3915 "B<endprotoent>(3) to enumerate the protocols database. When one or more "
3916 "I<key> arguments are provided, pass each numeric I<key> to "
3917 "B<getprotobynumber>(3) and each nonnumeric I<key> to B<getprotobyname>(3) "
3918 "and display the result."
3922 #: build/C/man1/getent.1:284 build/C/man5/nsswitch.conf.5:83
3928 #: build/C/man1/getent.1:305
3930 "When no I<key> is provided, use B<setrpcent>(3), B<getrpcent>(3), and "
3931 "B<endrpcent>(3) to enumerate the rpc database. When one or more I<key> "
3932 "arguments are provided, pass each numeric I<key> to B<getrpcbynumber>(3) "
3933 "and each nonnumeric I<key> to B<getrpcbyname>(3) and display the result."
3937 #: build/C/man1/getent.1:305 build/C/man5/nsswitch.conf.5:88
3943 #: build/C/man1/getent.1:326
3945 "When no I<key> is provided, use B<setservent>(3), B<getservent>(3), and "
3946 "B<endservent>(3) to enumerate the services database. When one or more "
3947 "I<key> arguments are provided, pass each numeric I<key> to "
3948 "B<getservbynumber>(3) and each nonnumeric I<key> to B<getservbyname>(3) "
3949 "and display the result."
3953 #: build/C/man1/getent.1:326 build/C/man5/nsswitch.conf.5:93
3959 #: build/C/man1/getent.1:343
3961 "When no I<key> is provided, use B<setspent>(3), B<getspent>(3), and "
3962 "B<endspent>(3) to enumerate the shadow database. When one or more I<key> "
3963 "arguments are provided, pass each I<key> in succession to B<getspnam>(3) "
3964 "and display the result."
3968 #: build/C/man1/getent.1:344
3974 #: build/C/man1/getent.1:347
3975 msgid "One of the following exit values can be returned by B<getent>:"
3979 #: build/C/man1/getent.1:348
3985 #: build/C/man1/getent.1:351
3986 msgid "Command completed successfully."
3990 #: build/C/man1/getent.1:351
3996 #: build/C/man1/getent.1:356
3997 msgid "Missing arguments, or I<database> unknown."
4001 #: build/C/man1/getent.1:356
4007 #: build/C/man1/getent.1:362
4008 msgid "One or more supplied I<key> could not be found in the I<database>."
4012 #: build/C/man1/getent.1:362
4018 #: build/C/man1/getent.1:366
4019 msgid "Enumeration not supported on this I<database>."
4023 #: build/C/man1/getent.1:369
4024 msgid "B<nsswitch.conf>(5)"
4028 #: build/C/man3/gethostbyname.3:36
4030 msgid "GETHOSTBYNAME"
4034 #: build/C/man3/gethostbyname.3:36
4040 #: build/C/man3/gethostbyname.3:44
4042 "gethostbyname, gethostbyaddr, sethostent, gethostent, endhostent, h_errno, "
4043 "herror, hstrerror, gethostbyaddr_r, gethostbyname2, gethostbyname2_r, "
4044 "gethostbyname_r, gethostent_r - get network host entry"
4048 #: build/C/man3/gethostbyname.3:48
4051 "B<#include E<lt>netdb.hE<gt>>\n"
4052 "B<extern int h_errno;>\n"
4056 #: build/C/man3/gethostbyname.3:50
4058 msgid "B<struct hostent *gethostbyname(const char *>I<name>B<);>\n"
4062 #: build/C/man3/gethostbyname.3:54
4065 "B<#include E<lt>sys/socket.hE<gt>> /* for AF_INET */\n"
4066 "B<struct hostent *gethostbyaddr(const void *>I<addr>B<,>\n"
4067 "B< socklen_t >I<len>B<, int >I<type>B<);>\n"
4071 #: build/C/man3/gethostbyname.3:56
4073 msgid "B<void sethostent(int >I<stayopen>B<);>\n"
4077 #: build/C/man3/gethostbyname.3:58
4079 msgid "B<void endhostent(void);>\n"
4083 #: build/C/man3/gethostbyname.3:60
4085 msgid "B<void herror(const char *>I<s>B<);>\n"
4089 #: build/C/man3/gethostbyname.3:62
4091 msgid "B<const char *hstrerror(int >I<err>B<);>\n"
4095 #: build/C/man3/gethostbyname.3:64
4097 msgid "/* System V/POSIX extension */\n"
4101 #: build/C/man3/gethostbyname.3:66
4103 msgid "B<struct hostent *gethostent(void);>\n"
4107 #: build/C/man3/gethostbyname.3:70
4109 msgid "B<struct hostent *gethostbyname2(const char *>I<name>B<, int >I<af>B<);>\n"
4113 #: build/C/man3/gethostbyname.3:74
4116 "B<int gethostent_r(>\n"
4117 "B< struct hostent *>I<ret>B<, char *>I<buf>B<, size_t "
4119 "B< struct hostent **>I<result>B<, int *>I<h_errnop>B<);>\n"
4123 #: build/C/man3/gethostbyname.3:78
4126 "B<int gethostbyaddr_r(const void *>I<addr>B<, socklen_t >I<len>B<, int "
4128 "B< struct hostent *>I<ret>B<, char *>I<buf>B<, size_t "
4130 "B< struct hostent **>I<result>B<, int *>I<h_errnop>B<);>\n"
4134 #: build/C/man3/gethostbyname.3:82
4137 "B<int gethostbyname_r(const char *>I<name>B<,>\n"
4138 "B< struct hostent *>I<ret>B<, char *>I<buf>B<, size_t "
4140 "B< struct hostent **>I<result>B<, int *>I<h_errnop>B<);>\n"
4144 #: build/C/man3/gethostbyname.3:86
4147 "B<int gethostbyname2_r(const char *>I<name>B<, int >I<af,>\n"
4148 "B< struct hostent *>I<ret>B<, char *>I<buf>B<, size_t "
4150 "B< struct hostent **>I<result>B<, int *>I<h_errnop>B<);>\n"
4154 #: build/C/man3/gethostbyname.3:100
4156 "B<gethostbyname2>(), B<gethostent_r>(), B<gethostbyaddr_r>(), "
4157 "B<gethostbyname_r>(), B<gethostbyname2_r>():"
4161 #: build/C/man3/gethostbyname.3:102 build/C/man3/getnetent_r.3:58 build/C/man3/getprotoent_r.3:55 build/C/man3/getservent_r.3:55
4162 msgid "_BSD_SOURCE || _SVID_SOURCE"
4166 #: build/C/man3/gethostbyname.3:106
4167 msgid "B<herror>(), B<hstrerror>():"
4171 #: build/C/man3/gethostbyname.3:107
4173 msgid "Since glibc 2.8:"
4177 #: build/C/man3/gethostbyname.3:110
4178 msgid "_BSD_SOURCE || _SVID_SOURCE || _GNU_SOURCE"
4182 #: build/C/man3/gethostbyname.3:110
4184 msgid "Before glibc 2.8:"
4188 #: build/C/man3/gethostbyname.3:113
4193 #: build/C/man3/gethostbyname.3:127
4195 "The B<gethostbyname*>() and B<gethostbyaddr*>() functions are obsolete. "
4196 "Applications should use B<getaddrinfo>(3) and B<getnameinfo>(3) instead."
4200 #: build/C/man3/gethostbyname.3:168
4202 "The B<gethostbyname>() function returns a structure of type I<hostent> for "
4203 "the given host I<name>. Here I<name> is either a hostname, or an IPv4 "
4204 "address in standard dot notation (as for B<inet_addr>(3)), or an IPv6 "
4205 "address in colon (and possibly dot) notation. (See RFC\\ 1884 for the "
4206 "description of IPv6 addresses.) If I<name> is an IPv4 or IPv6 address, no "
4207 "lookup is performed and B<gethostbyname>() simply copies I<name> into the "
4208 "I<h_name> field and its I<struct in_addr> equivalent into the "
4209 "I<h_addr_list[0]> field of the returned I<hostent> structure. If I<name> "
4210 "doesn't end in a dot and the environment variable B<HOSTALIASES> is set, the "
4211 "alias file pointed to by B<HOSTALIASES> will first be searched for I<name> "
4212 "(see B<hostname>(7) for the file format). The current domain and its "
4213 "parents are searched unless I<name> ends in a dot."
4217 #: build/C/man3/gethostbyname.3:184
4219 "The B<gethostbyaddr>() function returns a structure of type I<hostent> for "
4220 "the given host address I<addr> of length I<len> and address type I<type>. "
4221 "Valid address types are B<AF_INET> and B<AF_INET6>. The host address "
4222 "argument is a pointer to a struct of a type depending on the address type, "
4223 "for example a I<struct in_addr *> (probably obtained via a call to "
4224 "B<inet_addr>(3)) for address type B<AF_INET>."
4228 #: build/C/man3/gethostbyname.3:191
4230 "The B<sethostent>() function specifies, if I<stayopen> is true (1), that a "
4231 "connected TCP socket should be used for the name server queries and that the "
4232 "connection should remain open during successive queries. Otherwise, name "
4233 "server queries will use UDP datagrams."
4237 #: build/C/man3/gethostbyname.3:196
4239 "The B<endhostent>() function ends the use of a TCP connection for name "
4244 #: build/C/man3/gethostbyname.3:201
4246 "The (obsolete) B<herror>() function prints the error message associated "
4247 "with the current value of I<h_errno> on I<stderr>."
4251 #: build/C/man3/gethostbyname.3:206
4253 "The (obsolete) B<hstrerror>() function takes an error number (typically "
4254 "I<h_errno>) and returns the corresponding message string."
4258 #. .BR resolv+ (8)).
4260 #: build/C/man3/gethostbyname.3:223
4262 "The domain name queries carried out by B<gethostbyname>() and "
4263 "B<gethostbyaddr>() use a combination of any or all of the name server "
4264 "B<named>(8), a broken out line from I</etc/hosts>, and the Network "
4265 "Information Service (NIS or YP), depending upon the contents of the I<order> "
4266 "line in I</etc/host.conf>. The default action is to query B<named>(8), "
4267 "followed by I</etc/hosts>."
4271 #: build/C/man3/gethostbyname.3:225
4272 msgid "The I<hostent> structure is defined in I<E<lt>netdb.hE<gt>> as follows:"
4276 #: build/C/man3/gethostbyname.3:237
4279 "struct hostent {\n"
4280 " char *h_name; /* official name of host */\n"
4281 " char **h_aliases; /* alias list */\n"
4282 " int h_addrtype; /* host address type */\n"
4283 " int h_length; /* length of address */\n"
4284 " char **h_addr_list; /* list of addresses */\n"
4286 "#define h_addr h_addr_list[0] /* for backward compatibility */\n"
4290 #: build/C/man3/gethostbyname.3:241
4291 msgid "The members of the I<hostent> structure are:"
4295 #: build/C/man3/gethostbyname.3:241 build/C/man3/getipnodebyname.3:208
4301 #: build/C/man3/gethostbyname.3:244
4302 msgid "The official name of the host."
4306 #: build/C/man3/gethostbyname.3:244 build/C/man3/getipnodebyname.3:211
4308 msgid "I<h_aliases>"
4312 #: build/C/man3/gethostbyname.3:247
4313 msgid "An array of alternative names for the host, terminated by a NULL pointer."
4317 #: build/C/man3/gethostbyname.3:247 build/C/man3/getipnodebyname.3:215
4319 msgid "I<h_addrtype>"
4323 #: build/C/man3/gethostbyname.3:254
4324 msgid "The type of address; always B<AF_INET> or B<AF_INET6> at present."
4328 #: build/C/man3/gethostbyname.3:254 build/C/man3/getipnodebyname.3:237
4334 #: build/C/man3/gethostbyname.3:257
4335 msgid "The length of the address in bytes."
4339 #: build/C/man3/gethostbyname.3:257 build/C/man3/getipnodebyname.3:251
4341 msgid "I<h_addr_list>"
4345 #: build/C/man3/gethostbyname.3:261
4347 "An array of pointers to network addresses for the host (in network byte "
4348 "order), terminated by a NULL pointer."
4352 #: build/C/man3/gethostbyname.3:261
4358 #: build/C/man3/gethostbyname.3:264
4359 msgid "The first address in I<h_addr_list> for backward compatibility."
4363 #: build/C/man3/gethostbyname.3:276
4365 "The B<gethostbyname>() and B<gethostbyaddr>() functions return the "
4366 "I<hostent> structure or a NULL pointer if an error occurs. On error, the "
4367 "I<h_errno> variable holds an error number. When non-NULL, the return value "
4368 "may point at static data, see the notes below."
4372 #: build/C/man3/gethostbyname.3:278
4373 msgid "The variable I<h_errno> can have the following values:"
4377 #: build/C/man3/gethostbyname.3:278 build/C/man3/getipnodebyname.3:188
4379 msgid "B<HOST_NOT_FOUND>"
4383 #: build/C/man3/gethostbyname.3:281
4384 msgid "The specified host is unknown."
4388 #: build/C/man3/gethostbyname.3:281
4390 msgid "B<NO_ADDRESS> or B<NO_DATA>"
4394 #: build/C/man3/gethostbyname.3:284
4395 msgid "The requested name is valid but does not have an IP address."
4399 #: build/C/man3/gethostbyname.3:284 build/C/man3/getipnodebyname.3:197
4401 msgid "B<NO_RECOVERY>"
4405 #: build/C/man3/gethostbyname.3:287
4406 msgid "A nonrecoverable name server error occurred."
4410 #: build/C/man3/gethostbyname.3:287 build/C/man3/getipnodebyname.3:200
4412 msgid "B<TRY_AGAIN>"
4416 #: build/C/man3/gethostbyname.3:291
4418 "A temporary error occurred on an authoritative name server. Try again "
4423 #: build/C/man3/gethostbyname.3:292 build/C/man5/host.conf.5:181
4425 msgid "I</etc/host.conf>"
4429 #: build/C/man3/gethostbyname.3:295
4430 msgid "resolver configuration file"
4434 #: build/C/man3/gethostbyname.3:295 build/C/man5/host.conf.5:187 build/C/man5/hosts.5:88
4436 msgid "I</etc/hosts>"
4440 #: build/C/man3/gethostbyname.3:298
4441 msgid "host database file"
4445 #: build/C/man3/gethostbyname.3:298 build/C/man5/nsswitch.conf.5:293 build/C/man3/setnetgrent.3:87
4447 msgid "I</etc/nsswitch.conf>"
4451 #: build/C/man3/gethostbyname.3:301
4452 msgid "name service switch configuration"
4456 #: build/C/man3/gethostbyname.3:325
4458 "POSIX.1-2001 specifies B<gethostbyname>(), B<gethostbyaddr>(), "
4459 "B<sethostent>(), B<endhostent>(), B<gethostent>(), and I<h_errno>; "
4460 "B<gethostbyname>(), B<gethostbyaddr>(), and I<h_errno> are marked "
4461 "obsolescent in that standard. POSIX.1-2008 removes the specifications of "
4462 "B<gethostbyname>(), B<gethostbyaddr>(), and I<h_errno>, recommending the use "
4463 "of B<getaddrinfo>(3) and B<getnameinfo>(3) instead."
4467 #: build/C/man3/gethostbyname.3:335
4469 "The functions B<gethostbyname>() and B<gethostbyaddr>() may return "
4470 "pointers to static data, which may be overwritten by later calls. Copying "
4471 "the I<struct hostent> does not suffice, since it contains pointers; a deep "
4476 #: build/C/man3/gethostbyname.3:359
4478 "In the original BSD implementation the I<len> argument of B<gethostbyname>() "
4479 "was an I<int>. The SUSv2 standard is buggy and declares the I<len> argument "
4480 "of B<gethostbyaddr>() to be of type I<size_t>. (That is wrong, because it "
4481 "has to be I<int>, and I<size_t> is not. POSIX.1-2001 makes it I<socklen_t>, "
4482 "which is OK.) See also B<accept>(2)."
4486 #: build/C/man3/gethostbyname.3:365
4488 "The BSD prototype for B<gethostbyaddr>() uses I<const char *> for the first "
4493 #: build/C/man3/gethostbyname.3:365
4495 msgid "System V/POSIX Extension"
4498 #. e.g., Linux, FreeBSD, UnixWare, HP-UX
4499 #. e.g., FreeBSD, AIX
4501 #: build/C/man3/gethostbyname.3:382
4503 "POSIX requires the B<gethostent>() call, that should return the next entry "
4504 "in the host data base. When using DNS/BIND this does not make much sense, "
4505 "but it may be reasonable if the host data base is a file that can be read "
4506 "line by line. On many systems a routine of this name reads from the file "
4507 "I</etc/hosts>. It may be available only when the library was built without "
4508 "DNS support. The glibc version will ignore ipv6 entries. This function is "
4509 "not reentrant, and glibc adds a reentrant version B<gethostent_r>()."
4513 #: build/C/man3/gethostbyname.3:382
4515 msgid "GNU Extensions"
4519 #: build/C/man3/gethostbyname.3:388
4521 "Glibc2 also has a B<gethostbyname2>() that works like B<gethostbyname>(), "
4522 "but permits to specify the address family to which the address must belong."
4526 #: build/C/man3/gethostbyname.3:422
4528 "Glibc2 also has reentrant versions B<gethostent_r>(), B<gethostbyaddr_r>(), "
4529 "B<gethostbyname_r>() and B<gethostbyname2_r>(). The caller supplies a "
4530 "I<hostent> structure I<ret> which will be filled in on success, and a "
4531 "temporary work buffer I<buf> of size I<buflen>. After the call, I<result> "
4532 "will point to the result on success. In case of an error or if no entry is "
4533 "found I<result> will be NULL. The functions return 0 on success and a "
4534 "nonzero error number on failure. In addition to the errors returned by the "
4535 "nonreentrant versions of these functions, if I<buf> is too small, the "
4536 "functions will return B<ERANGE>, and the call should be retried with a "
4537 "larger buffer. The global variable I<h_errno> is not modified, but the "
4538 "address of a variable in which to store error numbers is passed in "
4542 #. http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=482973
4544 #: build/C/man3/gethostbyname.3:427
4546 "B<gethostbyname>() does not recognize components of a dotted IPv4 address "
4547 "string that are expressed in hexadecimal."
4550 #. .BR getipnodebyaddr (3),
4551 #. .BR getipnodebyname (3),
4554 #: build/C/man3/gethostbyname.3:441
4556 "B<getaddrinfo>(3), B<getnameinfo>(3), B<inet>(3), B<inet_ntop>(3), "
4557 "B<inet_pton>(3), B<resolver>(3), B<hosts>(5), B<nsswitch.conf>(5), "
4558 "B<hostname>(7), B<named>(8)"
4562 #: build/C/man3/getipnodebyname.3:24
4564 msgid "GETIPNODEBYNAME"
4568 #: build/C/man3/getipnodebyname.3:24
4574 #: build/C/man3/getipnodebyname.3:28
4576 "getipnodebyname, getipnodebyaddr, freehostent - get network hostnames and "
4581 #: build/C/man3/getipnodebyname.3:36
4584 "B<struct hostent *getipnodebyname(const char *>I<name>B<, int >I<af>B<,>\n"
4585 "B< int >I<flags>B<, int *>I<error_num>B<);>\n"
4589 #: build/C/man3/getipnodebyname.3:39
4592 "B<struct hostent *getipnodebyaddr(const void *>I<addr>B<, size_t "
4594 "B< int >I<af>B<, int *>I<error_num>B<);>\n"
4598 #: build/C/man3/getipnodebyname.3:41
4600 msgid "B<void freehostent(struct hostent *>I<ip>B<);>\n"
4604 #: build/C/man3/getipnodebyname.3:49
4606 "These functions are deprecated (and unavailable in glibc). Use "
4607 "B<getaddrinfo>(3) and B<getnameinfo>(3) instead."
4611 #: build/C/man3/getipnodebyname.3:57
4613 "The B<getipnodebyname>() and B<getipnodebyaddr>() functions return the "
4614 "names and addresses of a network host. These functions return a pointer to "
4615 "the following structure:"
4619 #: build/C/man3/getipnodebyname.3:67
4622 "struct hostent {\n"
4624 " char **h_aliases;\n"
4625 " int h_addrtype;\n"
4627 " char **h_addr_list;\n"
4632 #: build/C/man3/getipnodebyname.3:80
4634 "These functions replace the B<gethostbyname>(3) and B<gethostbyaddr>(3) "
4635 "functions, which could only access the IPv4 network address family. The "
4636 "B<getipnodebyname>() and B<getipnodebyaddr>() functions can access "
4637 "multiple network address families."
4641 #: build/C/man3/getipnodebyname.3:91
4643 "Unlike the B<gethostby> functions, these functions return pointers to "
4644 "dynamically allocated memory. The B<freehostent>() function is used to "
4645 "release the dynamically allocated memory after the caller no longer needs "
4646 "the I<hostent> structure."
4650 #: build/C/man3/getipnodebyname.3:91
4652 msgid "getipnodebyname() arguments"
4656 #: build/C/man3/getipnodebyname.3:102
4658 "The B<getipnodebyname>() function looks up network addresses for the host "
4659 "specified by the I<name> argument. The I<af> argument specifies one of the "
4664 #: build/C/man3/getipnodebyname.3:102 build/C/man3/getipnodebyname.3:164 build/C/man3/inet_ntop.3:55 build/C/man3/inet_pton.3:51
4670 #: build/C/man3/getipnodebyname.3:108
4672 "The I<name> argument points to a dotted-quad IPv4 address or a name of an "
4673 "IPv4 network host."
4677 #: build/C/man3/getipnodebyname.3:108 build/C/man3/getipnodebyname.3:174 build/C/man3/inet_ntop.3:68 build/C/man3/inet_pton.3:65
4683 #: build/C/man3/getipnodebyname.3:114
4685 "The I<name> argument points to a hexadecimal IPv6 address or a name of an "
4686 "IPv6 network host."
4690 #: build/C/man3/getipnodebyname.3:123
4692 "The I<flags> argument specifies additional options. More than one option "
4693 "can be specified by bitwise OR-ing them together. I<flags> should be set to "
4694 "0 if no options are desired."
4698 #: build/C/man3/getipnodebyname.3:123
4700 msgid "B<AI_V4MAPPED>"
4704 #: build/C/man3/getipnodebyname.3:130
4706 "This flag is used with B<AF_INET6> to request a query for IPv4 addresses "
4707 "instead of IPv6 addresses; the IPv4 addresses will be mapped to IPv6 "
4712 #: build/C/man3/getipnodebyname.3:130
4718 #: build/C/man3/getipnodebyname.3:136
4720 "This flag is used with B<AI_V4MAPPED> to request a query for both IPv4 and "
4721 "IPv6 addresses. Any IPv4 address found will be mapped to an IPv6 address."
4725 #: build/C/man3/getipnodebyname.3:136
4727 msgid "B<AI_ADDRCONFIG>"
4731 #: build/C/man3/getipnodebyname.3:148
4733 "This flag is used with B<AF_INET6> to further request that queries for IPv6 "
4734 "addresses should not be made unless the system has at least one IPv6 address "
4735 "assigned to a network interface, and that queries for IPv4 addresses should "
4736 "not be made unless the system has at least one IPv4 address assigned to a "
4737 "network interface. This flag may be used by itself or with the "
4738 "B<AI_V4MAPPED> flag."
4742 #: build/C/man3/getipnodebyname.3:148
4744 msgid "B<AI_DEFAULT>"
4748 #: build/C/man3/getipnodebyname.3:152
4749 msgid "This flag is equivalent to B<(AI_ADDRCONFIG | AI_V4MAPPED)>."
4753 #: build/C/man3/getipnodebyname.3:152
4755 msgid "getipnodebyaddr() arguments"
4759 #: build/C/man3/getipnodebyname.3:164
4761 "The B<getipnodebyaddr>() function looks up the name of the host whose "
4762 "network address is specified by the I<addr> argument. The I<af> argument "
4763 "specifies one of the following values:"
4767 #: build/C/man3/getipnodebyname.3:174
4769 "The I<addr> argument points to a I<struct in_addr> and I<len> must be set to "
4770 "I<sizeof(struct in_addr)>."
4774 #: build/C/man3/getipnodebyname.3:184
4776 "The I<addr> argument points to a I<struct in6_addr> and I<len> must be set "
4777 "to I<sizeof(struct in6_addr)>."
4781 #: build/C/man3/getipnodebyname.3:188
4783 "A NULL pointer is returned if an error occurred, and I<error_num> will "
4784 "contain an error code from the following list:"
4788 #: build/C/man3/getipnodebyname.3:191
4789 msgid "The hostname or network address was not found."
4793 #: build/C/man3/getipnodebyname.3:191
4795 msgid "B<NO_ADDRESS>"
4799 #: build/C/man3/getipnodebyname.3:197
4801 "The domain name server recognized the network address or name, but no answer "
4802 "was returned. This can happen if the network host has only IPv4 addresses "
4803 "and a request has been made for IPv6 information only, or vice versa."
4807 #: build/C/man3/getipnodebyname.3:200
4808 msgid "The domain name server returned a permanent failure response."
4812 #: build/C/man3/getipnodebyname.3:204
4814 "The domain name server returned a temporary failure response. You might "
4815 "have better luck next time."
4819 #: build/C/man3/getipnodebyname.3:208
4821 "A successful query returns a pointer to a I<hostent> structure that contains "
4822 "the following fields:"
4826 #: build/C/man3/getipnodebyname.3:211
4827 msgid "This is the official name of this network host."
4831 #: build/C/man3/getipnodebyname.3:215
4833 "This is an array of pointers to unofficial aliases for the same host. The "
4834 "array is terminated by a NULL pointer."
4838 #: build/C/man3/getipnodebyname.3:237
4840 "This is a copy of the I<af> argument to B<getipnodebyname>() or "
4841 "B<getipnodebyaddr>(). I<h_addrtype> will always be B<AF_INET> if the I<af> "
4842 "argument was B<AF_INET>. I<h_addrtype> will always be B<AF_INET6> if the "
4843 "I<af> argument was B<AF_INET6>."
4847 #: build/C/man3/getipnodebyname.3:251
4849 "This field will be set to I<sizeof(struct in_addr)> if I<h_addrtype> is "
4850 "B<AF_INET>, and to I<sizeof(struct in6_addr)> if I<h_addrtype> is "
4855 #: build/C/man3/getipnodebyname.3:256
4857 "This is an array of one or more pointers to network address structures for "
4858 "the network host. The array is terminated by a NULL pointer."
4861 #. Not in POSIX.1-2001.
4863 #: build/C/man3/getipnodebyname.3:259
4868 #: build/C/man3/getipnodebyname.3:264
4870 "These functions were present in glibc 2.1.91-95, but were removed again. "
4871 "Several UNIX-like systems support them, but all call them deprecated."
4875 #: build/C/man3/getipnodebyname.3:269
4876 msgid "B<getaddrinfo>(3), B<getnameinfo>(3), B<inet_ntop>(3), B<inet_pton>(3)"
4880 #: build/C/man3/getnameinfo.3:7
4886 #: build/C/man3/getnameinfo.3:7
4892 #: build/C/man3/getnameinfo.3:10
4893 msgid "getnameinfo - address-to-name translation in protocol-independent manner"
4897 #: build/C/man3/getnameinfo.3:14
4900 "B<#include E<lt>sys/socket.hE<gt>>\n"
4901 "B<#include E<lt>netdb.hE<gt>>\n"
4905 #: build/C/man3/getnameinfo.3:18
4908 "B<int getnameinfo(const struct sockaddr *>I<sa>B<, socklen_t >I<salen>B<,>\n"
4909 "B< char *>I<host>B<, size_t >I<hostlen>B<,>\n"
4910 "B< char *>I<serv>B<, size_t >I<servlen>B<, int "
4915 #: build/C/man3/getnameinfo.3:28
4917 "B<getnameinfo>(): _POSIX_C_SOURCE\\ E<gt>=\\ 1 || _XOPEN_SOURCE || "
4922 #: build/C/man3/getnameinfo.3:44
4924 "The B<getnameinfo>() function is the inverse of B<getaddrinfo>(3): it "
4925 "converts a socket address to a corresponding host and service, in a "
4926 "protocol-independent manner. It combines the functionality of "
4927 "B<gethostbyaddr>(3) and B<getservbyport>(3), but unlike those functions, "
4928 "B<getaddrinfo>(3) is reentrant and allows programs to eliminate "
4929 "IPv4-versus-IPv6 dependencies."
4933 #: build/C/man3/getnameinfo.3:67
4935 "The I<sa> argument is a pointer to a generic socket address structure (of "
4936 "type I<sockaddr_in> or I<sockaddr_in6>) of size I<salen> that holds the "
4937 "input IP address and port number. The arguments I<host> and I<serv> are "
4938 "pointers to caller-allocated buffers (of size I<hostlen> and I<servlen> "
4939 "respectively) into which B<getnameinfo>() places null-terminated strings "
4940 "containing the host and service names respectively."
4944 #: build/C/man3/getnameinfo.3:80
4946 "The caller can specify that no hostname (or no service name) is required by "
4947 "providing a NULL I<host> (or I<serv>) argument or a zero I<hostlen> (or "
4948 "I<servlen>) argument. However, at least one of hostname or service name "
4949 "must be requested."
4953 #: build/C/man3/getnameinfo.3:86
4954 msgid "The I<flags> argument modifies the behavior of B<getnameinfo>() as follows:"
4958 #: build/C/man3/getnameinfo.3:86
4960 msgid "B<NI_NAMEREQD>"
4964 #: build/C/man3/getnameinfo.3:89
4965 msgid "If set, then an error is returned if the hostname cannot be determined."
4969 #: build/C/man3/getnameinfo.3:89
4975 #: build/C/man3/getnameinfo.3:95
4977 "If set, then the service is datagram (UDP) based rather than stream (TCP) "
4978 "based. This is required for the few ports (512-514) that have different "
4979 "services for UDP and TCP."
4983 #: build/C/man3/getnameinfo.3:95
4985 msgid "B<NI_NOFQDN>"
4989 #: build/C/man3/getnameinfo.3:99
4991 "If set, return only the hostname part of the fully qualified domain name for "
4996 #: build/C/man3/getnameinfo.3:99
4998 msgid "B<NI_NUMERICHOST>"
5001 #. For example, by calling
5004 #. .BR gethostbyaddr ().
5005 #. POSIX.1-2003 has NI_NUMERICSCOPE, but glibc doesn't have it.
5007 #: build/C/man3/getnameinfo.3:109
5009 "If set, then the numeric form of the hostname is returned. (When not set, "
5010 "this will still happen in case the node's name cannot be determined.)"
5014 #: build/C/man3/getnameinfo.3:109
5016 msgid "B<NI_NUMERICSERV>"
5020 #: build/C/man3/getnameinfo.3:114
5022 "If set, then the numeric form of the service address is returned. (When not "
5023 "set, this will still happen in case the service's name cannot be "
5028 #: build/C/man3/getnameinfo.3:123
5030 "Starting with glibc 2.3.4, B<getnameinfo>() has been extended to "
5031 "selectively allow hostnames to be transparently converted to and from the "
5032 "Internationalized Domain Name (IDN) format (see RFC 3490, "
5033 "I<Internationalizing Domain Names in Applications (IDNA)>). Three new flags "
5038 #: build/C/man3/getnameinfo.3:123
5044 #: build/C/man3/getnameinfo.3:129
5046 "If this flag is used, then the name found in the lookup process is converted "
5047 "from IDN format to the locale's encoding if necessary. ASCII-only names are "
5048 "not affected by the conversion, which makes this flag usable in existing "
5049 "programs and environments."
5053 #: build/C/man3/getnameinfo.3:129
5055 msgid "B<NI_IDN_ALLOW_UNASSIGNED>, B<NI_IDN_USE_STD3_ASCII_RULES>"
5058 #. FIXME glibc defines the following additional errors, some which
5059 #. can probably be returned by getnameinfo(); they need to
5062 #. #define EAI_INPROGRESS -100 /* Processing request in progress. */
5063 #. #define EAI_CANCELED -101 /* Request canceled. */
5064 #. #define EAI_NOTCANCELED -102 /* Request not canceled. */
5065 #. #define EAI_ALLDONE -103 /* All requests done. */
5066 #. #define EAI_INTR -104 /* Interrupted by a signal. */
5067 #. #define EAI_IDN_ENCODE -105 /* IDN encoding failed. */
5070 #: build/C/man3/getnameinfo.3:152
5072 "On success 0 is returned, and node and service names, if requested, are "
5073 "filled with null-terminated strings, possibly truncated to fit the specified "
5074 "buffer lengths. On error one of the following nonzero error codes is "
5079 #: build/C/man3/getnameinfo.3:156
5080 msgid "The name could not be resolved at this time. Try again later."
5084 #: build/C/man3/getnameinfo.3:161
5085 msgid "The I<flags> argument has an invalid value."
5089 #: build/C/man3/getnameinfo.3:164
5090 msgid "A nonrecoverable error occurred."
5094 #: build/C/man3/getnameinfo.3:168
5096 "The address family was not recognized, or the address length was invalid for "
5097 "the specified family."
5101 #: build/C/man3/getnameinfo.3:177
5103 "The name does not resolve for the supplied arguments. B<NI_NAMEREQD> is set "
5104 "and the host's name cannot be located, or neither hostname nor service name "
5109 #: build/C/man3/getnameinfo.3:177
5111 msgid "B<EAI_OVERFLOW>"
5115 #: build/C/man3/getnameinfo.3:184
5116 msgid "The buffer pointed to by I<host> or I<serv> was too small."
5120 #: build/C/man3/getnameinfo.3:189
5121 msgid "A system error occurred. The error code can be found in I<errno>."
5125 #: build/C/man3/getnameinfo.3:196
5130 #: build/C/man3/getnameinfo.3:198
5131 msgid "/etc/nsswitch.conf"
5135 #: build/C/man3/getnameinfo.3:200
5136 msgid "/etc/resolv.conf"
5140 #: build/C/man3/getnameinfo.3:203
5141 msgid "B<getnameinfo>() is provided in glibc since version 2.1."
5145 #: build/C/man3/getnameinfo.3:205
5146 msgid "RFC\\ 2553, POSIX.1-2001."
5150 #: build/C/man3/getnameinfo.3:210
5152 "In order to assist the programmer in choosing reasonable sizes for the "
5153 "supplied buffers, I<E<lt>netdb.hE<gt>> defines the constants"
5157 #: build/C/man3/getnameinfo.3:215
5160 "#define NI_MAXHOST 1025\n"
5161 "#define NI_MAXSERV 32\n"
5165 #: build/C/man3/getnameinfo.3:225
5167 "Since glibc 2.8, these definitions are exposed only if one of the feature "
5168 "test macros B<_BSD_SOURCE>, B<_SVID_SOURCE>, or B<_GNU_SOURCE> is defined."
5172 #: build/C/man3/getnameinfo.3:233
5174 "The former is the constant B<MAXDNAME> in recent versions of BIND's "
5175 "I<E<lt>arpa/nameser.hE<gt>> header file. The latter is a guess based on the "
5176 "services listed in the current Assigned Numbers RFC."
5180 #: build/C/man3/getnameinfo.3:238
5182 "The following code tries to get the numeric hostname and service name, for a "
5183 "given socket address. Note that there is no hardcoded reference to a "
5184 "particular address family."
5188 #: build/C/man3/getnameinfo.3:244
5191 "struct sockaddr *sa; /* input */\n"
5192 "socklen_t len; /* input */\n"
5193 "char hbuf[NI_MAXHOST], sbuf[NI_MAXSERV];\n"
5197 #: build/C/man3/getnameinfo.3:248
5200 "if (getnameinfo(sa, len, hbuf, sizeof(hbuf), sbuf,\n"
5201 " sizeof(sbuf), NI_NUMERICHOST | NI_NUMERICSERV) == 0)\n"
5202 " printf(\"host=%s, serv=%s\\en\", hbuf, sbuf);\n"
5206 #: build/C/man3/getnameinfo.3:253
5208 "The following version checks if the socket address has a reverse address "
5213 #: build/C/man3/getnameinfo.3:259
5216 "struct sockaddr *sa; /* input */\n"
5217 "socklen_t len; /* input */\n"
5218 "char hbuf[NI_MAXHOST];\n"
5222 #: build/C/man3/getnameinfo.3:265
5225 "if (getnameinfo(sa, len, hbuf, sizeof(hbuf),\n"
5226 " NULL, 0, NI_NAMEREQD))\n"
5227 " printf(\"could not resolve hostname\");\n"
5229 " printf(\"host=%s\\en\", hbuf);\n"
5233 #: build/C/man3/getnameinfo.3:272
5235 "An example program using B<getnameinfo>() can be found in "
5236 "B<getaddrinfo>(3)."
5240 #: build/C/man3/getnameinfo.3:287
5242 "B<accept>(2), B<getpeername>(2), B<getsockname>(2), B<recvfrom>(2), "
5243 "B<socket>(2), B<getaddrinfo>(3), B<gethostbyaddr>(3), B<getservbyname>(3), "
5244 "B<getservbyport>(3), B<inet_ntop>(3), B<hosts>(5), B<services>(5), "
5245 "B<hostname>(7), B<named>(8)"
5249 #: build/C/man3/getnameinfo.3:291
5251 "R. Gilligan, S. Thomson, J. Bound and W. Stevens, I<Basic Socket Interface "
5252 "Extensions for IPv6>, RFC\\ 2553, March 1999."
5256 #: build/C/man3/getnameinfo.3:296
5258 "Tatsuya Jinmei and Atsushi Onoe, I<An Extension of Format for IPv6 Scoped "
5259 "Addresses>, internet draft, work in progress. "
5260 "ftp://ftp.ietf.org/internet-drafts/draft-ietf-ipngwg-scopedaddr-format-02.txt"
5264 #: build/C/man3/getnameinfo.3:301
5266 "Craig Metz, I<Protocol Independence Using the Sockets API>, Proceedings of "
5267 "the freenix track: 2000 USENIX annual technical conference, June 2000."
5271 #: build/C/man3/getnameinfo.3:303
5272 msgid "http://www.usenix.org/publications/library/proceedings/usenix2000/freenix/metzprotocol.html"
5276 #: build/C/man3/getnetent.3:28
5282 #: build/C/man3/getnetent.3:28 build/C/man3/getprotoent.3:28 build/C/man3/getservent.3:32
5288 #: build/C/man3/getnetent.3:32
5290 "getnetent, getnetbyname, getnetbyaddr, setnetent, endnetent - get network "
5295 #: build/C/man3/getnetent.3:35 build/C/man3/getnetent_r.3:31 build/C/man3/getprotoent.3:35 build/C/man3/getprotoent_r.3:31 build/C/man3/getservent.3:39 build/C/man3/getservent_r.3:31 build/C/man3/setnetgrent.3:12
5297 msgid "B<#include E<lt>netdb.hE<gt>>\n"
5301 #: build/C/man3/getnetent.3:37
5303 msgid "B<struct netent *getnetent(void);>\n"
5307 #: build/C/man3/getnetent.3:39
5309 msgid "B<struct netent *getnetbyname(const char *>I<name>B<);>\n"
5313 #: build/C/man3/getnetent.3:41
5315 msgid "B<struct netent *getnetbyaddr(uint32_t >I<net>B<, int >I<type>B<);>\n"
5319 #: build/C/man3/getnetent.3:43
5321 msgid "B<void setnetent(int >I<stayopen>B<);>\n"
5325 #: build/C/man3/getnetent.3:45
5327 msgid "B<void endnetent(void);>\n"
5331 #: build/C/man3/getnetent.3:53
5333 "The B<getnetent>() function reads the next entry from the networks database "
5334 "and returns a I<netent> structure containing the broken-out fields from the "
5335 "entry. A connection is opened to the database if necessary."
5339 #: build/C/man3/getnetent.3:59
5341 "The B<getnetbyname>() function returns a I<netent> structure for the entry "
5342 "from the database that matches the network I<name>."
5346 #: build/C/man3/getnetent.3:69
5348 "The B<getnetbyaddr>() function returns a I<netent> structure for the entry "
5349 "from the database that matches the network number I<net> of type I<type>. "
5350 "The I<net> argument must be in host byte order."
5354 #: build/C/man3/getnetent.3:79
5356 "The B<setnetent>() function opens a connection to the database, and sets "
5357 "the next entry to the first entry. If I<stayopen> is nonzero, then the "
5358 "connection to the database will not be closed between calls to one of the "
5359 "B<getnet*>() functions."
5363 #: build/C/man3/getnetent.3:83
5364 msgid "The B<endnetent>() function closes the connection to the database."
5368 #: build/C/man3/getnetent.3:85
5369 msgid "The I<netent> structure is defined in I<E<lt>netdb.hE<gt>> as follows:"
5373 #: build/C/man3/getnetent.3:94
5377 " char *n_name; /* official network name */\n"
5378 " char **n_aliases; /* alias list */\n"
5379 " int n_addrtype; /* net address type */\n"
5380 " uint32_t n_net; /* network number */\n"
5385 #: build/C/man3/getnetent.3:98
5386 msgid "The members of the I<netent> structure are:"
5390 #: build/C/man3/getnetent.3:98
5396 #: build/C/man3/getnetent.3:101
5397 msgid "The official name of the network."
5401 #: build/C/man3/getnetent.3:101
5403 msgid "I<n_aliases>"
5407 #: build/C/man3/getnetent.3:104
5408 msgid "A NULL-terminated list of alternative names for the network."
5412 #: build/C/man3/getnetent.3:104
5414 msgid "I<n_addrtype>"
5418 #: build/C/man3/getnetent.3:108
5419 msgid "The type of the network number; always B<AF_INET>."
5423 #: build/C/man3/getnetent.3:108
5429 #: build/C/man3/getnetent.3:111
5430 msgid "The network number in host byte order."
5434 #: build/C/man3/getnetent.3:120
5436 "The B<getnetent>(), B<getnetbyname>() and B<getnetbyaddr>() functions "
5437 "return a pointer to a statically allocated I<netent> structure, or a NULL "
5438 "pointer if an error occurs or the end of the file is reached."
5442 #: build/C/man3/getnetent.3:121 build/C/man5/networks.5:70
5444 msgid "I</etc/networks>"
5448 #: build/C/man3/getnetent.3:124
5449 msgid "networks database file"
5453 #: build/C/man3/getnetent.3:126 build/C/man3/getprotoent.3:122 build/C/man3/getservent.3:131
5454 msgid "4.3BSD, POSIX.1-2001."
5458 #: build/C/man3/getnetent.3:133
5460 "In glibc versions before 2.2, the I<net> argument of B<getnetbyaddr>() was "
5466 #: build/C/man3/getnetent.3:138
5467 msgid "B<getnetent_r>(3), B<getprotoent>(3), B<getservent>(3)"
5471 #: build/C/man3/getnetent.3:140
5476 #: build/C/man3/getnetent_r.3:24
5482 #: build/C/man3/getnetent_r.3:28
5483 msgid "getnetent_r, getnetbyname_r, getnetbyaddr_r - get network entry (reentrant)"
5487 #: build/C/man3/getnetent_r.3:35
5490 "B<int getnetent_r(struct netent *>I<result_buf>B<, char *>I<buf>B<,>\n"
5491 "B< size_t >I<buflen>B<, struct netent **>I<result>B<,>\n"
5492 "B< int *>I<h_errnop>B<);>\n"
5496 #: build/C/man3/getnetent_r.3:40
5499 "B<int getnetbyname_r(const char *>I<name>B<,>\n"
5500 "B< struct netent *>I<result_buf>B<, char *>I<buf>B<,>\n"
5501 "B< size_t >I<buflen>B<, struct netent **>I<result>B<,>\n"
5502 "B< int *>I<h_errnop>B<);>\n"
5506 #: build/C/man3/getnetent_r.3:45
5509 "B<int getnetbyaddr_r(uint32_t >I<net>B<, int >I<type>B<,>\n"
5510 "B< struct netent *>I<result_buf>B<, char *>I<buf>B<,>\n"
5511 "B< size_t >I<buflen>B<, struct netent **>I<result>B<,>\n"
5512 "B< int *>I<h_errnop>B<);>\n"
5516 #: build/C/man3/getnetent_r.3:56
5517 msgid "B<getnetent_r>(), B<getnetbyname_r>(), B<getnetbyaddr_r>():"
5521 #: build/C/man3/getnetent_r.3:77
5523 "The B<getnetent_r>(), B<getnetbyname_r>(), and B<getnetbyaddr_r>() "
5524 "functions are the reentrant equivalents of, respectively, B<getnetent>(3), "
5525 "B<getnetbyname>(3), and B<getnetbynumber>(3). They differ in the way that "
5526 "the I<netent> structure is returned, and in the function calling signature "
5527 "and return value. This manual page describes just the differences from the "
5528 "nonreentrant functions."
5532 #: build/C/man3/getnetent_r.3:83
5534 "Instead of returning a pointer to a statically allocated I<netent> structure "
5535 "as the function result, these functions copy the structure into the location "
5536 "pointed to by I<result_buf>."
5539 #. I can find no information on the required/recommended buffer size;
5540 #. the nonreentrant functions use a 1024 byte buffer -- mtk.
5542 #: build/C/man3/getnetent_r.3:100
5544 "The I<buf> array is used to store the string fields pointed to by the "
5545 "returned I<netent> structure. (The nonreentrant functions allocate these "
5546 "strings in static storage.) The size of this array is specified in "
5547 "I<buflen>. If I<buf> is too small, the call fails with the error B<ERANGE>, "
5548 "and the caller must try again with a larger buffer. (A buffer of length "
5549 "1024 bytes should be sufficient for most applications.)"
5553 #: build/C/man3/getnetent_r.3:108
5555 "If the function call successfully obtains a network record, then I<*result> "
5556 "is set pointing to I<result_buf>; otherwise, I<*result> is set to NULL."
5559 #. getnetent.3 doesn't document any use of h_errno, but nevertheless
5560 #. the nonreentrant functions no seem to set h_errno.
5562 #: build/C/man3/getnetent_r.3:116
5564 "The buffer pointed to by I<h_errnop> is used to return the value that would "
5565 "be stored in the global variable I<h_errno> by the nonreentrant versions of "
5570 #: build/C/man3/getnetent_r.3:119 build/C/man3/getprotoent_r.3:109
5572 "On success, these functions return 0. On error, they return one of the "
5573 "positive error numbers listed in ERRORS."
5577 #: build/C/man3/getnetent_r.3:127
5579 "On error, record not found (B<getnetbyname_r>(), B<getnetbyaddr_r>()), or "
5580 "end of input (B<getnetent_r>()) I<result> is set to NULL."
5584 #: build/C/man3/getnetent_r.3:132
5585 msgid "(B<getnetent_r>()) No more records in database."
5589 #: build/C/man3/getnetent_r.3:132 build/C/man3/getprotoent_r.3:122 build/C/man3/getservent_r.3:121
5595 #: build/C/man3/getnetent_r.3:139 build/C/man3/getprotoent_r.3:129 build/C/man3/getservent_r.3:128
5597 "I<buf> is too small. Try again with a larger buffer (and increased "
5602 #: build/C/man3/getnetent_r.3:143 build/C/man3/getprotoent_r.3:133 build/C/man3/getservent_r.3:132
5604 "These functions are GNU extensions. Functions with similar names exist on "
5605 "some other systems, though typically with different calling signatures."
5609 #: build/C/man3/getnetent_r.3:146
5610 msgid "B<getnetent>(3), B<networks>(5)"
5614 #: build/C/man2/getpeername.2:40
5620 #: build/C/man2/getpeername.2:40 build/C/man2/shutdown.2:38 build/C/man7/udplite.7:25
5626 #: build/C/man2/getpeername.2:43
5627 msgid "getpeername - get name of connected peer socket"
5631 #: build/C/man2/getpeername.2:48
5633 "B<int getpeername(int >I<sockfd>B<, struct sockaddr *>I<addr>B<, socklen_t "
5638 #: build/C/man2/getpeername.2:61
5640 "B<getpeername>() returns the address of the peer connected to the socket "
5641 "I<sockfd>, in the buffer pointed to by I<addr>. The I<addrlen> argument "
5642 "should be initialized to indicate the amount of space pointed to by "
5643 "I<addr>. On return it contains the actual size of the name returned (in "
5644 "bytes). The name is truncated if the buffer provided is too small."
5648 #: build/C/man2/getpeername.2:66
5650 "The returned address is truncated if the buffer provided is too small; in "
5651 "this case, I<addrlen> will return a value greater than was supplied to the "
5656 #: build/C/man2/getpeername.2:71 build/C/man2/shutdown.2:72
5658 "On success, zero is returned. On error, -1 is returned, and I<errno> is set "
5663 #: build/C/man2/getpeername.2:72 build/C/man2/shutdown.2:73
5669 #: build/C/man2/getpeername.2:77
5670 msgid "The argument I<sockfd> is not a valid descriptor."
5674 #: build/C/man2/getpeername.2:77 build/C/man7/packet.7:245 build/C/man7/raw.7:145 build/C/man7/unix.7:332
5680 #: build/C/man2/getpeername.2:83
5682 "The I<addr> argument points to memory not in a valid part of the process "
5687 #: build/C/man2/getpeername.2:87
5688 msgid "I<addrlen> is invalid (e.g., is negative)."
5692 #: build/C/man2/getpeername.2:87 build/C/man7/packet.7:257
5698 #: build/C/man2/getpeername.2:91
5700 "Insufficient resources were available in the system to perform the "
5705 #: build/C/man2/getpeername.2:94
5706 msgid "The socket is not connected."
5710 #: build/C/man2/getpeername.2:94 build/C/man2/shutdown.2:80
5716 #: build/C/man2/getpeername.2:99
5717 msgid "The argument I<sockfd> is a file, not a socket."
5721 #: build/C/man2/getpeername.2:103
5723 "SVr4, 4.4BSD (the B<getpeername>() function call first appeared in 4.2BSD), "
5728 #: build/C/man2/getpeername.2:114
5730 "The third argument of B<getpeername>() is in reality an I<int *> (and this "
5731 "is what 4.x BSD and libc4 and libc5 have). Some POSIX confusion resulted in "
5732 "the present I<socklen_t>, also used by glibc. See also B<accept>(2)."
5736 #: build/C/man2/getpeername.2:121
5738 "B<accept>(2), B<bind>(2), B<getsockname>(2), B<ip>(7), B<socket>(7), "
5743 #: build/C/man3/getprotoent.3:28
5749 #: build/C/man3/getprotoent.3:32
5751 "getprotoent, getprotobyname, getprotobynumber, setprotoent, endprotoent - "
5752 "get protocol entry"
5756 #: build/C/man3/getprotoent.3:37
5758 msgid "B<struct protoent *getprotoent(void);>\n"
5762 #: build/C/man3/getprotoent.3:39
5764 msgid "B<struct protoent *getprotobyname(const char *>I<name>B<);>\n"
5768 #: build/C/man3/getprotoent.3:41
5770 msgid "B<struct protoent *getprotobynumber(int >I<proto>B<);>\n"
5774 #: build/C/man3/getprotoent.3:43
5776 msgid "B<void setprotoent(int >I<stayopen>B<);>\n"
5780 #: build/C/man3/getprotoent.3:45
5782 msgid "B<void endprotoent(void);>\n"
5786 #: build/C/man3/getprotoent.3:54
5788 "The B<getprotoent>() function reads the next entry from the protocols "
5789 "database (see B<protocols>(5)) and returns a I<protoent> structure "
5790 "containing the broken-out fields from the entry. A connection is opened to "
5791 "the database if necessary."
5795 #: build/C/man3/getprotoent.3:61
5797 "The B<getprotobyname>() function returns a I<protoent> structure for the "
5798 "entry from the database that matches the protocol name I<name>. A "
5799 "connection is opened to the database if necessary."
5803 #: build/C/man3/getprotoent.3:68
5805 "The B<getprotobynumber>() function returns a I<protoent> structure for the "
5806 "entry from the database that matches the protocol number I<number>. A "
5807 "connection is opened to the database if necessary."
5811 #: build/C/man3/getprotoent.3:78
5813 "The B<setprotoent>() function opens a connection to the database, and sets "
5814 "the next entry to the first entry. If I<stayopen> is nonzero, then the "
5815 "connection to the database will not be closed between calls to one of the "
5816 "B<getproto*>() functions."
5820 #: build/C/man3/getprotoent.3:82
5821 msgid "The B<endprotoent>() function closes the connection to the database."
5825 #: build/C/man3/getprotoent.3:84
5826 msgid "The I<protoent> structure is defined in I<E<lt>netdb.hE<gt>> as follows:"
5830 #: build/C/man3/getprotoent.3:92
5833 "struct protoent {\n"
5834 " char *p_name; /* official protocol name */\n"
5835 " char **p_aliases; /* alias list */\n"
5836 " int p_proto; /* protocol number */\n"
5841 #: build/C/man3/getprotoent.3:96
5842 msgid "The members of the I<protoent> structure are:"
5846 #: build/C/man3/getprotoent.3:96
5852 #: build/C/man3/getprotoent.3:99
5853 msgid "The official name of the protocol."
5857 #: build/C/man3/getprotoent.3:99
5859 msgid "I<p_aliases>"
5863 #: build/C/man3/getprotoent.3:102
5864 msgid "A NULL-terminated list of alternative names for the protocol."
5868 #: build/C/man3/getprotoent.3:102
5874 #: build/C/man3/getprotoent.3:105
5875 msgid "The protocol number."
5879 #: build/C/man3/getprotoent.3:114
5881 "The B<getprotoent>(), B<getprotobyname>() and B<getprotobynumber>() "
5882 "functions return a pointer to a statically allocated I<protoent> structure, "
5883 "or a NULL pointer if an error occurs or the end of the file is reached."
5887 #: build/C/man3/getprotoent.3:116 build/C/man5/protocols.5:77
5889 msgid "I</etc/protocols>"
5893 #: build/C/man3/getprotoent.3:119
5894 msgid "protocol database file"
5898 #: build/C/man3/getprotoent.3:127
5899 msgid "B<getnetent>(3), B<getprotoent_r>(3), B<getservent>(3), B<protocols>(5)"
5903 #: build/C/man3/getprotoent_r.3:24
5905 msgid "GETPROTOENT_R"
5909 #: build/C/man3/getprotoent_r.3:28
5911 "getprotoent_r, getprotobyname_r, getprotobynumber_r - get protocol entry "
5916 #: build/C/man3/getprotoent_r.3:34
5919 "B<int getprotoent_r(struct protoent *>I<result_buf>B<, char *>I<buf>B<,>\n"
5920 "B< size_t >I<buflen>B<, struct protoent **>I<result>B<);>\n"
5924 #: build/C/man3/getprotoent_r.3:38
5927 "B<int getprotobyname_r(const char *>I<name>B<,>\n"
5928 "B< struct protoent *>I<result_buf>B<, char *>I<buf>B<,>\n"
5929 "B< size_t >I<buflen>B<, struct protoent **>I<result>B<);>\n"
5933 #: build/C/man3/getprotoent_r.3:42
5936 "B<int getprotobynumber_r(int >I<proto>B<,>\n"
5937 "B< struct protoent *>I<result_buf>B<, char *>I<buf>B<,>\n"
5938 "B< size_t >I<buflen>B<, struct protoent **>I<result>B<);>\n"
5942 #: build/C/man3/getprotoent_r.3:53
5943 msgid "B<getprotoent_r>(), B<getprotobyname_r>(), B<getprotobynumber_r>():"
5947 #: build/C/man3/getprotoent_r.3:74
5949 "The B<getprotoent_r>(), B<getprotobyname_r>(), and B<getprotobynumber_r>() "
5950 "functions are the reentrant equivalents of, respectively, B<getprotoent>(3), "
5951 "B<getprotobyname>(3), and B<getprotobynumber>(3). They differ in the way "
5952 "that the I<protoent> structure is returned, and in the function calling "
5953 "signature and return value. This manual page describes just the differences "
5954 "from the nonreentrant functions."
5958 #: build/C/man3/getprotoent_r.3:80
5960 "Instead of returning a pointer to a statically allocated I<protoent> "
5961 "structure as the function result, these functions copy the structure into "
5962 "the location pointed to by I<result_buf>."
5965 #. I can find no information on the required/recommended buffer size;
5966 #. the nonreentrant functions use a 1024 byte buffer.
5967 #. The 1024 byte value is also what the Solaris man page suggests. -- mtk
5969 #: build/C/man3/getprotoent_r.3:98
5971 "The I<buf> array is used to store the string fields pointed to by the "
5972 "returned I<protoent> structure. (The nonreentrant functions allocate these "
5973 "strings in static storage.) The size of this array is specified in "
5974 "I<buflen>. If I<buf> is too small, the call fails with the error B<ERANGE>, "
5975 "and the caller must try again with a larger buffer. (A buffer of length "
5976 "1024 bytes should be sufficient for most applications.)"
5980 #: build/C/man3/getprotoent_r.3:106
5982 "If the function call successfully obtains a protocol record, then I<*result> "
5983 "is set pointing to I<result_buf>; otherwise, I<*result> is set to NULL."
5987 #: build/C/man3/getprotoent_r.3:117
5989 "On error, record not found (B<getprotobyname_r>(), B<getprotobynumber_r>()), "
5990 "or end of input (B<getprotoent_r>()) I<result> is set to NULL."
5994 #: build/C/man3/getprotoent_r.3:122
5995 msgid "(B<getprotoent_r>()) No more records in database."
5999 #: build/C/man3/getprotoent_r.3:147
6001 "The program below uses B<getprotobyname_r>() to retrieve the protocol "
6002 "record for the protocol named in its first command-line argument. If a "
6003 "second (integer) command-line argument is supplied, it is used as the "
6004 "initial value for I<buflen>; if B<getprotobyname_r>() fails with the error "
6005 "B<ERANGE>, the program retries with larger buffer sizes. The following "
6006 "shell session shows a couple of sample runs:"
6010 #: build/C/man3/getprotoent_r.3:158
6013 "$B< ./a.out tcp 1>\n"
6014 "ERANGE! Retrying with larger buffer\n"
6015 "getprotobyname_r() returned: 0 (success) (buflen=78)\n"
6016 "p_name=tcp; p_proto=6; aliases=TCP\n"
6017 "$B< ./a.out xxx 1>\n"
6018 "ERANGE! Retrying with larger buffer\n"
6019 "getprotobyname_r() returned: 0 (success) (buflen=100)\n"
6020 "Call failed/record not found\n"
6024 #: build/C/man3/getprotoent_r.3:170 build/C/man3/getservent_r.3:168
6027 "#define _GNU_SOURCE\n"
6028 "#include E<lt>ctype.hE<gt>\n"
6029 "#include E<lt>netdb.hE<gt>\n"
6030 "#include E<lt>stdlib.hE<gt>\n"
6031 "#include E<lt>stdio.hE<gt>\n"
6032 "#include E<lt>errno.hE<gt>\n"
6033 "#include E<lt>string.hE<gt>\n"
6037 #: build/C/man3/getprotoent_r.3:172 build/C/man3/getservent_r.3:170
6039 msgid "#define MAX_BUF 10000\n"
6043 #: build/C/man3/getprotoent_r.3:181
6047 "main(int argc, char *argv[])\n"
6049 " int buflen, erange_cnt, s;\n"
6050 " struct protoent result_buf;\n"
6051 " struct protoent *result;\n"
6052 " char buf[MAX_BUF];\n"
6057 #: build/C/man3/getprotoent_r.3:186
6060 " if (argc E<lt> 2) {\n"
6061 " printf(\"Usage: %s proto-name [buflen]\\en\", argv[0]);\n"
6062 " exit(EXIT_FAILURE);\n"
6067 #: build/C/man3/getprotoent_r.3:190
6071 " if (argc E<gt> 2)\n"
6072 " buflen = atoi(argv[2]);\n"
6076 #: build/C/man3/getprotoent_r.3:195 build/C/man3/getservent_r.3:198
6079 " if (buflen E<gt> MAX_BUF) {\n"
6080 " printf(\"Exceeded buffer limit (%d)\\en\", MAX_BUF);\n"
6081 " exit(EXIT_FAILURE);\n"
6086 #: build/C/man3/getprotoent_r.3:204
6089 " erange_cnt = 0;\n"
6091 " s = getprotobyname_r(argv[1], &result_buf,\n"
6092 " buf, buflen, &result);\n"
6093 " if (s == ERANGE) {\n"
6094 " if (erange_cnt == 0)\n"
6095 " printf(\"ERANGE! Retrying with larger buffer\\en\");\n"
6100 #: build/C/man3/getprotoent_r.3:207 build/C/man3/getservent_r.3:210
6103 " /* Increment a byte at a time so we can see exactly\n"
6104 " what size buffer was required */\n"
6108 #: build/C/man3/getprotoent_r.3:209 build/C/man3/getservent_r.3:212
6110 msgid " buflen++;\n"
6114 #: build/C/man3/getprotoent_r.3:216 build/C/man3/getservent_r.3:219
6117 " if (buflen E<gt> MAX_BUF) {\n"
6118 " printf(\"Exceeded buffer limit (%d)\\en\", MAX_BUF);\n"
6119 " exit(EXIT_FAILURE);\n"
6122 " } while (s == ERANGE);\n"
6126 #: build/C/man3/getprotoent_r.3:220
6129 " printf(\"getprotobyname_r() returned: %s (buflen=%d)\\en\",\n"
6130 " (s == 0) ? \"0 (success)\" : (s == ENOENT) ? \"ENOENT\" :\n"
6131 " strerror(s), buflen);\n"
6135 #: build/C/man3/getprotoent_r.3:225 build/C/man3/getservent_r.3:228
6138 " if (s != 0 || result == NULL) {\n"
6139 " printf(\"Call failed/record not found\\en\");\n"
6140 " exit(EXIT_FAILURE);\n"
6145 #: build/C/man3/getprotoent_r.3:231
6148 " printf(\"p_name=%s; p_proto=%d; aliases=\",\n"
6149 " result_buf.p_name, result_buf.p_proto);\n"
6150 " for (p = result_buf.p_aliases; *p != NULL; p++)\n"
6151 " printf(\"%s \", *p);\n"
6152 " printf(\"\\en\");\n"
6156 #: build/C/man3/getprotoent_r.3:238
6157 msgid "B<getprotoent>(3), B<protocols>(5)"
6161 #: build/C/man3/getservent.3:32
6167 #: build/C/man3/getservent.3:36
6169 "getservent, getservbyname, getservbyport, setservent, endservent - get "
6174 #: build/C/man3/getservent.3:41
6176 msgid "B<struct servent *getservent(void);>\n"
6180 #: build/C/man3/getservent.3:43
6183 "B<struct servent *getservbyname(const char *>I<name>B<, const char "
6188 #: build/C/man3/getservent.3:45
6190 msgid "B<struct servent *getservbyport(int >I<port>B<, const char *>I<proto>B<);>\n"
6194 #: build/C/man3/getservent.3:47
6196 msgid "B<void setservent(int >I<stayopen>B<);>\n"
6200 #: build/C/man3/getservent.3:49
6202 msgid "B<void endservent(void);>\n"
6206 #: build/C/man3/getservent.3:58
6208 "The B<getservent>() function reads the next entry from the services "
6209 "database (see B<services>(5)) and returns a I<servent> structure containing "
6210 "the broken-out fields from the entry. A connection is opened to the "
6211 "database if necessary."
6215 #: build/C/man3/getservent.3:66
6217 "The B<getservbyname>() function returns a I<servent> structure for the "
6218 "entry from the database that matches the service I<name> using protocol "
6219 "I<proto>. If I<proto> is NULL, any protocol will be matched. A connection "
6220 "is opened to the database if necessary."
6224 #: build/C/man3/getservent.3:75
6226 "The B<getservbyport>() function returns a I<servent> structure for the "
6227 "entry from the database that matches the port I<port> (given in network byte "
6228 "order) using protocol I<proto>. If I<proto> is NULL, any protocol will be "
6229 "matched. A connection is opened to the database if necessary."
6233 #: build/C/man3/getservent.3:85
6235 "The B<setservent>() function opens a connection to the database, and sets "
6236 "the next entry to the first entry. If I<stayopen> is nonzero, then the "
6237 "connection to the database will not be closed between calls to one of the "
6238 "B<getserv*>() functions."
6242 #: build/C/man3/getservent.3:89
6243 msgid "The B<endservent>() function closes the connection to the database."
6247 #: build/C/man3/getservent.3:91
6248 msgid "The I<servent> structure is defined in I<E<lt>netdb.hE<gt>> as follows:"
6252 #: build/C/man3/getservent.3:100
6255 "struct servent {\n"
6256 " char *s_name; /* official service name */\n"
6257 " char **s_aliases; /* alias list */\n"
6258 " int s_port; /* port number */\n"
6259 " char *s_proto; /* protocol to use */\n"
6264 #: build/C/man3/getservent.3:104
6265 msgid "The members of the I<servent> structure are:"
6269 #: build/C/man3/getservent.3:104
6275 #: build/C/man3/getservent.3:107
6276 msgid "The official name of the service."
6280 #: build/C/man3/getservent.3:107
6282 msgid "I<s_aliases>"
6286 #: build/C/man3/getservent.3:110
6287 msgid "A NULL-terminated list of alternative names for the service."
6291 #: build/C/man3/getservent.3:110
6297 #: build/C/man3/getservent.3:113
6298 msgid "The port number for the service given in network byte order."
6302 #: build/C/man3/getservent.3:113
6308 #: build/C/man3/getservent.3:116
6309 msgid "The name of the protocol to use with this service."
6313 #: build/C/man3/getservent.3:125
6315 "The B<getservent>(), B<getservbyname>() and B<getservbyport>() functions "
6316 "return a pointer to a statically allocated I<servent> structure, or a NULL "
6317 "pointer if an error occurs or the end of the file is reached."
6321 #: build/C/man3/getservent.3:126 build/C/man5/services.5:185
6323 msgid "I</etc/services>"
6327 #: build/C/man3/getservent.3:129
6328 msgid "services database file"
6332 #: build/C/man3/getservent.3:136
6333 msgid "B<getnetent>(3), B<getprotoent>(3), B<getservent_r>(3), B<services>(5)"
6337 #: build/C/man3/getservent_r.3:24
6339 msgid "GETSERVENT_R"
6343 #: build/C/man3/getservent_r.3:28
6345 "getservent_r, getservbyname_r, getservbyport_r - get service entry "
6350 #: build/C/man3/getservent_r.3:34
6353 "B<int getservent_r(struct servent *>I<result_buf>B<, char *>I<buf>B<,>\n"
6354 "B< size_t >I<buflen>B<, struct servent **>I<result>B<);>\n"
6358 #: build/C/man3/getservent_r.3:38
6361 "B<int getservbyname_r(const char *>I<name>B<, const char *>I<proto>B<,>\n"
6362 "B< struct servent *>I<result_buf>B<, char *>I<buf>B<,>\n"
6363 "B< size_t >I<buflen>B<, struct servent **>I<result>B<);>\n"
6367 #: build/C/man3/getservent_r.3:42
6370 "B<int getservbyport_r(int >I<port>B<, const char *>I<proto>B<,>\n"
6371 "B< struct servent *>I<result_buf>B<, char *>I<buf>B<,>\n"
6372 "B< size_t >I<buflen>B<, struct servent **>I<result>B<);>\n"
6376 #: build/C/man3/getservent_r.3:53
6377 msgid "B<getservent_r>(), B<getservbyname_r>(), B<getservbyport_r>():"
6381 #: build/C/man3/getservent_r.3:74
6383 "The B<getservent_r>(), B<getservbyname_r>(), and B<getservbyport_r>() "
6384 "functions are the reentrant equivalents of, respectively, B<getservent>(3), "
6385 "B<getservbyname>(3), and B<getservbyport>(3). They differ in the way that "
6386 "the I<servent> structure is returned, and in the function calling signature "
6387 "and return value. This manual page describes just the differences from the "
6388 "nonreentrant functions."
6392 #: build/C/man3/getservent_r.3:80
6394 "Instead of returning a pointer to a statically allocated I<servent> "
6395 "structure as the function result, these functions copy the structure into "
6396 "the location pointed to by I<result_buf>."
6399 #. I can find no information on the required/recommended buffer size;
6400 #. the nonreentrant functions use a 1024 byte buffer -- mtk.
6402 #: build/C/man3/getservent_r.3:97
6404 "The I<buf> array is used to store the string fields pointed to by the "
6405 "returned I<servent> structure. (The nonreentrant functions allocate these "
6406 "strings in static storage.) The size of this array is specified in "
6407 "I<buflen>. If I<buf> is too small, the call fails with the error B<ERANGE>, "
6408 "and the caller must try again with a larger buffer. (A buffer of length "
6409 "1024 bytes should be sufficient for most applications.)"
6413 #: build/C/man3/getservent_r.3:105
6415 "If the function call successfully obtains a service record, then I<*result> "
6416 "is set pointing to I<result_buf>; otherwise, I<*result> is set to NULL."
6420 #: build/C/man3/getservent_r.3:108
6422 "On success, these functions return 0. On error, they return one of the "
6423 "positive error numbers listed in errors."
6427 #: build/C/man3/getservent_r.3:116
6429 "On error, record not found (B<getservbyname_r>(), B<getservbyport_r>()), or "
6430 "end of input (B<getservent_r>()) I<result> is set to NULL."
6434 #: build/C/man3/getservent_r.3:121
6435 msgid "(B<getservent_r>()) No more records in database."
6439 #: build/C/man3/getservent_r.3:146
6441 "The program below uses B<getservbyport_r>() to retrieve the service record "
6442 "for the port and protocol named in its first command-line argument. If a "
6443 "third (integer) command-line argument is supplied, it is used as the initial "
6444 "value for I<buflen>; if B<getservbyport_r>() fails with the error "
6445 "B<ERANGE>, the program retries with larger buffer sizes. The following "
6446 "shell session shows a couple of sample runs:"
6450 #: build/C/man3/getservent_r.3:156
6453 "$B< ./a.out 7 tcp 1>\n"
6454 "ERANGE! Retrying with larger buffer\n"
6455 "getservbyport_r() returned: 0 (success) (buflen=87)\n"
6456 "s_name=echo; s_proto=tcp; s_port=7; aliases=\n"
6457 "$B< ./a.out 77777 tcp>\n"
6458 "getservbyport_r() returned: 0 (success) (buflen=1024)\n"
6459 "Call failed/record not found\n"
6463 #: build/C/man3/getservent_r.3:180
6467 "main(int argc, char *argv[])\n"
6469 " int buflen, erange_cnt, port, s;\n"
6470 " struct servent result_buf;\n"
6471 " struct servent *result;\n"
6472 " char buf[MAX_BUF];\n"
6478 #: build/C/man3/getservent_r.3:185
6481 " if (argc E<lt> 3) {\n"
6482 " printf(\"Usage: %s port-num proto-name [buflen]\\en\", argv[0]);\n"
6483 " exit(EXIT_FAILURE);\n"
6488 #: build/C/man3/getservent_r.3:189
6491 " port = htons(atoi(argv[1]));\n"
6492 " protop = (strcmp(argv[2], \"null\") == 0 ||\n"
6493 "\t strcmp(argv[2], \"NULL\") == 0) ? NULL : argv[2];\n"
6497 #: build/C/man3/getservent_r.3:193
6501 " if (argc E<gt> 3)\n"
6502 " buflen = atoi(argv[3]);\n"
6506 #: build/C/man3/getservent_r.3:207
6509 " erange_cnt = 0;\n"
6511 " s = getservbyport_r(port, protop, &result_buf,\n"
6512 " buf, buflen, &result);\n"
6513 " if (s == ERANGE) {\n"
6514 " if (erange_cnt == 0)\n"
6515 " printf(\"ERANGE! Retrying with larger buffer\\en\");\n"
6520 #: build/C/man3/getservent_r.3:223
6523 " printf(\"getservbyport_r() returned: %s (buflen=%d)\\en\",\n"
6524 " (s == 0) ? \"0 (success)\" : (s == ENOENT) ? \"ENOENT\" :\n"
6525 " strerror(s), buflen);\n"
6529 #: build/C/man3/getservent_r.3:235
6532 " printf(\"s_name=%s; s_proto=%s; s_port=%d; aliases=\",\n"
6533 " result_buf.s_name, result_buf.s_proto,\n"
6534 " ntohs(result_buf.s_port));\n"
6535 " for (p = result_buf.s_aliases; *p != NULL; p++)\n"
6536 " printf(\"%s \", *p);\n"
6537 " printf(\"\\en\");\n"
6541 #: build/C/man3/getservent_r.3:242
6542 msgid "B<getservent>(3), B<services>(5)"
6546 #: build/C/man5/host.conf.5:26
6552 #: build/C/man5/host.conf.5:26
6558 #: build/C/man5/host.conf.5:26 build/C/man5/networks.5:24
6560 msgid "Linux System Administration"
6564 #: build/C/man5/host.conf.5:29
6565 msgid "host.conf - resolver configuration file"
6569 #: build/C/man5/host.conf.5:38
6571 "The file I</etc/host.conf> contains configuration information specific to "
6572 "the resolver library. It should contain one configuration keyword per line, "
6573 "followed by appropriate configuration information. The keywords recognized "
6574 "are I<order>, I<trim>, I<multi>, I<nospoof>, I<spoof>, and I<reorder>. "
6575 "These keywords are described below."
6579 #: build/C/man5/host.conf.5:38
6585 #: build/C/man5/host.conf.5:44
6587 "This keyword specifies how host lookups are to be performed. It should be "
6588 "followed by one or more lookup methods, separated by commas. Valid methods "
6589 "are I<bind>, I<hosts>, and I<nis>."
6593 #: build/C/man5/host.conf.5:44
6599 #: build/C/man5/host.conf.5:61
6601 "This keyword may be listed more than once. Each time it should be followed "
6602 "by a list of domains, separated by colons (\\(aq:\\(aq), semicolons "
6603 "(\\(aq;\\(aq) or commas (\\(aq,\\(aq), with the leading dot. When set, the "
6604 "resolv+ library will automatically trim the given domain name from the end "
6605 "of any hostname resolved via DNS. This is intended for use with local hosts "
6606 "and domains. (Related note: trim will not affect hostnames gathered via NIS "
6607 "or the hosts file. Care should be taken to ensure that the first hostname "
6608 "for each entry in the hosts file is fully qualified or unqualified, as "
6609 "appropriate for the local installation.)"
6613 #: build/C/man5/host.conf.5:61
6619 #: build/C/man5/host.conf.5:76
6621 "Valid values are I<on> and I<off>. If set to I<on>, the resolv+ library "
6622 "will return all valid addresses for a host that appears in the I</etc/hosts> "
6623 "file, instead of only the first. This is I<off> by default, as it may cause "
6624 "a substantial performance loss at sites with large hosts files."
6628 #: build/C/man5/host.conf.5:76
6634 #: build/C/man5/host.conf.5:91
6636 "Valid values are I<on> and I<off>. If set to I<on>, the resolv+ library "
6637 "will attempt to prevent hostname spoofing to enhance the security of "
6638 "B<rlogin> and B<rsh>. It works as follows: after performing a host address "
6639 "lookup, resolv+ will perform a hostname lookup for that address. If the two "
6640 "hostnames do not match, the query will fail. The default value is I<off>."
6644 #: build/C/man5/host.conf.5:91
6646 msgid "I<spoofalert>"
6650 #: build/C/man5/host.conf.5:103
6652 "Valid values are I<on> and I<off>. If this option is set to I<on> and the "
6653 "I<nospoof> option is also set, resolv+ will log a warning of the error via "
6654 "the syslog facility. The default value is I<off>."
6658 #: build/C/man5/host.conf.5:103
6664 #: build/C/man5/host.conf.5:122
6666 "Valid values are I<off>, I<nowarn> and I<warn>. If this option is set to "
6667 "I<off>, spoofed addresses are permitted and no warnings will be emitted via "
6668 "the syslog facility. If this option is set to I<warn>, resolv+ will attempt "
6669 "to prevent hostname spoofing to enhance the security and log a warning of "
6670 "the error via the syslog facility. If this option is set to I<nowarn>, the "
6671 "resolv+ library will attempt to prevent hostname spoofing to enhance the "
6672 "security but not emit warnings via the syslog facility. Setting this option "
6673 "to anything else is equal to setting it to I<nowarn>."
6677 #: build/C/man5/host.conf.5:122
6683 #: build/C/man5/host.conf.5:135
6685 "Valid values are I<on> and I<off>. If set to I<on>, resolv+ will attempt to "
6686 "reorder host addresses so that local addresses (i.e., on the same subnet) "
6687 "are listed first when a B<gethostbyname>(3) is performed. Reordering is "
6688 "done for all lookup methods. The default value is I<off>."
6692 #: build/C/man5/host.conf.5:135
6698 #: build/C/man5/host.conf.5:139
6700 "There are six environment variables that can be used to allow users to "
6701 "override the behavior which is configured in I</etc/host.conf>."
6705 #: build/C/man5/host.conf.5:139
6707 msgid "B<RESOLV_HOST_CONF>"
6711 #: build/C/man5/host.conf.5:143
6713 "If set this variable points to a file that should be read instead of "
6714 "I</etc/host.conf>."
6718 #: build/C/man5/host.conf.5:143
6720 msgid "B<RESOLV_SERV_ORDER>"
6724 #: build/C/man5/host.conf.5:148
6725 msgid "Overrides the I<order> command."
6729 #: build/C/man5/host.conf.5:148
6731 msgid "B<RESOLV_SPOOF_CHECK>"
6735 #: build/C/man5/host.conf.5:157
6737 "Overrides the I<nospoof>, I<spoofalert> and I<spoof> commands in the same "
6738 "way as the I<spoof> command is parsed. Valid values are I<off>, I<nowarn> "
6743 #: build/C/man5/host.conf.5:157
6745 msgid "B<RESOLV_MULTI>"
6749 #: build/C/man5/host.conf.5:162
6750 msgid "Overrides the I<multi> command."
6754 #: build/C/man5/host.conf.5:162
6756 msgid "B<RESOLV_REORDER>"
6760 #: build/C/man5/host.conf.5:167
6761 msgid "Overrides the I<reorder> command."
6765 #: build/C/man5/host.conf.5:167
6767 msgid "B<RESOLV_ADD_TRIM_DOMAINS>"
6771 #: build/C/man5/host.conf.5:172
6773 "A list of domains, separated by colons (\\(aq:\\(aq), semicolons "
6774 "(\\(aq;\\(aq) or commas (\\(aq,\\(aq), with the leading dot, which will be "
6775 "added to the list of domains that should be trimmed."
6779 #: build/C/man5/host.conf.5:172
6781 msgid "B<RESOLV_OVERRIDE_TRIM_DOMAINS>"
6785 #: build/C/man5/host.conf.5:180
6787 "A list of domains, separated by colons (\\(aq:\\(aq), semicolons "
6788 "(\\(aq;\\(aq) or commas (\\(aq,\\(aq), with the leading dot, which will "
6789 "replace the list of domains that should be trimmed. Overrides the I<trim> "
6794 #: build/C/man5/host.conf.5:184 build/C/man5/host.conf.5:187
6795 msgid "Resolver configuration file"
6799 #: build/C/man5/host.conf.5:184
6801 msgid "I</etc/resolv.conf>"
6805 #: build/C/man5/host.conf.5:190
6806 msgid "Local hosts database"
6810 #: build/C/man5/host.conf.5:199
6812 "The following differences exist compared to the original implementation. A "
6813 "new command I<spoof> and a new environment variable B<RESOLV_SPOOF_CHECK> "
6814 "can take arguments like I<off>, I<nowarn> and I<warn>. Line comments can "
6815 "appear anywhere and not only at the beginning of a line."
6819 #: build/C/man5/host.conf.5:204
6820 msgid "B<gethostbyname>(3), B<hostname>(7), B<named>(8), B<resolv+>(8)"
6824 #: build/C/man7/hostname.7:37
6830 #: build/C/man7/hostname.7:37
6836 #: build/C/man7/hostname.7:40
6837 msgid "hostname - hostname resolution description"
6841 #: build/C/man7/hostname.7:44
6843 "Hostnames are domains, where a domain is a hierarchical, dot-separated list "
6844 "of subdomains; for example, the machine monet, in the Berkeley subdomain of "
6845 "the EDU domain would be represented as \"monet.Berkeley.EDU\"."
6849 #: build/C/man7/hostname.7:53
6851 "Hostnames are often used with network client and server programs, which must "
6852 "generally translate the name to an address for use. (This task is generally "
6853 "performed by either B<getaddrinfo>(3) or the obsolete B<gethostbyname>(3).) "
6854 "Hostnames are resolved by the Internet name resolver in the following "
6859 #: build/C/man7/hostname.7:66
6861 "If the name consists of a single component, that is, contains no dot, and if "
6862 "the environment variable B<HOSTALIASES> is set to the name of a file, that "
6863 "file is searched for any string matching the input hostname. The file "
6864 "should consist of lines made up of two white-space separated strings, the "
6865 "first of which is the hostname alias, and the second of which is the "
6866 "complete hostname to be substituted for that alias. If a case-insensitive "
6867 "match is found between the hostname to be resolved and the first field of a "
6868 "line in the file, the substituted name is looked up with no further "
6873 #: build/C/man7/hostname.7:70
6875 "If the input name ends with a trailing dot, the trailing dot is removed, and "
6876 "the remaining name is looked up with no further processing."
6880 #: build/C/man7/hostname.7:83
6882 "If the input name does not end with a trailing dot, it is looked up by "
6883 "searching through a list of domains until a match is found. The default "
6884 "search list includes first the local domain, then its parent domains with at "
6885 "least 2 name components (longest first). For example, in the domain "
6886 "CS.Berkeley.EDU, the name lithium.CChem will be checked first as "
6887 "lithium.CChem.CS.Berkeley.EDU and then as lithium.CChem.Berkeley.EDU. "
6888 "Lithium.CChem.EDU will not be tried, as there is only one component "
6889 "remaining from the local domain. The search path can be changed from the "
6890 "default by a system-wide configuration file (see B<resolver>(5))."
6894 #. Hostname appeared in
6897 #: build/C/man7/hostname.7:91
6898 msgid "B<gethostbyname>(3), B<resolver>(5), B<mailaddr>(7), B<named>(8)"
6902 #: build/C/man5/hosts.5:27
6908 #: build/C/man5/hosts.5:27
6914 #: build/C/man5/hosts.5:30
6915 msgid "hosts - static table lookup for hostnames"
6919 #: build/C/man5/hosts.5:32
6920 msgid "B</etc/hosts>"
6924 #: build/C/man5/hosts.5:40
6926 "This manual page describes the format of the I</etc/hosts> file. This file "
6927 "is a simple text file that associates IP addresses with hostnames, one line "
6928 "per IP address. For each host a single line should be present with the "
6929 "following information:"
6933 #: build/C/man5/hosts.5:43
6934 msgid "IP_address canonical_hostname [aliases...]"
6938 #: build/C/man5/hosts.5:56
6940 "Fields of the entry are separated by any number of blanks and/or tab "
6941 "characters. Text from a \"#\" character until the end of the line is a "
6942 "comment, and is ignored. Host names may contain only alphanumeric "
6943 "characters, minus signs (\"-\"), and periods (\".\"). They must begin with "
6944 "an alphabetic character and end with an alphanumeric character. Optional "
6945 "aliases provide for name changes, alternate spellings, shorter hostnames, or "
6946 "generic hostnames (for example, I<localhost>)."
6950 #: build/C/man5/hosts.5:64
6952 "The Berkeley Internet Name Domain (BIND) Server implements the Internet name "
6953 "server for UNIX systems. It augments or replaces the I</etc/hosts> file or "
6954 "hostname lookup, and frees a host from relying on I</etc/hosts> being up to "
6955 "date and complete."
6959 #: build/C/man5/hosts.5:67
6961 "In modern systems, even though the host table has been superseded by DNS, it "
6962 "is still widely used for:"
6966 #: build/C/man5/hosts.5:67
6968 msgid "B<bootstrapping>"
6972 #: build/C/man5/hosts.5:73
6974 "Most systems have a small host table containing the name and address "
6975 "information for important hosts on the local network. This is useful when "
6976 "DNS is not running, for example during system bootup."
6980 #: build/C/man5/hosts.5:73
6986 #: build/C/man5/hosts.5:79
6988 "Sites that use NIS use the host table as input to the NIS host database. "
6989 "Even though NIS can be used with DNS, most NIS sites still use the host "
6990 "table with an entry for all local hosts as a backup."
6994 #: build/C/man5/hosts.5:79
6996 msgid "B<isolated nodes>"
7000 #: build/C/man5/hosts.5:86
7002 "Very small sites that are isolated from the network use the host table "
7003 "instead of DNS. If the local information rarely changes, and the network is "
7004 "not connected to the Internet, DNS offers little advantage."
7008 #: build/C/man5/hosts.5:91
7010 "Modifications to this file normally take effect immediately, except in cases "
7011 "where the file is cached by applications."
7015 #: build/C/man5/hosts.5:91
7017 msgid "Historical Notes"
7021 #: build/C/man5/hosts.5:94
7023 "RFC\\ 952 gave the original format for the host table, though it has since "
7028 #: build/C/man5/hosts.5:107
7030 "Before the advent of DNS, the host table was the only way of resolving "
7031 "hostnames on the fledgling Internet. Indeed, this file could be created "
7032 "from the official host data base maintained at the Network Information "
7033 "Control Center (NIC), though local changes were often required to bring it "
7034 "up to date regarding unofficial aliases and/or unknown hosts. The NIC no "
7035 "longer maintains the hosts.txt files, though looking around at the time of "
7036 "writing (circa 2000), there are historical hosts.txt files on the WWW. I "
7037 "just found three, from 92, 94, and 95."
7041 #: build/C/man5/hosts.5:114
7044 "127.0.0.1 localhost\n"
7045 "192.168.1.10 foo.mydomain.org foo\n"
7046 "192.168.1.13 bar.mydomain.org bar\n"
7047 "146.82.138.7 master.debian.org master\n"
7048 "209.237.226.90 www.opensource.org\n"
7052 #. This manual page was written by Manoj Srivastava <srivasta@debian.org>,
7053 #. for the Debian GNU/Linux system.
7055 #: build/C/man5/hosts.5:125
7057 "B<hostname>(1), B<resolver>(3), B<resolver>(5), B<hostname>(7), B<named>(8), "
7058 "Internet RFC\\ 952"
7062 #: build/C/man5/hosts.equiv.5:3
7068 #: build/C/man5/hosts.equiv.5:3
7074 #: build/C/man5/hosts.equiv.5:7
7076 "/etc/hosts.equiv - list of hosts and users that are granted \"trusted\" B<r> "
7077 "command access to your system"
7081 #: build/C/man5/hosts.equiv.5:11
7083 "The B<hosts.equiv> file allows or denies hosts and users to use the "
7084 "B<r>-commands (e.g., B<rlogin>, B<rsh> or B<rcp>) without supplying a "
7089 #: build/C/man5/hosts.equiv.5:13
7090 msgid "The file uses the following format:"
7094 #: build/C/man5/hosts.equiv.5:13
7096 msgid "I<[ + | - ]> I<[hostname]> I<[username]>"
7100 #: build/C/man5/hosts.equiv.5:27
7102 "The I<hostname> is the name of a host which is logically equivalent to the "
7103 "local host. Users logged into that host are allowed to access like-named "
7104 "user accounts on the local host without supplying a password. The "
7105 "I<hostname> may be (optionally) preceded by a plus (+) sign. If the plus "
7106 "sign is used alone it allows any host to access your system. You can "
7107 "explicitly deny access to a host by preceding the I<hostname> by a minus (-) "
7108 "sign. Users from that host must always supply a password. For security "
7109 "reasons you should always use the FQDN of the hostname and not the short "
7114 #: build/C/man5/hosts.equiv.5:39
7116 "The I<username> entry grants a specific user access to all user accounts "
7117 "(except root) without supplying a password. That means the user is NOT "
7118 "restricted to like-named accounts. The I<username> may be (optionally) "
7119 "preceded by a plus (+) sign. You can also explicitly deny access to a "
7120 "specific user by preceding the I<username> with a minus (-) sign. This says "
7121 "that the user is not trusted no matter what other entries for that host "
7126 #: build/C/man5/hosts.equiv.5:41
7127 msgid "Netgroups can be specified by preceding the netgroup by an @ sign."
7131 #: build/C/man5/hosts.equiv.5:47
7133 "Be extremely careful when using the plus (+) sign. A simple typographical "
7134 "error could result in a standalone plus sign. A standalone plus sign is a "
7135 "wildcard character that means \"any host\"!"
7139 #: build/C/man5/hosts.equiv.5:49
7140 msgid "I</etc/hosts.equiv>"
7144 #: build/C/man5/hosts.equiv.5:54
7146 "Some systems will only honor the contents of this file when it has owner "
7147 "root and no write permission for anybody else. Some exceptionally paranoid "
7148 "systems even require that there be no other hard links to the file."
7152 #: build/C/man5/hosts.equiv.5:62
7154 "Modern systems use the Pluggable Authentication Modules library (PAM). With "
7155 "PAM a standalone plus sign is only considered a wildcard character which "
7156 "means \"any host\" when the word I<promiscuous> is added to the auth "
7157 "component line in your PAM file for the particular service (e.g., "
7162 #: build/C/man5/hosts.equiv.5:66
7163 msgid "B<rhosts>(5), B<rlogind>(8), B<rshd>(8)"
7167 #: build/C/man7/icmp.7:7
7173 #: build/C/man7/icmp.7:7 build/C/man7/ipv6.7:7 build/C/man8/nscd.8:23 build/C/man7/packet.7:7 build/C/man7/raw.7:9 build/C/man7/unix.7:15 build/C/man7/x25.7:7
7179 #: build/C/man7/icmp.7:10
7180 msgid "icmp - Linux IPv4 ICMP kernel module."
7184 #: build/C/man7/icmp.7:18
7186 "This kernel protocol module implements the Internet Control Message Protocol "
7187 "defined in RFC\\ 792. It is used to signal error conditions and for "
7188 "diagnosis. The user doesn't interact directly with this module; instead it "
7189 "communicates with the other protocols in the kernel and these pass the ICMP "
7190 "errors to the application layers. The kernel ICMP module also answers ICMP "
7195 #: build/C/man7/icmp.7:30
7197 "A user protocol may receive ICMP packets for all local sockets by opening a "
7198 "raw socket with the protocol B<IPPROTO_ICMP>. See B<raw>(7) for more "
7199 "information. The types of ICMP packets passed to the socket can be filtered "
7200 "using the B<ICMP_FILTER> socket option. ICMP packets are always processed "
7201 "by the kernel too, even when passed to a user socket."
7205 #: build/C/man7/icmp.7:36
7207 "Linux limits the rate of ICMP error packets to each destination. "
7208 "B<ICMP_REDIRECT> and B<ICMP_DEST_UNREACH> are also limited by the "
7209 "destination route of the incoming packets."
7212 #. FIXME better description needed
7214 #: build/C/man7/icmp.7:49
7216 "ICMP supports a set of I</proc> interfaces to configure some global IP "
7217 "parameters. The parameters can be accessed by reading or writing files in "
7218 "the directory I</proc/sys/net/ipv4/>. Most of these parameters are rate "
7219 "limitations for specific ICMP types. Linux 2.2 uses a token bucket filter "
7220 "to limit ICMPs. The value is the timeout in jiffies until the token bucket "
7221 "filter is cleared after a burst. A jiffy is a system dependent unit, "
7222 "usually 10ms on i386 and about 1ms on alpha and ia64."
7226 #: build/C/man7/icmp.7:49
7228 msgid "I<icmp_destunreach_rate> (Linux 2.2 to 2.4.9)"
7231 #. Precisely: from 2.1.102
7233 #: build/C/man7/icmp.7:58
7235 "Maximum rate to send ICMP Destination Unreachable packets. This limits the "
7236 "rate at which packets are sent to any individual route or destination. The "
7237 "limit does not affect sending of B<ICMP_FRAG_NEEDED> packets needed for path "
7242 #: build/C/man7/icmp.7:58
7244 msgid "I<icmp_echo_ignore_all> (since Linux 2.2)"
7247 #. Precisely: 2.1.68
7249 #: build/C/man7/icmp.7:64
7250 msgid "If this value is nonzero, Linux will ignore all B<ICMP_ECHO> requests."
7254 #: build/C/man7/icmp.7:64
7256 msgid "I<icmp_echo_ignore_broadcasts> (since Linux 2.2)"
7259 #. Precisely: from 2.1.68
7261 #: build/C/man7/icmp.7:70
7263 "If this value is nonzero, Linux will ignore all B<ICMP_ECHO> packets sent to "
7264 "broadcast addresses."
7268 #: build/C/man7/icmp.7:70
7270 msgid "I<icmp_echoreply_rate> (Linux 2.2 to 2.4.9)"
7273 #. Precisely: from 2.1.102
7275 #: build/C/man7/icmp.7:78
7277 "Maximum rate for sending B<ICMP_ECHOREPLY> packets in response to "
7278 "B<ICMP_ECHOREQUEST> packets."
7282 #: build/C/man7/icmp.7:78
7285 "I<icmp_errors_use_inbound_ifaddr> (Boolean; default: disabled; since Linux "
7289 #. The following taken from 2.6.28-rc4 Documentation/networking/ip-sysctl.txt
7291 #: build/C/man7/icmp.7:83
7293 "If disabled, ICMP error messages are sent with the primary address of the "
7294 "exiting interface."
7298 #: build/C/man7/icmp.7:89
7300 "If enabled, the message will be sent with the primary address of the "
7301 "interface that received the packet that caused the ICMP error. This is the "
7302 "behavior that many network administrators will expect from a router. And it "
7303 "can make debugging complicated network layouts much easier."
7307 #: build/C/man7/icmp.7:93
7309 "Note that if no primary address exists for the interface selected, then the "
7310 "primary address of the first non-loopback interface that has one will be "
7311 "used regardless of this setting."
7315 #: build/C/man7/icmp.7:93
7318 "I<icmp_ignore_bogus_error_responses> (Boolean; default: disabled; since "
7322 #. precisely: since 2.1.32
7323 #. The following taken from 2.6.28-rc4 Documentation/networking/ip-sysctl.txt
7325 #: build/C/man7/icmp.7:101
7327 "Some routers violate RFC1122 by sending bogus responses to broadcast "
7328 "frames. Such violations are normally logged via a kernel warning. If this "
7329 "parameter is enabled, the kernel will not give such warnings, which will "
7330 "avoid log file clutter."
7334 #: build/C/man7/icmp.7:101
7336 msgid "I<icmp_paramprob_rate> (Linux 2.2 to 2.4.9)"
7339 #. Precisely: from 2.1.102
7341 #: build/C/man7/icmp.7:108
7343 "Maximum rate for sending B<ICMP_PARAMETERPROB> packets. These packets are "
7344 "sent when a packet arrives with an invalid IP header."
7348 #: build/C/man7/icmp.7:108
7350 msgid "I<icmp_ratelimit> (integer; default: 1000; since Linux 2.4.10)"
7353 #. The following taken from 2.6.28-rc4 Documentation/networking/ip-sysctl.txt
7355 #: build/C/man7/icmp.7:116
7357 "Limit the maximum rates for sending ICMP packets whose type matches "
7358 "I<icmp_ratemask> (see below) to specific targets. 0 to disable any "
7359 "limiting, otherwise the minimum space between responses in milliseconds."
7363 #: build/C/man7/icmp.7:116
7365 msgid "I<icmp_ratemask> (integer; default: see below; since Linux 2.4.10)"
7368 #. The following taken from 2.6.28-rc4 Documentation/networking/ip-sysctl.txt
7370 #: build/C/man7/icmp.7:120
7371 msgid "Mask made of ICMP types for which rates are being limited."
7375 #: build/C/man7/icmp.7:122
7376 msgid "Significant bits: IHGFEDCBA9876543210"
7380 #: build/C/man7/icmp.7:124
7381 msgid "Default mask: 0000001100000011000 (0x1818)"
7385 #: build/C/man7/icmp.7:127
7386 msgid "Bit definitions (see the kernel source file I<include/linux/icmp.h>):"
7390 #: build/C/man7/icmp.7:143
7394 "3 Destination Unreachable *\n"
7395 "4 Source Quench *\n"
7398 "B Time Exceeded *\n"
7399 "C Parameter Problem *\n"
7400 "D Timestamp Request\n"
7401 "E Timestamp Reply\n"
7404 "H Address Mask Request\n"
7405 "I Address Mask Reply\n"
7409 #: build/C/man7/icmp.7:148
7411 "The bits marked with an asterisk are rate limited by default (see the "
7412 "default mask above)."
7416 #: build/C/man7/icmp.7:148
7418 msgid "I<icmp_timeexceed_rate> (Linux 2.2 to 2.4.9)"
7422 #: build/C/man7/icmp.7:155
7424 "Maximum rate for sending B<ICMP_TIME_EXCEEDED> packets. These packets are "
7425 "sent to prevent loops when a packet has crossed too many hops."
7429 #: build/C/man7/icmp.7:159
7430 msgid "Support for the B<ICMP_ADDRESS> request was removed in 2.2."
7434 #: build/C/man7/icmp.7:163
7435 msgid "Support for B<ICMP_SOURCE_QUENCH> was removed in Linux 2.2."
7438 #. not really true ATM
7440 #. Linux ICMP should be compliant to RFC 1122.
7442 #: build/C/man7/icmp.7:171
7444 "As many other implementations don't support B<IPPROTO_ICMP> raw sockets, "
7445 "this feature should not be relied on in portable programs."
7449 #: build/C/man7/icmp.7:176
7451 "B<ICMP_REDIRECT> packets are not sent when Linux is not acting as a router. "
7452 "They are also only accepted from the old gateway defined in the routing "
7453 "table and the redirect routes are expired after some time."
7457 #: build/C/man7/icmp.7:180
7459 "The 64-bit timestamp returned by B<ICMP_TIMESTAMP> is in milliseconds since "
7460 "the Epoch, 1970-01-01 00:00:00 +0000 (UTC)."
7464 #: build/C/man7/icmp.7:185
7466 "Linux ICMP internally uses a raw socket to send ICMPs. This raw socket may "
7467 "appear in B<netstat>(8) output with a zero inode."
7471 #: build/C/man7/icmp.7:187
7476 #: build/C/man7/icmp.7:189
7477 msgid "RFC\\ 792 for a description of the ICMP protocol."
7481 #: build/C/man3/inet.3:42
7487 #: build/C/man3/inet.3:42
7493 #: build/C/man3/inet.3:46
7495 "inet_aton, inet_addr, inet_network, inet_ntoa, inet_makeaddr, inet_lnaof, "
7496 "inet_netof - Internet address manipulation routines"
7500 #: build/C/man3/inet.3:51
7503 "B<#include E<lt>sys/socket.hE<gt>>\n"
7504 "B<#include E<lt>netinet/in.hE<gt>>\n"
7505 "B<#include E<lt>arpa/inet.hE<gt>>\n"
7509 #: build/C/man3/inet.3:53
7511 msgid "B<int inet_aton(const char *>I<cp>B<, struct in_addr *>I<inp>B<);>\n"
7515 #: build/C/man3/inet.3:55
7517 msgid "B<in_addr_t inet_addr(const char *>I<cp>B<);>\n"
7521 #: build/C/man3/inet.3:57
7523 msgid "B<in_addr_t inet_network(const char *>I<cp>B<);>\n"
7527 #: build/C/man3/inet.3:59
7529 msgid "B<char *inet_ntoa(struct in_addr >I<in>B<);>\n"
7533 #: build/C/man3/inet.3:61
7535 msgid "B<struct in_addr inet_makeaddr(int >I<net>B<, int >I<host>B<);>\n"
7539 #: build/C/man3/inet.3:63
7541 msgid "B<in_addr_t inet_lnaof(struct in_addr >I<in>B<);>\n"
7545 #: build/C/man3/inet.3:65
7547 msgid "B<in_addr_t inet_netof(struct in_addr >I<in>B<);>\n"
7551 #: build/C/man3/inet.3:75
7552 msgid "B<inet_aton>(), B<inet_ntoa>(): _BSD_SOURCE || _SVID_SOURCE"
7556 #: build/C/man3/inet.3:85
7558 "B<inet_aton>() converts the Internet host address I<cp> from the IPv4 "
7559 "numbers-and-dots notation into binary form (in network byte order) and "
7560 "stores it in the structure that I<inp> points to. B<inet_aton>() returns "
7561 "nonzero if the address is valid, zero if not. The address supplied in I<cp> "
7562 "can have one of the following forms:"
7566 #: build/C/man3/inet.3:85
7572 #: build/C/man3/inet.3:89
7574 "Each of the four numeric parts specifies a byte of the address; the bytes "
7575 "are assigned in left-to-right order to produce the binary address."
7579 #: build/C/man3/inet.3:89
7585 #: build/C/man3/inet.3:102
7587 "Parts I<a> and I<b> specify the first two bytes of the binary address. Part "
7588 "I<c> is interpreted as a 16-bit value that defines the rightmost two bytes "
7589 "of the binary address. This notation is suitable for specifying (outmoded) "
7590 "Class B network addresses."
7594 #: build/C/man3/inet.3:102
7600 #: build/C/man3/inet.3:113
7602 "Part I<a> specifies the first byte of the binary address. Part I<b> is "
7603 "interpreted as a 24-bit value that defines the rightmost three bytes of the "
7604 "binary address. This notation is suitable for specifying (outmoded) Class C "
7605 "network addresses."
7609 #: build/C/man3/inet.3:113
7615 #: build/C/man3/inet.3:119
7617 "The value I<a> is interpreted as a 32-bit value that is stored directly into "
7618 "the binary address without any byte rearrangement."
7622 #: build/C/man3/inet.3:132
7624 "In all of the above forms, components of the dotted address can be specified "
7625 "in decimal, octal (with a leading I<0>), or hexadecimal, with a leading "
7626 "I<0X>). Addresses in any of these forms are collectively termed I<IPV4 "
7627 "numbers-and-dots notation>. The form that uses exactly four decimal numbers "
7628 "is referred to as I<IPv4 dotted-decimal notation> (or sometimes: I<IPv4 "
7629 "dotted-quad notation>)."
7633 #: build/C/man3/inet.3:149
7635 "The B<inet_addr>() function converts the Internet host address I<cp> from "
7636 "IPv4 numbers-and-dots notation into binary data in network byte order. If "
7637 "the input is invalid, B<INADDR_NONE> (usually -1) is returned. Use of this "
7638 "function is problematic because -1 is a valid address (255.255.255.255). "
7639 "Avoid its use in favor of B<inet_aton>(), B<inet_pton>(3), or "
7640 "B<getaddrinfo>(3) which provide a cleaner way to indicate error return."
7644 #: build/C/man3/inet.3:159
7646 "The B<inet_network>() function converts I<cp>, a string in IPv4 "
7647 "numbers-and-dots notation, into a number in host byte order suitable for use "
7648 "as an Internet network address. On success, the converted address is "
7649 "returned. If the input is invalid, -1 is returned."
7653 #: build/C/man3/inet.3:167
7655 "The B<inet_ntoa>() function converts the Internet host address I<in>, given "
7656 "in network byte order, to a string in IPv4 dotted-decimal notation. The "
7657 "string is returned in a statically allocated buffer, which subsequent calls "
7662 #: build/C/man3/inet.3:173
7664 "The B<inet_lnaof>() function returns the local network address part of the "
7665 "Internet address I<in>. The returned value is in host byte order."
7669 #: build/C/man3/inet.3:179
7671 "The B<inet_netof>() function returns the network number part of the "
7672 "Internet address I<in>. The returned value is in host byte order."
7676 #: build/C/man3/inet.3:190
7678 "The B<inet_makeaddr>() function is the converse of B<inet_netof>() and "
7679 "B<inet_lnaof>(). It returns an Internet host address in network byte order, "
7680 "created by combining the network number I<net> with the local address "
7681 "I<host>, both in host byte order."
7685 #: build/C/man3/inet.3:200
7687 "The structure I<in_addr> as used in B<inet_ntoa>(), B<inet_makeaddr>(), "
7688 "B<inet_lnaof>() and B<inet_netof>() is defined in "
7689 "I<E<lt>netinet/in.hE<gt>> as:"
7693 #: build/C/man3/inet.3:204
7695 msgid "typedef uint32_t in_addr_t;\n"
7699 #: build/C/man3/inet.3:208
7702 "struct in_addr {\n"
7703 " in_addr_t s_addr;\n"
7708 #: build/C/man3/inet.3:218
7710 "4.3BSD. B<inet_addr>() and B<inet_ntoa>() are specified in POSIX.1-2001. "
7711 "B<inet_aton>() is not specified in POSIX.1-2001, but is available on most "
7716 #: build/C/man3/inet.3:222
7718 "On the i386 the host byte order is Least Significant Byte first (little "
7719 "endian), whereas the network byte order, as used on the Internet, is Most "
7720 "Significant Byte first (big endian)."
7724 #: build/C/man3/inet.3:231
7726 "B<inet_lnaof>(), B<inet_netof>(), and B<inet_makeaddr>() are legacy "
7727 "functions that assume they are dealing with I<classful network addresses>. "
7728 "Classful networking divides IPv4 network addresses into host and network "
7729 "components at byte boundaries, as follows:"
7733 #: build/C/man3/inet.3:231
7739 #: build/C/man3/inet.3:237
7741 "This address type is indicated by the value 0 in the most significant bit of "
7742 "the (network byte ordered) address. The network address is contained in the "
7743 "most significant byte, and the host address occupies the remaining three "
7748 #: build/C/man3/inet.3:237
7754 #: build/C/man3/inet.3:243
7756 "This address type is indicated by the binary value 10 in the most "
7757 "significant two bits of the address. The network address is contained in "
7758 "the two most significant bytes, and the host address occupies the remaining "
7763 #: build/C/man3/inet.3:243
7769 #: build/C/man3/inet.3:249
7771 "This address type is indicated by the binary value 110 in the most "
7772 "significant three bits of the address. The network address is contained in "
7773 "the three most significant bytes, and the host address occupies the "
7778 #: build/C/man3/inet.3:254
7780 "Classful network addresses are now obsolete, having been superseded by "
7781 "Classless Inter-Domain Routing (CIDR), which divides addresses into network "
7782 "and host components at arbitrary bit (rather than byte) boundaries."
7786 #: build/C/man3/inet.3:261
7788 "An example of the use of B<inet_aton>() and B<inet_ntoa>() is shown "
7789 "below. Here are some example runs:"
7793 #: build/C/man3/inet.3:268
7796 "$B< ./a.out 226.000.000.037> # Last byte is in octal\n"
7798 "$B< ./a.out 0x7f.1 > # First byte is in hex\n"
7803 #: build/C/man3/inet.3:277
7806 "#define _BSD_SOURCE\n"
7807 "#include E<lt>arpa/inet.hE<gt>\n"
7808 "#include E<lt>stdio.hE<gt>\n"
7809 "#include E<lt>stdlib.hE<gt>\n"
7813 #: build/C/man3/inet.3:282
7817 "main(int argc, char *argv[])\n"
7819 " struct in_addr addr;\n"
7823 #: build/C/man3/inet.3:287
7826 " if (argc != 2) {\n"
7827 " fprintf(stderr, \"%s E<lt>dotted-addressE<gt>\\en\", argv[0]);\n"
7828 " exit(EXIT_FAILURE);\n"
7833 #: build/C/man3/inet.3:292
7836 " if (inet_aton(argv[1], &addr) == 0) {\n"
7837 " perror(\"inet_aton\");\n"
7838 " exit(EXIT_FAILURE);\n"
7843 #: build/C/man3/inet.3:296
7846 " printf(\"%s\\en\", inet_ntoa(addr));\n"
7847 " exit(EXIT_SUCCESS);\n"
7852 #: build/C/man3/inet.3:307
7854 "B<byteorder>(3), B<getaddrinfo>(3), B<gethostbyname>(3), B<getnameinfo>(3), "
7855 "B<getnetent>(3), B<inet_ntop>(3), B<inet_pton>(3), B<hosts>(5), "
7860 #: build/C/man3/inet_ntop.3:24
7866 #: build/C/man3/inet_ntop.3:24
7872 #: build/C/man3/inet_ntop.3:27
7873 msgid "inet_ntop - convert IPv4 and IPv6 addresses from binary to text form"
7877 #: build/C/man3/inet_ntop.3:33
7880 "B<const char *inet_ntop(int >I<af>B<, const void *>I<src>B<,>\n"
7881 "B< char *>I<dst>B<, socklen_t >I<size>B<);>\n"
7885 #: build/C/man3/inet_ntop.3:46
7887 "This function converts the network address structure I<src> in the I<af> "
7888 "address family into a character string. The resulting string is copied to "
7889 "the buffer pointed to by I<dst>, which must be a non-NULL pointer. The "
7890 "caller specifies the number of bytes available in this buffer in the "
7895 #: build/C/man3/inet_ntop.3:55
7897 "B<inet_ntop>() extends the B<inet_ntoa>(3) function to support multiple "
7898 "address families, B<inet_ntoa>(3) is now considered to be deprecated in "
7899 "favor of B<inet_ntop>(). The following address families are currently "
7904 #: build/C/man3/inet_ntop.3:68
7906 "I<src> points to a I<struct in_addr> (in network byte order) which is "
7907 "converted to an IPv4 network address in the dotted-decimal format, "
7908 "\"I<ddd.ddd.ddd.ddd>\". The buffer I<dst> must be at least "
7909 "B<INET_ADDRSTRLEN> bytes long."
7913 #: build/C/man3/inet_ntop.3:81
7915 "I<src> points to a I<struct in6_addr> (in network byte order) which is "
7916 "converted to a representation of this address in the most appropriate IPv6 "
7917 "network address format for this address. The buffer I<dst> must be at least "
7918 "B<INET6_ADDRSTRLEN> bytes long."
7922 #: build/C/man3/inet_ntop.3:89
7924 "On success, B<inet_ntop>() returns a non-NULL pointer to I<dst>. NULL is "
7925 "returned if there was an error, with I<errno> set to indicate the error."
7929 #: build/C/man3/inet_ntop.3:90
7931 msgid "B<EAFNOSUPPORT>"
7935 #: build/C/man3/inet_ntop.3:94
7936 msgid "I<af> was not a valid address family."
7940 #: build/C/man3/inet_ntop.3:94
7946 #: build/C/man3/inet_ntop.3:98
7947 msgid "The converted address string would exceed the size given by I<size>."
7950 #. 2.1.3: size_t, 2.1.91: socklen_t
7952 #: build/C/man3/inet_ntop.3:110
7954 "POSIX.1-2001. Note that RFC\\ 2553 defines a prototype where the last "
7955 "argument I<size> is of type I<size_t>. Many systems follow RFC\\ 2553. "
7956 "Glibc 2.0 and 2.1 have I<size_t>, but 2.2 and later have I<socklen_t>."
7960 #: build/C/man3/inet_ntop.3:113
7961 msgid "B<AF_INET6> converts IPv4-mapped IPv6 addresses into an IPv6 format."
7965 #: build/C/man3/inet_ntop.3:116
7966 msgid "See B<inet_pton>(3)."
7970 #: build/C/man3/inet_ntop.3:120
7971 msgid "B<getnameinfo>(3), B<inet>(3), B<inet_pton>(3)"
7975 #: build/C/man3/inet_pton.3:25
7981 #: build/C/man3/inet_pton.3:25
7987 #: build/C/man3/inet_pton.3:28
7988 msgid "inet_pton - convert IPv4 and IPv6 addresses from text to binary form"
7992 #: build/C/man3/inet_pton.3:33
7994 msgid "B<int inet_pton(int >I<af>B<, const char *>I<src>B<, void *>I<dst>B<);>\n"
7998 #: build/C/man3/inet_pton.3:49
8000 "This function converts the character string I<src> into a network address "
8001 "structure in the I<af> address family, then copies the network address "
8002 "structure to I<dst>. The I<af> argument must be either B<AF_INET> or "
8007 #: build/C/man3/inet_pton.3:51
8008 msgid "The following address families are currently supported:"
8012 #: build/C/man3/inet_pton.3:65
8014 "I<src> points to a character string containing an IPv4 network address in "
8015 "dotted-decimal format, \"I<ddd.ddd.ddd.ddd>\", where I<ddd> is a decimal "
8016 "number of up to three digits in the range 0 to 255. The address is "
8017 "converted to a I<struct in_addr> and copied to I<dst>, which must be "
8018 "I<sizeof(struct in_addr)> (4) bytes (32 bits) long."
8022 #: build/C/man3/inet_pton.3:77
8024 "I<src> points to a character string containing an IPv6 network address. The "
8025 "address is converted to a I<struct in6_addr> and copied to I<dst>, which "
8026 "must be I<sizeof(struct in6_addr)> (16) bytes (128 bits) long. The allowed "
8027 "formats for IPv6 addresses follow these rules:"
8031 #: build/C/man3/inet_pton.3:78
8037 #: build/C/man3/inet_pton.3:85
8039 "The preferred format is I<x:x:x:x:x:x:x:x>. This form consists of eight "
8040 "hexadecimal numbers, each of which expresses a 16-bit value (i.e., each I<x> "
8041 "can be up to 4 hex digits)."
8045 #: build/C/man3/inet_pton.3:85
8051 #: build/C/man3/inet_pton.3:98
8053 "A series of contiguous zero values in the preferred format can be "
8054 "abbreviated to I<::>. Only one instance of I<::> can occur in an address. "
8055 "For example, the loopback address I<0:0:0:0:0:0:0:1> can be abbreviated as "
8056 "I<::1>. The wildcard address, consisting of all zeros, can be written as "
8061 #: build/C/man3/inet_pton.3:98
8067 #: build/C/man3/inet_pton.3:111
8069 "An alternate format is useful for expressing IPv4-mapped IPv6 addresses. "
8070 "This form is written as I<x:x:x:x:x:x:d.d.d.d>, where the six leading I<x>s "
8071 "are hexadecimal values that define the six most-significant 16-bit pieces of "
8072 "the address (i.e., 96 bits), and the I<d>s express a value in dotted-decimal "
8073 "notation that defines the least significant 32 bits of the address. An "
8074 "example of such an address is I<::FFFF:204.152.189.116>."
8078 #: build/C/man3/inet_pton.3:114
8079 msgid "See RFC 2373 for further details on the representation of IPv6 addresses."
8083 #: build/C/man3/inet_pton.3:127
8085 "B<inet_pton>() returns 1 on success (network address was successfully "
8086 "converted). 0 is returned if I<src> does not contain a character string "
8087 "representing a valid network address in the specified address family. If "
8088 "I<af> does not contain a valid address family, -1 is returned and I<errno> "
8089 "is set to B<EAFNOSUPPORT>."
8093 #: build/C/man3/inet_pton.3:148
8095 "Unlike B<inet_aton>(3) and B<inet_addr>(3), B<inet_pton>() supports IPv6 "
8096 "addresses. On the other hand, B<inet_pton>() only accepts IPv4 addresses "
8097 "in dotted-decimal notation, whereas B<inet_aton>(3) and B<inet_addr>(3) "
8098 "allow the more general numbers-and-dots notation (hexadecimal and octal "
8099 "number formats, and formats that don't require all four bytes to be "
8100 "explicitly written). For an interface that handles both IPv6 addresses, and "
8101 "IPv4 addresses in numbers-and-dots notation, see B<getaddrinfo>(3)."
8105 #: build/C/man3/inet_pton.3:154
8107 "B<AF_INET6> does not recognize IPv4 addresses. An explicit IPv4-mapped IPv6 "
8108 "address must be supplied in I<src> instead."
8112 #: build/C/man3/inet_pton.3:160
8114 "The program below demonstrates the use of B<inet_pton>() and "
8115 "B<inet_ntop>(3). Here are some example runs:"
8119 #: build/C/man3/inet_pton.3:169
8122 "$B< ./a.out i6 0:0:0:0:0:0:0:0>\n"
8124 "$B< ./a.out i6 1:0:0:0:0:0:0:8>\n"
8126 "$B< ./a.out i6 0:0:0:0:0:FFFF:204.152.189.116>\n"
8127 "::ffff:204.152.189.116\n"
8131 #: build/C/man3/inet_pton.3:178
8134 "#include E<lt>arpa/inet.hE<gt>\n"
8135 "#include E<lt>stdio.hE<gt>\n"
8136 "#include E<lt>stdlib.hE<gt>\n"
8137 "#include E<lt>string.hE<gt>\n"
8141 #: build/C/man3/inet_pton.3:185
8145 "main(int argc, char *argv[])\n"
8147 " unsigned char buf[sizeof(struct in6_addr)];\n"
8149 " char str[INET6_ADDRSTRLEN];\n"
8153 #: build/C/man3/inet_pton.3:190
8156 " if (argc != 3) {\n"
8157 " fprintf(stderr, \"Usage: %s {i4|i6|E<lt>numE<gt>} string\\en\", "
8159 " exit(EXIT_FAILURE);\n"
8164 #: build/C/man3/inet_pton.3:193
8167 " domain = (strcmp(argv[1], \"i4\") == 0) ? AF_INET :\n"
8168 " (strcmp(argv[1], \"i6\") == 0) ? AF_INET6 : atoi(argv[1]);\n"
8172 #: build/C/man3/inet_pton.3:202
8175 " s = inet_pton(domain, argv[2], buf);\n"
8176 " if (s E<lt>= 0) {\n"
8178 " fprintf(stderr, \"Not in presentation format\");\n"
8180 " perror(\"inet_pton\");\n"
8181 " exit(EXIT_FAILURE);\n"
8186 #: build/C/man3/inet_pton.3:207
8189 " if (inet_ntop(domain, buf, str, INET6_ADDRSTRLEN) == NULL) {\n"
8190 " perror(\"inet_ntop\");\n"
8191 " exit(EXIT_FAILURE);\n"
8196 #: build/C/man3/inet_pton.3:209
8198 msgid " printf(\"%s\\en\", str);\n"
8202 #: build/C/man3/inet_pton.3:217
8203 msgid "B<getaddrinfo>(3), B<inet>(3), B<inet_ntop>(3)"
8207 #: build/C/man7/ip.7:12
8213 #: build/C/man7/ip.7:12
8219 #: build/C/man7/ip.7:15
8220 msgid "ip - Linux IPv4 protocol implementation"
8224 #: build/C/man7/ip.7:21 build/C/man7/ipv6.7:14 build/C/man7/raw.7:16 build/C/man7/tcp.7:23 build/C/man7/udp.7:15
8225 msgid "B<#include E<lt>netinet/in.hE<gt>>"
8229 #: build/C/man7/ip.7:23
8230 msgid "B<#include E<lt>netinet/ip.hE<gt> >/* superset of previous */"
8234 #: build/C/man7/ip.7:25
8235 msgid "I<tcp_socket>B< = socket(AF_INET, SOCK_STREAM, 0);>"
8239 #: build/C/man7/ip.7:27
8240 msgid "I<udp_socket>B< = socket(AF_INET, SOCK_DGRAM, 0);>"
8244 #: build/C/man7/ip.7:29
8245 msgid "I<raw_socket>B< = socket(AF_INET, SOCK_RAW, >I<protocol>B<);>"
8248 #. FIXME has someone verified that 2.1 is really 1812 compliant?
8250 #: build/C/man7/ip.7:36
8252 "Linux implements the Internet Protocol, version 4, described in RFC\\ 791 "
8253 "and RFC\\ 1122. B<ip> contains a level 2 multicasting implementation "
8254 "conforming to RFC\\ 1112. It also contains an IP router including a packet "
8259 #: build/C/man7/ip.7:40
8261 "The programming interface is BSD-sockets compatible. For more information "
8262 "on sockets, see B<socket>(7)."
8266 #: build/C/man7/ip.7:71
8268 "An IP socket is created by calling the B<socket>(2) function as "
8269 "B<socket(AF_INET, >I<socket_type>B<, >I<protocol>B<)>. Valid socket types "
8270 "are B<SOCK_STREAM> to open a B<tcp>(7) socket, B<SOCK_DGRAM> to open a "
8271 "B<udp>(7) socket, or B<SOCK_RAW> to open a B<raw>(7) socket to access the "
8272 "IP protocol directly. I<protocol> is the IP protocol in the IP header to be "
8273 "received or sent. The only valid values for I<protocol> are 0 and "
8274 "B<IPPROTO_TCP> for TCP sockets, and 0 and B<IPPROTO_UDP> for UDP sockets. "
8275 "For B<SOCK_RAW> you may specify a valid IANA IP protocol defined in RFC\\ "
8276 "1700 assigned numbers."
8279 #. FIXME ip current does an autobind in listen, but I'm not sure
8280 #. if that should be documented.
8282 #: build/C/man7/ip.7:90
8284 "When a process wants to receive new incoming packets or connections, it "
8285 "should bind a socket to a local interface address using B<bind>(2). Only "
8286 "one IP socket may be bound to any given local (address, port) pair. When "
8287 "B<INADDR_ANY> is specified in the bind call, the socket will be bound to "
8288 "I<all> local interfaces. When B<listen>(2) or B<connect>(2) are called on "
8289 "an unbound socket, it is automatically bound to a random free port with the "
8290 "local address set to B<INADDR_ANY>."
8294 #: build/C/man7/ip.7:96
8296 "A TCP local socket address that has been bound is unavailable for some time "
8297 "after closing, unless the B<SO_REUSEADDR> flag has been set. Care should be "
8298 "taken when using this flag as it makes TCP less reliable."
8302 #: build/C/man7/ip.7:107
8304 "An IP socket address is defined as a combination of an IP interface address "
8305 "and a 16-bit port number. The basic IP protocol does not supply port "
8306 "numbers, they are implemented by higher level protocols like B<udp>(7) and "
8307 "B<tcp>(7). On raw sockets I<sin_port> is set to the IP protocol."
8311 #: build/C/man7/ip.7:115
8314 "struct sockaddr_in {\n"
8315 " sa_family_t sin_family; /* address family: AF_INET */\n"
8316 " in_port_t sin_port; /* port in network byte order */\n"
8317 " struct in_addr sin_addr; /* internet address */\n"
8322 #: build/C/man7/ip.7:120
8325 "/* Internet address. */\n"
8326 "struct in_addr {\n"
8327 " uint32_t s_addr; /* address in network byte order */\n"
8332 #: build/C/man7/ip.7:145
8334 "I<sin_family> is always set to B<AF_INET>. This is required; in Linux 2.2 "
8335 "most networking functions return B<EINVAL> when this setting is missing. "
8336 "I<sin_port> contains the port in network byte order. The port numbers below "
8337 "1024 are called I<privileged ports> (or sometimes: I<reserved ports>). Only "
8338 "privileged processes (i.e., those having the B<CAP_NET_BIND_SERVICE> "
8339 "capability) may B<bind>(2) to these sockets. Note that the raw IPv4 "
8340 "protocol as such has no concept of a port, they are only implemented by "
8341 "higher protocols like B<tcp>(7) and B<udp>(7)."
8345 #: build/C/man7/ip.7:164
8347 "I<sin_addr> is the IP host address. The I<s_addr> member of I<struct "
8348 "in_addr> contains the host interface address in network byte order. "
8349 "I<in_addr> should be assigned one of the B<INADDR_*> values (e.g., "
8350 "B<INADDR_ANY>) or set using the B<inet_aton>(3), B<inet_addr>(3), "
8351 "B<inet_makeaddr>(3) library functions or directly with the name resolver "
8352 "(see B<gethostbyname>(3))."
8355 #. Leave a loophole for XTP @)
8357 #: build/C/man7/ip.7:176
8359 "IPv4 addresses are divided into unicast, broadcast and multicast addresses. "
8360 "Unicast addresses specify a single interface of a host, broadcast addresses "
8361 "specify all hosts on a network and multicast addresses address all hosts in "
8362 "a multicast group. Datagrams to broadcast addresses can be only sent or "
8363 "received when the B<SO_BROADCAST> socket flag is set. In the current "
8364 "implementation, connection-oriented sockets are only allowed to use unicast "
8369 #: build/C/man7/ip.7:184
8371 "Note that the address and the port are always stored in network byte order. "
8372 "In particular, this means that you need to call B<htons>(3) on the number "
8373 "that is assigned to a port. All address/port manipulation functions in the "
8374 "standard library work in network byte order."
8378 #: build/C/man7/ip.7:197
8380 "There are several special addresses: B<INADDR_LOOPBACK> (127.0.0.1) always "
8381 "refers to the local host via the loopback device; B<INADDR_ANY> (0.0.0.0) "
8382 "means any address for binding; B<INADDR_BROADCAST> (255.255.255.255) means "
8383 "any host and has the same effect on bind as B<INADDR_ANY> for historical "
8387 #. or SOL_IP on Linux
8389 #: build/C/man7/ip.7:206
8391 "IP supports some protocol-specific socket options that can be set with "
8392 "B<setsockopt>(2) and read with B<getsockopt>(2). The socket option level "
8393 "for IP is B<IPPROTO_IP>. A boolean integer flag is zero when it is false, "
8398 #: build/C/man7/ip.7:206
8400 msgid "B<IP_ADD_MEMBERSHIP> (since Linux 1.2)"
8404 #: build/C/man7/ip.7:212
8405 msgid "Join a multicast group. Argument is an I<ip_mreqn> structure."
8409 #: build/C/man7/ip.7:222
8412 "struct ip_mreqn {\n"
8413 " struct in_addr imr_multiaddr; /* IP multicast group\n"
8415 " struct in_addr imr_address; /* IP address of local\n"
8417 " int imr_ifindex; /* interface index */\n"
8421 #. (i.e., within the 224.0.0.0-239.255.255.255 range)
8423 #: build/C/man7/ip.7:243
8425 "I<imr_multiaddr> contains the address of the multicast group the application "
8426 "wants to join or leave. It must be a valid multicast address (or "
8427 "B<setsockopt>(2) fails with the error B<EINVAL>). I<imr_address> is the "
8428 "address of the local interface with which the system should join the "
8429 "multicast group; if it is equal to B<INADDR_ANY> an appropriate interface is "
8430 "chosen by the system. I<imr_ifindex> is the interface index of the "
8431 "interface that should join/leave the I<imr_multiaddr> group, or 0 to "
8432 "indicate any interface."
8436 #: build/C/man7/ip.7:258
8438 "The I<ip_mreqn> structure is available only since Linux 2.2. For "
8439 "compatibility, the old I<ip_mreq> structure (present since Linux 1.2) is "
8440 "still supported; it differs from I<ip_mreqn> only by not including the "
8441 "I<imr_ifindex> field. Only valid as a B<setsockopt>(2)."
8445 #: build/C/man7/ip.7:258
8447 msgid "B<IP_DROP_MEMBERSHIP> (since Linux 1.2)"
8451 #: build/C/man7/ip.7:267
8453 "Leave a multicast group. Argument is an I<ip_mreqn> or I<ip_mreq> structure "
8454 "similar to B<IP_ADD_MEMBERSHIP>."
8458 #: build/C/man7/ip.7:267
8460 msgid "B<IP_FREEBIND> (since Linux 2.4)"
8463 #. Precisely: 2.4.0-test10
8465 #: build/C/man7/ip.7:280
8467 "If enabled, this boolean option allows binding to an IP address that is "
8468 "nonlocal or does not (yet) exist. This permits listening on a socket, "
8469 "without requiring the underlying network interface or the specified dynamic "
8470 "IP address to be up at the time that the application is trying to bind to "
8471 "it. This option is the per-socket equivalent of the I<ip_nonlocal_bind> "
8472 "I</proc> interface described below."
8476 #: build/C/man7/ip.7:280
8478 msgid "B<IP_HDRINCL> (since Linux 2.0)"
8482 #. FIXME Document IP_IPSEC_POLICY
8483 #. Since Linux 2.5.47
8484 #. Needs CAP_NET_ADMIN
8486 #: build/C/man7/ip.7:300
8488 "If enabled, the user supplies an IP header in front of the user data. Only "
8489 "valid for B<SOCK_RAW> sockets. See B<raw>(7) for more information. When "
8490 "this flag is enabled the values set by B<IP_OPTIONS>, B<IP_TTL> and "
8491 "B<IP_TOS> are ignored."
8495 #: build/C/man7/ip.7:300
8497 msgid "B<IP_MTU> (since Linux 2.2)"
8500 #. Precisely: 2.1.124
8502 #: build/C/man7/ip.7:308
8504 "Retrieve the current known path MTU of the current socket. Only valid when "
8505 "the socket has been connected. Returns an integer. Only valid as a "
8510 #: build/C/man7/ip.7:308
8512 msgid "B<IP_MTU_DISCOVER> (since Linux 2.2)"
8515 #. Precisely: 2.1.124
8517 #: build/C/man7/ip.7:329
8519 "Set or receive the Path MTU Discovery setting for a socket. When enabled, "
8520 "Linux will perform Path MTU Discovery as defined in RFC\\ 1191 on "
8521 "B<SOCK_STREAM> sockets. For non-B<SOCK_STREAM> sockets, B<IP_PMTUDISC_DO> "
8522 "forces the don't-fragment flag to be set on all outgoing packets. It is the "
8523 "user's responsibility to packetize the data in MTU-sized chunks and to do "
8524 "the retransmits if necessary. The kernel will reject (with B<EMSGSIZE>) "
8525 "datagrams that are bigger than the known path MTU. B<IP_PMTUDISC_WANT> will "
8526 "fragment a datagram if needed according to the path MTU, or will set the "
8527 "don't-fragment flag otherwise."
8531 #: build/C/man7/ip.7:337
8533 "The system-wide default can be toggled between B<IP_PMTUDISC_WANT> and "
8534 "B<IP_PMTUDISC_DONT> by writing (respectively, zero and nonzero values) to "
8535 "the I</proc/sys/net/ipv4/ip_no_pmtu_disc> file."
8539 #: build/C/man7/ip.7:342
8541 msgid "Path MTU discovery value:Meaning\n"
8545 #: build/C/man7/ip.7:343
8547 msgid "IP_PMTUDISC_WANT:Use per-route settings.\n"
8551 #: build/C/man7/ip.7:344
8553 msgid "IP_PMTUDISC_DONT:Never do Path MTU Discovery.\n"
8557 #: build/C/man7/ip.7:345
8559 msgid "IP_PMTUDISC_DO:Always do Path MTU Discovery.\n"
8563 #: build/C/man7/ip.7:346
8565 msgid "IP_PMTUDISC_PROBE:Set DF but ignore Path MTU.\n"
8569 #: build/C/man7/ip.7:364
8571 "When PMTU discovery is enabled, the kernel automatically keeps track of the "
8572 "path MTU per destination host. When it is connected to a specific peer with "
8573 "B<connect>(2), the currently known path MTU can be retrieved conveniently "
8574 "using the B<IP_MTU> socket option (e.g., after an B<EMSGSIZE> error "
8575 "occurred). The path MTU may change over time. For connectionless sockets "
8576 "with many destinations, the new MTU for a given destination can also be "
8577 "accessed using the error queue (see B<IP_RECVERR>). A new error will be "
8578 "queued for every incoming MTU update."
8582 #: build/C/man7/ip.7:369
8584 "While MTU discovery is in progress, initial packets from datagram sockets "
8585 "may be dropped. Applications using UDP should be aware of this and not take "
8586 "it into account for their packet retransmit strategy."
8589 #. FIXME this is an ugly hack
8591 #: build/C/man7/ip.7:374
8593 "To bootstrap the path MTU discovery process on unconnected sockets, it is "
8594 "possible to start with a big datagram size (up to 64K-headers bytes long) "
8595 "and let it shrink by updates of the path MTU."
8599 #: build/C/man7/ip.7:383
8601 "To get an initial estimate of the path MTU, connect a datagram socket to the "
8602 "destination address using B<connect>(2) and retrieve the MTU by calling "
8603 "B<getsockopt>(2) with the B<IP_MTU> option."
8607 #: build/C/man7/ip.7:395
8609 "It is possible to implement RFC 4821 MTU probing with B<SOCK_DGRAM> or "
8610 "B<SOCK_RAW> sockets by setting a value of B<IP_PMTUDISC_PROBE> (available "
8611 "since Linux 2.6.22). This is also particularly useful for diagnostic tools "
8612 "such as B<tracepath>(8) that wish to deliberately send probe packets larger "
8613 "than the observed Path MTU."
8617 #: build/C/man7/ip.7:395
8619 msgid "B<IP_MULTICAST_IF> (since Linux 1.2)"
8623 #: build/C/man7/ip.7:404
8625 "Set the local device for a multicast socket. Argument is an I<ip_mreqn> or "
8626 "I<ip_mreq> structure similar to B<IP_ADD_MEMBERSHIP>."
8630 #: build/C/man7/ip.7:408
8631 msgid "When an invalid socket option is passed, B<ENOPROTOOPT> is returned."
8635 #: build/C/man7/ip.7:408
8637 msgid "B<IP_MULTICAST_LOOP> (since Linux 1.2)"
8641 #: build/C/man7/ip.7:412
8643 "Set or read a boolean integer argument that determines whether sent "
8644 "multicast packets should be looped back to the local sockets."
8648 #: build/C/man7/ip.7:412
8650 msgid "B<IP_MULTICAST_TTL> (since Linux 1.2)"
8654 #: build/C/man7/ip.7:420
8656 "Set or read the time-to-live value of outgoing multicast packets for this "
8657 "socket. It is very important for multicast packets to set the smallest TTL "
8658 "possible. The default is 1 which means that multicast packets don't leave "
8659 "the local network unless the user program explicitly requests it. Argument "
8664 #: build/C/man7/ip.7:420
8666 msgid "B<IP_NODEFRAG> (since Linux 2.6.36)"
8670 #: build/C/man7/ip.7:428
8672 "If enabled (argument is nonzero), the reassembly of outgoing packets is "
8673 "disabled in the netfilter layer. This option is only valid for B<SOCK_RAW> "
8674 "sockets. The argument is an integer."
8678 #: build/C/man7/ip.7:428
8680 msgid "B<IP_OPTIONS> (since Linux 2.0)"
8683 #. Precisely: 1.3.30
8684 #. FIXME Document IP_PASSSEC
8686 #. Since Linux 2.6.17
8687 #. commit 2c7946a7bf45ae86736ab3b43d0085e43947945c
8688 #. Author: Catherine Zhang <cxzhang@watson.ibm.com>
8690 #: build/C/man7/ip.7:462
8692 "Set or get the IP options to be sent with every packet from this socket. "
8693 "The arguments are a pointer to a memory buffer containing the options and "
8694 "the option length. The B<setsockopt>(2) call sets the IP options "
8695 "associated with a socket. The maximum option size for IPv4 is 40 bytes. "
8696 "See RFC\\ 791 for the allowed options. When the initial connection request "
8697 "packet for a B<SOCK_STREAM> socket contains IP options, the IP options will "
8698 "be set automatically to the options from the initial packet with routing "
8699 "headers reversed. Incoming packets are not allowed to change options after "
8700 "the connection is established. The processing of all incoming source "
8701 "routing options is disabled by default and can be enabled by using the "
8702 "I<accept_source_route> I</proc> interface. Other options like timestamps "
8703 "are still handled. For datagram sockets, IP options can be only set by the "
8704 "local user. Calling B<getsockopt>(2) with B<IP_OPTIONS> puts the current "
8705 "IP options used for sending into the supplied buffer."
8709 #: build/C/man7/ip.7:462
8711 msgid "B<IP_PKTINFO> (since Linux 2.2)"
8714 #. Precisely: 2.1.68
8716 #: build/C/man7/ip.7:479
8718 "Pass an B<IP_PKTINFO> ancillary message that contains a I<pktinfo> structure "
8719 "that supplies some information about the incoming packet. This only works "
8720 "for datagram oriented sockets. The argument is a flag that tells the socket "
8721 "whether the B<IP_PKTINFO> message should be passed or not. The message "
8722 "itself can only be sent/retrieved as control message with a packet using "
8723 "B<recvmsg>(2) or B<sendmsg>(2)."
8727 #: build/C/man7/ip.7:488
8730 "struct in_pktinfo {\n"
8731 " unsigned int ipi_ifindex; /* Interface index */\n"
8732 " struct in_addr ipi_spec_dst; /* Local address */\n"
8733 " struct in_addr ipi_addr; /* Header Destination\n"
8738 #. FIXME elaborate on that.
8739 #. This field is grossly misnamed
8741 #: build/C/man7/ip.7:513
8743 "I<ipi_ifindex> is the unique index of the interface the packet was received "
8744 "on. I<ipi_spec_dst> is the local address of the packet and I<ipi_addr> is "
8745 "the destination address in the packet header. If B<IP_PKTINFO> is passed to "
8746 "B<sendmsg>(2) and I<ipi_spec_dst> is not zero, then it is used as the local "
8747 "source address for the routing table lookup and for setting up IP source "
8748 "route options. When I<ipi_ifindex> is not zero, the primary local address "
8749 "of the interface specified by the index overwrites I<ipi_spec_dst> for the "
8750 "routing table lookup."
8754 #: build/C/man7/ip.7:513
8756 msgid "B<IP_RECVERR> (since Linux 2.2)"
8759 #. Precisely: 2.1.15
8760 #. or SOL_IP on Linux
8762 #: build/C/man7/ip.7:535
8764 "Enable extended reliable error message passing. When enabled on a datagram "
8765 "socket, all generated errors will be queued in a per-socket error queue. "
8766 "When the user receives an error from a socket operation, the errors can be "
8767 "received by calling B<recvmsg>(2) with the B<MSG_ERRQUEUE> flag set. The "
8768 "I<sock_extended_err> structure describing the error will be passed in an "
8769 "ancillary message with the type B<IP_RECVERR> and the level B<IPPROTO_IP>. "
8770 "This is useful for reliable error handling on unconnected sockets. The "
8771 "received data portion of the error queue contains the error packet."
8775 #: build/C/man7/ip.7:541
8776 msgid "The B<IP_RECVERR> control message contains a I<sock_extended_err> structure:"
8780 #: build/C/man7/ip.7:549
8783 "#define SO_EE_ORIGIN_NONE 0\n"
8784 "#define SO_EE_ORIGIN_LOCAL 1\n"
8785 "#define SO_EE_ORIGIN_ICMP 2\n"
8786 "#define SO_EE_ORIGIN_ICMP6 3\n"
8790 #: build/C/man7/ip.7:560
8793 "struct sock_extended_err {\n"
8794 " uint32_t ee_errno; /* error number */\n"
8795 " uint8_t ee_origin; /* where the error originated */\n"
8796 " uint8_t ee_type; /* type */\n"
8797 " uint8_t ee_code; /* code */\n"
8798 " uint8_t ee_pad;\n"
8799 " uint32_t ee_info; /* additional information */\n"
8800 " uint32_t ee_data; /* other data */\n"
8801 " /* More data may follow */\n"
8806 #: build/C/man7/ip.7:562
8808 msgid "struct sockaddr *SO_EE_OFFENDER(struct sock_extended_err *);\n"
8812 #: build/C/man7/ip.7:585
8814 "I<ee_errno> contains the I<errno> number of the queued error. I<ee_origin> "
8815 "is the origin code of where the error originated. The other fields are "
8816 "protocol-specific. The macro B<SO_EE_OFFENDER> returns a pointer to the "
8817 "address of the network object where the error originated from given a "
8818 "pointer to the ancillary message. If this address is not known, the "
8819 "I<sa_family> member of the I<sockaddr> contains B<AF_UNSPEC> and the other "
8820 "fields of the I<sockaddr> are undefined."
8823 #. FIXME . Is it a good idea to document that? It is a dubious feature.
8828 #. has slightly different semantics. Instead of
8829 #. saving the errors for the next timeout, it passes all incoming
8830 #. errors immediately to the user.
8831 #. This might be useful for very short-lived TCP connections which
8832 #. need fast error handling. Use this option with care:
8833 #. it makes TCP unreliable
8834 #. by not allowing it to recover properly from routing
8835 #. shifts and other normal
8836 #. conditions and breaks the protocol specification.
8838 #: build/C/man7/ip.7:644
8840 "IP uses the I<sock_extended_err> structure as follows: I<ee_origin> is set "
8841 "to B<SO_EE_ORIGIN_ICMP> for errors received as an ICMP packet, or "
8842 "B<SO_EE_ORIGIN_LOCAL> for locally generated errors. Unknown values should "
8843 "be ignored. I<ee_type> and I<ee_code> are set from the type and code fields "
8844 "of the ICMP header. I<ee_info> contains the discovered MTU for B<EMSGSIZE> "
8845 "errors. The message also contains the I<sockaddr_in of the node> caused the "
8846 "error, which can be accessed with the B<SO_EE_OFFENDER> macro. The "
8847 "I<sin_family> field of the B<SO_EE_OFFENDER> address is B<AF_UNSPEC> when "
8848 "the source was unknown. When the error originated from the network, all IP "
8849 "options (B<IP_OPTIONS>, B<IP_TTL>, etc.) enabled on the socket and contained "
8850 "in the error packet are passed as control messages. The payload of the "
8851 "packet causing the error is returned as normal payload. Note that TCP has "
8852 "no error queue; B<MSG_ERRQUEUE> is not permitted on B<SOCK_STREAM> sockets. "
8853 "B<IP_RECVERR> is valid for TCP, but all errors are returned by socket "
8854 "function return or B<SO_ERROR> only."
8858 #: build/C/man7/ip.7:649
8860 "For raw sockets, B<IP_RECVERR> enables passing of all received ICMP errors "
8861 "to the application, otherwise errors are only reported on connected sockets"
8865 #: build/C/man7/ip.7:653
8867 "It sets or retrieves an integer boolean flag. B<IP_RECVERR> defaults to "
8872 #: build/C/man7/ip.7:653
8874 msgid "B<IP_RECVOPTS> (since Linux 2.2)"
8877 #. Precisely: 2.1.15
8879 #: build/C/man7/ip.7:664
8881 "Pass all incoming IP options to the user in a B<IP_OPTIONS> control "
8882 "message. The routing header and other options are already filled in for the "
8883 "local host. Not supported for B<SOCK_STREAM> sockets."
8887 #: build/C/man7/ip.7:664
8889 msgid "B<IP_RECVORIGDSTADDR> (since Linux 2.6.29)"
8892 #. commit e8b2dfe9b4501ed0047459b2756ba26e5a940a69
8894 #: build/C/man7/ip.7:675
8896 "This boolean option enables the B<IP_ORIGDSTADDR> ancillary message in "
8897 "B<recvmsg>(2), in which the kernel returns the original destination address "
8898 "of the datagram being received. The ancillary message contains a I<struct "
8903 #: build/C/man7/ip.7:675
8905 msgid "B<IP_RECVTOS> (since Linux 2.2)"
8908 #. Precisely: 2.1.68
8910 #: build/C/man7/ip.7:684
8912 "If enabled the B<IP_TOS> ancillary message is passed with incoming packets. "
8913 "It contains a byte which specifies the Type of Service/Precedence field of "
8914 "the packet header. Expects a boolean integer flag."
8918 #: build/C/man7/ip.7:684
8920 msgid "B<IP_RECVTTL> (since Linux 2.2)"
8923 #. Precisely: 2.1.68
8925 #: build/C/man7/ip.7:694
8927 "When this flag is set, pass a B<IP_TTL> control message with the time to "
8928 "live field of the received packet as a byte. Not supported for "
8929 "B<SOCK_STREAM> sockets."
8933 #: build/C/man7/ip.7:694
8935 msgid "B<IP_RETOPTS> (since Linux 2.2)"
8938 #. Precisely: 2.1.15
8940 #: build/C/man7/ip.7:701
8942 "Identical to B<IP_RECVOPTS>, but returns raw unprocessed options with "
8943 "timestamp and route record options not filled in for this hop."
8947 #: build/C/man7/ip.7:701
8949 msgid "B<IP_ROUTER_ALERT> (since Linux 2.2)"
8952 #. Precisely: 2.1.68
8954 #: build/C/man7/ip.7:713
8956 "Pass all to-be forwarded packets with the IP Router Alert option set to this "
8957 "socket. Only valid for raw sockets. This is useful, for instance, for "
8958 "user-space RSVP daemons. The tapped packets are not forwarded by the "
8959 "kernel; it is the user's responsibility to send them out again. Socket "
8960 "binding is ignored, such packets are only filtered by protocol. Expects an "
8965 #: build/C/man7/ip.7:713
8967 msgid "B<IP_TOS> (since Linux 1.0)"
8970 #. FIXME elaborate on this
8971 #. Needs CAP_NET_ADMIN
8973 #. Since Linux 2.6.27
8974 #. Author: KOVACS Krisztian <hidden@sch.bme.hu>
8975 #. http://lwn.net/Articles/252545/
8977 #: build/C/man7/ip.7:747
8979 "Set or receive the Type-Of-Service (TOS) field that is sent with every IP "
8980 "packet originating from this socket. It is used to prioritize packets on "
8981 "the network. TOS is a byte. There are some standard TOS flags defined: "
8982 "B<IPTOS_LOWDELAY> to minimize delays for interactive traffic, "
8983 "B<IPTOS_THROUGHPUT> to optimize throughput, B<IPTOS_RELIABILITY> to optimize "
8984 "for reliability, B<IPTOS_MINCOST> should be used for \"filler data\" where "
8985 "slow transmission doesn't matter. At most one of these TOS values can be "
8986 "specified. Other bits are invalid and shall be cleared. Linux sends "
8987 "B<IPTOS_LOWDELAY> datagrams first by default, but the exact behavior depends "
8988 "on the configured queueing discipline. Some high priority levels may "
8989 "require superuser privileges (the B<CAP_NET_ADMIN> capability). The "
8990 "priority can also be set in a protocol independent way by the "
8991 "(B<SOL_SOCKET>, B<SO_PRIORITY>) socket option (see B<socket>(7))."
8995 #: build/C/man7/ip.7:747
8997 msgid "B<IP_TRANSPARENT> (since Linux 2.6.24)"
9000 #. commit f5715aea4564f233767ea1d944b2637a5fd7cd2e
9001 #. This patch introduces the IP_TRANSPARENT socket option: enabling that
9002 #. will make the IPv4 routing omit the non-local source address check on
9003 #. output. Setting IP_TRANSPARENT requires NET_ADMIN capability.
9004 #. http://lwn.net/Articles/252545/
9006 #: build/C/man7/ip.7:764
9008 "Setting this boolean option enables transparent proxying on this socket. "
9009 "This socket option allows the calling application to bind to a nonlocal IP "
9010 "address and operate both as a client and a server with the foreign address "
9011 "as the local endpoint. NOTE: this requires that routing be set up in a way "
9012 "that packets going to the foreign address are routed through the TProxy "
9013 "box. Enabling this socket option requires superuser privileges (the "
9014 "B<CAP_NET_ADMIN> capability)."
9018 #: build/C/man7/ip.7:767
9020 "TProxy redirection with the iptables TPROXY target also requires that this "
9021 "option be set on the redirected socket."
9025 #: build/C/man7/ip.7:767
9027 msgid "B<IP_TTL> (since Linux 1.0)"
9030 #. FIXME Document IP_XFRM_POLICY
9031 #. Since Linux 2.5.48
9032 #. Needs CAP_NET_ADMIN
9034 #: build/C/man7/ip.7:774
9036 "Set or retrieve the current time-to-live field that is used in every packet "
9037 "sent from this socket."
9040 #. FIXME As at 2.6.12, 14 Jun 2005, the following are undocumented:
9044 #: build/C/man7/ip.7:790
9046 "The IP protocol supports a set of I</proc> interfaces to configure some "
9047 "global parameters. The parameters can be accessed by reading or writing "
9048 "files in the directory I</proc/sys/net/ipv4/>. Interfaces described as "
9049 "I<Boolean> take an integer value, with a nonzero value (\"true\") meaning "
9050 "that the corresponding option is enabled, and a zero value (\"false\") "
9051 "meaning that the option is disabled."
9055 #: build/C/man7/ip.7:790
9057 msgid "I<ip_always_defrag> (Boolean; since Linux 2.2.13)"
9061 #: build/C/man7/ip.7:796
9063 "[New with kernel 2.2.13; in earlier kernel versions this feature was "
9064 "controlled at compile time by the B<CONFIG_IP_ALWAYS_DEFRAG> option; this "
9065 "option is not present in 2.4.x and later]"
9069 #: build/C/man7/ip.7:803
9071 "When this boolean flag is enabled (not equal 0), incoming fragments (parts "
9072 "of IP packets that arose when some host between origin and destination "
9073 "decided that the packets were too large and cut them into pieces) will be "
9074 "reassembled (defragmented) before being processed, even if they are about to "
9079 #: build/C/man7/ip.7:810
9081 "Only enable if running either a firewall that is the sole link to your "
9082 "network or a transparent proxy; never ever use it for a normal router or "
9083 "host. Otherwise fragmented communication can be disturbed if the fragments "
9084 "travel over different links. Defragmentation also has a large memory and "
9089 #: build/C/man7/ip.7:814
9091 "This is automagically turned on when masquerading or transparent proxying "
9096 #: build/C/man7/ip.7:814
9098 msgid "I<ip_autoconfig> (since Linux 2.2 to 2.6.17)"
9101 #. Precisely: since 2.1.68
9102 #. FIXME document ip_autoconfig
9104 #: build/C/man7/ip.7:820
9105 msgid "Not documented."
9109 #: build/C/man7/ip.7:820
9111 msgid "I<ip_default_ttl> (integer; default: 64; since Linux 2.2)"
9114 #. Precisely: 2.1.15
9116 #: build/C/man7/ip.7:828
9118 "Set the default time-to-live value of outgoing packets. This can be changed "
9119 "per socket with the B<IP_TTL> option."
9123 #: build/C/man7/ip.7:828
9125 msgid "I<ip_dynaddr> (Boolean; default: disabled; since Linux 2.0.31)"
9129 #: build/C/man7/ip.7:835
9131 "Enable dynamic socket address and masquerading entry rewriting on interface "
9132 "address change. This is useful for dialup interface with changing IP "
9133 "addresses. 0 means no rewriting, 1 turns it on and 2 enables verbose mode."
9137 #: build/C/man7/ip.7:835
9139 msgid "I<ip_forward> (Boolean; default: disabled; since Linux 1.2)"
9143 #: build/C/man7/ip.7:840
9145 "Enable IP forwarding with a boolean flag. IP forwarding can be also set on "
9146 "a per-interface basis."
9150 #: build/C/man7/ip.7:840
9152 msgid "I<ip_local_port_range> (since Linux 2.2)"
9155 #. Precisely: since 2.1.68
9157 #: build/C/man7/ip.7:854
9159 "Contains two integers that define the default local port range allocated to "
9160 "sockets. Allocation starts with the first number and ends with the second "
9161 "number. Note that these should not conflict with the ports used by "
9162 "masquerading (although the case is handled). Also arbitrary choices may "
9163 "cause problems with some firewall packet filters that make assumptions about "
9164 "the local ports in use. First number should be at least greater than 1024, "
9165 "or better, greater than 4096, to avoid clashes with well known ports and to "
9166 "minimize firewall problems."
9170 #: build/C/man7/ip.7:854
9172 msgid "I<ip_no_pmtu_disc> (Boolean; default: disabled; since Linux 2.2)"
9175 #. Precisely: 2.1.15
9177 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
9179 #: build/C/man7/ip.7:866
9181 "If enabled, don't do Path MTU Discovery for TCP sockets by default. Path "
9182 "MTU discovery may fail if misconfigured firewalls (that drop all ICMP "
9183 "packets) or misconfigured interfaces (e.g., a point-to-point link where the "
9184 "both ends don't agree on the MTU) are on the path. It is better to fix the "
9185 "broken routers on the path than to turn off Path MTU Discovery globally, "
9186 "because not doing it incurs a high cost to the network."
9190 #: build/C/man7/ip.7:866
9192 msgid "I<ip_nonlocal_bind> (Boolean; default: disabled; since Linux 2.4)"
9195 #. Precisely: patch-2.4.0-test10
9197 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
9199 #: build/C/man7/ip.7:875
9201 "If set, allows processes to B<bind>(2) to nonlocal IP addresses, which can "
9202 "be quite useful, but may break some applications."
9206 #: build/C/man7/ip.7:875
9208 msgid "I<ip6frag_time> (integer; default: 30)"
9212 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
9214 #: build/C/man7/ip.7:880
9215 msgid "Time in seconds to keep an IPv6 fragment in memory."
9219 #: build/C/man7/ip.7:880
9221 msgid "I<ip6frag_secret_interval> (integer; default: 600)"
9225 #: build/C/man7/ip.7:884
9227 "Regeneration interval (in seconds) of the hash secret (or lifetime for the "
9228 "hash secret) for IPv6 fragments."
9232 #: build/C/man7/ip.7:884
9234 msgid "I<ipfrag_high_thresh> (integer), I<ipfrag_low_thresh> (integer)"
9238 #: build/C/man7/ip.7:891
9240 "If the amount of queued IP fragments reaches I<ipfrag_high_thresh>, the "
9241 "queue is pruned down to I<ipfrag_low_thresh>. Contains an integer with the "
9246 #: build/C/man7/ip.7:891
9251 #. FIXME Document the conf/*/* interfaces
9252 #. FIXME Document the route/* interfaces
9253 #. FIXME document them all
9255 #: build/C/man7/ip.7:898
9256 msgid "See B<arp>(7)."
9260 #. commented out the following because ipchains is obsolete
9262 #. The ioctls to configure firewalling are documented in
9268 #: build/C/man7/ip.7:911
9269 msgid "All ioctls described in B<socket>(7) apply to B<ip>."
9272 #. FIXME Add a discussion of multicasting
9274 #: build/C/man7/ip.7:915
9276 "Ioctls to configure generic device parameters are described in "
9281 #: build/C/man7/ip.7:935
9283 "The user tried to execute an operation without the necessary permissions. "
9284 "These include: sending a packet to a broadcast address without having the "
9285 "B<SO_BROADCAST> flag set; sending a packet via a I<prohibit> route; "
9286 "modifying firewall settings without superuser privileges (the "
9287 "B<CAP_NET_ADMIN> capability); binding to a privileged port without superuser "
9288 "privileges (the B<CAP_NET_BIND_SERVICE> capability)."
9292 #: build/C/man7/ip.7:948
9293 msgid "An connection operation on a nonblocking socket is already in progress."
9297 #: build/C/man7/ip.7:957
9299 "No valid routing table entry matches the destination address. This error "
9300 "can be caused by a ICMP message from a remote router or for the local "
9305 #: build/C/man7/ip.7:963
9307 "Invalid argument passed. For send operations this can be caused by sending "
9308 "to a I<blackhole> route."
9312 #: build/C/man7/ip.7:970
9313 msgid "Datagram is bigger than an MTU on the path and it cannot be fragmented."
9317 #: build/C/man7/ip.7:970
9319 msgid "B<ENOBUFS>, B<ENOMEM>"
9323 #: build/C/man7/ip.7:975
9325 "Not enough free memory. This often means that the memory allocation is "
9326 "limited by the socket buffer limits, not by the system memory, but this is "
9327 "not 100% consistent."
9331 #: build/C/man7/ip.7:993
9333 "User doesn't have permission to set high priority, change configuration, or "
9334 "send signals to the requested process or group."
9338 #: build/C/man7/ip.7:999
9339 msgid "The socket is not configured or an unknown socket type was requested."
9343 #: build/C/man7/ip.7:1006
9345 "Other errors may be generated by the overlaying protocols; see B<tcp>(7), "
9346 "B<raw>(7), B<udp>(7) and B<socket>(7)."
9349 #. IP_PASSSEC is Linux-specific
9350 #. IP_XFRM_POLICY is Linux-specific
9351 #. IP_IPSEC_POLICY is a nonstandard extension, also present on some BSDs
9353 #: build/C/man7/ip.7:1020
9355 "B<IP_FREEBIND>, B<IP_MTU>, B<IP_MTU_DISCOVER>, B<IP_RECVORIGDSTADDR>, "
9356 "B<IP_PKTINFO>, B<IP_RECVERR>, B<IP_ROUTER_ALERT>, and B<IP_TRANSPARENT> are "
9361 #: build/C/man7/ip.7:1029
9363 "Be very careful with the B<SO_BROADCAST> option - it is not privileged in "
9364 "Linux. It is easy to overload the network with careless broadcasts. For "
9365 "new application protocols it is better to use a multicast group instead of "
9366 "broadcasting. Broadcasting is discouraged."
9370 #: build/C/man7/ip.7:1039
9372 "Some other BSD sockets implementations provide B<IP_RCVDSTADDR> and "
9373 "B<IP_RECVIF> socket options to get the destination address and the interface "
9374 "of received datagrams. Linux has the more general B<IP_PKTINFO> for the "
9379 #: build/C/man7/ip.7:1048
9381 "Some BSD sockets implementations also provide an B<IP_RECVTTL> option, but "
9382 "an ancillary message with type B<IP_RECVTTL> is passed with the incoming "
9383 "packet. This is different from the B<IP_TTL> option used in Linux."
9387 #: build/C/man7/ip.7:1054
9389 "Using B<SOL_IP> socket options level isn't portable, BSD-based stacks use "
9390 "B<IPPROTO_IP> level."
9394 #: build/C/man7/ip.7:1067
9396 "For compatibility with Linux 2.0, the obsolete B<socket(AF_INET, "
9397 "SOCK_PACKET, >I<protocol>B<)> syntax is still supported to open a "
9398 "B<packet>(7) socket. This is deprecated and should be replaced by "
9399 "B<socket(AF_PACKET, SOCK_RAW, >I<protocol>B<)> instead. The main difference "
9400 "is the new I<sockaddr_ll> address structure for generic link layer "
9401 "information instead of the old B<sockaddr_pkt>."
9405 #: build/C/man7/ip.7:1072
9407 "The ioctls to configure IP-specific interface options and ARP tables are not "
9412 #: build/C/man7/ip.7:1076
9414 "Some versions of glibc forget to declare I<in_pktinfo>. Workaround "
9415 "currently is to copy it into your program from this man page."
9419 #. This man page was written by Andi Kleen.
9421 #: build/C/man7/ip.7:1086
9423 "Receiving the original destination address with B<MSG_ERRQUEUE> in "
9424 "I<msg_name> by B<recvmsg>(2) does not work in some 2.2 kernels."
9428 #: build/C/man7/ip.7:1097
9430 "B<recvmsg>(2), B<sendmsg>(2), B<byteorder>(3), B<ipfw>(4), "
9431 "B<capabilities>(7), B<netlink>(7), B<raw>(7), B<socket>(7), B<tcp>(7), "
9436 #: build/C/man7/ip.7:1099
9437 msgid "RFC\\ 791 for the original IP specification."
9441 #: build/C/man7/ip.7:1101
9442 msgid "RFC\\ 1122 for the IPv4 host requirements."
9445 #. FIXME autobind INADDR REUSEADDR
9447 #: build/C/man7/ip.7:1104
9448 msgid "RFC\\ 1812 for the IPv4 router requirements."
9452 #: build/C/man7/ipv6.7:7
9458 #: build/C/man7/ipv6.7:10
9459 msgid "ipv6 - Linux IPv6 protocol implementation"
9463 #: build/C/man7/ipv6.7:16
9464 msgid "I<tcp6_socket>B< = socket(AF_INET6, SOCK_STREAM, 0);>"
9468 #: build/C/man7/ipv6.7:18
9469 msgid "I<raw6_socket>B< = socket(AF_INET6, SOCK_RAW, >I<protocol>B<);>"
9473 #: build/C/man7/ipv6.7:20
9474 msgid "I<udp6_socket>B< = socket(AF_INET6, SOCK_DGRAM, >I<protocol>B<);>"
9478 #: build/C/man7/ipv6.7:27
9480 "Linux 2.2 optionally implements the Internet Protocol, version 6. This man "
9481 "page contains a description of the IPv6 basic API as implemented by the "
9482 "Linux kernel and glibc 2.1. The interface is based on the BSD sockets "
9483 "interface; see B<socket>(7)."
9487 #: build/C/man7/ipv6.7:32
9489 "The IPv6 API aims to be mostly compatible with the IPv4 API (see B<ip>(7)). "
9490 "Only differences are described in this man page."
9494 #: build/C/man7/ipv6.7:44
9496 "To bind an B<AF_INET6> socket to any process, the local address should be "
9497 "copied from the I<in6addr_any> variable which has I<in6_addr> type. In "
9498 "static initializations, B<IN6ADDR_ANY_INIT> may also be used, which expands "
9499 "to a constant expression. Both of them are in network byte order."
9503 #: build/C/man7/ipv6.7:51
9505 "The IPv6 loopback address (::1) is available in the global "
9506 "I<in6addr_loopback> variable. For initializations, B<IN6ADDR_LOOPBACK_INIT> "
9511 #: build/C/man7/ipv6.7:58
9513 "IPv4 connections can be handled with the v6 API by using the v4-mapped-on-v6 "
9514 "address type; thus a program only needs to support this API type to support "
9515 "both protocols. This is handled transparently by the address handling "
9516 "functions in the C library."
9520 #: build/C/man7/ipv6.7:63
9522 "IPv4 and IPv6 share the local port space. When you get an IPv4 connection "
9523 "or packet to a IPv6 socket, its source address will be mapped to v6 and it "
9524 "will be mapped to v6."
9528 #: build/C/man7/ipv6.7:73
9531 "struct sockaddr_in6 {\n"
9532 " sa_family_t sin6_family; /* AF_INET6 */\n"
9533 " in_port_t sin6_port; /* port number */\n"
9534 " uint32_t sin6_flowinfo; /* IPv6 flow information */\n"
9535 " struct in6_addr sin6_addr; /* IPv6 address */\n"
9536 " uint32_t sin6_scope_id; /* Scope ID (new in 2.4) */\n"
9541 #: build/C/man7/ipv6.7:77
9544 "struct in6_addr {\n"
9545 " unsigned char s6_addr[16]; /* IPv6 address */\n"
9550 #: build/C/man7/ipv6.7:99
9552 "I<sin6_family> is always set to B<AF_INET6>; I<sin6_port> is the protocol "
9553 "port (see I<sin_port> in B<ip>(7)); I<sin6_flowinfo> is the IPv6 flow "
9554 "identifier; I<sin6_addr> is the 128-bit IPv6 address. I<sin6_scope_id> is "
9555 "an ID depending on the scope of the address. It is new in Linux 2.4. Linux "
9556 "only supports it for link-local addresses, in that case I<sin6_scope_id> "
9557 "contains the interface index (see B<netdevice>(7))"
9561 #: build/C/man7/ipv6.7:105
9563 "IPv6 supports several address types: unicast to address a single host, "
9564 "multicast to address a group of hosts, anycast to address the nearest member "
9565 "of a group of hosts (not implemented in Linux), IPv4-on-IPv6 to address a "
9566 "IPv4 host, and other reserved address types."
9570 #: build/C/man7/ipv6.7:111
9572 "The address notation for IPv6 is a group of 8 4-digit hexadecimal numbers, "
9573 "separated with a \\(aq:\\(aq. \\&\"::\" stands for a string of 0 bits. "
9574 "Special addresses are ::1 for loopback and ::FFFF:E<lt>IPv4 addressE<gt> for "
9575 "IPv4-mapped-on-IPv6."
9579 #: build/C/man7/ipv6.7:113
9580 msgid "The port space of IPv6 is shared with IPv4."
9584 #: build/C/man7/ipv6.7:121
9586 "IPv6 supports some protocol-specific socket options that can be set with "
9587 "B<setsockopt>(2) and read with B<getsockopt>(2). The socket option level "
9588 "for IPv6 is B<IPPROTO_IPV6>. A boolean integer flag is zero when it is "
9589 "false, otherwise true."
9593 #: build/C/man7/ipv6.7:121
9595 msgid "B<IPV6_ADDRFORM>"
9599 #: build/C/man7/ipv6.7:135
9601 "Turn an B<AF_INET6> socket into a socket of a different address family. "
9602 "Only B<AF_INET> is currently supported for that. It is only allowed for "
9603 "IPv6 sockets that are connected and bound to a v4-mapped-on-v6 address. The "
9604 "argument is a pointer to an integer containing B<AF_INET>. This is useful "
9605 "to pass v4-mapped sockets as file descriptors to programs that don't know "
9606 "how to deal with the IPv6 API."
9610 #: build/C/man7/ipv6.7:135
9612 msgid "B<IPV6_ADD_MEMBERSHIP, IPV6_DROP_MEMBERSHIP>"
9615 #. FIXME IPV6_CHECKSUM is not documented, and probably should be
9616 #. FIXME IPV6_JOIN_ANYCAST is not documented, and probably should be
9617 #. FIXME IPV6_LEAVE_ANYCAST is not documented, and probably should be
9618 #. FIXME IPV6_RECVPKTINFO is not documented, and probably should be
9619 #. FIXME IPV6_2292PKTINFO is not documented, and probably should be
9620 #. FIXME there are probably many other IPV6_* socket options that
9621 #. should be documented
9623 #: build/C/man7/ipv6.7:148
9625 "Control membership in multicast groups. Argument is a pointer to a I<struct "
9626 "ipv6_mreq> structure."
9630 #: build/C/man7/ipv6.7:148
9636 #: build/C/man7/ipv6.7:154
9638 "Set the MTU to be used for the socket. The MTU is limited by the device MTU "
9639 "or the path MTU when path MTU discovery is enabled. Argument is a pointer "
9644 #: build/C/man7/ipv6.7:154
9646 msgid "B<IPV6_MTU_DISCOVER>"
9650 #: build/C/man7/ipv6.7:162
9652 "Control path-MTU discovery on the socket. See B<IP_MTU_DISCOVER> in "
9653 "B<ip>(7) for details."
9657 #: build/C/man7/ipv6.7:162
9659 msgid "B<IPV6_MULTICAST_HOPS>"
9663 #: build/C/man7/ipv6.7:169
9665 "Set the multicast hop limit for the socket. Argument is a pointer to an "
9666 "integer. -1 in the value means use the route default, otherwise it should "
9667 "be between 0 and 255."
9671 #: build/C/man7/ipv6.7:169
9673 msgid "B<IPV6_MULTICAST_IF>"
9677 #: build/C/man7/ipv6.7:181
9679 "Set the device for outgoing multicast packets on the socket. This is only "
9680 "allowed for B<SOCK_DGRAM> and B<SOCK_RAW> socket. The argument is a pointer "
9681 "to an interface index (see B<netdevice>(7)) in an integer."
9685 #: build/C/man7/ipv6.7:181
9687 msgid "B<IPV6_MULTICAST_LOOP>"
9691 #: build/C/man7/ipv6.7:185
9693 "Control whether the socket sees multicast packets that it has send itself. "
9694 "Argument is a pointer to boolean."
9698 #: build/C/man7/ipv6.7:185
9700 msgid "B<IPV6_PKTINFO>"
9704 #: build/C/man7/ipv6.7:196
9706 "Set delivery of the B<IPV6_PKTINFO> control message on incoming datagrams. "
9707 "Only allowed for B<SOCK_DGRAM> or B<SOCK_RAW> sockets. Argument is a "
9708 "pointer to a boolean value in an integer."
9712 #: build/C/man7/ipv6.7:199
9714 "B<IPV6_RTHDR, IPV6_AUTHHDR, IPV6_DSTOPTS, IPV6_HOPOPTS, IPV6_FLOWINFO, "
9719 #: build/C/man7/ipv6.7:224
9721 "Set delivery of control messages for incoming datagrams containing extension "
9722 "headers from the received packet. B<IPV6_RTHDR> delivers the routing "
9723 "header, B<IPV6_AUTHHDR> delivers the authentication header, B<IPV6_DSTOPTS> "
9724 "delivers the destination options, B<IPV6_HOPOPTS> delivers the hop options, "
9725 "B<IPV6_FLOWINFO> delivers an integer containing the flow ID, "
9726 "B<IPV6_HOPLIMIT> delivers an integer containing the hop count of the "
9727 "packet. The control messages have the same type as the socket option. All "
9728 "these header options can also be set for outgoing packets by putting the "
9729 "appropriate control message into the control buffer of B<sendmsg>(2). Only "
9730 "allowed for B<SOCK_DGRAM> or B<SOCK_RAW> sockets. Argument is a pointer to "
9735 #: build/C/man7/ipv6.7:224
9737 msgid "B<IPV6_RECVERR>"
9741 #: build/C/man7/ipv6.7:233
9743 "Control receiving of asynchronous error options. See B<IP_RECVERR> in "
9744 "B<ip>(7) for details. Argument is a pointer to boolean."
9748 #: build/C/man7/ipv6.7:233
9750 msgid "B<IPV6_ROUTER_ALERT>"
9754 #: build/C/man7/ipv6.7:246
9756 "Pass forwarded packets containing a router alert hop-by-hop option to this "
9757 "socket. Only allowed for SOCK_RAW sockets. The tapped packets are not "
9758 "forwarded by the kernel, it is the user's responsibility to send them out "
9759 "again. Argument is a pointer to an integer. A positive integer indicates a "
9760 "router alert option value to intercept. Packets carrying a router alert "
9761 "option with a value field containing this integer will be delivered to the "
9762 "socket. A negative integer disables delivery of packets with router alert "
9763 "options to this socket."
9767 #: build/C/man7/ipv6.7:246
9769 msgid "B<IPV6_UNICAST_HOPS>"
9773 #: build/C/man7/ipv6.7:252
9775 "Set the unicast hop limit for the socket. Argument is a pointer to an "
9776 "integer. -1 in the value means use the route default, otherwise it should "
9777 "be between 0 and 255."
9781 #: build/C/man7/ipv6.7:252
9783 msgid "B<IPV6_V6ONLY> (since Linux 2.4.21 and 2.6)"
9788 #: build/C/man7/ipv6.7:259
9790 "If this flag is set to true (nonzero), then the socket is restricted to "
9791 "sending and receiving IPv6 packets only. In this case, an IPv4 and an IPv6 "
9792 "application can bind to a single port at the same time."
9796 #: build/C/man7/ipv6.7:263
9798 "If this flag is set to false (zero), then the socket can be used to send and "
9799 "receive packets to and from an IPv6 address or an IPv4-mapped IPv6 address."
9803 #: build/C/man7/ipv6.7:265
9804 msgid "The argument is a pointer to a boolean value in an integer."
9807 #. FLOWLABEL_MGR, FLOWINFO_SEND
9809 #: build/C/man7/ipv6.7:270
9811 "The default value for this flag is defined by the contents of the file "
9812 "I</proc/sys/net/ipv6/bindv6only>. The default value for that file is 0 "
9817 #: build/C/man7/ipv6.7:282
9819 "The user tried to B<bind>(2) to a link-local IPv6 address, but the "
9820 "I<sin6_scope_id> in the supplied I<sockaddr_in6> structure is not a valid "
9825 #: build/C/man7/ipv6.7:287
9827 "The older I<libinet6> libc5 based IPv6 API implementation for Linux is not "
9828 "described here and may vary in details."
9832 #: build/C/man7/ipv6.7:303
9834 "Linux 2.4 will break binary compatibility for the I<sockaddr_in6> for 64-bit "
9835 "hosts by changing the alignment of I<in6_addr> and adding an additional "
9836 "I<sin6_scope_id> field. The kernel interfaces stay compatible, but a "
9837 "program including I<sockaddr_in6> or I<in6_addr> into other structures may "
9838 "not be. This is not a problem for 32-bit hosts like i386."
9842 #: build/C/man7/ipv6.7:311
9844 "The I<sin6_flowinfo> field is new in Linux 2.4. It is transparently "
9845 "passed/read by the kernel when the passed address length contains it. Some "
9846 "programs that pass a longer address buffer and then check the outgoing "
9847 "address length may break."
9851 #: build/C/man7/ipv6.7:321
9853 "The I<sockaddr_in6> structure is bigger than the generic I<sockaddr>. "
9854 "Programs that assume that all address types can be stored safely in a "
9855 "I<struct sockaddr> need to be changed to use I<struct sockaddr_storage> for "
9860 #: build/C/man7/ipv6.7:326
9862 "The IPv6 extended API as in RFC\\ 2292 is currently only partly implemented; "
9863 "although the 2.2 kernel has near complete support for receiving options, the "
9864 "macros for generating IPv6 options are missing in glibc 2.1."
9868 #: build/C/man7/ipv6.7:328
9869 msgid "IPSec support for EH and AH headers is missing."
9873 #: build/C/man7/ipv6.7:330
9874 msgid "Flow label management is not complete and not documented here."
9878 #: build/C/man7/ipv6.7:332
9879 msgid "This man page is not complete."
9883 #: build/C/man7/ipv6.7:335
9884 msgid "B<cmsg>(3), B<ip>(7)"
9888 #: build/C/man7/ipv6.7:338
9889 msgid "RFC\\ 2553: IPv6 BASIC API. Linux tries to be compliant to this."
9893 #: build/C/man7/ipv6.7:340
9894 msgid "RFC\\ 2460: IPv6 specification."
9898 #: build/C/man7/netdevice.7:15
9904 #: build/C/man7/netdevice.7:15
9910 #: build/C/man7/netdevice.7:18
9911 msgid "netdevice - Low level access to Linux network devices"
9915 #: build/C/man7/netdevice.7:20
9916 msgid "B<#include E<lt>sys/ioctl.hE<gt>>"
9920 #: build/C/man7/netdevice.7:22
9921 msgid "B<#include E<lt>net/if.hE<gt>>"
9925 #: build/C/man7/netdevice.7:25
9927 "This man page describes the sockets interface which is used to configure "
9932 #: build/C/man7/netdevice.7:32
9934 "Linux supports some standard ioctls to configure network devices. They can "
9935 "be used on any socket's file descriptor regardless of the family or type. "
9936 "They pass an I<ifreq> structure:"
9940 #: build/C/man7/netdevice.7:53
9944 " char ifr_name[IFNAMSIZ]; /* Interface name */\n"
9946 " struct sockaddr ifr_addr;\n"
9947 " struct sockaddr ifr_dstaddr;\n"
9948 " struct sockaddr ifr_broadaddr;\n"
9949 " struct sockaddr ifr_netmask;\n"
9950 " struct sockaddr ifr_hwaddr;\n"
9951 " short ifr_flags;\n"
9952 " int ifr_ifindex;\n"
9953 " int ifr_metric;\n"
9955 " struct ifmap ifr_map;\n"
9956 " char ifr_slave[IFNAMSIZ];\n"
9957 " char ifr_newname[IFNAMSIZ];\n"
9958 " char *ifr_data;\n"
9964 #: build/C/man7/netdevice.7:61
9968 " int ifc_len; /* size of buffer */\n"
9970 " char *ifc_buf; /* buffer address */\n"
9971 " struct ifreq *ifc_req; /* array of structures */\n"
9977 #: build/C/man7/netdevice.7:69
9979 "Normally, the user specifies which device to affect by setting I<ifr_name> "
9980 "to the name of the interface. All other members of the structure may share "
9985 #: build/C/man7/netdevice.7:77
9987 "If an ioctl is marked as privileged then using it requires an effective user "
9988 "ID of 0 or the B<CAP_NET_ADMIN> capability. If this is not the case "
9989 "B<EPERM> will be returned."
9993 #: build/C/man7/netdevice.7:77
9995 msgid "B<SIOCGIFNAME>"
9999 #: build/C/man7/netdevice.7:85
10001 "Given the I<ifr_ifindex>, return the name of the interface in I<ifr_name>. "
10002 "This is the only ioctl which returns its result in I<ifr_name>."
10006 #: build/C/man7/netdevice.7:85
10008 msgid "B<SIOCGIFINDEX>"
10011 #. type: Plain text
10012 #: build/C/man7/netdevice.7:89
10013 msgid "Retrieve the interface index of the interface into I<ifr_ifindex>."
10017 #: build/C/man7/netdevice.7:89
10019 msgid "B<SIOCGIFFLAGS>, B<SIOCSIFFLAGS>"
10022 #. type: Plain text
10023 #: build/C/man7/netdevice.7:94
10025 "Get or set the active flag word of the device. I<ifr_flags> contains a bit "
10026 "mask of the following values:"
10030 #: build/C/man7/netdevice.7:98
10032 msgid "Device flags\n"
10036 #: build/C/man7/netdevice.7:99
10038 msgid "IFF_UP:Interface is running.\n"
10042 #: build/C/man7/netdevice.7:100
10044 msgid "IFF_BROADCAST:Valid broadcast address set.\n"
10048 #: build/C/man7/netdevice.7:101
10050 msgid "IFF_DEBUG:Internal debugging flag.\n"
10054 #: build/C/man7/netdevice.7:102
10056 msgid "IFF_LOOPBACK:Interface is a loopback interface.\n"
10060 #: build/C/man7/netdevice.7:103
10062 msgid "IFF_POINTOPOINT:Interface is a point-to-point link.\n"
10066 #: build/C/man7/netdevice.7:104
10068 msgid "IFF_RUNNING:Resources allocated.\n"
10072 #: build/C/man7/netdevice.7:105
10074 msgid "IFF_NOARP:No arp protocol, L2 destination address not set.\n"
10078 #: build/C/man7/netdevice.7:106
10080 msgid "IFF_PROMISC:Interface is in promiscuous mode.\n"
10084 #: build/C/man7/netdevice.7:107
10086 msgid "IFF_NOTRAILERS:Avoid use of trailers.\n"
10090 #: build/C/man7/netdevice.7:108
10092 msgid "IFF_ALLMULTI:Receive all multicast packets.\n"
10096 #: build/C/man7/netdevice.7:109
10098 msgid "IFF_MASTER:Master of a load balancing bundle.\n"
10102 #: build/C/man7/netdevice.7:110
10104 msgid "IFF_SLAVE:Slave of a load balancing bundle.\n"
10108 #: build/C/man7/netdevice.7:111
10110 msgid "IFF_MULTICAST:Supports multicast\n"
10114 #: build/C/man7/netdevice.7:112
10116 msgid "IFF_PORTSEL:Is able to select media type via ifmap.\n"
10120 #: build/C/man7/netdevice.7:113
10122 msgid "IFF_AUTOMEDIA:Auto media selection active.\n"
10126 #: build/C/man7/netdevice.7:114
10128 msgid "IFF_DYNAMIC:T{\n"
10132 #: build/C/man7/netdevice.7:115
10134 msgid "The addresses are lost when the interface goes down.\n"
10138 #: build/C/man7/netdevice.7:116
10144 #: build/C/man7/netdevice.7:117
10146 msgid "IFF_LOWER_UP:Driver signals L1 up (since Linux 2.6.17)\n"
10150 #: build/C/man7/netdevice.7:118
10152 msgid "IFF_DORMANT:Driver signals dormant (since Linux 2.6.17)\n"
10156 #: build/C/man7/netdevice.7:119
10158 msgid "IFF_ECHO:Echo sent packets (since Linux 2.6.25)\n"
10161 #. type: Plain text
10162 #: build/C/man7/netdevice.7:125
10164 "Setting the active flag word is a privileged operation, but any process may "
10169 #: build/C/man7/netdevice.7:125
10171 msgid "B<SIOCGIFPFLAGS>, B<SIOCSIFPFLAGS>"
10174 #. type: Plain text
10175 #: build/C/man7/netdevice.7:130
10177 "Get or set extended (private) flags for the device. I<ifr_flags> contains a "
10178 "bit mask of the following values:"
10182 #: build/C/man7/netdevice.7:134
10184 msgid "Private flags\n"
10188 #: build/C/man7/netdevice.7:135
10190 msgid "IFF_802_1Q_VLAN:Interface is 802.1Q VLAN device.\n"
10194 #: build/C/man7/netdevice.7:136
10196 msgid "IFF_EBRIDGE:Interface is Ethernet bridging device.\n"
10200 #: build/C/man7/netdevice.7:137
10202 msgid "IFF_SLAVE_INACTIVE:Interface is inactive bonding slave.\n"
10206 #: build/C/man7/netdevice.7:138
10208 msgid "IFF_MASTER_8023AD:Interface is 802.3ad bonding master.\n"
10212 #: build/C/man7/netdevice.7:139
10214 msgid "IFF_MASTER_ALB:Interface is balanced-alb bonding master.\n"
10218 #: build/C/man7/netdevice.7:140
10220 msgid "IFF_BONDING:Interface is a bonding master or slave.\n"
10224 #: build/C/man7/netdevice.7:141
10226 msgid "IFF_SLAVE_NEEDARP:Interface needs ARPs for validation.\n"
10230 #: build/C/man7/netdevice.7:142
10232 msgid "IFF_ISATAP:Interface is RFC4214 ISATAP interface.\n"
10235 #. type: Plain text
10236 #: build/C/man7/netdevice.7:146
10237 msgid "Setting the extended (private) interface flags is a privileged operation."
10241 #: build/C/man7/netdevice.7:146
10243 msgid "B<SIOCGIFADDR>, B<SIOCSIFADDR>"
10246 #. type: Plain text
10247 #: build/C/man7/netdevice.7:154
10249 "Get or set the address of the device using I<ifr_addr>. Setting the "
10250 "interface address is a privileged operation. For compatibility, only "
10251 "B<AF_INET> addresses are accepted or returned."
10255 #: build/C/man7/netdevice.7:154
10257 msgid "B<SIOCGIFDSTADDR>, B<SIOCSIFDSTADDR>"
10260 #. type: Plain text
10261 #: build/C/man7/netdevice.7:162
10263 "Get or set the destination address of a point-to-point device using "
10264 "I<ifr_dstaddr>. For compatibility, only B<AF_INET> addresses are accepted "
10265 "or returned. Setting the destination address is a privileged operation."
10269 #: build/C/man7/netdevice.7:162
10271 msgid "B<SIOCGIFBRDADDR>, B<SIOCSIFBRDADDR>"
10274 #. type: Plain text
10275 #: build/C/man7/netdevice.7:170
10277 "Get or set the broadcast address for a device using I<ifr_brdaddr>. For "
10278 "compatibility, only B<AF_INET> addresses are accepted or returned. Setting "
10279 "the broadcast address is a privileged operation."
10283 #: build/C/man7/netdevice.7:170
10285 msgid "B<SIOCGIFNETMASK>, B<SIOCSIFNETMASK>"
10288 #. type: Plain text
10289 #: build/C/man7/netdevice.7:178
10291 "Get or set the network mask for a device using I<ifr_netmask>. For "
10292 "compatibility, only B<AF_INET> addresses are accepted or returned. Setting "
10293 "the network mask is a privileged operation."
10297 #: build/C/man7/netdevice.7:178
10299 msgid "B<SIOCGIFMETRIC>, B<SIOCSIFMETRIC>"
10302 #. type: Plain text
10303 #: build/C/man7/netdevice.7:187
10305 "Get or set the metric of the device using I<ifr_metric>. This is currently "
10306 "not implemented; it sets I<ifr_metric> to 0 if you attempt to read it and "
10307 "returns B<EOPNOTSUPP> if you attempt to set it."
10311 #: build/C/man7/netdevice.7:187
10313 msgid "B<SIOCGIFMTU>, B<SIOCSIFMTU>"
10316 #. type: Plain text
10317 #: build/C/man7/netdevice.7:194
10319 "Get or set the MTU (Maximum Transfer Unit) of a device using I<ifr_mtu>. "
10320 "Setting the MTU is a privileged operation. Setting the MTU to too small "
10321 "values may cause kernel crashes."
10325 #: build/C/man7/netdevice.7:194
10327 msgid "B<SIOCGIFHWADDR>, B<SIOCSIFHWADDR>"
10330 #. type: Plain text
10331 #: build/C/man7/netdevice.7:205
10333 "Get or set the hardware address of a device using I<ifr_hwaddr>. The "
10334 "hardware address is specified in a struct I<sockaddr>. I<sa_family> "
10335 "contains the ARPHRD_* device type, I<sa_data> the L2 hardware address "
10336 "starting from byte 0. Setting the hardware address is a privileged "
10341 #: build/C/man7/netdevice.7:205
10343 msgid "B<SIOCSIFHWBROADCAST>"
10346 #. type: Plain text
10347 #: build/C/man7/netdevice.7:210
10349 "Set the hardware broadcast address of a device from I<ifr_hwaddr>. This is "
10350 "a privileged operation."
10354 #: build/C/man7/netdevice.7:210
10356 msgid "B<SIOCGIFMAP>, B<SIOCSIFMAP>"
10359 #. type: Plain text
10360 #: build/C/man7/netdevice.7:215
10362 "Get or set the interface's hardware parameters using I<ifr_map>. Setting "
10363 "the parameters is a privileged operation."
10366 #. type: Plain text
10367 #: build/C/man7/netdevice.7:226
10371 " unsigned long mem_start;\n"
10372 " unsigned long mem_end;\n"
10373 " unsigned short base_addr;\n"
10374 " unsigned char irq;\n"
10375 " unsigned char dma;\n"
10376 " unsigned char port;\n"
10380 #. type: Plain text
10381 #: build/C/man7/netdevice.7:231
10383 "The interpretation of the ifmap structure depends on the device driver and "
10384 "the architecture."
10388 #: build/C/man7/netdevice.7:231
10390 msgid "B<SIOCADDMULTI>, B<SIOCDELMULTI>"
10393 #. type: Plain text
10394 #: build/C/man7/netdevice.7:240
10396 "Add an address to or delete an address from the device's link layer "
10397 "multicast filters using I<ifr_hwaddr>. These are privileged operations. "
10398 "See also B<packet>(7) for an alternative."
10402 #: build/C/man7/netdevice.7:240
10404 msgid "B<SIOCGIFTXQLEN>, B<SIOCSIFTXQLEN>"
10407 #. type: Plain text
10408 #: build/C/man7/netdevice.7:245
10410 "Get or set the transmit queue length of a device using I<ifr_qlen>. Setting "
10411 "the transmit queue length is a privileged operation."
10415 #: build/C/man7/netdevice.7:245
10417 msgid "B<SIOCSIFNAME>"
10420 #. type: Plain text
10421 #: build/C/man7/netdevice.7:254
10423 "Changes the name of the interface specified in I<ifr_name> to "
10424 "I<ifr_newname>. This is a privileged operation. It is only allowed when "
10425 "the interface is not up."
10429 #: build/C/man7/netdevice.7:254
10431 msgid "B<SIOCGIFCONF>"
10434 #. Slaving isn't supported in 2.2
10437 #. .BR SIOCGIFSLAVE ", " SIOCSIFSLAVE
10438 #. Get or set the slave device using
10440 #. Setting the slave device is a privileged operation.
10442 #. FIXME add amateur radio stuff.
10443 #. type: Plain text
10444 #: build/C/man7/netdevice.7:294
10446 "Return a list of interface (transport layer) addresses. This currently "
10447 "means only addresses of the B<AF_INET> (IPv4) family for compatibility. The "
10448 "user passes a I<ifconf> structure as argument to the ioctl. It contains a "
10449 "pointer to an array of I<ifreq> structures in I<ifc_req> and its length in "
10450 "bytes in I<ifc_len>. The kernel fills the ifreqs with all current L3 "
10451 "interface addresses that are running: I<ifr_name> contains the interface "
10452 "name (eth0:1 etc.), I<ifr_addr> the address. The kernel returns with the "
10453 "actual length in I<ifc_len>. If I<ifc_len> is equal to the original length "
10454 "the buffer probably has overflowed and you should retry with a bigger buffer "
10455 "to get all addresses. When no error occurs the ioctl returns 0; otherwise "
10456 "-1. Overflow is not an error."
10459 #. type: Plain text
10460 #: build/C/man7/netdevice.7:300
10462 "Most protocols support their own ioctls to configure protocol-specific "
10463 "interface options. See the protocol man pages for a description. For "
10464 "configuring IP addresses see B<ip>(7)."
10467 #. type: Plain text
10468 #: build/C/man7/netdevice.7:303
10470 "In addition some devices support private ioctls. These are not described "
10474 #. type: Plain text
10475 #: build/C/man7/netdevice.7:311
10477 "Strictly speaking, B<SIOCGIFCONF> and the other ioctls that only accept or "
10478 "return B<AF_INET> socket addresses, are IP specific and belong in B<ip>(7)."
10481 #. type: Plain text
10482 #: build/C/man7/netdevice.7:316
10484 "The names of interfaces with no addresses or that don't have the "
10485 "B<IFF_RUNNING> flag set can be found via I</proc/net/dev>."
10488 #. type: Plain text
10489 #: build/C/man7/netdevice.7:321
10491 "Local IPv6 IP addresses can be found via I</proc/net> or via "
10495 #. type: Plain text
10496 #: build/C/man7/netdevice.7:327
10498 "glibc 2.1 is missing the I<ifr_newname> macro in I<E<lt>net/if.hE<gt>>. Add "
10499 "the following to your program as a workaround:"
10502 #. type: Plain text
10503 #: build/C/man7/netdevice.7:333
10506 "#ifndef ifr_newname\n"
10507 "#define ifr_newname ifr_ifru.ifru_slave\n"
10511 #. type: Plain text
10512 #: build/C/man7/netdevice.7:340
10513 msgid "B<proc>(5), B<capabilities>(7), B<ip>(7), B<rtnetlink>(7)"
10517 #: build/C/man5/networks.5:24
10523 #: build/C/man5/networks.5:24
10529 #: build/C/man5/networks.5:24
10534 #. type: Plain text
10535 #: build/C/man5/networks.5:27
10536 msgid "networks - network name information"
10539 #. type: Plain text
10540 #: build/C/man5/networks.5:33
10542 "The file I</etc/networks> is a plain ASCII file that describes known DARPA "
10543 "networks and symbolic names for these networks. Each line represents a "
10544 "network and has the following structure:"
10547 #. type: Plain text
10548 #: build/C/man5/networks.5:36
10549 msgid "I<name number aliases ...>"
10552 #. type: Plain text
10553 #: build/C/man5/networks.5:44
10555 "where the fields are delimited by spaces or tabs. Empty lines are ignored. "
10556 "The hash character (B<#>) indicates the start of a comment: this character, "
10557 "and the remaining characters up to the end of the current line, are ignored "
10558 "by library functions that process the file."
10561 #. type: Plain text
10562 #: build/C/man5/networks.5:46 build/C/man5/protocols.5:58
10563 msgid "The field descriptions are:"
10567 #: build/C/man5/networks.5:47
10572 #. type: Plain text
10573 #: build/C/man5/networks.5:52
10575 "The symbolic name for the network. Network names can contain any printable "
10576 "characters execept white-space characters or the comment character."
10580 #: build/C/man5/networks.5:52 build/C/man5/protocols.5:66
10585 #. type: Plain text
10586 #: build/C/man5/networks.5:57
10588 "The official number for this network in numbers-and-dots notation (see "
10589 "B<inet>(3)). The trailing \".0\" (for the host component of the network "
10590 "address) may be omitted."
10594 #: build/C/man5/networks.5:57 build/C/man5/protocols.5:70 build/C/man5/services.5:120
10599 #. type: Plain text
10600 #: build/C/man5/networks.5:60
10601 msgid "Optional aliases for the network."
10604 #. type: Plain text
10605 #: build/C/man5/networks.5:69
10607 "This file is read by the B<route>(8) and B<netstat>(8) utilities. Only "
10608 "Class A, B or C networks are supported, partitioned networks (i.e., "
10609 "network/26 or network/28) are not supported by this facility."
10612 #. type: Plain text
10613 #: build/C/man5/networks.5:73
10614 msgid "The networks definition file."
10617 #. type: Plain text
10618 #: build/C/man5/networks.5:79
10620 "B<getnetbyaddr>(3), B<getnetbyname>(3), B<getnetent>(3), B<netstat>(8), "
10625 #: build/C/man8/nscd.8:23
10630 #. type: Plain text
10631 #: build/C/man8/nscd.8:26
10632 msgid "nscd - name service cache daemon"
10635 #. type: Plain text
10636 #: build/C/man8/nscd.8:34
10638 "Nscd is a daemon that provides a cache for the most common name service "
10639 "requests. The default configuration file, I</etc/nscd.conf>, determines the "
10640 "behavior of the cache daemon. See B<nscd.conf>(5)."
10643 #. type: Plain text
10644 #: build/C/man8/nscd.8:47
10646 "Nscd provides caching for accesses of the B<passwd>(5), B<group>(5), and "
10647 "B<hosts>(5) databases through standard libc interfaces, such as "
10648 "B<getpwnam>(3), B<getpwuid>(3), B<getgrnam>(3), B<getgrgid>(3), "
10649 "B<gethostbyname>(3), and others."
10652 #. type: Plain text
10653 #: build/C/man8/nscd.8:56
10655 "There are two caches for each database: a positive one for items found, and "
10656 "a negative one for items not found. Each cache has a separate TTL "
10657 "(time-to-live) period for its data. Note that the shadow file is "
10658 "specifically not cached. B<getspnam>(3) calls remain uncached as a result."
10662 #: build/C/man8/nscd.8:56
10668 #: build/C/man8/nscd.8:57
10673 #. type: Plain text
10674 #: build/C/man8/nscd.8:60
10675 msgid "will give you a list with all options and what they do."
10678 #. type: Plain text
10679 #: build/C/man8/nscd.8:83
10681 "The daemon will try to watch for changes in configuration files appropriate "
10682 "for each database (e.g., I</etc/passwd> for the I<passwd> database or "
10683 "I</etc/hosts> and I</etc/resolv.conf> for the I<hosts> database), and flush "
10684 "the cache when these are changed. However, this will happen only after a "
10685 "short delay (unless the B<inotify>(7) mechanism is available and glibc 2.9 "
10686 "or later is available), and this auto-detection does not cover configuration "
10687 "files required by nonstandard NSS modules, if any are specified in "
10688 "I</etc/nsswitch.conf>. In that case, you need to run the following command "
10689 "after changing the configuration file of the database so that B<nscd> "
10690 "invalidates its cache:"
10693 #. type: Plain text
10694 #: build/C/man8/nscd.8:85
10696 msgid " $ B<nscd -i> I<E<lt>databaseE<gt>>\n"
10701 #. was written by Thorsten Kukuk and Ulrich Drepper.
10702 #. type: Plain text
10703 #: build/C/man8/nscd.8:91
10704 msgid "B<nscd.conf>(5), B<nsswitch.conf>(5)"
10708 #: build/C/man5/nscd.conf.5:20
10714 #: build/C/man5/nscd.conf.5:20
10719 #. type: Plain text
10720 #: build/C/man5/nscd.conf.5:23
10721 msgid "/etc/nscd.conf - name service cache daemon configuration file"
10724 #. type: Plain text
10725 #: build/C/man5/nscd.conf.5:36
10727 "The file I</etc/nscd.conf> is read from B<nscd>(8) at startup. Each line "
10728 "specifies either an attribute and a value, or an attribute, service, and a "
10729 "value. Fields are separated either by SPACE or TAB characters. A "
10730 "\\(aq#\\(aq (number sign) indicates the beginning of a comment; following "
10731 "characters, up to the end of the line, are not interpreted by nscd."
10734 #. type: Plain text
10735 #: build/C/man5/nscd.conf.5:38
10736 msgid "Valid services are I<passwd>, I<group>, or I<hosts>."
10739 #. type: Plain text
10740 #: build/C/man5/nscd.conf.5:41
10741 msgid "B<logfile> I<debug-file-name>"
10744 #. type: Plain text
10745 #: build/C/man5/nscd.conf.5:43
10746 msgid "Specifies name of the file to which debug info should be written."
10749 #. type: Plain text
10750 #: build/C/man5/nscd.conf.5:47
10751 msgid "B<debug-level> I<value>"
10754 #. type: Plain text
10755 #: build/C/man5/nscd.conf.5:49
10756 msgid "Sets the desired debug level."
10759 #. type: Plain text
10760 #: build/C/man5/nscd.conf.5:53
10761 msgid "B<threads> I<number>"
10764 #. type: Plain text
10765 #: build/C/man5/nscd.conf.5:57
10767 "This is the number of threads that are started to wait for requests. At "
10768 "least five threads will always be created."
10771 #. type: Plain text
10772 #: build/C/man5/nscd.conf.5:61
10773 msgid "B<server-user> I<user>"
10776 #. type: Plain text
10777 #: build/C/man5/nscd.conf.5:65
10779 "If this option is set, nscd will run as this user and not as root. If a "
10780 "separate cache for every user is used (-S parameter), this option is "
10784 #. type: Plain text
10785 #: build/C/man5/nscd.conf.5:70
10786 msgid "B<enable-cache> I<service> I<E<lt>yes|noE<gt>>"
10789 #. type: Plain text
10790 #: build/C/man5/nscd.conf.5:74
10791 msgid "Enables or disables the specified I<service> cache."
10794 #. type: Plain text
10795 #: build/C/man5/nscd.conf.5:79
10796 msgid "B<positive-time-to-live> I<service> I<value>"
10799 #. type: Plain text
10800 #: build/C/man5/nscd.conf.5:87
10802 "Sets the TTL (time-to-live) for positive entries (successful queries) in "
10803 "the specified cache for I<service>. I<Value> is in seconds. Larger values "
10804 "increase cache hit rates and reduce mean response times, but increase "
10805 "problems with cache coherence."
10808 #. type: Plain text
10809 #: build/C/man5/nscd.conf.5:92
10810 msgid "B<negative-time-to-live> I<service> I<value>"
10813 #. type: Plain text
10814 #: build/C/man5/nscd.conf.5:102
10816 "Sets the TTL (time-to-live) for negative entries (unsuccessful queries) in "
10817 "the specified cache for I<service>. I<Value> is in seconds. Can result in "
10818 "significant performance improvements if there are several files owned by "
10819 "UIDs (user IDs) not in system databases (for example untarring the linux "
10820 "kernel sources as root); should be kept small to reduce cache coherency "
10824 #. type: Plain text
10825 #: build/C/man5/nscd.conf.5:107
10826 msgid "B<suggested-size> I<service> I<value>"
10829 #. type: Plain text
10830 #: build/C/man5/nscd.conf.5:111
10832 "This is the internal hash table size, I<value> should remain a prime number "
10833 "for optimum efficiency."
10836 #. type: Plain text
10837 #: build/C/man5/nscd.conf.5:116
10838 msgid "B<check-files> I<service> I<E<lt>yes|noE<gt>>"
10841 #. type: Plain text
10842 #: build/C/man5/nscd.conf.5:125
10844 "Enables or disables checking the file belonging to the specified I<service> "
10845 "for changes. The files are I</etc/passwd>, I</etc/group>, and "
10849 #. type: Plain text
10850 #: build/C/man5/nscd.conf.5:129
10851 msgid "B<max-threads> I<threads>"
10854 #. type: Plain text
10855 #: build/C/man5/nscd.conf.5:131
10856 msgid "Specifies the maximum number of threads to be started."
10859 #. type: Plain text
10860 #: build/C/man5/nscd.conf.5:135
10861 msgid "B<stat-user> I<username>"
10864 #. type: Plain text
10865 #: build/C/man5/nscd.conf.5:137
10866 msgid "Specifies the user who is allowed to request statistics."
10869 #. type: Plain text
10870 #: build/C/man5/nscd.conf.5:142
10871 msgid "B<reload-count> unlimited | I<number>"
10874 #. type: Plain text
10875 #: build/C/man5/nscd.conf.5:146
10877 "Limit on the number of times a cached entry gets reloaded without being used "
10878 "before it gets removed. The default is 5."
10881 #. type: Plain text
10882 #: build/C/man5/nscd.conf.5:150
10883 msgid "B<paranoia> I<E<lt>yes|noE<gt>>"
10886 #. type: Plain text
10887 #: build/C/man5/nscd.conf.5:152
10888 msgid "Enabling paranoia mode causes nscd to restart itself periodically."
10891 #. type: Plain text
10892 #: build/C/man5/nscd.conf.5:156
10893 msgid "B<restart-interval> I<time>"
10896 #. type: Plain text
10897 #: build/C/man5/nscd.conf.5:163
10899 "Sets the restart interval to I<time> seconds if periodic restart is enabled "
10900 "by enabling B<paranoia> mode."
10903 #. type: Plain text
10904 #: build/C/man5/nscd.conf.5:168
10905 msgid "B<persistent> I<service> I<E<lt>yes|noE<gt>>"
10908 #. type: Plain text
10909 #: build/C/man5/nscd.conf.5:174
10911 "Keep the content of the cache for I<service> over server restarts; useful "
10912 "when B<paranoia> mode is set."
10915 #. type: Plain text
10916 #: build/C/man5/nscd.conf.5:179
10917 msgid "B<shared> I<service> I<E<lt>yes|noE<gt>>"
10920 #. type: Plain text
10921 #: build/C/man5/nscd.conf.5:185
10923 "The memory mapping of the nscd databases for I<service> is shared with the "
10924 "clients so that they can directly search in them instead of having to ask "
10925 "the daemon over the socket each time a lookup is performed."
10930 #. was written by Thorsten Kukuk and Ulrich Drepper.
10931 #. type: Plain text
10932 #: build/C/man5/nscd.conf.5:191
10937 #: build/C/man5/nsswitch.conf.5:24
10939 msgid "NSSWITCH.CONF"
10943 #: build/C/man5/nsswitch.conf.5:24
10948 #. type: Plain text
10949 #: build/C/man5/nsswitch.conf.5:27
10950 msgid "nsswitch.conf - Name Service Switch configuration file"
10953 #. type: Plain text
10954 #: build/C/man5/nsswitch.conf.5:35
10956 "The Name Service Switch (NSS) configuration file, I</etc/nsswitch.conf>, is "
10957 "used by the GNU C Library to determine the sources from which to obtain "
10958 "name-service information in a range of categories, and in what order. Each "
10959 "category of information is identified by a database name."
10962 #. type: Plain text
10963 #: build/C/man5/nsswitch.conf.5:41
10965 "The file is plain ASCII text, with columns separated by spaces or tab "
10966 "characters. The first column specifies the database name. The remaining "
10967 "columns describe the order of sources to query and a limited set of actions "
10968 "that can be performed by lookup result."
10971 #. type: Plain text
10972 #: build/C/man5/nsswitch.conf.5:43
10973 msgid "The following databases are understood by the GNU C Library:"
10976 #. type: Plain text
10977 #: build/C/man5/nsswitch.conf.5:48
10978 msgid "Mail aliases, used by B<getaliasent>(3) and related functions."
10981 #. type: Plain text
10982 #: build/C/man5/nsswitch.conf.5:51
10983 msgid "Ethernet numbers."
10986 #. type: Plain text
10987 #: build/C/man5/nsswitch.conf.5:56
10988 msgid "Groups of users, used by B<getgrent>(3) and related functions."
10991 #. type: Plain text
10992 #: build/C/man5/nsswitch.conf.5:61
10993 msgid "Host names and numbers, used by B<gethostbyname>(3) and related functions."
10996 #. type: Plain text
10997 #: build/C/man5/nsswitch.conf.5:65
10999 "Network-wide list of hosts and users, used for access rules. C libraries "
11000 "before glibc 2.1 supported netgroups only over NIS."
11003 #. type: Plain text
11004 #: build/C/man5/nsswitch.conf.5:70
11005 msgid "Network names and numbers, used by B<getnetent>(3) and related functions."
11008 #. type: Plain text
11009 #: build/C/man5/nsswitch.conf.5:75
11010 msgid "User passwords, used by B<getpwent>(3) and related functions."
11013 #. type: Plain text
11014 #: build/C/man5/nsswitch.conf.5:80
11015 msgid "Network protocols, used by B<getprotoent>(3) and related functions."
11019 #: build/C/man5/nsswitch.conf.5:80
11021 msgid "B<publickey>"
11024 #. type: Plain text
11025 #: build/C/man5/nsswitch.conf.5:83
11026 msgid "Public and secret keys for Secure_RPC used by NFS and NIS+."
11029 #. type: Plain text
11030 #: build/C/man5/nsswitch.conf.5:88
11032 "Remote procedure call names and numbers, used by B<getrpcbyname>(3) and "
11033 "related functions."
11036 #. type: Plain text
11037 #: build/C/man5/nsswitch.conf.5:93
11038 msgid "Network services, used by B<getservent>(3) and related functions."
11041 #. type: Plain text
11042 #: build/C/man5/nsswitch.conf.5:98
11043 msgid "Shadow user passwords, used by B<getspnam>(3) and related functions."
11046 #. type: Plain text
11047 #: build/C/man5/nsswitch.conf.5:102
11048 msgid "Here is an example I</etc/nsswitch.conf> file:"
11052 #: build/C/man5/nsswitch.conf.5:105
11057 #. type: Plain text
11058 #: build/C/man5/nsswitch.conf.5:108 build/C/man5/nsswitch.conf.5:111 build/C/man5/nsswitch.conf.5:114
11063 #: build/C/man5/nsswitch.conf.5:108
11069 #: build/C/man5/nsswitch.conf.5:111
11075 #: build/C/man5/nsswitch.conf.5:115
11080 #. type: Plain text
11081 #: build/C/man5/nsswitch.conf.5:118
11082 msgid "dns [!UNAVAIL=return] files"
11086 #: build/C/man5/nsswitch.conf.5:118
11091 #. type: Plain text
11092 #: build/C/man5/nsswitch.conf.5:121 build/C/man5/nsswitch.conf.5:124 build/C/man5/nsswitch.conf.5:127 build/C/man5/nsswitch.conf.5:130 build/C/man5/nsswitch.conf.5:133
11093 msgid "nis [NOTFOUND=return] files"
11097 #: build/C/man5/nsswitch.conf.5:121
11103 #: build/C/man5/nsswitch.conf.5:124
11109 #: build/C/man5/nsswitch.conf.5:127
11115 #: build/C/man5/nsswitch.conf.5:130
11120 #. type: Plain text
11121 #: build/C/man5/nsswitch.conf.5:138
11122 msgid "The first column is the database name. The remaining columns specify:"
11125 #. type: Plain text
11126 #: build/C/man5/nsswitch.conf.5:142
11128 "One or more service specifications e.g., \"files\", \"db\", or \"nis\". The "
11129 "order of the services on the line determines the order in which those "
11130 "services will be queried, in turn, until a result is found."
11133 #. type: Plain text
11134 #: build/C/man5/nsswitch.conf.5:145
11136 "Optional actions to perform if a particular result is obtained from the "
11137 "preceding service, e.g., \"[NOTFOUND=return]\"."
11140 #. type: Plain text
11141 #: build/C/man5/nsswitch.conf.5:172
11143 "The service specifications supported on your system depend on the presence "
11144 "of shared libraries, and are therefore extensible. Libraries called "
11145 "I</lib/libnss_SERVICE.so.>B<X> will provide the named I<SERVICE>. On a "
11146 "standard installation, you can use \"files\", \"db\", \"nis\", and "
11147 "\"nisplus\". For the B<hosts> database, you can additionally specify "
11148 "\"dns\". For the B<passwd>, B<group>, and B<shadow> databases, you can "
11149 "additionally specify \"compat\" (see B<Compatibility mode> below). The "
11150 "version number B<X> may be 1 for glibc 2.0, or 2 for glibc 2.1 and later. "
11151 "On systems with additional libraries installed, you may have access to "
11152 "further services such as \"hesiod\", \"ldap\", \"winbind\" and \"wins\"."
11155 #. type: Plain text
11156 #: build/C/man5/nsswitch.conf.5:177
11158 "An action may also be specified following a service specification. The "
11159 "action modifies the behavior following a result obtained from the preceding "
11160 "data source. Action items take the general form:"
11163 #. type: Plain text
11164 #: build/C/man5/nsswitch.conf.5:180
11165 msgid "[I<STATUS>=I<ACTION>]"
11168 #. type: Plain text
11169 #: build/C/man5/nsswitch.conf.5:182
11170 msgid "[!I<STATUS>=I<ACTION>]"
11173 #. type: Plain text
11174 #: build/C/man5/nsswitch.conf.5:185
11178 #. type: Plain text
11179 #: build/C/man5/nsswitch.conf.5:196
11180 msgid "I<STATUS> =E<gt> B<success> | B<notfound> | B<unavail> | B<tryagain>"
11183 #. type: Plain text
11184 #: build/C/man5/nsswitch.conf.5:202
11185 msgid "I<ACTION> =E<gt> B<return> | B<continue>"
11188 #. type: Plain text
11189 #: build/C/man5/nsswitch.conf.5:207
11191 "The ! negates the test, matching all possible results except the one "
11192 "specified. The case of the keywords is not significant."
11195 #. type: Plain text
11196 #: build/C/man5/nsswitch.conf.5:212
11198 "The I<STATUS> value is matched against the result of the lookup function "
11199 "called by the preceding service specification, and can be one of:"
11203 #: build/C/man5/nsswitch.conf.5:213
11208 #. type: Plain text
11209 #: build/C/man5/nsswitch.conf.5:217
11211 "No error occurred and the requested entry is returned. The default action "
11212 "for this condition is \"return\"."
11216 #: build/C/man5/nsswitch.conf.5:217
11218 msgid "B<notfound>"
11221 #. type: Plain text
11222 #: build/C/man5/nsswitch.conf.5:221
11224 "The lookup succeeded, but the requested entry was not found. The default "
11225 "action for this condition is \"continue\"."
11229 #: build/C/man5/nsswitch.conf.5:221
11234 #. type: Plain text
11235 #: build/C/man5/nsswitch.conf.5:228
11237 "The service is permanently unavailable. This can mean either that the "
11238 "required file cannot be read, or, for network services, that the server is "
11239 "not available or does not allow queries. The default action for this "
11240 "condition is \"continue\"."
11244 #: build/C/man5/nsswitch.conf.5:228
11246 msgid "B<tryagain>"
11249 #. type: Plain text
11250 #: build/C/man5/nsswitch.conf.5:234
11252 "The service is temporarily unavailable. This could mean a file is locked or "
11253 "a server currently cannot accept more connections. The default action for "
11254 "this condition is \"continue\"."
11257 #. type: Plain text
11258 #: build/C/man5/nsswitch.conf.5:239
11259 msgid "The I<ACTION> value can be one of:"
11263 #: build/C/man5/nsswitch.conf.5:240
11268 #. type: Plain text
11269 #: build/C/man5/nsswitch.conf.5:244
11270 msgid "Return a result now. Do not call any further lookup functions."
11274 #: build/C/man5/nsswitch.conf.5:244
11276 msgid "B<continue>"
11279 #. type: Plain text
11280 #: build/C/man5/nsswitch.conf.5:247
11281 msgid "Call the next lookup function."
11285 #: build/C/man5/nsswitch.conf.5:248
11287 msgid "Compatibility mode (compat)"
11290 #. type: Plain text
11291 #: build/C/man5/nsswitch.conf.5:254
11293 "The NSS \"compat\" service is similar to \"files\" except that it "
11294 "additionally permits special entries in I</etc/passwd> for granting users or "
11295 "members of netgroups access to the system. The following entries are valid "
11300 #: build/C/man5/nsswitch.conf.5:255
11302 msgid "B<+>I<user>"
11305 #. type: Plain text
11306 #: build/C/man5/nsswitch.conf.5:260
11307 msgid "Include the specified I<user> from the NIS passwd map."
11311 #: build/C/man5/nsswitch.conf.5:260
11313 msgid "B<+@>I<netgroup>"
11316 #. type: Plain text
11317 #: build/C/man5/nsswitch.conf.5:264
11318 msgid "Include all users in the given I<netgroup>."
11322 #: build/C/man5/nsswitch.conf.5:264
11324 msgid "B<->I<user>"
11327 #. type: Plain text
11328 #: build/C/man5/nsswitch.conf.5:269
11329 msgid "Exclude the specified I<user> from the NIS passwd map."
11333 #: build/C/man5/nsswitch.conf.5:269
11335 msgid "B<-@>I<netgroup>"
11338 #. type: Plain text
11339 #: build/C/man5/nsswitch.conf.5:273
11340 msgid "Exclude all users in the given I<netgroup>."
11344 #: build/C/man5/nsswitch.conf.5:273
11349 #. type: Plain text
11350 #: build/C/man5/nsswitch.conf.5:277
11352 "Include every user, except previously excluded ones, from the NIS passwd "
11356 #. type: Plain text
11357 #: build/C/man5/nsswitch.conf.5:285
11359 "By default the source is \"nis\", but this may be overridden by specifying "
11360 "\"nisplus\" as the source for the pseudo-databases B<passwd_compat>, "
11361 "B<group_compat>, and B<shadow_compat>."
11364 #. type: Plain text
11365 #: build/C/man5/nsswitch.conf.5:292
11367 "A service named I<SERVICE> is implemented by a shared object library named "
11368 "I<libnss_SERVICE.so.>B<X> that resides in I</lib>."
11371 #. type: Plain text
11372 #: build/C/man5/nsswitch.conf.5:297
11373 msgid "NSS configuration file."
11377 #: build/C/man5/nsswitch.conf.5:297
11379 msgid "I</lib/libnss_compat.so.>B<X>"
11382 #. type: Plain text
11383 #: build/C/man5/nsswitch.conf.5:300
11384 msgid "implements \"compat\" source."
11388 #: build/C/man5/nsswitch.conf.5:300
11390 msgid "I</lib/libnss_db.so.>B<X>"
11393 #. type: Plain text
11394 #: build/C/man5/nsswitch.conf.5:303
11395 msgid "implements \"db\" source."
11399 #: build/C/man5/nsswitch.conf.5:303
11401 msgid "I</lib/libnss_dns.so.>B<X>"
11404 #. type: Plain text
11405 #: build/C/man5/nsswitch.conf.5:306
11406 msgid "implements \"dns\" source."
11410 #: build/C/man5/nsswitch.conf.5:306
11412 msgid "I</lib/libnss_files.so.>B<X>"
11415 #. type: Plain text
11416 #: build/C/man5/nsswitch.conf.5:309
11417 msgid "implements \"files\" source."
11421 #: build/C/man5/nsswitch.conf.5:309
11423 msgid "I</lib/libnss_hesiod.so.>B<X>"
11426 #. type: Plain text
11427 #: build/C/man5/nsswitch.conf.5:312
11428 msgid "implements \"hesiod\" source."
11432 #: build/C/man5/nsswitch.conf.5:312
11434 msgid "I</lib/libnss_nis.so.>B<X>"
11437 #. type: Plain text
11438 #: build/C/man5/nsswitch.conf.5:315
11439 msgid "implements \"nis\" source."
11443 #: build/C/man5/nsswitch.conf.5:315
11445 msgid "I</lib/libnss_nisplus.so.>B<X>"
11448 #. type: Plain text
11449 #: build/C/man5/nsswitch.conf.5:318
11450 msgid "implements \"nisplus\" source."
11453 #. type: Plain text
11454 #: build/C/man5/nsswitch.conf.5:326
11456 "Within each process that uses B<nsswitch.conf>, the entire file is read only "
11457 "once. If the file is later changed, the process will continue using the old "
11461 #. type: Plain text
11462 #: build/C/man5/nsswitch.conf.5:339
11464 "Traditionally, there was only a single source for service information, often "
11465 "in the form of a single configuration file (e.g., I</etc/passwd>). However, "
11466 "as other name services, such as the Network Information Service (NIS) and "
11467 "the Domain Name Service (DNS), became popular, a method was needed that "
11468 "would be more flexible than fixed search orders coded into the C library. "
11469 "The Name Service Switch mechanism, which was based on the mechanism used by "
11470 "Sun Microsystems in the Solaris 2 C library, introduced a cleaner solution "
11474 #. type: Plain text
11475 #: build/C/man5/nsswitch.conf.5:342
11476 msgid "B<getent>(1), B<nss>(5)"
11480 #: build/C/man7/packet.7:7
11485 #. type: Plain text
11486 #: build/C/man7/packet.7:10
11487 msgid "packet - packet interface on device level."
11490 #. type: Plain text
11491 #: build/C/man7/packet.7:13
11493 msgid "B<#include E<lt>sys/socket.hE<gt>>\n"
11496 #. type: Plain text
11497 #: build/C/man7/packet.7:15
11499 msgid "B<#include E<lt>netpacket/packet.hE<gt>>\n"
11502 #. type: Plain text
11503 #: build/C/man7/packet.7:17
11505 msgid "B<#include E<lt>net/ethernet.hE<gt> /* the L2 protocols */>\n"
11508 #. type: Plain text
11509 #: build/C/man7/packet.7:19
11512 "B<packet_socket = socket(AF_PACKET, int >I<socket_type>B<, int "
11513 ">I<protocol>B<);>\n"
11516 #. type: Plain text
11517 #: build/C/man7/packet.7:25
11519 "Packet sockets are used to receive or send raw packets at the device driver "
11520 "(OSI Layer 2) level. They allow the user to implement protocol modules in "
11521 "user space on top of the physical layer."
11524 #. type: Plain text
11525 #: build/C/man7/packet.7:47
11527 "The I<socket_type> is either B<SOCK_RAW> for raw packets including the link "
11528 "level header or B<SOCK_DGRAM> for cooked packets with the link level header "
11529 "removed. The link level header information is available in a common format "
11530 "in a I<sockaddr_ll>. I<protocol> is the IEEE 802.3 protocol number in "
11531 "network order. See the I<E<lt>linux/if_ether.hE<gt>> include file for a "
11532 "list of allowed protocols. When protocol is set to B<htons(ETH_P_ALL)> then "
11533 "all protocols are received. All incoming packets of that protocol type will "
11534 "be passed to the packet socket before they are passed to the protocols "
11535 "implemented in the kernel."
11538 #. type: Plain text
11539 #: build/C/man7/packet.7:51
11541 "Only processes with effective UID 0 or the B<CAP_NET_RAW> capability may "
11542 "open packet sockets."
11545 #. type: Plain text
11546 #: build/C/man7/packet.7:69
11548 "B<SOCK_RAW> packets are passed to and from the device driver without any "
11549 "changes in the packet data. When receiving a packet, the address is still "
11550 "parsed and passed in a standard I<sockaddr_ll> address structure. When "
11551 "transmitting a packet, the user supplied buffer should contain the physical "
11552 "layer header. That packet is then queued unmodified to the network driver "
11553 "of the interface defined by the destination address. Some device drivers "
11554 "always add other headers. B<SOCK_RAW> is similar to but not compatible with "
11555 "the obsolete B<AF_INET/SOCK_PACKET> of Linux 2.0."
11558 #. type: Plain text
11559 #: build/C/man7/packet.7:79
11561 "B<SOCK_DGRAM> operates on a slightly higher level. The physical header is "
11562 "removed before the packet is passed to the user. Packets sent through a "
11563 "B<SOCK_DGRAM> packet socket get a suitable physical layer header based on "
11564 "the information in the I<sockaddr_ll> destination address before they are "
11568 #. type: Plain text
11569 #: build/C/man7/packet.7:92
11571 "By default all packets of the specified protocol type are passed to a packet "
11572 "socket. To only get packets from a specific interface use B<bind>(2) "
11573 "specifying an address in a I<struct sockaddr_ll> to bind the packet socket "
11574 "to an interface. Only the I<sll_protocol> and the I<sll_ifindex> address "
11575 "fields are used for purposes of binding."
11578 #. type: Plain text
11579 #: build/C/man7/packet.7:96
11580 msgid "The B<connect>(2) operation is not supported on packet sockets."
11583 #. type: Plain text
11584 #: build/C/man7/packet.7:105
11586 "When the B<MSG_TRUNC> flag is passed to B<recvmsg>(2), B<recv>(2), "
11587 "B<recvfrom>(2) the real length of the packet on the wire is always "
11588 "returned, even when it is longer than the buffer."
11592 #: build/C/man7/packet.7:105
11594 msgid "Address Types"
11597 #. type: Plain text
11598 #: build/C/man7/packet.7:107
11599 msgid "The sockaddr_ll is a device independent physical layer address."
11602 #. type: Plain text
11603 #: build/C/man7/packet.7:119
11606 "struct sockaddr_ll {\n"
11607 " unsigned short sll_family; /* Always AF_PACKET */\n"
11608 " unsigned short sll_protocol; /* Physical layer protocol */\n"
11609 " int sll_ifindex; /* Interface number */\n"
11610 " unsigned short sll_hatype; /* ARP hardware type */\n"
11611 " unsigned char sll_pkttype; /* Packet type */\n"
11612 " unsigned char sll_halen; /* Length of address */\n"
11613 " unsigned char sll_addr[8]; /* Physical layer address */\n"
11617 #. type: Plain text
11618 #: build/C/man7/packet.7:158
11620 "I<sll_protocol> is the standard ethernet protocol type in network order as "
11621 "defined in the I<E<lt>linux/if_ether.hE<gt>> include file. It defaults to "
11622 "the socket's protocol. I<sll_ifindex> is the interface index of the "
11623 "interface (see B<netdevice>(7)); 0 matches any interface (only permitted for "
11624 "binding). I<sll_hatype> is an ARP type as defined in the "
11625 "I<E<lt>linux/if_arp.hE<gt>> include file. I<sll_pkttype> contains the "
11626 "packet type. Valid types are B<PACKET_HOST> for a packet addressed to the "
11627 "local host, B<PACKET_BROADCAST> for a physical layer broadcast packet, "
11628 "B<PACKET_MULTICAST> for a packet sent to a physical layer multicast address, "
11629 "B<PACKET_OTHERHOST> for a packet to some other host that has been caught by "
11630 "a device driver in promiscuous mode, and B<PACKET_OUTGOING> for a packet "
11631 "originated from the local host that is looped back to a packet socket. "
11632 "These types make only sense for receiving. I<sll_addr> and I<sll_halen> "
11633 "contain the physical layer (e.g., IEEE 802.3) address and its length. The "
11634 "exact interpretation depends on the device."
11637 #. type: Plain text
11638 #: build/C/man7/packet.7:174
11640 "When you send packets it is enough to specify I<sll_family>, I<sll_addr>, "
11641 "I<sll_halen>, I<sll_ifindex>. The other fields should be 0. I<sll_hatype> "
11642 "and I<sll_pkttype> are set on received packets for your information. For "
11643 "bind only I<sll_protocol> and I<sll_ifindex> are used."
11646 #. type: Plain text
11647 #: build/C/man7/packet.7:189
11649 "Packet sockets can be used to configure physical layer multicasting and "
11650 "promiscuous mode. It works by calling B<setsockopt>(2) on a packet socket "
11651 "for B<SOL_PACKET> and one of the options B<PACKET_ADD_MEMBERSHIP> to add a "
11652 "binding or B<PACKET_DROP_MEMBERSHIP> to drop it. They both expect a "
11653 "B<packet_mreq> structure as argument:"
11656 #. type: Plain text
11657 #: build/C/man7/packet.7:198
11660 "struct packet_mreq {\n"
11661 " int mr_ifindex; /* interface index */\n"
11662 " unsigned short mr_type; /* action */\n"
11663 " unsigned short mr_alen; /* address length */\n"
11664 " unsigned char mr_address[8]; /* physical layer address */\n"
11668 #. type: Plain text
11669 #: build/C/man7/packet.7:219
11671 "B<mr_ifindex> contains the interface index for the interface whose status "
11672 "should be changed. The B<mr_type> parameter specifies which action to "
11673 "perform. B<PACKET_MR_PROMISC> enables receiving all packets on a shared "
11674 "medium (often known as \"promiscuous mode\"), B<PACKET_MR_MULTICAST> binds "
11675 "the socket to the physical layer multicast group specified in B<mr_address> "
11676 "and B<mr_alen>, and B<PACKET_MR_ALLMULTI> sets the socket up to receive all "
11677 "multicast packets arriving at the interface."
11680 #. type: Plain text
11681 #: build/C/man7/packet.7:225
11683 "In addition the traditional ioctls B<SIOCSIFFLAGS>, B<SIOCADDMULTI>, "
11684 "B<SIOCDELMULTI> can be used for the same purpose."
11687 #. FIXME Document SIOCGSTAMPNS
11688 #. type: Plain text
11689 #: build/C/man7/packet.7:231
11691 "B<SIOCGSTAMP> can be used to receive the timestamp of the last received "
11692 "packet. Argument is a I<struct timeval.>"
11695 #. type: Plain text
11696 #: build/C/man7/packet.7:237
11698 "In addition all standard ioctls defined in B<netdevice>(7) and B<socket>(7) "
11699 "are valid on packet sockets."
11703 #: build/C/man7/packet.7:237 build/C/man7/raw.7:127 build/C/man7/tcp.7:1080 build/C/man7/udp.7:97
11705 msgid "Error Handling"
11708 #. type: Plain text
11709 #: build/C/man7/packet.7:241
11711 "Packet sockets do no error handling other than errors occurred while passing "
11712 "the packet to the device driver. They don't have the concept of a pending "
11716 #. type: Plain text
11717 #: build/C/man7/packet.7:245
11718 msgid "Unknown multicast group address passed."
11721 #. type: Plain text
11722 #: build/C/man7/packet.7:248
11723 msgid "User passed invalid memory address."
11726 #. type: Plain text
11727 #: build/C/man7/packet.7:251 build/C/man7/raw.7:151
11728 msgid "Invalid argument."
11731 #. type: Plain text
11732 #: build/C/man7/packet.7:254
11733 msgid "Packet is bigger than interface MTU."
11737 #: build/C/man7/packet.7:254
11739 msgid "B<ENETDOWN>"
11742 #. type: Plain text
11743 #: build/C/man7/packet.7:257
11744 msgid "Interface is not up."
11747 #. type: Plain text
11748 #: build/C/man7/packet.7:260
11749 msgid "Not enough memory to allocate the packet."
11752 #. type: Plain text
11753 #: build/C/man7/packet.7:263
11754 msgid "Unknown device name or interface index specified in interface address."
11757 #. type: Plain text
11758 #: build/C/man7/packet.7:266
11759 msgid "No packet received."
11762 #. type: Plain text
11763 #: build/C/man7/packet.7:269
11764 msgid "No interface address passed."
11768 #: build/C/man7/packet.7:269
11773 #. type: Plain text
11774 #: build/C/man7/packet.7:272
11775 msgid "Interface address contained an invalid interface index."
11778 #. type: Plain text
11779 #: build/C/man7/packet.7:275
11780 msgid "User has insufficient privileges to carry out this operation."
11783 #. type: Plain text
11784 #: build/C/man7/packet.7:277
11785 msgid "In addition other errors may be generated by the low-level driver."
11788 #. type: Plain text
11789 #: build/C/man7/packet.7:282
11791 "B<AF_PACKET> is a new feature in Linux 2.2. Earlier Linux versions "
11792 "supported only B<SOCK_PACKET>."
11795 #. type: Plain text
11796 #: build/C/man7/packet.7:287
11798 "The include file I<E<lt>netpacket/packet.hE<gt>> is present since glibc "
11799 "2.1. Older systems need:"
11802 #. type: Plain text
11803 #: build/C/man7/packet.7:293
11806 "#include E<lt>asm/types.hE<gt>\n"
11807 "#include E<lt>linux/if_packet.hE<gt>\n"
11808 "#include E<lt>linux/if_ether.hE<gt> /* The L2 protocols */\n"
11811 #. type: Plain text
11812 #: build/C/man7/packet.7:303
11814 "For portable programs it is suggested to use B<AF_PACKET> via B<pcap>(3); "
11815 "although this only covers a subset of the B<AF_PACKET> features."
11818 #. type: Plain text
11819 #: build/C/man7/packet.7:324
11821 "The B<SOCK_DGRAM> packet sockets make no attempt to create or parse the IEEE "
11822 "802.2 LLC header for a IEEE 802.3 frame. When B<ETH_P_802_3> is specified "
11823 "as protocol for sending the kernel creates the 802.3 frame and fills out the "
11824 "length field; the user has to supply the LLC header to get a fully "
11825 "conforming packet. Incoming 802.3 packets are not multiplexed on the "
11826 "DSAP/SSAP protocol fields; instead they are supplied to the user as protocol "
11827 "B<ETH_P_802_2> with the LLC header prepended. It is thus not possible to "
11828 "bind to B<ETH_P_802_3>; bind to B<ETH_P_802_2> instead and do the protocol "
11829 "multiplex yourself. The default for sending is the standard Ethernet DIX "
11830 "encapsulation with the protocol filled in."
11833 #. type: Plain text
11834 #: build/C/man7/packet.7:326
11835 msgid "Packet sockets are not subject to the input or output firewall chains."
11838 #. type: Plain text
11839 #: build/C/man7/packet.7:336
11841 "In Linux 2.0, the only way to get a packet socket was by calling "
11842 "B<socket(AF_INET, SOCK_PACKET, >I<protocol>B<)>. This is still supported "
11843 "but strongly deprecated. The main difference between the two methods is "
11844 "that B<SOCK_PACKET> uses the old I<struct sockaddr_pkt> to specify an "
11845 "interface, which doesn't provide physical layer independence."
11848 #. type: Plain text
11849 #: build/C/man7/packet.7:344
11852 "struct sockaddr_pkt {\n"
11853 " unsigned short spkt_family;\n"
11854 " unsigned char spkt_device[14];\n"
11855 " unsigned short spkt_protocol;\n"
11859 #. type: Plain text
11860 #: build/C/man7/packet.7:356
11862 "I<spkt_family> contains the device type, I<spkt_protocol> is the IEEE 802.3 "
11863 "protocol type as defined in I<E<lt>sys/if_ether.hE<gt>> and I<spkt_device> "
11864 "is the device name as a null-terminated string, for example, eth0."
11867 #. type: Plain text
11868 #: build/C/man7/packet.7:358
11869 msgid "This structure is obsolete and should not be used in new code."
11872 #. type: Plain text
11873 #: build/C/man7/packet.7:362
11875 "glibc 2.1 does not have a define for B<SOL_PACKET>. The suggested "
11876 "workaround is to use:"
11879 #. type: Plain text
11880 #: build/C/man7/packet.7:368
11883 "#ifndef SOL_PACKET\n"
11884 "#define SOL_PACKET 263\n"
11888 #. type: Plain text
11889 #: build/C/man7/packet.7:373
11891 "This is fixed in later glibc versions and also does not occur on libc5 "
11895 #. type: Plain text
11896 #: build/C/man7/packet.7:375
11897 msgid "The IEEE 802.2/803.3 LLC handling could be considered as a bug."
11900 #. type: Plain text
11901 #: build/C/man7/packet.7:377
11902 msgid "Socket filters are not documented."
11906 #. This man page was written by Andi Kleen with help from Matthew Wilcox.
11907 #. AF_PACKET in Linux 2.2 was implemented
11908 #. by Alexey Kuznetsov, based on code by Alan Cox and others.
11909 #. type: Plain text
11910 #: build/C/man7/packet.7:389
11912 "The B<MSG_TRUNC> B<recvmsg>(2) extension is an ugly hack and should be "
11913 "replaced by a control message. There is currently no way to get the "
11914 "original destination address of packets via B<SOCK_DGRAM>."
11917 #. type: Plain text
11918 #: build/C/man7/packet.7:396
11920 "B<socket>(2), B<pcap>(3), B<capabilities>(7), B<ip>(7), B<raw>(7), "
11924 #. type: Plain text
11925 #: build/C/man7/packet.7:398
11926 msgid "RFC\\ 894 for the standard IP Ethernet encapsulation."
11929 #. type: Plain text
11930 #: build/C/man7/packet.7:400
11931 msgid "RFC\\ 1700 for the IEEE 802.3 IP encapsulation."
11934 #. type: Plain text
11935 #: build/C/man7/packet.7:404
11936 msgid "The I<E<lt>linux/if_ether.hE<gt>> include file for physical layer protocols."
11940 #: build/C/man5/protocols.5:28
11946 #: build/C/man5/protocols.5:28
11951 #. type: Plain text
11952 #: build/C/man5/protocols.5:31
11953 msgid "protocols - protocols definition file"
11956 #. type: Plain text
11957 #: build/C/man5/protocols.5:39
11959 "This file is a plain ASCII file, describing the various DARPA internet "
11960 "protocols that are available from the TCP/IP subsystem. It should be "
11961 "consulted instead of using the numbers in the ARPA include files, or, even "
11962 "worse, just guessing them. These numbers will occur in the protocol field "
11963 "of any IP header."
11966 #. .. by the DDN Network Information Center.
11967 #. type: Plain text
11968 #: build/C/man5/protocols.5:45
11970 "Keep this file untouched since changes would result in incorrect IP "
11971 "packages. Protocol numbers and names are specified by the IANA (Internet "
11972 "Assigned Numbers Authority)."
11975 #. type: Plain text
11976 #: build/C/man5/protocols.5:47
11977 msgid "Each line is of the following format:"
11980 #. type: Plain text
11981 #: build/C/man5/protocols.5:50
11982 msgid "I<protocol number aliases ...>"
11985 #. type: Plain text
11986 #: build/C/man5/protocols.5:56
11988 "where the fields are delimited by spaces or tabs. Empty lines are ignored. "
11989 "If a line contains a hash mark (#), the hash mark and the part of the line "
11990 "following it are ignored."
11994 #: build/C/man5/protocols.5:58 build/C/man5/services.5:109
11996 msgid "I<protocol>"
11999 #. type: Plain text
12000 #: build/C/man5/protocols.5:66
12001 msgid "the native name for the protocol. For example I<ip>, I<tcp>, or I<udp>."
12004 #. type: Plain text
12005 #: build/C/man5/protocols.5:70
12007 "the official number for this protocol as it will appear within the IP "
12011 #. type: Plain text
12012 #: build/C/man5/protocols.5:73
12013 msgid "optional aliases for the protocol."
12016 #. The following is not true as at glibc 2.8 (a line with a comma is
12017 #. ignored by getservent()); it's not clear if/when it was ever true.
12018 #. As a backward compatibility feature, the slash (/) between the
12022 #. name can in fact be either a slash or a comma (,).
12023 #. Use of the comma in
12024 #. modern installations is deprecated.
12025 #. type: Plain text
12026 #: build/C/man5/protocols.5:76 build/C/man5/services.5:165
12028 "This file might be distributed over a network using a network-wide naming "
12029 "service like Yellow Pages/NIS or BIND/Hesiod."
12032 #. type: Plain text
12033 #: build/C/man5/protocols.5:80
12034 msgid "The protocols definition file."
12037 #. type: Plain text
12038 #: build/C/man5/protocols.5:82
12039 msgid "B<getprotoent>(3)"
12042 #. type: Plain text
12043 #: build/C/man5/protocols.5:84
12044 msgid "http://www.iana.org/assignments/protocol-numbers"
12048 #: build/C/man7/raw.7:9
12053 #. type: Plain text
12054 #: build/C/man7/raw.7:12
12055 msgid "raw - Linux IPv4 raw sockets"
12058 #. type: Plain text
12059 #: build/C/man7/raw.7:18
12060 msgid "B<raw_socket = socket(AF_INET, SOCK_RAW, int >I<protocol>B<);>"
12063 #. type: Plain text
12064 #: build/C/man7/raw.7:22
12066 "Raw sockets allow new IPv4 protocols to be implemented in user space. A raw "
12067 "socket receives or sends the raw datagram not including link level headers."
12070 #. type: Plain text
12071 #: build/C/man7/raw.7:28
12073 "The IPv4 layer generates an IP header when sending a packet unless the "
12074 "B<IP_HDRINCL> socket option is enabled on the socket. When it is enabled, "
12075 "the packet must contain an IP header. For receiving the IP header is always "
12076 "included in the packet."
12079 #. type: Plain text
12080 #: build/C/man7/raw.7:32
12082 "Only processes with an effective user ID of 0 or the B<CAP_NET_RAW> "
12083 "capability are allowed to open raw sockets."
12086 #. type: Plain text
12087 #: build/C/man7/raw.7:39
12089 "All packets or errors matching the I<protocol> number specified for the raw "
12090 "socket are passed to this socket. For a list of the allowed protocols see "
12091 "RFC\\ 1700 assigned numbers and B<getprotobyname>(3)."
12094 #. type: Plain text
12095 #: build/C/man7/raw.7:49
12097 "A protocol of B<IPPROTO_RAW> implies enabled B<IP_HDRINCL> and is able to "
12098 "send any IP protocol that is specified in the passed header. Receiving of "
12099 "all IP protocols via B<IPPROTO_RAW> is not possible using raw sockets."
12103 #: build/C/man7/raw.7:54
12105 msgid "IP Header fields modified on sending by B<IP_HDRINCL>\n"
12109 #: build/C/man7/raw.7:55
12111 msgid "IP Checksum:Always filled in.\n"
12115 #: build/C/man7/raw.7:56
12117 msgid "Source Address:Filled in when zero.\n"
12121 #: build/C/man7/raw.7:57
12123 msgid "Packet Id:Filled in when zero.\n"
12127 #: build/C/man7/raw.7:58
12129 msgid "Total Length:Always filled in.\n"
12132 #. type: Plain text
12133 #: build/C/man7/raw.7:72
12135 "If B<IP_HDRINCL> is specified and the IP header has a nonzero destination "
12136 "address then the destination address of the socket is used to route the "
12137 "packet. When B<MSG_DONTROUTE> is specified, the destination address should "
12138 "refer to a local interface, otherwise a routing table lookup is done anyway "
12139 "but gatewayed routes are ignored."
12142 #. type: Plain text
12143 #: build/C/man7/raw.7:80
12145 "If B<IP_HDRINCL> isn't set, then IP header options can be set on raw sockets "
12146 "with B<setsockopt>(2); see B<ip>(7) for more information."
12149 #. type: Plain text
12150 #: build/C/man7/raw.7:85
12152 "In Linux 2.2, all IP header fields and options can be set using IP socket "
12153 "options. This means raw sockets are usually only needed for new protocols "
12154 "or protocols with no user interface (like ICMP)."
12157 #. type: Plain text
12158 #: build/C/man7/raw.7:89
12160 "When a packet is received, it is passed to any raw sockets which have been "
12161 "bound to its protocol before it is passed to other protocol handlers (e.g., "
12162 "kernel protocol modules)."
12165 #. type: Plain text
12166 #: build/C/man7/raw.7:105
12168 "Raw sockets use the standard I<sockaddr_in> address structure defined in "
12169 "B<ip>(7). The I<sin_port> field could be used to specify the IP protocol "
12170 "number, but it is ignored for sending in Linux 2.2 and should be always set "
12171 "to 0 (see BUGS). For incoming packets, I<sin_port> is set to the protocol "
12172 "of the packet. See the I<E<lt>netinet/in.hE<gt>> include file for valid IP "
12176 #. Or SOL_RAW on Linux
12177 #. type: Plain text
12178 #: build/C/man7/raw.7:114
12180 "Raw socket options can be set with B<setsockopt>(2) and read with "
12181 "B<getsockopt>(2) by passing the B<IPPROTO_RAW> family flag."
12185 #: build/C/man7/raw.7:114
12187 msgid "B<ICMP_FILTER>"
12190 #. type: Plain text
12191 #: build/C/man7/raw.7:122
12193 "Enable a special filter for raw sockets bound to the B<IPPROTO_ICMP> "
12194 "protocol. The value has a bit set for each ICMP message type which should "
12195 "be filtered out. The default is to filter no ICMP messages."
12198 #. type: Plain text
12199 #: build/C/man7/raw.7:127
12201 "In addition, all B<ip>(7) B<IPPROTO_IP> socket options valid for datagram "
12202 "sockets are supported."
12205 #. type: Plain text
12206 #: build/C/man7/raw.7:140
12208 "Errors originating from the network are only passed to the user when the "
12209 "socket is connected or the B<IP_RECVERR> flag is enabled. For connected "
12210 "sockets, only B<EMSGSIZE> and B<EPROTO> are passed for compatibility. With "
12211 "B<IP_RECVERR>, all network errors are saved in the error queue."
12214 #. type: Plain text
12215 #: build/C/man7/raw.7:145
12217 "User tried to send to a broadcast address without having the broadcast flag "
12218 "set on the socket."
12221 #. type: Plain text
12222 #: build/C/man7/raw.7:148
12223 msgid "An invalid memory address was supplied."
12226 #. type: Plain text
12227 #: build/C/man7/raw.7:158
12229 "Packet too big. Either Path MTU Discovery is enabled (the "
12230 "B<IP_MTU_DISCOVER> socket flag) or the packet size exceeds the maximum "
12231 "allowed IPv4 packet size of 64KB."
12235 #: build/C/man7/raw.7:158 build/C/man7/unix.7:360
12237 msgid "B<EOPNOTSUPP>"
12240 #. type: Plain text
12241 #: build/C/man7/raw.7:162
12242 msgid "Invalid flag has been passed to a socket call (like B<MSG_OOB>)."
12245 #. type: Plain text
12246 #: build/C/man7/raw.7:168
12248 "The user doesn't have permission to open raw sockets. Only processes with "
12249 "an effective user ID of 0 or the B<CAP_NET_RAW> attribute may do that."
12253 #: build/C/man7/raw.7:168
12258 #. type: Plain text
12259 #: build/C/man7/raw.7:171
12260 msgid "An ICMP error has arrived reporting a parameter problem."
12263 #. type: Plain text
12264 #: build/C/man7/raw.7:177
12266 "B<IP_RECVERR> and B<ICMP_FILTER> are new in Linux 2.2. They are Linux "
12267 "extensions and should not be used in portable programs."
12270 #. type: Plain text
12271 #: build/C/man7/raw.7:183
12273 "Linux 2.0 enabled some bug-to-bug compatibility with BSD in the raw socket "
12274 "code when the B<SO_BSDCOMPAT> socket option was set \\(em since Linux 2.2, "
12275 "this option no longer has that effect."
12278 #. type: Plain text
12279 #: build/C/man7/raw.7:201
12281 "By default, raw sockets do path MTU (Maximum Transmission Unit) discovery. "
12282 "This means the kernel will keep track of the MTU to a specific target IP "
12283 "address and return B<EMSGSIZE> when a raw packet write exceeds it. When "
12284 "this happens, the application should decrease the packet size. Path MTU "
12285 "discovery can be also turned off using the B<IP_MTU_DISCOVER> socket option "
12286 "or the I</proc/sys/net/ipv4/ip_no_pmtu_disc> file, see B<ip>(7) for "
12287 "details. When turned off, raw sockets will fragment outgoing packets that "
12288 "exceed the interface MTU. However, disabling it is not recommended for "
12289 "performance and reliability reasons."
12292 #. type: Plain text
12293 #: build/C/man7/raw.7:210
12295 "A raw socket can be bound to a specific local address using the B<bind>(2) "
12296 "call. If it isn't bound, all packets with the specified IP protocol are "
12297 "received. In addition, a RAW socket can be bound to a specific network "
12298 "device using B<SO_BINDTODEVICE>; see B<socket>(7)."
12301 #. type: Plain text
12302 #: build/C/man7/raw.7:221
12304 "An B<IPPROTO_RAW> socket is send only. If you really want to receive all IP "
12305 "packets, use a B<packet>(7) socket with the B<ETH_P_IP> protocol. Note "
12306 "that packet sockets don't reassemble IP fragments, unlike raw sockets."
12309 #. type: Plain text
12310 #: build/C/man7/raw.7:227
12312 "If you want to receive all ICMP packets for a datagram socket, it is often "
12313 "better to use B<IP_RECVERR> on that particular socket; see B<ip>(7)."
12316 #. type: Plain text
12317 #: build/C/man7/raw.7:234
12319 "Raw sockets may tap all IP protocols in Linux, even protocols like ICMP or "
12320 "TCP which have a protocol module in the kernel. In this case, the packets "
12321 "are passed to both the kernel module and the raw socket(s). This should not "
12322 "be relied upon in portable programs, many other BSD socket implementation "
12323 "have limitations here."
12326 #. type: Plain text
12327 #: build/C/man7/raw.7:239
12329 "Linux never changes headers passed from the user (except for filling in some "
12330 "zeroed fields as described for B<IP_HDRINCL>). This differs from many other "
12331 "implementations of raw sockets."
12334 #. type: Plain text
12335 #: build/C/man7/raw.7:242
12337 "RAW sockets are generally rather unportable and should be avoided in "
12338 "programs intended to be portable."
12341 #. type: Plain text
12342 #: build/C/man7/raw.7:248
12344 "Sending on raw sockets should take the IP protocol from I<sin_port>; this "
12345 "ability was lost in Linux 2.2. The workaround is to use B<IP_HDRINCL>."
12348 #. type: Plain text
12349 #: build/C/man7/raw.7:250
12350 msgid "Transparent proxy extensions are not described."
12353 #. type: Plain text
12354 #: build/C/man7/raw.7:255
12356 "When the B<IP_HDRINCL> option is set, datagrams will not be fragmented and "
12357 "are limited to the interface MTU."
12361 #. This man page was written by Andi Kleen.
12362 #. type: Plain text
12363 #: build/C/man7/raw.7:265
12365 "Setting the IP protocol for sending in I<sin_port> got lost in Linux 2.2. "
12366 "The protocol that the socket was bound to or that was specified in the "
12367 "initial B<socket>(2) call is always used."
12370 #. type: Plain text
12371 #: build/C/man7/raw.7:271
12372 msgid "B<recvmsg>(2), B<sendmsg>(2), B<capabilities>(7), B<ip>(7), B<socket>(7)"
12375 #. type: Plain text
12376 #: build/C/man7/raw.7:274
12377 msgid "B<RFC\\ 1191> for path MTU discovery."
12380 #. type: Plain text
12381 #: build/C/man7/raw.7:279
12383 "B<RFC\\ 791> and the I<E<lt>linux/ip.hE<gt>> include file for the IP "
12388 #: build/C/man3/rcmd.3:41
12394 #: build/C/man3/rcmd.3:41 build/C/man3/resolver.3:30 build/C/man3/rexec.3:39 build/C/man7/tcp.7:16
12399 #. type: Plain text
12400 #: build/C/man3/rcmd.3:46
12402 "rcmd, rresvport, iruserok, ruserok, rcmd_af, rresvport_af, iruserok_af, "
12403 "ruserok_af - routines for returning a stream to a remote command"
12406 #. type: Plain text
12407 #: build/C/man3/rcmd.3:49
12410 "B<#include E<lt>netdb.hE<gt> \\ \\ >/* Or E<lt>unistd.hE<gt> on some systems "
12414 #. type: Plain text
12415 #: build/C/man3/rcmd.3:52
12418 "B<int rcmd(char **>I<ahost>B<, int >I<inport>B<, const char *>I<locuser>B<, "
12420 "B< const char *>I<remuser>B<, const char *>I<cmd>B<, int "
12424 #. type: Plain text
12425 #: build/C/man3/rcmd.3:54
12427 msgid "B<int rresvport(int *>I<port>B<);>\n"
12430 #. type: Plain text
12431 #: build/C/man3/rcmd.3:57
12434 "B<int iruserok(uint32_t >I<raddr>B<, int >I<superuser>B<, >\n"
12435 "B< const char *>I<ruser>B<, const char *>I<luser>B<);>\n"
12438 #. type: Plain text
12439 #: build/C/man3/rcmd.3:60
12442 "B<int ruserok(const char *>I<rhost>B<, int >I<superuser>B<, >\n"
12443 "B< const char *>I<ruser>B<, const char *>I<luser>B<);>\n"
12446 #. type: Plain text
12447 #: build/C/man3/rcmd.3:64
12450 "B<int rcmd_af(char **>I<ahost>B<, int >I<inport>B<, const char "
12451 "*>I<locuser>B<, >\n"
12452 "B< const char *>I<remuser>B<, const char *>I<cmd>B<, int "
12454 "B< sa_family_t >I<af>B<);>\n"
12457 #. type: Plain text
12458 #: build/C/man3/rcmd.3:66
12460 msgid "B<int rresvport_af(int *>I<port>B<, sa_family_t >I<af>B<);>\n"
12463 #. type: Plain text
12464 #: build/C/man3/rcmd.3:70
12467 "B<int iruserok_af(uint32_t >I<raddr>B<, int >I<superuser>B<, >\n"
12468 "B< const char *>I<ruser>B<, const char *>I<luser>B<, "
12469 "sa_family_t >I<af>B<);>\n"
12472 #. type: Plain text
12473 #: build/C/man3/rcmd.3:74
12476 "B<int ruserok_af(const char *>I<rhost>B<, int >I<superuser>B<, >\n"
12477 "B< const char *>I<ruser>B<, const char *>I<luser>B<, "
12478 "sa_family_t >I<af>B<);>\n"
12481 #. type: Plain text
12482 #: build/C/man3/rcmd.3:90
12484 "B<rcmd>(), B<rcmd_af>(), B<rresvport>(), B<rresvport_af>(), B<iruserok>(), "
12485 "B<iruserok_af>(), B<ruserok>(), B<ruserok_af>(): _BSD_SOURCE"
12488 #. type: Plain text
12489 #: build/C/man3/rcmd.3:111
12491 "The B<rcmd>() function is used by the superuser to execute a command on a "
12492 "remote machine using an authentication scheme based on privileged port "
12493 "numbers. The B<rresvport>() function returns a descriptor to a socket with "
12494 "an address in the privileged port space. The B<iruserok>() and "
12495 "B<ruserok>() functions are used by servers to authenticate clients "
12496 "requesting service with B<rcmd>(). All four functions are used by the "
12497 "B<rshd>(8) server (among others)."
12501 #: build/C/man3/rcmd.3:111
12506 #. type: Plain text
12507 #: build/C/man3/rcmd.3:127
12509 "The B<rcmd>() function looks up the host I<*ahost> using "
12510 "B<gethostbyname>(3), returning -1 if the host does not exist. Otherwise "
12511 "I<*ahost> is set to the standard name of the host and a connection is "
12512 "established to a server residing at the well-known Internet port I<inport>."
12515 #. type: Plain text
12516 #: build/C/man3/rcmd.3:156
12518 "If the connection succeeds, a socket in the Internet domain of type "
12519 "B<SOCK_STREAM> is returned to the caller, and given to the remote command as "
12520 "I<stdin> and I<stdout>. If I<fd2p> is nonzero, then an auxiliary channel to "
12521 "a control process will be set up, and a descriptor for it will be placed in "
12522 "I<*fd2p>. The control process will return diagnostic output from the "
12523 "command (unit 2) on this channel, and will also accept bytes on this channel "
12524 "as being UNIX signal numbers, to be forwarded to the process group of the "
12525 "command. If I<fd2p> is 0, then the I<stderr> (unit 2 of the remote command) "
12526 "will be made the same as the I<stdout> and no provision is made for sending "
12527 "arbitrary signals to the remote process, although you may be able to get its "
12528 "attention by using out-of-band data."
12531 #. type: Plain text
12532 #: build/C/man3/rcmd.3:159
12533 msgid "The protocol is described in detail in B<rshd>(8)."
12537 #: build/C/man3/rcmd.3:159
12539 msgid "rresvport()"
12542 #. type: Plain text
12543 #: build/C/man3/rcmd.3:181
12545 "The B<rresvport>() function is used to obtain a socket with a privileged "
12546 "port bound to it. This socket is suitable for use by B<rcmd>() and several "
12547 "other functions. Privileged ports are those in the range 0 to 1023. Only a "
12548 "privileged process (B<CAP_NET_BIND_SERVICE>) is allowed to bind to a "
12549 "privileged port. In the glibc implementation, this function restricts its "
12550 "search to the ports from 512 to 1023. The I<port> argument is value-result: "
12551 "the value it supplies to the call is used as the starting point for a "
12552 "circular search of the port range; on (successful) return, it contains the "
12553 "port number that was bound to."
12557 #: build/C/man3/rcmd.3:181
12559 msgid "iruserok() and ruserok()"
12562 #. type: Plain text
12563 #: build/C/man3/rcmd.3:199
12565 "The B<iruserok>() and B<ruserok>() functions take a remote host's IP "
12566 "address or name, respectively, two usernames and a flag indicating whether "
12567 "the local user's name is that of the superuser. Then, if the user is I<not> "
12568 "the superuser, it checks the I</etc/hosts.equiv> file. If that lookup is "
12569 "not done, or is unsuccessful, the I<.rhosts> in the local user's home "
12570 "directory is checked to see if the request for service is allowed."
12573 #. type: Plain text
12574 #: build/C/man3/rcmd.3:215
12576 "If this file does not exist, is not a regular file, is owned by anyone other "
12577 "than the user or the superuser, or is writable by anyone other than the "
12578 "owner, the check automatically fails. Zero is returned if the machine name "
12579 "is listed in the I<hosts.equiv> file, or the host and remote username are "
12580 "found in the I<.rhosts> file; otherwise B<iruserok>() and B<ruserok>() "
12581 "return -1. If the local domain (as obtained from B<gethostname>(2)) is the "
12582 "same as the remote domain, only the machine name need be specified."
12585 #. type: Plain text
12586 #: build/C/man3/rcmd.3:221
12588 "If the IP address of the remote host is known, B<iruserok>() should be used "
12589 "in preference to B<ruserok>(), as it does not require trusting the DNS "
12590 "server for the remote host's domain."
12594 #: build/C/man3/rcmd.3:221
12596 msgid "*_af() variants"
12599 #. type: Plain text
12600 #: build/C/man3/rcmd.3:237
12602 "All of the functions described above work with IPv4 (B<AF_INET>) sockets. "
12603 "The \"_af\" variants take an extra argument that allows the socket address "
12604 "family to be specified. For these functions, the I<af> argument can be "
12605 "specified as B<AF_INET> or B<AF_INET6>. In addition, B<rcmd_af>() supports "
12606 "the use of B<AF_UNSPEC>."
12609 #. type: Plain text
12610 #: build/C/man3/rcmd.3:243
12612 "The B<rcmd>() function returns a valid socket descriptor on success. It "
12613 "returns -1 on error and prints a diagnostic message on the standard error."
12616 #. type: Plain text
12617 #: build/C/man3/rcmd.3:254
12619 "The B<rresvport>() function returns a valid, bound socket descriptor on "
12620 "success. It returns -1 on error with the global value I<errno> set "
12621 "according to the reason for failure. The error code B<EAGAIN> is overloaded "
12622 "to mean \"All network ports in use.\""
12625 #. type: Plain text
12626 #: build/C/man3/rcmd.3:260
12628 "For information on the return from B<ruserok>() and B<iruserok>(), see "
12632 #. type: Plain text
12633 #: build/C/man3/rcmd.3:268
12635 "The functions B<iruserok_af>(), B<rcmd_af>(), B<rresvport_af>(), and "
12636 "B<ruserok_af>() functions are provide in glibc since version 2.2."
12639 #. type: Plain text
12640 #: build/C/man3/rcmd.3:276
12642 "Not in POSIX.1-2001. Present on the BSDs, Solaris, and many other systems. "
12643 "These functions appeared in 4.2BSD. The \"_af\" variants are more recent "
12644 "additions, and are not present on as wide a range of systems."
12647 #. Bug filed 25 Nov 2007:
12648 #. http://sources.redhat.com/bugzilla/show_bug.cgi?id=5399
12649 #. type: Plain text
12650 #: build/C/man3/rcmd.3:283
12652 "B<iruserok>() and B<iruserok_af>() are declared in glibc headers only "
12653 "since version 2.12."
12656 #. type: Plain text
12657 #: build/C/man3/rcmd.3:291
12659 "B<rlogin>(1), B<rsh>(1), B<intro>(2), B<rexec>(3), B<rexecd>(8), "
12660 "B<rlogind>(8), B<rshd>(8)"
12664 #: build/C/man5/resolv.conf.5:21
12666 msgid "RESOLV.CONF"
12670 #: build/C/man5/resolv.conf.5:21
12675 #. type: Plain text
12676 #: build/C/man5/resolv.conf.5:25
12677 msgid "resolv.conf - resolver configuration file"
12680 #. type: Plain text
12681 #: build/C/man5/resolv.conf.5:27
12682 msgid "B</etc/resolv.conf>"
12685 #. type: Plain text
12686 #: build/C/man5/resolv.conf.5:36
12688 "The I<resolver> is a set of routines in the C library that provide access to "
12689 "the Internet Domain Name System (DNS). The resolver configuration file "
12690 "contains information that is read by the resolver routines the first time "
12691 "they are invoked by a process. The file is designed to be human readable "
12692 "and contains a list of keywords with values that provide various types of "
12693 "resolver information."
12696 #. type: Plain text
12697 #: build/C/man5/resolv.conf.5:41
12699 "If this file does not exist, only the name server on the local machine will "
12700 "be queried; the domain name is determined from the hostname and the domain "
12701 "search path is constructed from the domain name."
12704 #. type: Plain text
12705 #: build/C/man5/resolv.conf.5:43
12706 msgid "The different configuration options are:"
12710 #: build/C/man5/resolv.conf.5:43
12712 msgid "B<nameserver> Name server IP address"
12715 #. type: Plain text
12716 #: build/C/man5/resolv.conf.5:59
12718 "Internet address (in dot notation) of a name server that the resolver should "
12719 "query. Up to B<MAXNS> (currently 3, see I<E<lt>resolv.hE<gt>>) name servers "
12720 "may be listed, one per keyword. If there are multiple servers, the resolver "
12721 "library queries them in the order listed. If no B<nameserver> entries are "
12722 "present, the default is to use the name server on the local machine. (The "
12723 "algorithm used is to try a name server, and if the query times out, try the "
12724 "next, until out of name servers, then repeat trying all the name servers "
12725 "until a maximum number of retries are made.)"
12729 #: build/C/man5/resolv.conf.5:59
12731 msgid "B<domain> Local domain name."
12734 #. type: Plain text
12735 #: build/C/man5/resolv.conf.5:69
12737 "Most queries for names within this domain can use short names relative to "
12738 "the local domain. If no B<domain> entry is present, the domain is "
12739 "determined from the local hostname returned by B<gethostname>(2); the domain "
12740 "part is taken to be everything after the first \\(aq.\\(aq. Finally, if the "
12741 "hostname does not contain a domain part, the root domain is assumed."
12745 #: build/C/man5/resolv.conf.5:69
12747 msgid "B<search> Search list for host-name lookup."
12750 #. When having a resolv.conv with a line
12751 #. search subdomain.domain.tld domain.tld
12752 #. and doing a hostlookup, for example by
12753 #. ping host.anothersubdomain
12754 #. it sends dns-requests for
12755 #. host.anothersubdomain.
12756 #. host.anothersubdomain.subdomain.domain.tld.
12757 #. host.anothersubdomain.domain.tld.
12758 #. thus not only causing unnecessary traffic for the root-dns-servers
12759 #. but broadcasting information to the outside and making man-in-the-middle
12760 #. attacks possible.
12761 #. type: Plain text
12762 #: build/C/man5/resolv.conf.5:99
12764 "The search list is normally determined from the local domain name; by "
12765 "default, it contains only the local domain name. This may be changed by "
12766 "listing the desired domain search path following the I<search> keyword with "
12767 "spaces or tabs separating the names. Resolver queries having fewer than "
12768 "I<ndots> dots (default is 1) in them will be attempted using each component "
12769 "of the search path in turn until a match is found. For environments with "
12770 "multiple subdomains please read B<options ndots:>I<n> below to avoid "
12771 "man-in-the-middle attacks and unnecessary traffic for the root-dns-servers. "
12772 "Note that this process may be slow and will generate a lot of network "
12773 "traffic if the servers for the listed domains are not local, and that "
12774 "queries will time out if no server is available for one of the domains."
12777 #. type: Plain text
12778 #: build/C/man5/resolv.conf.5:102
12780 "The search list is currently limited to six domains with a total of 256 "
12785 #: build/C/man5/resolv.conf.5:102
12787 msgid "B<sortlist>"
12790 #. type: Plain text
12791 #: build/C/man5/resolv.conf.5:115
12793 "This option allows addresses returned by B<gethostbyname>(3) to be sorted. "
12794 "A sortlist is specified by IP-address-netmask pairs. The netmask is "
12795 "optional and defaults to the natural netmask of the net. The IP address and "
12796 "optional network pairs are separated by slashes. Up to 10 pairs may be "
12797 "specified. Here is an example:"
12800 #. type: Plain text
12801 #: build/C/man5/resolv.conf.5:118
12802 msgid "sortlist 130.155.160.0/255.255.240.0 130.155.0.0"
12806 #: build/C/man5/resolv.conf.5:120
12811 #. type: Plain text
12812 #: build/C/man5/resolv.conf.5:124
12814 "Options allows certain internal resolver variables to be modified. The "
12818 #. type: Plain text
12819 #: build/C/man5/resolv.conf.5:127
12820 msgid "B<options> I<option> I<...>"
12823 #. type: Plain text
12824 #: build/C/man5/resolv.conf.5:129
12825 msgid "where I<option> is one of the following:"
12829 #: build/C/man5/resolv.conf.5:129
12834 #. Since glibc 2.2?
12835 #. type: Plain text
12836 #: build/C/man5/resolv.conf.5:136
12837 msgid "sets B<RES_DEBUG> in I<_res.options>."
12841 #: build/C/man5/resolv.conf.5:136
12843 msgid "B<ndots:>I<n>"
12847 #. type: Plain text
12848 #: build/C/man5/resolv.conf.5:150
12850 "sets a threshold for the number of dots which must appear in a name given to "
12851 "B<res_query>(3) (see B<resolver>(3)) before an I<initial absolute query> "
12852 "will be made. The default for I<n> is 1, meaning that if there are any dots "
12853 "in a name, the name will be tried first as an absolute name before any "
12854 "I<search list> elements are appended to it. The value for this option is "
12855 "silently capped to 15."
12859 #: build/C/man5/resolv.conf.5:150
12861 msgid "B<timeout:>I<n>"
12865 #. type: Plain text
12866 #: build/C/man5/resolv.conf.5:161
12868 "sets the amount of time the resolver will wait for a response from a remote "
12869 "name server before retrying the query via a different name server. Measured "
12870 "in seconds, the default is B<RES_TIMEOUT> (currently 5, see "
12871 "I<E<lt>resolv.hE<gt>>). The value for this option is silently capped to 30."
12875 #: build/C/man5/resolv.conf.5:161
12877 msgid "B<attempts:>I<n>"
12880 #. type: Plain text
12881 #: build/C/man5/resolv.conf.5:170
12883 "sets the number of times the resolver will send a query to its name servers "
12884 "before giving up and returning an error to the calling application. The "
12885 "default is B<RES_DFLRETRY> (currently 2, see I<E<lt>resolv.hE<gt>>). The "
12886 "value for this option is silently capped to 5."
12890 #: build/C/man5/resolv.conf.5:170
12896 #. type: Plain text
12897 #: build/C/man5/resolv.conf.5:180
12899 "sets B<RES_ROTATE> in I<_res.options>, which causes round robin selection of "
12900 "nameservers from among those listed. This has the effect of spreading the "
12901 "query load among all listed servers, rather than having all clients try the "
12902 "first listed server first every time."
12906 #: build/C/man5/resolv.conf.5:180
12908 msgid "B<no-check-names>"
12912 #. type: Plain text
12913 #: build/C/man5/resolv.conf.5:190
12915 "sets B<RES_NOCHECKNAME> in I<_res.options>, which disables the modern BIND "
12916 "checking of incoming hostnames and mail names for invalid characters such as "
12917 "underscore (_), non-ASCII, or control characters."
12921 #: build/C/man5/resolv.conf.5:190
12927 #. type: Plain text
12928 #: build/C/man5/resolv.conf.5:201
12930 "sets B<RES_USE_INET6> in I<_res.options>. This has the effect of trying a "
12931 "AAAA query before an A query inside the B<gethostbyname>(3) function, and "
12932 "of mapping IPv4 responses in IPv6 \"tunneled form\" if no AAAA records are "
12933 "found but an A record set exists."
12937 #: build/C/man5/resolv.conf.5:201
12939 msgid "B<ip6-bytestring> (since glibc 2.3.4)"
12942 #. type: Plain text
12943 #: build/C/man5/resolv.conf.5:210
12945 "sets B<RES_USE_BSTRING> in I<_res.options>. This causes reverse IPv6 "
12946 "lookups to be made using the bit-label format described in RFC\\ 2673; if "
12947 "this option is not set, then nibble format is used."
12951 #: build/C/man5/resolv.conf.5:210
12953 msgid "B<ip6-dotint>/B<no-ip6-dotint> (since glibc 2.3.4)"
12956 #. type: Plain text
12957 #: build/C/man5/resolv.conf.5:227
12959 "Clear/set B<RES_NOIP6DOTINT> in I<_res.options>. When this option is clear "
12960 "(B<ip6-dotint>), reverse IPv6 lookups are made in the (deprecated) "
12961 "I<ip6.int> zone; when this option is set (B<no-ip6-dotint>), reverse IPv6 "
12962 "lookups are made in the I<ip6.arpa> zone by default. This option is set by "
12967 #: build/C/man5/resolv.conf.5:227
12969 msgid "B<edns0> (since glibc 2.6)"
12972 #. type: Plain text
12973 #: build/C/man5/resolv.conf.5:234
12975 "sets B<RES_USE_EDNSO> in I<_res.options>. This enables support for the DNS "
12976 "extensions described in RFC\\ 2671."
12980 #: build/C/man5/resolv.conf.5:234
12982 msgid "B<single-request> (since glibc 2.10)"
12985 #. type: Plain text
12986 #: build/C/man5/resolv.conf.5:247
12988 "sets B<RES_SNGLKUP> in I<_res.options>. By default, glibc performs IPv4 and "
12989 "IPv6 lookups in parallel since version 2.9. Some appliance DNS servers "
12990 "cannot handle these queries properly and make the requests time out. This "
12991 "option disables the behavior and makes glibc perform the IPv6 and IPv4 "
12992 "requests sequentially (at the cost of some slowdown of the resolving "
12996 #. type: Plain text
12997 #: build/C/man5/resolv.conf.5:252
12999 "The I<domain> and I<search> keywords are mutually exclusive. If more than "
13000 "one instance of these keywords is present, the last instance wins."
13003 #. type: Plain text
13004 #: build/C/man5/resolv.conf.5:257
13006 "The I<search> keyword of a system's I<resolv.conf> file can be overridden on "
13007 "a per-process basis by setting the environment variable B<LOCALDOMAIN> to a "
13008 "space-separated list of search domains."
13011 #. type: Plain text
13012 #: build/C/man5/resolv.conf.5:263
13014 "The I<options> keyword of a system's I<resolv.conf> file can be amended on a "
13015 "per-process basis by setting the environment variable B<RES_OPTIONS> to a "
13016 "space-separated list of resolver options as explained above under "
13020 #. type: Plain text
13021 #: build/C/man5/resolv.conf.5:267
13023 "The keyword and value must appear on a single line, and the keyword (e.g., "
13024 "B<nameserver>) must start the line. The value follows the keyword, "
13025 "separated by white space."
13028 #. type: Plain text
13029 #: build/C/man5/resolv.conf.5:270
13031 "Lines that contain a semicolon (;) or hash character (#) in the first "
13032 "column are treated as comments."
13035 #. type: Plain text
13036 #: build/C/man5/resolv.conf.5:273
13037 msgid "I</etc/resolv.conf>, I<E<lt>resolv.hE<gt>>"
13040 #. type: Plain text
13041 #: build/C/man5/resolv.conf.5:278
13042 msgid "B<gethostbyname>(3), B<resolver>(3), B<hostname>(7), B<named>(8)"
13045 #. type: Plain text
13046 #: build/C/man5/resolv.conf.5:280
13047 msgid "Name Server Operations Guide for BIND"
13051 #: build/C/man3/resolver.3:30
13056 #. type: Plain text
13057 #: build/C/man3/resolver.3:34
13059 "res_init, res_query, res_search, res_querydomain, res_mkquery, res_send, "
13060 "dn_comp, dn_expand - resolver routines"
13063 #. type: Plain text
13064 #: build/C/man3/resolver.3:40
13067 "B<#include E<lt>netinet/in.hE<gt>>\n"
13068 "B<#include E<lt>arpa/nameser.hE<gt>>\n"
13069 "B<#include E<lt>resolv.hE<gt>>\n"
13070 "B<extern struct state _res;>\n"
13073 #. type: Plain text
13074 #: build/C/man3/resolver.3:42
13076 msgid "B<int res_init(void);>\n"
13079 #. type: Plain text
13080 #: build/C/man3/resolver.3:44
13082 msgid "B<int res_query(const char *>I<dname>B<, int >I<class>B<, int >I<type>B<,>\n"
13085 #. type: Plain text
13086 #: build/C/man3/resolver.3:46 build/C/man3/resolver.3:51
13088 msgid "B<unsigned char *>I<answer>B<, int >I<anslen>B<);>\n"
13091 #. type: Plain text
13092 #: build/C/man3/resolver.3:49
13095 "B<int res_search(const char *>I<dname>B<, int >I<class>B<, int "
13099 #. type: Plain text
13100 #: build/C/man3/resolver.3:54
13102 msgid "B<int res_querydomain(const char *>I<name>B<, const char *>I<domain>B<,>\n"
13105 #. type: Plain text
13106 #: build/C/man3/resolver.3:57
13109 "B<int >I<class>B<, int >I<type>B<, unsigned char *>I<answer>B<,>\n"
13110 "B<int >I<anslen>B<);>\n"
13113 #. type: Plain text
13114 #: build/C/man3/resolver.3:60
13116 msgid "B<int res_mkquery(int >I<op>B<, const char *>I<dname>B<, int >I<class>B<,>\n"
13119 #. type: Plain text
13120 #: build/C/man3/resolver.3:63
13123 "B<int >I<type>B<, char *>I<data>B<, int >I<datalen>B<, struct rrec "
13125 "B<char *>I<buf>B<, int >I<buflen>B<);>\n"
13128 #. type: Plain text
13129 #: build/C/man3/resolver.3:66
13132 "B<int res_send(const char *>I<msg>B<, int >I<msglen>B<, char "
13133 "*>I<answer>B<,>\n"
13136 #. type: Plain text
13137 #: build/C/man3/resolver.3:68
13139 msgid "B<int >I<anslen>B<);>\n"
13142 #. type: Plain text
13143 #: build/C/man3/resolver.3:71
13145 msgid "B<int dn_comp(unsigned char *>I<exp_dn>B<, unsigned char *>I<comp_dn>B<,>\n"
13148 #. type: Plain text
13149 #: build/C/man3/resolver.3:73
13152 "B<int >I<length>B<, unsigned char **>I<dnptrs>B<, unsigned char "
13153 "**>I<lastdnptr>B<);>\n"
13156 #. type: Plain text
13157 #: build/C/man3/resolver.3:76
13159 msgid "B<int dn_expand(unsigned char *>I<msg>B<, unsigned char *>I<eomorig>B<,>\n"
13162 #. type: Plain text
13163 #: build/C/man3/resolver.3:79
13166 "B<unsigned char *>I<comp_dn>B<, char *>I<exp_dn>B<,>\n"
13167 "B<int >I<length>B<);>\n"
13170 #. type: Plain text
13171 #: build/C/man3/resolver.3:83
13172 msgid "Link with I<-lresolv>."
13175 #. type: Plain text
13176 #: build/C/man3/resolver.3:86
13178 "These functions make queries to and interpret the responses from Internet "
13179 "domain name servers."
13182 #. type: Plain text
13183 #: build/C/man3/resolver.3:99
13185 "The B<res_init>() function reads the configuration files (see "
13186 "resolv.conf(5)) to get the default domain name, search order and name server "
13187 "address(es). If no server is given, the local host is tried. If no domain "
13188 "is given, that associated with the local host is used. It can be overridden "
13189 "with the environment variable B<LOCALDOMAIN>. B<res_init>() is normally "
13190 "executed by the first call to one of the other functions."
13193 #. type: Plain text
13194 #: build/C/man3/resolver.3:107
13196 "The B<res_query>() function queries the name server for the fully qualified "
13197 "domain name I<name> of specified I<type> and I<class>. The reply is left in "
13198 "the buffer I<answer> of length I<anslen> supplied by the caller."
13201 #. type: Plain text
13202 #: build/C/man3/resolver.3:120
13204 "The B<res_search>() function makes a query and waits for the response like "
13205 "B<res_query>(), but in addition implements the default and search rules "
13206 "controlled by B<RES_DEFNAMES> and B<RES_DNSRCH> (see description of I<_res> "
13210 #. type: Plain text
13211 #: build/C/man3/resolver.3:126
13213 "The B<res_querydomain>() function makes a query using B<res_query>() on "
13214 "the concatenation of I<name> and I<domain>."
13217 #. type: Plain text
13218 #: build/C/man3/resolver.3:129
13219 msgid "The following functions are lower-level routines used by B<res_query>()."
13222 #. type: Plain text
13223 #: build/C/man3/resolver.3:140
13225 "The B<res_mkquery>() function constructs a query message in I<buf> of "
13226 "length I<buflen> for the domain name I<dname>. The query type I<op> is "
13227 "usually B<QUERY>, but can be any of the types defined in "
13228 "I<E<lt>arpa/nameser.hE<gt>>. I<newrr> is currently unused."
13231 #. type: Plain text
13232 #: build/C/man3/resolver.3:150
13234 "The B<res_send>() function sends a preformatted query given in I<msg> of "
13235 "length I<msglen> and returns the answer in I<answer> which is of length "
13236 "I<anslen>. It will call B<res_init>(), if it has not already been called."
13239 #. type: Plain text
13240 #: build/C/man3/resolver.3:163
13242 "The B<dn_comp>() function compresses the domain name I<exp_dn> and stores "
13243 "it in the buffer I<comp_dn> of length I<length>. The compression uses an "
13244 "array of pointers I<dnptrs> to previously compressed names in the current "
13245 "message. The first pointer points to the beginning of the message and the "
13246 "list ends with NULL. The limit of the array is specified by I<lastdnptr>. "
13247 "If I<dnptr> is NULL, domain names are not compressed. If I<lastdnptr> is "
13248 "NULL, the list of labels is not updated."
13251 #. type: Plain text
13252 #: build/C/man3/resolver.3:172
13254 "The B<dn_expand>() function expands the compressed domain name I<comp_dn> "
13255 "to a full domain name, which is placed in the buffer I<exp_dn> of size "
13256 "I<length>. The compressed name is contained in a query or reply message, "
13257 "and I<msg> points to the beginning of the message."
13260 #. type: Plain text
13261 #: build/C/man3/resolver.3:180
13263 "The resolver routines use global configuration and state information "
13264 "contained in the structure I<_res>, which is defined in "
13265 "I<E<lt>resolv.hE<gt>>. The only field that is normally manipulated by the "
13266 "user is I<_res.options>. This field can contain the bitwise \"OR\" of the "
13267 "following options:"
13271 #: build/C/man3/resolver.3:180
13273 msgid "B<RES_INIT>"
13276 #. type: Plain text
13277 #: build/C/man3/resolver.3:185
13278 msgid "True if B<res_init>() has been called."
13282 #: build/C/man3/resolver.3:185
13284 msgid "B<RES_DEBUG>"
13287 #. type: Plain text
13288 #: build/C/man3/resolver.3:188
13289 msgid "Print debugging messages."
13293 #: build/C/man3/resolver.3:188
13295 msgid "B<RES_AAONLY>"
13298 #. type: Plain text
13299 #: build/C/man3/resolver.3:195
13301 "Accept authoritative answers only. B<res_send>() continues until it finds "
13302 "an authoritative answer or returns an error. [Not currently implemented]."
13306 #: build/C/man3/resolver.3:195
13308 msgid "B<RES_USEVC>"
13311 #. type: Plain text
13312 #: build/C/man3/resolver.3:198
13313 msgid "Use TCP connections for queries rather than UDP datagrams."
13317 #: build/C/man3/resolver.3:198
13319 msgid "B<RES_PRIMARY>"
13322 #. type: Plain text
13323 #: build/C/man3/resolver.3:201
13324 msgid "Query primary domain name server only."
13328 #: build/C/man3/resolver.3:201
13330 msgid "B<RES_IGNTC>"
13333 #. type: Plain text
13334 #: build/C/man3/resolver.3:206
13336 "Ignore truncation errors. Don't retry with TCP. [Not currently "
13341 #: build/C/man3/resolver.3:206
13343 msgid "B<RES_RECURSE>"
13346 #. type: Plain text
13347 #: build/C/man3/resolver.3:213
13349 "Set the recursion desired bit in queries. Recursion is carried out by the "
13350 "domain name server, not by B<res_send>(). [Enabled by default]."
13354 #: build/C/man3/resolver.3:213
13356 msgid "B<RES_DEFNAMES>"
13359 #. type: Plain text
13360 #: build/C/man3/resolver.3:220
13362 "If set, B<res_search>() will append the default domain name to single "
13363 "component names, i.e., those that do not contain a dot. [Enabled by "
13368 #: build/C/man3/resolver.3:220
13370 msgid "B<RES_STAYOPEN>"
13373 #. type: Plain text
13374 #: build/C/man3/resolver.3:225
13375 msgid "Used with B<RES_USEVC> to keep the TCP connection open between queries."
13379 #: build/C/man3/resolver.3:225
13381 msgid "B<RES_DNSRCH>"
13384 #. type: Plain text
13385 #: build/C/man3/resolver.3:234
13387 "If set, B<res_search>() will search for hostnames in the current domain and "
13388 "in parent domains. This option is used by B<gethostbyname>(3). [Enabled by "
13392 #. type: Plain text
13393 #: build/C/man3/resolver.3:238
13395 "This list is not complete. You can find some other flags described in "
13396 "B<resolv.conf>(5)."
13399 #. type: Plain text
13400 #: build/C/man3/resolver.3:243
13401 msgid "The B<res_init>() function returns 0 on success, or -1 if an error occurs."
13404 #. type: Plain text
13405 #: build/C/man3/resolver.3:253
13407 "The B<res_query>(), B<res_search>(), B<res_querydomain>(), B<res_mkquery>() "
13408 "and B<res_send>() functions return the length of the response, or -1 if an "
13412 #. type: Plain text
13413 #: build/C/man3/resolver.3:260
13415 "The B<dn_comp>() and B<dn_expand>() functions return the length of the "
13416 "compressed name, or -1 if an error occurs."
13419 #. type: Plain text
13420 #: build/C/man3/resolver.3:264
13423 "/etc/resolv.conf resolver configuration file\n"
13424 "/etc/host.conf resolver configuration file\n"
13427 #. type: Plain text
13428 #: build/C/man3/resolver.3:267
13432 #. type: Plain text
13433 #: build/C/man3/resolver.3:273
13435 "B<gethostbyname>(3), B<resolv.conf>(5), B<resolver>(5), B<hostname>(7), "
13440 #: build/C/man3/rexec.3:39
13445 #. type: Plain text
13446 #: build/C/man3/rexec.3:42
13447 msgid "rexec, rexec_af - return stream to a remote command"
13450 #. type: Plain text
13451 #: build/C/man3/rexec.3:46
13454 "B<#define _BSD_SOURCE> /* See feature_test_macros(7) */\n"
13455 "B<#include E<lt>netdb.hE<gt>>\n"
13458 #. type: Plain text
13459 #: build/C/man3/rexec.3:49
13462 "B<int rexec(char **>I<ahost>B<, int >I<inport>B<, char *>I<user>B<, >\n"
13463 "B< char *>I<passwd>B<, char *>I<cmd>B<, int *>I<fd2p>B<);>\n"
13466 #. type: Plain text
13467 #: build/C/man3/rexec.3:53
13470 "B<int rexec_af(char **>I<ahost>B<, int >I<inport>B<, char *>I<user>B<, >\n"
13471 "B< char *>I<passwd>B<, char *>I<cmd>B<, int *>I<fd2p>B<,>\n"
13472 "B< sa_family_t >I<af>B<);>\n"
13475 #. type: Plain text
13476 #: build/C/man3/rexec.3:57
13477 msgid "This interface is obsoleted by B<rcmd>(3)."
13480 #. type: Plain text
13481 #: build/C/man3/rexec.3:76
13483 "The B<rexec>() function looks up the host I<*ahost> using "
13484 "B<gethostbyname>(3), returning -1 if the host does not exist. Otherwise "
13485 "I<*ahost> is set to the standard name of the host. If a username and "
13486 "password are both specified, then these are used to authenticate to the "
13487 "foreign host; otherwise the environment and then the user's I<.netrc> file "
13488 "in his home directory are searched for appropriate information. If all this "
13489 "fails, the user is prompted for the information."
13492 #. type: Plain text
13493 #: build/C/man3/rexec.3:87
13495 "The port I<inport> specifies which well-known DARPA Internet port to use for "
13496 "the connection; the call I<getservbyname(\"exec\", \"tcp\")> (see "
13497 "B<getservent>(3)) will return a pointer to a structure that contains the "
13498 "necessary port. The protocol for connection is described in detail in "
13502 #. type: Plain text
13503 #: build/C/man3/rexec.3:120
13505 "If the connection succeeds, a socket in the Internet domain of type "
13506 "B<SOCK_STREAM> is returned to the caller, and given to the remote command as "
13507 "I<stdin> and I<stdout>. If I<fd2p> is nonzero, then an auxiliary channel to "
13508 "a control process will be setup, and a descriptor for it will be placed in "
13509 "I<*fd2p>. The control process will return diagnostic output from the "
13510 "command (unit 2) on this channel, and will also accept bytes on this channel "
13511 "as being UNIX signal numbers, to be forwarded to the process group of the "
13512 "command. The diagnostic information returned does not include remote "
13513 "authorization failure, as the secondary connection is set up after "
13514 "authorization has been verified. If I<fd2p> is 0, then the I<stderr> (unit "
13515 "2 of the remote command) will be made the same as the I<stdout> and no "
13516 "provision is made for sending arbitrary signals to the remote process, "
13517 "although you may be able to get its attention by using out-of-band data."
13521 #: build/C/man3/rexec.3:120
13526 #. type: Plain text
13527 #: build/C/man3/rexec.3:136
13529 "The B<rexec>() function works over IPv4 (B<AF_INET>). By contrast, the "
13530 "B<rexec_af>() function provides an extra argument, I<af>, that allows the "
13531 "caller to select the protocol. This argument can be specified as "
13532 "B<AF_INET>, B<AF_INET6>, or B<AF_UNSPEC> (to allow the implementation to "
13533 "select the protocol)."
13536 #. type: Plain text
13537 #: build/C/man3/rexec.3:140
13538 msgid "The B<rexec_af>() function was added to glibc in version 2.2."
13541 #. type: Plain text
13542 #: build/C/man3/rexec.3:149
13544 "These functions are not in POSIX.1-2001. The B<rexec>() function first "
13545 "appeared in 4.2BSD, and is present on the BSDs, Solaris, and many other "
13546 "systems. The B<rexec_af>() function is more recent, and less widespread."
13549 #. type: Plain text
13550 #: build/C/man3/rexec.3:153
13551 msgid "The B<rexec>() function sends the unencrypted password across the network."
13554 #. type: Plain text
13555 #: build/C/man3/rexec.3:158
13557 "The underlying service is considered a big security hole and therefore not "
13558 "enabled on many sites; see B<rexecd>(8) for explanations."
13561 #. type: Plain text
13562 #: build/C/man3/rexec.3:161
13563 msgid "B<rcmd>(3), B<rexecd>(8)"
13567 #: build/C/man5/services.5:34
13573 #: build/C/man5/services.5:34
13578 #. type: Plain text
13579 #: build/C/man5/services.5:37
13580 msgid "services - Internet network services list"
13583 #. type: Plain text
13584 #: build/C/man5/services.5:52
13586 "B<services> is a plain ASCII file providing a mapping between human-friendly "
13587 "textual names for internet services, and their underlying assigned port "
13588 "numbers and protocol types. Every networking program should look into this "
13589 "file to get the port number (and protocol) for its service. The C library "
13590 "routines B<getservent>(3), B<getservbyname>(3), B<getservbyport>(3), "
13591 "B<setservent>(3), and B<endservent>(3) support querying this file from "
13595 #. type: Plain text
13596 #: build/C/man5/services.5:58
13598 "Port numbers are assigned by the IANA (Internet Assigned Numbers Authority), "
13599 "and their current policy is to assign both TCP and UDP protocols when "
13600 "assigning a port number. Therefore, most entries will have two entries, "
13601 "even for TCP-only services."
13604 #. type: Plain text
13605 #: build/C/man5/services.5:70
13607 "Port numbers below 1024 (so-called \"low numbered\" ports) can only be bound "
13608 "to by root (see B<bind>(2), B<tcp>(7), and B<udp>(7)). This is so clients "
13609 "connecting to low numbered ports can trust that the service running on the "
13610 "port is the standard implementation, and not a rogue service run by a user "
13611 "of the machine. Well-known port numbers specified by the IANA are normally "
13612 "located in this root-only space."
13615 #. type: Plain text
13616 #: build/C/man5/services.5:85
13618 "The presence of an entry for a service in the B<services> file does not "
13619 "necessarily mean that the service is currently running on the machine. See "
13620 "B<inetd.conf>(5) for the configuration of Internet services offered. Note "
13621 "that not all networking services are started by B<inetd>(8), and so won't "
13622 "appear in B<inetd.conf>(5). In particular, news (NNTP) and mail (SMTP) "
13623 "servers are often initialized from the system boot scripts."
13626 #. type: Plain text
13627 #: build/C/man5/services.5:94
13629 "The location of the B<services> file is defined by B<_PATH_SERVICES> in "
13630 "I<E<lt>netdb.hE<gt>>. This is usually set to I</etc/services>."
13633 #. type: Plain text
13634 #: build/C/man5/services.5:96
13635 msgid "Each line describes one service, and is of the form:"
13638 #. type: Plain text
13639 #: build/C/man5/services.5:98
13640 msgid "I<service-name\\ \\ \\ port>B</>I<protocol\\ \\ \\ >[I<aliases ...>]"
13644 #: build/C/man5/services.5:98
13650 #: build/C/man5/services.5:100
13652 msgid "I<service-name>"
13655 #. type: Plain text
13656 #: build/C/man5/services.5:106
13658 "is the friendly name the service is known by and looked up under. It is "
13659 "case sensitive. Often, the client program is named after the "
13664 #: build/C/man5/services.5:106
13669 #. type: Plain text
13670 #: build/C/man5/services.5:109
13671 msgid "is the port number (in decimal) to use for this service."
13674 #. type: Plain text
13675 #: build/C/man5/services.5:120
13677 "is the type of protocol to be used. This field should match an entry in the "
13678 "B<protocols>(5) file. Typical values include B<tcp> and B<udp>."
13681 #. type: Plain text
13682 #: build/C/man5/services.5:126
13684 "is an optional space or tab separated list of other names for this service. "
13685 "Again, the names are case sensitive."
13688 #. type: Plain text
13689 #: build/C/man5/services.5:128
13690 msgid "Either spaces or tabs may be used to separate the fields."
13693 #. type: Plain text
13694 #: build/C/man5/services.5:132
13696 "Comments are started by the hash sign (#) and continue until the end of the "
13697 "line. Blank lines are skipped."
13700 #. type: Plain text
13701 #: build/C/man5/services.5:143
13703 "The I<service-name> should begin in the first column of the file, since "
13704 "leading spaces are not stripped. I<service-names> can be any printable "
13705 "characters excluding space and tab. However, a conservative choice of "
13706 "characters should be used to minimize compatibility problems. E.g., a-z, "
13707 "0-9, and hyphen (-) would seem a sensible choice."
13710 #. type: Plain text
13711 #: build/C/man5/services.5:152
13713 "Lines not matching this format should not be present in the file. "
13714 "(Currently, they are silently skipped by B<getservent>(3), "
13715 "B<getservbyname>(3), and B<getservbyport>(3). However, this behavior should "
13716 "not be relied on.)"
13719 #. type: Plain text
13720 #: build/C/man5/services.5:169
13721 msgid "A sample B<services> file might look like this:"
13725 #: build/C/man5/services.5:172
13730 #. type: Plain text
13731 #: build/C/man5/services.5:182
13735 "qotd 17/tcp quote\n"
13736 "msp 18/tcp # message send protocol\n"
13737 "msp 18/udp # message send protocol\n"
13738 "chargen 19/tcp ttytst source\n"
13739 "chargen 19/udp ttytst source\n"
13741 "# 22 - unassigned\n"
13745 #. type: Plain text
13746 #: build/C/man5/services.5:188
13747 msgid "The Internet network services list"
13751 #: build/C/man5/services.5:188
13753 msgid "I<E<lt>netdb.hE<gt>>"
13757 #. It's not clear when/if the following was ever true;
13758 #. it isn't true for glibc 2.8:
13759 #. There is a maximum of 35 aliases, due to the way the
13760 #. .BR getservent (3)
13761 #. code is written.
13763 #. It's not clear when/if the following was ever true;
13764 #. it isn't true for glibc 2.8:
13765 #. Lines longer than
13767 #. (currently 1024) characters will be ignored by
13768 #. .BR getservent (3),
13769 #. .BR getservbyname (3),
13771 #. .BR getservbyport (3).
13772 #. However, this will also cause the next line to be mis-parsed.
13773 #. type: Plain text
13774 #: build/C/man5/services.5:209
13775 msgid "Definition of B<_PATH_SERVICES>"
13778 #. type: Plain text
13779 #: build/C/man5/services.5:219
13781 "B<listen>(2), B<endservent>(3), B<getservbyname>(3), B<getservbyport>(3), "
13782 "B<getservent>(3), B<setservent>(3), B<inetd.conf>(5), B<protocols>(5), "
13786 #. type: Plain text
13787 #: build/C/man5/services.5:221
13788 msgid "Assigned Numbers RFC, most recently RFC\\ 1700, (AKA STD0002)"
13792 #: build/C/man3/setnetgrent.3:5
13794 msgid "SETNETGRENT"
13798 #: build/C/man3/setnetgrent.3:5
13803 #. type: Plain text
13804 #: build/C/man3/setnetgrent.3:9
13806 "setnetgrent, endnetgrent, getnetgrent, getnetgrent_r, innetgr - handle "
13807 "network group entries"
13810 #. type: Plain text
13811 #: build/C/man3/setnetgrent.3:14
13813 msgid "B<int setnetgrent(const char *>I<netgroup>B<);>\n"
13816 #. type: Plain text
13817 #: build/C/man3/setnetgrent.3:16
13819 msgid "B<void endnetgrent(void);>\n"
13822 #. type: Plain text
13823 #: build/C/man3/setnetgrent.3:18
13826 "B<int getnetgrent(char **>I<host>B<, char **>I<user>B<, char "
13827 "**>I<domain>B<);>\n"
13830 #. type: Plain text
13831 #: build/C/man3/setnetgrent.3:21
13834 "B<int getnetgrent_r(char **>I<host>B<, char **>I<user>B<,>\n"
13835 "B< char **>I<domain>B<, char *>I<buf>B<, int "
13836 ">I<buflen>B<);>\n"
13839 #. type: Plain text
13840 #: build/C/man3/setnetgrent.3:24
13843 "B<int innetgr(const char *>I<netgroup>B<, const char *>I<host>B<,>\n"
13844 "B< const char *>I<user>B<, const char *>I<domain>B<);>\n"
13847 #. type: Plain text
13848 #: build/C/man3/setnetgrent.3:38
13850 "B<setnetgrent>(), B<endnetgrent>(), B<getnetgrent>(), B<getnetgrent_r>(), "
13851 "B<innetgr>(): _BSD_SOURCE || _SVID_SOURCE"
13854 #. type: Plain text
13855 #: build/C/man3/setnetgrent.3:52
13857 "The I<netgroup> is a SunOS invention. A netgroup database is a list of "
13858 "string triples (I<hostname>, I<username>, I<domainname>) or other netgroup "
13859 "names. Any of the elements in a triple can be empty, which means that "
13860 "anything matches. The functions described here allow access to the netgroup "
13861 "databases. The file I</etc/nsswitch.conf> defines what database is "
13865 #. type: Plain text
13866 #: build/C/man3/setnetgrent.3:72
13868 "The B<setnetgrent>() call defines the netgroup that will be searched by "
13869 "subsequent B<getnetgrent>() calls. The B<getnetgrent>() function "
13870 "retrieves the next netgroup entry, and returns pointers in I<host>, I<user>, "
13871 "I<domain>. A NULL pointer means that the corresponding entry matches any "
13872 "string. The pointers are valid only as long as there is no call to other "
13873 "netgroup-related functions. To avoid this problem you can use the GNU "
13874 "function B<getnetgrent_r>() that stores the strings in the supplied "
13875 "buffer. To free all allocated buffers use B<endnetgrent>()."
13878 #. type: Plain text
13879 #: build/C/man3/setnetgrent.3:81
13881 "In most cases you only want to check if the triplet (I<hostname>, "
13882 "I<username>, I<domainname>) is a member of a netgroup. The function "
13883 "B<innetgr>() can be used for this without calling the above three "
13884 "functions. Again, a NULL pointer is a wildcard and matches any string. The "
13885 "function is thread-safe."
13888 #. type: Plain text
13889 #: build/C/man3/setnetgrent.3:83
13890 msgid "These functions return 1 on success and 0 for failure."
13893 #. type: Plain text
13894 #: build/C/man3/setnetgrent.3:85
13895 msgid "I</etc/netgroup>"
13898 #. getnetgrent_r() is on Solaris 8 and AIX 5.1, but not the BSDs.
13899 #. type: Plain text
13900 #: build/C/man3/setnetgrent.3:98
13902 "These functions are not in POSIX.1-2001, but B<setnetgrent>(), "
13903 "B<endnetgrent>(), B<getnetgrent>(), and B<innetgr>() are available on most "
13904 "UNIX systems. B<getnetgrent_r>() is not widely available on other systems."
13907 #. type: Plain text
13908 #: build/C/man3/setnetgrent.3:102
13909 msgid "In the BSD implementation, B<setnetgrent>() returns void."
13912 #. type: Plain text
13913 #: build/C/man3/setnetgrent.3:106
13914 msgid "B<sethostent>(3), B<setprotoent>(3), B<setservent>(3)"
13918 #: build/C/man2/shutdown.2:38
13923 #. type: Plain text
13924 #: build/C/man2/shutdown.2:41
13925 msgid "shutdown - shut down part of a full-duplex connection"
13928 #. type: Plain text
13929 #: build/C/man2/shutdown.2:45
13930 msgid "B<int shutdown(int >I<sockfd>B<, int >I<how>B<);>"
13933 #. type: Plain text
13934 #: build/C/man2/shutdown.2:67
13936 "The B<shutdown>() call causes all or part of a full-duplex connection on "
13937 "the socket associated with I<sockfd> to be shut down. If I<how> is "
13938 "B<SHUT_RD>, further receptions will be disallowed. If I<how> is B<SHUT_WR>, "
13939 "further transmissions will be disallowed. If I<how> is B<SHUT_RDWR>, "
13940 "further receptions and transmissions will be disallowed."
13943 #. type: Plain text
13944 #: build/C/man2/shutdown.2:77
13945 msgid "I<sockfd> is not a valid descriptor."
13948 #. type: Plain text
13949 #: build/C/man2/shutdown.2:80
13950 msgid "The specified socket is not connected."
13953 #. type: Plain text
13954 #: build/C/man2/shutdown.2:84
13955 msgid "I<sockfd> is a file, not a socket."
13958 #. type: Plain text
13959 #: build/C/man2/shutdown.2:88
13961 "POSIX.1-2001, 4.4BSD (the B<shutdown>() function call first appeared in "
13965 #. type: Plain text
13966 #: build/C/man2/shutdown.2:97
13968 "The constants B<SHUT_RD>, B<SHUT_WR>, B<SHUT_RDWR> have the value 0, 1, 2, "
13969 "respectively, and are defined in I<E<lt>sys/socket.hE<gt>> since "
13973 #. type: Plain text
13974 #: build/C/man2/shutdown.2:101
13975 msgid "B<connect>(2), B<socket>(2), B<socket>(7)"
13979 #: build/C/man7/tcp.7:16
13984 #. type: Plain text
13985 #: build/C/man7/tcp.7:19
13986 msgid "tcp - TCP protocol"
13989 #. type: Plain text
13990 #: build/C/man7/tcp.7:25
13991 msgid "B<#include E<lt>netinet/tcp.hE<gt>>"
13994 #. type: Plain text
13995 #: build/C/man7/tcp.7:27
13996 msgid "B<tcp_socket = socket(AF_INET, SOCK_STREAM, 0);>"
13999 #. type: Plain text
14000 #: build/C/man7/tcp.7:40
14002 "This is an implementation of the TCP protocol defined in RFC\\ 793, RFC\\ "
14003 "1122 and RFC\\ 2001 with the NewReno and SACK extensions. It provides a "
14004 "reliable, stream-oriented, full-duplex connection between two sockets on top "
14005 "of B<ip>(7), for both v4 and v6 versions. TCP guarantees that the data "
14006 "arrives in order and retransmits lost packets. It generates and checks a "
14007 "per-packet checksum to catch transmission errors. TCP does not preserve "
14008 "record boundaries."
14011 #. type: Plain text
14012 #: build/C/man7/tcp.7:59
14014 "A newly created TCP socket has no remote or local address and is not fully "
14015 "specified. To create an outgoing TCP connection use B<connect>(2) to "
14016 "establish a connection to another TCP socket. To receive new incoming "
14017 "connections, first B<bind>(2) the socket to a local address and port and "
14018 "then call B<listen>(2) to put the socket into the listening state. After "
14019 "that a new socket for each incoming connection can be accepted using "
14020 "B<accept>(2). A socket which has had B<accept>(2) or B<connect>(2) "
14021 "successfully called on it is fully specified and may transmit data. Data "
14022 "cannot be transmitted on listening or not yet connected sockets."
14025 #. type: Plain text
14026 #: build/C/man7/tcp.7:79
14028 "Linux supports RFC\\ 1323 TCP high performance extensions. These include "
14029 "Protection Against Wrapped Sequence Numbers (PAWS), Window Scaling and "
14030 "Timestamps. Window scaling allows the use of large (E<gt> 64K) TCP windows "
14031 "in order to support links with high latency or bandwidth. To make use of "
14032 "them, the send and receive buffer sizes must be increased. They can be set "
14033 "globally with the I</proc/sys/net/ipv4/tcp_wmem> and "
14034 "I</proc/sys/net/ipv4/tcp_rmem> files, or on individual sockets by using the "
14035 "B<SO_SNDBUF> and B<SO_RCVBUF> socket options with the B<setsockopt>(2) "
14039 #. type: Plain text
14040 #: build/C/man7/tcp.7:110
14042 "The maximum sizes for socket buffers declared via the B<SO_SNDBUF> and "
14043 "B<SO_RCVBUF> mechanisms are limited by the values in the "
14044 "I</proc/sys/net/core/rmem_max> and I</proc/sys/net/core/wmem_max> files. "
14045 "Note that TCP actually allocates twice the size of the buffer requested in "
14046 "the B<setsockopt>(2) call, and so a succeeding B<getsockopt>(2) call will "
14047 "not return the same size of buffer as requested in the B<setsockopt>(2) "
14048 "call. TCP uses the extra space for administrative purposes and internal "
14049 "kernel structures, and the I</proc> file values reflect the larger sizes "
14050 "compared to the actual TCP windows. On individual connections, the socket "
14051 "buffer size must be set prior to the B<listen>(2) or B<connect>(2) calls "
14052 "in order to have it take effect. See B<socket>(7) for more information."
14055 #. type: Plain text
14056 #: build/C/man7/tcp.7:142
14058 "TCP supports urgent data. Urgent data is used to signal the receiver that "
14059 "some important message is part of the data stream and that it should be "
14060 "processed as soon as possible. To send urgent data specify the B<MSG_OOB> "
14061 "option to B<send>(2). When urgent data is received, the kernel sends a "
14062 "B<SIGURG> signal to the process or process group that has been set as the "
14063 "socket \"owner\" using the B<SIOCSPGRP> or B<FIOSETOWN> ioctls (or the "
14064 "POSIX.1-2001-specified B<fcntl>(2) B<F_SETOWN> operation). When the "
14065 "B<SO_OOBINLINE> socket option is enabled, urgent data is put into the normal "
14066 "data stream (a program can test for its location using the B<SIOCATMARK> "
14067 "ioctl described below), otherwise it can be only received when the "
14068 "B<MSG_OOB> flag is set for B<recv>(2) or B<recvmsg>(2)."
14071 #. type: Plain text
14072 #: build/C/man7/tcp.7:150
14074 "Linux 2.4 introduced a number of changes for improved throughput and "
14075 "scaling, as well as enhanced functionality. Some of these features include "
14076 "support for zero-copy B<sendfile>(2), Explicit Congestion Notification, new "
14077 "management of TIME_WAIT sockets, keep-alive socket options and support for "
14078 "Duplicate SACK extensions."
14082 #: build/C/man7/tcp.7:150
14084 msgid "Address Formats"
14087 #. type: Plain text
14088 #: build/C/man7/tcp.7:159
14090 "TCP is built on top of IP (see B<ip>(7)). The address formats defined by "
14091 "B<ip>(7) apply to TCP. TCP only supports point-to-point communication; "
14092 "broadcasting and multicasting are not supported."
14095 #. type: Plain text
14096 #: build/C/man7/tcp.7:171
14098 "System-wide TCP parameter settings can be accessed by files in the directory "
14099 "I</proc/sys/net/ipv4/>. In addition, most IP I</proc> interfaces also apply "
14100 "to TCP; see B<ip>(7). Variables described as I<Boolean> take an integer "
14101 "value, with a nonzero value (\"true\") meaning that the corresponding option "
14102 "is enabled, and a zero value (\"false\") meaning that the option is "
14107 #: build/C/man7/tcp.7:171
14109 msgid "I<tcp_abc> (Integer; default: 0; since Linux 2.6.15)"
14112 #. The following is from 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
14113 #. type: Plain text
14114 #: build/C/man7/tcp.7:179
14116 "Control the Appropriate Byte Count (ABC), defined in RFC 3465. ABC is a way "
14117 "of increasing the congestion window (I<cwnd>) more slowly in response to "
14118 "partial acknowledgments. Possible values are:"
14122 #: build/C/man7/tcp.7:180 build/C/man7/tcp.7:349 build/C/man7/tcp.7:370 build/C/man7/tcp.7:514
14127 #. type: Plain text
14128 #: build/C/man7/tcp.7:184
14129 msgid "increase I<cwnd> once per acknowledgment (no ABC)"
14133 #: build/C/man7/tcp.7:184 build/C/man7/tcp.7:351 build/C/man7/tcp.7:377 build/C/man7/tcp.7:516
14138 #. type: Plain text
14139 #: build/C/man7/tcp.7:188
14140 msgid "increase I<cwnd> once per acknowledgment of full sized segment"
14144 #: build/C/man7/tcp.7:188 build/C/man7/tcp.7:353 build/C/man7/tcp.7:384 build/C/man7/tcp.7:518
14149 #. type: Plain text
14150 #: build/C/man7/tcp.7:193
14152 "allow increase I<cwnd> by two if acknowledgment is of two segments to "
14153 "compensate for delayed acknowledgments."
14157 #: build/C/man7/tcp.7:194
14159 msgid "I<tcp_abort_on_overflow> (Boolean; default: disabled; since Linux 2.4)"
14163 #. type: Plain text
14164 #: build/C/man7/tcp.7:206
14166 "Enable resetting connections if the listening service is too slow and unable "
14167 "to keep up and accept them. It means that if overflow occurred due to a "
14168 "burst, the connection will recover. Enable this option I<only> if you are "
14169 "really sure that the listening daemon cannot be tuned to accept connections "
14170 "faster. Enabling this option can harm the clients of your server."
14174 #: build/C/man7/tcp.7:206
14176 msgid "I<tcp_adv_win_scale> (integer; default: 2; since Linux 2.4)"
14179 #. Since 2.4.0-test7
14180 #. type: Plain text
14181 #: build/C/man7/tcp.7:218
14183 "Count buffering overhead as I<bytes/2^tcp_adv_win_scale>, if "
14184 "I<tcp_adv_win_scale> is greater than 0; or "
14185 "I<bytes-bytes/2^(-tcp_adv_win_scale)>, if I<tcp_adv_win_scale> is less than "
14186 "or equal to zero."
14189 #. type: Plain text
14190 #: build/C/man7/tcp.7:231
14192 "The socket receive buffer space is shared between the application and "
14193 "kernel. TCP maintains part of the buffer as the TCP window, this is the "
14194 "size of the receive window advertised to the other end. The rest of the "
14195 "space is used as the \"application\" buffer, used to isolate the network "
14196 "from scheduling and application latencies. The I<tcp_adv_win_scale> default "
14197 "value of 2 implies that the space used for the application buffer is one "
14198 "fourth that of the total."
14202 #: build/C/man7/tcp.7:231
14205 "I<tcp_allowed_congestion_control> (String; default: see text; since Linux "
14209 #. The following is from 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
14210 #. FIXME How are the items in this delimited? Null bytes, spaces, commas?
14211 #. type: Plain text
14212 #: build/C/man7/tcp.7:243
14214 "Show/set the congestion control algorithm choices available to unprivileged "
14215 "processes (see the description of the B<TCP_CONGESTION> socket option). The "
14216 "list is a subset of those listed in I<tcp_available_congestion_control>. "
14217 "The default value for this list is \"reno\" plus the default setting of "
14218 "I<tcp_congestion_control>."
14222 #: build/C/man7/tcp.7:243
14224 msgid "I<tcp_available_congestion_control> (String; read-only; since Linux 2.4.20)"
14227 #. The following is from 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
14228 #. FIXME How are the items in this delimited? Null bytes, spaces, commas?
14229 #. type: Plain text
14230 #: build/C/man7/tcp.7:253
14232 "Show a list of the congestion-control algorithms that are registered. This "
14233 "list is a limiting set for the list in I<tcp_allowed_congestion_control>. "
14234 "More congestion-control algorithms may be available as modules, but not "
14239 #: build/C/man7/tcp.7:253
14241 msgid "I<tcp_app_win> (integer; default: 31; since Linux 2.4)"
14244 #. Since 2.4.0-test7
14245 #. type: Plain text
14246 #: build/C/man7/tcp.7:258
14248 "This variable defines how many bytes of the TCP window are reserved for "
14249 "buffering overhead."
14253 #. The following is from 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
14254 #. type: Plain text
14255 #: build/C/man7/tcp.7:264
14257 "A maximum of (I<window/2^tcp_app_win>, mss) bytes in the window are reserved "
14258 "for the application buffer. A value of 0 implies that no amount is "
14263 #: build/C/man7/tcp.7:264
14265 msgid "I<tcp_base_mss> (Integer; default: 512; since Linux 2.6.17)"
14269 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
14270 #. type: Plain text
14271 #: build/C/man7/tcp.7:273
14273 "The initial value of I<search_low> to be used by the packetization layer "
14274 "Path MTU discovery (MTU probing). If MTU probing is enabled, this is the "
14275 "initial MSS used by the connection."
14279 #: build/C/man7/tcp.7:273
14281 msgid "I<tcp_bic> (Boolean; default: disabled; Linux 2.4.27/2.6.6 to 2.6.13)"
14285 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
14286 #. type: Plain text
14287 #: build/C/man7/tcp.7:287
14289 "Enable BIC TCP congestion control algorithm. BIC-TCP is a sender-side only "
14290 "change that ensures a linear RTT fairness under large windows while offering "
14291 "both scalability and bounded TCP-friendliness. The protocol combines two "
14292 "schemes called additive increase and binary search increase. When the "
14293 "congestion window is large, additive increase with a large increment ensures "
14294 "linear RTT fairness as well as good scalability. Under small congestion "
14295 "windows, binary search increase provides TCP friendliness."
14299 #: build/C/man7/tcp.7:287
14301 msgid "I<tcp_bic_low_window> (integer; default: 14; Linux 2.4.27/2.6.6 to 2.6.13)"
14305 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
14306 #. type: Plain text
14307 #: build/C/man7/tcp.7:294
14309 "Set the threshold window (in packets) where BIC TCP starts to adjust the "
14310 "congestion window. Below this threshold BIC TCP behaves the same as the "
14311 "default TCP Reno."
14315 #: build/C/man7/tcp.7:294
14318 "I<tcp_bic_fast_convergence> (Boolean; default: enabled; Linux 2.4.27/2.6.6 "
14322 #. type: Plain text
14323 #: build/C/man7/tcp.7:298
14325 "Force BIC TCP to more quickly respond to changes in congestion window. "
14326 "Allows two flows sharing the same connection to converge more rapidly."
14330 #: build/C/man7/tcp.7:298
14332 msgid "I<tcp_congestion_control> (String; default: see text; since Linux 2.4.13)"
14335 #. The following is from 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
14336 #. type: Plain text
14337 #: build/C/man7/tcp.7:305
14339 "Set the default congestion-control algorithm to be used for new "
14340 "connections. The algorithm \"reno\" is always available, but additional "
14341 "choices may be available depending on kernel configuration. The default "
14342 "value for this file is set as part of kernel configuration."
14346 #: build/C/man7/tcp.7:305
14348 msgid "I<tcp_dma_copybreak> (integer; default: 4096; since Linux 2.6.24)"
14351 #. type: Plain text
14352 #: build/C/man7/tcp.7:312
14354 "Lower limit, in bytes, of the size of socket reads that will be offloaded to "
14355 "a DMA copy engine, if one is present in the system and the kernel was "
14356 "configured with the B<CONFIG_NET_DMA> option."
14360 #: build/C/man7/tcp.7:312
14362 msgid "I<tcp_dsack> (Boolean; default: enabled; since Linux 2.4)"
14365 #. Since 2.4.0-test7
14366 #. type: Plain text
14367 #: build/C/man7/tcp.7:316
14368 msgid "Enable RFC\\ 2883 TCP Duplicate SACK support."
14372 #: build/C/man7/tcp.7:316
14374 msgid "I<tcp_ecn> (Boolean; default: disabled; since Linux 2.4)"
14377 #. Since 2.4.0-test7
14378 #. type: Plain text
14379 #: build/C/man7/tcp.7:323
14381 "Enable RFC\\ 2884 Explicit Congestion Notification. When enabled, "
14382 "connectivity to some destinations could be affected due to older, "
14383 "misbehaving routers along the path causing connections to be dropped."
14387 #: build/C/man7/tcp.7:323
14389 msgid "I<tcp_fack> (Boolean; default: enabled; since Linux 2.2)"
14393 #. type: Plain text
14394 #: build/C/man7/tcp.7:327
14395 msgid "Enable TCP Forward Acknowledgement support."
14399 #: build/C/man7/tcp.7:327
14401 msgid "I<tcp_fin_timeout> (integer; default: 60; since Linux 2.2)"
14406 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
14407 #. type: Plain text
14408 #: build/C/man7/tcp.7:337
14410 "This specifies how many seconds to wait for a final FIN packet before the "
14411 "socket is forcibly closed. This is strictly a violation of the TCP "
14412 "specification, but required to prevent denial-of-service attacks. In Linux "
14413 "2.2, the default value was 180."
14417 #: build/C/man7/tcp.7:337
14419 msgid "I<tcp_frto> (integer; default: 0; since Linux 2.4.21/2.6)"
14422 #. Since 2.4.21/2.5.43
14423 #. type: Plain text
14424 #: build/C/man7/tcp.7:346
14426 "Enable F-RTO, an enhanced recovery algorithm for TCP retransmission timeouts "
14427 "(RTOs). It is particularly beneficial in wireless environments where packet "
14428 "loss is typically due to random radio interference rather than intermediate "
14429 "router congestion. See RFC 4138 for more details."
14432 #. type: Plain text
14433 #: build/C/man7/tcp.7:348
14434 msgid "This file can have one of the following values:"
14437 #. type: Plain text
14438 #: build/C/man7/tcp.7:351
14442 #. type: Plain text
14443 #: build/C/man7/tcp.7:353
14444 msgid "The basic version F-RTO algorithm is enabled."
14447 #. type: Plain text
14448 #: build/C/man7/tcp.7:358
14450 "Enable SACK-enhanced F-RTO if flow uses SACK. The basic version can be used "
14451 "also when SACK is in use though in that case scenario(s) exists where F-RTO "
14452 "interacts badly with the packet counting of the SACK-enabled TCP flow."
14455 #. type: Plain text
14456 #: build/C/man7/tcp.7:362
14458 "Before Linux 2.6.22, this parameter was a Boolean value, supporting just "
14459 "values 0 and 1 above."
14463 #: build/C/man7/tcp.7:362
14465 msgid "I<tcp_frto_response> (integer; default: 0; since Linux 2.6.22)"
14468 #. type: Plain text
14469 #: build/C/man7/tcp.7:369
14471 "When F-RTO has detected that a TCP retransmission timeout was spurious (i.e, "
14472 "the timeout would have been avoided had TCP set a longer retransmission "
14473 "timeout), TCP has several options concerning what to do next. Possible "
14477 #. type: Plain text
14478 #: build/C/man7/tcp.7:377
14480 "Rate halving based; a smooth and conservative response, results in halved "
14481 "congestion window (I<cwnd>) and slow-start threshold (I<ssthresh>) after "
14485 #. type: Plain text
14486 #: build/C/man7/tcp.7:384
14488 "Very conservative response; not recommended because even though being valid, "
14489 "it interacts poorly with the rest of Linux TCP; halves I<cwnd> and "
14490 "I<ssthresh> immediately."
14493 #. type: Plain text
14494 #: build/C/man7/tcp.7:393
14496 "Aggressive response; undoes congestion-control measures that are now known "
14497 "to be unnecessary (ignoring the possibility of a lost retransmission that "
14498 "would require TCP to be more cautious); I<cwnd> and I<ssthresh> are restored "
14499 "to the values prior to timeout."
14503 #: build/C/man7/tcp.7:394
14505 msgid "I<tcp_keepalive_intvl> (integer; default: 75; since Linux 2.4)"
14509 #. type: Plain text
14510 #: build/C/man7/tcp.7:398
14511 msgid "The number of seconds between TCP keep-alive probes."
14515 #: build/C/man7/tcp.7:398
14517 msgid "I<tcp_keepalive_probes> (integer; default: 9; since Linux 2.2)"
14521 #. type: Plain text
14522 #: build/C/man7/tcp.7:404
14524 "The maximum number of TCP keep-alive probes to send before giving up and "
14525 "killing the connection if no response is obtained from the other end."
14529 #: build/C/man7/tcp.7:404
14531 msgid "I<tcp_keepalive_time> (integer; default: 7200; since Linux 2.2)"
14535 #. type: Plain text
14536 #: build/C/man7/tcp.7:416
14538 "The number of seconds a connection needs to be idle before TCP begins "
14539 "sending out keep-alive probes. Keep-alives are only sent when the "
14540 "B<SO_KEEPALIVE> socket option is enabled. The default value is 7200 seconds "
14541 "(2 hours). An idle connection is terminated after approximately an "
14542 "additional 11 minutes (9 probes an interval of 75 seconds apart) when "
14543 "keep-alive is enabled."
14547 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
14548 #. type: Plain text
14549 #: build/C/man7/tcp.7:421
14551 "Note that underlying connection tracking mechanisms and application timeouts "
14552 "may be much shorter."
14556 #: build/C/man7/tcp.7:421
14558 msgid "I<tcp_low_latency> (Boolean; default: disabled; since Linux 2.4.21/2.6)"
14561 #. Since 2.4.21/2.5.60
14562 #. type: Plain text
14563 #: build/C/man7/tcp.7:429
14565 "If enabled, the TCP stack makes decisions that prefer lower latency as "
14566 "opposed to higher throughput. It this option is disabled, then higher "
14567 "throughput is preferred. An example of an application where this default "
14568 "should be changed would be a Beowulf compute cluster."
14572 #: build/C/man7/tcp.7:429
14574 msgid "I<tcp_max_orphans> (integer; default: see below; since Linux 2.4)"
14578 #. type: Plain text
14579 #: build/C/man7/tcp.7:443
14581 "The maximum number of orphaned (not attached to any user file handle) TCP "
14582 "sockets allowed in the system. When this number is exceeded, the orphaned "
14583 "connection is reset and a warning is printed. This limit exists only to "
14584 "prevent simple denial-of-service attacks. Lowering this limit is not "
14585 "recommended. Network conditions might require you to increase the number of "
14586 "orphans allowed, but note that each orphan can eat up to ~64K of unswappable "
14587 "memory. The default initial value is set equal to the kernel parameter "
14588 "NR_FILE. This initial default is adjusted depending on the memory in the "
14593 #: build/C/man7/tcp.7:443
14595 msgid "I<tcp_max_syn_backlog> (integer; default: see below; since Linux 2.2)"
14599 #. type: Plain text
14600 #: build/C/man7/tcp.7:460
14602 "The maximum number of queued connection requests which have still not "
14603 "received an acknowledgement from the connecting client. If this number is "
14604 "exceeded, the kernel will begin dropping requests. The default value of 256 "
14605 "is increased to 1024 when the memory present in the system is adequate or "
14606 "greater (E<gt>= 128Mb), and reduced to 128 for those systems with very low "
14607 "memory (E<lt>= 32Mb). It is recommended that if this needs to be increased "
14608 "above 1024, TCP_SYNQ_HSIZE in I<include/net/tcp.h> be modified to keep "
14609 "TCP_SYNQ_HSIZE*16E<lt>=tcp_max_syn_backlog, and the kernel be recompiled."
14613 #: build/C/man7/tcp.7:460
14615 msgid "I<tcp_max_tw_buckets> (integer; default: see below; since Linux 2.4)"
14619 #. type: Plain text
14620 #: build/C/man7/tcp.7:470
14622 "The maximum number of sockets in TIME_WAIT state allowed in the system. "
14623 "This limit exists only to prevent simple denial-of-service attacks. The "
14624 "default value of NR_FILE*2 is adjusted depending on the memory in the "
14625 "system. If this number is exceeded, the socket is closed and a warning is "
14630 #: build/C/man7/tcp.7:470
14632 msgid "I<tcp_moderate_rcvbuf> (Boolean; default: enabled; since Linux 2.4.17/2.6.7)"
14635 #. The following is from 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
14636 #. type: Plain text
14637 #: build/C/man7/tcp.7:477
14639 "If enabled, TCP performs receive buffer auto-tuning, attempting to "
14640 "automatically size the buffer (no greater than I<tcp_rmem[2]>) to match the "
14641 "size required by the path for full throughput."
14645 #: build/C/man7/tcp.7:477
14647 msgid "I<tcp_mem> (since Linux 2.4)"
14650 #. Since 2.4.0-test7
14651 #. type: Plain text
14652 #: build/C/man7/tcp.7:489
14654 "This is a vector of 3 integers: [low, pressure, high]. These bounds, "
14655 "measured in units of the system page size, are used by TCP to track its "
14656 "memory usage. The defaults are calculated at boot time from the amount of "
14657 "available memory. (TCP can only use I<low memory> for this, which is "
14658 "limited to around 900 megabytes on 32-bit systems. 64-bit systems do not "
14659 "suffer this limitation.)"
14663 #: build/C/man7/tcp.7:490
14668 #. type: Plain text
14669 #: build/C/man7/tcp.7:494
14671 "TCP doesn't regulate its memory allocation when the number of pages it has "
14672 "allocated globally is below this number."
14676 #: build/C/man7/tcp.7:494 build/C/man7/udp.7:145
14678 msgid "I<pressure>"
14681 #. type: Plain text
14682 #: build/C/man7/tcp.7:503
14684 "When the amount of memory allocated by TCP exceeds this number of pages, TCP "
14685 "moderates its memory consumption. This memory pressure state is exited once "
14686 "the number of pages allocated falls below the I<low> mark."
14690 #: build/C/man7/tcp.7:503
14695 #. type: Plain text
14696 #: build/C/man7/tcp.7:507
14698 "The maximum number of pages, globally, that TCP will allocate. This value "
14699 "overrides any other limits imposed by the kernel."
14703 #: build/C/man7/tcp.7:508
14705 msgid "I<tcp_mtu_probing> (integer; default: 0; since Linux 2.6.17)"
14708 #. The following is from 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
14709 #. type: Plain text
14710 #: build/C/man7/tcp.7:513
14712 "This parameter controls TCP Packetization-Layer Path MTU Discovery. The "
14713 "following values may be assigned to the file:"
14716 #. type: Plain text
14717 #: build/C/man7/tcp.7:516
14721 #. type: Plain text
14722 #: build/C/man7/tcp.7:518
14723 msgid "Disabled by default, enabled when an ICMP black hole detected"
14726 #. type: Plain text
14727 #: build/C/man7/tcp.7:521
14728 msgid "Always enabled, use initial MSS of I<tcp_base_mss>."
14732 #: build/C/man7/tcp.7:522
14734 msgid "I<tcp_no_metrics_save> (Boolean; default: disabled; since Linux 2.6.6)"
14737 #. The following is from 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
14738 #. type: Plain text
14739 #: build/C/man7/tcp.7:533
14741 "By default, TCP saves various connection metrics in the route cache when the "
14742 "connection closes, so that connections established in the near future can "
14743 "use these to set initial conditions. Usually, this increases overall "
14744 "performance, but it may sometimes cause performance degradation. If "
14745 "I<tcp_no_metrics_save> is enabled, TCP will not cache metrics on closing "
14750 #: build/C/man7/tcp.7:533
14752 msgid "I<tcp_orphan_retries> (integer; default: 8; since Linux 2.4)"
14756 #. type: Plain text
14757 #: build/C/man7/tcp.7:538
14759 "The maximum number of attempts made to probe the other end of a connection "
14760 "which has been closed by our end."
14764 #: build/C/man7/tcp.7:538
14766 msgid "I<tcp_reordering> (integer; default: 3; since Linux 2.4)"
14769 #. Since 2.4.0-test7
14770 #. type: Plain text
14771 #: build/C/man7/tcp.7:547
14773 "The maximum a packet can be reordered in a TCP packet stream without TCP "
14774 "assuming packet loss and going into slow start. It is not advisable to "
14775 "change this number. This is a packet reordering detection metric designed "
14776 "to minimize unnecessary back off and retransmits provoked by reordering of "
14777 "packets on a connection."
14781 #: build/C/man7/tcp.7:547
14783 msgid "I<tcp_retrans_collapse> (Boolean; default: enabled; since Linux 2.2)"
14787 #. type: Plain text
14788 #: build/C/man7/tcp.7:551
14789 msgid "Try to send full-sized packets during retransmit."
14793 #: build/C/man7/tcp.7:551
14795 msgid "I<tcp_retries1> (integer; default: 3; since Linux 2.2)"
14799 #. type: Plain text
14800 #: build/C/man7/tcp.7:561
14802 "The number of times TCP will attempt to retransmit a packet on an "
14803 "established connection normally, without the extra effort of getting the "
14804 "network layers involved. Once we exceed this number of retransmits, we "
14805 "first have the network layer update the route if possible before each new "
14806 "retransmit. The default is the RFC specified minimum of 3."
14810 #: build/C/man7/tcp.7:561
14812 msgid "I<tcp_retries2> (integer; default: 15; since Linux 2.2)"
14816 #. type: Plain text
14817 #: build/C/man7/tcp.7:571
14819 "The maximum number of times a TCP packet is retransmitted in established "
14820 "state before giving up. The default value is 15, which corresponds to a "
14821 "duration of approximately between 13 to 30 minutes, depending on the "
14822 "retransmission timeout. The RFC\\ 1122 specified minimum limit of 100 "
14823 "seconds is typically deemed too short."
14827 #: build/C/man7/tcp.7:571
14829 msgid "I<tcp_rfc1337> (Boolean; default: disabled; since Linux 2.2)"
14833 #. type: Plain text
14834 #: build/C/man7/tcp.7:579
14836 "Enable TCP behavior conformant with RFC\\ 1337. When disabled, if a RST is "
14837 "received in TIME_WAIT state, we close the socket immediately without waiting "
14838 "for the end of the TIME_WAIT period."
14842 #: build/C/man7/tcp.7:579
14844 msgid "I<tcp_rmem> (since Linux 2.4)"
14847 #. Since 2.4.0-test7
14848 #. type: Plain text
14849 #: build/C/man7/tcp.7:587
14851 "This is a vector of 3 integers: [min, default, max]. These parameters are "
14852 "used by TCP to regulate receive buffer sizes. TCP dynamically adjusts the "
14853 "size of the receive buffer from the defaults listed below, in the range of "
14854 "these values, depending on memory available in the system."
14858 #: build/C/man7/tcp.7:588 build/C/man7/tcp.7:764 build/C/man7/udp.7:139
14863 #. type: Plain text
14864 #: build/C/man7/tcp.7:603
14866 "minimum size of the receive buffer used by each TCP socket. The default "
14867 "value is the system page size. (On Linux 2.4, the default value is 4K, "
14868 "lowered to B<PAGE_SIZE> bytes in low-memory systems.) This value is used to "
14869 "ensure that in memory pressure mode, allocations below this size will still "
14870 "succeed. This is not used to bound the size of the receive buffer declared "
14871 "using B<SO_RCVBUF> on a socket."
14875 #: build/C/man7/tcp.7:603 build/C/man7/tcp.7:774
14880 #. type: Plain text
14881 #: build/C/man7/tcp.7:617
14883 "the default size of the receive buffer for a TCP socket. This value "
14884 "overwrites the initial default buffer size from the generic global "
14885 "I<net.core.rmem_default> defined for all protocols. The default value is "
14886 "87380 bytes. (On Linux 2.4, this will be lowered to 43689 in low-memory "
14887 "systems.) If larger receive buffer sizes are desired, this value should be "
14888 "increased (to affect all sockets). To employ large TCP windows, the "
14889 "I<net.ipv4.tcp_window_scaling> must be enabled (default)."
14893 #: build/C/man7/tcp.7:617 build/C/man7/tcp.7:788 build/C/man7/udp.7:151
14898 #. type: Plain text
14899 #: build/C/man7/tcp.7:626
14901 "the maximum size of the receive buffer used by each TCP socket. This value "
14902 "does not override the global I<net.core.rmem_max>. This is not used to "
14903 "limit the size of the receive buffer declared using B<SO_RCVBUF> on a "
14904 "socket. The default value is calculated using the formula"
14907 #. type: Plain text
14908 #: build/C/man7/tcp.7:628
14910 msgid " max(87380, min(4MB, I<tcp_mem>[1]*PAGE_SIZE/128))\n"
14913 #. type: Plain text
14914 #: build/C/man7/tcp.7:631
14916 "(On Linux 2.4, the default is 87380*2 bytes, lowered to 87380 in low-memory "
14921 #: build/C/man7/tcp.7:632
14923 msgid "I<tcp_sack> (Boolean; default: enabled; since Linux 2.2)"
14927 #. type: Plain text
14928 #: build/C/man7/tcp.7:636
14929 msgid "Enable RFC\\ 2018 TCP Selective Acknowledgements."
14933 #: build/C/man7/tcp.7:636
14935 msgid "I<tcp_slow_start_after_idle> (Boolean; default: enabled; since Linux 2.6.18)"
14938 #. The following is from 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
14939 #. type: Plain text
14940 #: build/C/man7/tcp.7:644
14942 "If enabled, provide RFC 2861 behavior and time out the congestion window "
14943 "after an idle period. An idle period is defined as the current RTO "
14944 "(retransmission timeout). If disabled, the congestion window will not be "
14945 "timed out after an idle period."
14949 #: build/C/man7/tcp.7:644
14951 msgid "I<tcp_stdurg> (Boolean; default: disabled; since Linux 2.2)"
14955 #. RFC 793 was ambiguous in its specification of the meaning of the
14956 #. urgent pointer. RFC 1122 (and RFC 961) fixed on a particular
14957 #. resolution of this ambiguity (unfortunately the "wrong" one).
14958 #. type: Plain text
14959 #: build/C/man7/tcp.7:658
14961 "If this option is enabled, then use the RFC\\ 1122 interpretation of the TCP "
14962 "urgent-pointer field. According to this interpretation, the urgent pointer "
14963 "points to the last byte of urgent data. If this option is disabled, then "
14964 "use the BSD-compatible interpretation of the urgent pointer: the urgent "
14965 "pointer points to the first byte after the urgent data. Enabling this "
14966 "option may lead to interoperability problems."
14970 #: build/C/man7/tcp.7:658
14972 msgid "I<tcp_syn_retries> (integer; default: 5; since Linux 2.2)"
14976 #. type: Plain text
14977 #: build/C/man7/tcp.7:665
14979 "The maximum number of times initial SYNs for an active TCP connection "
14980 "attempt will be retransmitted. This value should not be higher than 255. "
14981 "The default value is 5, which corresponds to approximately 180 seconds."
14985 #: build/C/man7/tcp.7:665
14987 msgid "I<tcp_synack_retries> (integer; default: 5; since Linux 2.2)"
14991 #. type: Plain text
14992 #: build/C/man7/tcp.7:671
14994 "The maximum number of times a SYN/ACK segment for a passive TCP connection "
14995 "will be retransmitted. This number should not be higher than 255."
14999 #: build/C/man7/tcp.7:671
15001 msgid "I<tcp_syncookies> (Boolean; since Linux 2.2)"
15005 #. type: Plain text
15006 #: build/C/man7/tcp.7:691
15008 "Enable TCP syncookies. The kernel must be compiled with "
15009 "B<CONFIG_SYN_COOKIES>. Send out syncookies when the syn backlog queue of a "
15010 "socket overflows. The syncookies feature attempts to protect a socket from "
15011 "a SYN flood attack. This should be used as a last resort, if at all. This "
15012 "is a violation of the TCP protocol, and conflicts with other areas of TCP "
15013 "such as TCP extensions. It can cause problems for clients and relays. It "
15014 "is not recommended as a tuning mechanism for heavily loaded servers to help "
15015 "with overloaded or misconfigured conditions. For recommended alternatives "
15016 "see I<tcp_max_syn_backlog>, I<tcp_synack_retries>, and "
15017 "I<tcp_abort_on_overflow>."
15021 #: build/C/man7/tcp.7:691
15023 msgid "I<tcp_timestamps> (Boolean; default: enabled; since Linux 2.2)"
15027 #. type: Plain text
15028 #: build/C/man7/tcp.7:695
15029 msgid "Enable RFC\\ 1323 TCP timestamps."
15033 #: build/C/man7/tcp.7:695
15035 msgid "I<tcp_tso_win_divisor> (integer; default: 3; since Linux 2.6.9)"
15038 #. type: Plain text
15039 #: build/C/man7/tcp.7:701
15041 "This parameter controls what percentage of the congestion window can be "
15042 "consumed by a single TCP Segmentation Offload (TSO) frame. The setting of "
15043 "this parameter is a tradeoff between burstiness and building larger TSO "
15048 #: build/C/man7/tcp.7:701
15050 msgid "I<tcp_tw_recycle> (Boolean; default: disabled; since Linux 2.4)"
15055 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
15056 #. type: Plain text
15057 #: build/C/man7/tcp.7:710
15059 "Enable fast recycling of TIME_WAIT sockets. Enabling this option is not "
15060 "recommended since this causes problems when working with NAT (Network "
15061 "Address Translation)."
15065 #: build/C/man7/tcp.7:710
15067 msgid "I<tcp_tw_reuse> (Boolean; default: disabled; since Linux 2.4.19/2.6)"
15070 #. Since 2.4.19/2.5.43
15072 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
15073 #. type: Plain text
15074 #: build/C/man7/tcp.7:718
15076 "Allow to reuse TIME_WAIT sockets for new connections when it is safe from "
15077 "protocol viewpoint. It should not be changed without advice/request of "
15078 "technical experts."
15082 #: build/C/man7/tcp.7:718
15084 msgid "I<tcp_vegas_cong_avoid> (Boolean; default: disabled; Linux 2.2 to 2.6.13)"
15087 #. Since 2.1.8; removed in 2.6.13
15089 #. The following is from 2.6.12: Documentation/networking/ip-sysctl.txt
15090 #. type: Plain text
15091 #: build/C/man7/tcp.7:729
15093 "Enable TCP Vegas congestion avoidance algorithm. TCP Vegas is a sender-side "
15094 "only change to TCP that anticipates the onset of congestion by estimating "
15095 "the bandwidth. TCP Vegas adjusts the sending rate by modifying the "
15096 "congestion window. TCP Vegas should provide less packet loss, but it is not "
15097 "as aggressive as TCP Reno."
15101 #: build/C/man7/tcp.7:729
15103 msgid "I<tcp_westwood> (Boolean; default: disabled; Linux 2.4.26/2.6.3 to 2.6.13)"
15106 #. type: Plain text
15107 #: build/C/man7/tcp.7:741
15109 "Enable TCP Westwood+ congestion control algorithm. TCP Westwood+ is a "
15110 "sender-side only modification of the TCP Reno protocol stack that optimizes "
15111 "the performance of TCP congestion control. It is based on end-to-end "
15112 "bandwidth estimation to set congestion window and slow start threshold after "
15113 "a congestion episode. Using this estimation, TCP Westwood+ adaptively sets "
15114 "a slow start threshold and a congestion window which takes into account the "
15115 "bandwidth used at the time congestion is experienced. TCP Westwood+ "
15116 "significantly increases fairness with respect to TCP Reno in wired networks "
15117 "and throughput over wireless links."
15121 #: build/C/man7/tcp.7:741
15123 msgid "I<tcp_window_scaling> (Boolean; default: enabled; since Linux 2.2)"
15127 #. type: Plain text
15128 #: build/C/man7/tcp.7:755
15130 "Enable RFC\\ 1323 TCP window scaling. This feature allows the use of a "
15131 "large window (E<gt> 64K) on a TCP connection, should the other end support "
15132 "it. Normally, the 16 bit window length field in the TCP header limits the "
15133 "window size to less than 64K bytes. If larger windows are desired, "
15134 "applications can increase the size of their socket buffers and the window "
15135 "scaling option will be employed. If I<tcp_window_scaling> is disabled, TCP "
15136 "will not negotiate the use of window scaling with the other end during "
15137 "connection setup."
15141 #: build/C/man7/tcp.7:755
15143 msgid "I<tcp_wmem> (since Linux 2.4)"
15146 #. Since 2.4.0-test7
15147 #. type: Plain text
15148 #: build/C/man7/tcp.7:763
15150 "This is a vector of 3 integers: [min, default, max]. These parameters are "
15151 "used by TCP to regulate send buffer sizes. TCP dynamically adjusts the size "
15152 "of the send buffer from the default values listed below, in the range of "
15153 "these values, depending on memory available."
15156 #. type: Plain text
15157 #: build/C/man7/tcp.7:774
15159 "Minimum size of the send buffer used by each TCP socket. The default value "
15160 "is the system page size. (On Linux 2.4, the default value is 4K bytes.) "
15161 "This value is used to ensure that in memory pressure mode, allocations below "
15162 "this size will still succeed. This is not used to bound the size of the "
15163 "send buffer declared using B<SO_SNDBUF> on a socket."
15166 #. True in Linux 2.4 and 2.6
15167 #. type: Plain text
15168 #: build/C/man7/tcp.7:788
15170 "The default size of the send buffer for a TCP socket. This value overwrites "
15171 "the initial default buffer size from the generic global "
15172 "I</proc/sys/net/core/wmem_default> defined for all protocols. The default "
15173 "value is 16K bytes. If larger send buffer sizes are desired, this value "
15174 "should be increased (to affect all sockets). To employ large TCP windows, "
15175 "the I</proc/sys/net/ipv4/tcp_window_scaling> must be set to a nonzero value "
15179 #. type: Plain text
15180 #: build/C/man7/tcp.7:797
15182 "The maximum size of the send buffer used by each TCP socket. This value "
15183 "does not override the value in I</proc/sys/net/core/wmem_max>. This is not "
15184 "used to limit the size of the send buffer declared using B<SO_SNDBUF> on a "
15185 "socket. The default value is calculated using the formula"
15188 #. type: Plain text
15189 #: build/C/man7/tcp.7:799
15191 msgid " max(65536, min(4MB, I<tcp_mem>[1]*PAGE_SIZE/128))\n"
15194 #. type: Plain text
15195 #: build/C/man7/tcp.7:802
15197 "(On Linux 2.4, the default value is 128K bytes, lowered 64K depending on "
15198 "low-memory systems.)"
15202 #: build/C/man7/tcp.7:803
15205 "I<tcp_workaround_signed_windows> (Boolean; default: disabled; since Linux "
15209 #. type: Plain text
15210 #: build/C/man7/tcp.7:809
15212 "If enabled, assume that no receipt of a window-scaling option means that the "
15213 "remote TCP is broken and treats the window as a signed quantity. If "
15214 "disabled, assume that the remote TCP is not broken even if we do not receive "
15215 "a window scaling option from it."
15218 #. or SOL_TCP on Linux
15219 #. FIXME Document TCP_CONGESTION (new in 2.6.13)
15220 #. type: Plain text
15221 #: build/C/man7/tcp.7:824
15223 "To set or get a TCP socket option, call B<getsockopt>(2) to read or "
15224 "B<setsockopt>(2) to write the option with the option level argument set to "
15225 "B<IPPROTO_TCP>. In addition, most B<IPPROTO_IP> socket options are valid on "
15226 "TCP sockets. For more information see B<ip>(7)."
15230 #: build/C/man7/tcp.7:824
15232 msgid "B<TCP_CORK> (since Linux 2.2)"
15235 #. precisely: since 2.1.127
15236 #. type: Plain text
15237 #: build/C/man7/tcp.7:840
15239 "If set, don't send out partial frames. All queued partial frames are sent "
15240 "when the option is cleared again. This is useful for prepending headers "
15241 "before calling B<sendfile>(2), or for throughput optimization. As currently "
15242 "implemented, there is a 200 millisecond ceiling on the time for which output "
15243 "is corked by B<TCP_CORK>. If this ceiling is reached, then queued data is "
15244 "automatically transmitted. This option can be combined with B<TCP_NODELAY> "
15245 "only since Linux 2.5.71. This option should not be used in code intended to "
15250 #: build/C/man7/tcp.7:840
15252 msgid "B<TCP_DEFER_ACCEPT> (since Linux 2.4)"
15255 #. Precisely: since 2.3.38
15256 #. type: Plain text
15257 #: build/C/man7/tcp.7:848
15259 "Allow a listener to be awakened only when data arrives on the socket. Takes "
15260 "an integer value (seconds), this can bound the maximum number of attempts "
15261 "TCP will make to complete the connection. This option should not be used in "
15262 "code intended to be portable."
15266 #: build/C/man7/tcp.7:848
15268 msgid "B<TCP_INFO> (since Linux 2.4)"
15271 #. type: Plain text
15272 #: build/C/man7/tcp.7:854
15274 "Used to collect information about this socket. The kernel returns a "
15275 "I<struct tcp_info> as defined in the file I</usr/include/linux/tcp.h>. This "
15276 "option should not be used in code intended to be portable."
15280 #: build/C/man7/tcp.7:854
15282 msgid "B<TCP_KEEPCNT> (since Linux 2.4)"
15285 #. Precisely: since 2.3.18
15286 #. type: Plain text
15287 #: build/C/man7/tcp.7:861
15289 "The maximum number of keepalive probes TCP should send before dropping the "
15290 "connection. This option should not be used in code intended to be portable."
15294 #: build/C/man7/tcp.7:861
15296 msgid "B<TCP_KEEPIDLE> (since Linux 2.4)"
15299 #. Precisely: since 2.3.18
15300 #. type: Plain text
15301 #: build/C/man7/tcp.7:870
15303 "The time (in seconds) the connection needs to remain idle before TCP starts "
15304 "sending keepalive probes, if the socket option B<SO_KEEPALIVE> has been set "
15305 "on this socket. This option should not be used in code intended to be "
15310 #: build/C/man7/tcp.7:870
15312 msgid "B<TCP_KEEPINTVL> (since Linux 2.4)"
15315 #. Precisely: since 2.3.18
15316 #. type: Plain text
15317 #: build/C/man7/tcp.7:875
15319 "The time (in seconds) between individual keepalive probes. This option "
15320 "should not be used in code intended to be portable."
15324 #: build/C/man7/tcp.7:875
15326 msgid "B<TCP_LINGER2> (since Linux 2.4)"
15329 #. Precisely: since 2.3.41
15330 #. type: Plain text
15331 #: build/C/man7/tcp.7:887
15333 "The lifetime of orphaned FIN_WAIT2 state sockets. This option can be used "
15334 "to override the system-wide setting in the file "
15335 "I</proc/sys/net/ipv4/tcp_fin_timeout> for this socket. This is not to be "
15336 "confused with the B<socket>(7) level option B<SO_LINGER>. This option "
15337 "should not be used in code intended to be portable."
15341 #: build/C/man7/tcp.7:887
15343 msgid "B<TCP_MAXSEG>"
15346 #. Present in Linux 1.0
15348 #. Document TCP_MD5SIG, added in Linux 2.6.20,
15349 #. Needs CONFIG_TCP_MD5SIG
15350 #. From net/inet/Kconfig
15351 #. bool "TCP: MD5 Signature Option support (RFC2385) (EXPERIMENTAL)"
15352 #. RFC2385 specifies a method of giving MD5 protection to TCP sessions.
15353 #. Its main (only?) use is to protect BGP sessions between core routers
15354 #. on the Internet.
15356 #. There is a TCP_MD5SIG option documented in FreeBSD's tcp(4),
15357 #. but probably many details are different on Linux
15358 #. Authors were yoshfuji@linux-ipv6.org and Dave Muller
15359 #. http://thread.gmane.org/gmane.linux.network/47490
15360 #. http://www.daemon-systems.org/man/tcp.4.html
15361 #. http://article.gmane.org/gmane.os.netbsd.devel.network/3767/match=tcp_md5sig+freebsd
15362 #. type: Plain text
15363 #: build/C/man7/tcp.7:912
15365 "The maximum segment size for outgoing TCP packets. In Linux 2.2 and "
15366 "earlier, and in Linux 2.6.28 and later, if this option is set before "
15367 "connection establishment, it also changes the MSS value announced to the "
15368 "other end in the initial packet. Values greater than the (eventual) "
15369 "interface MTU have no effect. TCP will also impose its minimum and maximum "
15370 "bounds over the value provided."
15374 #: build/C/man7/tcp.7:912
15376 msgid "B<TCP_NODELAY>"
15379 #. Present in Linux 1.0
15380 #. type: Plain text
15381 #: build/C/man7/tcp.7:929
15383 "If set, disable the Nagle algorithm. This means that segments are always "
15384 "sent as soon as possible, even if there is only a small amount of data. "
15385 "When not set, data is buffered until there is a sufficient amount to send "
15386 "out, thereby avoiding the frequent sending of small packets, which results "
15387 "in poor utilization of the network. This option is overridden by "
15388 "B<TCP_CORK>; however, setting this option forces an explicit flush of "
15389 "pending output, even if B<TCP_CORK> is currently set."
15393 #: build/C/man7/tcp.7:929
15395 msgid "B<TCP_QUICKACK> (since Linux 2.4.4)"
15398 #. FIXME Document TCP_USER_TIMEOUT (new in 2.6.37)
15399 #. See commit dca43c75e7e545694a9dd6288553f55c53e2a3a3
15400 #. type: Plain text
15401 #: build/C/man7/tcp.7:946
15403 "Enable quickack mode if set or disable quickack mode if cleared. In "
15404 "quickack mode, acks are sent immediately, rather than delayed if needed in "
15405 "accordance to normal TCP operation. This flag is not permanent, it only "
15406 "enables a switch to or from quickack mode. Subsequent operation of the TCP "
15407 "protocol will once again enter/leave quickack mode depending on internal "
15408 "protocol processing and factors such as delayed ack timeouts occurring and "
15409 "data transfer. This option should not be used in code intended to be "
15414 #: build/C/man7/tcp.7:946
15416 msgid "B<TCP_SYNCNT> (since Linux 2.4)"
15419 #. Precisely: since 2.3.18
15420 #. type: Plain text
15421 #: build/C/man7/tcp.7:953
15423 "Set the number of SYN retransmits that TCP should send before aborting the "
15424 "attempt to connect. It cannot exceed 255. This option should not be used "
15425 "in code intended to be portable."
15429 #: build/C/man7/tcp.7:953
15431 msgid "B<TCP_WINDOW_CLAMP> (since Linux 2.4)"
15434 #. Precisely: since 2.3.41
15435 #. type: Plain text
15436 #: build/C/man7/tcp.7:960
15438 "Bound the size of the advertised window to this value. The kernel imposes a "
15439 "minimum size of SOCK_MIN_RCVBUF/2. This option should not be used in code "
15440 "intended to be portable."
15444 #: build/C/man7/tcp.7:960 build/C/man7/unix.7:173
15446 msgid "Sockets API"
15449 #. type: Plain text
15450 #: build/C/man7/tcp.7:969
15452 "TCP provides limited support for out-of-band data, in the form of (a single "
15453 "byte of) urgent data. In Linux this means if the other end sends newer "
15454 "out-of-band data the older urgent data is inserted as normal data into the "
15455 "stream (even when B<SO_OOBINLINE> is not set). This differs from BSD-based "
15459 #. type: Plain text
15460 #: build/C/man7/tcp.7:976
15462 "Linux uses the BSD compatible interpretation of the urgent pointer field by "
15463 "default. This violates RFC\\ 1122, but is required for interoperability "
15464 "with other stacks. It can be changed via I</proc/sys/net/ipv4/tcp_stdurg>."
15467 #. type: Plain text
15468 #: build/C/man7/tcp.7:981
15470 "It is possible to peek at out-of-band data using the I<recv>(2) B<MSG_PEEK> "
15474 #. type: Plain text
15475 #: build/C/man7/tcp.7:997
15477 "Since version 2.4, Linux supports the use of B<MSG_TRUNC> in the I<flags> "
15478 "argument of B<recv>(2) (and B<recvmsg>(2)). This flag causes the received "
15479 "bytes of data to be discarded, rather than passed back in a caller-supplied "
15480 "buffer. Since Linux 2.4.4, B<MSG_PEEK> also has this effect when used in "
15481 "conjunction with B<MSG_OOB> to receive out-of-band data."
15484 #. type: Plain text
15485 #: build/C/man7/tcp.7:1003 build/C/man7/unix.7:286
15487 "The following B<ioctl>(2) calls return information in I<value>. The "
15488 "correct syntax is:"
15491 #. type: Plain text
15492 #: build/C/man7/tcp.7:1008
15495 "B<int>I< value>B<;>\n"
15496 "I<error>B< = ioctl(>I<tcp_socket>B<, >I<ioctl_type>B<, &>I<value>B<);>\n"
15499 #. type: Plain text
15500 #: build/C/man7/tcp.7:1013
15501 msgid "I<ioctl_type> is one of the following:"
15505 #: build/C/man7/tcp.7:1013 build/C/man7/unix.7:296
15510 #. FIXME http://sources.redhat.com/bugzilla/show_bug.cgi?id=12002,
15511 #. filed 2010-09-10, may cause SIOCINQ to be defined in glibc headers
15512 #. SIOCOUTQ also has an effect for UNIX domain sockets, but not
15513 #. quite what userland might expect. It seems to return the number
15514 #. of bytes allocated for buffers containing pending output.
15515 #. That number is normally larger than the number of bytes of pending
15516 #. output. Since this info is, from userland's point of view, imprecise,
15517 #. and it may well change, probably best not to document this now.
15518 #. type: Plain text
15519 #: build/C/man7/tcp.7:1029 build/C/man7/unix.7:318
15521 "Returns the amount of queued unread data in the receive buffer. The socket "
15522 "must not be in LISTEN state, otherwise an error (B<EINVAL>) is returned. "
15523 "B<SIOCINQ> is defined in I<E<lt>linux/sockios.hE<gt>>. Alternatively, you "
15524 "can use the synonymous B<FIONREAD>, defined in I<E<lt>sys/ioctl.hE<gt>>."
15528 #: build/C/man7/tcp.7:1029
15530 msgid "B<SIOCATMARK>"
15533 #. type: Plain text
15534 #: build/C/man7/tcp.7:1034
15536 "Returns true (i.e., I<value> is nonzero) if the inbound data stream is at "
15540 #. type: Plain text
15541 #: build/C/man7/tcp.7:1050
15543 "If the B<SO_OOBINLINE> socket option is set, and B<SIOCATMARK> returns true, "
15544 "then the next read from the socket will return the urgent data. If the "
15545 "B<SO_OOBINLINE> socket option is not set, and B<SIOCATMARK> returns true, "
15546 "then the next read from the socket will return the bytes following the "
15547 "urgent data (to actually read the urgent data requires the B<recv(MSG_OOB)> "
15551 #. type: Plain text
15552 #: build/C/man7/tcp.7:1064
15554 "Note that a read never reads across the urgent mark. If an application is "
15555 "informed of the presence of urgent data via B<select>(2) (using the "
15556 "I<exceptfds> argument) or through delivery of a B<SIGURG> signal, then it "
15557 "can advance up to the mark using a loop which repeatedly tests B<SIOCATMARK> "
15558 "and performs a read (requesting any number of bytes) as long as "
15559 "B<SIOCATMARK> returns false."
15563 #: build/C/man7/tcp.7:1064
15565 msgid "B<SIOCOUTQ>"
15568 #. FIXME http://sources.redhat.com/bugzilla/show_bug.cgi?id=12002,
15569 #. filed 2010-09-10, may cause SIOCOUTQ to be defined in glibc headers
15570 #. type: Plain text
15571 #: build/C/man7/tcp.7:1080
15573 "Returns the amount of unsent data in the socket send queue. The socket must "
15574 "not be in LISTEN state, otherwise an error (B<EINVAL>) is returned. "
15575 "B<SIOCOUTQ> is defined in I<E<lt>linux/sockios.hE<gt>>. Alternatively, you "
15576 "can use the synonymous B<TIOCOUTQ>, defined in I<E<lt>sys/ioctl.hE<gt>>."
15579 #. type: Plain text
15580 #: build/C/man7/tcp.7:1085
15582 "When a network error occurs, TCP tries to resend the packet. If it doesn't "
15583 "succeed after some time, either B<ETIMEDOUT> or the last received error on "
15584 "this connection is reported."
15587 #. type: Plain text
15588 #: build/C/man7/tcp.7:1096
15590 "Some applications require a quicker error notification. This can be enabled "
15591 "with the B<IPPROTO_IP> level B<IP_RECVERR> socket option. When this option "
15592 "is enabled, all incoming errors are immediately passed to the user program. "
15593 "Use this option with care \\(em it makes TCP less tolerant to routing "
15594 "changes and other normal network conditions."
15598 #: build/C/man7/tcp.7:1097
15600 msgid "B<EAFNOTSUPPORT>"
15603 #. type: Plain text
15604 #: build/C/man7/tcp.7:1103
15605 msgid "Passed socket address type in I<sin_family> was not B<AF_INET>."
15608 #. type: Plain text
15609 #: build/C/man7/tcp.7:1107
15611 "The other end closed the socket unexpectedly or a read is executed on a shut "
15616 #: build/C/man7/tcp.7:1107
15618 msgid "B<ETIMEDOUT>"
15621 #. type: Plain text
15622 #: build/C/man7/tcp.7:1110
15623 msgid "The other end didn't acknowledge retransmitted data after some time."
15626 #. type: Plain text
15627 #: build/C/man7/tcp.7:1114
15629 "Any errors defined for B<ip>(7) or the generic socket layer may also be "
15630 "returned for TCP."
15633 #. type: Plain text
15634 #: build/C/man7/tcp.7:1121
15636 "Support for Explicit Congestion Notification, zero-copy B<sendfile>(2), "
15637 "reordering support and some SACK extensions (DSACK) were introduced in 2.4. "
15638 "Support for forward acknowledgement (FACK), TIME_WAIT recycling, and "
15639 "per-connection keepalive socket options were introduced in 2.3."
15642 #. type: Plain text
15643 #: build/C/man7/tcp.7:1123
15644 msgid "Not all errors are documented."
15647 #. Only a single Linux kernel version is described
15648 #. Info for 2.2 was lost. Should be added again,
15649 #. or put into a separate page.
15651 #. This man page was originally written by Andi Kleen.
15652 #. It was updated for 2.4 by Nivedita Singhvi with input from
15653 #. Alexey Kuznetsov's Documentation/networking/ip-sysctl.txt
15655 #. type: Plain text
15656 #: build/C/man7/tcp.7:1133
15657 msgid "IPv6 is not described."
15660 #. type: Plain text
15661 #: build/C/man7/tcp.7:1145
15663 "B<accept>(2), B<bind>(2), B<connect>(2), B<getsockopt>(2), B<listen>(2), "
15664 "B<recvmsg>(2), B<sendfile>(2), B<sendmsg>(2), B<socket>(2), B<ip>(7), "
15668 #. type: Plain text
15669 #: build/C/man7/tcp.7:1147
15670 msgid "RFC\\ 793 for the TCP specification."
15673 #. type: Plain text
15674 #: build/C/man7/tcp.7:1149
15676 "RFC\\ 1122 for the TCP requirements and a description of the Nagle "
15680 #. type: Plain text
15681 #: build/C/man7/tcp.7:1151
15682 msgid "RFC\\ 1323 for TCP timestamp and window scaling options."
15685 #. type: Plain text
15686 #: build/C/man7/tcp.7:1153
15687 msgid "RFC\\ 1337 for a description of TIME_WAIT assassination hazards."
15690 #. type: Plain text
15691 #: build/C/man7/tcp.7:1155
15692 msgid "RFC\\ 3168 for a description of Explicit Congestion Notification."
15695 #. type: Plain text
15696 #: build/C/man7/tcp.7:1157
15697 msgid "RFC\\ 2581 for TCP congestion control algorithms."
15700 #. type: Plain text
15701 #: build/C/man7/tcp.7:1159
15702 msgid "RFC\\ 2018 and RFC\\ 2883 for SACK and extensions to SACK."
15706 #: build/C/man7/udp.7:8
15712 #: build/C/man7/udp.7:8
15717 #. type: Plain text
15718 #: build/C/man7/udp.7:11
15719 msgid "udp - User Datagram Protocol for IPv4"
15722 #. type: Plain text
15723 #: build/C/man7/udp.7:17
15724 msgid "B<udp_socket = socket(AF_INET, SOCK_DGRAM, 0);>"
15727 #. type: Plain text
15728 #: build/C/man7/udp.7:23
15730 "This is an implementation of the User Datagram Protocol described in RFC\\ "
15731 "768. It implements a connectionless, unreliable datagram packet service. "
15732 "Packets may be reordered or duplicated before they arrive. UDP generates "
15733 "and checks checksums to catch transmission errors."
15736 #. type: Plain text
15737 #: build/C/man7/udp.7:52
15739 "When a UDP socket is created, its local and remote addresses are "
15740 "unspecified. Datagrams can be sent immediately using B<sendto>(2) or "
15741 "B<sendmsg>(2) with a valid destination address as an argument. When "
15742 "B<connect>(2) is called on the socket, the default destination address is "
15743 "set and datagrams can now be sent using B<send>(2) or B<write>(2) without "
15744 "specifying a destination address. It is still possible to send to other "
15745 "destinations by passing an address to B<sendto>(2) or B<sendmsg>(2). In "
15746 "order to receive packets, the socket can be bound to a local address first "
15747 "by using B<bind>(2). Otherwise the socket layer will automatically assign a "
15748 "free local port out of the range defined by "
15749 "I</proc/sys/net/ipv4/ip_local_port_range> and bind the socket to "
15753 #. type: Plain text
15754 #: build/C/man7/udp.7:60
15756 "All receive operations return only one packet. When the packet is smaller "
15757 "than the passed buffer, only that much data is returned; when it is bigger, "
15758 "the packet is truncated and the B<MSG_TRUNC> flag is set. B<MSG_WAITALL> is "
15762 #. type: Plain text
15763 #: build/C/man7/udp.7:69
15765 "IP options may be sent or received using the socket options described in "
15766 "B<ip>(7). They are only processed by the kernel when the appropriate "
15767 "I</proc> parameter is enabled (but still passed to the user even when it is "
15768 "turned off). See B<ip>(7)."
15771 #. type: Plain text
15772 #: build/C/man7/udp.7:74
15774 "When the B<MSG_DONTROUTE> flag is set on sending, the destination address "
15775 "must refer to a local interface address and the packet is only sent to that "
15779 #. type: Plain text
15780 #: build/C/man7/udp.7:92
15782 "By default, Linux UDP does path MTU (Maximum Transmission Unit) discovery. "
15783 "This means the kernel will keep track of the MTU to a specific target IP "
15784 "address and return B<EMSGSIZE> when a UDP packet write exceeds it. When "
15785 "this happens, the application should decrease the packet size. Path MTU "
15786 "discovery can be also turned off using the B<IP_MTU_DISCOVER> socket option "
15787 "or the I</proc/sys/net/ipv4/ip_no_pmtu_disc> file; see B<ip>(7) for "
15788 "details. When turned off, UDP will fragment outgoing UDP packets that "
15789 "exceed the interface MTU. However, disabling it is not recommended for "
15790 "performance and reliability reasons."
15793 #. type: Plain text
15794 #: build/C/man7/udp.7:97
15795 msgid "UDP uses the IPv4 I<sockaddr_in> address format described in B<ip>(7)."
15798 #. type: Plain text
15799 #: build/C/man7/udp.7:108
15801 "All fatal errors will be passed to the user as an error return even when the "
15802 "socket is not connected. This includes asynchronous errors received from "
15803 "the network. You may get an error for an earlier packet that was sent on "
15804 "the same socket. This behavior differs from many other BSD socket "
15805 "implementations which don't pass any errors unless the socket is connected. "
15806 "Linux's behavior is mandated by B<RFC\\ 1122>."
15809 #. type: Plain text
15810 #: build/C/man7/udp.7:122
15812 "For compatibility with legacy code, in Linux 2.0 and 2.2 it was possible to "
15813 "set the B<SO_BSDCOMPAT> B<SOL_SOCKET> option to receive remote errors only "
15814 "when the socket has been connected (except for B<EPROTO> and B<EMSGSIZE>). "
15815 "Locally generated errors are always passed. Support for this socket option "
15816 "was removed in later kernels; see B<socket>(7) for further information."
15819 #. type: Plain text
15820 #: build/C/man7/udp.7:131
15822 "When the B<IP_RECVERR> option is enabled, all errors are stored in the "
15823 "socket error queue, and can be received by B<recvmsg>(2) with the "
15824 "B<MSG_ERRQUEUE> flag set."
15827 #. type: Plain text
15828 #: build/C/man7/udp.7:134
15830 "System-wide UDP parameter settings can be accessed by files in the directory "
15831 "I</proc/sys/net/ipv4/>."
15835 #: build/C/man7/udp.7:134
15837 msgid "I<udp_mem> (since Linux 2.6.25)"
15840 #. type: Plain text
15841 #: build/C/man7/udp.7:138
15843 "This is a vector of three integers governing the number of pages allowed for "
15844 "queueing by all UDP sockets."
15847 #. type: Plain text
15848 #: build/C/man7/udp.7:145
15850 "Below this number of pages, UDP is not bothered about its memory appetite. "
15851 "When the amount of memory allocated by UDP exceeds this number, UDP starts "
15852 "to moderate memory usage."
15855 #. type: Plain text
15856 #: build/C/man7/udp.7:151
15858 "This value was introduced to follow the format of I<tcp_mem> (see "
15862 #. type: Plain text
15863 #: build/C/man7/udp.7:154
15864 msgid "Number of pages allowed for queueing by all UDP sockets."
15867 #. type: Plain text
15868 #: build/C/man7/udp.7:158
15870 "Defaults values for these three items are calculated at boot time from the "
15871 "amount of available memory."
15875 #: build/C/man7/udp.7:158
15877 msgid "I<udp_rmem_min> (integer; default value: PAGE_SIZE; since Linux 2.6.25)"
15880 #. type: Plain text
15881 #: build/C/man7/udp.7:165
15883 "Minimal size, in bytes, of receive buffers used by UDP sockets in "
15884 "moderation. Each UDP socket is able to use the size for receiving data, "
15885 "even if total pages of UDP sockets exceed I<udp_mem> pressure."
15889 #: build/C/man7/udp.7:165
15891 msgid "I<udp_wmem_min> (integer; default value: PAGE_SIZE; since Linux 2.6.25)"
15894 #. type: Plain text
15895 #: build/C/man7/udp.7:172
15897 "Minimal size, in bytes, of send buffer used by UDP sockets in moderation. "
15898 "Each UDP socket is able to use the size for sending data, even if total "
15899 "pages of UDP sockets exceed I<udp_mem> pressure."
15902 #. type: Plain text
15903 #: build/C/man7/udp.7:179
15905 "To set or get a UDP socket option, call B<getsockopt>(2) to read or "
15906 "B<setsockopt>(2) to write the option with the option level argument set to "
15911 #: build/C/man7/udp.7:179
15913 msgid "B<UDP_CORK> (since Linux 2.5.44)"
15916 #. FIXME document UDP_ENCAP (new in kernel 2.5.67)
15917 #. From include/linux/udp.h:
15918 #. /* UDP encapsulation types */
15919 #. #define UDP_ENCAP_ESPINUDP_NON_IKE 1 /* draft-ietf-ipsec-nat-t-ike-00/01 */
15920 #. #define UDP_ENCAP_ESPINUDP 2 /* draft-ietf-ipsec-udp-encaps-06 */
15921 #. #define UDP_ENCAP_L2TPINUDP 3 /* rfc2661 */
15922 #. type: Plain text
15923 #: build/C/man7/udp.7:192
15925 "If this option is enabled, then all data output on this socket is "
15926 "accumulated into a single datagram that is transmitted when the option is "
15927 "disabled. This option should not be used in code intended to be portable."
15930 #. type: Plain text
15931 #: build/C/man7/udp.7:196
15932 msgid "These ioctls can be accessed using B<ioctl>(2). The correct syntax is:"
15935 #. type: Plain text
15936 #: build/C/man7/udp.7:201
15939 "B<int>I< value>B<;>\n"
15940 "I<error>B< = ioctl(>I<udp_socket>B<, >I<ioctl_type>B<, &>I<value>B<);>\n"
15944 #: build/C/man7/udp.7:203
15946 msgid "B<FIONREAD> (B<SIOCINQ>)"
15949 #. See http://www.securiteam.com/unixfocus/5KP0I15IKO.html
15950 #. "GNUnet DoS (UDP Socket Unreachable)", 14 May 2006
15951 #. type: Plain text
15952 #: build/C/man7/udp.7:221
15954 "Gets a pointer to an integer as argument. Returns the size of the next "
15955 "pending datagram in the integer in bytes, or 0 when no datagram is pending. "
15956 "B<Warning:> Using B<FIONREAD>, it is impossible to distinguish the case "
15957 "where no datagram is pending from the case where the next pending datagram "
15958 "contains zero bytes of data. It is safer to use B<select>(2), B<poll>(2), "
15959 "or B<epoll>(7) to distinguish these cases."
15963 #: build/C/man7/udp.7:221
15965 msgid "B<TIOCOUTQ> (B<SIOCOUTQ>)"
15968 #. type: Plain text
15969 #: build/C/man7/udp.7:225
15971 "Returns the number of data bytes in the local send queue. Only supported "
15972 "with Linux 2.4 and above."
15975 #. type: Plain text
15976 #: build/C/man7/udp.7:231
15978 "In addition all ioctls documented in B<ip>(7) and B<socket>(7) are "
15982 #. type: Plain text
15983 #: build/C/man7/udp.7:237
15985 "All errors documented for B<socket>(7) or B<ip>(7) may be returned by a "
15986 "send or receive on a UDP socket."
15990 #: build/C/man7/udp.7:237 build/C/man7/unix.7:323
15992 msgid "B<ECONNREFUSED>"
15995 #. type: Plain text
15996 #: build/C/man7/udp.7:241
15998 "No receiver was associated with the destination address. This might be "
15999 "caused by a previous packet sent over the socket."
16003 #. This man page was written by Andi Kleen.
16004 #. type: Plain text
16005 #: build/C/man7/udp.7:246
16006 msgid "B<IP_RECVERR> is a new feature in Linux 2.2."
16009 #. type: Plain text
16010 #: build/C/man7/udp.7:251
16011 msgid "B<ip>(7), B<raw>(7), B<socket>(7), B<udplite>(7)"
16014 #. type: Plain text
16015 #: build/C/man7/udp.7:253
16016 msgid "RFC\\ 768 for the User Datagram Protocol."
16019 #. type: Plain text
16020 #: build/C/man7/udp.7:255
16021 msgid "RFC\\ 1122 for the host requirements."
16024 #. type: Plain text
16025 #: build/C/man7/udp.7:257
16026 msgid "RFC\\ 1191 for a description of path MTU discovery."
16030 #: build/C/man7/udplite.7:25
16035 #. type: Plain text
16036 #: build/C/man7/udplite.7:28
16037 msgid "udplite - Lightweight User Datagram Protocol"
16040 #. type: Plain text
16041 #: build/C/man7/udplite.7:36
16042 msgid "B<sockfd = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDPLITE);>"
16045 #. type: Plain text
16046 #: build/C/man7/udplite.7:39
16048 "This is an implementation of the Lightweight User Datagram Protocol "
16049 "(UDP-Lite), as described in RFC\\ 3828."
16052 #. type: Plain text
16053 #: build/C/man7/udplite.7:45
16055 "UDP-Lite is an extension of UDP (RFC\\ 768) to support variable-length "
16056 "checksums. This has advantages for some types of multimedia transport that "
16057 "may be able to make use of slightly damaged datagrams, rather than having "
16058 "them discarded by lower-layer protocols."
16061 #. type: Plain text
16062 #: build/C/man7/udplite.7:51
16064 "The variable-length checksum coverage is set via a B<setsockopt>(2) "
16065 "option. If this option is not set, the only difference to UDP is in using a "
16066 "different IP protocol identifier (IANA number 136)."
16069 #. type: Plain text
16070 #: build/C/man7/udplite.7:56
16072 "The UDP-Lite implementation is a full extension of B<udp>(7), i.e., it "
16073 "shares the same API and API behaviour, and in addition offers two socket "
16074 "options to control the checksum coverage."
16077 #. type: Plain text
16078 #: build/C/man7/udplite.7:65
16080 "UDP-Litev4 uses the I<sockaddr_in> address format described in B<ip>(7). "
16081 "UDP-Litev6 uses the I<sockaddr_in6> address format described in B<ipv6>(7)."
16084 #. type: Plain text
16085 #: build/C/man7/udplite.7:78
16087 "To set or get a UDP-Lite socket option, call B<getsockopt>(2) to read or "
16088 "B<setsockopt>(2) to write the option with the option level argument set to "
16089 "B<IPPROTO_UDPLITE>. In addition, all B<IPPROTO_UDP> socket options are "
16090 "valid on a UDP-Lite socket. See B<udp>(7) for more information."
16093 #. type: Plain text
16094 #: build/C/man7/udplite.7:80
16095 msgid "The following two options are specific to UDP-Lite."
16099 #: build/C/man7/udplite.7:80
16101 msgid "B<UDPLITE_SEND_CSCOV>"
16104 #. type: Plain text
16105 #: build/C/man7/udplite.7:85
16107 "This option sets the sender checksum coverage and takes an I<int> as "
16108 "argument, with a checksum coverage value in the range 0..2^16-1."
16111 #. type: Plain text
16112 #: build/C/man7/udplite.7:89
16114 "A value of 0 means that the entire datagram is always covered. Values from "
16115 "1-7 are illegal (RFC\\ 3828, 3.1) and are rounded up to the minimum coverage "
16119 #. type: Plain text
16120 #: build/C/man7/udplite.7:95
16122 "With regard to IPv6 jumbograms (RFC\\ 2675), the UDP-Litev6 checksum "
16123 "coverage is limited to the first 2^16-1 octets, as per RFC\\ 3828, 3.5. "
16124 "Higher values are therefore silently truncated to 2^16-1. If in doubt, the "
16125 "current coverage value can always be queried using B<getsockopt>(2)."
16129 #: build/C/man7/udplite.7:95
16131 msgid "B<UDPLITE_RECV_CSCOV>"
16134 #. type: Plain text
16135 #: build/C/man7/udplite.7:106
16137 "This is the receiver-side analogue and uses the same argument format and "
16138 "value range as B<UDPLITE_SEND_CSCOV>. This option is not required to enable "
16139 "traffic with partial checksum coverage. Its function is that of a traffic "
16140 "filter: when enabled, it instructs the kernel to drop all packets which have "
16141 "a coverage I<less> than the specified coverage value."
16144 #. SO_NO_CHECK exists and is supported by UDPv4, but is
16145 #. commented out in socket(7), hence also commented out here
16147 #. Since UDP-Lite mandates checksums, checksumming can not be disabled
16152 #. type: Plain text
16153 #: build/C/man7/udplite.7:119
16155 "When the value of B<UDPLITE_RECV_CSCOV> exceeds the actual packet coverage, "
16156 "incoming packets are silently dropped, but may generate a warning message in "
16160 #. type: Plain text
16161 #: build/C/man7/udplite.7:124
16163 "All errors documented for B<udp>(7) may be returned. UDP-Lite does not add "
16167 #. FIXME . remove this section once glibc supports UDP-Lite
16168 #. type: Plain text
16169 #: build/C/man7/udplite.7:127
16170 msgid "Where glibc support is missing, the following definitions are needed:"
16173 #. The following two are defined in the kernel in linux/net/udplite.h
16174 #. type: Plain text
16175 #: build/C/man7/udplite.7:134
16178 "#define IPPROTO_UDPLITE 136\n"
16179 "#define UDPLITE_SEND_CSCOV 10\n"
16180 "#define UDPLITE_RECV_CSCOV 11\n"
16183 #. type: Plain text
16184 #: build/C/man7/udplite.7:139
16185 msgid "I</proc/net/snmp> - basic UDP-Litev4 statistics counters."
16188 #. type: Plain text
16189 #: build/C/man7/udplite.7:142
16190 msgid "I</proc/net/snmp6> - basic UDP-Litev6 statistics counters."
16193 #. type: Plain text
16194 #: build/C/man7/udplite.7:144
16195 msgid "UDP-Litev4/v6 first appeared in Linux 2.6.20."
16198 #. type: Plain text
16199 #: build/C/man7/udplite.7:149
16200 msgid "B<ip>(7), B<ipv6>(7), B<socket>(7), B<udp>(7)"
16203 #. type: Plain text
16204 #: build/C/man7/udplite.7:151
16205 msgid "RFC\\ 3828 for the Lightweight User Datagram Protocol (UDP-Lite)"
16208 #. type: Plain text
16209 #: build/C/man7/udplite.7:153
16210 msgid "I<Documentation/networking/udplite.txt>"
16214 #: build/C/man7/unix.7:15
16219 #. type: Plain text
16220 #: build/C/man7/unix.7:19
16221 msgid "unix - Sockets for local interprocess communication"
16224 #. type: Plain text
16225 #: build/C/man7/unix.7:23
16226 msgid "B<#include E<lt>sys/un.hE<gt>>"
16229 #. type: Plain text
16230 #: build/C/man7/unix.7:25
16231 msgid "I<unix_socket>B< = socket(AF_UNIX, type, 0);>"
16234 #. type: Plain text
16235 #: build/C/man7/unix.7:27
16236 msgid "I<error>B< = socketpair(AF_UNIX, type, 0, int *>I<sv>B<);>"
16239 #. type: Plain text
16240 #: build/C/man7/unix.7:38
16242 "The B<AF_UNIX> (also known as B<AF_LOCAL>) socket family is used to "
16243 "communicate between processes on the same machine efficiently. "
16244 "Traditionally, UNIX domain sockets can be either unnamed, or bound to a file "
16245 "system pathname (marked as being of type socket). Linux also supports an "
16246 "abstract namespace which is independent of the file system."
16249 #. type: Plain text
16250 #: build/C/man7/unix.7:50
16252 "Valid types are: B<SOCK_STREAM>, for a stream-oriented socket and "
16253 "B<SOCK_DGRAM>, for a datagram-oriented socket that preserves message "
16254 "boundaries (as on most UNIX implementations, UNIX domain datagram sockets "
16255 "are always reliable and don't reorder datagrams); and (since Linux 2.6.4) "
16256 "B<SOCK_SEQPACKET>, for a connection-oriented socket that preserves message "
16257 "boundaries and delivers messages in the order that they were sent."
16260 #. type: Plain text
16261 #: build/C/man7/unix.7:53
16263 "UNIX domain sockets support passing file descriptors or process credentials "
16264 "to other processes using ancillary data."
16267 #. type: Plain text
16268 #: build/C/man7/unix.7:55
16269 msgid "A UNIX domain socket address is represented in the following structure:"
16272 #. type: Plain text
16273 #: build/C/man7/unix.7:59
16275 msgid "#define UNIX_PATH_MAX 108\n"
16278 #. type: Plain text
16279 #: build/C/man7/unix.7:64
16282 "struct sockaddr_un {\n"
16283 " sa_family_t sun_family; /* AF_UNIX */\n"
16284 " char sun_path[UNIX_PATH_MAX]; /* pathname */\n"
16288 #. type: Plain text
16289 #: build/C/man7/unix.7:70
16290 msgid "I<sun_family> always contains B<AF_UNIX>."
16293 #. type: Plain text
16294 #: build/C/man7/unix.7:72
16295 msgid "Three types of address are distinguished in this structure:"
16298 #. type: Plain text
16299 #: build/C/man7/unix.7:87
16301 "I<pathname>: a UNIX domain socket can be bound to a null-terminated file "
16302 "system pathname using B<bind>(2). When the address of the socket is "
16303 "returned by B<getsockname>(2), B<getpeername>(2), and B<accept>(2), its "
16304 "length is I<offsetof(struct sockaddr_un, sun_path) + strlen(sun_path) + 1>, "
16305 "and I<sun_path> contains the null-terminated pathname."
16308 #. There is quite some variation across implementations: FreeBSD
16309 #. says the length is 16 bytes, HP-UX 11 says it's zero bytes.
16310 #. type: Plain text
16311 #: build/C/man7/unix.7:107
16313 "I<unnamed>: A stream socket that has not been bound to a pathname using "
16314 "B<bind>(2) has no name. Likewise, the two sockets created by "
16315 "B<socketpair>(2) are unnamed. When the address of an unnamed socket is "
16316 "returned by B<getsockname>(2), B<getpeername>(2), and B<accept>(2), its "
16317 "length is I<sizeof(sa_family_t)>, and I<sun_path> should not be inspected."
16320 #. type: Plain text
16321 #: build/C/man7/unix.7:133
16323 "I<abstract>: an abstract socket address is distinguished by the fact that "
16324 "I<sun_path[0]> is a null byte (\\(aq\\e0\\(aq). The socket's address in "
16325 "this namespace is given by the additional bytes in I<sun_path> that are "
16326 "covered by the specified length of the address structure. (Null bytes in "
16327 "the name have no special significance.) The name has no connection with "
16328 "file system pathnames. When the address of an abstract socket is returned "
16329 "by B<getsockname>(2), B<getpeername>(2), and B<accept>(2), the returned "
16330 "I<addrlen> is greater than I<sizeof(sa_family_t)> (i.e., greater than 2), "
16331 "and the name of the socket is contained in the first I<(addrlen - "
16332 "sizeof(sa_family_t))> bytes of I<sun_path>. The abstract socket namespace "
16333 "is a nonportable Linux extension."
16336 #. type: Plain text
16337 #: build/C/man7/unix.7:146
16339 "For historical reasons these socket options are specified with a "
16340 "B<SOL_SOCKET> type even though they are B<AF_UNIX> specific. They can be "
16341 "set with B<setsockopt>(2) and read with B<getsockopt>(2) by specifying "
16342 "B<SOL_SOCKET> as the socket family."
16346 #: build/C/man7/unix.7:146
16348 msgid "B<SO_PASSCRED>"
16351 #. type: Plain text
16352 #: build/C/man7/unix.7:153
16354 "Enables the receiving of the credentials of the sending process in an "
16355 "ancillary message. When this option is set and the socket is not yet "
16356 "connected a unique name in the abstract namespace will be generated "
16357 "automatically. Expects an integer boolean flag."
16361 #: build/C/man7/unix.7:153
16363 msgid "Autobind Feature"
16366 #. i.e. sizeof(short)
16367 #. type: Plain text
16368 #: build/C/man7/unix.7:173
16370 "If a B<bind>(2) call specifies I<addrlen> as I<sizeof(sa_family_t)>, or the "
16371 "B<SO_PASSCRED> socket option was specified for a socket that was not "
16372 "explicitly bound to an address, then the socket is autobound to an abstract "
16373 "address. The address consists of a null byte followed by 5 bytes in the "
16374 "character set I<[0-9a-f]>. Thus, there is a limit of 2^20 autobind "
16375 "addresses. (From Linux 2.1.15, when the autobind feature was added, 8 bytes "
16376 "were used, and the limit was thus 2^32 autobind addresses. The change to 5 "
16377 "bytes came in Linux 2.3.15.)"
16380 #. type: Plain text
16381 #: build/C/man7/unix.7:176
16383 "The following paragraphs describe domain-specific details and unsupported "
16384 "features of the sockets API for UNIX domain sockets on Linux."
16387 #. type: Plain text
16388 #: build/C/man7/unix.7:184
16390 "UNIX domain sockets do not support the transmission of out-of-band data (the "
16391 "B<MSG_OOB> flag for B<send>(2) and B<recv>(2))."
16394 #. type: Plain text
16395 #: build/C/man7/unix.7:189
16396 msgid "The B<send>(2) B<MSG_MORE> flag is not supported by UNIX domain sockets."
16399 #. type: Plain text
16400 #: build/C/man7/unix.7:197
16402 "The use of B<MSG_TRUNC> in the I<flags> argument of B<recv>(2) is not "
16403 "supported by UNIX domain sockets."
16406 #. type: Plain text
16407 #: build/C/man7/unix.7:209
16409 "The B<SO_SNDBUF> socket option does have an effect for UNIX domain sockets, "
16410 "but the B<SO_RCVBUF> option does not. For datagram sockets, the "
16411 "B<SO_SNDBUF> value imposes an upper limit on the size of outgoing "
16412 "datagrams. This limit is calculated as the doubled (see B<socket>(7)) "
16413 "option value less 32 bytes used for overhead."
16417 #: build/C/man7/unix.7:209
16419 msgid "Ancillary Messages"
16422 #. type: Plain text
16423 #: build/C/man7/unix.7:231
16425 "Ancillary data is sent and received using B<sendmsg>(2) and B<recvmsg>(2). "
16426 "For historical reasons the ancillary message types listed below are "
16427 "specified with a B<SOL_SOCKET> type even though they are B<AF_UNIX> "
16428 "specific. To send them set the I<cmsg_level> field of the struct I<cmsghdr> "
16429 "to B<SOL_SOCKET> and the I<cmsg_type> field to the type. For more "
16430 "information see B<cmsg>(3)."
16434 #: build/C/man7/unix.7:231
16436 msgid "B<SCM_RIGHTS>"
16439 #. type: Plain text
16440 #: build/C/man7/unix.7:237
16442 "Send or receive a set of open file descriptors from another process. The "
16443 "data portion contains an integer array of the file descriptors. The passed "
16444 "file descriptors behave as though they have been created with B<dup>(2)."
16448 #: build/C/man7/unix.7:237
16450 msgid "B<SCM_CREDENTIALS>"
16453 #. type: Plain text
16454 #: build/C/man7/unix.7:247
16456 "Send or receive UNIX credentials. This can be used for authentication. The "
16457 "credentials are passed as a I<struct ucred> ancillary message. Thus "
16458 "structure is defined in I<E<lt>sys/socket.hE<gt>> as follows:"
16461 #. type: Plain text
16462 #: build/C/man7/unix.7:255
16466 " pid_t pid; /* process ID of the sending process */\n"
16467 " uid_t uid; /* user ID of the sending process */\n"
16468 " gid_t gid; /* group ID of the sending process */\n"
16472 #. type: Plain text
16473 #: build/C/man7/unix.7:264
16475 "Since glibc 2.8, the B<_GNU_SOURCE> feature test macro must be defined "
16476 "(before including I<any> header files) in order to obtain the definition of "
16480 #. type: Plain text
16481 #: build/C/man7/unix.7:280
16483 "The credentials which the sender specifies are checked by the kernel. A "
16484 "process with effective user ID 0 is allowed to specify values that do not "
16485 "match its own. The sender must specify its own process ID (unless it has "
16486 "the capability B<CAP_SYS_ADMIN>), its user ID, effective user ID, or saved "
16487 "set-user-ID (unless it has B<CAP_SETUID>), and its group ID, effective group "
16488 "ID, or saved set-group-ID (unless it has B<CAP_SETGID>). To receive a "
16489 "I<struct ucred> message the B<SO_PASSCRED> option must be enabled on the "
16493 #. type: Plain text
16494 #: build/C/man7/unix.7:291
16497 "B<int>I< value>B<;>\n"
16498 "I<error>B< = ioctl(>I<unix_socket>B<, >I<ioctl_type>B<, &>I<value>B<);>\n"
16501 #. type: Plain text
16502 #: build/C/man7/unix.7:296
16503 msgid "I<ioctl_type> can be:"
16506 #. type: Plain text
16507 #: build/C/man7/unix.7:323
16509 "The specified local address is already in use or the file system socket "
16510 "object already exists."
16513 #. type: Plain text
16514 #: build/C/man7/unix.7:329
16516 "The remote address specified by B<connect>(2) was not a listening socket. "
16517 "This error can also occur if the target filename is not a socket."
16521 #: build/C/man7/unix.7:329
16523 msgid "B<ECONNRESET>"
16526 #. type: Plain text
16527 #: build/C/man7/unix.7:332
16528 msgid "Remote socket was unexpectedly closed."
16531 #. type: Plain text
16532 #: build/C/man7/unix.7:335
16533 msgid "User memory address was not valid."
16536 #. type: Plain text
16537 #: build/C/man7/unix.7:344
16539 "Invalid argument passed. A common cause is that the value B<AF_UNIX> was "
16540 "not specified in the I<sun_type> field of passed addresses, or the socket "
16541 "was in an invalid state for the applied operation."
16544 #. type: Plain text
16545 #: build/C/man7/unix.7:349
16547 "B<connect>(2) called on an already connected socket or a target address was "
16548 "specified on a connected socket."
16551 #. type: Plain text
16552 #: build/C/man7/unix.7:354
16554 "The pathname in the remote address specified to B<connect>(2) did not "
16559 #: build/C/man7/unix.7:354
16564 #. type: Plain text
16565 #: build/C/man7/unix.7:360
16566 msgid "Socket operation needs a target address, but the socket is not connected."
16569 #. type: Plain text
16570 #: build/C/man7/unix.7:364
16572 "Stream operation called on non-stream oriented socket or tried to use the "
16573 "out-of-band data option."
16576 #. type: Plain text
16577 #: build/C/man7/unix.7:368
16578 msgid "The sender passed invalid credentials in the I<struct ucred>."
16581 #. type: Plain text
16582 #: build/C/man7/unix.7:380
16584 "Remote socket was closed on a stream socket. If enabled, a B<SIGPIPE> is "
16585 "sent as well. This can be avoided by passing the B<MSG_NOSIGNAL> flag to "
16586 "B<sendmsg>(2) or B<recvmsg>(2)."
16590 #: build/C/man7/unix.7:380
16592 msgid "B<EPROTONOSUPPORT>"
16595 #. type: Plain text
16596 #: build/C/man7/unix.7:384
16597 msgid "Passed protocol is not B<AF_UNIX>."
16601 #: build/C/man7/unix.7:384
16603 msgid "B<EPROTOTYPE>"
16606 #. type: Plain text
16607 #: build/C/man7/unix.7:390
16609 "Remote socket does not match the local socket type (B<SOCK_DGRAM> versus "
16613 #. type: Plain text
16614 #: build/C/man7/unix.7:393
16615 msgid "Unknown socket type."
16618 #. type: Plain text
16619 #: build/C/man7/unix.7:397
16621 "Other errors can be generated by the generic socket layer or by the file "
16622 "system while generating a file system socket object. See the appropriate "
16623 "manual pages for more information."
16626 #. type: Plain text
16627 #: build/C/man7/unix.7:403
16629 "B<SCM_CREDENTIALS> and the abstract namespace were introduced with Linux 2.2 "
16630 "and should not be used in portable programs. (Some BSD-derived systems also "
16631 "support credential passing, but the implementation details differ.)"
16634 #. type: Plain text
16635 #: build/C/man7/unix.7:414
16637 "In the Linux implementation, sockets which are visible in the file system "
16638 "honor the permissions of the directory they are in. Their owner, group and "
16639 "their permissions can be changed. Creation of a new socket will fail if the "
16640 "process does not have write and search (execute) permission on the directory "
16641 "the socket is created in. Connecting to the socket object requires "
16642 "read/write permission. This behavior differs from many BSD-derived systems "
16643 "which ignore permissions for UNIX domain sockets. Portable programs should "
16644 "not rely on this feature for security."
16647 #. type: Plain text
16648 #: build/C/man7/unix.7:422
16650 "Binding to a socket with a filename creates a socket in the file system that "
16651 "must be deleted by the caller when it is no longer needed (using "
16652 "B<unlink>(2)). The usual UNIX close-behind semantics apply; the socket can "
16653 "be unlinked at any time and will be finally removed from the file system "
16654 "when the last reference to it is closed."
16657 #. type: Plain text
16658 #: build/C/man7/unix.7:431
16660 "To pass file descriptors or credentials over a B<SOCK_STREAM>, you need to "
16661 "send or receive at least one byte of nonancillary data in the same "
16662 "B<sendmsg>(2) or B<recvmsg>(2) call."
16665 #. type: Plain text
16666 #: build/C/man7/unix.7:433
16667 msgid "UNIX domain stream sockets do not support the notion of out-of-band data."
16670 #. type: Plain text
16671 #: build/C/man7/unix.7:436
16672 msgid "See B<bind>(2)."
16675 #. type: Plain text
16676 #: build/C/man7/unix.7:441
16677 msgid "For an example of the use of B<SCM_RIGHTS> see B<cmsg>(3)."
16680 #. type: Plain text
16681 #: build/C/man7/unix.7:450
16683 "B<recvmsg>(2), B<sendmsg>(2), B<socket>(2), B<socketpair>(2), B<cmsg>(3), "
16684 "B<capabilities>(7), B<credentials>(7), B<socket>(7)"
16688 #: build/C/man7/x25.7:7
16693 #. type: Plain text
16694 #: build/C/man7/x25.7:10
16695 msgid "x25 - ITU-T X.25 / ISO-8208 protocol interface."
16698 #. type: Plain text
16699 #: build/C/man7/x25.7:14
16700 msgid "B<#include E<lt>linux/x25.hE<gt>>"
16703 #. type: Plain text
16704 #: build/C/man7/x25.7:16
16705 msgid "B<x25_socket = socket(AF_X25, SOCK_SEQPACKET, 0);>"
16708 #. type: Plain text
16709 #: build/C/man7/x25.7:25
16711 "X25 sockets provide an interface to the X.25 packet layer protocol. This "
16712 "allows applications to communicate over a public X.25 data network as "
16713 "standardized by International Telecommunication Union's recommendation X.25 "
16714 "(X.25 DTE-DCE mode). X25 sockets can also be used for communication without "
16715 "an intermediate X.25 network (X.25 DTE-DTE mode) as described in ISO-8208."
16718 #. type: Plain text
16719 #: build/C/man7/x25.7:42
16721 "Message boundaries are preserved \\(em a B<read>(2) from a socket will "
16722 "retrieve the same chunk of data as output with the corresponding B<write>(2) "
16723 "to the peer socket. When necessary, the kernel takes care of segmenting and "
16724 "reassembling long messages by means of the X.25 M-bit. There is no "
16725 "hard-coded upper limit for the message size. However, reassembling of a "
16726 "long message might fail if there is a temporary lack of system resources or "
16727 "when other constraints (such as socket memory or buffer size limits) become "
16728 "effective. If that occurs, the X.25 connection will be reset."
16732 #: build/C/man7/x25.7:42
16734 msgid "Socket Addresses"
16737 #. type: Plain text
16738 #: build/C/man7/x25.7:49
16740 "The B<AF_X25> socket address family uses the I<struct sockaddr_x25> for "
16741 "representing network addresses as defined in ITU-T recommendation X.121."
16744 #. type: Plain text
16745 #: build/C/man7/x25.7:56
16748 "struct sockaddr_x25 {\n"
16749 " sa_family_t sx25_family; /* must be AF_X25 */\n"
16750 " x25_address sx25_addr; /* X.121 Address */\n"
16754 #. type: Plain text
16755 #: build/C/man7/x25.7:67
16757 "I<sx25_addr> contains a char array I<x25_addr[]> to be interpreted as a "
16758 "null-terminated string. I<sx25_addr.x25_addr[]> consists of up to 15 (not "
16759 "counting the terminating 0) ASCII characters forming the X.121 address. "
16760 "Only the decimal digit characters from \\(aq0\\(aq to \\(aq9\\(aq are "
16764 #. type: Plain text
16765 #: build/C/man7/x25.7:76
16767 "The following X.25-specific socket options can be set by using "
16768 "B<setsockopt>(2) and read with B<getsockopt>(2) with the I<level> argument "
16769 "set to B<SOL_X25>."
16773 #: build/C/man7/x25.7:76
16775 msgid "B<X25_QBITINCL>"
16778 #. type: Plain text
16779 #: build/C/man7/x25.7:95
16781 "Controls whether the X.25 Q-bit (Qualified Data Bit) is accessible by the "
16782 "user. It expects an integer argument. If set to 0 (default), the Q-bit is "
16783 "never set for outgoing packets and the Q-bit of incoming packets is "
16784 "ignored. If set to 1, an additional first byte is prepended to each message "
16785 "read from or written to the socket. For data read from the socket, a 0 "
16786 "first byte indicates that the Q-bits of the corresponding incoming data "
16787 "packets were not set. A first byte with value 1 indicates that the Q-bit of "
16788 "the corresponding incoming data packets was set. If the first byte of the "
16789 "data written to the socket is 1 the Q-bit of the corresponding outgoing data "
16790 "packets will be set. If the first byte is 0 the Q-bit will not be set."
16793 #. type: Plain text
16794 #: build/C/man7/x25.7:97
16795 msgid "The AF_X25 protocol family is a new feature of Linux 2.2."
16798 #. type: Plain text
16799 #: build/C/man7/x25.7:100
16800 msgid "Plenty, as the X.25 PLP implementation is B<CONFIG_EXPERIMENTAL>."
16803 #. type: Plain text
16804 #: build/C/man7/x25.7:102
16805 msgid "This man page is incomplete."
16808 #. type: Plain text
16809 #: build/C/man7/x25.7:109
16811 "There is no dedicated application programmer's header file yet; you need to "
16812 "include the kernel header file I<E<lt>linux/x25.hE<gt>>. "
16813 "B<CONFIG_EXPERIMENTAL> might also imply that future versions of the "
16814 "interface are not binary compatible."
16817 #. type: Plain text
16818 #: build/C/man7/x25.7:113
16820 "X.25 N-Reset events are not propagated to the user process yet. Thus, if a "
16821 "reset occurred, data might be lost without notice."
16824 #. type: Plain text
16825 #: build/C/man7/x25.7:116
16826 msgid "B<socket>(2), B<socket>(7)"
16829 #. type: Plain text
16830 #: build/C/man7/x25.7:120
16832 "Jonathan Simon Naylor: \\(lqThe Re-Analysis and Re-Implementation of "
16833 "X.25.\\(rq The URL is"
16836 #. type: Plain text
16837 #: build/C/man7/x25.7:122
16838 msgid "I<ftp://ftp.pspt.fi/pub/ham/linux/ax25/x25doc.tgz>"