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