source: networking/netutils/avahi.xml@ 22ff60a

systemd-13485
Last change on this file since 22ff60a was 027c7d7, checked in by DJ Lucas <dj@…>, 8 years ago

Merge Chapter 16 from trunk.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@16879 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 20.7 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 "http://avahi.org/download/avahi-&avahi-version;.tar.gz">
8 <!ENTITY avahi-download-ftp " ">
9 <!ENTITY avahi-md5sum "2f22745b8f7368ad5a0a3fddac343f2d">
10 <!ENTITY avahi-size "1.3 MB">
11 <!ENTITY avahi-buildsize "23 MB">
12 <!ENTITY avahi-time "0.4 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 &lfs78_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"/> and
86 <xref linkend="libglade"/>
87 </para>
88
89 <bridgehead renderas="sect4">Optional</bridgehead>
90 <para role="optional">
91 <xref linkend="dbus-python"/>,
92 <xref linkend="pygtk"/> and
93 <xref linkend="qt4"/>
94 </para>
95
96 <para condition="html" role="usernotes">User Notes:
97 <ulink url="&blfs-wiki;/avahi"/>
98 </para>
99 </sect2>
100
101 <sect2 role="installation">
102 <title>Installation of Avahi</title>
103
104 <para>
105 There should be a dedicated user and group to take control
106 of the <command>avahi-daemon</command> daemon after it is
107 started. Issue the following commands as the
108 <systemitem class="username">root</systemitem> user:
109 </para>
110
111<screen role="root"><userinput>groupadd -fg 84 avahi &amp;&amp;
112useradd -c "Avahi Daemon Owner" -d /var/run/avahi-daemon -u 84 \
113 -g avahi -s /bin/false avahi</userinput></screen>
114
115 <para>
116 There should also be a dedicated priviliged access group for
117 <application>Avahi</application> clients. Issue the following command as
118 the <systemitem class="username">root</systemitem> user:
119 </para>
120
121<screen role="root"><userinput>groupadd -fg 86 netdev</userinput></screen>
122
123 <para>Install <application>Avahi</application> by running the following
124 commands:</para>
125
126<!-- final part of sed removes " -DGDK_DISABLE_DEPRECATED=1 -DGTK_DISABLE_DEPRECATED=1 \" -->
127<screen><userinput>sed -i 's/\(CFLAGS=.*\)-Werror \(.*\)/\1\2/' configure &amp;&amp;
128
129sed -e 's/-DG_DISABLE_DEPRECATED=1//' \
130 -e '/-DGDK_DISABLE_DEPRECATED/d' \
131 -i avahi-ui/Makefile.in &amp;&amp;
132
133./configure --prefix=/usr \
134 --sysconfdir=/etc \
135 --localstatedir=/var \
136 --disable-static \
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=/lib/systemd/system &amp;&amp;
145make</userinput></screen>
146
147 <para>
148 This package does not come with a test suite.
149 </para>
150
151 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
152
153<screen role="root"><userinput>make install</userinput></screen>
154
155 </sect2>
156
157 <sect2 role="commands">
158 <title>Command Explanations</title>
159
160 <para>
161 <command>sed -i ...</command>: These seds allow the package to build after
162 the deprecation of symbols in <literal>gtkstock.h</literal> by current
163 <application>gtk+-3</application> by removing <literal>-Werror</literal>
164 and by removing the defines for G{,DK,TK}_DISABLE_DEPRECATED.
165 </para>
166
167 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
168 href="../../xincludes/static-libraries.xml"/>
169
170 <para>
171 <parameter>--disable-mono</parameter>: This parameter disables the
172 <application>Mono</application> bindings.
173 </para>
174
175 <para>
176 <parameter>--disable-monodoc</parameter>: This parameter disables
177 documentation for the <application>Mono</application> bindings.
178 </para>
179
180 <para>
181 <parameter>--disable-python</parameter>: This parameter disables the
182 scripts that depend on <application>Python</application>. It also
183 allows a regular install to complete successfully.
184 </para>
185
186 <para>
187 <parameter>--disable-qt3</parameter>: This parameter disables the
188 building of <application>Qt3</application> mainloop integration.
189 </para>
190
191 <para>
192 <parameter>--disable-qt4</parameter>: This parameter disables the building
193 of <application>Qt4Core</application> mainloop integration. Omit
194 this if you have installed <application>Qt4</application>.
195 </para>
196
197 <para>
198 <parameter>--enable-core-docs</parameter>: This parameter enables the
199 building of documentation.
200 </para>
201
202 <para>
203 <parameter>--with-distro=none</parameter>: There is an obsolete
204 boot script in the distribution for LFS. This option disables it.
205 </para>
206
207 <para>
208 <parameter>--with-systemdsystemunitdir=/lib/systemd/system</parameter>:
209 This parameter is used to set the correct installation directory for
210 systemd units.
211 </para>
212
213 <para>
214 <option>--disable-dbus</option>: This parameter disables the use
215 of <application>D-Bus</application>.
216 </para>
217
218 <para>
219 <option>--disable-gtk</option>: This parameter disables the use
220 of <application>GTK+2</application>.
221 </para>
222
223 <para>
224 <option>--disable-gtk3</option>: This parameter disables the use
225 of <application>GTK+3</application>.
226 </para>
227
228 <para>
229 <option>--disable-libdaemon</option>: This parameter disables the use
230 of <application>libdaemon</application>. If you use this option,
231 <command>avahi-daemon</command> won't be built.
232 </para>
233
234 <para>
235 <option>--enable-tests</option>: This option enables the building of
236 tests and examples.
237 </para>
238
239 <para>
240 <option>--enable-compat-howl</option>: This option enables the
241 compatibility layer for <application>HOWL</application>.
242 </para>
243
244 <para>
245 <option>--enable-compat-libdns_sd</option>: This option enables the
246 compatibility layer for <application>libdns_sd</application>.
247 </para>
248
249 </sect2>
250
251 <sect2 role="configuration">
252 <title>Configuring Avahi</title>
253
254 <sect3 id="avahi-init">
255 <title>Systemd Units</title>
256
257 <para>
258 To start the <command>avahi-daemon</command> daemon at boot, enable
259 the previously installed systemd unit by running the following command
260 as the <systemitem class="username">root</systemitem> user:
261 </para>
262
263 <indexterm zone="avahi avahi-init">
264 <primary sortas="f-avahi">avahi</primary>
265 </indexterm>
266
267<screen role="root"><userinput>systemctl enable avahi-daemon</userinput></screen>
268
269 <para>
270 To start the <command>avahi-dnsconfd</command> daemon at boot, enable
271 the previously installed systemd unit by running the following command
272 as the <systemitem class="username">root</systemitem> user:
273 </para>
274
275<screen role="root"><userinput>systemctl enable avahi-dnsconfd</userinput></screen>
276
277 </sect3>
278
279 </sect2>
280
281 <sect2 role="content">
282 <title>Contents</title>
283
284 <segmentedlist>
285 <segtitle>Installed Programs</segtitle>
286 <segtitle>Installed Libraries</segtitle>
287 <segtitle>Installed Directories</segtitle>
288
289 <seglistitem>
290 <seg>avahi-autoipd, avahi-bookmarks, avahi-browse, avahi-browse-domains,
291 avahi-daemon, avahi-discover, avahi-discover-standalone, avahi-dnsconfd,
292 avahi-publish, avahi-publish-address, avahi-publish-service,
293 avahi-resolve, avahi-resolve-address, avahi-resolve-host-name,
294 avahi-set-host-name, bshell, bssh, and bvnc</seg>
295 <seg>libavahi-client.so, libavahi-common.so,
296 libavahi-core.so, libavahi-glib.so, libavahi-gobject.so,
297 libavahi-ui-gtk3.so,, libavahi-ui.so, libdns_sd.so, and
298 libhowl.so,</seg>
299 <seg>/etc/avahi/services, /usr/{include/{avahi-client,avahi-common,
300 avahi-compat-howl/{corby,discovery,rendezvous,salt},
301 avahi-compat-libdns_sd,avahi-core,avahi-glib,avahi-gobject,avahi-ui},
302 lib/{avahi,python&python2-majorver;/site-packages/{avahi,
303 avahi_discover}},share/{avahi/interfaces,locale/en_NZ/LC_MESSAGES}}</seg>
304 </seglistitem>
305 </segmentedlist>
306
307 <variablelist>
308 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
309 <?dbfo list-presentation="list"?>
310 <?dbhtml list-presentation="table"?>
311
312 <varlistentry id="avahi-autoipd">
313 <term><command>avahi-autoipd</command></term>
314 <listitem>
315 <para>is a IPv4LL network address configuration daemon.</para>
316 <indexterm zone="avahi avahi-autoipd">
317 <primary sortas="b-avahi-autoipd">avahi-autoipd</primary>
318 </indexterm>
319 </listitem>
320 </varlistentry>
321
322 <varlistentry id="avahi-bookmarks">
323 <term><command>avahi-bookmarks</command></term>
324 <listitem>
325 <para>is a Web service showing mDNS/DNS-SD announced HTTP services
326 using the <application>Avahi</application> daemon.</para>
327 <indexterm zone="avahi avahi-bookmarks">
328 <primary sortas="b-avahi-bookmarks">avahi-bookmarks</primary>
329 </indexterm>
330 </listitem>
331 </varlistentry>
332
333 <varlistentry id="avahi-browse">
334 <term><command>avahi-browse</command></term>
335 <listitem>
336 <para>browses for mDNS/DNS-SD services using the
337 <application>Avahi</application> daemon.</para>
338 <indexterm zone="avahi avahi-browse">
339 <primary sortas="b-avahi-browse">avahi-browse</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry id="avahi-browse-domains">
345 <term><command>avahi-browse-domains</command></term>
346 <listitem>
347 <para>browses for mDNS/DNS-SD services using the
348 <application>Avahi</application> daemon.</para>
349 <indexterm zone="avahi avahi-browse-domains">
350 <primary sortas="b-avahi-browse-domains">avahi-browse-domains</primary>
351 </indexterm>
352 </listitem>
353 </varlistentry>
354
355 <varlistentry id="avahi-daemon">
356 <term><command>avahi-daemon</command></term>
357 <listitem>
358 <para>is the <application>Avahi</application> mDNS/DNS-SD
359 daemon.</para>
360 <indexterm zone="avahi avahi-daemon">
361 <primary sortas="b-avahi-daemon">avahi-daemon</primary>
362 </indexterm>
363 </listitem>
364 </varlistentry>
365
366 <varlistentry id="avahi-discover">
367 <term><command>avahi-discover</command></term>
368 <listitem>
369 <para>browses for mDNS/DNS-SD services using the
370 <application>Avahi</application> daemon.</para>
371 <indexterm zone="avahi avahi-discover">
372 <primary sortas="b-avahi-discover">avahi-discover</primary>
373 </indexterm>
374 </listitem>
375 </varlistentry>
376
377 <varlistentry id="avahi-discover-standalone">
378 <term><command>avahi-discover-standalone</command></term>
379 <listitem>
380 <para>browses for mDNS/DNS-SD services using the
381 <application>Avahi</application> daemon.</para>
382 <indexterm zone="avahi avahi-discover-standalone">
383 <primary sortas="b-avahi-discover-standalone">avahi-discover-standalone</primary>
384 </indexterm>
385 </listitem>
386 </varlistentry>
387
388 <varlistentry id="avahi-dnsconfd">
389 <term><command>avahi-dnsconfd</command></term>
390 <listitem>
391 <para>is a Unicast DNS server from mDNS/DNS-SD configuration
392 daemon.</para>
393 <indexterm zone="avahi avahi-dnsconfd">
394 <primary sortas="b-avahi-dnsconfd">avahi-dnsconfd</primary>
395 </indexterm>
396 </listitem>
397 </varlistentry>
398
399 <varlistentry id="avahi-publish">
400 <term><command>avahi-publish</command></term>
401 <listitem>
402 <para>registers a mDNS/DNS-SD service or host name or address mapping
403 using the <application>Avahi</application> daemon.</para>
404 <indexterm zone="avahi avahi-publish">
405 <primary sortas="b-avahi-publish">avahi-publish</primary>
406 </indexterm>
407 </listitem>
408 </varlistentry>
409
410 <varlistentry id="avahi-publish-address">
411 <term><command>avahi-publish-address</command></term>
412 <listitem>
413 <para>registers a mDNS/DNS-SD service or host name or address mapping
414 using the <application>Avahi</application> daemon.</para>
415 <indexterm zone="avahi avahi-publish-address">
416 <primary sortas="b-avahi-publish-address">avahi-publish-address</primary>
417 </indexterm>
418 </listitem>
419 </varlistentry>
420
421 <varlistentry id="avahi-publish-service">
422 <term><command>avahi-publish-service</command></term>
423 <listitem>
424 <para>registers a mDNS/DNS-SD service or host name or address mapping
425 using the <application>Avahi</application> daemon.</para>
426 <indexterm zone="avahi avahi-publish-service">
427 <primary sortas="b-avahi-publish-service">avahi-publish-service</primary>
428 </indexterm>
429 </listitem>
430 </varlistentry>
431
432 <varlistentry id="avahi-resolve">
433 <term><command>avahi-resolve</command></term>
434 <listitem>
435 <para>resolves one or more mDNS/DNS host name(s) to IP address(es)
436 (and vice versa) using the <application>Avahi</application>
437 daemon.</para>
438 <indexterm zone="avahi avahi-resolve">
439 <primary sortas="b-avahi-resolve">avahi-resolve</primary>
440 </indexterm>
441 </listitem>
442 </varlistentry>
443
444 <varlistentry id="avahi-resolve-address">
445 <term><command>avahi-resolve-address</command></term>
446 <listitem>
447 <para>resolves one or more mDNS/DNS host name(s) to IP address(es)
448 (and vice versa) using the <application>Avahi</application>
449 daemon.</para>
450 <indexterm zone="avahi avahi-resolve-address">
451 <primary sortas="b-avahi-resolve-address">avahi-resolve-address</primary>
452 </indexterm>
453 </listitem>
454 </varlistentry>
455
456 <varlistentry id="avahi-resolve-host-name">
457 <term><command>avahi-resolve-host-name</command></term>
458 <listitem>
459 <para>resolves one or more mDNS/DNS host name(s) to IP address(es)
460 (and vice versa) using the <application>Avahi</application>
461 daemon.</para>
462 <indexterm zone="avahi avahi-resolve-host-name">
463 <primary sortas="b-avahi-resolve-host-name">avahi-resolve-host-name</primary>
464 </indexterm>
465 </listitem>
466 </varlistentry>
467
468 <varlistentry id="avahi-set-host-name">
469 <term><command>avahi-set-host-name</command></term>
470 <listitem>
471 <para>changes the mDNS host name.</para>
472 <indexterm zone="avahi avahi-set-host-name">
473 <primary sortas="b-avahi-set-host-name">avahi-set-host-name</primary>
474 </indexterm>
475 </listitem>
476 </varlistentry>
477
478 <!--<varlistentry id="bshell">
479 <term><command>bshell</command></term>
480 <listitem>
481 <para>does this .....</para>
482 <indexterm zone="avahi bshell">
483 <primary sortas="b-bshell">bshell</primary>
484 </indexterm>
485 </listitem>
486 </varlistentry>-->
487
488 <varlistentry id="bssh">
489 <term><command>bssh</command></term>
490 <listitem>
491 <para>browses for SSH servers on the local network.</para>
492 <indexterm zone="avahi bssh">
493 <primary sortas="b-bssh">bssh</primary>
494 </indexterm>
495 </listitem>
496 </varlistentry>
497
498 <varlistentry id="bvnc">
499 <term><command>bvnc</command></term>
500 <listitem>
501 <para>browses for VNC servers on the local network.</para>
502 <indexterm zone="avahi bvnc">
503 <primary sortas="b-bvnc">bvnc</primary>
504 </indexterm>
505 </listitem>
506 </varlistentry>
507
508 <!--<varlistentry id="libavahi-client">
509 <term><filename class='libraryfile'>libavahi-client.{so,a}</filename></term>
510 <listitem>
511 <para>contains functions that .....</para>
512 <indexterm zone="avahi libavahi-client">
513 <primary sortas="c-libavahi-client">libavahi-client.{so,a}</primary>
514 </indexterm>
515 </listitem>
516 </varlistentry>
517
518 <varlistentry id="libavahi-common">
519 <term><filename class='libraryfile'>libavahi-common.{so,a}</filename></term>
520 <listitem>
521 <para>contains functions that .....</para>
522 <indexterm zone="avahi libavahi-common">
523 <primary sortas="c-libavahi-common">libavahi-common.{so,a}</primary>
524 </indexterm>
525 </listitem>
526 </varlistentry>
527
528 <varlistentry id="libavahi-core">
529 <term><filename class='libraryfile'>libavahi-core.{so,a}</filename></term>
530 <listitem>
531 <para>contains functions that .....</para>
532 <indexterm zone="avahi libavahi-core">
533 <primary sortas="c-libavahi-core">libavahi-core.{so,a}</primary>
534 </indexterm>
535 </listitem>
536 </varlistentry>
537
538 <varlistentry id="libavahi-glib">
539 <term><filename class='libraryfile'>libavahi-glib.{so,a}</filename></term>
540 <listitem>
541 <para>contains functions that .....</para>
542 <indexterm zone="avahi libavahi-glib">
543 <primary sortas="c-libavahi-glib">libavahi-glib.{so,a}</primary>
544 </indexterm>
545 </listitem>
546 </varlistentry>
547
548 <varlistentry id="libavahi-gobject">
549 <term><filename class='libraryfile'>libavahi-gobject.{so,a}</filename></term>
550 <listitem>
551 <para>contains functions that .....</para>
552 <indexterm zone="avahi libavahi-gobject">
553 <primary sortas="c-libavahi-gobject">libavahi-gobject.{so,a}</primary>
554 </indexterm>
555 </listitem>
556 </varlistentry>
557
558 <varlistentry id="libavahi-ui-gtk3">
559 <term><filename class='libraryfile'>libavahi-ui-gtk3.{so,a}</filename></term>
560 <listitem>
561 <para>contains functions that .....</para>
562 <indexterm zone="avahi libavahi-ui-gtk3">
563 <primary sortas="c-libavahi-ui-gtk3">libavahi-ui-gtk3.{so,a}</primary>
564 </indexterm>
565 </listitem>
566 </varlistentry>
567
568 <varlistentry id="libavahi-ui">
569 <term><filename class='libraryfile'>libavahi-ui.{so,a}</filename></term>
570 <listitem>
571 <para>contains functions that .....</para>
572 <indexterm zone="avahi libavahi-ui">
573 <primary sortas="c-libavahi-ui">libavahi-ui.{so,a}</primary>
574 </indexterm>
575 </listitem>
576 </varlistentry>
577
578 <varlistentry id="libdns_sd">
579 <term><filename class='libraryfile'>libdns_sd.{so,a}</filename></term>
580 <listitem>
581 <para>contains functions that .....</para>
582 <indexterm zone="avahi libdns_sd">
583 <primary sortas="c-libdns_sd">libdns_sd.{so,a}</primary>
584 </indexterm>
585 </listitem>
586 </varlistentry>
587
588 <varlistentry id="libhowl">
589 <term><filename class='libraryfile'>libhowl.{so,a}</filename></term>
590 <listitem>
591 <para>contains functions that .....</para>
592 <indexterm zone="avahi libhowl">
593 <primary sortas="c-libhowl">libhowl.{so,a}</primary>
594 </indexterm>
595 </listitem>
596 </varlistentry>-->
597
598 </variablelist>
599
600 </sect2>
601
602</sect1>
Note: See TracBrowser for help on using the repository browser.