source: networking/netutils/avahi-systemd.xml@ 4b422698

systemd-11177
Last change on this file since 4b422698 was 10a6c8d, checked in by Krejzi <krejzi@…>, 10 years ago

Merge some more of Christopher's work into systemd branch.

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