summaryrefslogtreecommitdiffstats
path: root/man7/rtnetlink.7
diff options
context:
space:
mode:
Diffstat (limited to 'man7/rtnetlink.7')
-rw-r--r--man7/rtnetlink.772
1 files changed, 52 insertions, 20 deletions
diff --git a/man7/rtnetlink.7 b/man7/rtnetlink.7
index 3b6465f..1ab355f 100644
--- a/man7/rtnetlink.7
+++ b/man7/rtnetlink.7
@@ -7,7 +7,7 @@
.\" help from Matthew Wilcox.
.\" $Id: rtnetlink.7,v 1.8 2000/01/22 01:55:04 freitag Exp $
.\"
-.TH rtnetlink 7 2023-07-15 "Linux man-pages 6.05.01"
+.TH rtnetlink 7 2023-10-31 "Linux man-pages 6.7"
.SH NAME
rtnetlink \- Linux routing socket
.SH SYNOPSIS
@@ -16,7 +16,7 @@ rtnetlink \- Linux routing socket
.B #include <linux/netlink.h>
.B #include <linux/rtnetlink.h>
.B #include <sys/socket.h>
-.PP
+.P
.BI "rtnetlink_socket = socket(AF_NETLINK, int " socket_type ", NETLINK_ROUTE);"
.fi
.SH DESCRIPTION
@@ -35,7 +35,7 @@ for more information.
.\" FIXME . ? all these macros could be moved to rtnetlink(3)
.SS Routing attributes
Some rtnetlink messages have optional attributes after the initial header:
-.PP
+.P
.in +4n
.EX
struct rtattr {
@@ -45,7 +45,7 @@ struct rtattr {
};
.EE
.in
-.PP
+.P
These attributes should be manipulated using only the RTA_* macros
or libnetlink, see
.BR rtnetlink (3).
@@ -53,7 +53,11 @@ or libnetlink, see
Rtnetlink consists of these message types
(in addition to standard netlink messages):
.TP
-.BR RTM_NEWLINK ", " RTM_DELLINK ", " RTM_GETLINK
+.B RTM_NEWLINK
+.TQ
+.B RTM_DELLINK
+.TQ
+.B RTM_GETLINK
Create, remove, or get information about a specific network interface.
These messages contain an
.I ifinfomsg
@@ -112,7 +116,11 @@ is
.RI ( "struct net_device_stats"
in Linux 2.4 and earlier).
.TP
-.BR RTM_NEWADDR ", " RTM_DELADDR ", " RTM_GETADDR
+.B RTM_NEWADDR
+.TQ
+.B RTM_DELADDR
+.TQ
+.B RTM_GETADDR
Add, remove, or receive information about an IP address associated with
an interface.
In Linux 2.2, an interface can carry multiple IP addresses,
@@ -170,7 +178,11 @@ IFA_CACHEINFO:struct ifa_cacheinfo:Address information
.TE
.\" FIXME Document struct ifa_cacheinfo
.TP
-.BR RTM_NEWROUTE ", " RTM_DELROUTE ", " RTM_GETROUTE
+.B RTM_NEWROUTE
+.TQ
+.B RTM_DELROUTE
+.TQ
+.B RTM_GETROUTE
Create, remove, or receive information about a network route.
These messages contain an
.I rtmsg
@@ -242,7 +254,7 @@ RTPROT_KERNEL:by the kernel
RTPROT_BOOT:during boot
RTPROT_STATIC:by the administrator
.TE
-.sp 1
+.IP
Values larger than
.B RTPROT_STATIC
are not interpreted by the kernel, they are just for user information.
@@ -265,7 +277,7 @@ RT_SCOPE_LINK:route on this link
RT_SCOPE_HOST:route on the local host
RT_SCOPE_NOWHERE:destination doesn't exist
.TE
-.sp 1
+.IP
The values between
.B RT_SCOPE_UNIVERSE
and
@@ -284,7 +296,7 @@ T}
RTM_F_CLONED:route is cloned from another route
RTM_F_EQUALIZE:a multipath equalizer (not yet implemented)
.TE
-.sp 1
+.IP
.I rtm_table
specifies the routing table
.TS
@@ -295,7 +307,7 @@ RT_TABLE_DEFAULT:the default table
RT_TABLE_MAIN:the main table
RT_TABLE_LOCAL:the local table
.TE
-.sp 1
+.IP
The user may assign arbitrary values between
.B RT_TABLE_UNSPEC
and
@@ -423,7 +435,11 @@ defined in
.IP
.B Fill these values in!
.TP
-.BR RTM_NEWNEIGH ", " RTM_DELNEIGH ", " RTM_GETNEIGH
+.B RTM_NEWNEIGH
+.TQ
+.B RTM_DELNEIGH
+.TQ
+.B RTM_GETNEIGH
Add, remove, or receive information about a neighbor table
entry (e.g., an ARP entry).
The message contains an
@@ -461,7 +477,7 @@ NUD_FAILED:an invalid cache entry
NUD_NOARP:a device with no destination cache
NUD_PERMANENT:a static entry
.TE
-.sp 1
+.IP
Valid
.I ndm_flags
are:
@@ -471,7 +487,7 @@ lb l.
NTF_PROXY:a proxy arp entry
NTF_ROUTER:an IPv6 router
.TE
-.sp 1
+.IP
.\" FIXME .
.\" document the members of the struct better
The
@@ -487,7 +503,7 @@ NDA_DST:a neighbor cache n/w layer destination address
NDA_LLADDR:a neighbor cache link layer address
NDA_CACHEINFO:cache statistics
.TE
-.sp 1
+.IP
If the
.I rta_type
field is
@@ -496,12 +512,20 @@ then a
.I struct nda_cacheinfo
header follows.
.TP
-.BR RTM_NEWRULE ", " RTM_DELRULE ", " RTM_GETRULE
+.B RTM_NEWRULE
+.TQ
+.B RTM_DELRULE
+.TQ
+.B RTM_GETRULE
Add, delete, or retrieve a routing rule.
Carries a
.I struct rtmsg
.TP
-.BR RTM_NEWQDISC ", " RTM_DELQDISC ", " RTM_GETQDISC
+.B RTM_NEWQDISC
+.TQ
+.B RTM_DELQDISC
+.TQ
+.B RTM_GETQDISC
Add, remove, or get a queueing discipline.
The message contains a
.I struct tcmsg
@@ -531,17 +555,25 @@ TCA_STATS:struct tc_stats:Qdisc statistics
TCA_XSTATS:qdisc-specific:Module-specific statistics
TCA_RATE:struct tc_estimator:Rate limit
.TE
-.sp 1
+.IP
In addition, various other qdisc-module-specific attributes are allowed.
For more information see the appropriate include files.
.TP
-.BR RTM_NEWTCLASS ", " RTM_DELTCLASS ", " RTM_GETTCLASS
+.B RTM_NEWTCLASS
+.TQ
+.B RTM_DELTCLASS
+.TQ
+.B RTM_GETTCLASS
Add, remove, or get a traffic class.
These messages contain a
.I struct tcmsg
as described above.
.TP
-.BR RTM_NEWTFILTER ", " RTM_DELTFILTER ", " RTM_GETTFILTER
+.B RTM_NEWTFILTER
+.TQ
+.B RTM_DELTFILTER
+.TQ
+.B RTM_GETTFILTER
Add, remove, or receive information about a traffic filter.
These messages contain a
.I struct tcmsg