source: networking/netlibs/libnl.xml@ 6397333

basic
Last change on this file since 6397333 was 6397333, checked in by Bruce Dubbs <bdubbs@…>, 6 years ago

Convert internal like to external links for BLFS packages not in
the Basic book.

Reorder some chapters.

Merge System V and systemd sections so both are always displayed
with proper attribution for system type.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/basic@20524 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 11.1 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 "8f71910c03db363b41e2ea62057a4311">
10 <!ENTITY libnl-size "912 KB">
11 <!ENTITY libnl-buildsize "29 MB (with tests and API documentation)">
12 <!ENTITY libnl-time "0.4 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 "2255846ccf58875529f84898df325dea">
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 &lfs83_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 </para>
124
125 <para>
126 Now, as the <systemitem class="username">root</systemitem> user:
127 </para>
128
129<screen role="root"><userinput>make install</userinput></screen>
130
131 <para>
132 If you wish to install the API documentation, as the
133 <systemitem class="username">root</systemitem> user:
134 </para>
135
136<screen role="root"><userinput>mkdir -vp /usr/share/doc/libnl-&libnl-version; &amp;&amp;
137tar -xf ../libnl-doc-&libnl-version;.tar.gz --strip-components=1 --no-same-owner \
138 -C /usr/share/doc/libnl-&libnl-version;</userinput></screen>
139
140 </sect2>
141
142 <sect2 role="commands">
143 <title>Command Explanations</title>
144
145 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
146 href="../../xincludes/static-libraries.xml"/>
147
148 <para>
149 <option>--disable-cli</option>: Use this parameter if you
150 don't want to install cli tools provided by the package.
151 </para>
152
153 </sect2>
154
155 <sect2 role="content">
156 <title>Contents</title>
157
158 <segmentedlist>
159 <segtitle>Installed Programs</segtitle>
160 <segtitle>Installed Libraries</segtitle>
161 <segtitle>Installed Directories</segtitle>
162
163 <seglistitem>
164 <seg>
165 genl-ctrl-list,
166 idiag-socket-details,
167 nl-class-add,
168 nl-class-delete,
169 nl-classid-lookup,
170 nl-class-list,
171 nl-cls-add,
172 nl-cls-delete,
173 nl-cls-list,
174 nl-link-list,
175 nl-pktloc-lookup,
176 nl-qdisc-add,
177 nl-qdisc-delete,
178 nl-qdisc-list, and 32 other helper programs with nl- and nf- prefixes
179 </seg>
180 <seg>
181 libnl-3.so,
182 libnl-cli-3.so,
183 libnl-genl-3.so,
184 libnl-idiag-3.so,
185 libnl-nf-3.so,
186 libnl-route-3.so,
187 libnl-xfrm-3.so, and
188 cli modules under /usr/lib/libnl/cli tree
189 </seg>
190 <seg>
191 /etc/libnl,
192 /usr/include/libnl3,
193 /usr/lib/libnl, and
194 /usr/share/doc/libnl-&libnl-version;
195 </seg>
196 </seglistitem>
197 </segmentedlist>
198
199 <variablelist>
200 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
201 <?dbfo list-presentation="list"?>
202 <?dbhtml list-presentation="table"?>
203
204 <varlistentry id="genl-ctrl-list">
205 <term><command>genl-ctrl-list</command></term>
206 <listitem>
207 <para>
208 queries the Generic Netlink controller in the kernel and prints
209 a list of all registered Generic Netlink families including
210 the version of the interface that has been registered.
211 </para>
212 <indexterm zone="libnl genl-ctrl-list">
213 <primary sortas="b-genl-ctrl-list">genl-ctrl-list</primary>
214 </indexterm>
215 </listitem>
216 </varlistentry>
217
218 <varlistentry id="nl-class-add">
219 <term><command>nl-class-add</command></term>
220 <listitem>
221 <para>
222 adds, updates, or replaces Traffic Classes
223 </para>
224 <indexterm zone="libnl nl-class-add">
225 <primary sortas="b-nl-class-add">nl-class-add</primary>
226 </indexterm>
227 </listitem>
228 </varlistentry>
229
230 <varlistentry id="nl-class-delete">
231 <term><command>nl-class-delete</command></term>
232 <listitem>
233 <para>
234 deletes Traffic Classes
235 </para>
236 <indexterm zone="libnl nl-class-delete">
237 <primary sortas="b-nl-class-delete">nl-class-delete</primary>
238 </indexterm>
239 </listitem>
240 </varlistentry>
241
242 <varlistentry id="nl-classid-lookup">
243 <term><command>nl-classid-lookup</command></term>
244 <listitem>
245 <para>
246 is used to resolve qdisc/class names to classid values and vice
247 versa.
248 </para>
249 <indexterm zone="libnl nl-classid-lookup">
250 <primary sortas="b-nl-classid-lookup">nl-classid-lookup</primary>
251 </indexterm>
252 </listitem>
253 </varlistentry>
254
255 <varlistentry id="nl-class-list">
256 <term><command>nl-class-list</command></term>
257 <listitem>
258 <para>
259 lists Traffic Classes.
260 </para>
261 <indexterm zone="libnl nl-class-list">
262 <primary sortas="b-nl-class-list">nl-class-list</primary>
263 </indexterm>
264 </listitem>
265 </varlistentry>
266
267 <varlistentry id="nl-cls-add">
268 <term><command>nl-cls-add</command></term>
269 <listitem>
270 <para>
271 adds a classifier.
272 </para>
273 <indexterm zone="libnl nl-cls-add">
274 <primary sortas="b-nl-cls-add">nl-cls-add</primary>
275 </indexterm>
276 </listitem>
277 </varlistentry>
278
279 <varlistentry id="nl-cls-delete">
280 <term><command>nl-cls-delete</command></term>
281 <listitem>
282 <para>
283 deletes a classifier.
284 </para>
285 <indexterm zone="libnl nl-cls-delete">
286 <primary sortas="b-nl-cls-delete">nl-cls-delete</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 <varlistentry id="nl-cls-list">
292 <term><command>nl-cls-list</command></term>
293 <listitem>
294 <para>
295 lists classifiers.
296 </para>
297 <indexterm zone="libnl nl-cls-list">
298 <primary sortas="b-nl-cls-list">nl-cls-list</primary>
299 </indexterm>
300 </listitem>
301 </varlistentry>
302
303 <varlistentry id="nl-link-list">
304 <term><command>nl-link-list</command></term>
305 <listitem>
306 <para>
307 dumps link attributes.
308 </para>
309 <indexterm zone="libnl nl-link-list">
310 <primary sortas="b-nl-link-list">nl-link-list</primary>
311 </indexterm>
312 </listitem>
313 </varlistentry>
314
315 <varlistentry id="nl-pktloc-lookup">
316 <term><command>nl-pktloc-lookup</command></term>
317 <listitem>
318 <para>
319 allows the lookup of packet location definitions.
320 </para>
321 <indexterm zone="libnl nl-pktloc-lookup">
322 <primary sortas="b-nl-pktloc-lookup">nl-pktloc-lookup</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 <varlistentry id="nl-qdisc-add">
328 <term><command>nl-qdisc-add</command></term>
329 <listitem>
330 <para>
331 adds queueing disciplines (qdiscs) in the kernel.
332 </para>
333 <indexterm zone="libnl nl-qdisc-add">
334 <primary sortas="b-nl-qdisc-add">nl-qdisc-add</primary>
335 </indexterm>
336 </listitem>
337 </varlistentry>
338
339 <varlistentry id="nl-qdisc-delete">
340 <term><command>nl-qdisc-delete</command></term>
341 <listitem>
342 <para>
343 deletes queueing disciplines (qdiscs) in the kernel.
344 </para>
345 <indexterm zone="libnl nl-qdisc-delete">
346 <primary sortas="b-nl-qdisc-delete">nl-qdisc-delete</primary>
347 </indexterm>
348 </listitem>
349 </varlistentry>
350
351 <varlistentry id="nl-qdisc-list">
352 <term><command>nl-qdisc-list</command></term>
353 <listitem>
354 <para>
355 lists queueing disciplines (qdiscs) in the kernel.
356 </para>
357 <indexterm zone="libnl nl-qdisc-list">
358 <primary sortas="b-nl-qdisc-list">nl-qdisc-list</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 <varlistentry id="libnl-lib">
364 <term><filename class="libraryfile">libnl*-3.so</filename></term>
365 <listitem>
366 <para>
367 These libraries contain API functions used to access Netlink
368 interfaces in Linux kernel.
369 </para>
370 <indexterm zone="libnl libnl-lib">
371 <primary sortas="c-libnl">libnl*-3.so</primary>
372 </indexterm>
373 </listitem>
374 </varlistentry>
375
376 </variablelist>
377
378 </sect2>
379
380</sect1>
Note: See TracBrowser for help on using the repository browser.