You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sis.apache.org by bu...@apache.org on 2016/03/03 00:09:50 UTC
svn commit: r981699 - in /websites/staging/sis/trunk/content: ./
command-line.html
Author: buildbot
Date: Wed Mar 2 23:09:50 2016
New Revision: 981699
Log:
Staging update by buildbot for sis
Modified:
websites/staging/sis/trunk/content/ (props changed)
websites/staging/sis/trunk/content/command-line.html
Propchange: websites/staging/sis/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Mar 2 23:09:50 2016
@@ -1 +1 @@
-1733321
+1733388
Modified: websites/staging/sis/trunk/content/command-line.html
==============================================================================
--- websites/staging/sis/trunk/content/command-line.html (original)
+++ websites/staging/sis/trunk/content/command-line.html Wed Mar 2 23:09:50 2016
@@ -96,8 +96,12 @@ h2:hover > .headerlink, h3:hover > .head
<p>A command-line interface is provided for extracting information from a data file.</p>
<div class="toc">
<ul>
-<li><a href="#install">Installation</a></li>
-<li><a href="#usage">Usage</a><ul>
+<li><a href="#install">Installation</a><ul>
+<li><a href="#dependencies">Optional dependencies</a></li>
+</ul>
+</li>
+<li><a href="#usage">Usage</a></li>
+<li><a href="#examples">Examples</a><ul>
<li><a href="#crs">Extracting ISO 19111 Coordinate Reference System (CRS)</a></li>
<li><a href="#metadata">Extracting ISO 19115 Metadata</a></li>
</ul>
@@ -110,22 +114,37 @@ h2:hover > .headerlink, h3:hover > .head
The directory structure will be as below:</p>
<div class="codehilite"><pre>apache-sis-0.6
ââ bin
-ââ lib
+ââ conf
+ââ data
+ââ lib
+ââ log
</pre></div>
<p>The <code>bin</code> sub-directory contains a <code>sis</code> command for Unix systems (Linux or MacOS â we have not yet done a <code>sis.bat</code> file for Windows).
The <code>bin</code> sub-directory can be added to the <code>PATH</code> environment variable for convenience, but this is not mandatory.
-The remaining of this page assumes that <code>bin</code> is on the search path.
+Example:</p>
+<div class="codehilite"><pre><span class="nb">export </span><span class="nv">PATH</span><span class="o">=</span><span class="nv">$PWD</span>/apache-sis-0.6/bin:<span class="nv">$PATH</span>
+</pre></div>
+
+
+<p>The remaining of this page assumes that <code>bin</code> is on the search path.
If not, just prepend the <code>sis</code> command by its path (e.g. <code>./apache-sis-0.6/bin/sis</code>).</p>
+<h2 id="dependencies">Optional dependencies<a class="headerlink" href="#dependencies" title="Permanent link">¶</a></h2>
<p>Every JAR files present in the <code>lib</code> sub-directory will be included on the classpath during the execution of <code>sis</code> command.
By default, the <code>lib</code> directory contains only the SIS archive. However users can add other JAR files in that directory for
the following optional dependencies:</p>
<ul>
-<li><strong>UCAR NetCDF library â</strong>
+<li>
+<p><strong>Derby driver â</strong>
+ needed only if Apache SIS can not locate a JavaDB driver in the JDK installation directory.</p>
+</li>
+<li>
+<p><strong>UCAR NetCDF library â</strong>
by default, SIS uses its own embedded NetCDF reader which supports only the classical NetCDF format, as standardized by OGC.
If there is a need to read files encoded in GRID or HDF formats, then one can copy the UCAR NetCDF library in the <code>lib</code> sub-directory.
- If presents, the UCAR library should be detected and used automatically.</li>
+ If presents, the UCAR library should be detected and used automatically.</p>
+</li>
</ul>
<h1 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">¶</a></h1>
<p>Invoking <code>sis</code> without argument show a summary of available commands and all options.
@@ -134,8 +153,35 @@ For executing a command, the syntax is:<
</pre></div>
+<p>Available commands are:</p>
+<table>
+ <tr><td><code>help</code></td> <td>Show a help overview.</td></tr>
+ <tr><td><code>about</code></td> <td>Show information about Apache SIS and system configuration.</td></tr>
+ <tr><td><code>mime-type</code></td> <td>Show MIME type for the given file.</td></tr>
+ <tr><td><code>metadata</code></td> <td>Show metadata information for the given file.</td></tr>
+ <tr><td><code>crs</code></td> <td>Show Coordinate Reference System information for the given file or code.</td></tr>
+ <tr><td><code>identifier</code></td> <td>Show identifiers for metadata and referencing systems in the given file.</td></tr>
+</table>
+
<p>The set of legal options and the expected number of file arguments depends on the command being executed.
-However all commands support the <code>--help</code> option, which lists the options available for that command.</p>
+However all commands support the <code>--help</code> option, which lists the options available for that command.
+Available options will be from the following list:</p>
+<table>
+ <tr><td><code>--format</code></td> <td>The output format: xml, wkt, wkt1 or text.</td></tr>
+ <tr><td><code>--locale</code></td> <td>The locale to use for the command output.</td></tr>
+ <tr><td><code>--timezone</code></td> <td>The timezone for the dates to be formatted.</td></tr>
+ <tr><td><code>--encoding</code></td> <td>The encoding to use for the command output.</td></tr>
+ <tr><td><code>--colors</code></td> <td>Whether colorized output shall be enabled.</td></tr>
+ <tr><td><code>--brief</code></td> <td>Whether the output should contains only brief information.</td></tr>
+ <tr><td><code>--verbose</code></td> <td>Whether the output should contains more detailed information.</td></tr>
+ <tr><td><code>--debug</code></td> <td>Prints full stack trace in case of failure.</td></tr>
+ <tr><td><code>--help</code></td> <td>Lists the options available for a specific command.</td></tr>
+</table>
+
+<p>The <code>--locale</code>, <code>--timezone</code> and <code>--encoding</code> options apply to the command output sent to the standard output stream,
+but usually do not apply to the error messages sent to the standard error stream.
+The reason is that command output may be targeted to a client, while the error messages are usually for the operator.</p>
+<h1 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">¶</a></h1>
<h2 id="crs">Extracting ISO 19111 Coordinate Reference System (CRS)<a class="headerlink" href="#crs" title="Permanent link">¶</a></h2>
<p>SIS can read a Coordinate Reference System definition from the <em>Well Known Text</em> (WKT) format version 1 and 2,
or from <em>Geographic Markup Language</em> (GML) version 3.2.
@@ -144,28 +190,27 @@ The following example show the CRS of a
</pre></div>
-<p>The above command output should produce the following output:</p>
-<div class="codehilite"><pre>PROJCRS["NTF (Paris) / Lambert zone II",
- BASEGEODCRS["NTF (Paris)",
- DATUM["Nouvelle Triangulation Francaise",
- ELLIPSOID["Clarke 1880 (IGN)", 6378249.2, 293.4660212936269, LENGTHUNIT["metre", 1]]],
- PRIMEM["Paris", 2.5969213, ANGLEUNIT["grade", 0.015707963267948967]]],
- CONVERSION["Lambert zone II",
- METHOD["Lambert Conic Conformal (1SP)", ID["EPSG", 9801]],
- PARAMETER["Latitude of natural origin", 52.0, ANGLEUNIT["grade", 0.015707963267948967], ID["EPSG", 8801]],
- PARAMETER["Longitude of natural origin", 0.0, ANGLEUNIT["grade", 0.015707963267948967], ID["EPSG", 8802]],
- PARAMETER["Scale factor at natural origin", 0.99987742, SCALEUNIT["unity", 1], ID["EPSG", 8805]],
- PARAMETER["False easting", 600000.0, LENGTHUNIT["metre", 1], ID["EPSG", 8806]],
- PARAMETER["False northing", 2200000.0, LENGTHUNIT["metre", 1], ID["EPSG", 8807]]],
+<p><details>
+ <summary>The above command output should produce the following output:</summary>
+<pre>PROJCRS["NTF (Paris) / Lambert zone II",
+ BASEGEODCRS["NTF (Paris)",
+ DATUM["Nouvelle Triangulation Francaise",
+ ELLIPSOID["Clarke 1880 (IGN)", 6378249.2, 293.4660212936269, LENGTHUNIT["metre", 1]]],
+ PRIMEM["Paris", 2.5969213, ANGLEUNIT["grade", 0.015707963267948967]]],
+ CONVERSION["Lambert zone II",
+ METHOD["Lambert Conic Conformal (1SP)", ID["EPSG", 9801]],
+ PARAMETER["Latitude of natural origin", 52.0, ANGLEUNIT["grade", 0.015707963267948967], ID["EPSG", 8801]],
+ PARAMETER["Longitude of natural origin", 0.0, ANGLEUNIT["grade", 0.015707963267948967], ID["EPSG", 8802]],
+ PARAMETER["Scale factor at natural origin", 0.99987742, SCALEUNIT["unity", 1], ID["EPSG", 8805]],
+ PARAMETER["False easting", 600000.0, LENGTHUNIT["metre", 1], ID["EPSG", 8806]],
+ PARAMETER["False northing", 2200000.0, LENGTHUNIT["metre", 1], ID["EPSG", 8807]]],
CS[Cartesian, 2],
- AXIS["Easting (E)", east, ORDER[1]],
- AXIS["Northing (N)", north, ORDER[2]],
- LENGTHUNIT["metre", 1],
- SCOPE["Large and medium scale topographic mapping and engineering survey."],
- ID["EPSG", 27572, URI["urn:ogc:def:crs:EPSG::27572"]]]
-</pre></div>
-
-
+ AXIS["Easting (E)", east, ORDER[1]],
+ AXIS["Northing (N)", north, ORDER[2]],
+ LENGTHUNIT["metre", 1],
+ SCOPE["Large and medium scale topographic mapping and engineering survey."],
+ ID["EPSG", 27572, URI["urn:ogc:def:crs:EPSG::27572"]]]</pre>
+</details></p>
<h2 id="metadata">Extracting ISO 19115 Metadata<a class="headerlink" href="#metadata" title="Permanent link">¶</a></h2>
<p>SIS can read the header of a data file and print the metadata in an ISO 19115 structure.
The data file given in argument can be a local file or a URL.
@@ -180,8 +225,9 @@ As of SIS 0.6, only CF-compliant NetCDF
</pre></div>
-<p>Below is an extract of the above command output:</p>
-<div class="codehilite"><pre>Metadata
+<p><details>
+ <summary>Below is an extract of the above command output:</summary>
+<pre>Metadata
  ââIdentification info
  â   ââCitation
  â   â   ââTitleâ¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦ Sea Surface Temperature Analysis Model
@@ -214,10 +260,8 @@ As of SIS 0.6, only CF-compliant NetCDF
  ââContent info
     ââDimension
         ââDescriptorâ¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦ Sea temperature
-         ââSequence identifierâ¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦ SST
-</pre></div>
-
-
+         ââSequence identifierâ¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦â¦ SST</pre>
+</details></p>
<p>Adding the <code>--format xml</code> option to the above command will format the same metadata in a XML document.
The output is not shown in this page because of its verbosity.</p>
<h1 id="performance">Performance consideration<a class="headerlink" href="#performance" title="Permanent link">¶</a></h1>