OSDN Git Service

Update MANUAL*
[stew/Stew4.git] / MANUAL.html
index eb15a89..8b4af46 100644 (file)
@@ -12,7 +12,7 @@
 <body>\r
 <header>\r
 <h1 class="title">Stew4 User Manual</h1>\r
-<h3 class="date">version 4.0</h3>\r
+<h3 class="date">version 4.1</h3>\r
 </header>\r
 <nav id="TOC">\r
 <ul>\r
@@ -40,7 +40,7 @@
 <li><a href="#rollback---rollbacks-current-transaction-built-in">rollback - Rollbacks current transaction (built-in)</a></li>\r
 <li><a href="#e---evaluates-multiple-commands-built-in">-e - Evaluates multiple commands (built-in)</a></li>\r
 <li><a href="#f---executes-file-content-as-command-built-in">-f - Executes file content as command (built-in)</a></li>\r
-<li><a href="#s---executes-file-content-as-script-built-in">-s - Executes file content as script (built-in)</a></li>\r
+<li><a href="#s---executes-file-content-as-script-built-in-improved-feature-in-version-4.1">-s - Executes file content as script (built-in) &lt;improved feature in version 4.1&gt;</a></li>\r
 <li><a href="#cd---changes-current-directory-built-in">cd - Changes current directory (built-in)</a></li>\r
 <li><a href="#displays-directories-built-in">@ - Displays directories (built-in)</a></li>\r
 <li><a href="#displays-system-properties-built-in">? - Displays System Properties (built-in)</a></li>\r
 </ul>\r
 </nav>\r
 <h2 id="what-is-stew"><a href="#TOC">What Is Stew ?</a></h2>\r
-<p>...</p>\r
+<p>Stew is the database (SQL) tool with JDBC.</p>\r
+<p>For details, see &quot;README.md&quot;.</p>\r
 <h2 id="precautions"><a href="#TOC">PRECAUTIONS</a></h2>\r
 <h3 id="password-management"><a href="#TOC">Password Management</a></h3>\r
-<p>...</p>\r
-<p>For details, see <a href="#Connector-Settings">How To Use - Connector Settings</a>.</p>\r
+<p>By defaults, passwords are not encrypted. Setting &quot;Encryption&quot; in the connector will encrypt the password.</p>\r
+<p>For details, see <a href="#configuration-of-connector">How To Use - Configuration Of &quot;Connector&quot;</a>.</p>\r
 <h3 id="rollback-does-not-work-when-the-connection-is-disconnecting"><a href="#TOC">Rollback Does Not Work When The Connection Is Disconnecting</a></h3>\r
-<p>...</p>\r
-<p>For details, see <a href="#Connector-Settings">How To Use - Connector Settings</a>.</p>\r
+<p>By defaults, Rollback does not work automatically on disconnect. You have to care that some of DBMSs commit on disconnect.</p>\r
+<p>Setting &quot;Auto Rollback&quot; in the connector will rollback automatically on disconnect.</p>\r
+<p>For details, see <a href="#configuration-of-connector">How To Use - Configuration Of &quot;Connector&quot;</a>.</p>\r
 <h3 id="other"><a href="#TOC">Other</a></h3>\r
 <p>For more information, see the project site. <a href="http://stew.sourceforge.jp/"><code class="url">http://stew.sourceforge.jp/</code></a></p>\r
 <h2 id="installation"><a href="#TOC">Installation</a></h2>\r
-<p>...</p>\r
+<p>Just extract the package archive file.</p>\r
 <h2 id="running-app"><a href="#TOC">Running App</a></h2>\r
 <p>If you want to use GUI mode, execute the following command:</p>\r
 <pre><code>&gt; java -jar stew.jar --gui</code></pre>\r
@@ -220,14 +222,21 @@ $ stew --edit
 <h3 id="f---executes-file-content-as-command-built-in"><a href="#TOC">-f - Executes file content as command (built-in)</a></h3>\r
 <pre><code>&gt; -f &lt;file&gt;</code></pre>\r
 <p>...</p>\r
-<h3 id="s---executes-file-content-as-script-built-in"><a href="#TOC">-s - Executes file content as script (built-in)</a></h3>\r
-<pre><code>&gt; -s &lt;file&gt;</code></pre>\r
-<p>( default=JavaScript )</p>\r
-<p>The following variables will be available in the script:</p>\r
+<h3 id="s---executes-file-content-as-script-built-in-improved-feature-in-version-4.1"><a href="#TOC">-s - Executes file content as script (built-in) &lt;improved feature in version 4.1&gt;</a></h3>\r
+<pre><code>&gt; -s . | &lt;SCRIPT FILE&gt; | &lt;SCRIPT-NAME&gt; &lt;SCRIPT-CODE&gt;</code></pre>\r
+<ol type="1">\r
+<li>If the first argument is &quot;.&quot;, the Script Context is reset.</li>\r
+<li>If the first argument is a filename with extension, the script language is identified by the extension, and the file is run as the script language's script.</li>\r
+<li>Otherwise, the first argument is recognized as the name of a script language, and the rest of arguments are executed as the script language's script.</li>\r
+</ol>\r
+<p>(Only the built-in JavaScript by file is supported in version 4.0.)</p>\r
+<p>To use script languages except the built-in script language (JavaScript), it requires each script engine of script languages such as jruby, jython and groovy.</p>\r
+<p>The Script Context keeps global scope bindings, and following scripts can reuse the bindings. If you want to reset Script Context, input &quot; -s . &quot; above.</p>\r
+<p>The following variables will be available in the script (global scope):</p>\r
 <ul>\r
-<li>object of current connection: connection, conn</li>\r
-<li>object of Parameter: parameter, p</li>\r
-<li>object of OutputProcessor: outputProcessor, op</li>\r
+<li>the reference of current connection: connection, conn</li>\r
+<li>the reference of Parameter: parameter, p</li>\r
+<li>the reference of OutputProcessor: outputProcessor, op</li>\r
 </ul>\r
 <h3 id="cd---changes-current-directory-built-in"><a href="#TOC">cd - Changes current directory (built-in)</a></h3>\r
 <pre><code>&gt; cd &lt;directory&gt;</code></pre>\r