/usr/share/doc/stilts/sun256/invoke.html is in stilts-doc 3.1.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 | <html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="sun-style.css">
<title>Invocation</title>
</head>
<body>
<hr>
<a href="jvmClasspath.html">Next</a> <a href="sec2.4.html">Previous</a> <a href="index.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="jvmClasspath.html">Class Path</a><br>
<b>Up: </b><a href="index.html">Top</a><br>
<b>Previous: </b><a href="sec2.4.html">Getting Help</a><br>
<hr>
<hr>
<h2><a name="invoke">3 Invocation</a></h2>
<p>There are a number of ways of invoking the <code>stilts</code> command,
depending on how you have installed the package.
This section describes how to invoke it from the command line.
An alternative, using it from Jython (the Java implementation of
the Python language), is described in <a href="jystilts.html">Section 4</a>.
</p>
<p>If you're using a Unix-like operating system,
the easiest way is to use the <code>stilts</code> script.
If you have a full starjava installation it is in the
<code>starjava/bin</code> directory.
Otherwise you can download it separately from wherever you got your
STILTS installation in the first place, or find it
at the top of the <code>stilts.jar</code> or <code>topcat-*.jar</code>
that contains your STILTS installation, so do something like
<pre>
unzip stilts.jar stilts
chmod +x stilts
</pre>
to extract it (if you don't have <code>unzip</code>,
try <code>jar xvf stilts.jar stilts</code>).
<code>stilts</code> is a simple shell script which just invokes java with the
right classpath and the supplied arguments.
</p>
<p>To run using the <code>stilts</code> script, first make sure that
both the <code>java</code>
executable and the <code>stilts</code> script itself are on your path,
and that the <code>stilts.jar</code> or <code>topcat-*.jar</code>
jar file is in the same directory as <code>stilts</code>.
Then the form of invocation is:
<pre>
stilts <java-flags> <stilts-flags> <task-name> <task-args>
</pre>
A simple example would be:
<pre>
stilts votcopy format=binary t1.xml t2.xml
</pre>
in this case, as often, there are no <code><java-flags></code> or
<code><stilts-flags></code>.
If you use the <code>-classpath</code>
argument or have a CLASSPATH environment variable set,
then classpath elements thus specified will be added to the classpath
required to run the command.
The examples in the
command descriptions below use this form for convenience.
</p>
<p>If you don't have a Unix-like shell available however,
you will need to invoke
Java directly with the appropriate classes on your classpath.
If you have the file <code>stilts.jar</code>, in most cases you can
just write:
<pre>
java <java-flags> -jar stilts.jar <stilts-flags> <task-name> <task-args>
</pre>
which in practice would look something like
<pre>
java -jar /some/where/stilts.jar votcopy format=binary t1.xml t2.xml
</pre>
</p>
<p>In the most general case, Java's <code>-jar</code> flag might be
no good, for one of the following reasons:
<ol>
<li>You have the classes in some form other than the <code>stilts.jar</code>
file (such as <code>topcat-full.jar</code>)
</li>
<li>You need to specify some extra classes on the classpath, which is
required e.g. for use with
<a href="jdbcConfig.html">JDBC</a>
or if you are
<a href="jelExtend.html">extending the commands</a>
using your own classes at runtime
</li>
</ol>
In this case, you will need an invocation of this form:
<pre>
java <java-flags> -classpath <class-path>
uk.ac.starlink.ttools.Stilts <stilts-flags> <task-name> <task-args>
</pre>
The example above in this case would look something like:
<pre>
java -classpath /some/where/topcat-full.jar uk.ac.starlink.ttools.Stilts
votcopy format=binary t1.xml t2.xml
</pre>
</p>
<p>Finally, as a convenience, it is possible to run STILTS from a
<a href="http://www.starlink.ac.uk/topcat/">TOPCAT</a>
installation by using its <code>-stilts</code> flag, like this:
<pre>
topcat <java-flags> -stilts <stilts-flags> <task-name> <task-args>
</pre>
This is possible because TOPCAT is built on top of STILTS, so contains
a superset of its code.
</p>
<p>The
<code><stilts-flags></code>,
<code><task-name></code> and
<code><task-args></code>
parts of these invocations are explained in <a href="stilts-cmd.html">Section 2</a>,
and the
<code><class-path></code> and
<code><java-flags></code>
parts are explained in the following subsections.
</p>
<ul>
<li><a href="jvmClasspath.html">3.1 Class Path</a></li>
<li><a href="jvmArgs.html">3.2 Java Flags</a></li>
<li><a href="sysProperties.html">3.3 System Properties</a></li>
<li><a href="jdbcConfig.html">3.4 JDBC Configuration</a></li>
</ul>
<hr><a href="jvmClasspath.html">Next</a> <a href="sec2.4.html">Previous</a> <a href="index.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="jvmClasspath.html">Class Path</a><br>
<b>Up: </b><a href="index.html">Top</a><br>
<b>Previous: </b><a href="sec2.4.html">Getting Help</a><br>
<hr><i>STILTS - Starlink Tables Infrastructure Library Tool Set<br>Starlink User Note256<br>STILTS web page:
<a href="http://www.starlink.ac.uk/stilts/">http://www.starlink.ac.uk/stilts/</a><br>Author email:
<a href="mailto:m.b.taylor@bristol.ac.uk">m.b.taylor@bristol.ac.uk</a><br>Mailing list:
<a href="mailto:topcat-user@jiscmail.ac.uk">topcat-user@jiscmail.ac.uk</a><br></i></body>
</html>
|