OSDN Git Service

Update MANUAL* v4.1.0-beta2
authorargius <argius.net@gmail.com>
Fri, 20 Dec 2013 11:43:26 +0000 (20:43 +0900)
committerargius <argius.net@gmail.com>
Fri, 20 Dec 2013 11:43:26 +0000 (20:43 +0900)
MANUAL.html
MANUAL.md
MANUAL_ja.html
MANUAL_ja.md

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
index d8ef224..c598eaf 100644 (file)
--- a/MANUAL.md
+++ b/MANUAL.md
@@ -1,30 +1,33 @@
 % Stew4 User Manual
 %
-% version 4.0
+% version 4.1
 
 
 ## What Is Stew ?
 
-...
+Stew is the database (SQL) tool with JDBC.
+
+For details, see "README.md".
 
 
 ## PRECAUTIONS
 
 ### Password Management
 
-...
-
+By defaults, passwords are not encrypted.
+Setting "Encryption" in the connector will encrypt the password.
 
-For details, see [How To Use - Connector Settings](#Connector-Settings).
+For details, see [How To Use - Configuration Of "Connector"](#configuration-of-connector).
 
 
 ### Rollback Does Not Work When The Connection Is Disconnecting
 
+By defaults, Rollback does not work automatically on disconnect.
+You have to care that some of DBMSs commit on disconnect.
 
-...
-
+Setting "Auto Rollback" in the connector will rollback automatically on disconnect.
 
-For details, see [How To Use - Connector Settings](#Connector-Settings).
+For details, see [How To Use - Configuration Of "Connector"](#configuration-of-connector).
 
 
 ### Other
@@ -35,9 +38,7 @@ For more information, see the project site.
 
 ## Installation
 
-
-...
-
+Just extract the package archive file.
 
 
 ## Running App
@@ -182,17 +183,27 @@ For example, you can execute two export command continuously,
 ...
 
 
-### -s - Executes file content as script (built-in)
+### -s - Executes file content as script (built-in) \<improved feature in version 4.1\>
+
+    > -s . | <SCRIPT FILE> | <SCRIPT-NAME> <SCRIPT-CODE>
+
+ 1. If the first argument is ".", the Script Context is reset.
+ 2. 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.
+ 3. 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.
+
+(Only the built-in JavaScript by file is supported in version 4.0.)
+
+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.
 
-    > -s <file>
+The Script Context keeps global scope bindings, and following scripts can reuse the bindings.
+If you want to reset Script Context, input " -s . " above.
 
-( default=JavaScript )
 
-The following variables will be available in the script:
+The following variables will be available in the script (global scope):
 
- * object of current connection: connection, conn
- * object of Parameter: parameter, p
- * object of OutputProcessor: outputProcessor, op
+ * the reference of current connection: connection, conn
+ * the reference of Parameter: parameter, p
+ * the reference of OutputProcessor: outputProcessor, op
 
 
 ### cd - Changes current directory (built-in)
@@ -223,9 +234,9 @@ By defauts, it displays JRE, OS and Locale.
     OS : ...
     Locale : ja_JP
     > ? java.version user.timezone zzz
-    java.version=[1.6.0_##]\r
-    user.timezone=[Europe/London]\r
-    zzz=undefined\r
+    java.version=[1.6.0_##]
+    user.timezone=[Europe/London]
+    zzz=undefined
 
 
 ### alias - Registers alias (built-in)
@@ -507,7 +518,7 @@ just connected: connector as a root node and sub nodes ...
 Each node expands ...
 
 
-An "Auto-expansion" is a function to automatically expands nodes in the database info tree when connecting a database.\r
+An "Auto-expansion" is a function to automatically expands nodes in the database info tree when connecting a database.
 If you use it, create a TSV file named "autoexpansion.tsv" in the system directory (.stew) and write node name lists as TSV into this file.
 
 
index 66e15aa..c8fd524 100644 (file)
@@ -12,7 +12,7 @@
 <body>\r
 <header>\r
 <h1 class="title">Stew4 ユーザーマニュアル</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---トランザクションのロールバック-組み込みコマンド">rollback - トランザクションのロールバック (組み込みコマンド)</a></li>\r
 <li><a href="#e---複数コマンドの評価-組み込みコマンド">-e - 複数コマンドの評価 (組み込みコマンド)</a></li>\r
 <li><a href="#f---ファイル内容をコマンドとして実行-組み込みコマンド">-f - ファイル内容をコマンドとして実行 (組み込みコマンド)</a></li>\r
-<li><a href="#s---ã\83\95ã\82¡ã\82¤ã\83«å\86\85容ã\82\92ã\82¹ã\82¯ã\83ªã\83\97ã\83\88ã\81¨ã\81\97ã\81¦å®\9fè¡\8c-çµ\84ã\81¿è¾¼ã\81¿ã\82³ã\83\9eã\83³ã\83\89">-s - ã\83\95ã\82¡ã\82¤ã\83«å\86\85容ã\82\92ã\82¹ã\82¯ã\83ªã\83\97ã\83\88ã\81¨ã\81\97ã\81¦å®\9fè¡\8c (çµ\84ã\81¿è¾¼ã\81¿ã\82³ã\83\9eã\83³ã\83\89)</a></li>\r
+<li><a href="#s---ã\82¹ã\82¯ã\83ªã\83\97ã\83\88ã\81¨ã\81\97ã\81¦å®\9fè¡\8c-çµ\84ã\81¿è¾¼ã\81¿ã\82³ã\83\9eã\83³ã\83\89\83\90ã\83¼ã\82¸ã\83§ã\83³4.1ã\81®æ\9b´æ\96°æ©\9fè\83½">-s - ã\82¹ã\82¯ã\83ªã\83\97ã\83\88ã\81¨ã\81\97ã\81¦å®\9fè¡\8c (çµ\84ã\81¿è¾¼ã\81¿ã\82³ã\83\9eã\83³ã\83\89) &lt;ã\83\90ã\83¼ã\82¸ã\83§ã\83³4.1ã\81®æ\9b´æ\96°æ©\9fè\83½&gt;</a></li>\r
 <li><a href="#cd---カレントディレクトリの移動-組み込みコマンド">cd - カレントディレクトリの移動 (組み込みコマンド)</a></li>\r
 <li><a href="#場所の表示-組み込みコマンド">@ - 場所の表示 (組み込みコマンド)</a></li>\r
 <li><a href="#システムプロパティ-組み込みコマンド">? - システムプロパティ (組み込みコマンド)</a></li>\r
 <h3 id="f---ファイル内容をコマンドとして実行-組み込みコマンド"><a href="#TOC">-f - ファイル内容をコマンドとして実行 (組み込みコマンド)</a></h3>\r
 <pre><code>&gt; -f &lt;ファイル&gt;</code></pre>\r
 <p>ファイルの内容をコマンドとして実行します。 再帰的に指定できますが、無限ループは検知できないので注意してください。</p>\r
-<h3 id="s---ファイル内容をスクリプトとして実行-組み込みコマンド"><a href="#TOC">-s - ファイル内容をスクリプトとして実行 (組み込みコマンド)</a></h3>\r
-<pre><code>&gt; -s &lt;ファイル&gt;</code></pre>\r
-<p>ファイルの内容をスクリプト(JavaScript)として実行します。</p>\r
+<h3 id="s---スクリプトとして実行-組み込みコマンド-バージョン4.1の更新機能"><a href="#TOC">-s - スクリプトとして実行 (組み込みコマンド) &lt;バージョン4.1の更新機能&gt;</a></h3>\r
+<pre><code>&gt; -s . | &lt;スクリプトファイル&gt; | &lt;スクリプト言語名&gt; &lt;スクリプトコード&gt;</code></pre>\r
+<ol type="1">\r
+<li>最初の引数が&quot;.&quot;(ピリオド)の場合、スクリプトコンテキストはリセットされます。</li>\r
+<li>最初の引数が拡張子付きのファイル名の場合、拡張子でスクリプト言語を特定し、ファイルをそのスクリプト言語のスクリプトファイルとして実行します。</li>\r
+<li>それ以外の場合、最初の引数はスクリプト言語名として認識され、残りの引数はそのスクリプト言語のスクリプトコードとして実行されます。</li>\r
+</ol>\r
+<p>組み込み(JavaScript)以外のスクリプト言語を使うには、JRuby、Jython、Groovyなど、言語ごとのスクリプトエンジンが必要です。</p>\r
+<p>スクリプトコンテキストは、グローバルスコープのバインディング(すなわちグローバル変数)を保持します。 スクリプトコンテキストをリセットしたい場合は、前述のとおり、&quot; -s . &quot;を入力します。</p>\r
 <p>スクリプト内では、以下の変数が定義済みになります。</p>\r
 <ul>\r
 <li>接続中のコネクション: connection, conn</li>\r
index cafdf18..8114b55 100644 (file)
@@ -1,6 +1,6 @@
 % Stew4 ユーザーマニュアル
 %
-% version 4.0
+% version 4.1
 
 
 ## Stewとは何ですか?
@@ -266,11 +266,18 @@ exportなどを同時に実行する場合や、コマンドラインからの
 再帰的に指定できますが、無限ループは検知できないので注意してください。
 
 
-### -s - ã\83\95ã\82¡ã\82¤ã\83«å\86\85容ã\82\92ã\82¹ã\82¯ã\83ªã\83\97ã\83\88ã\81¨ã\81\97ã\81¦å®\9fè¡\8c (çµ\84ã\81¿è¾¼ã\81¿ã\82³ã\83\9eã\83³ã\83\89)
+### -s - ã\82¹ã\82¯ã\83ªã\83\97ã\83\88ã\81¨ã\81\97ã\81¦å®\9fè¡\8c (çµ\84ã\81¿è¾¼ã\81¿ã\82³ã\83\9eã\83³ã\83\89) \<ã\83\90ã\83¼ã\82¸ã\83§ã\83³4.1ã\81®æ\9b´æ\96°æ©\9fè\83½>
 
-    > -s <ファイル>
+    > -s . | <スクリプトファイル> | <スクリプト言語名> <スクリプトコード>
 
-ファイルの内容をスクリプト(JavaScript)として実行します。
+ 1. 最初の引数が"."(ピリオド)の場合、スクリプトコンテキストはリセットされます。
+ 2. 最初の引数が拡張子付きのファイル名の場合、拡張子でスクリプト言語を特定し、ファイルをそのスクリプト言語のスクリプトファイルとして実行します。
+ 3. それ以外の場合、最初の引数はスクリプト言語名として認識され、残りの引数はそのスクリプト言語のスクリプトコードとして実行されます。
+
+組み込み(JavaScript)以外のスクリプト言語を使うには、JRuby、Jython、Groovyなど、言語ごとのスクリプトエンジンが必要です。
+
+スクリプトコンテキストは、グローバルスコープのバインディング(すなわちグローバル変数)を保持します。
+スクリプトコンテキストをリセットしたい場合は、前述のとおり、" -s . "を入力します。
 
 スクリプト内では、以下の変数が定義済みになります。
 
@@ -307,9 +314,9 @@ exportなどを同時に実行する場合や、コマンドラインからの
     OS : ...
     Locale : ja_JP
     > ? java.version user.timezone zzz
-    java.version=[1.6.0_##]\r
-    user.timezone=[Asia/Tokyo]\r
-    zzz=undefined\r
+    java.version=[1.6.0_##]
+    user.timezone=[Asia/Tokyo]
+    zzz=undefined
 
 
 ### alias - エイリアス(コマンド別名)の登録 (組み込みコマンド)