Installation: Difference between revisions

From Artha
m Prefixed 'Who should read this' details
Updated to 1.0.0
Line 19: Line 19:
| [http://www.gtk.org/download.html gtk+]
| [http://www.gtk.org/download.html gtk+]
|align="center"| 2.12 ||align="center"| libgtk2.0-dev
|align="center"| 2.12 ||align="center"| libgtk2.0-dev
|-
| [http://dbus.freedesktop.org/doc/dbus-glib/index.html dbus-glib]
|align="center"| 0.70 ||align="center"| libdbus-glib-1-dev
|}
|}


Line 26: Line 29:
* [http://www.gnu.org/software/autoconf/#downloading Autoconf] (>= 2.50)
* [http://www.gnu.org/software/autoconf/#downloading Autoconf] (>= 2.50)
* [http://www.gnu.org/software/automake/#downloading Automake]
* [http://www.gnu.org/software/automake/#downloading Automake]
* gtk-builder-convert (gets installed along with libgtk2.0-dev)
* [http://pkg-config.freedesktop.org/wiki/ pkg-config]
* [http://pkg-config.freedesktop.org/wiki/ pkg-config]


If you have installed GTK+ and GLib properly, ''pkg-config'' should be able to give the cflags and libs of GTK+ and GLib on the following command.
If you have installed GTK+, GLib and dbus-glib properly, ''pkg-config'' should be able to give the cflags and libs of the libraries on the following command:


     pkg-config --cflags --libs libgtk+-2.0
     pkg-config --cflags --libs gtk+-2.0 glib-2.0 dbus-glib-1




==Optional Libraries==
==Optional Libraries==
===Notifications===
===Notifications===
For Notifications feature to be available, you need [http://www.galago-project.org/downloads.php libnotify-dev] (>= 0.4.1) and libdbus-glib-1-dev (>= 0.74). Also pkg-config should be able to give the cflags and libs of libnotify and libdbus-glib on the following command.
For Notifications feature to be available, you need [http://www.galago-project.org/downloads.php libnotify's] (>= 0.4.1) binary (libnotify.so.1) available on your system. The development headers of libnotify is not required, just the runtime of libnotify alone is enough.


    pkg-config --cflags --libs libnotify dbus-glib-1
'''NOTE:''' Even though libnotify (necessary condition) is enough for Artha to expose the ''Notifications'' feature, the sufficient condition to actually see the notifications appear on-screen is to have the [http://www.galago-project.org/downloads.php notification daemon] installed. It is this daemon which actually will put up the notifications requested by Artha.
 
 
It is to be noted that even though libnotify is enough (necessary condition) to build Artha with notifications feature, the sufficient condition to actually see the notifications appear on-screen is to have [http://www.galago-project.org/downloads.php notification daemon] installed. This is to be installed, which will actually put up the notifications on request by Artha.


===Suggestions===
===Suggestions===
For Artha to show suggestions when a misspelled word is queried, libenchat binaries (run time files) are required. While building Artha, libenchant's development headers are not required. Artha looks for libenchat's availability only at run-time. Also a valid spell checker like [[Wikipedia:Aspell|GNU Aspell]] and an [ftp://ftp.gnu.org/gnu/aspell/dict/en/aspell6-en-6.0-0.tar.bz2 English dictionary] that works with that spell checker, is required to be installed for libenchant to work. The locale of the English dictionary is not an problem; any English dictionary that could work with the installed spell checker is sufficient.
For Artha to show suggestions when a misspelled word is queried, libenchat binaries (run time files) are required. While building Artha, libenchant's development headers are not required. Artha looks for libenchat's availability only at run-time. Also a valid spell checker like [[Wikipedia:Aspell|GNU Aspell]] and an [ftp://ftp.gnu.org/gnu/aspell/dict/en/aspell6-en-6.0-0.tar.bz2 English dictionary] that works with that spell checker, is required to be installed for libenchant to work. The locale of the English dictionary is not an problem; any English dictionary that could work with the installed spell checker is sufficient.
===Regex Search===
For regular expressions based search to work, the sense index file '''''index.sense''''' of WordNet should be available on your system, in the same directory as your other WordNet dict files.




==Configuring and Building==
==Configuring and Building==
Once you have the tar ball from [[Download]]. Extract it. This will create a directory ''artha-0.9.1''.
Once you have the tar ball from [[Download]]. Extract it. This will create a directory ''artha-1.0.0''.


     tar xzvf artha-0.9.1.tar.gz
     tar xzvf artha-1.0.0.tar.gz
     cd artha-0.9.1
     cd artha-1.0.0


Now you can configure. Use the prefix parameter to install it in /usr and by default ''configure'' configures it to /usr/local, which is not the actual path for installations.
Now you can configure. Use the prefix parameter to install it in /usr and by default ''configure'' configures it to /usr/local, which is not the actual path for installations.

Revision as of 06:36, 11 January 2010

If you are installing Artha using prebuilt binaries (.deb), please visit the Download page for installation instructions. If you are building Artha from source then this page is for you.


Dependencies

Artha directly depends on the following libraries. Please note that you will need to have the development headers (.h and .a/.so) of these libraries along with the actual library files.


Library Min. Version Common Package Name
wordnet 3.0 wordnet-dev
glib 2.14 libglib2.0-dev
gtk+ 2.12 libgtk2.0-dev
dbus-glib 0.70 libdbus-glib-1-dev


You will need the following tools to build:

If you have installed GTK+, GLib and dbus-glib properly, pkg-config should be able to give the cflags and libs of the libraries on the following command:

   pkg-config --cflags --libs gtk+-2.0 glib-2.0 dbus-glib-1


Optional Libraries

Notifications

For Notifications feature to be available, you need libnotify's (>= 0.4.1) binary (libnotify.so.1) available on your system. The development headers of libnotify is not required, just the runtime of libnotify alone is enough.

NOTE: Even though libnotify (necessary condition) is enough for Artha to expose the Notifications feature, the sufficient condition to actually see the notifications appear on-screen is to have the notification daemon installed. It is this daemon which actually will put up the notifications requested by Artha.

Suggestions

For Artha to show suggestions when a misspelled word is queried, libenchat binaries (run time files) are required. While building Artha, libenchant's development headers are not required. Artha looks for libenchat's availability only at run-time. Also a valid spell checker like GNU Aspell and an English dictionary that works with that spell checker, is required to be installed for libenchant to work. The locale of the English dictionary is not an problem; any English dictionary that could work with the installed spell checker is sufficient.

Regex Search

For regular expressions based search to work, the sense index file index.sense of WordNet should be available on your system, in the same directory as your other WordNet dict files.


Configuring and Building

Once you have the tar ball from Download. Extract it. This will create a directory artha-1.0.0.

   tar xzvf artha-1.0.0.tar.gz
   cd artha-1.0.0

Now you can configure. Use the prefix parameter to install it in /usr and by default configure configures it to /usr/local, which is not the actual path for installations.

   ./configure --prefix=/usr

If you have all the aforementioned dependencies right, configure will end with no errors. Should it encounter errors, follow the on-screen instructions it says to fix them.

To build give

   make


Installing

You need to install Artha to run it, successful building is necessary but not sufficient. To install artha you need root privileges.

   make install (as root)

Once the installation is complete, you can run Artha

   artha

Or give man for Artha's manual

   man artha

A shortcut will also get created in the Applications->Accessories menu.


Uninstalling

To uninstall Artha give a make uninstall (as root) in a Terminal window.