ICU-5605 added stuff to the readme, removed an old import from PathModel
X-SVN-Rev: 21451
This commit is contained in:
Andrew J Macheret
parent
ec9e1daca8
commit
d0cd4695db
@ -1,70 +1,110 @@
|
||||
<h3>Introduction</h3>
|
||||
<!--
|
||||
*******************************************************************************
|
||||
* Copyright (C) 2000-2006, International Business Machines Corporation and *
|
||||
* others. All Rights Reserved. *
|
||||
*******************************************************************************
|
||||
-->
|
||||
|
||||
<h3>Contents</h3>
|
||||
|
||||
<ul>
|
||||
<li><a href="#intro">Introduction</a></li>
|
||||
<li><a href="#sysreq">System Requirements</a></li>
|
||||
<li><a href="#install">Installation</a></li>
|
||||
<li><a href="#run">Running ICUTZU</a>
|
||||
<ul>
|
||||
<li><a href="#gui">Running in GUI Mode</a></li>
|
||||
<li><a href="#cmd">Running in Command-line Mode</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#restore">Restoring Changes</a></li>
|
||||
<!-- <li><a href="#version">Version History</a></li> -->
|
||||
</ul>
|
||||
|
||||
|
||||
<a name="intro"><h3>Introduction</h3></a>
|
||||
|
||||
<p>ICU4J Time Zone Update Utility (ICUTZU) is a utility that supplies ICU4J jar files with the latest time zone information and daylight savings time changeover dates.</p>
|
||||
<p>The time zone data is stored in zoneinfo.res files which are generated by the ICU team using the Olson Time Zone Database (<a href="http://www.twinsun.com/tz/tz-link.htm">http://www.twinsun.com/tz/tz-link.htm</a>). Every version of the time zone data corresponds directly to a version of the Olson database. For example "2006a" refers to the first refresh of the Olson database in 2006.</p>
|
||||
<p>ICUTZU works by searching the file system for ICU4J jar files containing old time zone data, checking online for the newest time zone data and updating the ICU4J jar files accordingly. The user can choose to update from a copy of the time zone data that comes bundled with ICUTZU or from an online copy on the ICU servers.</p>
|
||||
|
||||
<h3>Installation</h3>
|
||||
<a name="sysreq"><h3>System Requirements</h3></a>
|
||||
|
||||
<p>ICUTZU will run on any system that ICU4J runs on: Solaris 5.9, 5.10, AIX 5.2, 5.3, RHEL 4, 5, Windows XP, Vista, HP-UX 9000.</p>
|
||||
<p>ICUTZU also requires Java 1.3 or higher to run.</p>
|
||||
|
||||
<a name="install"><h3>Installation</h3></a>
|
||||
|
||||
<p>Unpack the archive into a directory of your choosing. For Unix-based systems, you will need to set permissions on runicutzu.sh:</p>
|
||||
<p><code>chmod 755 runicutzu.sh</code></p>
|
||||
|
||||
<h3>Running ICUTZU</h3>
|
||||
<a name="run"><h3>Running ICUTZU</h3></a>
|
||||
|
||||
<h4>GUI</h4>
|
||||
<a name="gui"><h4>GUI</h4></a>
|
||||
<ol>
|
||||
<li>To start ICUTZU, double-click <b>icutzu.jar</b> or open a console and type <code>java -jar icutzu.jar</code> .</li>
|
||||
<li><p>To start ICUTZU, double-click <b>icutzu.jar</b> or open a console and type <code>java -jar icutzu.jar</code> .</p></li>
|
||||
<li>
|
||||
Specify which paths to search and which paths to exclude from the search. By default, all drives are included in the search.
|
||||
<p>Specify which paths to search and which paths to exclude from the search. By default, all drives are included in the search.</p>
|
||||
<ul>
|
||||
<li>To include a path in the search, select <b>Include</b> from the drop-down menu, and either type the path in the text field and press enter, or simply browse for the path.</li>
|
||||
<li>To exclude a path from the search, do the same as above, but select <b>Exclude</b> from the drop-down menu.</li>
|
||||
<li>To specify whether to search subdirectories, check or uncheck the "Search Subdirectories" option.</li>
|
||||
<li>For additional options, right-click the directory list for a context-menu.</li>
|
||||
<li><p>To include a path in the search, select <b>Include</b> from the drop-down menu, and either type the path in the text field and press enter, or simply browse for the path.</p></li>
|
||||
<li><p>To exclude a path from the search, do the same as above, but select <b>Exclude</b> from the drop-down menu.</p></li>
|
||||
<li><p>To specify whether to search subdirectories, check or uncheck the "Search Subdirectories" option.</p></li>
|
||||
<li><p>For additional options, right-click the directory list for a context-menu.</p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p>Click <b>Search</b> to begin searching for updatable ICU4J jar files in the directories specified. A new window will pop up during the search with a list of updatable ICU4J jar files found.</p></li>
|
||||
<li>
|
||||
Click <b>Search</b> to begin searching for updatable ICU4J jar files in the directories specified. A new window will pop up during the search with a list of updatable ICU4J jar files found.
|
||||
<p>Select which ICU4J jar files you wish to update.</p>
|
||||
<ul><li><p><b>ICU Version</b> refers to the version of the ICU4J jar file itself, and <b>TZ Version</b> refers to version of the time zone data within the jar file.</p></li></ul>
|
||||
</li>
|
||||
<li>
|
||||
Select which ICU4J jar files you wish to update.
|
||||
<ul><li><b>ICU Version</b> refers to the version of the ICU4J jar file itself, and <b>TZ Version</b> refers to version of the time zone data within the jar file.</li></ul>
|
||||
</li>
|
||||
<li>Choose the version of time zone data to update with from the drop down list.</li>
|
||||
<li>Click <b>Update</b> to begin updating the selected ICU4J jar files.</li>
|
||||
<li><p>Choose the version of time zone data to update with from the drop down list.</p></li>
|
||||
<li><p>Click <b>Update</b> to begin updating the selected ICU4J jar files.</p></li>
|
||||
</ol>
|
||||
|
||||
<h4>Command-line</h4>
|
||||
<a name="cmd"><h4>Command-line</h4></a>
|
||||
|
||||
<ol>
|
||||
<li>
|
||||
Edit the <b>DirectorySearch.txt</b> file and specify which paths ICUTZU will include and exclude in its search. ICUTZU searches directories recursively.
|
||||
<p>Edit the <b>DirectorySearch.txt</b> file and specify which paths ICUTZU will include and exclude in its search. ICUTZU searches directories recursively.</p>
|
||||
<ul>
|
||||
<li><i>all</i> means include all file system roots in the search (for Windows this will include all drives, for Unix-based systems this will include the root directory).</li>
|
||||
<li><i>+path</i> means to include <i>path</i> in the search.</li>
|
||||
<li><i>-path</i> means to exclude <i>path</i> in the search.</li>
|
||||
<li><p><i>all</i> means include all file system roots in the search (for Windows this will include all drives, for Unix-based systems this will include the root directory).</p></li>
|
||||
<li><p><i>+path</i> means to include <i>path</i> in the search.</p></li>
|
||||
<li><p><i>-path</i> means to exclude <i>path</i> in the search.</p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Edit the <b>runicutzuenv.X</b> file, where X depends on your system (<b>.sh</b> for Unix-based systems, <b>.bat</b> for Windows, <b>.cmd</b> for Windows NT):
|
||||
<p>Edit the <b>runicutzuenv.X</b> file, where X depends on your system (<b>.sh</b> for Unix-based systems, <b>.bat</b> for Windows, <b>.cmd</b> for Windows NT):</p>
|
||||
<ul><table>
|
||||
<tr><td valign=top><li><b>JAVA_HOME</b>:</td><td>Set this to the path where java is installed on your machine (ie. C:\Program Files\Java\jdk1.5.0 for Windows or /usr/jdk1.5.0 for Unix).</li></td></tr>
|
||||
<tr><td valign=top><li><b>NOGUI</b>:</td><td>Set this to <b>true</b> to run in command-line mode.</li></td></tr>
|
||||
<tr><td valign=top><li><b>DISCOVERONLY</b>:</td><td>Set this to <b>true</b> the first time ICUTZU is run. When true, ICUTZU will build a list of updatable ICU4J jar files and save it to ICUList.txt. When false, ICUTZU will procede to update the files listed in ICUList.txt.</li></td></tr>
|
||||
<tr><td valign=top><li><b>SILENTPATCH</b>:</td><td>Set this to <b>false</b> for normal running, or true to give no output except in the case of an error. This option does not effect the content of the log file.</li></td></tr>
|
||||
<tr><td valign=top><li><b>OFFLINE</b>:</td><td>Set this to <b>false</b> for normal running, or true to keep ICUTZU from checking online for the latest time zone data and to use the local copy bundled with ICUTZU instead.</li></td></tr>
|
||||
<tr><td valign=top><li><p><b>JAVA_HOME</b>:</td><td>Set this to the path where java is installed on your machine (ie. C:\Program Files\Java\jdk1.5.0 for Windows or /usr/jdk1.5.0 for Unix).</p></li></td></tr>
|
||||
<tr><td valign=top><li><p><b>NOGUI</b>:</td><td>Set this to <b>true</b> to run in command-line mode.</p></li></td></tr>
|
||||
<tr><td valign=top><li><p><b>DISCOVERONLY</b>:</td><td>Set this to <b>true</b> the first time ICUTZU is run. When true, ICUTZU will build a list of updatable ICU4J jar files and save it to ICUList.txt. When false, ICUTZU will procede to update the files listed in ICUList.txt.</p></li></td></tr>
|
||||
<tr><td valign=top><li><p><b>SILENTPATCH</b>:</td><td>Set this to <b>false</b> for normal running, or true to give no output except in the case of an error. This option does not effect the content of the log file.</p></li></td></tr>
|
||||
<tr><td valign=top><li><p><b>OFFLINE</b>:</td><td>Set this to <b>false</b> for normal running, or true to keep ICUTZU from checking online for the latest time zone data and to use the local copy bundled with ICUTZU instead.</p></li></td></tr>
|
||||
</table></ul>
|
||||
</li>
|
||||
<li>Run <b>runicutzu.X</b> where X depends on your system (as above). This will build a list of updatable ICU4J files and save it to ICUList.txt.</li>
|
||||
<li>Edit the <b>runicutzuenv.X</b> file again, and set DISCOVERONLY to <b>false</b>..</li>
|
||||
<li>Run <b>runicutzu.X</b> again. This will update the files listed in ICUList.txt.</li>
|
||||
<li><p>Run <b>runicutzu.X</b> where X depends on your system (as above). This will build a list of updatable ICU4J files and save it to ICUList.txt.</p></li>
|
||||
<li><p>Edit the <b>runicutzuenv.X</b> file again, and set DISCOVERONLY to <b>false</b>..</p></li>
|
||||
<li><p>Run <b>runicutzu.X</b> again. This will update the files listed in ICUList.txt.</p></li>
|
||||
</ol>
|
||||
|
||||
<h3>Restoring Changes</h3>
|
||||
<a name="restore"><h3>Restoring Changes</h3></a>
|
||||
|
||||
<p>
|
||||
When updating an icu4j jar file, the original file is copied to a backup location which is reported during runtime in the console output (which can also be found in the log file).
|
||||
<ul>
|
||||
<li>The backup location is of the form <i>[icutzu home]<b>/Temp/</b>[prefix]<b>/</b>[prefix][unique id]<b>.jar</b></i>, where <i>[prefix]</i> is the filename of the original icu4j jar file without the .jar at the end.</li>
|
||||
<li>The txt file in the same directory that shares the same unique id specifies the original location.</li>
|
||||
<li><p>The backup location is of the form <i>[icutzu home]<b>/Temp/</b>[prefix]<b>/</b>[prefix]~[unique id]<b>.jar</b></i>, where <i>[prefix]</i> is the filename of the original icu4j jar file without the .jar at the end.</p></li>
|
||||
<li><p>The txt file in the same directory that shares the same <i>[unique id]</i> specifies the original location.</p></li>
|
||||
<li>
|
||||
<p>Example: If ICUTZU is running from <b>c:\icutzu</b> and updates <b>c:\icu4j_3-6.jar</b>, the backup will be stored in <b>c:\icutzu\icu4j\icu4j_3-6~</b><i>[unique id]</i><b>.jar</b>.</p>
|
||||
<p>The file <b>c:\icutzu\icu4j\icu4j_3-6~</b><i>[unique id]</i><b>.txt</b> will contain the original path of icu4j_3-6.jar.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</p>
|
||||
|
||||
<!--
|
||||
|
||||
<a name="version"><h3>Version History</h3></a>
|
||||
|
||||
Version history information will go here.
|
||||
|
||||
-->
|
||||
Loading…
Reference in New Issue
Block a user