
------------------------------------------------------------------------

     ScienceArchive TK QueryTool interface README file

     Peter Kunszt, August 6, 1999

     Updated April 17, 2000 PK

     Updated Aug 2, 2001 DCD
------------------------------------------------------------------------


Requirements
============

sdssQT runs on any platform that has tcl/tk version 8.0.
If you don't have tcl/tk 8, you can download the latest
version for your platform from http://dev.scriptics.com/

sdssQT consists merely of standard tcl code, no additional
installation is necessary. (Windows is OK, Mac not tested
but should work fine.)


Environment
===========

You need to have HOME set to your home directory (for Windows,
set HOME to the value you want in autoexec.bat)
and you need the variable SDSSQT_DIR (or SXGUI_DIR) to point to
the sdssQT directory.

Unix:
-----
PATH needs the directories of 

x wish
x sdssQT
x netscape

sdssQT expects the executables 'wish' and 'netscape' to be
in the path and to correspond to the correct versions.
To test whether you have these programs in
your path, simply use the 'which' command like:

which netscape

should give you the path of the executable for netscape,
if any. If you get 'command not found', you should update
your PATH environment variable for it.
sdssQT resides in the sdssQT/bin directory. So if you decide
to install sdssQT into /usr/local/sdssQT add /usr/local/sdssQT/bin
to your path.


Windows:
--------
As in unix, you should set the PATH variable to include the executables
for tcl/tk, sdssQT/bin and netscape. You can do so in the autoexec.bat
batch file.

Unlike the other environment variables (see above), you need to use the DOS
back slash "\" not the UNIX front slash "/" in the PATH environment variable.

Also, the netscape executable must be called netscape. For example, the
current (6/01) netscape download from netscape.com sets netscp6.exe as
the executable. You need to copy this to an executable called netscape.exe.
Setting a shortcut called netscape will not work. You should do a copy.

All changes should be done in the administrator environment.

Installing sdssQT
===============

Unix:
-----
No special installation needed, just copy the sdssQT wherever you want.
If all environment variables have been updated correctly, just type
sdssQT to run it.

There will be no problem multiple users running the program since
each user will have his/her configuration files in the directory
pointed to by the $HOME environment variable.


Windows:
--------
Rename bin\sdssQT into bin\sdssQT.tcl and make a shortcut to it on your
desktop. This way you can simply double-click on it to run.
If you just set your environment variables in autoexec.bat, you
need to reboot first (as usual). 


First-time startup
==================

If you start sdssQT for the first time, the QT generates its local
settings for you. Each user gets their own '.sdss' files in their
home directory.

Then you can proceed to enter your username and password.
To get your password, write email to jen_a@fnal.gov


Files
=====

Every user needs the SDSSQT_DIR environment to be set to the sdssQT path.
User customization is saved in the users $HOME directory:

$HOME/.sxconfig				Configuration options
$HOME/.sxPDconfig			Port Daemon host/port, server id
$HOME/.sxSite				Latest site you connected to


Command-line switches
=====================

There is currently only one command line switch, -nosxwm which
will cause all the windows to be managed by your window manager
instead of the sdssQT canvas. Some people like this better...


Problems
========

The server status can be checked anytime by selecting "Check Connection"
form the Server menu. If you are unsure about the server,
check this first. There are queries that do take long to analyze.

If your query consistently 'disconnects' the server, report the query
that caused it to the bug database. Also, scan it for syntax - you might
be able to fix the problem yourself. Please, do report such queries.
Use the SDSS bug report system at 
http://www.astro.princeton.edu:81/cgi-bin/gnatsweb.pl

If you get an error message stating that the server is down,
"Contact administrator", please wait for 2 minutes. The
Server should be restarted if it has crashed. 
If you are sure that it was your query that has crashed it,
report it through the bug report system.


Happy Querying!

More info at
http://www.sdss.jhu.edu/


Documentation suggestions to
/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/     .       .  |          .
Dennis Dinge                                       .      \|/     .
Bloomberg Center of Physics and Astronomy               ---*---
Johns Hopkins University Baltimore           .        .   /|\        .
email:ddinge@pha.jhu.edu                          .        |   .       .
/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/               .



