bug fix 14901: WScilex.exe stops immediately when launched from Java
[scilab.git] / scilab / modules / core / help / ja_JP / scilab.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
3     xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml"
4     xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
5     xmlns:scilab="http://www.scilab.org" xml:id="scilab" xml:lang="ja">
6     <refnamediv xml:id="wscilex">
7     </refnamediv>
8     <refnamediv xml:id="scilex">
9     </refnamediv>
10     <refnamediv>
11         <refname>scilex | scilab</refname>
12         <refpurpose>
13             Scilabおよび関連ツールを起動するためのツール
14         </refpurpose>
15     </refnamediv>
16     <refsynopsisdiv>
17         <title>呼出し手順</title>
18         <synopsis>
19 #      MS Windows          |  # Linux / Unix / Mac OS X
20 wscilex     &lt;Options&gt;     |  scilab         &lt;Options&gt;
21 wscilex-cli &lt;Options&gt; |  scilab-adv-cli &lt;Options&gt;
22 scilex      &lt;Options&gt;      |  scilab-cli     &lt;Options&gt;
23         </synopsis>
24     </refsynopsisdiv>
25     <refsection role="arguments">
26         <title>説定</title>
27         <variablelist>
28             <varlistentry>
29                 <term>-args arg#1 arg#2 ..</term>
30                 <listitem>
31                     <para>
32                         This option allows to send some data to the Scilab session:
33                         <itemizedlist>
34                             <listitem>Consecutive data are separated by one or several spaces.
35                             </listitem>
36                             <listitem>An expression between double-quotes is a single data.
37                             </listitem>
38                             <listitem>To include a double-quote in a data, write <literal>\"</literal> instead of <literal>"</literal>.
39                             </listitem>
40                             <listitem>The single quote <literal>'</literal> is a regular character. It has no special meaning.
41                             </listitem>
42                         </itemizedlist>
43                     </para>
44                     <para>
45                       Inside the opened session, these data can be retrieved as separated strings with <link linkend="sciargs">sciargs()</link>.
46                      </para>
47                      <para>
48                       Example:
49                         <screen><![CDATA[C:\Users\Me> scilex -nb -noatomsautoload -args "Hello \"%USERNAME%\"" 1.2345 \"%cd%\"]]></screen>
50                         <programlisting><![CDATA[
51 // Inside the opened session:
52 a = sciargs()
53 i = find(a=="-args")
54 a(i+1)
55 evstr(a(i+2))*2
56 "This session has been launched from " + a(i+3)
57                         ]]>
58                         </programlisting>
59                         <screen><![CDATA[
60 --> // Inside the opened session:
61 --> a = sciargs()
62  a  =
63 !c:\SCIdir\bin\scilex  -nw  -nb  -noatomsautoload  -args  Hello "John"  1.2345  "C:\Users\Me" !
64
65 --> i = find(a=="-args")
66  i  =
67     5.
68
69 --> a(i+1)
70  ans  =
71  Hello "John"
72
73 --> evstr(a(i+2))*2
74  ans  =
75     2.469
76
77 --> "This session has been launched from " + a(i+3)
78  ans  =
79  This session has been launched from "C:\Users\Me"
80
81 -->
82 ]]></screen>
83                      </para>
84                      <para>
85                      <note>Using <literal>-args</literal> as the <emphasis role="italic">last</emphasis> command line option is safer.
86                      </note>
87                      </para>
88                 </listitem>
89             </varlistentry>
90             <varlistentry>
91                 <term>-display Display</term>
92                 <listitem>
93                     <para>
94                         Xwindow システム上でのみ使用可能で, 表示する
95                         Xサーバーを指定します.
96                         デフォルトの表示先は unix:0.0 です.
97                     </para>
98                     <para>
99                         <literal>-display</literal> は,
100                         <literal>-d</literal>と短縮形で指定できます.
101                     </para>
102                 </listitem>
103             </varlistentry>
104             <varlistentry>
105                 <term>-e Instructions</term>
106                 <listitem>
107                     <para>
108                         At the end of the whole session startup, this option
109                         <itemizedlist>
110                             <listitem>
111                                 <para>sets the current working directory to the shell directory from which Scilab has been launched. Please see the example given here-below for the <literal>-f</literal> option. Then,
112                                 </para>
113                             </listitem>
114                             <listitem>
115                                 <para>executes Scilab <literal>Instructions</literal> provided in a string. Example:
116                                     <screen><![CDATA[ scilab-cli -e  "disp(\"Hello\"); a=%pi+%i; disp(exp(a)); exit;" -nb]]></screen>
117                                 </para>
118                             </listitem>
119                         </itemizedlist>
120                     </para>
121                     <warning>
122                         <literal>-e</literal> および <literal>-f</literal> オプションは相互に排他的です.
123                     </warning>
124                 </listitem>
125             </varlistentry>
126             <varlistentry>
127                 <term>-f file</term>
128                 <listitem>
129                     <para>
130                         If this option is used, then at the beginning of the Scilab session, after the execution of the scilab and user startup files, and after the setting of user Preferences -- including the working directory ones --,
131                         <itemizedlist>
132                             <listitem>
133                                 <para>
134                                     the current Scilab working directory is set to the shell directory from which Scilab has been launched. For instance,
135                                     <screen><![CDATA[ D:\users\me\scilab\dev> C:\scilab-5.5.2\bin\scilex -f ..\test.sce]]></screen>
136                                     will do a <literal>cd("D:\users\me\scilab\dev")</literal>.
137                                 </para>
138                             </listitem>
139                             <listitem>
140                                 <para>
141                                     the Scilab script <literal>file</literal> is executed. If a relative path is used (default <literal>.\</literal>, or like <literal>..\</literal> in the sample here-above), it refers to the new Scilab working directory.
142                                 </para>
143                             </listitem>
144                         </itemizedlist>
145                     </para>
146                     <para>.xcos 拡張子を有するファイルはXcosで開かれます.</para>
147                 </listitem>
148             </varlistentry>
149             <varlistentry>
150                 <term>-quit</term>
151                 <listitem>
152                     <para>This option forces scilab to always exit after the instruction(s) passed with the <literal>-e</literal>
153                     option, or the script referred to by the <literal>-f</literal> option, have been executed,
154                     even in case of a runtime error. This option should always be used in batch mode.
155                     It is ignored if neither <literal>-e</literal> nor <literal>-f</literal> options are present.
156                     </para>
157                 </listitem>
158             </varlistentry>
159             <varlistentry>
160                 <term>-l lang</term>
161                 <listitem>
162                     <para>このオプションを指定した場合,
163                         ユーザ言語を指定します.
164                         <emphasis>lang</emphasis> は以下の値を指定できます: <emphasis>ca_ES de_DE en_US es_ES
165                             fr_FR ja_JP pt_BR ru_RU zh_CN zh_TW
166                         </emphasis>
167                         (Scilab 5.2以降).
168                     </para>
169                     <para>
170                         互換性維持のため,その他に <literal>lang</literal> の値は,フランス語として
171                         <literal>'fr'</literal> および英語として <literal>'en'</literal> を使用可能です.
172                         デフォルト値は,<literal>scilab.start</literal>ファイルで指定されます.
173                     </para>
174                     <para>いくつかのシステムでは,UTF-8フォントを正しく描画するために,
175                         ロケールをコンパイルする必要があります.
176                     </para>
177                     <para>Scilab を以下のようにコールすることも可能です:</para>
178                     <screen><![CDATA[ LANG=ja_JP scilab
179  # これは以下と等価です
180  scilab -l ja_JP
181 ]]></screen>
182                 </listitem>
183             </varlistentry>
184             <varlistentry>
185                 <term>-nb</term>
186                 <listitem>
187                     <para>"no banner" :
188                         このオプションが指定された場合, Scilabの Welcome バナーは表示されません.
189                     </para>
190                 </listitem>
191             </varlistentry>
192             <varlistentry>
193                 <term>-ns</term>
194                 <listitem>
195                     <para>"No Startup files" :
196                         このオプションが指定された場合, スタートアップファイル
197                         <literal>SCI/etc/scilab.start</literal> およびユーザスタートアップファイル
198                         <literal>SCIHOME/.scilab</literal>,
199                         <literal>SCIHOME/scilab.ini</literal> は実行されません.
200                     </para>
201                     <para>このオプションは, Scilabの多くの機能を無効にします (動作を理解している場合のみ
202                         使用してください).
203                     </para>
204                 </listitem>
205             </varlistentry>
206             <varlistentry>
207                 <term>-nouserstartup</term>
208                 <listitem>
209                     <para>このオプションが指定された場合, スタートアップファイル
210                         <literal>SCIHOME/.scilab</literal>,
211                         <literal>SCIHOME/scilab.ini</literal> は実行されません.
212                     </para>
213                 </listitem>
214             </varlistentry>
215             <varlistentry>
216                 <term>-noatomsautoload</term>
217                 <listitem>
218                     <para>
219                         このオプションが指定された場合,イントール済みのATOMモジュールは
220                         このセッションでロードされません.
221                     </para>
222                 </listitem>
223             </varlistentry>
224             <varlistentry>
225                 <term>-nw</term>
226                 <listitem>
227                     <para>
228                         このオプションが指定された場合, Scilab は
229                         先進的な機能(グラフィック, export, xcos, scinotes, ヘルプブラウザ, ...)
230                         と共にコマンドラインで起動されます.
231                     </para>
232                     <para>Scilab 5.2以降:</para>
233                     <itemizedlist>
234                         <listitem>
235                             <para>全てのオペレーティングシステムについて
236                                 パイプが有効です (詳細については例を参照ください).
237                             </para>
238                         </listitem>
239                         <listitem>
240                             <para>Scilab のディストリビューションには,
241                                 <literal>-nw</literal>と同様のバイナリを提供します:
242                                 <literal>scilab-adv-cli</literal>
243                                 (Scilab Advanced Command Line Interpreter).
244                             </para>
245                         </listitem>
246                     </itemizedlist>
247                 </listitem>
248             </varlistentry>
249             <varlistentry>
250                 <term>-nwni / -nogui</term>
251                 <listitem>
252                     <important>このモードでは Java 仮想マシンはロードされません.
253                         (起動は高速化され,メモリ消費量は減少します)
254                     </important>
255                     <para>このオプションが指定された場合, Scilab は先進的な機能
256                         (グラフィック, export, xcos, scinotes, ヘルプブラウザ, ...)なしで
257                         コマンドラインで起動されます.
258                     </para>
259                     <para>Scilab 5.2以降:</para>
260                     <itemizedlist>
261                         <listitem>
262                             <para>全てのオペレーティングシステムについて
263                                 パイプが有効です (詳細については例を参照ください).
264                             </para>
265                         </listitem>
266                         <listitem>
267                             <para>
268                                 Scilab のディストリビューションでは,
269                                 <literal>-nwni</literal>と同じ専用バイナリが提供されています
270                                 : <literal>scilab-cli</literal>
271                                 (Scilab Command Line Interpreter).
272                             </para>
273                         </listitem>
274                     </itemizedlist>
275                 </listitem>
276             </varlistentry>
277             <varlistentry>
278                 <term>-scihome dir</term>
279                 <listitem>
280                     <para>Forces SCIHOME to the <literal>dir</literal> directory. If the path
281                       includes some white space, it must be specified between double-quotes (no
282                       single quotes!).
283                     </para>
284                 </listitem>
285             </varlistentry>
286             <varlistentry>
287                 <term>--texmacs</term>
288                 <listitem>
289                     <para>このオプションは TeXMacs用に予約されています.</para>
290                     <para>
291                         ATOMSモジュールをインストールしてください: <programlisting role="">atomsInstall('texmacs')</programlisting>
292                     </para>
293                 </listitem>
294             </varlistentry>
295             <varlistentry>
296                 <term>-version</term>
297                 <listitem>
298                     <para>このオプションはプロダクトのバージョンを出力し,終了します.</para>
299                 </listitem>
300             </varlistentry>
301         </variablelist>
302     </refsection>
303
304     <refsection role="arguments">
305         <title>Additional options for Unix/Linux and Mac OS X</title>
306         <para>助言: これらのオプションをScilabソースツリー上で使用してください.</para>
307         <variablelist>
308             <varlistentry>
309                 <term>-debug</term>
310                 <listitem>
311                     <para>デバッガgdb上でScilabを開始します.</para>
312                     <para>
313                         gdb にカスタムオプションを追加する場合,
314                         変数<literal>SCILAB_GDB_OPT</literal>を定義します.
315                     </para>
316                 </listitem>
317             </varlistentry>
318             <varlistentry>
319                 <term>-debug-kdbg</term>
320                 <listitem>
321                     <para>kdbg上でScilabを開始します.</para>
322                 </listitem>
323             </varlistentry>
324             <varlistentry>
325                 <term>-profiling</term>
326                 <listitem>
327                     <para>valgrind上でScilabを開始します.</para>
328                     <para>
329                         valgrind にカスタムオプションを追加する場合
330                         (および既存の valgrind オプションを上書きする場合),SCILAB_VALGRIND_OPT
331                         を定義してください.
332                     </para>
333                 </listitem>
334             </varlistentry>
335             <varlistentry>
336                 <term>-profiling-visu</term>
337                 <listitem>
338                     <para>callgrind上でScilabを開始します.</para>
339                     <para>
340                         callgrind にカスタムオプションを追加する場合
341                         (および既存の callgrind オプションを上書きする場合),SCILAB_VALGRIND_OPT
342                         を定義してください.
343                     </para>
344                 </listitem>
345             </varlistentry>
346             <varlistentry>
347                 <term>-electric-fence</term>
348                 <listitem>
349                     <para>Electric Fence を指定して Scilab を開始します.</para>
350                 </listitem>
351             </varlistentry>
352         </variablelist>
353     </refsection>
354
355     <refsection role="description">
356         <title>環境変数の説明</title>
357         <variablelist>
358             <varlistentry>
359                 <term>SCIVERBOSE</term>
360                 <listitem>
361                     <para>
362                         この変数が存在した場合, Scilab起動スクリプトは起動時デバッグ情報を表示します.
363                         主にバグレポートおよびデバッグ目的で使用されます.
364                     </para>
365                 </listitem>
366             </varlistentry>
367             <varlistentry>
368                 <term>JAVA_HOME</term>
369                 <listitem>
370                     <para>
371                         使用するJavaを指定します. 例えば,
372                         <literal>JAVA_HOME=/usr/lib/jvm/java-7-openjdk/ scilab</literal> は
373                         Java 7 でScilabを起動します.
374                     </para>
375                 </listitem>
376             </varlistentry>
377             <varlistentry>
378                 <term>SCI_DISABLE_TK</term>
379                 <listitem>
380                     <para>Tk (Tclではなく) 機能を無効にします.</para>
381                 </listitem>
382             </varlistentry>
383             <varlistentry>
384                 <term>SCI_JAVA_ENABLE_HEADLESS</term>
385                 <listitem>
386                     <para>
387                         ヘッドレスJava仮想マシン (すなわち,GUI機能なし).
388                     </para>
389                 </listitem>
390             </varlistentry>
391         </variablelist>
392     </refsection>
393     <refsection role="description">
394         <title>Java 仮想マシンオプション</title>
395         <warning>
396             The options described here-below are useless and are cancelled if the option <literal>-nwni</literal> is used.
397         </warning>
398         <para>Scilab 5.0以降, グラフィカルユーザインターフェイス (GUI) および
399             ドキュメントの構築は,Java機能に基づいています.
400             いくつかのケースでは,
401             JVM (Java仮想マシン)オプションを編集することが重要となります.
402         </para>
403         <para>これらのオプションは,
404             <emphasis>jvm_options.xml</emphasis>ファイルで利用可能です.
405         </para>
406         <para>5.0.X および 5.1.Xでは, このファイルは
407             <emphasis>SCI/modules/jvm/etc/jvm_options.xml</emphasis>に保存されています.
408         </para>
409         <para>&gt;= 5.2.0以降, このファイルは
410             <emphasis>
411                 etc/jvm_options.xml<emphasis> </emphasis>
412             </emphasis>
413             にあります.
414         </para>
415         <para>デフォルトで, 以下の3つのオプションが
416             設定ファイルで容易にアクセス可能です:
417         </para>
418         <variablelist>
419             <varlistentry>
420                 <term>-XmxXXXm</term>
421                 <listitem>
422                     <para>
423                         このオプションは,Java仮想マシンで利用可能なメモリ量を設定します.
424                         デフォルトで, 256M が確保されます.
425                         この値を変更した場合, その値がシステムで利用可能なメモリを
426                         超えないことを確認してください.
427                     </para>
428                     <para>
429                         Scilab 5.4.0以降, この値は設定メニュー内で変更可能です.
430                     </para>
431                 </listitem>
432             </varlistentry>
433             <varlistentry>
434                 <term>-Djava.compiler=JIT</term>
435                 <listitem>
436                     <para>
437                         このオプションを引数<emphasis>JIT</emphasis>を付けて指定すると,
438                         Java Just In Time compilerが有効になります.
439                         このオプションはデフォルトで有効となります.
440                         <emphasis>NONE</emphasis>によりJITは無効となり,
441                         著しく性能が低下します.
442                     </para>
443                 </listitem>
444             </varlistentry>
445             <varlistentry>
446                 <term>-verbose:jni / -Xcheck:jni</term>
447                 <listitem>
448                     <para>
449                         これらのオプションは,JNIコールとその出力をより詳細に確認します.
450                         デバッグ時にはこれらのオプションを利用可能ですが,
451                         性能を低下させるためデフォルトでは無効となっています.
452                     </para>
453                 </listitem>
454             </varlistentry>
455         </variablelist>
456         <para>より多くのオプションが利用可能です.
457             これにより性能を改善したり,ルックアンドフィールを変更したり,
458             メモリ管理を変更したりといったことが可能です.
459             参照:  <ulink url="http://www.oracle.com/technetwork/java/javase/tech/vmoptions-jsp-140102.html">http://www.oracle.com/technetwork/java/javase/tech/vmoptions-jsp-140102.html</ulink>
460         </para>
461     </refsection>
462     <refsection role="examples">
463         <title>例</title>
464         <screen><![CDATA[
465 # Let's start Scilab in profiling mode without attaching a gdb once a SIGSEGV is met.
466 # We are under Bash shell
467 export SCILAB_VALGRIND_OPT="--db-attach=no --log-file=myfile.txt"
468 scilab -profiling
469 # Let's start Scilab in debug mode without stopping after each SIGSEGV
470 # First, we write a small command file
471 echo "handle SIGSEGV nostop" > debug.txt
472 # Now set the custom option
473 # We are under Bash shell
474 export SCILAB_GDB_OPT="--command=debug.txt"
475 # Start Scilab in debug mode
476 scilab -debug ]]></screen>
477         <para></para>
478         <screen><![CDATA[
479 # Under GNU/Linux, Mac OS X or Unix:
480 $ echo "disp(%pi)"|scilab-cli
481 or
482 $ echo "disp(%pi)"|scilab -nwni
483 # Only open the Scilab help window:
484 $ scilab-adv-cli -e "help()"
485 or
486 $ scilab -nw -e "help()"
487 # Scilab can be used for scripting aspects:
488 echo "if 1&lt;>2 then exit(99) end"|scilab-cli
489 echo $? ]]></screen>
490     </refsection>
491     <refsection role="see also">
492         <title>参照</title>
493         <simplelist type="inline">
494             <member>
495                 <link linkend="startup">startup</link>
496             </member>
497             <member>
498                 <link linkend="sciargs">sciargs</link>
499             </member>
500             <member>
501                 <link linkend="getpid">getpid</link>
502             </member>
503             <member>
504                 <link linkend="getenv">getenv</link>
505             </member>
506             <member>
507                 <link linkend="getversion">getversion</link>
508             </member>
509             <member>
510                 <link linkend="consolebox">consolebox</link>
511             </member>
512             <member>
513                 <link linkend="exit">exit</link>
514             </member>
515         </simplelist>
516     </refsection>
517     <refsection role="history">
518         <title>履歴</title>
519         <revhistory>
520             <revision>
521                 <revnumber>5.4.0</revnumber>
522                 <revremark>-noatomsautoload が追加されました.</revremark>
523             </revision>
524             <revision>
525                 <revnumber>5.4.1</revnumber>
526                 <revremark>scinotes と xcos 個別スクリプトが導入されました. SEP #87参照.</revremark>
527             </revision>
528             <revision>
529                 <revnumber>6.0.0</revnumber>
530                 <revremark>
531                     <literal>-quit</literal> option added. <literal>-mem</literal> option removed.
532                 </revremark>
533             </revision>
534             <revision>
535                 <revnumber>6.0.1</revnumber>
536                 <revremark>
537                     <literal>-scihome</literal> option added.
538                 </revremark>
539             </revision>
540         </revhistory>
541     </refsection>
542 </refentry>