Revision: 15268
          http://gate.svn.sourceforge.net/gate/?rev=15268&view=rev
Author:   ian_roberts
Date:     2012-01-30 16:23:59 +0000 (Mon, 30 Jan 2012)
Log Message:
-----------
Cleaned up the misleading (and in some clases plain wrong) bits of the gate.sh
documentation to match the way the launcher now works, and added a note about
gate.class.path/GATE_CLASSPATH.

Modified Paths:
--------------
    userguide/trunk/gettingstarted.tex

Modified: userguide/trunk/gettingstarted.tex
===================================================================
--- userguide/trunk/gettingstarted.tex  2012-01-30 15:50:44 UTC (rev 15267)
+++ userguide/trunk/gettingstarted.tex  2012-01-30 16:23:59 UTC (rev 15268)
@@ -153,13 +153,11 @@
      This can be used to e.g. set properties using the \texttt{java} option
      \texttt{-D}. For example to set the maximum amount of heap memory to be
      used when running GATE to 6000M, you can add
-     \texttt{-DXmx6000m} as a parameter.
-     The name of any property that should get passed on to GATE should be 
prepended
-     with \texttt{'run.'}. 
+     \texttt{-Xmx6000m} as a parameter.
      In order to change the default encoding used by GATE to \texttt{UTF-8} 
add 
-     \texttt{-Drun.file.encoding=utf-8} as a parameter. To specify 
+     \texttt{-Dfile.encoding=utf-8} as a parameter. To specify 
      a log4j configuration file add something like \\
-     
\texttt{-Drun.log4j.configuration=file:///home/myuser/log4jconfig.properties}.
+     \texttt{-Dlog4j.configuration=file:///home/myuser/log4jconfig.properties}.
 \end{description}
 Running GATE Developer with either the \texttt{-ld} or the \texttt{-ln} 
 option from different directories is useful to keep several projects 
@@ -226,19 +224,6 @@
 
 {\tt java -Dgate.home=/my/new/gate/home/directory -cp... gate.Main}
 
-To set these values when running GATE Developer from the command line via
-\verb|ant|, of via the \verb|gate.sh| script, use the following
-syntax, prepending `\texttt{run.}' to the property name,  
-for example to set \texttt{gate.user.config}:
-
-\texttt{ant run -Drun.gate.user.config=/my/path/to/user/config.file} \\
-or  \\
-\texttt{./bin/gate.sh -Drun.gate.user.config=/my/path/to/user/config.file} 
-
-Note that \texttt{gate.home} and some other properties are automatically
-set by \texttt{build.xml} and cannot be overwritten on the command line
-when using either \texttt{ant run} or \texttt{gate.sh}.
-
 When running GATE Developer, you can set the properties by creating a file
 {\tt build.properties} in the top level GATE directory.  In this file, any
 system properties which are prefixed with `{\tt run.}' will be passed to
@@ -255,6 +240,30 @@
 
 {\tt run.java.io.tmpdir=d:/bigtmp}
 
+When running GATE Developer from the command line via \verb|ant| or via the
+{\tt gate.sh} script you can set properties using \verb!-D!.  Note that the
+``run'' prefix is required when using ant:
+
+\texttt{ant run -Drun.gate.user.config=/my/path/to/user/config.file}
+
+but not when using {\tt gate.sh}:
+
+\texttt{./bin/gate.sh -Dgate.user.config=/my/path/to/user/config.file} 
+
+The GATE Developer launcher also supports the system property
+{\tt gate.class.path} to specify additional classpath entries that should be
+added to the classloader that is used to load GATE classes.  This is expected
+to be in the normal ``classpath'' format, i.e. a list of directory or JAR file
+paths separated by semicolons on Windows and colons on other platforms.  The
+standard Java 6 shorthand of {\tt /path/to/directory/*}\footnote{Remember to
+protect the * from expansion by your shell if necessary.} to include all
+{\tt .jar} files from a given directory is also supported.  As an alternative
+to this system property, the environment variable \verb!GATE_CLASSPATH! can be
+used, but the environment variable is only read if the system property is
+{\em not} set.
+
+\texttt{./bin/gate.sh -Dgate.class.path=/shared/lib/myclasses.jar}
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \sect[sec:gettingstarted:gateconfig]{Configuring GATE}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

This was sent by the SourceForge.net collaborative development platform, the 
world's largest Open Source development site.


------------------------------------------------------------------------------
Try before you buy = See our experts in action!
The most comprehensive online learning library for Microsoft developers
is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3,
Metro Style Apps, more. Free future releases when you subscribe now!
http://p.sf.net/sfu/learndevnow-dev2
_______________________________________________
GATE-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gate-cvs

Reply via email to