~ubuntu-branches/ubuntu/jaunty/bibletime/jaunty

« back to all changes in this revision

Viewing changes to INSTALL

  • Committer: Bazaar Package Importer
  • Author(s): Ralph Janke
  • Date: 2008-05-10 15:18:16 UTC
  • mfrom: (1.1.6 upstream) (3.1.1 lenny)
  • Revision ID: james.westby@ubuntu.com-20080510151816-bqp8y1to705zd0fm
Tags: 1.6.5.1-1
* New upstream version (Closes: #441161, #271502)
* fixes for new autotools and gcc 4.3 (Closes: #407291)
* added poxml to Build-Depends
* No DFSG necessary anymore since biblestudy howto has 
  now Commons Licence 
* Added libclucene-dev to dev-depends (Closes: #436677)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Installation instructions for BibleTime 1.6.5.1:
 
2
---------------------------
 
3
 
 
4
Sometimes it is difficult to compile BibleTime from source code, but it's 
 
5
possible. Don't hesitate to ask for support at info@bibletime.info. In that 
 
6
case, please include your system's configuration details.
 
7
 
 
8
BibleTime 1.6.5.1 requires:
 
9
 
 
10
  - KDE >= 3.0 (at least the libraries (kdelibs) and the base package (kdebase))
 
11
     Although BibleTime should compile and run with KDE 3.0-3.3, we strongly recommend 
 
12
     to use the latest version of KDE available for your Linux installation.
 
13
 
 
14
  - SWORD 1.5.9, available from http://www.crosswire.org/sword/; you should include
 
15
     a stability patch to Sword 1.5.9 available from the BibleTime download pages
 
16
     (fixes problems with compressed and locked modules).
 
17
 
 
18
  - CLucene >= 0.9.16, available from http://clucene.sf.net/.
 
19
 
 
20
 
 
21
If you don't have the sources already, please browse to www.bibletime.info to see
 
22
a list of required packages with their download URLs.
 
23
 
 
24
To install texts (e.g. Bibles), just use the Bookshelf Manager in the Settings 
 
25
menu of BibleTime.
 
26
 
 
27
 
 
28
Compile BibleTime 1.6.5.1:
 
29
---------------------------
 
30
 
 
31
cd ~
 
32
tar -xjf bibletime-1.6.5.1.tar.bz2
 
33
cd ~/bibletime-1.6.5.1              # Move to your source directory
 
34
kde-config --prefix                   # Displays your KDE directory (optional)
 
35
./configure --prefix=<your KDE dir>   # create makefiles
 
36
make                                  # compile BibleTime
 
37
su -c "make install"                  # change to "root user" and install BibleTime
 
38
 
 
39
After this, if you want to use the translations of BibleTime's UI, you should
 
40
install the bibletime-i18n package.
 
41
 
 
42
 
 
43
Debian specifics
 
44
---------------------------
 
45
Debian (and possibly derived distros as well) use a non-standard path to
 
46
store the documentation of KDE programs. Therefore the ./configure line above in 
 
47
this case needs to be changed to:
 
48
 
 
49
kde_htmldir=/usr/share/doc/kde/HTML ./configure --prefix=/usr
 
50
 
 
51
If you forget this, you'll likely not be able to access the handbook and the 
 
52
BibleStudy HowTo.
 
53
 
 
54
 
 
55
Other useful make options
 
56
---------------------------
 
57
make clean           # Removes binaries from the directory
 
58
                     # where BibleTime was compiled, but not the source
 
59
 
 
60
make uninstall       # Removes BibleTime from your system
 
61
 
 
62
 
 
63
If something is missing in this file please post to info@bibletime.info, the contact 
 
64
adress for BibleTime. Please read README for a short description of BibleTime 1.6.5.1. 
 
65
 
 
66
 
 
67
 
 
68
The BibleTime team, <info@bibletime.info>
 
69
 
 
70
 
 
71
 
 
72
 
 
73
______________________________________________________________________________
 
74
**     The standard Installation instructions of auto-tool packages         **
 
75
------------------------------------------------------------------------------
 
76
 
 
77
 
 
78
Basic Installation
 
79
==================
 
80
 
 
81
   These are generic installation instructions.
 
82
 
 
83
   The `configure' shell script attempts to guess correct values for
 
84
various system-dependent variables used during compilation.  It uses
 
85
those values to create a `Makefile' in each directory of the package.
 
86
It may also create one or more `.h' files containing system-dependent
 
87
definitions.  Finally, it creates a shell script `config.status' that
 
88
you can run in the future to recreate the current configuration, a file
 
89
`config.cache' that saves the results of its tests to speed up
 
90
reconfiguring, and a file `config.log' containing compiler output
 
91
(useful mainly for debugging `configure').
 
92
 
 
93
   If you need to do unusual things to compile the package, please try
 
94
to figure out how `configure' could check whether to do them, and mail
 
95
diffs or instructions to the address given in the `README' so they can
 
96
be considered for the next release.  If at some point `config.cache'
 
97
contains results you don't want to keep, you may remove or edit it.
 
98
 
 
99
   The file `configure.in' is used to create `configure' by a program
 
100
called `autoconf'.  You only need `configure.in' if you want to change
 
101
it or regenerate `configure' using a newer version of `autoconf'.
 
102
 
 
103
The simplest way to compile this package is:
 
104
 
 
105
  1. `cd' to the directory containing the package's source code and type
 
106
     `./configure' to configure the package for your system.  If you're
 
107
     using `csh' on an old version of System V, you might need to type
 
108
     `sh ./configure' instead to prevent `csh' from trying to execute
 
109
     `configure' itself.
 
110
 
 
111
     Running `configure' takes a while.  While running, it prints some
 
112
     messages telling which features it is checking for.
 
113
 
 
114
  2. Type `make' to compile the package.
 
115
 
 
116
  3. Type `make install' to install the programs and any data files and
 
117
     documentation.
 
118
 
 
119
  4. You can remove the program binaries and object files from the
 
120
     source code directory by typing `make clean'.
 
121
 
 
122
Compilers and Options
 
123
=====================
 
124
 
 
125
   Some systems require unusual options for compilation or linking that
 
126
the `configure' script does not know about.  You can give `configure'
 
127
initial values for variables by setting them in the environment.  Using
 
128
a Bourne-compatible shell, you can do that on the command line like
 
129
this:
 
130
     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
 
131
 
 
132
Or on systems that have the `env' program, you can do it like this:
 
133
     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
 
134
 
 
135
Compiling For Multiple Architectures
 
136
====================================
 
137
 
 
138
   You can compile the package for more than one kind of computer at the
 
139
same time, by placing the object files for each architecture in their
 
140
own directory.  To do this, you must use a version of `make' that
 
141
supports the `VPATH' variable, such as GNU `make'.  `cd' to the
 
142
directory where you want the object files and executables to go and run
 
143
the `configure' script.  `configure' automatically checks for the
 
144
source code in the directory that `configure' is in and in `..'.
 
145
 
 
146
   If you have to use a `make' that does not supports the `VPATH'
 
147
variable, you have to compile the package for one architecture at a time
 
148
in the source code directory.  After you have installed the package for
 
149
one architecture, use `make distclean' before reconfiguring for another
 
150
architecture.
 
151
 
 
152
Installation Names
 
153
==================
 
154
 
 
155
   By default, `make install' will install the package's files in
 
156
`/usr/local/bin', `/usr/local/man', etc.  You can specify an
 
157
installation prefix other than `/usr/local' by giving `configure' the
 
158
option `--prefix=PATH'.
 
159
 
 
160
   You can specify separate installation prefixes for
 
161
architecture-specific files and architecture-independent files.  If you
 
162
give `configure' the option `--exec-prefix=PATH', the package will use
 
163
PATH as the prefix for installing programs and libraries.
 
164
Documentation and other data files will still use the regular prefix.
 
165
 
 
166
   If the package supports it, you can cause programs to be installed
 
167
with an extra prefix or suffix on their names by giving `configure' the
 
168
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 
169
 
 
170
Optional Features
 
171
=================
 
172
 
 
173
   Some packages pay attention to `--enable-FEATURE' options to
 
174
`configure', where FEATURE indicates an optional part of the package.
 
175
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 
176
is something like `gnu-as' or `x' (for the X Window System).  The
 
177
`README' should mention any `--enable-' and `--with-' options that the
 
178
package recognizes.
 
179
 
 
180
   For packages that use the X Window System, `configure' can usually
 
181
find the X include and library files automatically, but if it doesn't,
 
182
you can use the `configure' options `--x-includes=DIR' and
 
183
`--x-libraries=DIR' to specify their locations.
 
184
 
 
185
Specifying the System Type
 
186
==========================
 
187
 
 
188
   There may be some features `configure' can not figure out
 
189
automatically, but needs to determine by the type of host the package
 
190
will run on.  Usually `configure' can figure that out, but if it prints
 
191
a message saying it can not guess the host type, give it the
 
192
`--host=TYPE' option.  TYPE can either be a short name for the system
 
193
type, such as `sun4', or a canonical name with three fields:
 
194
     CPU-COMPANY-SYSTEM
 
195
 
 
196
See the file `config.sub' for the possible values of each field.  If
 
197
`config.sub' isn't included in this package, then this package doesn't
 
198
need to know the host type.
 
199
 
 
200
   If you are building compiler tools for cross-compiling, you can also
 
201
use the `--target=TYPE' option to select the type of system they will
 
202
produce code for and the `--build=TYPE' option to select the type of
 
203
system on which you are compiling the package.
 
204
 
 
205
Sharing Defaults
 
206
================
 
207
 
 
208
   If you want to set default values for `configure' scripts to share,
 
209
you can create a site shell script called `config.site' that gives
 
210
default values for variables like `CC', `cache_file', and `prefix'.
 
211
`configure' looks for `PREFIX/share/config.site' if it exists, then
 
212
`PREFIX/etc/config.site' if it exists.  Or, you can set the
 
213
`CONFIG_SITE' environment variable to the location of the site script.
 
214
A warning: not all `configure' scripts look for a site script.
 
215
 
 
216
Operation Controls
 
217
==================
 
218
 
 
219
   `configure' recognizes the following options to control how it
 
220
operates.
 
221
 
 
222
`--cache-file=FILE'
 
223
     Use and save the results of the tests in FILE instead of
 
224
     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
 
225
     debugging `configure'.
 
226
 
 
227
`--help'
 
228
     Print a summary of the options to `configure', and exit.
 
229
 
 
230
`--quiet'
 
231
`--silent'
 
232
`-q'
 
233
     Do not print messages saying which checks are being made.
 
234
 
 
235
`--srcdir=DIR'
 
236
     Look for the package's source code in directory DIR.  Usually
 
237
     `configure' can determine that directory automatically.
 
238
 
 
239
`--version'
 
240
     Print the version of Autoconf used to generate the `configure'
 
241
     script, and exit.
 
242
 
 
243
`configure' also accepts some other, not widely useful, options.
 
244