6379bb9
================================================
6379bb9
# xtide-README.fedora
6379bb9
# Written by Patrice Dumas and Mamoru Tasaka
6379bb9
b15ea27
# ChangeLog:
72afd03
# 2007 Nov 23: Modified as the upstream developer
72afd03
               splitted free and non-free data
b15ea27
# 2007 May 31: Modified as we now ship US part 
b15ea27
#              harmonics data
b15ea27
# 2006 Nov 11: Initial document created
b15ea27
6379bb9
# If you have some questions, please report it
6379bb9
# with redhat bugzilla:
6379bb9
# https://bugzilla.redhat.com/bugzilla/index.cgi
6379bb9
================================================
6379bb9
6379bb9
Availability and installation of harmonics files
6379bb9
================================================
6379bb9
6379bb9
To use xtide and related utilities (like xttpd, 
72afd03
tideEditor), you need an harmonics file. Currently 
72afd03
we ship the harmonics data of US part only, which are 
72afd03
under public domain. The harmonics data outside US 
72afd03
cannot be distributed as part of Fedora because their 
72afd03
license restricts commercial redistribution and selling,
72afd03
which is too restrictive for Fedora. If you want to 
72afd03
use harmonics data outside US, you have to install 
72afd03
such data after the package installation by yourself.
6379bb9
6379bb9
Such files are available at:
6379bb9
http://www.flaterco.com/xtide/files.html
6379bb9
As the time of writing, the latest harmonics file is:
72afd03
ftp://ftp.flaterco.com/xtide/harmonics-dwf-20071122-nonfree.tcd.bz2
6379bb9
The utilities can only use uncompressed harmonics files.
6379bb9
6379bb9
There are 2 possibilities to have the utilities become aware of
6379bb9
the harmonics file location:
6379bb9
6379bb9
1) by editing /etc/xtide.conf, and setting the first line of the file
6379bb9
  to the path of the directory containing the harmonics files, or  
6379bb9
  to the harmonics file location (the utilities will also accept a colon `:' 
6379bb9
  delimited list of paths). 
6379bb9
  The second line of /etc/xtide.conf sets the directory which 
6379bb9
  contains world vector shoreline data. The second line can accept only
6379bb9
  one directory and cannot be colon-delimited.
6379bb9
  
6379bb9
  The default content of /etc/xtide.conf used by fedora is:
6379bb9
6379bb9
  /usr/share/xtide-harmonics/
6379bb9
  /usr/share/wvs-data/
6379bb9
6379bb9
  which means that all the files in /usr/share/xtide-harmonics
6379bb9
  are considered to be harmonics files and all under /usr/share/wvs-data
6379bb9
  are considered to be WVS data.
6379bb9
6379bb9
2) by setting the environment variable HFILE_PATH. You can also
6379bb9
   set WVS_PATH to specify the directory under which WVS data are
6379bb9
   stored.
6379bb9
6379bb9
You can run the provided script xtide-get_harmonics-data.sh
6379bb9
under /usr/sbin to install harmonics files to 
6379bb9
/usr/share/xtide-harmonics. This script requires 
6379bb9
administrator previledges.