source: networking/netutils/avahi.xml@ 2aa0f3b

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 2aa0f3b was 7c56ece, checked in by Pierre Labastie <pieere@…>, 4 years ago

Finish formatting "networking"

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@22877 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 22.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 avahi-download-http "https://github.com/lathiat/avahi/releases/download/v&avahi-version;/avahi-&avahi-version;.tar.gz">
8 <!ENTITY avahi-download-ftp " ">
9 <!ENTITY avahi-md5sum "229c6aa30674fc43c202b22c5f8c2be7">
10 <!ENTITY avahi-size "1.5 MB">
11 <!ENTITY avahi-buildsize "32 MB">
12 <!ENTITY avahi-time "0.3 SBU">
13]>
14
15<sect1 id="avahi" xreflabel="Avahi-&avahi-version;">
16 <?dbhtml filename="avahi.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>Avahi-&avahi-version;</title>
24
25 <indexterm zone="avahi">
26 <primary sortas="a-Avahi">Avahi</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Avahi</title>
31
32 <para>
33 The <application>Avahi</application> package is a system which
34 facilitates service discovery on a local network.
35 </para>
36
37 &lfs91_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing="compact">
41 <listitem>
42 <para>
43 Download (HTTP): <ulink url="&avahi-download-http;"/>
44 </para>
45 </listitem>
46 <listitem>
47 <para>
48 Download (FTP): <ulink url="&avahi-download-ftp;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download MD5 sum: &avahi-md5sum;
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download size: &avahi-size;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Estimated disk space required: &avahi-buildsize;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated build time: &avahi-time;
69 </para>
70 </listitem>
71 </itemizedlist>
72
73 <bridgehead renderas="sect3">Avahi Dependencies</bridgehead>
74
75 <bridgehead renderas="sect4">Required</bridgehead>
76 <para role="required">
77 <xref linkend="glib2"/>
78 </para>
79
80 <bridgehead renderas="sect4">Recommended</bridgehead>
81 <para role="recommended">
82 <xref linkend="gobject-introspection"/>,
83 <xref linkend="gtk2"/>,
84 <xref linkend="gtk3"/>,
85 <xref linkend="libdaemon"/>,
86 <xref linkend="libglade"/>, and
87 <xref linkend="qt5"/>
88 </para>
89
90 <bridgehead renderas="sect4">Optional</bridgehead>
91 <para role="optional">
92 <xref linkend="dbus-python"/>,
93 <xref linkend="libevent"/>,
94 <xref linkend="pygtk"/>,
95 <xref linkend="doxygen"/> and
96 <ulink url="https://sourceforge.net/projects/xmltoman/">xmltoman</ulink>
97 (for generating documentation)
98 </para>
99
100 <para condition="html" role="usernotes">User Notes:
101 <ulink url="&blfs-wiki;/avahi"/>
102 </para>
103 </sect2>
104
105 <sect2 role="installation">
106 <title>Installation of Avahi</title>
107
108 <para>
109 There should be a dedicated user and group to take control
110 of the <command>avahi-daemon</command> daemon after it is
111 started. Issue the following commands as the
112 <systemitem class="username">root</systemitem> user:
113 </para>
114
115<screen role="root"><userinput>groupadd -fg 84 avahi &amp;&amp;
116useradd -c "Avahi Daemon Owner" -d /var/run/avahi-daemon -u 84 \
117 -g avahi -s /bin/false avahi</userinput></screen>
118
119 <para>
120 There should also be a dedicated priviliged access group for
121 <application>Avahi</application> clients. Issue the following command as
122 the <systemitem class="username">root</systemitem> user:
123 </para>
124
125<screen role="root"><userinput>groupadd -fg 86 netdev</userinput></screen>
126
127 <para>
128 Install <application>Avahi</application> by running the following
129 commands:
130 </para>
131
132<screen revision="sysv"><userinput>./configure --prefix=/usr \
133 --sysconfdir=/etc \
134 --localstatedir=/var \
135 --disable-static \
136 --disable-libevent \
137 --disable-mono \
138 --disable-monodoc \
139 --disable-python \
140 --disable-qt3 \
141 --disable-qt4 \
142 --enable-core-docs \
143 --with-distro=none \
144 --with-systemdsystemunitdir=no &amp;&amp;
145make</userinput></screen>
146
147<screen revision="systemd"><userinput>./configure --prefix=/usr \
148 --sysconfdir=/etc \
149 --localstatedir=/var \
150 --disable-static \
151 --disable-libevent \
152 --disable-mono \
153 --disable-monodoc \
154 --disable-python \
155 --disable-qt3 \
156 --disable-qt4 \
157 --enable-core-docs \
158 --with-distro=none \
159 --with-systemdsystemunitdir=/lib/systemd/system &amp;&amp;
160make</userinput></screen>
161
162 <para>
163 This package does not come with a test suite.
164 </para>
165
166 <para>
167 Now, as the <systemitem class="username">root</systemitem> user:
168 </para>
169
170<screen role="root"><userinput>make install</userinput></screen>
171
172 </sect2>
173
174 <sect2 role="commands">
175 <title>Command Explanations</title>
176
177 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
178 href="../../xincludes/static-libraries.xml"/>
179
180 <para>
181 <parameter>--disable-libevent</parameter>: This parameter disables the
182 use of <xref linkend="libevent"/>. Remove if you have it installed.
183 </para>
184
185 <para>
186 <parameter>--disable-mono</parameter>: This parameter disables the
187 <application>Mono</application> bindings.
188 </para>
189
190 <para>
191 <parameter>--disable-monodoc</parameter>: This parameter disables
192 documentation for the <application>Mono</application> bindings.
193 </para>
194
195 <para>
196 <parameter>--disable-python</parameter>: This parameter disables the
197 scripts that depend on <application>Python</application>. It also
198 allows a regular install to complete successfully.
199 </para>
200
201 <para>
202 <parameter>--disable-qt3</parameter>: This parameter disables the
203 attempt to build the obsolete <application>Qt3</application>
204 portions of the package.
205 </para>
206
207 <para>
208 <parameter>--disable-qt4</parameter>: This parameter disables the
209 attempt to build the obsolete <application>Qt4Core</application>
210 portions of the package.
211 </para>
212
213 <para>
214 <parameter>--enable-core-docs</parameter>: This parameter enables the
215 building of documentation.
216 </para>
217
218 <para>
219 <parameter>--with-distro=none</parameter>: There is an obsolete
220 boot script in the distribution for LFS. This option disables it.
221 </para>
222
223 <para revision="sysv">
224 <parameter>--with-systemdsystemunitdir=no</parameter>: Without it, the
225 daemon fails to start in BLFS, which does not support
226 <application>systemd</application>.
227 </para>
228
229 <para revision="systemd">
230 <parameter>--with-systemdsystemunitdir=/lib/systemd/system</parameter>:
231 This parameter is used to set the correct installation directory for
232 systemd units.
233 </para>
234
235 <para>
236 <option>--disable-dbus</option>: This parameter disables the use
237 of <application>D-Bus</application>.
238 </para>
239
240 <para>
241 <option>--disable-gtk</option>: This parameter disables the use
242 of <application>GTK+2</application>.
243 </para>
244
245 <para>
246 <option>--disable-gtk3</option>: This parameter disables the use
247 of <application>GTK+3</application>.
248 </para>
249
250 <para>
251 <option>--disable-libdaemon</option>: This parameter disables the use
252 of <application>libdaemon</application>. If you use this option,
253 <command>avahi-daemon</command> won't be built.
254 </para>
255
256 <para>
257 <option>--enable-tests</option>: This option enables the building of
258 tests and examples.
259 </para>
260
261 <para>
262 <option>--enable-compat-howl</option>: This option enables the
263 compatibility layer for <application>HOWL</application>.
264 </para>
265
266 <para>
267 <option>--enable-compat-libdns_sd</option>: This option enables the
268 compatibility layer for <application>libdns_sd</application>.
269 </para>
270
271 </sect2>
272
273 <sect2 role="configuration">
274 <title>Configuring avahi</title>
275
276 <sect3 id="avahi-init">
277 <title>Boot Script</title>
278
279 <para revision="sysv">
280 To automatically start the <command>avahi-daemon</command>
281 when the system is rebooted, install the
282 <filename>/etc/rc.d/init.d/avahi</filename> bootscript from
283 the <xref linkend="bootscripts"/> package.
284 </para>
285
286 <para revision="systemd">
287 To start the <command>avahi-daemon</command> daemon at boot, enable
288 the previously installed systemd unit by running the following command
289 as the <systemitem class="username">root</systemitem> user:
290 </para>
291
292 <indexterm zone="avahi avahi-init">
293 <primary sortas="f-avahi">avahi</primary>
294 </indexterm>
295
296<screen role="root" revision="sysv"><userinput>make install-avahi</userinput></screen>
297
298<screen role="root" revision="systemd"><userinput>systemctl enable avahi-daemon</userinput></screen>
299
300 <para revision="systemd">
301 To start the <command>avahi-dnsconfd</command> daemon at boot, enable
302 the previously installed systemd unit by running the following command
303 as the <systemitem class="username">root</systemitem> user:
304 </para>
305
306<screen role="root" revision="systemd"><userinput>systemctl enable avahi-dnsconfd</userinput></screen>
307
308 </sect3>
309
310 </sect2>
311
312 <sect2 role="content">
313 <title>Contents</title>
314
315 <segmentedlist>
316 <segtitle>Installed Programs</segtitle>
317 <segtitle>Installed Libraries</segtitle>
318 <segtitle>Installed Directories</segtitle>
319
320 <seglistitem>
321 <seg>avahi-autoipd, avahi-browse, avahi-browse-domains,
322 avahi-daemon, avahi-discover-standalone, avahi-dnsconfd,
323 avahi-publish, avahi-publish-address, avahi-publish-service,
324 avahi-resolve, avahi-resolve-address, avahi-resolve-host-name,
325 avahi-set-host-name, bshell, bssh, and bvnc</seg>
326 <seg>libavahi-client.so, libavahi-common.so, libavahi-core.so,
327 libavahi-glib.so, libavahi-gobject.so, libavahi-libevent.so
328 libavahi-ui-gtk3.so, libavahi-qt5, libavahi-ui.so, libdns_sd.so, and
329 libhowl.so,</seg>
330 <seg>/etc/avahi/services, /usr/include/{avahi-client,avahi-common,
331 avahi-compat-howl, avahi-compat-libdns_sd, avahi-core, avahi-glib,
332 avahi-gobject, avahi-libevent, avahi-qt5, avahi-ui},
333 /usr/lib/avahi, /usr/share/avahi</seg>
334 </seglistitem>
335 </segmentedlist>
336
337 <variablelist>
338 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
339 <?dbfo list-presentation="list"?>
340 <?dbhtml list-presentation="table"?>
341
342 <varlistentry id="avahi-autoipd">
343 <term><command>avahi-autoipd</command></term>
344 <listitem>
345 <para>
346 is a IPv4LL network address configuration daemon.
347 </para>
348 <indexterm zone="avahi avahi-autoipd">
349 <primary sortas="b-avahi-autoipd">avahi-autoipd</primary>
350 </indexterm>
351 </listitem>
352 </varlistentry>
353 <!--
354 <varlistentry id="avahi-bookmarks">
355 <term><command>avahi-bookmarks</command></term>
356 <listitem>
357 <para>
358 is a Web service showing mDNS/DNS-SD announced HTTP services
359 using the <application>Avahi</application> daemon.
360 </para>
361 <indexterm zone="avahi avahi-bookmarks">
362 <primary sortas="b-avahi-bookmarks">avahi-bookmarks</primary>
363 </indexterm>
364 </listitem>
365 </varlistentry>
366 -->
367 <varlistentry id="avahi-browse">
368 <term><command>avahi-browse</command></term>
369 <listitem>
370 <para>
371 browses for mDNS/DNS-SD services using the
372 <application>Avahi</application> daemon.
373 </para>
374 <indexterm zone="avahi avahi-browse">
375 <primary sortas="b-avahi-browse">avahi-browse</primary>
376 </indexterm>
377 </listitem>
378 </varlistentry>
379
380 <varlistentry id="avahi-browse-domains">
381 <term><command>avahi-browse-domains</command></term>
382 <listitem>
383 <para>
384 browses for mDNS/DNS-SD services using the
385 <application>Avahi</application> daemon.
386 </para>
387 <indexterm zone="avahi avahi-browse-domains">
388 <primary sortas="b-avahi-browse-domains">avahi-browse-domains</primary>
389 </indexterm>
390 </listitem>
391 </varlistentry>
392
393 <varlistentry id="avahi-daemon">
394 <term><command>avahi-daemon</command></term>
395 <listitem>
396 <para>
397 is the <application>Avahi</application> mDNS/DNS-SD daemon.
398 </para>
399 <indexterm zone="avahi avahi-daemon">
400 <primary sortas="b-avahi-daemon">avahi-daemon</primary>
401 </indexterm>
402 </listitem>
403 </varlistentry>
404 <!--
405 <varlistentry id="avahi-discover">
406 <term><command>avahi-discover</command></term>
407 <listitem>
408 <para>
409 browses for mDNS/DNS-SD services using the
410 <application>Avahi</application> daemon.
411 </para>
412 <indexterm zone="avahi avahi-discover">
413 <primary sortas="b-avahi-discover">avahi-discover</primary>
414 </indexterm>
415 </listitem>
416 </varlistentry>
417 -->
418 <varlistentry id="avahi-discover-standalone">
419 <term><command>avahi-discover-standalone</command></term>
420 <listitem>
421 <para>
422 browses for mDNS/DNS-SD services using the
423 <application>Avahi</application> daemon.
424 </para>
425 <indexterm zone="avahi avahi-discover-standalone">
426 <primary sortas="b-avahi-discover-standalone">avahi-discover-standalone</primary>
427 </indexterm>
428 </listitem>
429 </varlistentry>
430
431 <varlistentry id="avahi-dnsconfd">
432 <term><command>avahi-dnsconfd</command></term>
433 <listitem>
434 <para>
435 is a Unicast DNS server from mDNS/DNS-SD configuration daemon.
436 </para>
437 <indexterm zone="avahi avahi-dnsconfd">
438 <primary sortas="b-avahi-dnsconfd">avahi-dnsconfd</primary>
439 </indexterm>
440 </listitem>
441 </varlistentry>
442
443 <varlistentry id="avahi-publish">
444 <term><command>avahi-publish</command></term>
445 <listitem>
446 <para>
447 registers a mDNS/DNS-SD service or host name or address mapping
448 using the <application>Avahi</application> daemon.
449 </para>
450 <indexterm zone="avahi avahi-publish">
451 <primary sortas="b-avahi-publish">avahi-publish</primary>
452 </indexterm>
453 </listitem>
454 </varlistentry>
455
456 <varlistentry id="avahi-publish-address">
457 <term><command>avahi-publish-address</command></term>
458 <listitem>
459 <para>
460 registers a mDNS/DNS-SD service or host name or address mapping
461 using the <application>Avahi</application> daemon.
462 </para>
463 <indexterm zone="avahi avahi-publish-address">
464 <primary sortas="b-avahi-publish-address">avahi-publish-address</primary>
465 </indexterm>
466 </listitem>
467 </varlistentry>
468
469 <varlistentry id="avahi-publish-service">
470 <term><command>avahi-publish-service</command></term>
471 <listitem>
472 <para>
473 registers a mDNS/DNS-SD service or host name or address mapping
474 using the <application>Avahi</application> daemon.
475 </para>
476 <indexterm zone="avahi avahi-publish-service">
477 <primary sortas="b-avahi-publish-service">avahi-publish-service</primary>
478 </indexterm>
479 </listitem>
480 </varlistentry>
481
482 <varlistentry id="avahi-resolve">
483 <term><command>avahi-resolve</command></term>
484 <listitem>
485 <para>
486 resolves one or more mDNS/DNS host name(s) to IP address(es)
487 (and vice versa) using the <application>Avahi</application>
488 daemon.
489 </para>
490 <indexterm zone="avahi avahi-resolve">
491 <primary sortas="b-avahi-resolve">avahi-resolve</primary>
492 </indexterm>
493 </listitem>
494 </varlistentry>
495
496 <varlistentry id="avahi-resolve-address">
497 <term><command>avahi-resolve-address</command></term>
498 <listitem>
499 <para>
500 resolves one or more mDNS/DNS host name(s) to IP address(es)
501 (and vice versa) using the <application>Avahi</application>
502 daemon.
503 </para>
504 <indexterm zone="avahi avahi-resolve-address">
505 <primary sortas="b-avahi-resolve-address">avahi-resolve-address</primary>
506 </indexterm>
507 </listitem>
508 </varlistentry>
509
510 <varlistentry id="avahi-resolve-host-name">
511 <term><command>avahi-resolve-host-name</command></term>
512 <listitem>
513 <para>
514 resolves one or more mDNS/DNS host name(s) to IP address(es)
515 (and vice versa) using the <application>Avahi</application>
516 daemon.
517 </para>
518 <indexterm zone="avahi avahi-resolve-host-name">
519 <primary sortas="b-avahi-resolve-host-name">avahi-resolve-host-name</primary>
520 </indexterm>
521 </listitem>
522 </varlistentry>
523
524 <varlistentry id="avahi-set-host-name">
525 <term><command>avahi-set-host-name</command></term>
526 <listitem>
527 <para>
528 changes the mDNS host name.
529 </para>
530 <indexterm zone="avahi avahi-set-host-name">
531 <primary sortas="b-avahi-set-host-name">avahi-set-host-name</primary>
532 </indexterm>
533 </listitem>
534 </varlistentry>
535
536 <!--<varlistentry id="bshell">
537 <term><command>bshell</command></term>
538 <listitem>
539 <para>
540 does this .....
541 </para>
542 <indexterm zone="avahi bshell">
543 <primary sortas="b-bshell">bshell</primary>
544 </indexterm>
545 </listitem>
546 </varlistentry>-->
547
548 <varlistentry id="bssh">
549 <term><command>bssh</command></term>
550 <listitem>
551 <para>
552 browses for SSH servers on the local network.
553 </para>
554 <indexterm zone="avahi bssh">
555 <primary sortas="b-bssh">bssh</primary>
556 </indexterm>
557 </listitem>
558 </varlistentry>
559
560 <varlistentry id="bvnc">
561 <term><command>bvnc</command></term>
562 <listitem>
563 <para>
564 browses for VNC servers on the local network.
565 </para>
566 <indexterm zone="avahi bvnc">
567 <primary sortas="b-bvnc">bvnc</primary>
568 </indexterm>
569 </listitem>
570 </varlistentry>
571
572 <!--<varlistentry id="libavahi-client">
573 <term><filename class='libraryfile'>libavahi-client.{so,a}</filename></term>
574 <listitem>
575 <para>
576 contains functions that .....
577 </para>
578 <indexterm zone="avahi libavahi-client">
579 <primary sortas="c-libavahi-client">libavahi-client.{so,a}</primary>
580 </indexterm>
581 </listitem>
582 </varlistentry>
583
584 <varlistentry id="libavahi-common">
585 <term><filename class='libraryfile'>libavahi-common.{so,a}</filename></term>
586 <listitem>
587 <para>
588 contains functions that .....
589 </para>
590 <indexterm zone="avahi libavahi-common">
591 <primary sortas="c-libavahi-common">libavahi-common.{so,a}</primary>
592 </indexterm>
593 </listitem>
594 </varlistentry>
595
596 <varlistentry id="libavahi-core">
597 <term><filename class='libraryfile'>libavahi-core.{so,a}</filename></term>
598 <listitem>
599 <para>
600 contains functions that .....
601 </para>
602 <indexterm zone="avahi libavahi-core">
603 <primary sortas="c-libavahi-core">libavahi-core.{so,a}</primary>
604 </indexterm>
605 </listitem>
606 </varlistentry>
607
608 <varlistentry id="libavahi-glib">
609 <term><filename class='libraryfile'>libavahi-glib.{so,a}</filename></term>
610 <listitem>
611 <para>
612 contains functions that .....
613 </para>
614 <indexterm zone="avahi libavahi-glib">
615 <primary sortas="c-libavahi-glib">libavahi-glib.{so,a}</primary>
616 </indexterm>
617 </listitem>
618 </varlistentry>
619
620 <varlistentry id="libavahi-gobject">
621 <term><filename class='libraryfile'>libavahi-gobject.{so,a}</filename></term>
622 <listitem>
623 <para>
624 contains functions that .....
625 </para>
626 <indexterm zone="avahi libavahi-gobject">
627 <primary sortas="c-libavahi-gobject">libavahi-gobject.{so,a}</primary>
628 </indexterm>
629 </listitem>
630 </varlistentry>
631
632 <varlistentry id="libavahi-ui-gtk3">
633 <term><filename class='libraryfile'>libavahi-ui-gtk3.{so,a}</filename></term>
634 <listitem>
635 <para>
636 contains functions that .....
637 </para>
638 <indexterm zone="avahi libavahi-ui-gtk3">
639 <primary sortas="c-libavahi-ui-gtk3">libavahi-ui-gtk3.{so,a}</primary>
640 </indexterm>
641 </listitem>
642 </varlistentry>
643
644 <varlistentry id="libavahi-ui">
645 <term><filename class='libraryfile'>libavahi-ui.{so,a}</filename></term>
646 <listitem>
647 <para>
648 contains functions that .....
649 </para>
650 <indexterm zone="avahi libavahi-ui">
651 <primary sortas="c-libavahi-ui">libavahi-ui.{so,a}</primary>
652 </indexterm>
653 </listitem>
654 </varlistentry>
655
656 <varlistentry id="libdns_sd">
657 <term><filename class='libraryfile'>libdns_sd.{so,a}</filename></term>
658 <listitem>
659 <para>
660 contains functions that .....
661 </para>
662 <indexterm zone="avahi libdns_sd">
663 <primary sortas="c-libdns_sd">libdns_sd.{so,a}</primary>
664 </indexterm>
665 </listitem>
666 </varlistentry>
667
668 <varlistentry id="libhowl">
669 <term><filename class='libraryfile'>libhowl.{so,a}</filename></term>
670 <listitem>
671 <para>
672 contains functions that .....
673 </para>
674 <indexterm zone="avahi libhowl">
675 <primary sortas="c-libhowl">libhowl.{so,a}</primary>
676 </indexterm>
677 </listitem>
678 </varlistentry>-->
679
680 </variablelist>
681
682 </sect2>
683
684</sect1>
Note: See TracBrowser for help on using the repository browser.