source: networking/netutils/avahi.xml@ 5f729f8

11.2 plabs/python-mods trunk xry111/soup3
Last change on this file since 5f729f8 was 5f729f8, checked in by Douglas R. Reno <renodr@…>, 4 months ago

Various typo fixes

  • Property mode set to 100644
File size: 23.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 <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 &lfs111_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 /run/avahi-daemon -u 84 \
126 -g avahi -s /bin/false avahi</userinput></screen>
127
128 <para>
129 There should also be a dedicated privileged 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 vulnerability 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 \
158 --prefix=/usr \
159 --sysconfdir=/etc \
160 --localstatedir=/var \
161 --disable-static \
162 --disable-libevent \
163 --disable-mono \
164 --disable-monodoc \
165 --disable-python \
166 --disable-qt3 \
167 --disable-qt4 \
168 --enable-core-docs \
169 --with-distro=none \
170 --with-systemdsystemunitdir=no \
171 --with-dbus-system-address='unix:path=/run/dbus/system_bus_socket' &amp;&amp;
172make</userinput></screen>
173
174<screen revision="systemd"><userinput>./configure \
175 --prefix=/usr \
176 --sysconfdir=/etc \
177 --localstatedir=/var \
178 --disable-static \
179 --disable-libevent \
180 --disable-mono \
181 --disable-monodoc \
182 --disable-python \
183 --disable-qt3 \
184 --disable-qt4 \
185 --enable-core-docs \
186 --with-distro=none \
187 --with-dbus-system-address='unix:path=/run/dbus/system_bus_socket' &amp;&amp;
188make</userinput></screen>
189
190 <para>
191 This package does not come with a test suite.
192 </para>
193
194 <para>
195 Now, as the <systemitem class="username">root</systemitem> user:
196 </para>
197
198<screen role="root"><userinput>make install</userinput></screen>
199
200 </sect2>
201
202 <sect2 role="commands">
203 <title>Command Explanations</title>
204
205 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
206 href="../../xincludes/static-libraries.xml"/>
207
208 <para>
209 <parameter>--disable-libevent</parameter>: This parameter disables the
210 use of <xref linkend="libevent"/>. Remove if you have it installed.
211 </para>
212
213 <para>
214 <parameter>--disable-mono</parameter>: This parameter disables the
215 <application>Mono</application> bindings.
216 </para>
217
218 <para>
219 <parameter>--disable-monodoc</parameter>: This parameter disables
220 documentation for the <application>Mono</application> bindings.
221 </para>
222
223 <para>
224 <parameter>--disable-python</parameter>: This parameter disables the
225 scripts that depend on <application>Python</application>. It also
226 allows a regular install to complete successfully.
227 </para>
228
229 <para>
230 <parameter>--disable-qt3</parameter>: This parameter disables the
231 attempt to build the obsolete <application>Qt3</application>
232 portions of the package.
233 </para>
234
235 <para>
236 <parameter>--disable-qt4</parameter>: This parameter disables the
237 attempt to build the obsolete <application>Qt4Core</application>
238 portions of the package.
239 </para>
240
241 <para>
242 <parameter>--enable-core-docs</parameter>: This parameter enables the
243 building of documentation.
244 </para>
245
246 <para>
247 <parameter>--with-distro=none</parameter>: There is an obsolete
248 boot script in the distribution for LFS. This option disables it.
249 </para>
250
251 <para revision="sysv">
252 <parameter>--with-systemdsystemunitdir=no</parameter>: Without it, the
253 daemon fails to start in BLFS, which does not support
254 <application>systemd</application>.
255 </para>
256
257 <para>
258 <parameter>--with-dbus-system-address=...</parameter>: This option
259 prevents the package from referring to the deprecated
260 <filename class='directory'>/var/run</filename> directory.
261 </para>
262
263 <para>
264 <option>--disable-dbus</option>: This parameter disables the use
265 of <application>D-Bus</application>.
266 </para>
267
268 <para>
269 <option>--disable-gtk</option>: This parameter disables the use
270 of <application>GTK+2</application>.
271 </para>
272
273 <para>
274 <option>--disable-gtk3</option>: This parameter disables the use
275 of <application>GTK+3</application>.
276 </para>
277
278 <para>
279 <option>--disable-qt5</option>: This parameter disables the use
280 of <application>Qt5</application>, and allows building without it.
281 </para>
282
283 <para>
284 <option>--disable-libdaemon</option>: This parameter disables the use
285 of <application>libdaemon</application>. If you use this option,
286 <command>avahi-daemon</command> won't be built.
287 </para>
288
289 <para>
290 <option>--enable-tests</option>: This option enables the building of
291 tests and examples.
292 </para>
293
294 <para>
295 <option>--enable-compat-howl</option>: This option enables the
296 compatibility layer for <application>HOWL</application>.
297 </para>
298
299 <para>
300 <option>--enable-compat-libdns_sd</option>: This option enables the
301 compatibility layer for <application>libdns_sd</application>.
302 </para>
303
304 </sect2>
305
306 <sect2 role="configuration">
307 <title>Configuring avahi</title>
308
309 <sect3 id="avahi-init">
310 <title>Boot Script</title>
311
312 <para revision="sysv">
313 To automatically start the <command>avahi-daemon</command>
314 when the system is rebooted, install the
315 <filename>/etc/rc.d/init.d/avahi</filename> bootscript from
316 the <xref linkend="bootscripts"/> package.
317 </para>
318
319 <para revision="systemd">
320 To start the <command>avahi-daemon</command> daemon at boot, enable
321 the previously installed systemd unit by running the following command
322 as the <systemitem class="username">root</systemitem> user:
323 </para>
324
325 <indexterm zone="avahi avahi-init">
326 <primary sortas="f-avahi">avahi</primary>
327 </indexterm>
328
329<screen role="root" revision="sysv"><userinput>make install-avahi</userinput></screen>
330
331<screen role="root" revision="systemd"><userinput>systemctl enable avahi-daemon</userinput></screen>
332
333 <para revision="systemd">
334 To start the <command>avahi-dnsconfd</command> daemon at boot, enable
335 the previously installed systemd unit by running the following command
336 as the <systemitem class="username">root</systemitem> user:
337 </para>
338
339<screen role="root" revision="systemd"><userinput>systemctl enable avahi-dnsconfd</userinput></screen>
340
341 </sect3>
342
343 </sect2>
344
345 <sect2 role="content">
346 <title>Contents</title>
347
348 <segmentedlist>
349 <segtitle>Installed Programs</segtitle>
350 <segtitle>Installed Libraries</segtitle>
351 <segtitle>Installed Directories</segtitle>
352
353 <seglistitem>
354 <seg>avahi-autoipd, avahi-browse, avahi-browse-domains,
355 avahi-daemon, avahi-discover-standalone, avahi-dnsconfd,
356 avahi-publish, avahi-publish-address, avahi-publish-service,
357 avahi-resolve, avahi-resolve-address, avahi-resolve-host-name,
358 avahi-set-host-name, bshell, bssh, and bvnc</seg>
359 <seg>libavahi-client.so, libavahi-common.so, libavahi-core.so,
360 libavahi-glib.so, libavahi-gobject.so, libavahi-libevent.so
361 libavahi-ui-gtk3.so, libavahi-qt5, libavahi-ui.so, libdns_sd.so, and
362 libhowl.so,</seg>
363 <seg>/etc/avahi/services, /usr/include/{avahi-client,avahi-common,
364 avahi-compat-howl, avahi-compat-libdns_sd, avahi-core, avahi-glib,
365 avahi-gobject, avahi-libevent, avahi-qt5, avahi-ui},
366 /usr/lib/avahi, /usr/share/avahi</seg>
367 </seglistitem>
368 </segmentedlist>
369
370 <variablelist>
371 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
372 <?dbfo list-presentation="list"?>
373 <?dbhtml list-presentation="table"?>
374
375 <varlistentry id="avahi-autoipd">
376 <term><command>avahi-autoipd</command></term>
377 <listitem>
378 <para>
379 is a IPv4LL network address configuration daemon
380 </para>
381 <indexterm zone="avahi avahi-autoipd">
382 <primary sortas="b-avahi-autoipd">avahi-autoipd</primary>
383 </indexterm>
384 </listitem>
385 </varlistentry>
386 <!--
387 <varlistentry id="avahi-bookmarks">
388 <term><command>avahi-bookmarks</command></term>
389 <listitem>
390 <para>
391 is a Web service showing mDNS/DNS-SD announced HTTP services
392 using the <application>Avahi</application> daemon.
393 </para>
394 <indexterm zone="avahi avahi-bookmarks">
395 <primary sortas="b-avahi-bookmarks">avahi-bookmarks</primary>
396 </indexterm>
397 </listitem>
398 </varlistentry>
399 -->
400 <varlistentry id="avahi-browse">
401 <term><command>avahi-browse</command></term>
402 <listitem>
403 <para>
404 browses for mDNS/DNS-SD services using the
405 <application>Avahi</application> daemon
406 </para>
407 <indexterm zone="avahi avahi-browse">
408 <primary sortas="b-avahi-browse">avahi-browse</primary>
409 </indexterm>
410 </listitem>
411 </varlistentry>
412
413 <varlistentry id="avahi-browse-domains">
414 <term><command>avahi-browse-domains</command></term>
415 <listitem>
416 <para>
417 browses for mDNS/DNS-SD services using the
418 <application>Avahi</application> daemon
419 </para>
420 <indexterm zone="avahi avahi-browse-domains">
421 <primary sortas="b-avahi-browse-domains">avahi-browse-domains</primary>
422 </indexterm>
423 </listitem>
424 </varlistentry>
425
426 <varlistentry id="avahi-daemon">
427 <term><command>avahi-daemon</command></term>
428 <listitem>
429 <para>
430 is the <application>Avahi</application> mDNS/DNS-SD daemon
431 </para>
432 <indexterm zone="avahi avahi-daemon">
433 <primary sortas="b-avahi-daemon">avahi-daemon</primary>
434 </indexterm>
435 </listitem>
436 </varlistentry>
437 <!--
438 <varlistentry id="avahi-discover">
439 <term><command>avahi-discover</command></term>
440 <listitem>
441 <para>
442 browses for mDNS/DNS-SD services using the
443 <application>Avahi</application> daemon.
444 </para>
445 <indexterm zone="avahi avahi-discover">
446 <primary sortas="b-avahi-discover">avahi-discover</primary>
447 </indexterm>
448 </listitem>
449 </varlistentry>
450 -->
451 <varlistentry id="avahi-discover-standalone">
452 <term><command>avahi-discover-standalone</command></term>
453 <listitem>
454 <para>
455 browses for mDNS/DNS-SD services using the
456 <application>Avahi</application> daemon
457 </para>
458 <indexterm zone="avahi avahi-discover-standalone">
459 <primary sortas="b-avahi-discover-standalone">avahi-discover-standalone</primary>
460 </indexterm>
461 </listitem>
462 </varlistentry>
463
464 <varlistentry id="avahi-dnsconfd">
465 <term><command>avahi-dnsconfd</command></term>
466 <listitem>
467 <para>
468 is a Unicast DNS server from mDNS/DNS-SD configuration daemon
469 </para>
470 <indexterm zone="avahi avahi-dnsconfd">
471 <primary sortas="b-avahi-dnsconfd">avahi-dnsconfd</primary>
472 </indexterm>
473 </listitem>
474 </varlistentry>
475
476 <varlistentry id="avahi-publish">
477 <term><command>avahi-publish</command></term>
478 <listitem>
479 <para>
480 registers a mDNS/DNS-SD service or host name or address mapping
481 using the <application>Avahi</application> daemon
482 </para>
483 <indexterm zone="avahi avahi-publish">
484 <primary sortas="b-avahi-publish">avahi-publish</primary>
485 </indexterm>
486 </listitem>
487 </varlistentry>
488
489 <varlistentry id="avahi-publish-address">
490 <term><command>avahi-publish-address</command></term>
491 <listitem>
492 <para>
493 registers a mDNS/DNS-SD service or host name or address mapping
494 using the <application>Avahi</application> daemon
495 </para>
496 <indexterm zone="avahi avahi-publish-address">
497 <primary sortas="b-avahi-publish-address">avahi-publish-address</primary>
498 </indexterm>
499 </listitem>
500 </varlistentry>
501
502 <varlistentry id="avahi-publish-service">
503 <term><command>avahi-publish-service</command></term>
504 <listitem>
505 <para>
506 registers a mDNS/DNS-SD service or host name or address mapping
507 using the <application>Avahi</application> daemon
508 </para>
509 <indexterm zone="avahi avahi-publish-service">
510 <primary sortas="b-avahi-publish-service">avahi-publish-service</primary>
511 </indexterm>
512 </listitem>
513 </varlistentry>
514
515 <varlistentry id="avahi-resolve">
516 <term><command>avahi-resolve</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">
524 <primary sortas="b-avahi-resolve">avahi-resolve</primary>
525 </indexterm>
526 </listitem>
527 </varlistentry>
528
529 <varlistentry id="avahi-resolve-address">
530 <term><command>avahi-resolve-address</command></term>
531 <listitem>
532 <para>
533 resolves one or more mDNS/DNS host name(s) to IP address(es)
534 (and vice versa) using the <application>Avahi</application>
535 daemon
536 </para>
537 <indexterm zone="avahi avahi-resolve-address">
538 <primary sortas="b-avahi-resolve-address">avahi-resolve-address</primary>
539 </indexterm>
540 </listitem>
541 </varlistentry>
542
543 <varlistentry id="avahi-resolve-host-name">
544 <term><command>avahi-resolve-host-name</command></term>
545 <listitem>
546 <para>
547 resolves one or more mDNS/DNS host name(s) to IP address(es)
548 (and vice versa) using the <application>Avahi</application>
549 daemon
550 </para>
551 <indexterm zone="avahi avahi-resolve-host-name">
552 <primary sortas="b-avahi-resolve-host-name">avahi-resolve-host-name</primary>
553 </indexterm>
554 </listitem>
555 </varlistentry>
556
557 <varlistentry id="avahi-set-host-name">
558 <term><command>avahi-set-host-name</command></term>
559 <listitem>
560 <para>
561 changes the mDNS host name
562 </para>
563 <indexterm zone="avahi avahi-set-host-name">
564 <primary sortas="b-avahi-set-host-name">avahi-set-host-name</primary>
565 </indexterm>
566 </listitem>
567 </varlistentry>
568
569 <!--<varlistentry id="bshell">
570 <term><command>bshell</command></term>
571 <listitem>
572 <para>
573 does this .....
574 </para>
575 <indexterm zone="avahi bshell">
576 <primary sortas="b-bshell">bshell</primary>
577 </indexterm>
578 </listitem>
579 </varlistentry>-->
580
581 <varlistentry id="bssh">
582 <term><command>bssh</command></term>
583 <listitem>
584 <para>
585 browses for SSH servers on the local network
586 </para>
587 <indexterm zone="avahi bssh">
588 <primary sortas="b-bssh">bssh</primary>
589 </indexterm>
590 </listitem>
591 </varlistentry>
592
593 <varlistentry id="bvnc">
594 <term><command>bvnc</command></term>
595 <listitem>
596 <para>
597 browses for VNC servers on the local network
598 </para>
599 <indexterm zone="avahi bvnc">
600 <primary sortas="b-bvnc">bvnc</primary>
601 </indexterm>
602 </listitem>
603 </varlistentry>
604
605 <!--<varlistentry id="libavahi-client">
606 <term><filename class='libraryfile'>libavahi-client.{so,a}</filename></term>
607 <listitem>
608 <para>
609 contains functions that .....
610 </para>
611 <indexterm zone="avahi libavahi-client">
612 <primary sortas="c-libavahi-client">libavahi-client.{so,a}</primary>
613 </indexterm>
614 </listitem>
615 </varlistentry>
616
617 <varlistentry id="libavahi-common">
618 <term><filename class='libraryfile'>libavahi-common.{so,a}</filename></term>
619 <listitem>
620 <para>
621 contains functions that .....
622 </para>
623 <indexterm zone="avahi libavahi-common">
624 <primary sortas="c-libavahi-common">libavahi-common.{so,a}</primary>
625 </indexterm>
626 </listitem>
627 </varlistentry>
628
629 <varlistentry id="libavahi-core">
630 <term><filename class='libraryfile'>libavahi-core.{so,a}</filename></term>
631 <listitem>
632 <para>
633 contains functions that .....
634 </para>
635 <indexterm zone="avahi libavahi-core">
636 <primary sortas="c-libavahi-core">libavahi-core.{so,a}</primary>
637 </indexterm>
638 </listitem>
639 </varlistentry>
640
641 <varlistentry id="libavahi-glib">
642 <term><filename class='libraryfile'>libavahi-glib.{so,a}</filename></term>
643 <listitem>
644 <para>
645 contains functions that .....
646 </para>
647 <indexterm zone="avahi libavahi-glib">
648 <primary sortas="c-libavahi-glib">libavahi-glib.{so,a}</primary>
649 </indexterm>
650 </listitem>
651 </varlistentry>
652
653 <varlistentry id="libavahi-gobject">
654 <term><filename class='libraryfile'>libavahi-gobject.{so,a}</filename></term>
655 <listitem>
656 <para>
657 contains functions that .....
658 </para>
659 <indexterm zone="avahi libavahi-gobject">
660 <primary sortas="c-libavahi-gobject">libavahi-gobject.{so,a}</primary>
661 </indexterm>
662 </listitem>
663 </varlistentry>
664
665 <varlistentry id="libavahi-ui-gtk3">
666 <term><filename class='libraryfile'>libavahi-ui-gtk3.{so,a}</filename></term>
667 <listitem>
668 <para>
669 contains functions that .....
670 </para>
671 <indexterm zone="avahi libavahi-ui-gtk3">
672 <primary sortas="c-libavahi-ui-gtk3">libavahi-ui-gtk3.{so,a}</primary>
673 </indexterm>
674 </listitem>
675 </varlistentry>
676
677 <varlistentry id="libavahi-ui">
678 <term><filename class='libraryfile'>libavahi-ui.{so,a}</filename></term>
679 <listitem>
680 <para>
681 contains functions that .....
682 </para>
683 <indexterm zone="avahi libavahi-ui">
684 <primary sortas="c-libavahi-ui">libavahi-ui.{so,a}</primary>
685 </indexterm>
686 </listitem>
687 </varlistentry>
688
689 <varlistentry id="libdns_sd">
690 <term><filename class='libraryfile'>libdns_sd.{so,a}</filename></term>
691 <listitem>
692 <para>
693 contains functions that .....
694 </para>
695 <indexterm zone="avahi libdns_sd">
696 <primary sortas="c-libdns_sd">libdns_sd.{so,a}</primary>
697 </indexterm>
698 </listitem>
699 </varlistentry>
700
701 <varlistentry id="libhowl">
702 <term><filename class='libraryfile'>libhowl.{so,a}</filename></term>
703 <listitem>
704 <para>
705 contains functions that .....
706 </para>
707 <indexterm zone="avahi libhowl">
708 <primary sortas="c-libhowl">libhowl.{so,a}</primary>
709 </indexterm>
710 </listitem>
711 </varlistentry>-->
712
713 </variablelist>
714
715 </sect2>
716
717</sect1>
Note: See TracBrowser for help on using the repository browser.