]> git.ipfire.org Git - thirdparty/haproxy.git/commitdiff
DOC: simplify bind option "interface" explanation
authorLukas Tribus <luky-37@hotmail.com>
Tue, 12 Feb 2013 21:13:19 +0000 (22:13 +0100)
committerWilly Tarreau <w@1wt.eu>
Tue, 12 Feb 2013 22:42:11 +0000 (23:42 +0100)
The current documentation of the bind option "interface" can be misleading
(as seen on the ML recently).

This patch tries to address misunderstandings by :

  - avoiding the words listen or bind in the behavior description, using
    "restrict to interface" instead

  - using a different sentence construction (partially stolen from
    "man 7 socket": SO_BINDTODEVICE)

  - "defragmentation": moving behavior related explanations to the beginning
    and restrictions, use-cases and requirements to the end.

doc/configuration.txt

index 30647a982f3d33c2baba89fbb200da2306469033..5f7a65bb0929ec93f5b233ed024d9c9643ecdf03 100644 (file)
@@ -7126,14 +7126,13 @@ id <id>
   option can only be used when defining only a single socket.
 
 interface <interface>
-  Sets the name of the network interface to listen. This is currently only
-  supported on Linux. The interface must be a primary system interface, not an
-  aliased interface. When specified, all addresses on the same line will only
-  be accepted if the incoming packets physically come through the designated
-  interface. It is also possible to bind multiple frontends to the same address
-  if they are bound to different interfaces.  Note that binding to a network
-  interface requires root privileges. This parameter is only compatible with
-  TCPv4/TCPv6 sockets.
+  Restricts the socket to a specific interface. When specified, only packets
+  received from that particular interface are processed by the socket. This is
+  currently only supported on Linux. The interface must be a primary system
+  interface, not an aliased interface. It is also possible to bind multiple
+  frontends to the same address if they are bound to different interfaces. Note
+  that binding to a network interface requires root privileges. This parameter
+  is only compatible with TCPv4/TCPv6 sockets.
 
 level <level>
   This setting is used with the stats sockets only to restrict the nature of