From 53335cee493865e062e8e51b1f81c84882895038 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Thu, 14 Aug 2008 17:45:29 +0200 Subject: add proper documentation --- Makefile.am | 20 +++++++-- README | 21 ---------- configure.ac | 25 +++++++++++ doc/.gitignore | 2 + doc/Makefile.am | 35 ++++++++++++++++ doc/README.html.in | 120 +++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/style.css | 25 +++++++++++ 7 files changed, 224 insertions(+), 24 deletions(-) delete mode 100644 README create mode 100644 doc/.gitignore 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 2fa898c..24d6660 100644 --- a/Makefile.am +++ b/Makefile.am @@ -19,10 +19,10 @@ dist_doc_DATA = README EXTRA_DIST = bootstrap.sh autogen.sh LGPL -SUBDIRS = src gtkdoc libltdl +SUBDIRS = src gtkdoc libltdl doc -MAINTAINERCLEANFILES = -noinst_DATA = +MAINTAINERCLEANFILES = README +noinst_DATA = README pkgconfigdir = $(libdir)/pkgconfig pkgconfig_DATA = libcanberra.pc @@ -33,3 +33,17 @@ endif DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc ACLOCAL_AMFLAGS = -I m4 + +README: + rm -f README + $(MAKE) -C doc README + cd $(srcdir) && ln -s doc/README README + +homepage: all dist doxygen + test -d $$HOME/homepage/private + mkdir -p $$HOME/homepage/private/projects/libcanberra + cp libcanberra-@PACKAGE_VERSION@.tar.gz $$HOME/homepage/private/projects/libcanberra + cp doc/README.html doc/style.css $$HOME/homepage/private/projects/libcanberra + ln -sf README.html $$HOME/homepage/private/projects/libcanberra/index.html + +.PHONY: homepage diff --git a/README b/README deleted file mode 100644 index 0e4c850..0000000 --- a/README +++ /dev/null @@ -1,21 +0,0 @@ -LIBCANBERRA SOUND EVENT LIBRARY - -GIT: - git://git.0pointer.de/libcanberra.git - -GITWEB: - http://git.0pointer.de/?p=libcanberra.git;a=summary - -MAILING LIST: - https://tango.0pointer.de/mailman/listinfo/libcanberra-discuss - -AUTHORS: - Lennart Poettering - -REQUIREMENTS: - OGG Vorbis - Gtk+ (optional, for the Gtk+ bindings) - ALSA (optional, for the ALSA backend) - PulseAudio (optional, for the PulseAudio backend) - - diff --git a/configure.ac b/configure.ac index 56cce26..0253cbe 100644 --- a/configure.ac +++ b/configure.ac @@ -298,6 +298,29 @@ AC_SUBST(GTK_MODULES_DIR) AC_SUBST(HAVE_GTK) AM_CONDITIONAL([HAVE_GTK], [test "x$HAVE_GTK" = x1]) +### LYNX documentation generation ### + +AC_ARG_ENABLE([lynx], + AC_HELP_STRING([--disable-lynx], [Turn off lynx usage for documentation generation]), + [ + case "${enableval}" in + yes) lynx=yes ;; + no) lynx=no ;; + *) AC_MSG_ERROR(bad value ${enableval} for --disable-lynx) ;; + esac + ], + [lynx=yes]) + +if test x$lynx = xyes ; then + AC_CHECK_PROG(have_lynx, lynx, yes, no) + + if test "x$have_lynx" = xno ; then + AC_MSG_WARN([*** lynx not found, plain text README will not be built ***]) + fi +fi + +AM_CONDITIONAL([USE_LYNX], [test "x$have_lynx" = xyes]) + ### Vorbis (mandatory) ### PKG_CHECK_MODULES(VORBIS, [ vorbisfile ]) @@ -388,6 +411,8 @@ src/Makefile libcanberra.pc libcanberra-gtk.pc gtkdoc/Makefile +doc/Makefile +doc/README.html ]) AC_OUTPUT diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 0000000..bc63974 --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1,2 @@ +README +README.html diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..819a6f9 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,35 @@ +# This file is part of libcanberra. +# +# Copyright 2008 Lennart Poettering +# +# libcanberra 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. +# +# libcanberra 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 libcanberra. If not, see +# . + +noinst_DATA = README.html README +EXTRA_DIST = $(noinst_DATA) style.css README.html.in + +MAINTAINERCLEANFILES = 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 -qe < README.html ; true + +.PHONY: tidy diff --git a/doc/README.html.in b/doc/README.html.in new file mode 100644 index 0000000..3c3357e --- /dev/null +++ b/doc/README.html.in @@ -0,0 +1,120 @@ + + + + + +libcanberra @PACKAGE_VERSION@ + + + + +

libcanberra @PACKAGE_VERSION@

+ +

Copyright 2008 Lennart Poettering <@PACKAGE_BUGREPORT@>

+ + + +

License

+ +

This program 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.

+ +

This program 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.

+ +

News

+ +
Thu 14 Aug +2008:

Version +0.7 released; changes include:

+ +

Overview

+ +

libcanberra is an implementation of +the XDG +Sound Theme and Name Specifications, for generating event sounds +on free desktops. It comes with several backends (ALSA, PulseAudio, +Null) and is designed to be portable. It consists of the following +parts:

+ +
    +
  1. libcanberra: the main library
    2. +
  2. libcanberra-gtk: some glue code to make it easier to use libcanberra from Gtk+ applications
    3. +
  3. libcanberra-gtk-module: a Gtk+ module that uses libcanberra-gtk to trigger input feedback event sounds
    4. +
+ +

For more information see the original announcement.

+ +

Current Status

+ +

libcanberra is mostly feature complete. For now however it +includes backends only for ALSA and PulseAudio.

+ +

libcanberra has been +declared a +blessed GNOME dependency.

+ +

Documentation

+ +

You may browse the gtkdoc +generated programing +documentation of the API.

+ +

Requirements

+ +

Currently, libcanberra is tested on Linux only.

+ +

libcanberra was developed and tested on Fedora Rawhide +from August 2008, it should work on most other Linux +distributions (and maybe Unix versions) since it uses GNU autoconf and +GNU libtool for source code configuration and shared library +management.

+ +

libcanberra has no dependencies besides the OGG Vorbis +development headers and whatever the selected backends require. Gtk+ +support is optional.

+ +

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 +libcanberra.

+ +

Acknowledgements

+ +

None so far.

+ +

Download

+ +

The newest release is always available from @PACKAGE_URL@

+ +

The current release is @PACKAGE_VERSION@

+ +

Get libcanberra's development sources from the GIT repository (gitweb):

+ +
git clone git://git.0pointer.de/libcanberra
+ +

If you want to report bugs or have questions, please use the libcanberra-discuss mailing list.

+ + +
+
Lennart Poettering <@PACKAGE_BUGREPORT@>, August 2008
+ + + diff --git a/doc/style.css b/doc/style.css new file mode 100644 index 0000000..3d46fb4 --- /dev/null +++ b/doc/style.css @@ -0,0 +1,25 @@ +/*** + This file is part of libcanberra. + + Copyright 2008 Lennart Poettering + + libcanberra 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. + + libcanberra 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 libcanberra. If not, see + . +***/ + +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