OSDN Git Service

Documents have changed
authorargius <argius.net@gmail.com>
Sat, 22 Jun 2013 08:06:52 +0000 (17:06 +0900)
committerargius <argius.net@gmail.com>
Sat, 22 Jun 2013 08:06:52 +0000 (17:06 +0900)
FEATURE.md
FEATURE_ja.md
MANUAL.html
MANUAL.md
MANUAL_ja.html
MANUAL_ja.md
README.md

index c6db83b..620857f 100644 (file)
@@ -5,16 +5,21 @@
 
 The new features in version 4 are listed below:
 
-special command "?" - display environment info (not OS ENV).
-:   Display System Properties. (System.getProperty)
-    By defauts, displays JRE, OS and Locale.
-
+Special command "-s" - Executing file as script
+:   Execute a file as script (JavaScript).
+    This feature can be used instead of a command class.
 
-xxx
-:   xxx
+Special command "?" - display environment info (not OS ENV)
+:   Display System Properties. (System.getProperty)
+    By defauts, it displays JRE, OS and Locale.
 
+Auto-expanding nodes in the database info tree (GUI)
+:   This feature automatically expands nodes in the database info tree
+    when connecting a database.
+    If you use this feature, make a "autoexpansion.tsv" file
+    in system directory.
 
-For more details, see MANUAL.html.
+For more details, see MANUAL.html file.
 
 
 ## Changes
@@ -27,8 +32,10 @@ Requires Java6 and later
 
 Implementation
 :   Improved implementation with Java6.
-    Specifically, Unnecessary classes was removed, and some codes ared replaced with more fitting APIs.
+    Specifically, Unnecessary classes was removed, and some codes ared
+    replaced with more fitting APIs.
 
 
-## Others
+## Other Notes
 
+A connector config file (connector.properties) is compatible to version 3.
index 3f850fb..9cc15b5 100644 (file)
@@ -6,13 +6,18 @@
 バージョン4の主な新機能は以下のとおりです。
 各機能の詳細については、マニュアル(MANUAL_ja.html)をご覧ください。
 
-特殊コマンド "?" - 実行環境情報の表示
+特殊コマンド "-s" - スクリプトの実行
+:   ファイルをスクリプト(JavaScript)として実行します。
+    これは、コマンドクラスの代わりに使用することができます。
+
+特殊コマンド "?" - システムプロパティの表示
 :   システムプロパティを表示します。(System.getProperty)
     引数を指定しない場合は、JRE,OS,Localeの情報を表示します。
 
-
-xxx
-:    xxx
+データベース情報ツリーのノード自動展開(GUI)
+:   データベース接続時に、指定しておいたノードを自動展開します。
+    システムディレクトリに"autoexpansion.tsv"というファイルを
+    作成する必要があります。
 
 
 ## 変更点
@@ -32,8 +37,3 @@ Java6以降のみサポート
 ## その他
 
 接続設定ファイル(connector.properties)は、バージョン3と互換性があります。
-
----TODO---
--s
-?
-DBInfo自動展開
index 32947ab..eb15a89 100644 (file)
@@ -43,6 +43,7 @@
 <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="#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
 <li><a href="#alias---registers-alias-built-in">alias - Registers alias (built-in)</a></li>\r
 <li><a href="#unalias---removes-alias-built-in">unalias - Removes alias (built-in)</a></li>\r
 <li><a href="#exit---exits-application-built-in">exit - Exits application (built-in)</a></li>\r
@@ -234,6 +235,18 @@ $ stew --edit
 <h3 id="displays-directories-built-in"><a href="#TOC">@ - Displays directories (built-in)</a></h3>\r
 <pre><code>&gt; @</code></pre>\r
 <p>Displays the paths of current directory and system directory.</p>\r
+<h3 id="displays-system-properties-built-in"><a href="#TOC">? - Displays System Properties (built-in)</a></h3>\r
+<pre><code>&gt; ? [&lt;property-name&gt; [&lt;property-name-2&gt; ... &lt;property-name-n&gt;]]</code></pre>\r
+<p>Display System Properties. (System.getProperty)</p>\r
+<p>By defauts, it displays JRE, OS and Locale.</p>\r
+<pre><code>&gt; ?\r
+JRE : ...\r
+OS : ...\r
+Locale : ja_JP\r
+&gt; ? java.version user.timezone zzz\r
+java.version=[1.6.0_##]\r
+user.timezone=[Europe/London]\r
+zzz=undefined</code></pre>\r
 <h3 id="alias---registers-alias-built-in"><a href="#TOC">alias - Registers alias (built-in)</a></h3>\r
 <pre><code>&gt; alias [&lt;name&gt; [&lt;command&gt;]]</code></pre>\r
 <p>Registers the alias of command. When called with an argument, display the alias and its command. When called without arguments, display all aliases.</p>\r
@@ -377,6 +390,7 @@ Selected 42 records.</code></pre>
 </dl>\r
 <h3 id="database-info-tree"><a href="#TOC">Database Info Tree</a></h3>\r
 <p>The database info tree is a tree view of hierarchical structure, which consists catalogs, schemas, tables, table type and columns as a tree. Not connected: blank ... just connected: connector as a root node and sub nodes ... Each node expands ...</p>\r
+<p>An &quot;Auto-expansion&quot; 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 &quot;autoexpansion.tsv&quot; in the system directory (.stew) and write node name lists as TSV into this file.</p>\r
 <p>The context menu for this component are listed below:</p>\r
 <dl>\r
 <dt>Copy</dt>\r
@@ -493,7 +507,7 @@ Selected 42 records.</code></pre>
 <li>Blink(B): Blinks window.</li>\r
 </ul>\r
 <h3 id="command---encryption-key-k"><a href="#TOC">Command - Encryption Key (K)</a></h3>\r
-<p>This command ...</p>\r
+<p>This command shows the dialog to input an encryption key.</p>\r
 <h3 id="command---edit-connectors-e"><a href="#TOC">Command - Edit Connectors (E)</a></h3>\r
 <p>This command shows the dialog to edit connectors.</p>\r
 <h3 id="data---sort-s-alt-s"><a href="#TOC">Data - Sort (S) Alt-S</a></h3>\r
@@ -503,7 +517,7 @@ Selected 42 records.</code></pre>
 <h3 id="data---export-file-e-ctrl-shift-s"><a href="#TOC">Data - Export File (E) Ctrl-Shift-S</a></h3>\r
 <p>This command exports results into file.</p>\r
 <h3 id="help---show-help"><a href="#TOC">Help - Show Help</a></h3>\r
-<p>This command shows this help file by default browser. This feature ...</p>\r
+<p>This command shows this help file by default browser.</p>\r
 <h3 id="help---about-stew"><a href="#TOC">Help - About Stew</a></h3>\r
 <p>This command shows version dialog about Stew.</p>\r
 <h2 id="properties"><a href="#TOC">Properties</a></h2>\r
index 1cde800..d8ef224 100644 (file)
--- a/MANUAL.md
+++ b/MANUAL.md
@@ -210,6 +210,24 @@ Changes current directory to specified one.
 Displays the paths of current directory and system directory.
 
 
+### ? - Displays System Properties (built-in)
+
+    > ? [<property-name> [<property-name-2> ... <property-name-n>]]
+
+Display System Properties. (System.getProperty)
+
+By defauts, it displays JRE, OS and Locale.
+
+    > ?
+    JRE : ...
+    OS : ...
+    Locale : ja_JP
+    > ? java.version user.timezone zzz
+    java.version=[1.6.0_##]\r
+    user.timezone=[Europe/London]\r
+    zzz=undefined\r
+
+
 ### alias - Registers alias (built-in)
 
     > alias [<name> [<command>]]
@@ -489,6 +507,10 @@ 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
+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.
+
+
 The context menu for this component are listed below:
 
 
@@ -720,7 +742,7 @@ There are following modes:
 
 ### Command - Encryption Key (K)
 
-This command ...
+This command shows the dialog to input an encryption key.
 
 
 ### Command - Edit Connectors (E)
@@ -746,7 +768,6 @@ This command exports results into file.
 ### Help - Show Help
 
 This command shows this help file by default browser.
-This feature ...
 
 
 ### Help - About Stew
index dd8f577..66e15aa 100644 (file)
@@ -3,7 +3,7 @@
 <head>\r
   <meta charset="utf-8">\r
   <meta name="generator" content="pandoc">\r
-  <title>Stew マニュアル</title>\r
+  <title>Stew4 ユーザーマニュアル</title>\r
   <!--[if lt IE 9]>\r
     <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>\r
   <![endif]-->\r
@@ -11,7 +11,7 @@
 </head>\r
 <body>\r
 <header>\r
-<h1 class="title">Stew マニュアル</h1>\r
+<h1 class="title">Stew4 ユーザーマニュアル</h1>\r
 <h3 class="date">version 4.0</h3>\r
 </header>\r
 <nav id="TOC">\r
@@ -43,6 +43,7 @@
 <li><a href="#s---ファイル内容をスクリプトとして実行-組み込みコマンド">-s - ファイル内容をスクリプトとして実行 (組み込みコマンド)</a></li>\r
 <li><a href="#cd---カレントディレクトリの移動-組み込みコマンド">cd - カレントディレクトリの移動 (組み込みコマンド)</a></li>\r
 <li><a href="#場所の表示-組み込みコマンド">@ - 場所の表示 (組み込みコマンド)</a></li>\r
+<li><a href="#システムプロパティ-組み込みコマンド">? - システムプロパティ (組み込みコマンド)</a></li>\r
 <li><a href="#alias---エイリアスコマンド別名の登録-組み込みコマンド">alias - エイリアス(コマンド別名)の登録 (組み込みコマンド)</a></li>\r
 <li><a href="#unalias---エイリアスコマンド別名の解除-組み込みコマンド">unalias - エイリアス(コマンド別名)の解除 (組み込みコマンド)</a></li>\r
 <li><a href="#exit---終了-組み込みコマンド">exit - 終了 (組み込みコマンド)</a></li>\r
 <pre><code>&gt; java -jar stew.jar --gui</code></pre>\r
 <p>CUIモードで起動する場合は、以下のコマンドを実行します。</p>\r
 <pre><code>&gt; java -jar stew.jar --cui</code></pre>\r
-<p>起動スクリプトもしくはショートカットやエイリアスを作成しておくと便利です。 UNIX系OSの場合は&quot;stew.sh&quot;を、Windowsの場合は&quot;stew.bat&quot;を参照してください。</p>\r
+<p>起動スクリプトもしくはショートカットやエイリアスを作成しておくと便利です。 stew.propertiesに以下の設定を追加すれば、JarファイルのダブルクリックでGUI起動できるようになります。</p>\r
+<pre><code>stew.boot=GUI</code></pre>\r
 <p>Stewを実行すると、システムディレクトリ&quot;.stew&quot;が作成され、設定の保存に使用されます。 &quot;.stew&quot;ディレクトリは、デフォルトではカレントディレクトリに作成されます。</p>\r
 <h2 id="アンインストール"><a href="#TOC">アンインストール</a></h2>\r
 <p>インストールしたファイルと&quot;.stew&quot;ディレクトリを削除してください。</p>\r
 <h3 id="場所の表示-組み込みコマンド"><a href="#TOC">@ - 場所の表示 (組み込みコマンド)</a></h3>\r
 <pre><code>&gt; @</code></pre>\r
 <p>カレントディレクトリとシステムディレクトリの場所を表示します。</p>\r
+<h3 id="システムプロパティ-組み込みコマンド"><a href="#TOC">? - システムプロパティ (組み込みコマンド)</a></h3>\r
+<pre><code>&gt; ? [&lt;プロパティ名&gt; [&lt;プロパティ名2&gt; ... &lt;プロパティ名n&gt;]]</code></pre>\r
+<p>指定されたシステムプロパティを表示します。(System.getProperty)</p>\r
+<p>引数を指定しない場合は、JRE,OS,Localeの情報を表示します。</p>\r
+<pre><code>&gt; ?\r
+JRE : ...\r
+OS : ...\r
+Locale : ja_JP\r
+&gt; ? java.version user.timezone zzz\r
+java.version=[1.6.0_##]\r
+user.timezone=[Asia/Tokyo]\r
+zzz=undefined</code></pre>\r
 <h3 id="alias---エイリアスコマンド別名の登録-組み込みコマンド"><a href="#TOC">alias - エイリアス(コマンド別名)の登録 (組み込みコマンド)</a></h3>\r
 <pre><code>&gt; alias [&lt;エイリアス&gt; [&lt;コマンド&gt;]]</code></pre>\r
 <p>コマンド別名を登録します。 引数が1つで実行した場合は、既に設定されたコマンド内容を表示します。 引数なしで実行した場合は、すべての定義済みエイリアスを表示します。</p>\r
 <p>登録または表示の前にファイルからメモリ上の情報を最新化します。 ファイルを直接修正したり、他のスレッドで変更した内容を反映させたい場合は、 このコマンドを実行してください。 (実装詳細:循環参照などの無限ループ抑制のために、展開の深さは最大100。)</p>\r
 <pre><code>&gt; alias\r
 エイリアスは未定義です。\r
-&gt; alias search select # from\r
-&gt; alias count select count(#) from\r
+&gt; alias search select * from\r
+&gt; alias count select count(*) from\r
 &gt; alias search\r
-alias search=[select # from]\r
+alias search=[select * from]\r
 &gt; search table1\r
-&gt;&gt; select # from table1\r
-(select # from table1 の結果)\r
+&gt;&gt; select * from table1\r
+(select * from table1 の結果)\r
 &gt;</code></pre>\r
 <h3 id="unalias---エイリアスコマンド別名の解除-組み込みコマンド"><a href="#TOC">unalias - エイリアス(コマンド別名)の解除 (組み込みコマンド)</a></h3>\r
 <pre><code>&gt; unalias &lt;エイリアス&gt;</code></pre>\r
@@ -299,9 +313,9 @@ alias search=[select # from]
 <pre><code>&gt; time [&lt;回数&gt;] &lt;SQL文&gt;</code></pre>\r
 <p>指定したSQL文を実行し、その実行時間を計測して表示します。</p>\r
 <p>回数が指定された場合は、回数分SQLを繰り返し実行して、 「合計」「平均」「最大」「最小」を集計します。 回数を指定しない場合は、1回の実行時間を表示します。</p>\r
-<pre><code>&gt; time select # from EMPLOYEE\r
+<pre><code>&gt; time select * from EMPLOYEE\r
 実行時間 : 0.093 秒\r
-&gt; time 100 select # from EMPLOYEE\r
+&gt; time 100 select * from EMPLOYEE\r
 合計 : 0.484 秒\r
 平均 : 0.005 秒\r
 最大 : 0.094 秒\r
@@ -311,11 +325,11 @@ alias search=[select # from]
 <pre><code>&gt; find &lt;テーブル名パターン&gt; [&lt;テーブル種別パターン&gt; [&lt;スキーマ名パターン&gt; [&lt;カタログ名パターン&gt; [ FULL ]]]]</code></pre>\r
 <p>参照可能なテーブルの一覧を表示します。 &quot;パターン&quot;というキーワードを含むパラメータは、ワイルドカード(#,?)が指定できます。</p>\r
 <h3 id="report---データベース情報表示"><a href="#TOC">report - データベース情報表示</a></h3>\r
-<pre><code>&gt; report - | &lt;テーブル名&gt; [ PK | INDEX ]</code></pre>\r
+<pre><code>&gt; report - | &lt;テーブル名&gt; [ FULL | PK | INDEX ]</code></pre>\r
 <p>接続中のコネクションに関する情報を表示します。</p>\r
 <p>-(ハイフン)が指定された場合は、DBとJDBCドライバの名称とバージョン、 接続ユーザとアドレスを表示します。</p>\r
 <p>テーブル名のみが指定された場合は、テーブルの列情報が表示されます。</p>\r
-<p>テーブル名とオプションが指定された場合は、PKを指定するとプライマリキーの一覧が、 INDEXを指定するとインデックスキーの一覧が、それぞれ表示されます。</p>\r
+<p>テーブル名とオプションが指定された場合は、PKを指定するとプライマリキーの一覧が、 INDEXを指定するとインデックスキーの一覧が、それぞれ表示されます。 FULLを指定すると、API(DatabaseMetaData#getColumns)が返すすべての列が表示されます。</p>\r
 <h3 id="download---1データごとにダウンロード"><a href="#TOC">download - 1データごとにダウンロード</a></h3>\r
 <pre><code>&gt; download &lt;ルートディレクトリ&gt; SELECT &lt;ダウンロードするデータの列&gt; [, ファイルパス...] FROM ...</code></pre>\r
 <p>1つの列のデータをダウンロードしてファイルに保存します。</p>\r
index 99f7fac..cafdf18 100644 (file)
@@ -1,4 +1,4 @@
-% Stew マニュアル
+% Stew4 ユーザーマニュアル
 %
 % version 4.0
 
@@ -68,7 +68,10 @@ CUIモードで起動する場合は、以下のコマンドを実行します
 
 
 起動スクリプトもしくはショートカットやエイリアスを作成しておくと便利です。
-UNIX系OSの場合は"stew.sh"を、Windowsの場合は"stew.bat"を参照してください。
+stew.propertiesに以下の設定を追加すれば、JarファイルのダブルクリックでGUI起動できるようになります。
+
+    stew.boot=GUI
+
 
 Stewを実行すると、システムディレクトリ".stew"が作成され、設定の保存に使用されます。
 ".stew"ディレクトリは、デフォルトではカレントディレクトリに作成されます。
@@ -291,6 +294,24 @@ exportなどを同時に実行する場合や、コマンドラインからの
 カレントディレクトリとシステムディレクトリの場所を表示します。
 
 
+### ? - システムプロパティ (組み込みコマンド)
+
+    > ? [<プロパティ名> [<プロパティ名2> ... <プロパティ名n>]]
+
+指定されたシステムプロパティを表示します。(System.getProperty)
+
+引数を指定しない場合は、JRE,OS,Localeの情報を表示します。
+
+    > ?
+    JRE : ...
+    OS : ...
+    Locale : ja_JP
+    > ? java.version user.timezone zzz
+    java.version=[1.6.0_##]\r
+    user.timezone=[Asia/Tokyo]\r
+    zzz=undefined\r
+
+
 ### alias - エイリアス(コマンド別名)の登録 (組み込みコマンド)
 
     > alias [<エイリアス> [<コマンド>]]
index 3375d62..08f63c5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 % Readme - Stew4
 
 
-## 1. Outline
+## 1. Overview
 
 Stew is the database (SQL) tool with JDBC.