From 3fa15050823dd70cf2d26983a5755b68408facd7 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Thu, 19 Jan 2006 01:58:29 +0000 Subject: add preliminary documentation git-svn-id: file:///home/lennart/svn/public/mod_dnssd/trunk@13 634eccf8-0006-0410-930e-e16565b0b7de --- Makefile.am | 32 ++++++-------- configure.ac | 3 +- doc/Makefile.am | 33 ++++++++++++++ doc/README.html.in | 128 +++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/style.css | 25 +++++++++++ 5 files changed, 201 insertions(+), 20 deletions(-) create mode 100644 doc/Makefile.am create mode 100644 doc/README.html.in create mode 100644 doc/style.css diff --git a/Makefile.am b/Makefile.am index bc9e28c..37c85f1 100644 --- a/Makefile.am +++ b/Makefile.am @@ -15,25 +15,21 @@ # permissions and limitations under the License. EXTRA_DIST=bootstrap.sh LICENSE src/mod_dnssd.c src/Makefile.in -SUBDIRS=src -# doc +SUBDIRS=src doc -#MAINTAINERCLEANFILES = README -#noinst_DATA = README LICENSE +MAINTAINERCLEANFILES = README +noinst_DATA = README LICENSE -#README: -# rm -f README -# $(MAKE) -C doc README -# cd $(srcdir) && ln -s doc/README README +README: + rm -f README + $(MAKE) -C doc README + cd $(srcdir) && ln -s doc/README README -#homepage: all dist -# test -d $$HOME/homepage/private -# mkdir -p $$HOME/homepage/private/projects/mod_mime_xattr -# cp *.tar.gz $$HOME/homepage/private/projects/mod_mime_xattr -# cp doc/README.html doc/style.css $$HOME/homepage/private/projects/mod_mime_xattr -# cp $$HOME/homepage/private/projects/mod_mime_xattr/README.html $$HOME/homepage/private/projects/mod_mime_xattr/index.html +homepage: all dist + test -d $$HOME/homepage/private + mkdir -p $$HOME/homepage/private/projects/mod_dnssd + cp *.tar.gz $$HOME/homepage/private/projects/mod_dnssd + cp doc/README.html doc/style.css $$HOME/homepage/private/projects/mod_dnssd + ln -sf $$HOME/homepage/private/projects/mod_dnssd/README.html $$HOME/homepage/private/projects/mod_dnssd/index.html -#distcleancheck: -# @: - -#.PHONY: homepage distcleancheck +.PHONY: homepage diff --git a/configure.ac b/configure.ac index a4651ff..2d23443 100644 --- a/configure.ac +++ b/configure.ac @@ -114,6 +114,5 @@ fi AM_CONDITIONAL([USE_LYNX], [test "x$lynx" = xyes]) -AC_CONFIG_FILES([src/Makefile Makefile]) -dnl AC_CONFIG_FILES([src/Makefile Makefile doc/Makefile doc/README.html]) +AC_CONFIG_FILES([src/Makefile Makefile doc/Makefile doc/README.html]) AC_OUTPUT 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 @@ + + + + + +mod_dnssd @PACKAGE_VERSION@ + + + + +

mod_dnssd @PACKAGE_VERSION@

+ +

Copyright 2006 Lennart Poettering <@PACKAGE_BUGREPORT@>

+ + + +

License

+ +

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.

+ +

News

+ +
Thu Jan 19 2006:

Version 0.1 released, +initial realease

+ +

Overview

+ +

mod_dnssd is an Apache +HTTPD module which adds Zeroconf support via DNS-SD using Avahi.

+ +

Status

+ +

Version @PACKAGE_VERSION@ is more or less stable and fulfills its purpose.

+ +

Documentation

+ +

For activating mod_dnssd just load it into the server and use the global directive DNSSDEnable to enable it:

+ +
+DNSSDEnable on
+
+ +

That's it, nothing more is required! The module publishes all +configured virtual hosts and the mod_userdir directories of +all local users. For mod_userdir to work you need to load +that module and configure it for the path ~/public_html/.

+ +

Four other directives are available: the global directive +DNSSDAutoRegisterUserDir can be used to disable automatic +registration of mod_userdir directories. The global directive +DNSSDAutoRegisterVHosts can be used to disable automatic +registration of all local virtual hosts. + +

The two directives DNSSDServiceName and +DNSSDServiceTypes which can be placed inside a +<VirtualHost> or a <Location> section +can be used to define additional services for publishing or to finetune +the service name or types of virtual hosts.

+ +

Requirements

+ +

mod_dnssd requires a current release of Apache 2.0 with +apxs and a development installation of Avahi 0.6 or newer.

+ +

mod_dnssd 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 apxs for source code configuration.

+ +

Installation

+ +

As this package is made with the GNU autotools you should run +./configure inside the distribution directory for configuring +the source tree. After that you should run make for +compilation and make install (as root) for installation of +mod_dnssd.

+ +

Acknowledgements

+ +

This work was inspired by Sander Temme's and Sebastien Estienne's mod_zeroconf module.

+ +

Download

+ +

The newest release is always available from @PACKAGE_URL@

+ +

The current release is @PACKAGE_VERSION@

+ +

Get mod_dnssd's development sources from the Subversion repository (viewcvs):

+ +
svn checkout svn://svn.0pointer.net/mod_dnssd/trunk mod_dnssd
+ +

If you want to be notified whenever I release a new version of this software use the subscription feature of Freshmeat.

+ +
+ +
Lennart Poettering <@PACKAGE_BUGREPORT@>, January 2006
+ +
$Id$
+ + + 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%; } -- cgit