source: networking/netutils/avahi.xml@ a65bfc5a

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 a65bfc5a was a65bfc5a, checked in by Douglas R. Reno <renodr@…>, 3 years ago

A few tags and a package update

Update to gexiv2-0.12.3

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