Lemur Development Resources

How to work with CVS?

CVS Path: The cvs repository is at /home/czhai/cvsroot on sifaka. You must specify the cvs path, in either of the following two ways: (1) Use the command line option "-d /home/czhai/cvsroot"; (2) Set the environment variable "CVSROOT" (e.g., "setenv CVSROOT /home/czhai/cvsroot"). The latter is often more convenient, since you only need to do it at once, but the former has the flexibility of working with different cvs repositories.
Module: Current there is only one module "lemur0", which is a light version of Lemur, containing only the indexing and some basic retrieval mechansims. A more complete version of Lemur will be setup later. For most of our tasks, the light version is probably sufficient, and it is better to work with the light version whenever it is possible, since it is quicker to compile and link.
Checkout a module: Use "cvs -d /home/czhai/cvsroot checkout lemur0" to check out the lemur0 module. (You can omit the "-d" option if you have set the CVSROOT variable; this is true for all the cvs commands.) This will create a directory called "lemur0" in your current directory and put all the files there.
Check in any changed file: Use "cvs -d /home/czhai/cvsroot commit -m "YOUR MESSAGE" filename" to check in a file with the name "filename". You should provide a brief message to document what has been changed. WARNING: DO NOT CHECK IN ANY CODE THAT HAS NOT BEEN SERIOUSLY TESTED. More rules for checking in files.
More cvs commands can be found in this CVS Manual.

How to use Lemur?

After you check out the lemur0 module, first do "./configure", which would create a customized "MakeDefns" file, and then do "gmake", which will compile and link the whole toolkit. Generally, you develop any new application by adding a new file to the app/src directory. If your application is sophisticated, you may need to add files to other module directories, such as "retrieval" and "index". In all cases, to compile and link your code, simply go to the root directory (i.e,. "/lemur0/"), and do "gmake". This should automatically recognize your code and do all the necessary work for compilation and linking. Sometimes, your application is so sophisticated that you may need to create a new module. In that case, you would need to do some trivial modification to the makefiles. Please see Lemur Documentation for details about how to do this and other modifications.