Jewish Calendar for Linux
=========================

Table Of Contents
-----------------

1. Installing and using Jewish Calendar for Linux on a Linux PDA
2. Compiling Jewish Calendar for Linux
3. Program Structure
4. System requirements
5. Author


1. Installing and using Jewish Calendar for Linux on a Linux PDA
----------------------------------------------------------------

The following files must be copied into the appropriate directories
on the Linux PDA:

File name            Path                                     File mode
---------            ----                                     ---------
jewcalarm            /usr/local/bin                           711
cities               /root (your home directory)              644

jewcal.desktop       /usr/local/share/gnome/apps/Utilities    644
jewcal.xpm           /usr/local/share                         644


The jewcalarm and cities file are required to run the program.

The jewcal.desktop and jewcal.xpm file are necessary for
appearing the program as "JeCal" in the start menu under
the section "Utilities".

To close the Jewish Calendar for Linux program, click on
"Menu" and "Exit", otherwise settings, which are changed, are
not stored!


2. Compiling Jewish Calendar for Linux
--------------------------------------

- Execute config_arm to compile the PDA version or config_i386 to
  compile the desktop version

- Execute make

- After compilation, the PDA version has the name jewcalarm, and
  the desktop version has the name jewcal

If using the desktop version, make sure that the file cities
is located in your home directory.


3. Program Structure
--------------------

Settings are stored in the .jewcalsettings file which is
located in the home directory.

In the file .jewcalanni, the entered anniversaries, birthdays
and Yahrzeits are stored.

The file cities contains the data of the predefined cities (name
of location, latitude, longitude and time zone) - own locations
can be defined by the user himself.

The source files are:

anni.c             Calculation algorithm for anniversaries, birthdays
                   and Yahrzeit
annidlg.c          Dialog box for viewing and editing anniversaries,
                   birthdays and Yahrzeit
annifile.c         Storing entered anniversaries, birthdays and Yahrzeits
calctime.c         Calculation of a time specified by a string,
                   retrieving locations, considering daylight savings
                   time
dialogs.c          Various dialog boxes
dstconf.c          Dialog box for configuration of Daylight Savings Time
gregor.c           Calculation of the Gregorian calendar
halacha.c,          
halacha2.c         Calculation of the Halacha information for a day
hebrcal.c          Calculation of the Jewish calendar
holidays.c         Implementing calculation of holidays and providing
                   names of holidays
ini.c              Implementing the file format for storing settings
main.c             Main program
misc.c             Various helper functions
molad.c            Molad calculation for a specific day
names.c            Contains calendar names (weekday, month and torah
                   section names)
paint.c            Drawing the calendar window
settings.c         Storing and retrieving settings
shabconf.c         Dialog box for configuring shabbat times calculation
suntime.c          Calculation of sunrise, sunset or degrees below horizon
torah.c            Calculation of torah sections
zmanim.c           Retrieving the various Zmanim for a day
zmanimdlg.c        Dialog box for configuring Zmanim


4. System requirements
----------------------

For compiling the desktop version:
  GNU C compiler, GTK toolkit 1.2

For compiling the PDA version:
  GNU C compiler for ARM processor and adapted libraries,
  GTK toolkit 1.2

For installation:
  Linux PDA with an ARM processor and GTK toolkit installed,
  GNOME desktop for inclusion in start menu


5. Author
---------

Ulrich Greve
E-Mail: ulrichgreve@tichnut.de
Websites: http://www.tichnut.de/jewish/
          http://www.tichnut.de/jewish/windowsce.htm