From: Lennart Poettering Date: Mon, 8 Aug 2005 17:32:25 +0000 (+0000) Subject: * documentation update X-Git-Url: https://git.meshlink.io/?a=commitdiff_plain;h=9ad2a95c80ab0f9cf48d3f58e9a7ed6f06685c34;p=catta * documentation update * embed CSS data in xmltoman.xsl git-svn-id: file:///home/lennart/svn/public/avahi/trunk@274 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe --- 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 @@ + - + + 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. - + 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. - - - - DBUS Introspection data - - - - -

- interface - -

- -

+ + + + + DBUS Introspection data + + + + +

+ interface + +

+ +

@@ -68,20 +85,20 @@ -

- - - - +

+ + + + - -

- annotation - = - -

- + +

+ annotation + = + +

+ 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= where D-BUS system.d directory is --with-distro= the target Linux distribution (one of redhat, suse, gentoo, debian or slackware) --with-avahi-user= User for running the Avahi daemon (avahi) --with-avahi-group= 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 @@ - + + + + + - - <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + - - <xsl:value-of select="@name"/>(<xsl:value-of select="@section"/>) - - + <xsl:value-of select="@name"/>(<xsl:value-of select="@section"/>) +

Name

- - - - + -