source: networking/netutils/avahi.xml@ 096492a

systemd-13485
Last change on this file since 096492a was 54aaa89, checked in by Douglas R. Reno <renodr@…>, 8 years ago

Sync to trunk r17213
Added entity for GNOME-3.20

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

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