~audio-recorder/audio-recorder/trunk

« back to all changes in this revision

Viewing changes to INSTALL

  • Committer: Osmo Antero Maatta
  • Date: 2011-01-17 08:09:50 UTC
  • Revision ID: osmoma@gmail.com-20110117080950-4cbm2fnnsr0332jw
InitialĀ importĀ 17.jan.2011

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Notater: 
 
2
* autoheader finnes ikke i Natty 11.04
 
3
* Remove libpanel-applet2-dev 
 
4
* Added libdbus-1-dev and libdbus-glib-1-dev
 
5
* Add support for libappindicator-dev
 
6
 
 
7
Installation Instructions
 
8
**************************
 
9
 
 
10
Compilation from source requires these packages. The package names are from Debian/Ubuntu, 
 
11
but you should find similar packages in any other Linux-distribution.
 
12
 
 
13
libgtk2.0-dev - Development files for the GTK+ library (development files).
 
14
libglib2.0-dev - Development files for the GLib library (development files).
 
15
libgconf2-dev - GNOME configuration database system (development files).
 
16
libgstreamer0.10-dev - GStreamer development files. Library name is gstreamer-0.10. 
 
17
libgstreamer-plugins-base0.10-dev - GStreamer development files for "base" set of plugins. gstreamer-interfaces-0.10 library. 
 
18
libgnome-media-dev - Development libraries for the GNOME media utilities (audio file formats).
 
19
libpulse-dev - PulseAudio client development headers and libraries.
 
20
libdbus-1-dev - Simple interprocess messaging system (development headers).
 
21
libdbus-glib-1-dev - Simple interprocess messaging system (GLib interface).
 
22
 
 
23
The new Unity desktop and GNOME 3.0 requires:
 
24
libappindicator-dev - New type Application Indicators on the toolbar.
 
25
 
 
26
The various audio encoders need also these packages:
 
27
gstreamer0.10-plugins-good - WAV format, wavenc encoder. 
 
28
                           - Flac format, flacenc encoder.
 
29
gstreamer0.10-plugins-base - OGG audio format, vorbisenc encoder. Normally installed by default.
 
30
 
 
31
gstreamer0.10-plugins-ugly 
 
32
gstreamer0.10-plugins-ugly-multiverse - MP3 format, contains the lame encoder.
 
33
 
 
34
gstreamer0.10-plugins-bad
 
35
gstreamer0.10-plugins-bad-multiverse - AAC (.m4a) format, contains the faac encoder.
 
36
 
 
37
Use the "gst-inspect-0.10 [encodername]" command to learn more about these encoders. 
 
38
 
 
39
Developers:
 
40
Developers should also install Autotools and laguage support packages.
 
41
build-essential - Gcc and g++ compilers. This project uses gcc.
 
42
autotools-dev - Update infrastructure for config.{guess,sub} files.
 
43
automake - A tool for generating GNU Standards-compliant Makefiles
 
44
autoconf - Automatic configure script builder, includes autoheader.
 
45
gettext  - GNU Internationalization utilities.
 
46
intltool - Utility scripts for internationalizing XML.
 
47
 
 
48
Install also devscripts package (contains debuild, dput, lintian etc).
 
49
devscripts - Scripts to make the life of a Debian Package maintainer easier
 
50
-------------
 
51
 
 
52
Installation from source:
 
53
*************************
 
54
Briefly, these shell commands should configure, build/compile, and install the program:
 
55
 
 
56
cd rec-applet*
 
57
./configure
 
58
make
 
59
make install  #run this as root or sudo
 
60
-------------
 
61
 
 
62
You must also re-fresh the GNOME's panel configuration by issuing command
 
63
pkill gnome-panel
 
64
 
 
65
The new applet will now be visible in the toolbar's "Add to panel..." list. 
 
66
-------------
 
67
 
 
68
This GNOME-applet is not a stand-alone program. You must add it to the toolbar panel. 
 
69
Right-clik the toolbar panel and select "Add to panel..." from the popup-menu. 
 
70
Then pick the "Easy-to-use audio recording tool" from the list. 
 
71
Click the panel/applet to start the configuration and recording.
 
72
 
 
73
The program's about-dialog (in the applet's right-click menu) vill show some details 
 
74
about the installation directories and locations.
 
75
-------------
 
76
 
 
77
Read the rec-applet*/debian/README file if you plan to create a Debian/Ubuntu package of this program.
 
78
Read also the rec-applet/README file.
 
79
-------------
 
80
 
 
81
Generic instructions:
 
82
**********************
 
83
Here is a generic explanation about the configuration and build process.
 
84
 
 
85
   The `configure' shell script attempts to guess correct values for
 
86
various system-dependent variables used during compilation.  It uses
 
87
those values to create a `Makefile' in each directory of the package.
 
88
It may also create one or more `.h' files containing system-dependent
 
89
definitions.  Finally, it creates a shell script `config.status' that
 
90
you can run in the future to recreate the current configuration, and a
 
91
file `config.log' containing compiler output (useful mainly for
 
92
debugging `configure').
 
93
 
 
94
   It can also use an optional file (typically called `config.cache'
 
95
and enabled with `--cache-file=config.cache' or simply `-C') that saves
 
96
the results of its tests to speed up reconfiguring.  Caching is
 
97
disabled by default to prevent problems with accidental use of stale
 
98
cache files.
 
99
 
 
100
   If you need to do unusual things to compile the package, please try
 
101
to figure out how `configure' could check whether to do them, and mail
 
102
diffs or instructions to the address given in the `README' so they can
 
103
be considered for the next release.  If you are using the cache, and at
 
104
some point `config.cache' contains results you don't want to keep, you
 
105
may remove or edit it.
 
106
 
 
107
   The file `configure.ac' (or `configure.in') is used to create
 
108
`configure' by a program called `autoconf'.  You need `configure.ac' if
 
109
you want to change it or regenerate `configure' using a newer version
 
110
of `autoconf'.
 
111
 
 
112
The simplest way to compile this package is:
 
113
 
 
114
  1. `cd' to the directory containing the package's source code and type
 
115
     `./configure' to configure the package for your system.
 
116
 
 
117
     Running `configure' might take a while.  While running, it prints
 
118
     some messages telling which features it is checking for.
 
119
 
 
120
  2. Type `make' to compile the package.
 
121
 
 
122
  3. Optionally, type `make check' to run any self-tests that come with
 
123
     the package.
 
124
 
 
125
  4. Type `make install' to install the programs and any data files and
 
126
     documentation.
 
127
 
 
128
  5. You can remove the program binaries and object files from the
 
129
     source code directory by typing `make clean'.  To also remove the
 
130
     files that `configure' created (so you can compile the package for
 
131
     a different kind of computer), type `make distclean'.  There is
 
132
     also a `make maintainer-clean' target, but that is intended mainly
 
133
     for the package's developers.  If you use it, you may have to get
 
134
     all sorts of other programs in order to regenerate files that came
 
135
     with the distribution.
 
136
 
 
137
  6. Often, you can also type `make uninstall' to remove the installed
 
138
     files again.
 
139
 
 
140
Compilers and Options
 
141
=====================
 
142
 
 
143
Some systems require unusual options for compilation or linking that the
 
144
`configure' script does not know about.  Run `./configure --help' for
 
145
details on some of the pertinent environment variables.
 
146
 
 
147
   You can give `configure' initial values for configuration parameters
 
148
by setting variables in the command line or in the environment.  Here
 
149
is an example:
 
150
 
 
151
     ./configure CC=c99 CFLAGS=-g LIBS=-lposix
 
152
 
 
153
   *Note Defining Variables::, for more details.
 
154
 
 
155
Compiling For Multiple Architectures
 
156
====================================
 
157
 
 
158
You can compile the package for more than one kind of computer at the
 
159
same time, by placing the object files for each architecture in their
 
160
own directory.  To do this, you can use GNU `make'.  `cd' to the
 
161
directory where you want the object files and executables to go and run
 
162
the `configure' script.  `configure' automatically checks for the
 
163
source code in the directory that `configure' is in and in `..'.
 
164
 
 
165
   With a non-GNU `make', it is safer to compile the package for one
 
166
architecture at a time in the source code directory.  After you have
 
167
installed the package for one architecture, use `make distclean' before
 
168
reconfiguring for another architecture.
 
169
 
 
170
Installation Names
 
171
==================
 
172
 
 
173
By default, `make install' installs the package's commands under
 
174
`/usr/local/bin', include files under `/usr/local/include', etc.  You
 
175
can specify an installation prefix other than `/usr/local' by giving
 
176
`configure' the option `--prefix=PREFIX'.
 
177
 
 
178
   You can specify separate installation prefixes for
 
179
architecture-specific files and architecture-independent files.  If you
 
180
pass the option `--exec-prefix=PREFIX' to `configure', the package uses
 
181
PREFIX as the prefix for installing programs and libraries.
 
182
Documentation and other data files still use the regular prefix.
 
183
 
 
184
   In addition, if you use an unusual directory layout you can give
 
185
options like `--bindir=DIR' to specify different values for particular
 
186
kinds of files.  Run `configure --help' for a list of the directories
 
187
you can set and what kinds of files go in them.
 
188
 
 
189
   If the package supports it, you can cause programs to be installed
 
190
with an extra prefix or suffix on their names by giving `configure' the
 
191
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 
192
 
 
193
Optional Features
 
194
=================
 
195
 
 
196
Some packages pay attention to `--enable-FEATURE' options to
 
197
`configure', where FEATURE indicates an optional part of the package.
 
198
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 
199
is something like `gnu-as' or `x' (for the X Window System).  The
 
200
`README' should mention any `--enable-' and `--with-' options that the
 
201
package recognizes.
 
202
 
 
203
   For packages that use the X Window System, `configure' can usually
 
204
find the X include and library files automatically, but if it doesn't,
 
205
you can use the `configure' options `--x-includes=DIR' and
 
206
`--x-libraries=DIR' to specify their locations.
 
207
 
 
208
Specifying the System Type
 
209
==========================
 
210
 
 
211
There may be some features `configure' cannot figure out automatically,
 
212
but needs to determine by the type of machine the package will run on.
 
213
Usually, assuming the package is built to be run on the _same_
 
214
architectures, `configure' can figure that out, but if it prints a
 
215
message saying it cannot guess the machine type, give it the
 
216
`--build=TYPE' option.  TYPE can either be a short name for the system
 
217
type, such as `sun4', or a canonical name which has the form:
 
218
 
 
219
     CPU-COMPANY-SYSTEM
 
220
 
 
221
where SYSTEM can have one of these forms:
 
222
 
 
223
     OS KERNEL-OS
 
224
 
 
225
   See the file `config.sub' for the possible values of each field.  If
 
226
`config.sub' isn't included in this package, then this package doesn't
 
227
need to know the machine type.
 
228
 
 
229
   If you are _building_ compiler tools for cross-compiling, you should
 
230
use the option `--target=TYPE' to select the type of system they will
 
231
produce code for.
 
232
 
 
233
   If you want to _use_ a cross compiler, that generates code for a
 
234
platform different from the build platform, you should specify the
 
235
"host" platform (i.e., that on which the generated programs will
 
236
eventually be run) with `--host=TYPE'.
 
237
 
 
238
Sharing Defaults
 
239
================
 
240
 
 
241
If you want to set default values for `configure' scripts to share, you
 
242
can create a site shell script called `config.site' that gives default
 
243
values for variables like `CC', `cache_file', and `prefix'.
 
244
`configure' looks for `PREFIX/share/config.site' if it exists, then
 
245
`PREFIX/etc/config.site' if it exists.  Or, you can set the
 
246
`CONFIG_SITE' environment variable to the location of the site script.
 
247
A warning: not all `configure' scripts look for a site script.
 
248
 
 
249
Defining Variables
 
250
==================
 
251
 
 
252
Variables not defined in a site shell script can be set in the
 
253
environment passed to `configure'.  However, some packages may run
 
254
configure again during the build, and the customized values of these
 
255
variables may be lost.  In order to avoid this problem, you should set
 
256
them in the `configure' command line, using `VAR=value'.  For example:
 
257
 
 
258
     ./configure CC=/usr/local2/bin/gcc
 
259
 
 
260
causes the specified `gcc' to be used as the C compiler (unless it is
 
261
overridden in the site shell script).
 
262
 
 
263
Unfortunately, this technique does not work for `CONFIG_SHELL' due to
 
264
an Autoconf bug.  Until the bug is fixed you can use this workaround:
 
265
 
 
266
     CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
 
267
 
 
268
`configure' Invocation
 
269
======================
 
270
 
 
271
`configure' recognizes the following options to control how it operates.
 
272
 
 
273
`--help'
 
274
`-h'
 
275
     Print a summary of the options to `configure', and exit.
 
276
 
 
277
`--version'
 
278
`-V'
 
279
     Print the version of Autoconf used to generate the `configure'
 
280
     script, and exit.
 
281
 
 
282
`--cache-file=FILE'
 
283
     Enable the cache: use and save the results of the tests in FILE,
 
284
     traditionally `config.cache'.  FILE defaults to `/dev/null' to
 
285
     disable caching.
 
286
 
 
287
`--config-cache'
 
288
`-C'
 
289
     Alias for `--cache-file=config.cache'.
 
290
 
 
291
`--quiet'
 
292
`--silent'
 
293
`-q'
 
294
     Do not print messages saying which checks are being made.  To
 
295
     suppress all normal output, redirect it to `/dev/null' (any error
 
296
     messages will still be shown).
 
297
 
 
298
`--srcdir=DIR'
 
299
     Look for the package's source code in directory DIR.  Usually
 
300
     `configure' can determine that directory automatically.
 
301
 
 
302
`configure' also accepts some other, not widely useful, options.  Run
 
303
`configure --help' for more details.
 
304