summaryrefslogtreecommitdiffstats
path: root/doc/README.html.in
blob: dc4aa3a240a03cbfea6e65071a1c672b42d72c02 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
<?xml version="1.0" encoding="iso-8859-1"?> <!-- -*-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>libcanberra @PACKAGE_VERSION@</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>

<body>
<h1><a name="top">libcanberra @PACKAGE_VERSION@</a></h1>

<p><i>Copyright 2008 Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;</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>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.</p>

<p>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.</p>

<h2><a name="news">News</a></h2>

<div class="news-date">Thu 14 Aug
2008: </div> <p class="news-text"><a href="@PACKAGE_URL@libcanberra-0.7.tar.gz">Version
0.7</a> released; changes include: documentation updates; various bug
fixes; add this web site/README; allow playback of event sounds with
only a sound file path specified; other changes</p>

<h2><a name="overview">Overview</a></h2>

<p><tt>libcanberra</tt> is an implementation of
the <a href="http://freedesktop.org/wiki/Specifications/sound-theme-spec">XDG
Sound Theme and Name Specifications</a>, for generating event sounds
on free desktops, such as <a href="http://www.gnome.org/">GNOME</a>. It comes with several backends (<a href="http://alsa-project.org/">ALSA</a>, <a href="http://pulseaudio.org/">PulseAudio</a>,
null) and is designed to be portable. It consists of the following
parts:</p>

<ol>
<li><tt>libcanberra</tt>: the main library</li>
<li><tt>libcanberra-gtk</tt>: some glue code to make it easier to use <tt>libcanberra</tt> from Gtk+ applications</li>
<li><tt>libcanberra-gtk-module</tt>: a Gtk+ module that uses <tt>libcanberra-gtk</tt> to trigger input feedback event sounds</li>
</ol>

<p>For more information see <a href="http://0pointer.de/blog/projects/sixfold-announcement.html">the original announcement.</a></p>

<h2><a name="status">Current Status</a></h2>

<p><tt>libcanberra</tt> is mostly feature complete. For now however it
includes backends only for ALSA and PulseAudio.</p>

<p><tt>libcanberra</tt> has been
declared <a href="http://mail.gnome.org/archives/devel-announce-list/2008-August/msg00001.html">a
blessed GNOME dependency</a>.</p>

<h2><a name="documentation">Documentation</a></h2>

<p>You may browse the <a href="http://www.gtk.org/gtk-doc/">gtkdoc</a>
generated <a href="http://0pointer.de/lennart/projects/libcanberra/gtkdoc/">programing
documentation</a> of the API.</p>

<h2><a name="requirements">Requirements</a></h2>

<p>Currently, <tt>libcanberra</tt> is tested on Linux only.</p>

<p><tt>libcanberra</tt> 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.</p>

<p><tt>libcanberra</tt> has no dependencies besides the OGG Vorbis
development headers and whatever the selected backends require. Gtk+
support is optional.</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>libcanberra</tt>.</p>

<h2><a name="acks">Acknowledgements</a></h2>

<p>None so far.</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@libcanberra-@PACKAGE_VERSION@.tar.gz">@PACKAGE_VERSION@</a></p>

<p>Get <tt>libcanberra</tt>'s development sources from the <a href="http://git.or.cz/">GIT</a> <a href="git://git.0pointer.de/libcanberra">repository</a> (<a href="http://git.0pointer.de/?p=libcanberra.git">gitweb</a>): </p>

<pre>git clone git://git.0pointer.de/libcanberra</pre>

<p>If you want to report bugs or have questions, please use the <a href="https://tango.0pointer.de/mailman/listinfo/libcanberra-discuss/"><tt>libcanberra-discuss</tt></a> mailing list.</p>

<hr/>
<address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, August 2008</address>

</body>
</html>