From cabf996a6bdc616cbe4cca148d6faa9548bad16b Mon Sep 17 00:00:00 2001 From: Michael Kerrisk Date: Thu, 20 Nov 2008 14:09:35 -0500 Subject: [PATCH] arp.7, ddp.7, icmp.7, ip.7, socket.7, tcp.7: ffix: Convert /proc file names from bold to italic http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=506335 Reported-by: Eugen Dedu --- man7/arp.7 | 32 +++++++++++------------ man7/ddp.7 | 8 +++--- man7/icmp.7 | 12 ++++----- man7/ip.7 | 35 +++++++++++++------------- man7/socket.7 | 2 +- man7/tcp.7 | 70 +++++++++++++++++++++++++-------------------------- 6 files changed, 80 insertions(+), 79 deletions(-) diff --git a/man7/arp.7 b/man7/arp.7 index cff832f08..2a443eb44 100644 --- a/man7/arp.7 +++ b/man7/arp.7 @@ -143,19 +143,19 @@ devices. Unless otherwise specified time-related sysctls are specified in seconds. .TP -.B anycast_delay +.I anycast_delay The maximum number of jiffies to delay before replying to a IPv6 neighbor solicitation message. Anycast support is not yet implemented. Defaults to 1 second. .TP -.B app_solicit +.I app_solicit The maximum number of probes to send to the user space ARP daemon via netlink before dropping back to multicast probes (see .IR mcast_solicit ). Defaults to 0. .TP -.B base_reachable_time +.I base_reachable_time Once a neighbor has been found, the entry is considered to be valid for at least a random value between .IR base_reachable_time "/2 and 3*" base_reachable_time /2. @@ -163,73 +163,73 @@ An entry's validity will be extended if it receives positive feedback from higher level protocols. Defaults to 30 seconds. .TP -.B delay_first_probe_time +.I delay_first_probe_time Delay before first probe after it has been decided that a neighbor is stale. Defaults to 5 seconds. .TP -.B gc_interval +.I gc_interval How frequently the garbage collector for neighbor entries should attempt to run. Defaults to 30 seconds. .TP -.B gc_stale_time +.I gc_stale_time Determines how often to check for stale neighbor entries. When a neighbor entry is considered stale it is resolved again before sending data to it. Defaults to 60 seconds. .TP -.B gc_thresh1 +.I gc_thresh1 The minimum number of entries to keep in the ARP cache. The garbage collector will not run if there are fewer than this number of entries in the cache. Defaults to 128. .TP -.B gc_thresh2 +.I gc_thresh2 The soft maximum number of entries to keep in the ARP cache. The garbage collector will allow the number of entries to exceed this for 5 seconds before collection will be performed. Defaults to 512. .TP -.B gc_thresh3 +.I gc_thresh3 The hard maximum number of entries to keep in the ARP cache. The garbage collector will always run if there are more than this number of entries in the cache. Defaults to 1024. .TP -.B locktime +.I locktime The minimum number of jiffies to keep an ARP entry in the cache. This prevents ARP cache thrashing if there is more than one potential mapping (generally due to network misconfiguration). Defaults to 1 second. .TP -.B mcast_solicit +.I mcast_solicit The maximum number of attempts to resolve an address by multicast/broadcast before marking the entry as unreachable. Defaults to 3. .TP -.B proxy_delay +.I proxy_delay When an ARP request for a known proxy-ARP address is received, delay up to .I proxy_delay jiffies before replying. This is used to prevent network flooding in some cases. Defaults to 0.8 seconds. .TP -.B proxy_qlen +.I proxy_qlen The maximum number of packets which may be queued to proxy-ARP addresses. Defaults to 64. .TP -.B retrans_time +.I retrans_time The number of jiffies to delay before retransmitting a request. Defaults to 1 second. .TP -.B ucast_solicit +.I ucast_solicit The maximum number of attempts to send unicast probes before asking the ARP daemon (see .IR app_solicit ). Defaults to 3. .TP -.B unres_qlen +.I unres_qlen The maximum number of packets which may be queued for each unresolved address by other network layers. Defaults to 3. diff --git a/man7/ddp.7 b/man7/ddp.7 index 43811e06a..f5cc6b73a 100644 --- a/man7/ddp.7 +++ b/man7/ddp.7 @@ -123,17 +123,17 @@ files or with the .BR sysctl (2) interface. .TP -.B aarp-expiry-time +.I aarp-expiry-time The time interval (in seconds) before an AARP cache entry expires. .TP -.B aarp-resolve-time +.I aarp-resolve-time The time interval (in seconds) before an AARP cache entry is resolved. .TP -.B aarp-retransmit-limit +.I aarp-retransmit-limit The number of retransmissions of an AARP query before the node is declared dead. .TP -.B aarp-tick-time +.I aarp-tick-time The timer rate (in seconds) for the timer driving AARP. .PP The default values match the specification and should never need to be diff --git a/man7/icmp.7 b/man7/icmp.7 index 57ae4e086..9ab56b7c8 100644 --- a/man7/icmp.7 +++ b/man7/icmp.7 @@ -48,7 +48,7 @@ cleared after a burst. A jiffy is a system dependent unit, usually 10ms on i386 and about 1ms on alpha and ia64. .TP -.B icmp_destunreach_rate +.I icmp_destunreach_rate Maximum rate to send ICMP Destination Unreachable packets. This limits the rate at which packets are sent to any individual route or destination. @@ -56,30 +56,30 @@ The limit does not affect sending of .B ICMP_FRAG_NEEDED packets needed for path MTU discovery. .TP -.B icmp_echo_ignore_all +.I icmp_echo_ignore_all If this value is non-zero, Linux will ignore all .B ICMP_ECHO requests. .TP -.B icmp_echo_ignore_broadcasts +.I icmp_echo_ignore_broadcasts If this value is non-zero, Linux will ignore all .B ICMP_ECHO packets sent to broadcast addresses. .TP -.B icmp_echoreply_rate +.I icmp_echoreply_rate Maximum rate for sending .B ICMP_ECHOREPLY packets in response to .B ICMP_ECHOREQUEST packets. .TP -.B icmp_paramprob_rate +.I icmp_paramprob_rate Maximum rate for sending .B ICMP_PARAMETERPROB packets. These packets are sent when a packet arrives with an invalid IP header. .TP -.B icmp_timeexceed_rate +.I icmp_timeexceed_rate Maximum rate for sending .B ICMP_TIME_EXCEEDED packets. diff --git a/man7/ip.7 b/man7/ip.7 index 4cb3a9ae9..2c07faf69 100644 --- a/man7/ip.7 +++ b/man7/ip.7 @@ -227,7 +227,7 @@ Incoming packets are not allowed to change options after the connection is established. The processing of all incoming source routing options is disabled by default and can be enabled by using the -.B accept_source_route +.I accept_source_route sysctl. Other options like timestamps are still handled. For datagram sockets, IP options can be only set by the local user. @@ -519,7 +519,7 @@ as defined in RFC\ 1191 on this socket. The don't fragment flag is set on all outgoing datagrams. The system-wide default is controlled by the -.B ip_no_pmtu_disc +.I ip_no_pmtu_disc sysctl for .B SOCK_STREAM sockets, and disabled on all others. @@ -718,7 +718,7 @@ the corresponding option is enabled, and a zero value ("false") meaning that the option is disabled. .\" .TP -.BR ip_always_defrag " (Boolean)" +.IR ip_always_defrag " (Boolean)" [New with kernel 2.2.13; in earlier kernel versions this feature was controlled at compile time by the .B CONFIG_IP_ALWAYS_DEFRAG @@ -742,31 +742,31 @@ This is automagically turned on when masquerading or transparent proxying are configured. .\" .TP -.B ip_autoconfig +.I ip_autoconfig .\" FIXME document ip_autoconfig Not documented. .\" .TP -.BR ip_default_ttl " (integer; default: 64)" +.IR ip_default_ttl " (integer; default: 64)" Set the default time-to-live value of outgoing packets. This can be changed per socket with the .B IP_TTL option. .\" .TP -.BR ip_dynaddr " (Boolean; default: disabled)" +.IR ip_dynaddr " (Boolean; default: disabled)" Enable dynamic socket address and masquerading entry rewriting on interface address change. This is useful for dialup interface with changing IP addresses. 0 means no rewriting, 1 turns it on and 2 enables verbose mode. .\" .TP -.BR ip_forward " (Boolean; default: disabled)" +.IR ip_forward " (Boolean; default: disabled)" Enable IP forwarding with a boolean flag. IP forwarding can be also set on a per interface basis. .\" .TP -.B ip_local_port_range +.I ip_local_port_range Contains two integers that define the default local port range allocated to sockets. Allocation starts with the first number and ends with the second number. @@ -778,7 +778,7 @@ First number should be at least >1024, better >4096 to avoid clashes with well known ports and to minimize firewall problems. .\" .TP -.BR ip_no_pmtu_disc " (Boolean; default: disabled)" +.IR ip_no_pmtu_disc " (Boolean; default: disabled)" If enabled, don't do Path MTU Discovery for TCP sockets by default. Path MTU discovery may fail if misconfigured firewalls (that drop all ICMP packets) or misconfigured interfaces (e.g., a point-to-point @@ -789,7 +789,7 @@ to the network. .\" .\" The following is from 2.6.12: Documentation/networking/ip-sysctl.txt .TP -.BR ip_nonlocal_bind " (Boolean; default: disabled)" +.IR ip_nonlocal_bind " (Boolean; default: disabled)" If set, allows processes to .BR bind (2) to non-local IP addresses, @@ -797,25 +797,25 @@ which can be quite useful, but may break some applications. .\" .\" The following is from 2.6.12: Documentation/networking/ip-sysctl.txt .TP -.BR ip6frag_time " (integer; default 30)" +.IR ip6frag_time " (integer; default 30)" Time in seconds to keep an IPv6 fragment in memory. .\" .\" The following is from 2.6.12: Documentation/networking/ip-sysctl.txt .TP -.BR ip6frag_secret_interval " (integer; default 600)" +.IR ip6frag_secret_interval " (integer; default 600)" Regeneration interval (in seconds) of the hash secret (or lifetime for the hash secret) for IPv6 fragments. .TP -.BR ipfrag_high_thresh " (integer), " ipfrag_low_thresh " (integer)" +.IR ipfrag_high_thresh " (integer), " ipfrag_low_thresh " (integer)" If the amount of queued IP fragments reaches -.BR ipfrag_high_thresh , +.IR ipfrag_high_thresh , the queue is pruned down to -.BR ipfrag_low_thresh . +.IR ipfrag_low_thresh . Contains an integer with the number of bytes. .TP -.B neigh/* +.I neigh/* See .BR arp (7). .\" FIXME Document the conf/*/* sysctls @@ -824,7 +824,8 @@ See .SS Ioctls All ioctls described in .BR socket (7) -apply to ip. +apply to +.BR ip . .\" 2006-04-02, mtk .\" commented out the following because ipchains is obsolete .\" .PP diff --git a/man7/socket.7 b/man7/socket.7 index 5192f187b..7925c55f3 100644 --- a/man7/socket.7 +++ b/man7/socket.7 @@ -569,7 +569,7 @@ set by using the .B SO_SNDBUF socket option. .TP -.BR message_cost " and " message_burst +.IR message_cost " and " message_burst configure the token bucket filter used to load limit warning messages caused by external network events. .TP diff --git a/man7/tcp.7 b/man7/tcp.7 index 1723a0533..ee4db213a 100644 --- a/man7/tcp.7 +++ b/man7/tcp.7 @@ -184,7 +184,7 @@ meaning that the option is disabled. .\" /proc/sys/net/ipv4/tcp_no_metrics_save .\" 0 .TP -.BR tcp_abort_on_overflow " (Boolean; default: disabled)" +.IR tcp_abort_on_overflow " (Boolean; default: disabled)" Enable resetting connections if the listening service is too slow and unable to keep up and accept them. It means that if overflow occurred due @@ -196,7 +196,7 @@ cannot be tuned to accept connections faster. Enabling this option can harm the clients of your server. .TP -.BR tcp_adv_win_scale " (integer; default: 2)" +.IR tcp_adv_win_scale " (integer; default: 2)" Count buffering overhead as .IR "bytes/2^tcp_adv_win_scale" , if @@ -221,7 +221,7 @@ default value of 2 implies that the space used for the application buffer is one fourth that of the total. .TP -.BR tcp_app_win " (integer; default: 31)" +.IR tcp_app_win " (integer; default: 31)" This variable defines how many bytes of the TCP window are reserved for buffering overhead. @@ -233,7 +233,7 @@ implies that no amount is reserved. .\" .\" The following is from 2.6.12: Documentation/networking/ip-sysctl.txt .TP -.BR tcp_bic " (Boolean; default: disabled)" +.IR tcp_bic " (Boolean; default: disabled)" Enable BIC TCP congestion control algorithm. BIC-TCP is a sender-side only change that ensures a linear RTT fairness under large windows while offering both scalability and @@ -249,7 +249,7 @@ increase provides TCP friendliness. .\" .\" The following is from 2.6.12: Documentation/networking/ip-sysctl.txt .TP -.BR tcp_bic_low_window " (integer; default: 14)" +.IR tcp_bic_low_window " (integer; default: 14)" Sets the threshold window (in packets) where BIC TCP starts to adjust the congestion window. Below this threshold BIC TCP behaves @@ -257,25 +257,25 @@ the same as the default TCP Reno. .\" .\" The following is from 2.6.12: Documentation/networking/ip-sysctl.txt .TP -.BR tcp_bic_fast_convergence " (Boolean; default: enabled)" +.IR tcp_bic_fast_convergence " (Boolean; default: enabled)" Forces BIC TCP to more quickly respond to changes in congestion window. Allows two flows sharing the same connection to converge more rapidly. .TP -.BR tcp_dsack " (Boolean; default: enabled)" +.IR tcp_dsack " (Boolean; default: enabled)" Enable RFC\ 2883 TCP Duplicate SACK support. .TP -.BR tcp_ecn " (Boolean; default: disabled)" +.IR tcp_ecn " (Boolean; default: disabled)" Enable RFC\ 2884 Explicit Congestion Notification. When enabled, connectivity to some destinations could be affected due to older, misbehaving routers along the path causing connections to be dropped. .TP -.BR tcp_fack " (Boolean; default: enabled)" +.IR tcp_fack " (Boolean; default: enabled)" Enable TCP Forward Acknowledgement support. .TP -.BR tcp_fin_timeout " (integer; default: 60)" +.IR tcp_fin_timeout " (integer; default: 60)" This specifies how many seconds to wait for a final FIN packet before the socket is forcibly closed. This is strictly a violation of @@ -285,22 +285,22 @@ In Linux 2.2, the default value was 180. .\" .\" The following is from 2.6.12: Documentation/networking/ip-sysctl.txt .TP -.BR tcp_frto " (Boolean; default: disabled)" +.IR tcp_frto " (Boolean; default: disabled)" Enables F-RTO, an enhanced recovery algorithm for TCP retransmission timeouts. It is particularly beneficial in wireless environments where packet loss is typically due to random radio interference rather than intermediate router congestion. .TP -.BR tcp_keepalive_intvl " (integer; default: 75)" +.IR tcp_keepalive_intvl " (integer; default: 75)" The number of seconds between TCP keep-alive probes. .TP -.BR tcp_keepalive_probes " (integer; default: 9)" +.IR tcp_keepalive_probes " (integer; default: 9)" The maximum number of TCP keep-alive probes to send before giving up and killing the connection if no response is obtained from the other end. .TP -.BR tcp_keepalive_time " (integer; default: 7200)" +.IR tcp_keepalive_time " (integer; default: 7200)" The number of seconds a connection needs to be idle before TCP begins sending out keep-alive probes. Keep-alives are only sent when the @@ -316,14 +316,14 @@ application timeouts may be much shorter. .\" .\" The following is from 2.6.12: Documentation/networking/ip-sysctl.txt .TP -.BR tcp_low_latency " (Boolean; default: disabled)" +.IR tcp_low_latency " (Boolean; default: disabled)" If enabled, the TCP stack makes decisions that prefer lower latency as opposed to higher throughput. It this option is disabled, then higher throughput is preferred. An example of an application where this default should be changed would be a Beowulf compute cluster. .TP -.BR tcp_max_orphans " (integer; default: see below)" +.IR tcp_max_orphans " (integer; default: see below)" The maximum number of orphaned (not attached to any user file handle) TCP sockets allowed in the system. When this number @@ -338,7 +338,7 @@ The default initial value is set equal to the kernel parameter NR_FILE. This initial default is adjusted depending on the memory in the system. .TP -.BR tcp_max_syn_backlog " (integer; default: see below)" +.IR tcp_max_syn_backlog " (integer; default: see below)" The maximum number of queued connection requests which have still not received an acknowledgement from the connecting client. If this number is exceeded, the kernel will begin @@ -354,7 +354,7 @@ be modified to keep TCP_SYNQ_HSIZE*16<=tcp_max_syn_backlog, and the kernel be recompiled. .TP -.BR tcp_max_tw_buckets " (integer; default: see below)" +.IR tcp_max_tw_buckets " (integer; default: see below)" The maximum number of sockets in TIME_WAIT state allowed in the system. This limit exists only to prevent simple denial-of-service @@ -394,11 +394,11 @@ will allocate. This value overrides any other limits imposed by the kernel. .TP -.BR tcp_orphan_retries " (integer; default: 8)" +.IR tcp_orphan_retries " (integer; default: 8)" The maximum number of attempts made to probe the other end of a connection which has been closed by our end. .TP -.BR tcp_reordering " (integer; default: 3)" +.IR tcp_reordering " (integer; default: 3)" The maximum a packet can be reordered in a TCP packet stream without TCP assuming packet loss and going into slow start. It is not advisable to change this number. @@ -406,10 +406,10 @@ This is a packet reordering detection metric designed to minimize unnecessary back off and retransmits provoked by reordering of packets on a connection. .TP -.BR tcp_retrans_collapse " (Boolean; default: enabled)" +.IR tcp_retrans_collapse " (Boolean; default: enabled)" Try to send full-sized packets during retransmit. .TP -.BR tcp_retries1 " (integer; default: 3)" +.IR tcp_retries1 " (integer; default: 3)" The number of times TCP will attempt to retransmit a packet on an established connection normally, without the extra effort of getting the network @@ -419,7 +419,7 @@ retransmits, we first have the network layer update the route if possible before each new retransmit. The default is the RFC specified minimum of 3. .TP -.BR tcp_retries2 " (integer; default: 15)" +.IR tcp_retries2 " (integer; default: 15)" The maximum number of times a TCP packet is retransmitted in established state before giving up. The default @@ -430,7 +430,7 @@ The RFC\ 1122 specified minimum limit of 100 seconds is typically deemed too short. .TP -.BR tcp_rfc1337 " (Boolean; default: disabled)" +.IR tcp_rfc1337 " (Boolean; default: disabled)" Enable TCP behavior conformant with RFC\ 1337. When disabled, if a RST is received in TIME_WAIT state, we close @@ -490,10 +490,10 @@ The default value of 87380*2 bytes is lowered to 87380 in low-memory systems. .RE .TP -.BR tcp_sack " (Boolean; default: enabled)" +.IR tcp_sack " (Boolean; default: enabled)" Enable RFC\ 2018 TCP Selective Acknowledgements. .TP -.BR tcp_stdurg " (Boolean; default: disabled)" +.IR tcp_stdurg " (Boolean; default: disabled)" If this option is enabled, then use the RFC\ 1122 interpretation of the TCP urgent-pointer field. .\" RFC 793 was ambiguous in its specification of the meaning of the @@ -506,12 +506,12 @@ the urgent pointer: the urgent pointer points to the first byte after the urgent data. Enabling this option may lead to interoperability problems. .TP -.BR tcp_synack_retries " (integer; default: 5)" +.IR tcp_synack_retries " (integer; default: 5)" The maximum number of times a SYN/ACK segment for a passive TCP connection will be retransmitted. This number should not be higher than 255. .TP -.BR tcp_syncookies " (Boolean)" +.IR tcp_syncookies " (Boolean)" Enable TCP syncookies. The kernel must be compiled with .BR CONFIG_SYN_COOKIES . @@ -534,7 +534,7 @@ For recommended alternatives see and .IR tcp_abort_on_overflow . .TP -.BR tcp_syn_retries " (integer; default: 5)" +.IR tcp_syn_retries " (integer; default: 5)" The maximum number of times initial SYNs for an active TCP connection attempt will be retransmitted. This value should @@ -542,10 +542,10 @@ not be higher than 255. The default value is 5, which corresponds to approximately 180 seconds. .TP -.BR tcp_timestamps " (Boolean; default: enabled)" +.IR tcp_timestamps " (Boolean; default: enabled)" Enable RFC\ 1323 TCP timestamps. .TP -.BR tcp_tw_recycle " (Boolean; default: disabled)" +.IR tcp_tw_recycle " (Boolean; default: disabled)" Enable fast recycling of TIME_WAIT sockets. Enabling this option is not recommended since this causes problems when working @@ -553,13 +553,13 @@ with NAT (Network Address Translation). .\" .\" The following is from 2.6.12: Documentation/networking/ip-sysctl.txt .TP -.BR tcp_tw_reuse " (Boolean; default: disabled)" +.IR tcp_tw_reuse " (Boolean; default: disabled)" Allow to reuse TIME_WAIT sockets for new connections when it is safe from protocol viewpoint. It should not be changed without advice/request of technical experts. .TP -.BR tcp_window_scaling " (Boolean; default: enabled)" +.IR tcp_window_scaling " (Boolean; default: enabled)" Enable RFC\ 1323 TCP window scaling. This feature allows the use of a large window (> 64K) on a TCP connection, should the other end support it. @@ -576,7 +576,7 @@ scaling with the other end during connection setup. .\" .\" The following is from 2.6.12: Documentation/networking/ip-sysctl.txt .TP -.BR tcp_vegas_cong_avoid " (Boolean; default: disabled)" +.IR tcp_vegas_cong_avoid " (Boolean; default: disabled)" Enable TCP Vegas congestion avoidance algorithm. TCP Vegas is a sender-side only change to TCP that anticipates the onset of congestion by estimating the bandwidth. @@ -588,7 +588,7 @@ not as aggressive as TCP Reno. .\" .\" The following is from 2.6.12: Documentation/networking/ip-sysctl.txt .TP -.BR tcp_westwood " (Boolean; default: disabled)" +.IR tcp_westwood " (Boolean; default: disabled)" Enable TCP Westwood+ congestion control algorithm. TCP Westwood+ is a sender-side only modification of the TCP Reno protocol stack that optimizes the performance of TCP congestion