[3e39d34] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[8c19ac9] | 7 | <!ENTITY libnl-download-http "https://github.com/thom311/libnl/releases/download/libnl&libnl-dl-version;/libnl-&libnl-version;.tar.gz">
|
---|
[3e39d34] | 8 | <!ENTITY libnl-download-ftp " ">
|
---|
[a89a5a6] | 9 | <!ENTITY libnl-md5sum "74ba57b1b1d6f9f92268aa8141d8e8e4">
|
---|
| 10 | <!ENTITY libnl-size "948 KB">
|
---|
| 11 | <!ENTITY libnl-buildsize "78 MB (with tests and API documentation)">
|
---|
| 12 | <!ENTITY libnl-time "0.5 SBU (with tests and API documentation)">
|
---|
[fad8db2] | 13 |
|
---|
| 14 |
|
---|
[8c19ac9] | 15 | <!ENTITY libnl-doc-download-http "https://github.com/thom311/libnl/releases/download/libnl&libnl-dl-version;/libnl-doc-&libnl-version;.tar.gz">
|
---|
[fad8db2] | 16 | <!ENTITY libnl-doc-download-ftp " ">
|
---|
[a89a5a6] | 17 | <!ENTITY libnl-doc-md5sum "43a1a6f0c39f32bee05287c06c500bce">
|
---|
[3690841] | 18 | <!ENTITY libnl-doc-size "11 MB">
|
---|
[3e39d34] | 19 | ]>
|
---|
| 20 |
|
---|
| 21 | <sect1 id="libnl" xreflabel="libnl-&libnl-version;">
|
---|
| 22 | <?dbhtml filename="libnl.html"?>
|
---|
| 23 |
|
---|
| 24 | <sect1info>
|
---|
| 25 | <othername>$LastChangedBy$</othername>
|
---|
| 26 | <date>$Date$</date>
|
---|
| 27 | </sect1info>
|
---|
| 28 |
|
---|
| 29 | <title>libnl-&libnl-version;</title>
|
---|
| 30 |
|
---|
| 31 | <indexterm zone="libnl">
|
---|
| 32 | <primary sortas="a-libnl">libnl</primary>
|
---|
| 33 | </indexterm>
|
---|
| 34 |
|
---|
| 35 | <sect2 role="package">
|
---|
| 36 | <title>Introduction to libnl</title>
|
---|
| 37 |
|
---|
[c6ac193] | 38 | <para>
|
---|
| 39 | The <application>libnl</application> suite is a collection of libraries
|
---|
| 40 | providing APIs to netlink protocol based Linux kernel interfaces.
|
---|
| 41 | </para>
|
---|
[3e39d34] | 42 |
|
---|
[81f86f9e] | 43 | &lfs101_checked;
|
---|
[3e39d34] | 44 |
|
---|
| 45 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 46 | <itemizedlist spacing="compact">
|
---|
| 47 | <listitem>
|
---|
[c6ac193] | 48 | <para>
|
---|
| 49 | Download (HTTP): <ulink url="&libnl-download-http;"/>
|
---|
| 50 | </para>
|
---|
[3e39d34] | 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
[c6ac193] | 53 | <para>
|
---|
| 54 | Download (FTP): <ulink url="&libnl-download-ftp;"/>
|
---|
| 55 | </para>
|
---|
[3e39d34] | 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
[c6ac193] | 58 | <para>
|
---|
| 59 | Download MD5 sum: &libnl-md5sum;
|
---|
| 60 | </para>
|
---|
[3e39d34] | 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
[c6ac193] | 63 | <para>
|
---|
| 64 | Download size: &libnl-size;
|
---|
| 65 | </para>
|
---|
[3e39d34] | 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
[c6ac193] | 68 | <para>
|
---|
| 69 | Estimated disk space required: &libnl-buildsize;
|
---|
| 70 | </para>
|
---|
[3e39d34] | 71 | </listitem>
|
---|
| 72 | <listitem>
|
---|
[c6ac193] | 73 | <para>
|
---|
| 74 | Estimated build time: &libnl-time;
|
---|
| 75 | </para>
|
---|
[3e39d34] | 76 | </listitem>
|
---|
| 77 | </itemizedlist>
|
---|
| 78 |
|
---|
[fad8db2] | 79 | <bridgehead renderas="sect3">Optional Download</bridgehead>
|
---|
| 80 | <itemizedlist spacing="compact">
|
---|
| 81 | <listitem>
|
---|
| 82 | <para>
|
---|
| 83 | Download (HTTP): <ulink url="&libnl-doc-download-http;"/>
|
---|
| 84 | </para>
|
---|
| 85 | </listitem>
|
---|
| 86 | <listitem>
|
---|
| 87 | <para>
|
---|
| 88 | Download (FTP): <ulink url="&libnl-doc-download-ftp;"/>
|
---|
| 89 | </para>
|
---|
| 90 | </listitem>
|
---|
| 91 | <listitem>
|
---|
| 92 | <para>
|
---|
| 93 | Download MD5 sum: &libnl-doc-md5sum;
|
---|
| 94 | </para>
|
---|
| 95 | </listitem>
|
---|
| 96 | <listitem>
|
---|
| 97 | <para>
|
---|
| 98 | Download size: &libnl-doc-size;
|
---|
| 99 | </para>
|
---|
| 100 | </listitem>
|
---|
| 101 | </itemizedlist>
|
---|
[933d7c9] | 102 |
|
---|
[3e39d34] | 103 | <para condition="html" role="usernotes">User Notes:
|
---|
[c6ac193] | 104 | <ulink url="&blfs-wiki;/libnl"/>
|
---|
| 105 | </para>
|
---|
[3e39d34] | 106 | </sect2>
|
---|
| 107 |
|
---|
| 108 | <sect2 role="installation">
|
---|
| 109 | <title>Installation of libnl</title>
|
---|
| 110 |
|
---|
[c6ac193] | 111 | <para>
|
---|
| 112 | Install <application>libnl</application> by running the following
|
---|
| 113 | commands:
|
---|
| 114 | </para>
|
---|
[3e39d34] | 115 |
|
---|
[3e7d4c6] | 116 | <screen><userinput>./configure --prefix=/usr \
|
---|
[d61e48e3] | 117 | --sysconfdir=/etc \
|
---|
[fad8db2] | 118 | --disable-static &&
|
---|
[9c24d38] | 119 | make</userinput></screen>
|
---|
[3e39d34] | 120 |
|
---|
[c6ac193] | 121 | <para>
|
---|
[ccc69593] | 122 | To test the results, issue: <command>make check</command>.
|
---|
[544688d] | 123 | <!-- currently broken by check-0.15.1 -->
|
---|
[ccc69593] | 124 | <!--This package does not have a working test suite.
|
---|
| 125 | With check-0.15.2, things are working again. -->
|
---|
[c6ac193] | 126 | </para>
|
---|
[3e39d34] | 127 |
|
---|
[c6ac193] | 128 | <para>
|
---|
| 129 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 130 | </para>
|
---|
[3e39d34] | 131 |
|
---|
| 132 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 133 |
|
---|
[fad8db2] | 134 | <para>
|
---|
[5fa1961] | 135 | If you wish to install the API documentation, as the
|
---|
[fad8db2] | 136 | <systemitem class="username">root</systemitem> user:
|
---|
| 137 | </para>
|
---|
| 138 |
|
---|
| 139 | <screen role="root"><userinput>mkdir -vp /usr/share/doc/libnl-&libnl-version; &&
|
---|
[8f79ce13] | 140 | tar -xf ../libnl-doc-&libnl-version;.tar.gz --strip-components=1 --no-same-owner \
|
---|
[d915944] | 141 | -C /usr/share/doc/libnl-&libnl-version;</userinput></screen>
|
---|
[fad8db2] | 142 |
|
---|
[3e39d34] | 143 | </sect2>
|
---|
| 144 |
|
---|
| 145 | <sect2 role="commands">
|
---|
| 146 | <title>Command Explanations</title>
|
---|
| 147 |
|
---|
[c6ac193] | 148 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 149 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 150 |
|
---|
| 151 | <para>
|
---|
| 152 | <option>--disable-cli</option>: Use this parameter if you
|
---|
| 153 | don't want to install cli tools provided by the package.
|
---|
| 154 | </para>
|
---|
[3e39d34] | 155 |
|
---|
| 156 | </sect2>
|
---|
| 157 |
|
---|
| 158 | <sect2 role="content">
|
---|
| 159 | <title>Contents</title>
|
---|
| 160 |
|
---|
| 161 | <segmentedlist>
|
---|
| 162 | <segtitle>Installed Programs</segtitle>
|
---|
[d61e48e3] | 163 | <segtitle>Installed Libraries</segtitle>
|
---|
[3e39d34] | 164 | <segtitle>Installed Directories</segtitle>
|
---|
| 165 |
|
---|
| 166 | <seglistitem>
|
---|
[c6ac193] | 167 | <seg>
|
---|
[f3429309] | 168 | genl-ctrl-list,
|
---|
[d915944] | 169 | idiag-socket-details,
|
---|
[f3429309] | 170 | nl-class-add,
|
---|
| 171 | nl-class-delete,
|
---|
[d915944] | 172 | nl-classid-lookup,
|
---|
[f3429309] | 173 | nl-class-list,
|
---|
| 174 | nl-cls-add,
|
---|
| 175 | nl-cls-delete,
|
---|
| 176 | nl-cls-list,
|
---|
[d915944] | 177 | nl-link-list,
|
---|
[f3429309] | 178 | nl-pktloc-lookup,
|
---|
| 179 | nl-qdisc-add,
|
---|
[d915944] | 180 | nl-qdisc-delete,
|
---|
[a89a5a6] | 181 | nl-qdisc-list, and 48 other helper programs with nl- and nf- prefixes
|
---|
[c6ac193] | 182 | </seg>
|
---|
| 183 | <seg>
|
---|
[8b5b31b2] | 184 | libnl-3.so,
|
---|
| 185 | libnl-cli-3.so,
|
---|
[91b65df] | 186 | libnl-genl-3.so,
|
---|
[9304e0a] | 187 | libnl-idiag-3.so,
|
---|
[8b5b31b2] | 188 | libnl-nf-3.so,
|
---|
[f3429309] | 189 | libnl-route-3.so,
|
---|
[d915944] | 190 | libnl-xfrm-3.so, and
|
---|
[fad8db2] | 191 | cli modules under /usr/lib/libnl/cli tree
|
---|
[c6ac193] | 192 | </seg>
|
---|
[3e7d4c6] | 193 | <seg>
|
---|
[c6ac193] | 194 | /etc/libnl,
|
---|
[fad8db2] | 195 | /usr/include/libnl3,
|
---|
| 196 | /usr/lib/libnl, and
|
---|
| 197 | /usr/share/doc/libnl-&libnl-version;
|
---|
[c6ac193] | 198 | </seg>
|
---|
[3e39d34] | 199 | </seglistitem>
|
---|
| 200 | </segmentedlist>
|
---|
[c6ac193] | 201 |
|
---|
[3e39d34] | 202 | <variablelist>
|
---|
| 203 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 204 | <?dbfo list-presentation="list"?>
|
---|
| 205 | <?dbhtml list-presentation="table"?>
|
---|
| 206 |
|
---|
[6d772cc] | 207 | <varlistentry id="genl-ctrl-list">
|
---|
| 208 | <term><command>genl-ctrl-list</command></term>
|
---|
| 209 | <listitem>
|
---|
| 210 | <para>
|
---|
[bea508c] | 211 | queries the Generic Netlink controller in the kernel and prints
|
---|
[6d772cc] | 212 | a list of all registered Generic Netlink families including
|
---|
[4c24eb0a] | 213 | the version of the interface that has been registered
|
---|
[6d772cc] | 214 | </para>
|
---|
| 215 | <indexterm zone="libnl genl-ctrl-list">
|
---|
| 216 | <primary sortas="b-genl-ctrl-list">genl-ctrl-list</primary>
|
---|
| 217 | </indexterm>
|
---|
| 218 | </listitem>
|
---|
| 219 | </varlistentry>
|
---|
| 220 |
|
---|
| 221 | <varlistentry id="nl-class-add">
|
---|
| 222 | <term><command>nl-class-add</command></term>
|
---|
| 223 | <listitem>
|
---|
| 224 | <para>
|
---|
[bea508c] | 225 | adds, updates, or replaces Traffic Classes
|
---|
[6d772cc] | 226 | </para>
|
---|
| 227 | <indexterm zone="libnl nl-class-add">
|
---|
| 228 | <primary sortas="b-nl-class-add">nl-class-add</primary>
|
---|
| 229 | </indexterm>
|
---|
| 230 | </listitem>
|
---|
| 231 | </varlistentry>
|
---|
| 232 |
|
---|
| 233 | <varlistentry id="nl-class-delete">
|
---|
| 234 | <term><command>nl-class-delete</command></term>
|
---|
| 235 | <listitem>
|
---|
| 236 | <para>
|
---|
[bea508c] | 237 | deletes Traffic Classes
|
---|
[6d772cc] | 238 | </para>
|
---|
| 239 | <indexterm zone="libnl nl-class-delete">
|
---|
| 240 | <primary sortas="b-nl-class-delete">nl-class-delete</primary>
|
---|
| 241 | </indexterm>
|
---|
| 242 | </listitem>
|
---|
| 243 | </varlistentry>
|
---|
| 244 |
|
---|
| 245 | <varlistentry id="nl-classid-lookup">
|
---|
| 246 | <term><command>nl-classid-lookup</command></term>
|
---|
| 247 | <listitem>
|
---|
| 248 | <para>
|
---|
| 249 | is used to resolve qdisc/class names to classid values and vice
|
---|
[4c24eb0a] | 250 | versa
|
---|
[6d772cc] | 251 | </para>
|
---|
| 252 | <indexterm zone="libnl nl-classid-lookup">
|
---|
| 253 | <primary sortas="b-nl-classid-lookup">nl-classid-lookup</primary>
|
---|
| 254 | </indexterm>
|
---|
| 255 | </listitem>
|
---|
| 256 | </varlistentry>
|
---|
| 257 |
|
---|
| 258 | <varlistentry id="nl-class-list">
|
---|
| 259 | <term><command>nl-class-list</command></term>
|
---|
| 260 | <listitem>
|
---|
| 261 | <para>
|
---|
[4c24eb0a] | 262 | lists Traffic Classes
|
---|
[6d772cc] | 263 | </para>
|
---|
| 264 | <indexterm zone="libnl nl-class-list">
|
---|
| 265 | <primary sortas="b-nl-class-list">nl-class-list</primary>
|
---|
| 266 | </indexterm>
|
---|
| 267 | </listitem>
|
---|
| 268 | </varlistentry>
|
---|
| 269 |
|
---|
| 270 | <varlistentry id="nl-cls-add">
|
---|
| 271 | <term><command>nl-cls-add</command></term>
|
---|
| 272 | <listitem>
|
---|
| 273 | <para>
|
---|
[4c24eb0a] | 274 | adds a classifier
|
---|
[6d772cc] | 275 | </para>
|
---|
| 276 | <indexterm zone="libnl nl-cls-add">
|
---|
| 277 | <primary sortas="b-nl-cls-add">nl-cls-add</primary>
|
---|
| 278 | </indexterm>
|
---|
| 279 | </listitem>
|
---|
| 280 | </varlistentry>
|
---|
| 281 |
|
---|
| 282 | <varlistentry id="nl-cls-delete">
|
---|
| 283 | <term><command>nl-cls-delete</command></term>
|
---|
| 284 | <listitem>
|
---|
| 285 | <para>
|
---|
[4c24eb0a] | 286 | deletes a classifier
|
---|
[6d772cc] | 287 | </para>
|
---|
| 288 | <indexterm zone="libnl nl-cls-delete">
|
---|
| 289 | <primary sortas="b-nl-cls-delete">nl-cls-delete</primary>
|
---|
| 290 | </indexterm>
|
---|
| 291 | </listitem>
|
---|
| 292 | </varlistentry>
|
---|
| 293 |
|
---|
| 294 | <varlistentry id="nl-cls-list">
|
---|
| 295 | <term><command>nl-cls-list</command></term>
|
---|
| 296 | <listitem>
|
---|
| 297 | <para>
|
---|
[4c24eb0a] | 298 | lists classifiers
|
---|
[6d772cc] | 299 | </para>
|
---|
| 300 | <indexterm zone="libnl nl-cls-list">
|
---|
| 301 | <primary sortas="b-nl-cls-list">nl-cls-list</primary>
|
---|
| 302 | </indexterm>
|
---|
| 303 | </listitem>
|
---|
| 304 | </varlistentry>
|
---|
| 305 |
|
---|
| 306 | <varlistentry id="nl-link-list">
|
---|
| 307 | <term><command>nl-link-list</command></term>
|
---|
| 308 | <listitem>
|
---|
| 309 | <para>
|
---|
[4c24eb0a] | 310 | dumps link attributes
|
---|
[6d772cc] | 311 | </para>
|
---|
| 312 | <indexterm zone="libnl nl-link-list">
|
---|
| 313 | <primary sortas="b-nl-link-list">nl-link-list</primary>
|
---|
| 314 | </indexterm>
|
---|
| 315 | </listitem>
|
---|
| 316 | </varlistentry>
|
---|
| 317 |
|
---|
| 318 | <varlistentry id="nl-pktloc-lookup">
|
---|
| 319 | <term><command>nl-pktloc-lookup</command></term>
|
---|
| 320 | <listitem>
|
---|
| 321 | <para>
|
---|
[4c24eb0a] | 322 | allows the lookup of packet location definitions
|
---|
[6d772cc] | 323 | </para>
|
---|
| 324 | <indexterm zone="libnl nl-pktloc-lookup">
|
---|
| 325 | <primary sortas="b-nl-pktloc-lookup">nl-pktloc-lookup</primary>
|
---|
| 326 | </indexterm>
|
---|
| 327 | </listitem>
|
---|
| 328 | </varlistentry>
|
---|
| 329 |
|
---|
| 330 | <varlistentry id="nl-qdisc-add">
|
---|
| 331 | <term><command>nl-qdisc-add</command></term>
|
---|
| 332 | <listitem>
|
---|
| 333 | <para>
|
---|
[4c24eb0a] | 334 | adds queueing disciplines (qdiscs) in the kernel
|
---|
[6d772cc] | 335 | </para>
|
---|
| 336 | <indexterm zone="libnl nl-qdisc-add">
|
---|
| 337 | <primary sortas="b-nl-qdisc-add">nl-qdisc-add</primary>
|
---|
| 338 | </indexterm>
|
---|
| 339 | </listitem>
|
---|
| 340 | </varlistentry>
|
---|
| 341 |
|
---|
| 342 | <varlistentry id="nl-qdisc-delete">
|
---|
| 343 | <term><command>nl-qdisc-delete</command></term>
|
---|
| 344 | <listitem>
|
---|
| 345 | <para>
|
---|
[4c24eb0a] | 346 | deletes queueing disciplines (qdiscs) in the kernel
|
---|
[6d772cc] | 347 | </para>
|
---|
| 348 | <indexterm zone="libnl nl-qdisc-delete">
|
---|
| 349 | <primary sortas="b-nl-qdisc-delete">nl-qdisc-delete</primary>
|
---|
| 350 | </indexterm>
|
---|
| 351 | </listitem>
|
---|
| 352 | </varlistentry>
|
---|
| 353 |
|
---|
| 354 | <varlistentry id="nl-qdisc-list">
|
---|
| 355 | <term><command>nl-qdisc-list</command></term>
|
---|
| 356 | <listitem>
|
---|
| 357 | <para>
|
---|
[4c24eb0a] | 358 | lists queueing disciplines (qdiscs) in the kernel
|
---|
[6d772cc] | 359 | </para>
|
---|
| 360 | <indexterm zone="libnl nl-qdisc-list">
|
---|
| 361 | <primary sortas="b-nl-qdisc-list">nl-qdisc-list</primary>
|
---|
| 362 | </indexterm>
|
---|
| 363 | </listitem>
|
---|
| 364 | </varlistentry>
|
---|
| 365 |
|
---|
[3e39d34] | 366 | <varlistentry id="libnl-lib">
|
---|
[b7b6efc] | 367 | <term><filename class="libraryfile">libnl*-3.so</filename></term>
|
---|
[3e39d34] | 368 | <listitem>
|
---|
[c6ac193] | 369 | <para>
|
---|
| 370 | These libraries contain API functions used to access Netlink
|
---|
[4c24eb0a] | 371 | interfaces in Linux kernel
|
---|
[c6ac193] | 372 | </para>
|
---|
[3e39d34] | 373 | <indexterm zone="libnl libnl-lib">
|
---|
[c6ac193] | 374 | <primary sortas="c-libnl">libnl*-3.so</primary>
|
---|
[3e39d34] | 375 | </indexterm>
|
---|
| 376 | </listitem>
|
---|
| 377 | </varlistentry>
|
---|
| 378 |
|
---|
| 379 | </variablelist>
|
---|
[c6ac193] | 380 |
|
---|
[3e39d34] | 381 | </sect2>
|
---|
| 382 |
|
---|
| 383 | </sect1>
|
---|