--- /dev/null
+<HTML>\r
+<HEAD>\r
+ <!-- Created by GNNpress -->\r
+ <!-- Changed by: Anselm Baird-Smith, 4-Feb-1997 -->\r
+ <TITLE>Jigsaw installation procedure</TITLE>\r
+</HEAD>\r
+<BODY BGCOLOR="#FFFFFF">\r
+<P>\r
+<A HREF="http://www.w3.org/" TARGET="_top_"><IMG SRC="/icons/WWW/w3c_home"\r
+ ALT="w3c" BORDER=0 HEIGHT=48 WIDTH=72></A> <A HREF="http://www.w3.org/Jigsaw"\r
+ TARGET="_top_"><IMG SRC="/icons/jigsaw" ALT="Jigsaw" BORDER=0 HEIGHT=49\r
+ WIDTH=212></A>\r
+<H1>\r
+ Installation Procedure\r
+</H1>\r
+<H3>\r
+ Prerequisite\r
+</H3>\r
+<P>\r
+Before reading further make sure:\r
+<UL>\r
+ <LI>\r
+ That you have downloaded the latest <B>Jigsaw</B> distribution (version 1.0beta)\r
+ <LI>\r
+ That you have downloaded any implementation of <B>Java</B> for your platform\r
+ (<B>Jigsaw</B> 1.0beta will compile and run only with a 1.1 JDK)\r
+ <LI>\r
+ If you're using the zip distribution, make sure it's at least version\r
+ 6.x\r
+</UL>\r
+<P>\r
+This document describes how to install <B>Jigsaw</B>. As an example, we are\r
+assuming that you are running either on Windows (be it 95 or NT) or on UNIX,\r
+even though <B>Jigsaw</B> will (should ?) run on <I>any</I> platform that\r
+supports <B>Java</B>.\r
+<P>\r
+The installation process involves the following steps:\r
+<UL>\r
+ <LI>\r
+ <A HREF="#unpack">Unpack the distribution file</A>\r
+ <LI>\r
+ <A HREF="#env">Set up some environment variables</A>\r
+ <LI>\r
+ <A HREF="#run">Run <B>Jigsaw</B></A>\r
+</UL>\r
+<H2>\r
+ Note on upgrading (<A HREF="#unpack">skip if not upgrading</A>)\r
+</H2>\r
+<P>\r
+The upgrade may require two steps if you are upgrading from a version earlier\r
+than alpha5. If it is not the case, read the following section, otherwise,\r
+go to the <A HREF="#upgradealpha5">Alpha4 to Alpha5 </A>part before upgrading\r
+to beta.\r
+<H3>\r
+ Upgrade from 1.0alpha5 to 1.0beta<A NAME="upgradebeta"></A><!-- -->\r
+</H3>\r
+<P>\r
+Once again, an automatic upgrade from your old version of <B>Jigsaw</B> has\r
+been provided. During the upgrade process, <B>Jigsaw</B> will give you\r
+information about this upgrade process. Be sure to have the upgrade package\r
+needed for this operation, <TT>upgrade.zip </TT>for Windows,\r
+<TT>upgrade.tar.gz</TT> for UNIX. Those packages are in the\r
+<TT>Jigsaw/upgrade</TT> directory.\r
+<P>\r
+It is strongly recommended to keep a backup of your current configuration.\r
+Backup'ing the configuration can be done using any tools, if <I>INSTDIR</I>\r
+is the place where you installed the previous release of <B>Jigsaw</B>:\r
+<TABLE BORDER CELLPADDING=2 >\r
+ <CAPTION>\r
+ Backuping the config \r
+ </CAPTION>\r
+ <TR>\r
+ <TD>UNIX</TD>\r
+ <TD>cd <I>INSTDIR</I>; tar cvf - config > config.tar</TD>\r
+ </TR>\r
+ <TR>\r
+ <TD>Windows</TD>\r
+ <TD>cd <I>INSTDIR</I>; zip -r config.zip config</TD>\r
+ </TR>\r
+</TABLE>\r
+<P>\r
+If you use the following instructions, you can re-install using:\r
+<TABLE BORDER CELLPADDING=2 >\r
+ <CAPTION>\r
+ Restoring a backed up configuration \r
+ </CAPTION>\r
+ <TR>\r
+ <TD>UNIX</TD>\r
+ <TD>cd <I>INSTDIR</I>; tar xomvf - config.tar</TD>\r
+ </TR>\r
+ <TR>\r
+ <TD>Windows</TD>\r
+ <TD>cd <I>INSTDIR</I>; unzip config.zip</TD>\r
+ </TR>\r
+</TABLE>\r
+<P>\r
+Now, you must install the new configuration files in your configuration\r
+directory, taken from the update zip.\r
+<TABLE BORDER CELLPADDING=2 >\r
+ <CAPTION>\r
+ Installing the new configuration files \r
+ </CAPTION>\r
+ <TR>\r
+ <TD>UNIX</TD>\r
+ <TD>cd <I>INSTDIR/</I>Jigsaw/Jigsaw/config; gzip -c -d upgrade.tar.gz | tar\r
+ xomvf -</TD>\r
+ </TR>\r
+ <TR>\r
+ <TD>Windows</TD>\r
+ <TD>cd <I>INSTDIR</I>/Jigsaw/Jigsaw/config; unzip upgrade.zip</TD>\r
+ </TR>\r
+</TABLE>\r
+<P>\r
+Be careful, if you have already an "admin" realm for your Authentification,\r
+be sure to put back the backuped version. This realm is used by the\r
+administration server.\r
+<P>\r
+To complete the upgrade of <B>Jigsaw</B>, you only have to start jigsaw\r
+(<TT>w3c.jigsaw.Main</TT>). During this last step, <B>Jigsaw</B> will emit\r
+traces of what happened, the result will be stored in\r
+<TT>INSTDIR/Jigsaw/Jigsaw/config/upgrade2to3.txt</TT>. Check this file for\r
+errors.\r
+<H3>\r
+ Upgrade from 1.0alpha4 to 1.0alpha5<A NAME="upgradealpha5"></A><!-- -->\r
+</H3>\r
+<P>\r
+For those of you who have already installed a previous release of\r
+<B>Jigsaw</B>, you should be aware that since version 1.0alpha4,\r
+<B>Jigsaw</B> has a facility for automatically upgrading your configuration\r
+files. You will note that the first time you run a newer release of\r
+<B>Jigsaw</B>, it will tell you about that upgrading process, and how it\r
+goes.\r
+<P>\r
+<B>Note</B>: for the upgrade process to happen, it is <I>mandatory</I> that\r
+you run <B>Jigsaw</B> the old way, through the <TT>w3c.jigsaw.http.httpd</TT>\r
+class. Once the upgrade is done, you can safely start using the modern command\r
+line (ie the <TT>w3c.jigsaw.Main</TT>). That's a bug !\r
+<P>\r
+It is recommended that you keep a backup of the previous configuration, by\r
+packing all the <TT>config</TT> directory in an archive file. Backup'ing\r
+the configuration can be done using any tools, if <I>INSTDIR</I> is the place\r
+where you installed the previous release of <B>Jigsaw</B>:\r
+<TABLE BORDER CELLPADDING=2 >\r
+ <CAPTION>\r
+ Backuping the config \r
+ </CAPTION>\r
+ <TR>\r
+ <TD>UNIX</TD>\r
+ <TD>cd <I>INSTDIR</I>; tar cvf - config > config.tar</TD>\r
+ </TR>\r
+ <TR>\r
+ <TD>Windows</TD>\r
+ <TD>cd <I>INSTDIR</I>; zip -r config.zip config</TD>\r
+ </TR>\r
+</TABLE>\r
+<P>\r
+If you use the following instructions, you can re-install using:\r
+<TABLE BORDER CELLPADDING=2 >\r
+ <CAPTION>\r
+ Restoring a backed up configuration \r
+ </CAPTION>\r
+ <TR>\r
+ <TD>UNIX</TD>\r
+ <TD>cd <I>INSTDIR</I>; tar xomvf - config.tar</TD>\r
+ </TR>\r
+ <TR>\r
+ <TD>Windows</TD>\r
+ <TD>cd <I>INSTDIR</I>; unzip config.zip</TD>\r
+ </TR>\r
+</TABLE>\r
+<P>\r
+Last but not least, once your configuration has been upgraded, you may want\r
+:\r
+<UL>\r
+ <LI>\r
+ To copy the <TT>Jigsaw/Jigsaw/WWW/Admin</TT> directory into your (empty ?)\r
+ <TT>Admin</TT> directory, the <TT>Overview.html</TT> document available there\r
+ provides a nice frame based toolbar.\r
+ <LI>\r
+ To install a\r
+ <TT><A HREF="../Reference/w3c.jigsaw.contrib.SalvagerResource.html">w3c.jigsaw.contrib.SalvagerResource</A></TT>\r
+ and a\r
+ <TT><A HREF="../Reference/w3c.jigsaw.contrib.CheckpointResource.html">w3c.jigsaw.contrib.CheckpointResource</A></TT>\r
+ in your <TT>/Admin</TT> directory\r
+</UL>\r
+<H2>\r
+ <A NAME="unpack"></A>Unpacking the distribution file\r
+</H2>\r
+<P>\r
+Pick a place to unpack the distribution: we'll call this directory the\r
+<I>installation directory</I> (abreviated as <I>INSTDIR</I>). This\r
+can be any directory, you just have to change your current working directory\r
+to it:\r
+<TABLE BORDER CELLPADDING=2 >\r
+ <TR>\r
+ <TD>UNIX</TD>\r
+ <TD><PRE>cd <I>INSTDIR</I>\r
+</PRE>\r
+ </TD>\r
+ </TR>\r
+ <TR>\r
+ <TD>Windows</TD>\r
+ <TD><PRE>cd <I>INSTDIR</I>\r
+</PRE>\r
+ </TD>\r
+ </TR>\r
+</TABLE>\r
+<P>\r
+Now unpack the file:\r
+<TABLE BORDER CELLPADDING=2 >\r
+ <TR>\r
+ <TD>UNIX</TD>\r
+ <TD><PRE>cat jigsaw.tar.gz | gzip -d | tar xomvf -\r
+</PRE>\r
+ </TD>\r
+ </TR>\r
+ <TR>\r
+ <TD>Windows</TD>\r
+ <TD><PRE>unzip jigsaw.zip\r
+</PRE>\r
+ </TD>\r
+ </TR>\r
+</TABLE>\r
+<P>\r
+This will create a number of directories under the <B>Jigsaw</B> directory:\r
+<DL>\r
+ <DT>\r
+ <TT>Jigsaw/src</TT>\r
+ <DD>\r
+ Contains <B>Jigsaw</B> sources.\r
+ <DT>\r
+ <TT>Jigsaw/classes</TT>\r
+ <DD>\r
+ Contains the pre-compiled classes.\r
+ <DT>\r
+ <TT>Jigsaw/lib</TT>\r
+ <DD>\r
+ Contains some native code support for solaris.\r
+ <DT>\r
+ <TT>Jigsaw/Jigsaw</TT>\r
+ <DD>\r
+ Is a sample root directory to run the server in. This directory in turns\r
+ contain the following sub-directories:\r
+ <DL>\r
+ <DT>\r
+ <TT>Jigsaw/Jigsaw/config</TT>\r
+ <DD>\r
+ Is the configuration directory for the server\r
+ <DT>\r
+ <TT>Jigsaw/Jigsaw/logs</TT>\r
+ <DD>\r
+ Is the normal directory for log files\r
+ <DT>\r
+ <TT>Jigsaw/Jigsaw/bin</TT>\r
+ <DD>\r
+ Contains some shell scripts to help you start <B>Jigsaw</B>.\r
+ <DT>\r
+ <TT>Jigsaw/Jigsaw/cache</TT>\r
+ <DD>\r
+ The directory to use for caching when using <B>Jigsaw</B> as a caching proxy.\r
+ <DT>\r
+ <TT>Jigsaw/Jigsaw/WWW</TT>\r
+ <DD>\r
+ Is your exported file space\r
+ </DL>\r
+</DL>\r
+<P>\r
+You are now ready for the next section, which explains how to setup your\r
+environment.\r
+<H2>\r
+ <A NAME="env"></A>Setting up your environment\r
+</H2>\r
+<P>\r
+As <B>Jigsaw</B> is just a set of Java classes, you need to specify to the\r
+Java interpreter the place where <B>Jigsaw</B> classes are stored. This is\r
+usually done by setting some CLASSPATH environment variable. This is simply\r
+done by the following command:\r
+<TABLE BORDER CELLPADDING=2 >\r
+ <TR>\r
+ <TD>UNIX</TD>\r
+ <TD><PRE># This depends on the shell you are using, we're assuming <TT>/bin/sh</TT>\r
+CLASSPATH=<I>INSTDIR</I>/Jigsaw/classes/jigsaw.zip\r
+export CLASSPATH\r
+</PRE>\r
+ </TD>\r
+ </TR>\r
+ <TR>\r
+ <TD>Windows</TD>\r
+ <TD><PRE>set CLASSPATH=<I>INSTDIR</I>\Jigsaw\classes\jigsaw.zip\r
+</PRE>\r
+ </TD>\r
+ </TR>\r
+</TABLE>\r
+<P>\r
+Don't forget to change <I>INSTDIR</I> with the absolute path of the place\r
+you have unpacked the distribution. You should now\r
+be ready to run <B>Jigsaw</B>.\r
+<P>\r
+<B>Warning</B>: on some Windows Java implementation, prefixing the CLASSPATH\r
+with the disk drive letter may cause some confusion. If java complains about\r
+not being able to find some class, you may want to remove the disk drive\r
+letter from the CLASSPATH.\r
+<H2>\r
+ <A NAME="run"></A>Running <B>Jigsaw</B>\r
+</H2>\r
+<P>\r
+You are now all set to run <B>Jigsaw</B>. Just type in the following command:\r
+<TABLE BORDER CELLPADDING=2 >\r
+ <TR>\r
+ <TD>UNIX</TD>\r
+ <TD><PRE>cd <I>INSTDIR</I>/Jigsaw/Jigsaw\r
+java w3c.jigsaw.Main -host<I> host</I> -root <I>INSTDIR</I>/Jigsaw/Jigsaw\r
+</PRE>\r
+ </TD>\r
+ </TR>\r
+ <TR>\r
+ <TD>Windows</TD>\r
+ <TD><PRE>cd <I>INSTDIR\</I>Jigsaw\Jigsaw\r
+java w3c.jigsaw.Main -host <I>host</I> -root <I>INSTDIR\</I>Jigsaw\Jigsaw\r
+</PRE>\r
+ </TD>\r
+ </TR>\r
+</TABLE>\r
+<P>\r
+Don't forget to susbstitute to <I>INSTDIR</I> the absolute path of the location\r
+where you have unpacked the distribution file, and to <I>host</I> the full\r
+IP hostname of the machine running <B>Jigsaw</B>.\r
+<P>\r
+<B>Jigsaw</B> should be running, and will probably have emited a message\r
+like:\r
+<PRE>www24:Jigsaw$ bin/jigsaw -root `pwd` \r
+loading properties from: /0/w3c/abaird/puzzles/JigEdit/config/server.props\r
+Jigsaw[1.0beta]: serving at http://www43.inria.fr:8009/\r
+</PRE>\r
+<P>\r
+Indicating that it is waiting to meet your browser at the given URL.\r
+<H2>\r
+ Further reading\r
+</H2>\r
+<P>\r
+At this point, it is recommended that you start reading the documentation,\r
+available from your server at <TT>/User</TT> (i.e. in the above example,\r
+the full URL would be <TT>http://www24.w3.org:8001/User</TT>.\r
+<P>\r
+Here is a roadmap to the documentation:\r
+<UL>\r
+ <LI>\r
+ You should first start by reading the <A HREF="architecture.html">architecture\r
+ overview.</A>\r
+ <LI>\r
+ You should then configure your server to meet your need. There are two sources\r
+ of documentation for this stage:\r
+ <UL>\r
+ <LI>\r
+ The <A HREF="../Administration/Overview.html">administration guide</A>\r
+ <LI>\r
+ The <A HREF="../Tutorials/configuration.html">configuration tutorial</A>\r
+ <LI>\r
+ The Jigsaw aministration tool.\r
+ </UL>\r
+ <LI>\r
+ At this point, you should have understood the configuration process, you\r
+ can now browse the rest of the documentation in whatever order you want.\r
+</UL>\r
+<P>\r
+ <HR>\r
+<A HREF="mailto:jigsaw@w3.org">Jigsaw Team</A> <BR>\r
+$Id: installation.html,v 1.1 2010/06/15 12:20:09 smhuang Exp $\r
+</BODY></HTML>\r
projects / Benchmarks_CSolver.git / blobdiff