diff options
Diffstat (limited to 'man')
-rw-r--r-- | man/Makefile.am | 33 | ||||
-rw-r--r-- | man/avahi-bookmarks.1.xml.in | 17 | ||||
-rw-r--r-- | man/avahi-browse.1.xml.in | 63 | ||||
-rw-r--r-- | man/avahi-daemon.8.xml.in | 19 | ||||
-rw-r--r-- | man/avahi-daemon.conf.5.xml.in | 61 | ||||
-rw-r--r-- | man/avahi-dnsconfd.8.xml.in | 3 | ||||
-rw-r--r-- | man/avahi-resolve-address.1.xml.in | 60 | ||||
-rw-r--r-- | man/avahi-resolve-host-name.1.xml.in | 60 | ||||
-rw-r--r-- | man/avahi-resolve.1.xml.in | 107 |
9 files changed, 257 insertions, 166 deletions
diff --git a/man/Makefile.am b/man/Makefile.am index d80c885..4beb7cb 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -33,8 +33,7 @@ noinst_DATA = \ avahi-browse.1.xml \ avahi-publish-service.1.xml \ avahi-publish-address.1.xml \ - avahi-resolve-address.1.xml \ - avahi-resolve-host-name.1.xml \ + avahi-resolve.1.xml \ avahi-daemon.8.xml \ avahi-discover.1.xml \ avahi-bookmarks.1.xml \ @@ -46,18 +45,18 @@ noinst_DATA = \ CLEANFILES = \ $(noinst_DATA) -if HAVE_PYTHON if HAVE_DBUS man_MANS += \ avahi-browse.1 \ + avahi-resolve.1 + +if HAVE_PYTHON +man_MANS += \ avahi-publish-service.1 \ avahi-publish-address.1 \ - avahi-resolve-address.1 \ - avahi-resolve-host-name.1 \ avahi-discover.1 \ avahi-bookmarks.1 - endif endif @@ -73,11 +72,7 @@ avahi-publish-address.1.xml: avahi-publish-address.1.xml.in Makefile sed -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ -avahi-resolve-address.1.xml: avahi-resolve-address.1.xml.in Makefile - sed -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ - -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ - -avahi-resolve-host-name.1.xml: avahi-resolve-host-name.1.xml.in Makefile +avahi-resolve.1.xml: avahi-resolve.1.xml.in Makefile sed -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \ -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@ @@ -130,10 +125,7 @@ avahi-publish-service.1: avahi-publish-service.1.xml Makefile avahi-publish-address.1: avahi-publish-address.1.xml Makefile xmltoman $< > $@ -avahi-resolve-address.1: avahi-resolve-address.1.xml Makefile - xmltoman $< > $@ - -avahi-resolve-host-name.1: avahi-resolve-host-name.1.xml Makefile +avahi-resolve.1: avahi-resolve.1.xml Makefile xmltoman $< > $@ avahi-daemon.8: avahi-daemon.8.xml Makefile @@ -172,8 +164,7 @@ EXTRA_DIST = \ avahi-browse.1.xml.in \ avahi-publish-service.1.xml.in \ avahi-publish-address.1.xml.in \ - avahi-resolve-address.1.xml.in \ - avahi-resolve-host-name.1.xml.in \ + avahi-resolve.1.xml.in \ avahi-daemon.8.xml.in \ avahi-discover.1.xml.in \ avahi-bookmarks.1.xml.in \ @@ -184,3 +175,11 @@ EXTRA_DIST = \ xmltoman.css \ xmltoman.xsl \ xmltoman.dtd + + +if HAVE_DBUS + +install-exec-local: + cd $(DESTDIR)/$(mandir)/man1 && rm -f avahi-resolve-host-name.1 avahi-resolve-address.1 && $(LN_S) avahi-resolve.1 avahi-resolve-host-name.1 && $(LN_S) avahi-resolve.1 avahi-resolve-address.1 + +endif diff --git a/man/avahi-bookmarks.1.xml.in b/man/avahi-bookmarks.1.xml.in index 58c791c..f43fa46 100644 --- a/man/avahi-bookmarks.1.xml.in +++ b/man/avahi-bookmarks.1.xml.in @@ -30,12 +30,12 @@ </synopsis> <description> - <p>Web service showing mDNS/DNS-SD announced HTTP services using - the Avahi daemon. avahi-bookmarks opens an TCP port 8080 and - waits for incoming HTTP connections returning a dynamic web site - containing links to all services of type _http._tcp on the - LAN. Point your browser to http://localhost:8080/ to make use of - avahi-bookmarks.</p> + <p>A web service for listing HTTP services that are announced + via mDNS/DNS-SD using the Avahi daemon. avahi-bookmarks opens a + TCP socket on port 8080 and waits for incoming HTTP connections + returning a dynamic web site containing links to all services of + type _http._tcp on the LAN. Point your browser to + http://localhost:8080/ to make use of avahi-bookmarks.</p> </description> @@ -58,6 +58,11 @@ mDNS host names (e.g. nss-mdns).</p></optdesc> </option> + <option> + <p><opt>-d | --domain</opt> <arg>DOMAIN</arg></p> + <optdesc><p>The domain to browse for services in.</p></optdesc> + </option> + <option> <p><opt>-h | --help</opt></p> <optdesc><p>Show help</p></optdesc> diff --git a/man/avahi-browse.1.xml.in b/man/avahi-browse.1.xml.in index b6f2da1..6bf8103 100644 --- a/man/avahi-browse.1.xml.in +++ b/man/avahi-browse.1.xml.in @@ -28,11 +28,11 @@ <synopsis> <cmd>avahi-browse [<arg>options</arg>] <arg>service-type</arg></cmd> <cmd>avahi-browse [<arg>options</arg>] <opt>--all</opt></cmd> - <cmd>avahi-browse <opt>--help</opt></cmd> + <cmd>avahi-browse [<arg>options</arg>] <opt>--browse-domains</opt></cmd> </synopsis> <description> - <p>Browse for mDNS/DNS-SD network services using the Avahi daemon.</p> + <p>Browse for mDNS/DNS-SD network services and browsing domains using the Avahi daemon.</p> </description> @@ -40,23 +40,68 @@ <p>Specify a DNS-SD service type (e.g. _http._tcp) to browse for on the command line, or <opt>-a</opt> to browse for all - available service types.</p> + available service types. Items that appear on the network are prefixed with "+", items that disappear are prefixed with "-".</p> - <option> + <option> <p><opt>-a | --all</opt></p> <optdesc><p>Browse for all service types registered on the LAN, not just the one specified on the command line.</p></optdesc> </option> - <option> + <option> + <p><opt>-D | --browse-domains</opt></p> + <optdesc><p>Browse for browsing domains instead for services.</p></optdesc> + </option> + + <option> <p><opt>-d | --domain=</opt> <arg>DOMAIN</arg></p> - <optdesc><p>Just browse in the specified domain. If omited - avahi-browse will browse in .local and all other browse - domains announced on the LAN.</p></optdesc> + <optdesc><p>Browse in the specified domain. If omitted + avahi-browse will browse in the default browsing domain + (usually .local)</p></optdesc> </option> + <option> + <p><opt>-v | --verbose</opt></p> + <optdesc><p>Enable verbose mode.</p></optdesc> + </option> + + <option> + <p><opt>-t | --terminate</opt></p> + <optdesc><p>Terminate after dumping a more or less complete list.</p></optdesc> + </option> + + <option> + <p><opt>-c | --cache</opt></p> + <optdesc><p>Terminate after dumping all entries available in the cache.</p></optdesc> + </option> + + <option> + <p><opt>-l | --ignore-local</opt></p> + <optdesc><p>Ignore local services, show only remote services.</p></optdesc> + </option> + <option> <p><opt>-h | --help</opt></p> - <optdesc><p>Show help</p></optdesc> + <optdesc><p>Show help.</p></optdesc> + </option> + + <option> + <p><opt>-r | --resolve</opt></p> + <optdesc><p>Automatically resolve services found.</p></optdesc> + </option> + + <option> + <p><opt>-f | --no-fail</opt></p> + <optdesc><p>Don't fail if the service is not found running. Instead, wait until it appears. If it disconnects, try to reconnect.</p></optdesc> + </option> + + <option> + <p><opt>-k | --no-db-lookup</opt></p> + <optdesc><p>Don't lookup services types in service type database.</p></optdesc> + </option> + + <option> + <p><opt>-V | --version</opt></p> + <optdesc><p>Show version information.</p></optdesc> </option> </options> diff --git a/man/avahi-daemon.8.xml.in b/man/avahi-daemon.8.xml.in index ce8ab81..1c949be 100644 --- a/man/avahi-daemon.8.xml.in +++ b/man/avahi-daemon.8.xml.in @@ -30,8 +30,6 @@ <cmd>avahi-daemon <opt>--kill</opt></cmd> <cmd>avahi-daemon <opt>--reload</opt></cmd> <cmd>avahi-daemon <opt>--check</opt></cmd> - <cmd>avahi-daemon <opt>--version</opt></cmd> - <cmd>avahi-daemon <opt>--help</opt></cmd> </synopsis> <description> @@ -88,6 +86,19 @@ <optdesc><p>Don't drop root priviliges after startup and don't require daemon to be started as root. We recommend not to use this option.</p></optdesc> </option> + <option> + <p><opt>--no-chroot</opt></p> + <optdesc><p>Don't <manref section="2" name="chroot"/> the daemon. This option is only available when compiled with chroot() support.</p></optdesc> + </option> + + <option> + <p><opt>--no-proctitle</opt></p> + <optdesc><p>Don't change the process name while + running. Unless this option is specified avahi will reflect + it's current state and selected host name in the process + title.</p></optdesc> + </option> + <option> <p><opt>-k | --kill</opt></p> <optdesc><p>Kill an already running avahi-daemon. (equivalent to sending a SIGTERM)</p></optdesc> @@ -101,7 +112,7 @@ <file>avahi-daemon.conf</file>) the files from <file>@servicedir@/</file>. Please note that this will not reload the - <file>@pkgsysconfdir@/avahi-daemon.conf</file>(equivalent to + <file>@pkgsysconfdir@/avahi-daemon.conf</file>. (equivalent to sending a SIGHUP)</p></optdesc> </option> @@ -120,10 +131,8 @@ <optdesc><p>Show version information </p></optdesc> </option> - </options> - <section name="Files"> <p><file>@pkgsysconfdir@/avahi-daemon.conf</file>: the default configuration file for avahi-daemon.</p> diff --git a/man/avahi-daemon.conf.5.xml.in b/man/avahi-daemon.conf.5.xml.in index 89aa38e..030d82d 100644 --- a/man/avahi-daemon.conf.5.xml.in +++ b/man/avahi-daemon.conf.5.xml.in @@ -42,9 +42,21 @@ </option> <option> - <p><opt>domain-name=</opt> Set the domain name avahi-domain + <p><opt>domain-name=</opt> Set the default domain name avahi-daemon tries to register its host name and services on the LAN in. If - omited defaults to ".local".</p> + omitted defaults to ".local".</p> + </option> + + <option> + <p><opt>browse-domains=</opt> Set a comma seperated list of + browsing domains (in addition to the default one and those + announced inside the default browsing domain). Please note + that the user may specify additional browsing domains on the + client side, either by setting $AVAHI_BROWSE_DOMAINS to a list + of colon seperated domains or by adding them to the XDG config + file <file>~/.config/avahi/browse-domains</file> (seperated by + newlines).</p> + </option> <option> @@ -93,6 +105,47 @@ </option> <option> + <p><opt>disallow-other-stacks=</opt> Takes a boolean value + ("yes" or "no"). If set to "yes", no other process is allowed + to bind to UDP port 5353. This effectively impedes other mDNS + stacks from running on the host. Use this as a security + measure to make sure that only Avahi is responsible for mDNS + traffic. Please note that we do no recommend running multiple + mDNS stacks on the same host simultaneously. This hampers + reliability and is a waste of resources. However, to not annoy + people this option defaults to "no".</p> + </option> + + </section> + + <section name="Section [wide-area]"> + <option> + <p><opt>enable-wide-area=</opt> Enable wide-area DNS-SD, aka + DNS-SD over unicast DNS. If this is enabled only domains + ending in .local will be resolved on mDNS, all other domains + are resolved via unicast DNS. If you want to maintain multiple + different multicast DNS domains even with this option enabled + we encourage you to use subdomains of .local, such as + "kitchen.local". This option defaults to "yes".</p> + </option> + + </section> + + <section name="Section [publish]"> + + <option><p><opt>disable-publishing=</opt> Takes a boolean value + ("yes" or "no"). If set to "yes", no record will be published by + Avahi, not even address records for the local host. Avahi will + be started in a querying-only mode. Use this is a security + measure. This option defaults to "no"</p></option> + + <option><p><opt>disable-publishing=</opt> Takes a boolean value + ("yes" or "no"). If set to "yes", Avahi will still publish + address records and suchlike but will not allow user + applications to publish services. Use this is a security + measure. This option defaults to "no"</p></option> + + <option> <p><opt>add-service-cookie=</opt> Takes a boolean value ("yes" or "no"). If set to "yes" an implicit TXT entry will be added to all locally registered services, containing a cookie value @@ -102,10 +155,6 @@ "yes".</p> </option> - - </section> - - <section name="Section [publish]"> <option> <p><opt>publish-addresses=</opt> Takes a boolean value ("yes" or "no"). If set to "yes" avahi-daemon will register mDNS diff --git a/man/avahi-dnsconfd.8.xml.in b/man/avahi-dnsconfd.8.xml.in index 6532319..4348d74 100644 --- a/man/avahi-dnsconfd.8.xml.in +++ b/man/avahi-dnsconfd.8.xml.in @@ -30,8 +30,6 @@ <cmd>avahi-dnsconfd <opt>--kill</opt></cmd> <cmd>avahi-dnsconfd <opt>--refresh</opt></cmd> <cmd>avahi-dnsconfd <opt>--check</opt></cmd> - <cmd>avahi-dnsconfd <opt>--version</opt></cmd> - <cmd>avahi-dnsconfd <opt>--help</opt></cmd> </synopsis> <description> @@ -76,7 +74,6 @@ </options> - <section name="Files"> <p><file>@pkgsysconfdir@/dnsconf.action</file>: the script to run when a DNS server is found or removed.</p> diff --git a/man/avahi-resolve-address.1.xml.in b/man/avahi-resolve-address.1.xml.in deleted file mode 100644 index 234f1f3..0000000 --- a/man/avahi-resolve-address.1.xml.in +++ /dev/null @@ -1,60 +0,0 @@ -<?xml version="1.0"?><!--*-nxml-*--> -<!DOCTYPE manpage SYSTEM "xmltoman.dtd"> -<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?> - -<!-- $Id$ --> - -<!-- - This file is part of avahi. - - avahi is free software; you can redistribute it and/or modify it - under the terms of the GNU Lesser General Public License as - published by the Free Software Foundation; either version 2.1 of the - License, or (at your option) any later version. - - avahi is distributed in the hope that it will be useful, but WITHOUT - ANY WARRANTY; without even the implied warranty of MERCHANTABILITY - or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General - Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with avahi; if not, write to the Free Software - Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 - USA. ---> - - <manpage name="avahi-resolve-address" section="1" desc="Resolve one or more IP address(es) to mDNS host name(s) using the Avahi daemon"> - - <synopsis> - <cmd>avahi-resolve-address <arg>address ...</arg></cmd> - </synopsis> - - <description> - <p>Resolve one or more IP address(es) to mDNS host name(s) using the Avahi daemon ("reverse name lookup").</p> - </description> - - <options> - - <p>Specify one or more IP address(es) (e.g. "192.168.50.1" or "2001:db8:0:1::1") for being resolved into host names on the command line.</p> - - </options> - - <section name="Authors"> - <p>The avahi developers <@PACKAGE_BUGREPORT@>; avahi is - available from <url href="@PACKAGE_URL@"/></p> - </section> - - <section name="See also"> - <p> - <manref name="avahi-publish-address" section="1"/>, <manref - name="avahi-resolve-host-name" section="1"/>, <manref - name="avahi-daemon" section="8"/> - </p> - </section> - - <section name="Comments"> - <p>This man page was written using <manref name="xml2man" section="1" - href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p> - </section> - - </manpage> diff --git a/man/avahi-resolve-host-name.1.xml.in b/man/avahi-resolve-host-name.1.xml.in deleted file mode 100644 index 9c9b0a6..0000000 --- a/man/avahi-resolve-host-name.1.xml.in +++ /dev/null @@ -1,60 +0,0 @@ -<?xml version="1.0"?><!--*-nxml-*--> -<!DOCTYPE manpage SYSTEM "xmltoman.dtd"> -<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?> - -<!-- $Id$ --> - -<!-- - This file is part of avahi. - - avahi is free software; you can redistribute it and/or modify it - under the terms of the GNU Lesser General Public License as - published by the Free Software Foundation; either version 2.1 of the - License, or (at your option) any later version. - - avahi is distributed in the hope that it will be useful, but WITHOUT - ANY WARRANTY; without even the implied warranty of MERCHANTABILITY - or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General - Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with avahi; if not, write to the Free Software - Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 - USA. ---> - - <manpage name="avahi-resolve-host-name" section="1" desc="Resolve one or more mDNS host name(s) to IP address(es) using the Avahi daemon"> - - <synopsis> - <cmd>avahi-resolve-host-name <arg>host-name ...</arg></cmd> - </synopsis> - - <description> - <p>Resolve one or more mDNS host name(s) to IP address(es) using the Avahi daemon</p> - </description> - - <options> - - <p>Specify one or more mDNS host name(s) (e.g. "foo.local") for being resolved into IP addresses on the command line.</p> - - </options> - - <section name="Authors"> - <p>The avahi developers <@PACKAGE_BUGREPORT@>; avahi is - available from <url href="@PACKAGE_URL@"/></p> - </section> - - <section name="See also"> - <p> - <manref name="avahi-publish-address" section="1"/>, <manref - name="avahi-resolve-address" section="1"/>, <manref - name="avahi-daemon" section="8"/> - </p> - </section> - - <section name="Comments"> - <p>This man page was written using <manref name="xml2man" section="1" - href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p> - </section> - - </manpage> diff --git a/man/avahi-resolve.1.xml.in b/man/avahi-resolve.1.xml.in new file mode 100644 index 0000000..f3691b9 --- /dev/null +++ b/man/avahi-resolve.1.xml.in @@ -0,0 +1,107 @@ +<?xml version="1.0"?><!--*-nxml-*--> +<!DOCTYPE manpage SYSTEM "xmltoman.dtd"> +<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?> + +<!-- $Id$ --> + +<!-- + This file is part of avahi. + + avahi is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as + published by the Free Software Foundation; either version 2.1 of the + License, or (at your option) any later version. + + avahi is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY + or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General + Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with avahi; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 + USA. +--> + + <manpage name="avahi-resolve" section="1" desc="Resolve one or more mDNS/DNS host name(s) to IP address(es) (and vice versa) using the Avahi daemon"> + + <synopsis> + <cmd>avahi-resolve --name <arg>host-name ...</arg></cmd> + <cmd>avahi-resolve-host-name <arg>host-name ...</arg></cmd> + <cmd>avahi-resolve --address <arg>address ...</arg></cmd> + <cmd>avahi-resolve-address <arg>address ...</arg></cmd> + </synopsis> + + <description> + <p>Resolve one or more mDNS/DNS host name(s) to IP address(es) (and vice versa) using the Avahi daemon.</p> + </description> + + <options> + + <p>When passing -n, specify one or more fully qualified mDNS/DNS host name(s) + (e.g. "foo.local") to resolve into IP addresses on the + command line. When passing -a, specifiy one or more IP address + to resolve into host names.</p> + + <p>avahi-resolve-host-name is equivalent to avahi-resolve --name.</p> + + <p>avahi-resolve-address is equivalent to avahi-resolve --address.</p> + + <option> + <p><opt>-n | --name</opt></p> + <optdesc><p>Translate one or more fully qualified host names into addresses.</p></optdesc> + </option> + + <option> + <p><opt>-a | --address</opt></p> + <optdesc><p>Translate one or more addresses into fully qualified host names.</p></optdesc> + </option> + + <option> + <p><opt>-v | --verbose</opt></p> + <optdesc><p>Enable verbose mode.</p></optdesc> + </option> + + <option> + <p><opt>-6</opt></p> + <optdesc><p>When resolving a host name, look for IPv6 addresses exclusively.</p></optdesc> + </option> + + <option> + <p><opt>-4</opt></p> + <optdesc><p>When resolving a host name, look for IPv4 addresses exclusively.</p></optdesc> + </option> + + <option> + <p><opt>-h | --help</opt></p> + <optdesc><p>Show help.</p></optdesc> + </option> + + + <option> + <p><opt>-V | --version</opt></p> + <optdesc><p>Show version information.</p></optdesc> + </option> + + + </options> + + <section name="Authors"> + <p>The avahi developers <@PACKAGE_BUGREPORT@>; avahi is + available from <url href="@PACKAGE_URL@"/></p> + </section> + + <section name="See also"> + <p> + <manref name="avahi-publish-address" section="1"/>, + <manref + name="avahi-daemon" section="8"/> + </p> + </section> + + <section name="Comments"> + <p>This man page was written using <manref name="xml2man" section="1" + href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p> + </section> + + </manpage> |