docs: Update ares_set_local_dev man page (#886)

Binding to an interface does not require root since
c427bfec18

Fixes #405
Authored-By: Cristian Rodríguez (@crrodriguez)
pull/887/head
Cristian Rodríguez 5 months ago committed by GitHub
parent 8b2f5e01eb
commit 9e64b10f5e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 10
      docs/ares_set_local_dev.3

@ -2,7 +2,7 @@
.\" Copyright 2010 by Ben Greear <greearb@candelatech.com>
.\" SPDX-License-Identifier: MIT
.\"
.TH ARES_SET_LOCAL_DEV 3 "30 June 2010"
.TH ARES_SET_LOCAL_DEV 3 "23 September 2024"
.SH NAME
ares_set_local_dev \- Bind to a specific network device when creating sockets.
.SH SYNOPSIS
@ -15,12 +15,14 @@ void ares_set_local_dev(ares_channel_t *\fIchannel\fP, const char* \fIlocal_dev_
The \fBares_set_local_dev\fP function causes all future sockets
to be bound to this device with SO_BINDTODEVICE. This forces communications
to go over a certain interface, which can be useful on multi-homed machines.
This option is only supported on Linux, and root privileges are required
for the option to work. If SO_BINDTODEVICE is not supported or the
setsocktop call fails (probably because of permissions), the error is
This option is only supported on Linux, the interface must not be already bound to the
socket or the current effective user must have CAP_NET_RAW capability in the current
network namespace for the option to work. If SO_BINDTODEVICE is not supported or the
setsockopt call fails (probably because of permissions), the error is
silently ignored.
.SH SEE ALSO
.BR ares_set_local_ip4 (3)
.BR ares_set_local_ip6 (3)
.BR network_namespaces (7)
.SH NOTES
This function was added in c-ares 1.7.4

Loading…
Cancel
Save