|
|
| (8 intermediate revisions by one other user not shown) |
| Line 7: |
Line 7: |
| | Edit your new stuff immediately below this line | | Edit your new stuff immediately below this line |
| | ---- | | ---- |
| − |
| |
| − | ==Getting Started Compiling and Installing SWORD from Source==
| |
| − |
| |
| − | ==Aims==
| |
| − |
| |
| − | This page is intended to help anyone who needs to get started obtaining and compiling the latest SWORD source code, and installing and testing it on their machine, on a Linux (or possibly other Unix-like) operating system.
| |
| − |
| |
| − | ==Introduction==
| |
| − |
| |
| − | There are four main steps involved:
| |
| − |
| |
| − | * Install necessary software packages
| |
| − | * Download the SWORD source code
| |
| − | * Compile and install SWORD
| |
| − | * Test your new SWORD installation is working
| |
| − |
| |
| − | All of these can be scripted for a specific Linux distribution, and some sample scripts to use will be provided later on this page.
| |
| − |
| |
| − | ==Becoming root (using sudo)==
| |
| − |
| |
| − | In order to install software (including installing SWORD itself), you will need to be able to temporarily "become" root.
| |
| − |
| |
| − | Most Linux (and free *BSD) distributions include a tool called sudo than can do this very conveniently, once set up, without having to enter a root password. On some Linux distributions (including Ubuntu) this is already set up for you during the installation process. On others, you will need to
| |
| − |
| |
| − | * Become root some other way (log in as root, or use su, and type in the root password when prompted for it).
| |
| − | * Ue the command <pre>visudo</pre> to edit the sudo configuration file.
| |
| − | * Add a line <pre>yourusername ALL=(ALL) ALL</pre> to the file, save the change and and exit your text editor.
| |
| − |
| |
| − | After that, you should be able to type <pre>sudo id</pre> to run the (harmless) command id as root. sudo will prompt you for your own password, but if it is used more than once within a short period, will "remember" that you have already provided it and not ask for it again. This is very convenient.
| |
| − |
| |
| − | ==Install necessary software packages==
| |
| − |
| |
| − | Starting from a default fairly minimal Linux installation, you need to add a C++ compiler and several other libraries and tools to your system so that you can correctly compile SWORD. The command to do this varies between different Linux distributions. A few examples follow:
| |
| − |
| |
| − | ;Fedora, Red Hat Enterprise Linux, CentOS: sudo yum install <list of packages>
| |
| − | ;Debian, Ubuntu, Mint: sudo apt-get install <list of packages>
| |
| − | ;Mandriva: sudo urpmi <list of packages>
| |
| − |
| |
| − | These tools will automatically install additional dependent packges, so the ones you request will work.
| |
| − |
| |
| − | Package names vary too, but you will generally need:
| |
| − |
| |
| − | * subversion (a tool for obtaining the latest SWORD source code, see below)
| |
| − | * the GNU C++ compiler, often in a package named g++ or gcc-c++
| |
| − | * make
| |
| − | * libtool
| |
| − | * icu
| |
| − | * zlib-devel (sometimes named zlib1g-dev)
| |
| − | * clucene-core-devel (sometimes named libclucene-dev)
| |
| − | * libicu-devel (sometimes named libicu-dev)
| |
| − | * libcurl-devel (named libcurl4-gnutls-dev on Debian-derived systems)
| |
| − |
| |
| − | These will generally automatically "pull in" other necessary packages such as binutils, automake and autoconf as dependencies.
| |
| − |
| |
| − | ==Download the SWORD source code==
| |
| − |
| |
| − | The single command <pre>svn https://crosswire.org/sword/svn/trunk sword</pre> will download the current development code of SWORD, into a directory called sword. If it asks you about the SSL key, type p (for permanent, so it remembers the key) and press Enterm and it will continue. Once the command finishes, you should be able to do <pre>cd sword</pre> and look at all the source code you just downloaded.
| |
| − |
| |
| − | ==Compile and install SWORD==
| |
| − |
| |
| − | You can read the INSTALL file for the details, but if all is well, after cd sword (so you are inside the SWORD source code directory) you can do <pre>./autogen.sh && ./usrinst.sh && make</pre> to configure and compile SWORD.
| |
| − |
| |
| − | If this fails, make sure you have all the necessary packages installed on your system, and after that, ask for help in the Crosswire forums at http://crosswire.org/forums/ .
| |
| − |
| |
| − | To install SWORD,After successfully compiling SWORD, you can do <pre>sudo make install && sudo make install_config</pre> to install SWORD and a default configuration file on your machine.
| |
| − |
| |
| − | ==Test your new SWORD installation==
| |
| − |
| |
| − | As a very basic test, you can download and install the KJV SWORD "module" and then check that the command line bible reader diatheke can read a verse from it. The commands to do this (using the usual bash shell) are:
| |
| − |
| |
| − | <pre>
| |
| − |
| |
| − | export SWORD_PATH=~/.sword
| |
| − | mkdir -p $SWORD_PATH/mods.d
| |
| − |
| |
| − | echo yes |installmgr -init
| |
| − | echo yes |installmgr -sc
| |
| − | echo yes |installmgr -r CrossWire
| |
| − | echo yes |installmgr -ri CrossWire KJV
| |
| − | installmgr -l
| |
| − | diatheke -b KJV -k Jn 3:16
| |
| − | </pre>
| |
| − |
| |
| − | If that displays a bunch of text and then something very similar to:
| |
| − | <pre>
| |
| − | John 3:16:
| |
| − | For God so loved the world, that he gave his only begotten Son,
| |
| − | that whosoever believeth in him should not perish, but have everlasting life.
| |
| − |
| |
| − | (KJV)
| |
| − | </pre>
| |
| − |
| |
| − | you have successfully installed a basically working SWORD library and its utilities onto your machine.
| |
