]> git.meshlink.io Git - catta/commitdiff
* Man page for avahi-browse
authorLennart Poettering <lennart@poettering.net>
Sat, 6 Aug 2005 21:05:35 +0000 (21:05 +0000)
committerLennart Poettering <lennart@poettering.net>
Sat, 6 Aug 2005 21:05:35 +0000 (21:05 +0000)
git-svn-id: file:///home/lennart/svn/public/avahi/trunk@250 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe

configure.ac
man/avahi-browse.1.xml.in
man/xmltoman.css
man/xmltoman.dtd
man/xmltoman.xsl

index e1524383a7296df5ef3c1882d4917baf484d296c..d62397a08d497a8de5a2a4ab2c92efdc6a35eb16 100644 (file)
@@ -21,7 +21,7 @@
 # USA.
 
 AC_PREREQ(2.57)
-AC_INIT([avahi],[0.1],[mzninuv (at) 0pointer (dot) de])
+AC_INIT([avahi],[0.1],[avahi (at) lists (dot) freedesktop (dot) org])
 AC_CONFIG_SRCDIR([avahi-core/server.c])
 AC_CONFIG_HEADERS([config.h])
 AM_INIT_AUTOMAKE([foreign 1.9 -Wall])
index e9fb2c20fe8a1be23ce89a42ffa0aecee9655980..832fda0ca4e151088a74342664d66d37248edefa 100644 (file)
-<?xml version="1.0"?>
+<?xml version="1.0"?><!--*-nxml-*-->
 <!DOCTYPE manpage SYSTEM "xmltoman.dtd">
 <?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
 
-<!-- $Id: ifplugstatus.8.xml.in 110 2004-05-10 21:32:00Z lennart $ -->
+<!-- $Id$ -->
 
 <!-- 
-  This file is part of ifplugd.
-
-  ifplugd is free software; you can redistribute it and/or modify it under
-  the terms of the GNU General Public License as published by the Free
-  Software Foundation; either version 2 of the License, or (at your
-  option) any later version.
-
-  ifplugd 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 General Public License
-  for more details.
-
-  You should have received a copy of the GNU General Public License
-  along with ifplugd; if not, write to the Free Software Foundation,
-  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 
+  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="ifplugstatus" section="8" desc="A link beat detection tool">
+  <manpage name="avahi-browse" section="1" desc="Browse for mDNS/DNS-SD services using the Avahi daemon">
 
        <synopsis>
-         <cmd>ifplugstatus [<arg>options</arg>] [<arg>INTERFACE</arg>]</cmd>
+      <cmd>avahi-browse [<arg>options</arg>] <arg>service-type</arg></cmd>
+      <cmd>avahi-browse [<arg>options</arg>] <opt>-a</opt></cmd>
+      <cmd>avahi-browse <opt>-h</opt></cmd>
        </synopsis>
        
-       <description>
-         <p>ifplugstatus is an utility which may be used to detect the link
-         status of a local Linux ethernet device, much in the same way
-         mii-diag, mii-tool and ethtool work. In fact it supports all
-         three different APIs these three tools use. In addition it supports
-         link checking with the IFF_RUNNING interface flag, which most modern 
-         drivers (not only ethernet) support, and association status checking 
-         with the wireless extension API for WLAN devices.</p>
-         
-         <p>The APIs are tried in the following order:</p>
-        
-         <p>First the newest API: <arg>SIOCETHTOOL</arg> (aka ethtool API)</p>
-         <p>Second the next older API: <arg>SIOCGMIIREG</arg> (aka mii-diag API)</p>
-         <p>Than the WLAN API: <arg>wireless extension</arg> (aka iwconfig API)</p>
-         <p>Followed by the cleanest API: <arg>IFF_RUNNING</arg> (aka ifconfig API)</p>
-         
-      <p>The oldest API (<arg>SIOCPRIV</arg> aka mii-tool API) is not tested since it is obsolete.</p>
-         
-         <p>ifplugstatus may be used in shell script since it returns the
-         current status as return value. It is especially useful to
-         detect the available APIs on the used network driver. (Option 
-         <opt>-v</opt>)</p>
+    <description>
+      <p>Browse for mDNS/DNS-SD network services using the Avahi daemon.</p>
+      
        </description>
        
        <options>
 
-         <p>You may specify an ethernet device on the command
-         line. Otherwise ifplugstatus will check all available network interfaces.</p>
+      <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>
          
          <option>
-               <p><opt>-a | --auto</opt></p>
-               <optdesc><p>
-                       Enable interface automatically before querying (default: off)
-                 </p></optdesc>
+               <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>
                <p><opt>-h | --help</opt></p>
-               <optdesc><p>
-                       Show help
-                 </p></optdesc>
+               <optdesc><p>Show help</p></optdesc>
          </option>
 
          <option>
-               <p><opt>-q | --quiet</opt></p> <optdesc><p>Decrease verbosity
-               by one. If the verbosity is &lt; 0, no text will be shown,
-               only the return value is relevant; if the verbosity is = 0, a
-               terse status will be shown; If the verbosity is &gt; 0,
-               detailed information about the used API is returned. (By
-               default the verbosity is 0)</p></optdesc>
+               <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>
          </option>
 
-         <option>
-               <p><opt>-v | --verbose</opt></p>
-               <optdesc><p>
-                       Increase verbosity by one. See option <opt>-q</opt>.
-                 </p></optdesc>
-         </option>
-         
-         <option>
-               <p><opt>-V | --version</opt></p>
-               <optdesc><p>
-                       Show version
-                 </p></optdesc>
-         </option>
-         
        </options>
        
-       <section name="Return values">
-         <p><arg>0</arg> Success</p>
-         <p><arg>1</arg> Failure</p>
-         <p><arg>2</arg> Link beat detected (only available when an interface is specified)</p>
-         <p><arg>3</arg> Unplugged (same here)</p>
-       </section>
-       
-       <section name="Author">
-         <p>ifplugd was written by Lennart Poettering
-               &lt;@PACKAGE_BUGREPORT@&gt;.  ifplugd is available
-               at <url
-               href="@PACKAGE_URL@"/>
-         </p>
+       <section name="Authors">
+         <p>The avahi developers &lt;@PACKAGE_BUGREPORT@&gt;; avahi is
+         available from <url href="@PACKAGE_URL@"/></p>
        </section>
        
        <section name="See also">
          <p>
-               <manref name="mii-diag" section="8"/>, <manref name="mii-tool"
-                 section="8"/>, <manref name="ethtool" section="8"/>, <manref name="ifplugd" section="8"/>
+        <manref name="avahi-publish-service" section="1"/>, <manref name="avahi-daemon" section="8"/>
          </p>
        </section>
        
index caab6047a0da99a3347484c3ef1780a08c2f79d0..4c80847bd061f7310538da6232f5b5d7a6cc1db6 100644 (file)
@@ -1,27 +1,27 @@
-/* $Id: xmltoman.css 52 2003-10-17 00:09:23Z lennart $ */
+/* $Id$ */
 
 /***
-  This file is part of ifplugd.
+  This file is part of avahi.
 
-  ifplugd is free software; you can redistribute it and/or modify it under
+  avahi is free software; you can redistribute it and/or modify it under
   the terms of the GNU General Public License as published by the Free
   Software Foundation; either version 2 of the License, or (at your
   option) any later version.
 
-  ifplugd is distributed in the hope that it will be useful, but WITHOUT
+  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 General Public License
   for more details.
 
   You should have received a copy of the GNU General Public License
-  along with ifplugd; if not, write to the Free Software Foundation,
+  along with avahi; if not, write to the Free Software Foundation,
   Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 
 ***/
 
-body { color: black; background-color: white; margin: 0.5cm; 
+body { color: black; background-color: white; } 
 a:link, a:visited { color: #900000; }       
-h1 { text-transform:uppercase; font-size: 18pt; color: #00009F; }
-p { margin-left:1cm; margin-right:1cm; }
+h1 { text-transform:uppercase; font-size: 18pt; 
+p { margin-left:1cm; margin-right:1cm; } 
 .cmd { font-family:monospace; }
 .file { font-family:monospace; }
 .arg { text-transform:uppercase; font-family:monospace; font-style: italic; }
index 42809db0813f6d9d5a8f41f97495473c95d316bd..018e1d87bf0f584b733cfed74b59b0cf3003e0fc 100644 (file)
@@ -1,20 +1,20 @@
-<!-- $Id: xmltoman.dtd 60 2003-10-20 22:05:22Z lennart $ -->
+<!-- $Id$ -->
 
 <!-- 
-  This file is part of ifplugd.
+  This file is part of avahi.
 
-  ifplugd is free software; you can redistribute it and/or modify it under
+  avahi is free software; you can redistribute it and/or modify it under
   the terms of the GNU General Public License as published by the Free
   Software Foundation; either version 2 of the License, or (at your
   option) any later version.
 
-  ifplugd is distributed in the hope that it will be useful, but WITHOUT
+  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 General Public License
   for more details.
 
   You should have received a copy of the GNU General Public License
-  along with ifplugd; if not, write to the Free Software Foundation,
+  along with avahi; if not, write to the Free Software Foundation,
   Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 
 -->
 
index 2048708e319f46cd1416579129445dc457ff5a69..7bf78ac01e871112a38f252094a0ab54f0a2bc07 100644 (file)
@@ -2,20 +2,20 @@
 <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml">
 
 <!-- 
-  This file is part of ifplugd.
+  This file is part of avahi.
 
-  ifplugd is free software; you can redistribute it and/or modify it under
+  avahi is free software; you can redistribute it and/or modify it under
   the terms of the GNU General Public License as published by the Free
   Software Foundation; either version 2 of the License, or (at your
   option) any later version.
 
-  ifplugd is distributed in the hope that it will be useful, but WITHOUT
+  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 General Public License
   for more details.
 
   You should have received a copy of the GNU General Public License
-  along with ifplugd; if not, write to the Free Software Foundation,
+  along with avahi; if not, write to the Free Software Foundation,
   Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 
 -->