diff options
| author | Lennart Poettering <lennart@poettering.net> | 2006-01-19 01:58:29 +0000 |
|---|---|---|
| committer | Lennart Poettering <lennart@poettering.net> | 2006-01-19 01:58:29 +0000 |
| commit | 3fa15050823dd70cf2d26983a5755b68408facd7 (patch) | |
| tree | cbcbfa8476d4bac8e6d449454a4df12e239905b9 /doc | |
| parent | 585e68a16644a099c744ede6606b9d132ac9604c (diff) | |
add preliminary documentation
git-svn-id: file:///home/lennart/svn/public/mod_dnssd/trunk@13 634eccf8-0006-0410-930e-e16565b0b7de
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 33 | ||||
| -rw-r--r-- | doc/README.html.in | 128 | ||||
| -rw-r--r-- | doc/style.css | 25 |
3 files changed, 186 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..4da58be --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,33 @@ +# $Id$ + +# Copyright 2006 Lennart Poettering +# +# Licensed under the Apache License, Version 2.0 (the "License"); you +# may not use this file except in compliance with the License. You +# may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. See the License for the specific language governing +# permissions and limitations under the License. + +noinst_DATA = README.html README +EXTRA_DIST = $(noinst_DATA) style.css README.html.in + +MAINTAINERCLEANFILES = README README.html +CLEANFILES = + +if USE_LYNX +README: README.html + lynx --dump $^ | sed 's,file://localhost/.*/doc/README.html,README,' > $@ + +CLEANFILES += README +endif + +tidy: README.html + tidy -e < README.html + +.PHONY: tidy diff --git a/doc/README.html.in b/doc/README.html.in new file mode 100644 index 0000000..6098dca --- /dev/null +++ b/doc/README.html.in @@ -0,0 +1,128 @@ +<?xml version="1.0" encoding="iso-8859-15"?> <!-- -*-html-helper-*- --> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + +<head> +<title>mod_dnssd @PACKAGE_VERSION@</title> +<link rel="stylesheet" type="text/css" href="style.css" /> +</head> + +<body> +<h1><a name="top">mod_dnssd @PACKAGE_VERSION@</a></h1> + +<p><i>Copyright 2006 Lennart Poettering <@PACKAGE_BUGREPORT@></i></p> + +<ul class="toc"> + <li><a href="#license">License</a></li> + <li><a href="#news">News</a></li> + <li><a href="#overview">Overview</a></li> + <li><a href="#status">Current Status</a></li> + <li><a href="#documentation">Documentation</a></li> + <li><a href="#requirements">Requirements</a></li> + <li><a href="#installation">Installation</a></li> + <li><a href="#acks">Acknowledgements</a></li> + <li><a href="#download">Download</a></li> +</ul> + +<h2><a name="license">License</a></h2> + +<p>Copyright 2006 Lennart Poettering</p> + +<p>Licensed under the Apache License, Version 2.0 (the "License"); you +may not use this file except in compliance with the License. You may +obtain a copy of the License at</p> + +<p> <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></p> + +<p>Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +implied. See the License for the specific language governing +permissions and limitations under the License.</p> + +<h2><a name="news">News</a></h2> + +<div class="news-date">Thu Jan 19 2006: </div> <p class="news-text"><a +href="@PACKAGE_URL@mod_dnssd-0.1.tar.gz">Version 0.1</a> released, +initial realease</p> + +<h2><a name="overview">Overview</a></h2> + +<p><tt>mod_dnssd</tt> is an <a href="http://httpd.apache.org/">Apache +HTTPD</a> module which adds <a +href="http://www.zeroconf.org/">Zeroconf</a> support via <a +href="http://www.dns-sd.org/">DNS-SD</a> using <a +href="http://avahi.org/">Avahi</a>.</p> + +<h2><a name="status">Status</a></h2> + +<p>Version @PACKAGE_VERSION@ is more or less stable and fulfills its purpose.</p> + +<h2><a name="documentation">Documentation</a></h2> + +<p>For activating <tt>mod_dnssd</tt> just load it into the server and use the global directive <tt>DNSSDEnable</tt> to enable it: </p> + +<pre> +DNSSDEnable on +</pre> + +<p>That's it, nothing more is required! The module publishes all +configured virtual hosts and the <tt>mod_userdir</tt> directories of +all local users. For <tt>mod_userdir</tt> to work you need to load +that module and configure it for the path <tt>~/public_html/</tt>.</p> + +<p>Four other directives are available: the global directive +<tt>DNSSDAutoRegisterUserDir</tt> can be used to disable automatic +registration of <tt>mod_userdir</tt> directories. The global directive +<tt>DNSSDAutoRegisterVHosts</tt> can be used to disable automatic +registration of all local virtual hosts.</tt> + +<p>The two directives <tt>DNSSDServiceName</tt> and +<tt>DNSSDServiceTypes</tt> which can be placed inside a +<tt><VirtualHost></tt> or a <tt><Location></tt> section +can be used to define additional services for publishing or to finetune +the service name or types of virtual hosts.</p> + +<h2><a name="requirements">Requirements</a></h2> + +<p><tt>mod_dnssd</tt> requires a current release of Apache 2.0 with +<tt>apxs</tt> and a development installation of <a +href="http://avahi.org/">Avahi</a> 0.6 or newer.</p> + +<p><tt>mod_dnssd</tt> has been developed and tested on Debian GNU/Linux +"testing" from January 2006, it should work on most other Linux +distributions and probably POSIX implementations since it uses GNU +autoconf and Apache <tt>apxs</tt> for source code configuration.</p> + +<h2><a name="installation">Installation</a></h2> + +<p>As this package is made with the GNU autotools you should run +<tt>./configure</tt> inside the distribution directory for configuring +the source tree. After that you should run <tt>make</tt> for +compilation and <tt>make install</tt> (as root) for installation of +<tt>mod_dnssd</tt>.</p> + +<h2><a name="acks">Acknowledgements</a></h2> + +<p>This work was inspired by Sander Temme's and Sebastien Estienne's <a href="http://www.temme.net/sander/mod_zeroconf/">mod_zeroconf</a> module.</p> + +<h2><a name="download">Download</a></h2> + +<p>The newest release is always available from <a href="@PACKAGE_URL@">@PACKAGE_URL@</a></p> + +<p>The current release is <a href="@PACKAGE_URL@mod_dnssd-@PACKAGE_VERSION@.tar.gz">@PACKAGE_VERSION@</a></p> + +<p>Get <tt>mod_dnssd</tt>'s development sources from the <a href="http://subversion.tigris.org/">Subversion</a> <a href="svn://svn.0pointer.net/mod_dnssd">repository</a> (<a href="http://0pointer.net/cgi-bin/viewcvs.cgi/?root=mod_dnssd">viewcvs</a>): </p> + +<pre>svn checkout svn://svn.0pointer.net/mod_dnssd/trunk mod_dnssd</pre> + +<p>If you want to be notified whenever I release a new version of this software use the subscription feature of <a href="http://freshmeat.net/projects/mod_dnssd/">Freshmeat</a>.</p> + +<hr/> + +<address class="grey">Lennart Poettering <@PACKAGE_BUGREPORT@>, January 2006</address> + +<div class="grey"><i>$Id$</i></div> + +</body> +</html> diff --git a/doc/style.css b/doc/style.css new file mode 100644 index 0000000..8eeb813 --- /dev/null +++ b/doc/style.css @@ -0,0 +1,25 @@ +/* $Id$ */ + +/*** + This file is part of syrep. + + syrep 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. + + syrep 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 syrep; 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; } +a:link, a:visited { color: #900000; } +div.news-date { font-size: 80%; font-style: italic; } +pre { background-color: #f0f0f0; padding: 0.4cm; } +.grey { color: #8f8f8f; font-size: 80%; } |