/[hyperestraier]/upstream/0.5.2/doc/nguide-ja.html
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Diff of /upstream/0.5.2/doc/nguide-ja.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

upstream/0.5.1/doc/nguide-ja.html revision 2 by dpavlin, Fri Jul 29 21:56:53 2005 UTC upstream/0.5.2/doc/nguide-ja.html revision 9 by dpavlin, Wed Aug 3 15:21:15 2005 UTC
# Line 196  A love so brand new Line 196  A love so brand new
196  <pre>estcall search -dpt 1 -vx http://localhost:1978/node/test1 "girl"  <pre>estcall search -dpt 1 -vx http://localhost:1978/node/test1 "girl"
197  </pre>  </pre>
198    
199  <p>コマンドラインで検索しても大して面白くないので、Webブラウザで検索できるインターフェイスも用意されています。「http://localhost:1978/node/test1/searchui」にアクセスしてみてください。</p>  <p>コマンドラインで検索しても大して面白くないですよね。でも、ノードサーバにはWebブラウザで検索できるインターフェイスも内蔵されています。「http://localhost:1978/node/test1/searchui」にアクセスしてみてください。表示された画面で、「phrase」の欄に検索語を入れてから、「search」ボタンを押せば検索できます。「depth」の数を増やせばメタ検索もできます。左側に表示されたリンクを選択すると、そのノードを起点にして再検索が行われます。</p>
200    
201  <h3>アプリケーションの開発</h3>  <h3>アプリケーションの開発</h3>
202    
# Line 282  proxyport: Line 282  proxyport:
282  loglevel: 2  loglevel: 2
283  docroot:  docroot:
284  indexfile:  indexfile:
285  trustednodes:  trustednode:
286  denyuntrusted: 0  denyuntrusted: 0
287  cachesize: 64  cachesize: 64
288  specialcache:  specialcache:
289  snipwwidth: 480  snipwwidth: 480
290  sniphwidth: 96  sniphwidth: 96
291  snipawidth: 96  snipawidth: 96
292    uilprefix: file:///home/mikio/public_html/
293    uigprefix: http://localhost/
294    uigsuffix:
295    uidirindex: index.html
296    uireplace: //localhost/{{!}}//127.0.0.1/
297    uireplace: //127.0.0.1:80/{{!}}//127.0.0.1/
298    uiextattr: @author|Author
299    uiextattr: @mdate|Modification Date
300    uismplphrase: 1
301  </pre>  </pre>
302    
303  <p>それぞれの変数の機能を以下に示します。</p>  <p>それぞれの変数の機能を以下に示します。</p>
# Line 305  snipawidth: 96 Line 314  snipawidth: 96
314  <li><kbd>proxyhost</kbd> : プロクシサーバのホスト名を指定します。</li>  <li><kbd>proxyhost</kbd> : プロクシサーバのホスト名を指定します。</li>
315  <li><kbd>proxyport</kbd> : プロクシサーバのポート番号を指定します。</li>  <li><kbd>proxyport</kbd> : プロクシサーバのポート番号を指定します。</li>
316  <li><kbd>loglevel</kbd> : ログのレベルを指定します。1ならデバッグ、2なら通常、3なら警告、4ならエラー、5なら無しです。</li>  <li><kbd>loglevel</kbd> : ログのレベルを指定します。1ならデバッグ、2なら通常、3なら警告、4ならエラー、5なら無しです。</li>
317  <li><kbd>docroot</kbd> : 通常のWebサーバとして公開するディレクトリのパスを指定します。不要なら空文字列にします。</li>  <li><kbd>docroot</kbd> : 通常のWebサーバとして公開するディレクトリのフルパスを指定します。</li>
318  <li><kbd>indexfile</kbd> : 通常のWebサーバとして公開する際のディレクトリのインデックスファイルの名前を指定します。不要なら空文字列にします。</li>  <li><kbd>indexfile</kbd> : 通常のWebサーバとして公開する際のディレクトリのインデックスファイルの名前を指定します。不要なら空文字列にします。</li>
319  <li><kbd>trustednodes</kbd> : 認証を省略するノード（クライアント）のIPアドレスを10進数ドット付き表記で指定します。</li>  <li><kbd>trustednode</kbd> : 認証を省略するノード（クライアント）のIPアドレスを10進数ドット付き表記で指定します。複数回指定可能です。</li>
320  <li><kbd>denyuntrusted</kbd> : 正数なら上記のノード以外からのアクセスを拒絶します。</li>  <li><kbd>denyuntrusted</kbd> : 正数なら上記のノード以外からのアクセスを拒絶します。</li>
321  <li><kbd>cachesize</kbd> : インデックス用キャッシュのサイズをメガバイト単位で指定します。</li>  <li><kbd>cachesize</kbd> : インデックス用キャッシュのサイズをメガバイト単位で指定します。</li>
322  <li><kbd>specialcache</kbd> : スペシャルキャッシュの属性名を指示します。</li>  <li><kbd>specialcache</kbd> : スペシャルキャッシュの属性名を指示します。</li>
323  <li><kbd>snipwwidth</kbd> : 検索結果の紹介文の全体の幅を指示します。</li>  <li><kbd>snipwwidth</kbd> : 検索結果の紹介文の全体の幅を指示します。</li>
324  <li><kbd>sniphwidth</kbd> : 検索結果の紹介文を作る際に文書の冒頭から取得する幅を指示します。</li>  <li><kbd>sniphwidth</kbd> : 検索結果の紹介文を作る際に文書の冒頭から取得する幅を指示します。</li>
325  <li><kbd>snipawidth</kbd> : 検索結果の紹介文を作る際に検索語の周辺から取得する幅を指示します。</li>  <li><kbd>snipawidth</kbd> : 検索結果の紹介文を作る際に検索語の周辺から取得する幅を指示します。</li>
326    <li><kbd>uilprefix</kbd> : 登録文書群のローカルURIの接頭辞を指示します。</li>
327    <li><kbd>uigprefix</kbd> : 登録文書群の公開URIに付加する接頭辞を指示します。</li>
328    <li><kbd>uigsuffix</kbd> : 登録文書群の公開URIに付加する接尾辞を指示します。</li>
329    <li><kbd>uidirindex</kbd> : ディレクトリのインデックスファイルの名前を指示します。</li>
330    <li><kbd>uireplace</kbd> : URIの変換前後の文字列を「{{!}}」で区切って指定します。複数回指定できます。</li>
331    <li><kbd>uiextattr</kbd> : 表示する属性の名前とラベルを「|」で区切って指示します。複数回指定できます。</li>
332    <li><kbd>uismplphrase</kbd> : 正数ならUIの検索条件式を簡便法にします。</li>
333  </ul>  </ul>
334    
335  <h3>ユーザアカウントファイル</h3>  <h3>ユーザアカウントファイル</h3>
# Line 894  est_noderes_delete(nres); Line 910  est_noderes_delete(nres);
910    
911  <p>ノード接続オブジェクト、ノード結果オブジェクト、結果文書オブジェクトのいずれも、スレッド間で共有してはなりません。マルチスレッドを用いる場合は、各スレッドで別々のオブジェクトを使うようにしてください。その条件さえ守れば、ノードAPIの各関数はマルチスレッドセーフなものとして扱えます。</p>  <p>ノード接続オブジェクト、ノード結果オブジェクト、結果文書オブジェクトのいずれも、スレッド間で共有してはなりません。マルチスレッドを用いる場合は、各スレッドで別々のオブジェクトを使うようにしてください。その条件さえ守れば、ノードAPIの各関数はマルチスレッドセーフなものとして扱えます。</p>
912    
913    <h3>ギャザラのサンプル</h3>
914    
915    <p>最も単純なギャザラの実装を以下に示します。コアAPIのギャザラとの違いは、ネットワーク環境の初期化が必要なことと、データベースオブジェクトの代わりにノード接続オブジェクトを使うことです。</p>
916    
917    <pre>#include &lt;estraier.h&gt;
918    #include &lt;estnode.h&gt;
919    #include &lt;cabin.h&gt;
920    #include &lt;stdlib.h&gt;
921    #include &lt;stdio.h&gt;
922    
923    int main(int argc, char **argv){
924      ESTNODE *node;
925      ESTDOC *doc;
926      /* ネットワーク環境を初期化する */
927      if(!est_init_net_env()){
928        fprintf(stderr, "error: network is unavailable\n");
929        return 1;
930      }
931      /* ノード接続オブジェクトを生成して設定する */
932      node = est_node_new("http://localhost:1978/node/test1");
933      est_node_set_auth(node, "admin", "admin");
934      /* 文書オブジェクトを生成する */
935      doc = est_doc_new();
936      /* 文書オブジェクトに属性を追加する */
937      est_doc_add_attr(doc, "@uri", "http://estraier.gov/example.txt");
938      est_doc_add_attr(doc, "@title", "Over the Rainbow");
939      /* 文書オブジェクトに本文を追加する */
940      est_doc_add_text(doc, "Somewhere over the rainbow.  Way up high.");
941      est_doc_add_text(doc, "There's a land that I heard of once in a lullaby.");
942      /* 文書オブジェクトをノードに登録する */
943      if(!est_node_put_doc(node, doc))
944        fprintf(stderr, "error: %d\n", est_node_status(node));
945      /* 文書オブジェクトを破棄する */
946      est_doc_delete(doc);
947      /* ノードオブジェクトを破棄する */
948      est_node_delete(node);
949      /* ネットワーク環境を破棄する */
950      est_free_net_env();
951      return 0;
952    }
953    </pre>
954    
955    <h3>サーチャのサンプル</h3>
956    
957    <p>最も単純なサーチャの実装を以下に示します。コアAPIでは検索結果から文書オブジェクト（ESTDOC）を取得していましたが、ここでは結果文書オブジェクト（ESTRESDOC）を取得していることに注意してください。</p>
958    
959    <pre>#include &lt;estraier.h&gt;
960    #include &lt;estnode.h&gt;
961    #include &lt;cabin.h&gt;
962    #include &lt;stdlib.h&gt;
963    #include &lt;stdio.h&gt;
964    
965    int main(int argc, char **argv){
966      ESTNODE *node;
967      ESTCOND *cond;
968      ESTNODERES *nres;
969      ESTRESDOC *rdoc;
970      int i;
971      const char *value;
972      /* ネットワーク環境を初期化する */
973      if(!est_init_net_env()){
974        fprintf(stderr, "error: network is unavailable\n");
975        return 1;
976      }
977      /* ノード接続オブジェクトを生成する */
978      node = est_node_new("http://localhost:1978/node/test1");
979      /* 検索条件オブジェクトを生成する */
980      cond = est_cond_new();
981      /* 検索条件オブジェクトに検索式を設定する */
982      est_cond_set_phrase(cond, "rainbow AND lullaby");
983      /* ノード結果オブジェクトを取得する */
984      nres = est_node_search(node, cond, 0);
985      if(nres){
986        /* 各文書を取得して表示する */
987        for(i = 0; i &lt; est_noderes_doc_num(nres); i++){
988          /* 結果文書オブジェクトを取得する */
989          rdoc = est_noderes_get_doc(nres, i);
990          /* 属性を表示する */
991          if((value = est_resdoc_attr(rdoc, "@uri")) != NULL)
992            printf("URI: %s\n", value);
993          if((value = est_resdoc_attr(rdoc, "@title")) != NULL)
994            printf("Title: %s\n", value);
995          /* スニペットを表示する */
996          value = est_resdoc_snippet(rdoc);
997          printf("%s", value);
998        }
999        /* ノード結果オブジェクトを破棄する */
1000        est_noderes_delete(nres);
1001      } else {
1002        fprintf(stderr, "error: %d\n", est_node_status(node));
1003      }
1004      /* destroy the search condition object */
1005      est_cond_delete(cond);
1006      /* ノードオブジェクトを破棄する */
1007      est_node_delete(node);
1008      /* ネットワーク環境を破棄する */
1009      est_free_net_env();
1010      return 0;
1011    }
1012    </pre>
1013    
1014  <hr />  <hr />
1015    
1016  <h2 id="estcall">クライアント用コマンド</h2>  <h2 id="estcall">クライアント用コマンド</h2>
# Line 905  est_noderes_delete(nres); Line 1022  est_noderes_delete(nres);
1022  <p>estcallは多くのサブコマンドの集合体です。サブコマンドの名前は第1引数で指定されます。その他の引数はサブコマンドの種類に応じて解釈されます。<var>nurl</var>という引数は操作対象のノードのURLです。-proxyオプションはプロクシのホスト名とポート番号を指定します。-toutはタイムアウトの時間を秒単位で指定します。-authは認証のユーザ名とパスワードを指定します。</p>  <p>estcallは多くのサブコマンドの集合体です。サブコマンドの名前は第1引数で指定されます。その他の引数はサブコマンドの種類に応じて解釈されます。<var>nurl</var>という引数は操作対象のノードのURLです。-proxyオプションはプロクシのホスト名とポート番号を指定します。-toutはタイムアウトの時間を秒単位で指定します。-authは認証のユーザ名とパスワードを指定します。</p>
1023    
1024  <dl>  <dl>
1025  <dt><kbd>estcall put [-proxy <var>host</var>:<var>port</var>] [-tout <var>num</var>] [-auth <var>user</var> <var>pass</var>] <var>nurl</var> [<var>file</var>]</kbd></dt>  <dt><kbd>estcall put [-proxy <var>host</var> <var>port</var>] [-tout <var>num</var>] [-auth <var>user</var> <var>pass</var>] <var>nurl</var> [<var>file</var>]</kbd></dt>
1026  <dd>文書ドラフト形式のファイルを登録します。</dd>  <dd>文書ドラフト形式のファイルを登録します。</dd>
1027  <dd><var>file</var>は対象のファイルを指定しますが、省略した場合は標準入力が読み込まれます。</dd>  <dd><var>file</var>は対象のファイルを指定しますが、省略した場合は標準入力が読み込まれます。</dd>
1028  </dl>  </dl>
1029    
1030  <dl>  <dl>
1031  <dt><kbd>estcall out [-proxy <var>host</var>:<var>port</var>] [-tout <var>num</var>] [-auth <var>user</var> <var>pass</var>] <var>nurl</var> <var>expr</var></kbd></dt>  <dt><kbd>estcall out [-proxy <var>host</var> <var>port</var>] [-tout <var>num</var>] [-auth <var>user</var> <var>pass</var>] <var>nurl</var> <var>expr</var></kbd></dt>
1032  <dd>特定の文書の情報をインデックスから削除します。</dd>  <dd>特定の文書の情報をインデックスから削除します。</dd>
1033  <dd><var>expr</var>は対象のID番号かURIを指定します。</dd>  <dd><var>expr</var>は対象のID番号かURIを指定します。</dd>
1034  </dl>  </dl>
1035    
1036  <dl>  <dl>
1037  <dt><kbd>estcall get [-proxy <var>host</var>:<var>port</var>] [-tout <var>num</var>] [-auth <var>user</var> <var>pass</var>] <var>nurl</var> <var>expr</var> [<var>attr</var>]</kbd></dt>  <dt><kbd>estcall get [-proxy <var>host</var> <var>port</var>] [-tout <var>num</var>] [-auth <var>user</var> <var>pass</var>] <var>nurl</var> <var>expr</var> [<var>attr</var>]</kbd></dt>
1038  <dd>特定の文書の情報を文書ドラフト形式で出力します。</dd>  <dd>特定の文書の情報を文書ドラフト形式で出力します。</dd>
1039  <dd><var>expr</var>は対象のID番号かURIを指定します。</dd>  <dd><var>expr</var>は対象のID番号かURIを指定します。</dd>
1040  <dd><var>attr</var>を付けると、その属性の値のみを出力します。</dd>  <dd><var>attr</var>を付けると、その属性の値のみを出力します。</dd>
1041  </dl>  </dl>
1042    
1043  <dl>  <dl>
1044  <dt><kbd>estcall uriid [-proxy <var>host</var>:<var>port</var>] [-tout <var>num</var>] [-auth <var>user</var> <var>pass</var>] <var>nurl</var> <var>uri</var></kbd></dt>  <dt><kbd>estcall uriid [-proxy <var>host</var> <var>port</var>] [-tout <var>num</var>] [-auth <var>user</var> <var>pass</var>] <var>nurl</var> <var>uri</var></kbd></dt>
1045  <dd>指定したURIの文書のID番号を出力します。</dd>  <dd>指定したURIの文書のID番号を出力します。</dd>
1046  <dd><var>uri</var>は対象のURIを指定します。</dd>  <dd><var>uri</var>は対象のURIを指定します。</dd>
1047  </dl>  </dl>
1048    
1049  <dl>  <dl>
1050  <dt><kbd>estcall inform [-proxy <var>host</var>:<var>port</var>] [-tout <var>num</var>] [-auth <var>user</var> <var>pass</var>] <var>nurl</var></kbd></dt>  <dt><kbd>estcall inform [-proxy <var>host</var> <var>port</var>] [-tout <var>num</var>] [-auth <var>user</var> <var>pass</var>] <var>nurl</var></kbd></dt>
1051  <dd>ノードの名前とラベルと登録文書数と登録語数を出力します。</dd>  <dd>ノードの名前とラベルと登録文書数と登録語数を出力します。</dd>
1052  </dl>  </dl>
1053    
1054  <dl>  <dl>
1055  <dt><kbd>estcall search [-proxy <var>host</var>:<var>port</var>] [-tout <var>num</var>] [-auth <var>user</var> <var>pass</var>] [-vx] [-attr <var>expr</var>] [-ord <var>expr</var>] [-max <var>num</var>] [-dpt <var>num</var>] <var>nurl</var> [<var>phrase</var>]</kbd></dt>  <dt><kbd>estcall search [-proxy <var>host</var> <var>port</var>] [-tout <var>num</var>] [-auth <var>user</var> <var>pass</var>] [-vx] [-sf] [-attr <var>expr</var>] [-ord <var>expr</var>] [-max <var>num</var>] [-dpt <var>num</var>] <var>nurl</var> [<var>phrase</var>]</kbd></dt>
1056  <dd>ノードに登録された文書を検索します。</dd>  <dd>ノードに登録された文書を検索します。</dd>
1057  <dd><var>phrase</var>は全文検索の検索式を指定します。</dd>  <dd><var>phrase</var>は全文検索の検索式を指定します。</dd>
1058  <dd>-vxを付けると、XML形式にして結果を出力します。</dd>  <dd>-vxを付けると、XML形式にして結果を出力します。</dd>
1059    <dd>-sfを付けると、検索式を簡便形式として扱います。</dd>
1060  <dd>-attrは絞り込みの属性条件を指定します。複数指定可能です。</dd>  <dd>-attrは絞り込みの属性条件を指定します。複数指定可能です。</dd>
1061  <dd>-ordはソート条件を指定します。デフォルトはスコアの降順です。</dd>  <dd>-ordはソート条件を指定します。デフォルトはスコアの降順です。</dd>
1062  <dd>-maxは最大表示件数を指定します。負数にすると無制限になります。デフォルトは10件です。</dd>  <dd>-maxは最大表示件数を指定します。負数にすると無制限になります。デフォルトは10件です。</dd>
# Line 946  est_noderes_delete(nres); Line 1064  est_noderes_delete(nres);
1064  </dl>  </dl>
1065    
1066  <dl>  <dl>
1067  <dt><kbd>estcall setuser [-proxy <var>host</var>:<var>port</var>] [-tout <var>num</var>] [-auth <var>user</var> <var>pass</var>] <var>nurl</var> <var>name</var> <var>mode</var></kbd></dt>  <dt><kbd>estcall setuser [-proxy <var>host</var> <var>port</var>] [-tout <var>num</var>] [-auth <var>user</var> <var>pass</var>] <var>nurl</var> <var>name</var> <var>mode</var></kbd></dt>
1068  <dd>ユーザ権限を設定します。</dd>  <dd>ユーザ権限を設定します。</dd>
1069  <dd><var>name</var>はユーザ名を指定します。</dd>  <dd><var>name</var>はユーザ名を指定します。</dd>
1070  <dd><var>mode</var>が1ならそのユーザを管理者にし、2ならそのユーザを通常ユーザにし、0ならユーザ権限を削除します。</dd>  <dd><var>mode</var>が1ならそのユーザを管理者にし、2ならそのユーザを通常ユーザにし、0ならユーザ権限を削除します。</dd>
1071  </dl>  </dl>
1072    
1073  <dl>  <dl>
1074  <dt><kbd>estcall setlink [-proxy <var>host</var>:<var>port</var>] [-tout <var>num</var>] [-auth <var>user</var> <var>pass</var>] <var>nurl</var> <var>url</var> <var>label</var> <var>credit</var></kbd></dt>  <dt><kbd>estcall setlink [-proxy <var>host</var> <var>port</var>] [-tout <var>num</var>] [-auth <var>user</var> <var>pass</var>] <var>nurl</var> <var>url</var> <var>label</var> <var>credit</var></kbd></dt>
1075  <dd>リンクを設定します。</dd>  <dd>リンクを設定します。</dd>
1076  <dd><var>url</var>はリンク先のノードのURLを指定します。</dd>  <dd><var>url</var>はリンク先のノードのURLを指定します。</dd>
1077  <dd><var>label</var>はラベルを指定します。</dd>  <dd><var>label</var>はラベルを指定します。</dd>
# Line 961  est_noderes_delete(nres); Line 1079  est_noderes_delete(nres);
1079  </dl>  </dl>
1080    
1081  <dl>  <dl>
1082  <dt><kbd>estcall raw [-proxy <var>host</var>:<var>port</var>] [-tout <var>num</var>] [-auth <var>user</var> <var>pass</var>] [-np] [-eh <var>expr</var>] <var>url</var> [<var>file</var>]</kbd></dt>  <dt><kbd>estcall raw [-proxy <var>host</var> <var>port</var>] [-tout <var>num</var>] [-auth <var>user</var> <var>pass</var>] [-np] [-eh <var>expr</var>] <var>url</var> [<var>file</var>]</kbd></dt>
1083  <dd>HTTPリクエストを直接制御してレスポンスを出力します。</dd>  <dd>HTTPリクエストを直接制御してレスポンスを出力します。</dd>
1084  <dd><var>url</var>は操作対象のURLを指定します。</dd>  <dd><var>url</var>は操作対象のURLを指定します。</dd>
1085  <dd><var>file</var>が指定された場合はその内容をPOSTメソッドで送信します。指定されなかった場合はGETメソッドを用います。"-" を指定すると標準入力を読み込みます。</dd>  <dd><var>file</var>が指定された場合はその内容をPOSTメソッドで送信します。指定されなかった場合はGETメソッドを用います。"-" を指定すると標準入力を読み込みます。</dd>
# Line 1057  indexfile: index.html Line 1175  indexfile: index.html
1175  <dd><var>file</var>を指定した場合、そのファイルの各行に含まれるURLのリクエストを発行します。<var>url</var>を指定した場合、そのURLのリクエストを発行します。何も指定しなかった場合、標準入力の各行に含まれるURLのリクエストを発行します。</dd>  <dd><var>file</var>を指定した場合、そのファイルの各行に含まれるURLのリクエストを発行します。<var>url</var>を指定した場合、そのURLのリクエストを発行します。何も指定しなかった場合、標準入力の各行に含まれるURLのリクエストを発行します。</dd>
1176  <dd>-tは並行して動かすスレッドの数を指定します。デフォルトは1です。</dd>  <dd>-tは並行して動かすスレッドの数を指定します。デフォルトは1です。</dd>
1177  <dd>-lはリストを繰り返す回数を指定します。デフォルトは1です。</dd>  <dd>-lはリストを繰り返す回数を指定します。デフォルトは1です。</dd>
1178  <dd>-iはリクエストを発行してからスリープする時間をミリ秒単位で回数を指定します。デフォルトは0です。</dd>  <dd>-iはリクエストを発行してからスリープする時間をミリ秒単位で指定します。デフォルトは0です。</dd>
1179  <dd>-pを指定すると、レスポンスを表示します。</dd>  <dd>-pを指定すると、レスポンスを表示します。</dd>
1180  <dd>-qを指定すると、進捗状態を表示しません。</dd>  <dd>-qを指定すると、進捗状態を表示しません。</dd>
1181  </dl>  </dl>
Legend:
Removed from v.2  
changed lines
  Added in v.9
  ViewVC Help
Powered by ViewVC 1.1.26