* documentation update

* embed CSS data in xmltoman.xsl git-svn-id: file:///home/lennart/svn/public/avahi/trunk@274 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe
author: Lennart Poettering <lennart@poettering.net> 2005-08-08 17:32:25 +0000
committer: Lennart Poettering <lennart@poettering.net> 2005-08-08 17:32:25 +0000
commit: 9ad2a95c80ab0f9cf48d3f58e9a7ed6f06685c34 (patch)
tree: 2db6a9e1969ca9e9cb916759c0c7e8f15cf8dbdc
parent: 0556d428a56bdc4dac52d6eed2c515e66958094e (diff)
6 files changed, 164 insertions, 83 deletions
diff --git a/Makefile.am b/Makefile.am
index 2523408..1ce7f76 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -27,8 +27,9 @@ EXTRA_DIST = \
 	$(DX_CONFIG) \
 	docs/INSTALL \
 	docs/TODO \
-	docs/DBUS-API \
 	docs/README \
+	docs/DBUS-API \
+	docs/AUTHORS \
 	docs/HACKING \
 	docs/overview.dia
 
@@ -50,4 +51,8 @@ pkgconfig_DATA = avahi-core.pc
 
 MOSTLYCLEANFILES = $(DX_CLEANFILES)
 
-#.PHONY: distcleancheck
+homepage:
+	scp avahi-daemon/*.introspect avahi-daemon/introspect.dtd avahi-daemon/introspect.xsl\
+	    man/*.xml man/xmltoman.dtd man/xmltoman.xsl \
+	    fdo:public_html/
+	    
diff --git a/avahi-daemon/introspect.xsl b/avahi-daemon/introspect.xsl
index 38b443c..32a371c 100644
--- a/avahi-daemon/introspect.xsl
+++ b/avahi-daemon/introspect.xsl
@@ -1,35 +1,52 @@
 <?xml version="1.0" encoding="iso-8859-15"?>
+<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml">
 
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+<!-- 
+  This file is part of avahi.
 
-  <!-- $Id$ -->
+  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.
 
-  <xsl:output method="xml" version="1.0" encoding="iso-8859-15" doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN" doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" indent="yes"/>
+  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.
 
-  <xsl:template match="/">
-    <html xmlns="http://www.w3.org/1999/xhtml">
-      <head>
-        <title>DBUS Introspection data</title>
-        <style type="text/css">
-          body { color: black; background-color: white } 
-          h1 { font-family: sans-serif }
-          ul { list-style-type: none; margin-bottom: 10px }
-          li { font-family: sans-serif }
-          .keyword { font-style: italic }
-          .type { font-weight: bold }
-          .symbol { font-family: monospace }
-          .interface { padding: 10px; margin: 10px }
-        </style>
-      </head>
-      <body>
-        <xsl:for-each select="node/interface">
-          <div class="interface">
-            <h1>
-              <span class="keyword">interface</span><xsl:text> </xsl:text>
-              <span class="symbol"><xsl:value-of select="@name"/></span>
-            </h1>   
-            
-            <ul>
+  You should have received a copy of the GNU 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. 
+-->
+
+<!-- $Id$ -->
+
+<xsl:output method="xml" version="1.0" encoding="iso-8859-15" doctype-public="-//W3C//DTD XHTML 1.0 Strict//EN" doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" indent="yes"/>
+
+<xsl:template match="/">
+  <html>
+    <head>
+      <title>DBUS Introspection data</title>
+      <style type="text/css">
+        body { color: black; background-color: white } 
+        h1 { font-family: sans-serif }
+        ul { list-style-type: none; margin-bottom: 10px }
+        li { font-family: sans-serif }
+        .keyword { font-style: italic }
+        .type { font-weight: bold }
+        .symbol { font-family: monospace }
+        .interface { padding: 10px; margin: 10px }
+      </style>
+    </head>
+    <body>
+      <xsl:for-each select="node/interface">
+        <div class="interface">
+          <h1>
+            <span class="keyword">interface</span><xsl:text> </xsl:text>
+            <span class="symbol"><xsl:value-of select="@name"/></span>
+          </h1>   
+          
+          <ul>
 
             <xsl:apply-templates select="annotation"/> 
 
@@ -68,20 +85,20 @@
               </li>
             </xsl:for-each>
 
-            </ul>
-          </div>
-        </xsl:for-each>
-      </body>
-    </html>
-  </xsl:template>
+          </ul>
+        </div>
+      </xsl:for-each>
+    </body>
+  </html>
+</xsl:template>
 
 
-  <xsl:template match="annotation"> 
-    <li xmlns="http://www.w3.org/1999/xhtml">
-      <span class="keyword">annotation</span>
-      <code><xsl:value-of select="@name"/></code><xsl:text> = </xsl:text>
-      <code><xsl:value-of select="@value"/></code>
-    </li>
-  </xsl:template>
+<xsl:template match="annotation"> 
+  <li>
+    <span class="keyword">annotation</span>
+    <code><xsl:value-of select="@name"/></code><xsl:text> = </xsl:text>
+    <code><xsl:value-of select="@value"/></code>
+  </li>
+</xsl:template>
 
 </xsl:stylesheet>
diff --git a/docs/AUTHORS b/docs/AUTHORS
new file mode 100644
index 0000000..f1428cf
--- /dev/null
+++ b/docs/AUTHORS
@@ -0,0 +1,5 @@
+Lennart Poettering
+Trent Lloyd
+Sebastien Estienne
+
+$Id$
diff --git a/docs/INSTALL b/docs/INSTALL
index d6b134e..d7b3974 100644
--- a/docs/INSTALL
+++ b/docs/INSTALL
@@ -1,36 +1,46 @@
-*** Quick install instructions (tested on debian/ubuntu only!) ***
+*** Quick install instructions (tested on Debian/Ubuntu only!) ***
 
-While "make" and "boostrap.sh" may be run as normal users all other commands
-need to be run is root.
+While "configure" and "make" may be run as normal user all other commands
+need to be run as root.
 
-$ ./bootstrap.sh
-	(this will run autoconf/automake)
+Configure the build system:
+	$ ./configure --sysconfdir=/etc --localstatedir=/var
 
-$ ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
+Some configure options available:
 
-Extra configure options available:
-
-    --enable-gtk             use GTK+    (default=yes)
-    --enable-dbus            use DBus    (default=yes)
+    --disable-gtk            disable GTK+ tools                (default: enabled)
+    --disable-dbus           disable DBUS support              (default: enabled)
+    --disable-python         disable building python modules   (default: enabled)
     --with-dbus-sys=<dir>    where D-BUS system.d directory is
     --with-distro=<distro>   the target Linux distribution (one of redhat,
                                     suse, gentoo, debian or slackware)
     --with-avahi-user=<user> User for running the Avahi daemon (avahi)
     --with-avahi-group=<grp> Group for Avahi (avahi)
 
-$ make
-# make install
+    Please note that by disabling DBUS you lose the ability to publish and browse
+    services from local applications.
+
+    Please note that only the Debian init script is currently up-to-date. 
+    YMMV on other distributions. Patches welcome!
+
+	$ make
+	# make install
+
+Add a user an a group for avahi. (Debian specific)
+	# addgroup --system avahi
+	# adduser --system --no-create-home --ingroup avahi avahi
+
+Ask DBUS to re-read its policies:
+	# kill -HUP `cat /var/run/dbus/pid`
 
-# addgroup --system avahi
-# adduser --system --no-create-home --ingroup avahi avahi
-	(These commands are Debian specific and may be different on other
-	distributions)
+Now start the Avahi daemon:
+	# /etc/init.d/avahi-daemon start
 
-# kill -HUP `cat /var/run/dbus/pid`
-	(This will ask DBUS to re-read its policies)
-# /etc/dbus-1/event.d/75avahi-daemon start
+Optionally start the unicast DNS configuration daemon:
+	# /etc/init.d/avahi-dnsconfd start
 
-- To automatically start avahi-dnsconfd on Debian based distro:
-# update-rc.d avahi-dnsconfd defaults 25 15
+To start the two daemons on Debian based distributions automatically:
+	# update-rc.d avahi-daemon defaults 25 15
+	# update-rc.d avahi-dnsconfd defaults 26 14
 
 $Id$
diff --git a/docs/README b/docs/README
index dfaf409..37aaf2c 100644
--- a/docs/README
+++ b/docs/README
@@ -1,11 +1,46 @@
-* Quick start guide:
-0) make sure you read the INSTALL file.
-1) start the deamon in background as root: avahi-daemon -D
-Or (You shouldn't start avahi-daemon and avahi-discover at the same time.) 
-1) start the Gui to browse zeroconf network as your user: avahi-discover
+Avahi is a free, LGPL mDNS/DNS-SD implementation.
 
+Copyright 2004, 2005 by the Avahi developers.
 
-* Basic instructions to control the avahi deamon (as root):
-- starting it:			avahi-daemon
-- starting it in background:	avahi-daemon -D
-- stopping it:			avahi-daemon -k
+	http://www.freedesktop.org/Software/Avahi
+
+Avahi has a mailing list:
+
+	http://lists.freedesktop.org/mailman/listinfo/avahi
+
+You have a chance to meet the developers on
+
+	#avahi on irc.freenode.org
+
+Please report bugs to the freedesktop.org bugzilla:
+
+	http://bugs.freedesktop.org/
+
+Avahi's SVN repository is freely accessible:
+
+	svn checkout svn://svn.0pointer.de/flexmdns/trunk avahi
+
+	http://0pointer.de/cgi-bin/viewcvs.cgi/?root=flexmdns
+
+Avahi has the following requirements:
+	- glib2
+	- expat
+	- libdaemon (http://0pointer.de/lennart/projects/libdaemon/)
+	- Linux 2.4 or 2.6
+	- DBUS 0.3x (optional, if you disable this, the daemon is not
+	  accessible over IPC to other applications!)
+	- gtk2 + glade (optional, needed for avahi-discover-standalone)
+	- doxygen (optional, needed for he API documentaton)
+	- Python 2.4, pygtk2 (optional, needed by all client tools)
+	- python-twisted (optional, needed by avahi-bookmarks)
+
+Please make sure to read the currently available documentation for avahi before
+asking for support on the mailing list:
+
+	- INSTALL
+	- Man pages
+	- Homepage http://www.freedesktop.org/Software/Avahi
+	- Mailing list archive http://lists.freedesktop.org/archives/avahi/
+
+
+$Id$
diff --git a/man/xmltoman.xsl b/man/xmltoman.xsl
index 7bf78ac..96c9d81 100644
--- a/man/xmltoman.xsl
+++ b/man/xmltoman.xsl
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
+<?xml version="1.0" encoding="iso-8859-15"?>
 <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml">
 
 <!-- 
@@ -19,24 +19,33 @@
   Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 
 -->
 
+<!-- $Id$ -->
+
+<xsl:output method="xml" version="1.0" encoding="iso-8859-15" doctype-public="-//W3C//DTD XHTML 1.0 Strict//EN" doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" indent="yes"/>
+
 <xsl:template match="/manpage">
-    <xsl:text disable-output-escaping="yes">
-    &lt;!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"&gt;
-    </xsl:text>
+  
     <html>
 
     <head>
-      <title>
-        <xsl:value-of select="@name"/>(<xsl:value-of select="@section"/>) 
-      </title>
-      <link rel="stylesheet" type="text/css" href="xmltoman.css"/>
+      <title><xsl:value-of select="@name"/>(<xsl:value-of select="@section"/>)</title>
+      <style type="text/css">
+        body { color: black; background-color: white; } 
+        a:link, a:visited { color: #900000; }       
+        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; }
+        .opt { font-family:monospace; font-weight: bold;  }
+        .manref { font-family:monospace; }
+        .option .optdesc { margin-left:2cm; }
+      </style>
     </head>
     <body>
       <h1>Name</h1>
       <p><xsl:value-of select="@name"/>
-        <xsl:if test="string-length(@desc) &gt; 0">
-          - <xsl:value-of select="@desc"/>
-        </xsl:if>
+        <xsl:if test="string-length(@desc) &gt; 0"> - <xsl:value-of select="@desc"/></xsl:if>
       </p>
       <xsl:apply-templates />
     </body>
author	Lennart Poettering <lennart@poettering.net>	2005-08-08 17:32:25 +0000
committer	Lennart Poettering <lennart@poettering.net>	2005-08-08 17:32:25 +0000
commit	9ad2a95c80ab0f9cf48d3f58e9a7ed6f06685c34 (patch)
tree	2db6a9e1969ca9e9cb916759c0c7e8f15cf8dbdc
parent	0556d428a56bdc4dac52d6eed2c515e66958094e (diff)