source: networking/netutils/avahi.xml@ 9063b113

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 9063b113 was 9063b113, checked in by Pierre Labastie <pieere@…>, 4 years ago

avahi can be built without qt5: document the option for that

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

  • Property mode set to 100644
File size: 22.5 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-qt5</option>: This parameter disables the use
252 of <application>Qt-5</application>, and allows to build without it.
253 </para>
254
255 <para>
256 <option>--disable-libdaemon</option>: This parameter disables the use
257 of <application>libdaemon</application>. If you use this option,
258 <command>avahi-daemon</command> won't be built.
259 </para>
260
261 <para>
262 <option>--enable-tests</option>: This option enables the building of
263 tests and examples.
264 </para>
265
266 <para>
267 <option>--enable-compat-howl</option>: This option enables the
268 compatibility layer for <application>HOWL</application>.
269 </para>
270
271 <para>
272 <option>--enable-compat-libdns_sd</option>: This option enables the
273 compatibility layer for <application>libdns_sd</application>.
274 </para>
275
276 </sect2>
277
278 <sect2 role="configuration">
279 <title>Configuring avahi</title>
280
281 <sect3 id="avahi-init">
282 <title>Boot Script</title>
283
284 <para revision="sysv">
285 To automatically start the <command>avahi-daemon</command>
286 when the system is rebooted, install the
287 <filename>/etc/rc.d/init.d/avahi</filename> bootscript from
288 the <xref linkend="bootscripts"/> package.
289 </para>
290
291 <para revision="systemd">
292 To start the <command>avahi-daemon</command> daemon at boot, enable
293 the previously installed systemd unit by running the following command
294 as the <systemitem class="username">root</systemitem> user:
295 </para>
296
297 <indexterm zone="avahi avahi-init">
298 <primary sortas="f-avahi">avahi</primary>
299 </indexterm>
300
301<screen role="root" revision="sysv"><userinput>make install-avahi</userinput></screen>
302
303<screen role="root" revision="systemd"><userinput>systemctl enable avahi-daemon</userinput></screen>
304
305 <para revision="systemd">
306 To start the <command>avahi-dnsconfd</command> daemon at boot, enable
307 the previously installed systemd unit by running the following command
308 as the <systemitem class="username">root</systemitem> user:
309 </para>
310
311<screen role="root" revision="systemd"><userinput>systemctl enable avahi-dnsconfd</userinput></screen>
312
313 </sect3>
314
315 </sect2>
316
317 <sect2 role="content">
318 <title>Contents</title>
319
320 <segmentedlist>
321 <segtitle>Installed Programs</segtitle>
322 <segtitle>Installed Libraries</segtitle>
323 <segtitle>Installed Directories</segtitle>
324
325 <seglistitem>
326 <seg>avahi-autoipd, avahi-browse, avahi-browse-domains,
327 avahi-daemon, avahi-discover-standalone, avahi-dnsconfd,
328 avahi-publish, avahi-publish-address, avahi-publish-service,
329 avahi-resolve, avahi-resolve-address, avahi-resolve-host-name,
330 avahi-set-host-name, bshell, bssh, and bvnc</seg>
331 <seg>libavahi-client.so, libavahi-common.so, libavahi-core.so,
332 libavahi-glib.so, libavahi-gobject.so, libavahi-libevent.so
333 libavahi-ui-gtk3.so, libavahi-qt5, libavahi-ui.so, libdns_sd.so, and
334 libhowl.so,</seg>
335 <seg>/etc/avahi/services, /usr/include/{avahi-client,avahi-common,
336 avahi-compat-howl, avahi-compat-libdns_sd, avahi-core, avahi-glib,
337 avahi-gobject, avahi-libevent, avahi-qt5, avahi-ui},
338 /usr/lib/avahi, /usr/share/avahi</seg>
339 </seglistitem>
340 </segmentedlist>
341
342 <variablelist>
343 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
344 <?dbfo list-presentation="list"?>
345 <?dbhtml list-presentation="table"?>
346
347 <varlistentry id="avahi-autoipd">
348 <term><command>avahi-autoipd</command></term>
349 <listitem>
350 <para>
351 is a IPv4LL network address configuration daemon.
352 </para>
353 <indexterm zone="avahi avahi-autoipd">
354 <primary sortas="b-avahi-autoipd">avahi-autoipd</primary>
355 </indexterm>
356 </listitem>
357 </varlistentry>
358 <!--
359 <varlistentry id="avahi-bookmarks">
360 <term><command>avahi-bookmarks</command></term>
361 <listitem>
362 <para>
363 is a Web service showing mDNS/DNS-SD announced HTTP services
364 using the <application>Avahi</application> daemon.
365 </para>
366 <indexterm zone="avahi avahi-bookmarks">
367 <primary sortas="b-avahi-bookmarks">avahi-bookmarks</primary>
368 </indexterm>
369 </listitem>
370 </varlistentry>
371 -->
372 <varlistentry id="avahi-browse">
373 <term><command>avahi-browse</command></term>
374 <listitem>
375 <para>
376 browses for mDNS/DNS-SD services using the
377 <application>Avahi</application> daemon.
378 </para>
379 <indexterm zone="avahi avahi-browse">
380 <primary sortas="b-avahi-browse">avahi-browse</primary>
381 </indexterm>
382 </listitem>
383 </varlistentry>
384
385 <varlistentry id="avahi-browse-domains">
386 <term><command>avahi-browse-domains</command></term>
387 <listitem>
388 <para>
389 browses for mDNS/DNS-SD services using the
390 <application>Avahi</application> daemon.
391 </para>
392 <indexterm zone="avahi avahi-browse-domains">
393 <primary sortas="b-avahi-browse-domains">avahi-browse-domains</primary>
394 </indexterm>
395 </listitem>
396 </varlistentry>
397
398 <varlistentry id="avahi-daemon">
399 <term><command>avahi-daemon</command></term>
400 <listitem>
401 <para>
402 is the <application>Avahi</application> mDNS/DNS-SD daemon.
403 </para>
404 <indexterm zone="avahi avahi-daemon">
405 <primary sortas="b-avahi-daemon">avahi-daemon</primary>
406 </indexterm>
407 </listitem>
408 </varlistentry>
409 <!--
410 <varlistentry id="avahi-discover">
411 <term><command>avahi-discover</command></term>
412 <listitem>
413 <para>
414 browses for mDNS/DNS-SD services using the
415 <application>Avahi</application> daemon.
416 </para>
417 <indexterm zone="avahi avahi-discover">
418 <primary sortas="b-avahi-discover">avahi-discover</primary>
419 </indexterm>
420 </listitem>
421 </varlistentry>
422 -->
423 <varlistentry id="avahi-discover-standalone">
424 <term><command>avahi-discover-standalone</command></term>
425 <listitem>
426 <para>
427 browses for mDNS/DNS-SD services using the
428 <application>Avahi</application> daemon.
429 </para>
430 <indexterm zone="avahi avahi-discover-standalone">
431 <primary sortas="b-avahi-discover-standalone">avahi-discover-standalone</primary>
432 </indexterm>
433 </listitem>
434 </varlistentry>
435
436 <varlistentry id="avahi-dnsconfd">
437 <term><command>avahi-dnsconfd</command></term>
438 <listitem>
439 <para>
440 is a Unicast DNS server from mDNS/DNS-SD configuration daemon.
441 </para>
442 <indexterm zone="avahi avahi-dnsconfd">
443 <primary sortas="b-avahi-dnsconfd">avahi-dnsconfd</primary>
444 </indexterm>
445 </listitem>
446 </varlistentry>
447
448 <varlistentry id="avahi-publish">
449 <term><command>avahi-publish</command></term>
450 <listitem>
451 <para>
452 registers a mDNS/DNS-SD service or host name or address mapping
453 using the <application>Avahi</application> daemon.
454 </para>
455 <indexterm zone="avahi avahi-publish">
456 <primary sortas="b-avahi-publish">avahi-publish</primary>
457 </indexterm>
458 </listitem>
459 </varlistentry>
460
461 <varlistentry id="avahi-publish-address">
462 <term><command>avahi-publish-address</command></term>
463 <listitem>
464 <para>
465 registers a mDNS/DNS-SD service or host name or address mapping
466 using the <application>Avahi</application> daemon.
467 </para>
468 <indexterm zone="avahi avahi-publish-address">
469 <primary sortas="b-avahi-publish-address">avahi-publish-address</primary>
470 </indexterm>
471 </listitem>
472 </varlistentry>
473
474 <varlistentry id="avahi-publish-service">
475 <term><command>avahi-publish-service</command></term>
476 <listitem>
477 <para>
478 registers a mDNS/DNS-SD service or host name or address mapping
479 using the <application>Avahi</application> daemon.
480 </para>
481 <indexterm zone="avahi avahi-publish-service">
482 <primary sortas="b-avahi-publish-service">avahi-publish-service</primary>
483 </indexterm>
484 </listitem>
485 </varlistentry>
486
487 <varlistentry id="avahi-resolve">
488 <term><command>avahi-resolve</command></term>
489 <listitem>
490 <para>
491 resolves one or more mDNS/DNS host name(s) to IP address(es)
492 (and vice versa) using the <application>Avahi</application>
493 daemon.
494 </para>
495 <indexterm zone="avahi avahi-resolve">
496 <primary sortas="b-avahi-resolve">avahi-resolve</primary>
497 </indexterm>
498 </listitem>
499 </varlistentry>
500
501 <varlistentry id="avahi-resolve-address">
502 <term><command>avahi-resolve-address</command></term>
503 <listitem>
504 <para>
505 resolves one or more mDNS/DNS host name(s) to IP address(es)
506 (and vice versa) using the <application>Avahi</application>
507 daemon.
508 </para>
509 <indexterm zone="avahi avahi-resolve-address">
510 <primary sortas="b-avahi-resolve-address">avahi-resolve-address</primary>
511 </indexterm>
512 </listitem>
513 </varlistentry>
514
515 <varlistentry id="avahi-resolve-host-name">
516 <term><command>avahi-resolve-host-name</command></term>
517 <listitem>
518 <para>
519 resolves one or more mDNS/DNS host name(s) to IP address(es)
520 (and vice versa) using the <application>Avahi</application>
521 daemon.
522 </para>
523 <indexterm zone="avahi avahi-resolve-host-name">
524 <primary sortas="b-avahi-resolve-host-name">avahi-resolve-host-name</primary>
525 </indexterm>
526 </listitem>
527 </varlistentry>
528
529 <varlistentry id="avahi-set-host-name">
530 <term><command>avahi-set-host-name</command></term>
531 <listitem>
532 <para>
533 changes the mDNS host name.
534 </para>
535 <indexterm zone="avahi avahi-set-host-name">
536 <primary sortas="b-avahi-set-host-name">avahi-set-host-name</primary>
537 </indexterm>
538 </listitem>
539 </varlistentry>
540
541 <!--<varlistentry id="bshell">
542 <term><command>bshell</command></term>
543 <listitem>
544 <para>
545 does this .....
546 </para>
547 <indexterm zone="avahi bshell">
548 <primary sortas="b-bshell">bshell</primary>
549 </indexterm>
550 </listitem>
551 </varlistentry>-->
552
553 <varlistentry id="bssh">
554 <term><command>bssh</command></term>
555 <listitem>
556 <para>
557 browses for SSH servers on the local network.
558 </para>
559 <indexterm zone="avahi bssh">
560 <primary sortas="b-bssh">bssh</primary>
561 </indexterm>
562 </listitem>
563 </varlistentry>
564
565 <varlistentry id="bvnc">
566 <term><command>bvnc</command></term>
567 <listitem>
568 <para>
569 browses for VNC servers on the local network.
570 </para>
571 <indexterm zone="avahi bvnc">
572 <primary sortas="b-bvnc">bvnc</primary>
573 </indexterm>
574 </listitem>
575 </varlistentry>
576
577 <!--<varlistentry id="libavahi-client">
578 <term><filename class='libraryfile'>libavahi-client.{so,a}</filename></term>
579 <listitem>
580 <para>
581 contains functions that .....
582 </para>
583 <indexterm zone="avahi libavahi-client">
584 <primary sortas="c-libavahi-client">libavahi-client.{so,a}</primary>
585 </indexterm>
586 </listitem>
587 </varlistentry>
588
589 <varlistentry id="libavahi-common">
590 <term><filename class='libraryfile'>libavahi-common.{so,a}</filename></term>
591 <listitem>
592 <para>
593 contains functions that .....
594 </para>
595 <indexterm zone="avahi libavahi-common">
596 <primary sortas="c-libavahi-common">libavahi-common.{so,a}</primary>
597 </indexterm>
598 </listitem>
599 </varlistentry>
600
601 <varlistentry id="libavahi-core">
602 <term><filename class='libraryfile'>libavahi-core.{so,a}</filename></term>
603 <listitem>
604 <para>
605 contains functions that .....
606 </para>
607 <indexterm zone="avahi libavahi-core">
608 <primary sortas="c-libavahi-core">libavahi-core.{so,a}</primary>
609 </indexterm>
610 </listitem>
611 </varlistentry>
612
613 <varlistentry id="libavahi-glib">
614 <term><filename class='libraryfile'>libavahi-glib.{so,a}</filename></term>
615 <listitem>
616 <para>
617 contains functions that .....
618 </para>
619 <indexterm zone="avahi libavahi-glib">
620 <primary sortas="c-libavahi-glib">libavahi-glib.{so,a}</primary>
621 </indexterm>
622 </listitem>
623 </varlistentry>
624
625 <varlistentry id="libavahi-gobject">
626 <term><filename class='libraryfile'>libavahi-gobject.{so,a}</filename></term>
627 <listitem>
628 <para>
629 contains functions that .....
630 </para>
631 <indexterm zone="avahi libavahi-gobject">
632 <primary sortas="c-libavahi-gobject">libavahi-gobject.{so,a}</primary>
633 </indexterm>
634 </listitem>
635 </varlistentry>
636
637 <varlistentry id="libavahi-ui-gtk3">
638 <term><filename class='libraryfile'>libavahi-ui-gtk3.{so,a}</filename></term>
639 <listitem>
640 <para>
641 contains functions that .....
642 </para>
643 <indexterm zone="avahi libavahi-ui-gtk3">
644 <primary sortas="c-libavahi-ui-gtk3">libavahi-ui-gtk3.{so,a}</primary>
645 </indexterm>
646 </listitem>
647 </varlistentry>
648
649 <varlistentry id="libavahi-ui">
650 <term><filename class='libraryfile'>libavahi-ui.{so,a}</filename></term>
651 <listitem>
652 <para>
653 contains functions that .....
654 </para>
655 <indexterm zone="avahi libavahi-ui">
656 <primary sortas="c-libavahi-ui">libavahi-ui.{so,a}</primary>
657 </indexterm>
658 </listitem>
659 </varlistentry>
660
661 <varlistentry id="libdns_sd">
662 <term><filename class='libraryfile'>libdns_sd.{so,a}</filename></term>
663 <listitem>
664 <para>
665 contains functions that .....
666 </para>
667 <indexterm zone="avahi libdns_sd">
668 <primary sortas="c-libdns_sd">libdns_sd.{so,a}</primary>
669 </indexterm>
670 </listitem>
671 </varlistentry>
672
673 <varlistentry id="libhowl">
674 <term><filename class='libraryfile'>libhowl.{so,a}</filename></term>
675 <listitem>
676 <para>
677 contains functions that .....
678 </para>
679 <indexterm zone="avahi libhowl">
680 <primary sortas="c-libhowl">libhowl.{so,a}</primary>
681 </indexterm>
682 </listitem>
683 </varlistentry>-->
684
685 </variablelist>
686
687 </sect2>
688
689</sect1>
Note: See TracBrowser for help on using the repository browser.