05/05: doc: Document 'avahi-service'.

[Ludovic Courtès]

civodul pushed a commit to branch master
in repository guix.

commit 965a7332201af37059bdaf97dc2ec21249bc9d32
Author: Ludovic Courtès <address@hidden>
Date:   Fri May 8 16:33:52 2015 +0200

    doc: Document 'avahi-service'.
    
    * gnu/services/avahi.scm (avahi-service): Add URL in docstring.
    * doc/guix.texi (Networking Services): Document it.
      (Name Service Switch): Fix cross-reference.
---
 doc/guix.texi          |   26 +++++++++++++++++++++++++-
 gnu/services/avahi.scm |    2 +-
 2 files changed, 26 insertions(+), 2 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index b44811f..e2465ee 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -4952,6 +4952,30 @@ This mechanism can prevent programs running locally, 
such as Web
 browsers, from accessing Facebook.
 @end defvr
 
+The @code{(gnu services avahi)} provides the following definition.
+
address@hidden {Monadic Procedure} avahi-service [#:avahi @var{avahi}] @
+          [#:host-name #f] [#:publish? #t] [#:ipv4? #t] @
+          [#:ipv6? #t] [#:wide-area? #f] @
+          [#:domains-to-browse '()]
+Return a service that runs @command{avahi-daemon}, a system-wide
+mDNS/DNS-SD responder that allows for service discovery and
+"zero-configuration" host name lookups (see @uref{http://avahi.org/}).
+
+If @var{host-name} is different from @code{#f}, use that as the host name to
+publish for this machine; otherwise, use the machine's actual host name.
+
+When @var{publish?} is true, publishing of host names and services is allowed;
+in particular, avahi-daemon will publish the machine's host name and IP
+address via mDNS on the local network.
+
+When @var{wide-area?} is true, DNS-SD over unicast DNS is enabled.
+
+Boolean values @var{ipv4?} and @var{ipv6?} determine whether to use IPv4/IPv6
+sockets.
address@hidden deffn
+
+
 @node X Window
 @subsubsection X Window
 
@@ -5248,7 +5272,7 @@ configuration file:
 @dots{} and then refer to @var{%my-base-services} instead of
 @var{%base-services} in the @code{operating-system} declaration.
 Lastly, this relies on the availability of the Avahi service
-(@pxref{Desktop Services, @code{avahi-service}}).
+(@pxref{Networking Services, @code{avahi-service}}).
 
 For convenience, the following variables provide typical NSS
 configurations.
diff --git a/gnu/services/avahi.scm b/gnu/services/avahi.scm
index 0a56f3d..a3ca5ab 100644
--- a/gnu/services/avahi.scm
+++ b/gnu/services/avahi.scm
@@ -63,7 +63,7 @@
                         (domains-to-browse '()))
   "Return a service that runs @command{avahi-daemon}, a system-wide
 mDNS/DNS-SD responder that allows for service discovery and
-\"zero-configuration\" host name lookups.
+\"zero-configuration\" host name lookups (see @uref{http://avahi.org/}).
 
 If @var{host-name} is different from @code{#f}, use that as the host name to
 publish for this machine; otherwise, use the machine's actual host name.