source: networking/netlibs/libnl.xml@ 544688d

10.0 10.1 11.0 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 544688d was 544688d, checked in by Xi Ruoyao <xry111@…>, 16 months ago

libnl: test currently broken

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@23464 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 11.3 KB
Line 
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
7 <!ENTITY libnl-download-http "https://github.com/thom311/libnl/releases/download/libnl&libnl-dl-version;/libnl-&libnl-version;.tar.gz">
8 <!ENTITY libnl-download-ftp " ">
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)">
13
14
15 <!ENTITY libnl-doc-download-http "https://github.com/thom311/libnl/releases/download/libnl&libnl-dl-version;/libnl-doc-&libnl-version;.tar.gz">
16 <!ENTITY libnl-doc-download-ftp " ">
17 <!ENTITY libnl-doc-md5sum "43a1a6f0c39f32bee05287c06c500bce">
18 <!ENTITY libnl-doc-size "11 MB">
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
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>
42
43 &lfs91_checked;
44
45 <bridgehead renderas="sect3">Package Information</bridgehead>
46 <itemizedlist spacing="compact">
47 <listitem>
48 <para>
49 Download (HTTP): <ulink url="&libnl-download-http;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download (FTP): <ulink url="&libnl-download-ftp;"/>
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download MD5 sum: &libnl-md5sum;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Download size: &libnl-size;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated disk space required: &libnl-buildsize;
70 </para>
71 </listitem>
72 <listitem>
73 <para>
74 Estimated build time: &libnl-time;
75 </para>
76 </listitem>
77 </itemizedlist>
78
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>
102
103 <para condition="html" role="usernotes">User Notes:
104 <ulink url="&blfs-wiki;/libnl"/>
105 </para>
106 </sect2>
107
108 <sect2 role="installation">
109 <title>Installation of libnl</title>
110
111 <para>
112 Install <application>libnl</application> by running the following
113 commands:
114 </para>
115
116<screen><userinput>./configure --prefix=/usr \
117 --sysconfdir=/etc \
118 --disable-static &amp;&amp;
119make</userinput></screen>
120
121 <para>
122 <!-- To test the results, issue: <command>make check</command>. -->
123 <!-- currently broken by check-0.15.1 -->
124 This package does not have a working test suite.
125 </para>
126
127 <para>
128 Now, as the <systemitem class="username">root</systemitem> user:
129 </para>
130
131<screen role="root"><userinput>make install</userinput></screen>
132
133 <para>
134 If you wish to install the API documentation, as the
135 <systemitem class="username">root</systemitem> user:
136 </para>
137
138<screen role="root"><userinput>mkdir -vp /usr/share/doc/libnl-&libnl-version; &amp;&amp;
139tar -xf ../libnl-doc-&libnl-version;.tar.gz --strip-components=1 --no-same-owner \
140 -C /usr/share/doc/libnl-&libnl-version;</userinput></screen>
141
142 </sect2>
143
144 <sect2 role="commands">
145 <title>Command Explanations</title>
146
147 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
148 href="../../xincludes/static-libraries.xml"/>
149
150 <para>
151 <option>--disable-cli</option>: Use this parameter if you
152 don't want to install cli tools provided by the package.
153 </para>
154
155 </sect2>
156
157 <sect2 role="content">
158 <title>Contents</title>
159
160 <segmentedlist>
161 <segtitle>Installed Programs</segtitle>
162 <segtitle>Installed Libraries</segtitle>
163 <segtitle>Installed Directories</segtitle>
164
165 <seglistitem>
166 <seg>
167 genl-ctrl-list,
168 idiag-socket-details,
169 nl-class-add,
170 nl-class-delete,
171 nl-classid-lookup,
172 nl-class-list,
173 nl-cls-add,
174 nl-cls-delete,
175 nl-cls-list,
176 nl-link-list,
177 nl-pktloc-lookup,
178 nl-qdisc-add,
179 nl-qdisc-delete,
180 nl-qdisc-list, and 48 other helper programs with nl- and nf- prefixes
181 </seg>
182 <seg>
183 libnl-3.so,
184 libnl-cli-3.so,
185 libnl-genl-3.so,
186 libnl-idiag-3.so,
187 libnl-nf-3.so,
188 libnl-route-3.so,
189 libnl-xfrm-3.so, and
190 cli modules under /usr/lib/libnl/cli tree
191 </seg>
192 <seg>
193 /etc/libnl,
194 /usr/include/libnl3,
195 /usr/lib/libnl, and
196 /usr/share/doc/libnl-&libnl-version;
197 </seg>
198 </seglistitem>
199 </segmentedlist>
200
201 <variablelist>
202 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
203 <?dbfo list-presentation="list"?>
204 <?dbhtml list-presentation="table"?>
205
206 <varlistentry id="genl-ctrl-list">
207 <term><command>genl-ctrl-list</command></term>
208 <listitem>
209 <para>
210 queries the Generic Netlink controller in the kernel and prints
211 a list of all registered Generic Netlink families including
212 the version of the interface that has been registered.
213 </para>
214 <indexterm zone="libnl genl-ctrl-list">
215 <primary sortas="b-genl-ctrl-list">genl-ctrl-list</primary>
216 </indexterm>
217 </listitem>
218 </varlistentry>
219
220 <varlistentry id="nl-class-add">
221 <term><command>nl-class-add</command></term>
222 <listitem>
223 <para>
224 adds, updates, or replaces Traffic Classes
225 </para>
226 <indexterm zone="libnl nl-class-add">
227 <primary sortas="b-nl-class-add">nl-class-add</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 <varlistentry id="nl-class-delete">
233 <term><command>nl-class-delete</command></term>
234 <listitem>
235 <para>
236 deletes Traffic Classes
237 </para>
238 <indexterm zone="libnl nl-class-delete">
239 <primary sortas="b-nl-class-delete">nl-class-delete</primary>
240 </indexterm>
241 </listitem>
242 </varlistentry>
243
244 <varlistentry id="nl-classid-lookup">
245 <term><command>nl-classid-lookup</command></term>
246 <listitem>
247 <para>
248 is used to resolve qdisc/class names to classid values and vice
249 versa.
250 </para>
251 <indexterm zone="libnl nl-classid-lookup">
252 <primary sortas="b-nl-classid-lookup">nl-classid-lookup</primary>
253 </indexterm>
254 </listitem>
255 </varlistentry>
256
257 <varlistentry id="nl-class-list">
258 <term><command>nl-class-list</command></term>
259 <listitem>
260 <para>
261 lists Traffic Classes.
262 </para>
263 <indexterm zone="libnl nl-class-list">
264 <primary sortas="b-nl-class-list">nl-class-list</primary>
265 </indexterm>
266 </listitem>
267 </varlistentry>
268
269 <varlistentry id="nl-cls-add">
270 <term><command>nl-cls-add</command></term>
271 <listitem>
272 <para>
273 adds a classifier.
274 </para>
275 <indexterm zone="libnl nl-cls-add">
276 <primary sortas="b-nl-cls-add">nl-cls-add</primary>
277 </indexterm>
278 </listitem>
279 </varlistentry>
280
281 <varlistentry id="nl-cls-delete">
282 <term><command>nl-cls-delete</command></term>
283 <listitem>
284 <para>
285 deletes a classifier.
286 </para>
287 <indexterm zone="libnl nl-cls-delete">
288 <primary sortas="b-nl-cls-delete">nl-cls-delete</primary>
289 </indexterm>
290 </listitem>
291 </varlistentry>
292
293 <varlistentry id="nl-cls-list">
294 <term><command>nl-cls-list</command></term>
295 <listitem>
296 <para>
297 lists classifiers.
298 </para>
299 <indexterm zone="libnl nl-cls-list">
300 <primary sortas="b-nl-cls-list">nl-cls-list</primary>
301 </indexterm>
302 </listitem>
303 </varlistentry>
304
305 <varlistentry id="nl-link-list">
306 <term><command>nl-link-list</command></term>
307 <listitem>
308 <para>
309 dumps link attributes.
310 </para>
311 <indexterm zone="libnl nl-link-list">
312 <primary sortas="b-nl-link-list">nl-link-list</primary>
313 </indexterm>
314 </listitem>
315 </varlistentry>
316
317 <varlistentry id="nl-pktloc-lookup">
318 <term><command>nl-pktloc-lookup</command></term>
319 <listitem>
320 <para>
321 allows the lookup of packet location definitions.
322 </para>
323 <indexterm zone="libnl nl-pktloc-lookup">
324 <primary sortas="b-nl-pktloc-lookup">nl-pktloc-lookup</primary>
325 </indexterm>
326 </listitem>
327 </varlistentry>
328
329 <varlistentry id="nl-qdisc-add">
330 <term><command>nl-qdisc-add</command></term>
331 <listitem>
332 <para>
333 adds queueing disciplines (qdiscs) in the kernel.
334 </para>
335 <indexterm zone="libnl nl-qdisc-add">
336 <primary sortas="b-nl-qdisc-add">nl-qdisc-add</primary>
337 </indexterm>
338 </listitem>
339 </varlistentry>
340
341 <varlistentry id="nl-qdisc-delete">
342 <term><command>nl-qdisc-delete</command></term>
343 <listitem>
344 <para>
345 deletes queueing disciplines (qdiscs) in the kernel.
346 </para>
347 <indexterm zone="libnl nl-qdisc-delete">
348 <primary sortas="b-nl-qdisc-delete">nl-qdisc-delete</primary>
349 </indexterm>
350 </listitem>
351 </varlistentry>
352
353 <varlistentry id="nl-qdisc-list">
354 <term><command>nl-qdisc-list</command></term>
355 <listitem>
356 <para>
357 lists queueing disciplines (qdiscs) in the kernel.
358 </para>
359 <indexterm zone="libnl nl-qdisc-list">
360 <primary sortas="b-nl-qdisc-list">nl-qdisc-list</primary>
361 </indexterm>
362 </listitem>
363 </varlistentry>
364
365 <varlistentry id="libnl-lib">
366 <term><filename class="libraryfile">libnl*-3.so</filename></term>
367 <listitem>
368 <para>
369 These libraries contain API functions used to access Netlink
370 interfaces in Linux kernel.
371 </para>
372 <indexterm zone="libnl libnl-lib">
373 <primary sortas="c-libnl">libnl*-3.so</primary>
374 </indexterm>
375 </listitem>
376 </varlistentry>
377
378 </variablelist>
379
380 </sect2>
381
382</sect1>
Note: See TracBrowser for help on using the repository browser.