Bibletime – a bible study tool
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

244 lines
9.5 KiB

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