flag to force scilab exit after -e or -f execution added.
[scilab.git] / scilab / modules / core / help / ja_JP / scilab.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="scilab" xml:lang="ja">
4
5     <refnamediv>
6
7         <refname>scilab</refname>
8
9         <refpurpose>
10
11             Scilabおよび関連ツールを起動するためのツール
12
13             (GNU/Linux, Unix および Mac OS X)
14
15         </refpurpose>
16
17     </refnamediv>
18
19     <refsynopsisdiv>
20
21         <title>呼出し手順</title>
22
23         <synopsis>scilab &lt;Options&gt;
24
25             scilab-adv-cli &lt;Options&gt;
26
27             scilab-cli &lt;Options&gt;
28
29         </synopsis>
30
31     </refsynopsisdiv>
32
33     <refsection role="arguments">
34
35         <title>説定</title>
36
37         <variablelist>
38
39             <varlistentry>
40
41                 <term>-args Arguments</term>
42
43                 <listitem>
44
45                     <para>
46
47                         このオプションが存在する場合,引数がScilabに渡されます.
48
49                         これらは,<link linkend="sciargs">sciargs</link>関数で取得することが
50
51                         できます.
52
53                         複数の引数を指定する場合,以下のように一連の複数の単語を引用符で括り,
54
55                         空白で分割してください: <literal>scilab -args 'foo1 foo2'</literal>.
56
57                         このオプションを指定しない場合,未知の引数は受け付けられません.
58
59                     </para>
60
61                 </listitem>
62
63             </varlistentry>
64
65             <varlistentry>
66
67                 <term>-display Display</term>
68
69                 <listitem>
70
71                     <para>
72
73                         Xwindow システム上でのみ使用可能で, 表示する
74
75                         Xサーバーを指定します.
76
77                         デフォルトの表示先は unix:0.0 です.
78
79                     </para>
80
81                     <para>
82
83                         <literal>-display</literal> は,
84
85                         <literal>-d</literal>と短縮形で指定できます.
86
87                     </para>
88
89                 </listitem>
90
91             </varlistentry>
92
93             <varlistentry>
94
95                 <term>-debug</term>
96
97                 <listitem>
98
99                     <para>デバッガgdb上でScilabを開始します(Unix/Linux/Mac OS Xのみ).</para>
100
101                     <para>
102
103                         gdb にカスタムオプションを追加する場合,
104
105                         変数<literal>SCILAB_GDB_OPT</literal>を定義します.
106
107                     </para>
108
109                     <para>助言: このオプションをScilabソースツリー上で使用してください.</para>
110
111                 </listitem>
112
113             </varlistentry>
114
115             <varlistentry>
116
117                 <term>-debug-kdbg</term>
118
119                 <listitem>
120
121                     <para>kdbg上でScilabを開始します (Unix/Linux/Mac OS X のみ).</para>
122
123                     <para>助言: このオプションをScilabソースツリー上で使用してください.</para>
124
125                 </listitem>
126
127             </varlistentry>
128
129             <varlistentry>
130
131                 <term>-profiling</term>
132
133                 <listitem>
134
135                     <para>valgrind上でScilabを開始します (Unix/Linux/Mac OS X のみ).</para>
136
137                     <para>
138
139                         valgrind にカスタムオプションを追加する場合
140
141                         (および既存の valgrind オプションを上書きする場合),SCILAB_VALGRIND_OPT
142
143                         を定義してください.
144
145                     </para>
146
147                     <para>助言: このオプションをScilabソースツリー上で使用してください.</para>
148
149                 </listitem>
150
151             </varlistentry>
152
153             <varlistentry>
154
155                 <term>-profiling-visu</term>
156
157                 <listitem>
158
159                     <para>callgrind上でScilabを開始します (Unix/Linux/Mac OS X のみ).</para>
160
161                     <para>
162
163                         callgrind にカスタムオプションを追加する場合
164
165                         (および既存の callgrind オプションを上書きする場合),SCILAB_VALGRIND_OPT
166
167                         を定義してください.
168
169                     </para>
170
171                     <para>助言: このオプションをScilabソースツリー上で使用してください.</para>
172
173                 </listitem>
174
175             </varlistentry>
176
177             <varlistentry>
178
179                 <term>-electric-fence</term>
180
181                 <listitem>
182
183                     <para>Electric Fence を指定して Scilab を開始します(Unix/Linux/Mac OS Xのみ).</para>
184
185                     <para>助言: このオプションをScilabソースツリー上で使用してください.</para>
186
187                 </listitem>
188
189             </varlistentry>
190
191             <varlistentry>
192
193                 <term>-e 命令</term>
194
195                 <listitem>
196
197                     <para>
198
199                         このオプションを指定すると Scilab 命令
200
201                         <literal>Instruction</literal> が(スタートアップファイルの実行直後に)
202
203                         まずScilabで実行されます.
204
205                         <literal>-e</literal> および
206
207                         <literal>-f</literal> オプションは相互に排他的です.
208
209                     </para>
210
211                     <para>
212                         <literal>-e</literal>により複数の命令を指定できることに注意してください.
213                     </para>
214
215                     <programlisting role="no-scilab-exec">scilab-cli -e  "a=1+%i; aPlusPi=a+%pi; disp(aPlusPi);exit;" -nb</programlisting>
216
217                 </listitem>
218
219             </varlistentry>
220
221             <varlistentry>
222
223                 <term>-f file</term>
224
225                 <listitem>
226
227                     <para>
228
229                         このオプションを指定すると, Scilab はスクリプト <literal>file</literal>
230
231                         を(スタートアップファイルの実行直後,)Scilab上で最初に実行します.
232
233
234
235                         <literal>-e</literal> および
236
237                         <literal>-f</literal> オプションは相互に排他的です.
238
239                     </para>
240
241                     <para>.xcos 拡張子を有するファイルはXcosで開かれます.</para>
242
243                 </listitem>
244
245             </varlistentry>
246
247             <varlistentry>
248                 <term>-quit</term>
249                 <listitem>
250                     This option forces scilab to always exit after the instruction(s) passed with the <literal>-e</literal>
251                     option, or the script referred to by the <literal>-f</literal> option, have been executed,
252                     even in case of a runtime error. This option should always be used in batch mode.
253                     It is ignored if neither <literal>-e</literal> nor <literal>-f</literal> options are present.
254                     </para>
255                 </listitem>
256             </varlistentry>
257
258             <varlistentry>
259
260                 <term>-l lang</term>
261
262                 <listitem>
263
264                     <para>このオプションを指定した場合,
265
266                         ユーザ言語を指定します.
267
268                         <emphasis>lang</emphasis> は以下の値を指定できます: <emphasis>ca_ES de_DE en_US es_ES
269
270                             fr_FR ja_JP pt_BR ru_RU zh_CN zh_TW
271
272                         </emphasis>
273
274                         (Scilab 5.2以降).
275
276                     </para>
277
278                     <para>
279
280                         互換性維持のため,その他に <literal>lang</literal> の値は,フランス語として
281
282                         <literal>'fr'</literal> および英語として <literal>'en'</literal> を使用可能です.
283
284                         デフォルト値は,<literal>scilab.start</literal>ファイルで指定されます.
285
286                     </para>
287
288                     <para>いくつかのシステムでは,UTF-8フォントを正しく描画するために,
289
290                         ロケールをコンパイルする必要があります.
291
292                     </para>
293
294                     <para>Scilab を以下のようにコールすることも可能です:</para>
295
296                     <programlisting role="no-scilab-exec">LANG=ja_JP scilab
297
298                         # これは以下と等価です
299
300                         scilab -l ja_JP
301
302                     </programlisting>
303
304                 </listitem>
305
306             </varlistentry>
307
308             <varlistentry>
309
310                 <term>-nb</term>
311
312                 <listitem>
313
314                     <para>
315
316                         このオプションが指定された場合, Scilabの Welcome バナーは表示されません.
317
318                     </para>
319
320                 </listitem>
321
322             </varlistentry>
323
324             <varlistentry>
325
326                 <term>-ns</term>
327
328                 <listitem>
329
330                     <para>
331
332                         このオプションが指定された場合, スタートアップファイル
333
334                         <literal>SCI/etc/scilab.start</literal> およびユーザスタートアップファイル
335
336                         <literal>SCIHOME/.scilab</literal>,
337
338                         <literal>SCIHOME/scilab.ini</literal> は実行されません.
339
340                     </para>
341
342                     <para>このオプションは, Scilabの多くの機能を無効にします (動作を理解している場合のみ
343
344                         使用してください).
345
346                     </para>
347
348                 </listitem>
349
350             </varlistentry>
351
352             <varlistentry>
353
354                 <term>-nouserstartup</term>
355
356                 <listitem>
357
358                     <para>このオプションが指定された場合, スタートアップファイル
359
360                         <literal>SCIHOME/.scilab</literal>,
361
362                         <literal>SCIHOME/scilab.ini</literal> は実行されません.
363
364                     </para>
365
366                 </listitem>
367
368             </varlistentry>
369
370             <varlistentry>
371
372                 <term>-noatomsautoload</term>
373
374                 <listitem>
375
376                     <para>
377
378                         このオプションが指定された場合,イントール済みのATOMモジュールは
379
380                         このセッションでロードされません.
381
382                     </para>
383
384                 </listitem>
385
386             </varlistentry>
387
388             <varlistentry>
389
390                 <term>-nw</term>
391
392                 <listitem>
393
394                     <para>
395
396                         このオプションが指定された場合, Scilab は
397
398                         先進的な機能(グラフィック, export, xcos, scinotes, ヘルプブラウザ, ...)
399
400                         と共にコマンドラインで起動されます.
401
402                     </para>
403
404                     <para>
405                         このオプションは <literal>-f</literal>または <literal>-e</literal>
406
407                         オプションと同時に指定することができます.
408                     </para>
409
410                     <para>Scilab 5.2以降:</para>
411
412                     <itemizedlist>
413
414                         <listitem>
415
416                             <para>Scilab のディストリビューションには,
417
418                                 <literal>-nw</literal>と同様のバイナリを提供します:
419
420                                 <literal>scilab-adv-cli</literal>
421
422                                 (Scilab Advanced Command Line Interpreter).
423
424                             </para>
425
426                         </listitem>
427
428                         <listitem>
429
430                             <para>全てのオペレーティングシステムについて
431
432                                 パイプが有効です (詳細については例を参照ください).
433
434                             </para>
435
436                         </listitem>
437
438                     </itemizedlist>
439
440                 </listitem>
441
442             </varlistentry>
443
444             <varlistentry>
445
446                 <term>-nwni / -nogui</term>
447
448                 <listitem>
449
450                     <para>このオプションが指定された場合, Scilab は先進的な機能
451
452                         (グラフィック, export, xcos, scinotes, ヘルプブラウザ, ...)なしで
453
454                         コマンドラインで起動されます.
455
456                     </para>
457
458                     <para>
459                         このオプションは <literal>-f</literal> または <literal>-e</literal>
460
461                         オプションと同時に指定することができます.
462                     </para>
463
464                     <para>Scilab 5.2以降:</para>
465
466                     <itemizedlist>
467
468                         <listitem>
469
470                             <para>
471
472                                 Scilab のディストリビューションでは,
473
474                                 <literal>-nwni</literal>と同じ専用バイナリが提供されています
475
476                                 : <literal>scilab-cli</literal>
477
478                                 (Scilab Command Line Interpreter).
479
480                             </para>
481
482                         </listitem>
483
484                     </itemizedlist>
485
486                     <itemizedlist>
487
488                         <listitem>
489
490                             <para>全てのオペレーティングシステムについて
491
492                                 パイプが有効です (詳細については例を参照ください).
493
494                             </para>
495
496                         </listitem>
497
498                     </itemizedlist>
499
500                     <para>このモードでは Java 仮想マシンはロードされません.
501
502                         (起動は高速化され,メモリ消費量は減少します)
503
504                     </para>
505
506                 </listitem>
507
508             </varlistentry>
509
510             <varlistentry>
511
512                 <term>--texmacs</term>
513
514                 <listitem>
515
516                     <para>このオプションは TeXMacs用に予約されています.</para>
517
518                     <para>
519
520                         ATOMSモジュールをインストールしてください: <programlisting role="">atomsInstall('texmacs')</programlisting>
521
522                     </para>
523
524                 </listitem>
525
526             </varlistentry>
527
528             <varlistentry>
529
530                 <term>-version</term>
531
532                 <listitem>
533
534                     <para>このオプションはプロダクトのバージョンを出力し,終了します.</para>
535
536                 </listitem>
537
538             </varlistentry>
539
540         </variablelist>
541
542     </refsection>
543
544     <refsection role="description">
545
546         <title>環境変数の説明</title>
547
548         <variablelist>
549
550             <varlistentry>
551
552                 <term>SCIVERBOSE</term>
553
554                 <listitem>
555
556                     <para>
557
558                         この変数が存在した場合, Scilab起動スクリプトは起動時デバッグ情報を表示します.
559
560                         主にバグレポートおよびデバッグ目的で使用されます.
561
562                     </para>
563
564                 </listitem>
565
566             </varlistentry>
567
568             <varlistentry>
569
570                 <term>JAVA_HOME</term>
571
572                 <listitem>
573
574                     <para>
575
576                         使用するJavaを指定します. 例えば,
577
578                         <literal>JAVA_HOME=/usr/lib/jvm/java-7-openjdk/ scilab</literal> は
579
580                         Java 7 でScilabを起動します.
581
582                     </para>
583
584                 </listitem>
585
586             </varlistentry>
587
588             <varlistentry>
589
590                 <term>SCI_DISABLE_TK</term>
591
592                 <listitem>
593
594                     <para>Tk (Tclではなく) 機能を無効にします.</para>
595
596                 </listitem>
597
598             </varlistentry>
599
600             <varlistentry>
601
602                 <term>SCI_JAVA_ENABLE_HEADLESS</term>
603
604                 <listitem>
605
606                     <para>
607
608                         ヘッドレスJava仮想マシン (すなわち,GUI機能なし).
609
610                     </para>
611
612                 </listitem>
613
614             </varlistentry>
615
616         </variablelist>
617
618     </refsection>
619
620     <refsection role="description">
621
622         <title>Java 仮想マシンオプション</title>
623
624         <para>Scilab 5.0以降, グラフィカルユーザインターフェイス (GUI) および
625
626             ドキュメントの構築は,Java機能に基づいています.
627
628             いくつかのケースでは,
629
630             JVM (Java仮想マシン)オプションを編集することが重要となります.
631
632         </para>
633
634         <para>これらのオプションは,
635
636             <emphasis>jvm_options.xml</emphasis>ファイルで利用可能です.
637
638         </para>
639
640         <para>5.0.X および 5.1.Xでは, このファイルは
641
642             <emphasis>SCI/modules/jvm/etc/jvm_options.xml</emphasis>に保存されています.
643
644         </para>
645
646         <para>&gt;= 5.2.0以降, このファイルは
647
648             <emphasis>
649
650                 etc/jvm_options.xml<emphasis> </emphasis>
651
652             </emphasis>
653
654             にあります.
655
656         </para>
657
658         <para>デフォルトで, 以下の3つのオプションが
659
660             設定ファイルで容易にアクセス可能です:
661
662         </para>
663
664         <variablelist>
665
666             <varlistentry>
667
668                 <term>-XmxXXXm</term>
669
670                 <listitem>
671
672                     <para>
673
674                         このオプションは,Java仮想マシンで利用可能なメモリ量を設定します.
675
676                         デフォルトで, 256M が確保されます.
677
678                         この値を変更した場合, その値がシステムで利用可能なメモリを
679
680                         超えないことを確認してください.
681
682                     </para>
683
684                     <para>
685
686                         Scilab 5.4.0以降, この値は設定メニュー内で変更可能です.
687
688                     </para>
689
690                 </listitem>
691
692             </varlistentry>
693
694             <varlistentry>
695
696                 <term>-Djava.compiler=JIT</term>
697
698                 <listitem>
699
700                     <para>
701
702                         このオプションを引数<emphasis>JIT</emphasis>を付けて指定すると,
703
704                         Java Just In Time compilerが有効になります.
705
706                         このオプションはデフォルトで有効となります.
707
708                         <emphasis>NONE</emphasis>によりJITは無効となり,
709
710                         著しく性能が低下します.
711
712                     </para>
713
714                 </listitem>
715
716             </varlistentry>
717
718             <varlistentry>
719
720                 <term>-verbose:jni / -Xcheck:jni</term>
721
722                 <listitem>
723
724                     <para>
725
726                         これらのオプションは,JNIコールとその出力をより詳細に確認します.
727
728                         デバッグ時にはこれらのオプションを利用可能ですが,
729
730                         性能を低下させるためデフォルトでは無効となっています.
731
732                     </para>
733
734                 </listitem>
735
736             </varlistentry>
737
738         </variablelist>
739
740         <para>より多くのオプションが利用可能です.
741
742             これにより性能を改善したり,ルックアンドフィールを変更したり,
743
744             メモリ管理を変更したりといったことが可能です.
745
746             参照:  <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>
747
748         </para>
749
750     </refsection>
751
752     <refsection role="examples">
753
754         <title>例</title>
755
756         <programlisting role="no-scilab-exec"><![CDATA[
757 # Let's start Scilab in profiling mode without attaching a gdb once a SIGSEGV is met.
758 # We are under Bash shell
759 export SCILAB_VALGRIND_OPT="--db-attach=no --log-file=myfile.txt"
760 scilab -profiling
761
762 # Let's start Scilab in debug mode without stopping after each SIGSEGV
763 # First, we write a small command file
764 echo "handle SIGSEGV nostop" &> debug.txt
765 # Now set the custom option
766 # We are under Bash shell
767 export SCILAB_GDB_OPT="--command=debug.txt"
768 # Start Scilab in debug mode
769 scilab -debug]]></programlisting>
770
771         <programlisting role="no-scilab-exec"><![CDATA[
772 # Under GNU/Linux, Mac OS X or Unix:
773 $ echo "disp(%pi)"|scilab-cli
774 or
775 $ echo "disp(%pi)"|scilab -nwni
776
777 # Only open the Scilab help window:
778 $ scilab-adv-cli -e "help()"
779 or
780 $ scilab -nw -e "help()"
781
782
783 # Scilab can be used for scripting aspects:
784 echo "if 1<>2 then exit(99) end"|scilab-cli
785 echo $? ]]></programlisting>
786
787     </refsection>
788
789     <refsection role="see also">
790
791         <title>参照</title>
792
793         <simplelist type="inline">
794
795             <member>
796
797                 <link linkend="exit">exit</link>
798
799             </member>
800
801             <member>
802
803                 <link linkend="startup">startup</link>
804
805             </member>
806
807         </simplelist>
808
809     </refsection>
810
811     <refsection role="history">
812
813         <title>履歴</title>
814
815         <revhistory>
816
817             <revision>
818
819                 <revnumber>5.4.0</revnumber>
820
821                 <revremark>-noatomsautoload が追加されました.</revremark>
822
823             </revision>
824
825             <revision>
826
827                 <revnumber>5.4.1</revnumber>
828
829                 <revremark>scinotes と xcos 個別スクリプトが導入されました. SEP #87参照.</revremark>
830
831             </revision>
832             <revision>
833                 <revnumber>6.0.0</revnumber>
834                 <revremark>
835                     <literal>-quit</literal> option added. <literal>-mem</literal> option removed.
836                 </revremark>
837             </revision>
838         </revhistory>
839
840     </refsection>
841
842 </refentry>
843