<?xml version="1.0" encoding="UTF-8"?>
-
-<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">
-
+<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">
+ <refnamediv xml:id="wscilex">
+ </refnamediv>
+ <refnamediv xml:id="scilex">
+ </refnamediv>
<refnamediv>
-
- <refname>scilab</refname>
-
+ <refname>scilex | scilab</refname>
<refpurpose>
-
Scilabおよび関連ツールを起動するためのツール
-
- (GNU/Linux, Unix および Mac OS X)
-
</refpurpose>
-
</refnamediv>
-
<refsynopsisdiv>
-
<title>呼出し手順</title>
-
- <synopsis>scilab <Options>
-
- scilab-adv-cli <Options>
-
- scilab-cli <Options>
-
+ <synopsis>
+# MS Windows | # Linux / Unix / Mac OS X
+wscilex <Options> | scilab <Options>
+wscilex -nw <Options> | scilab-adv-cli <Options>
+scilex <Options> | scilab-cli <Options>
</synopsis>
-
</refsynopsisdiv>
-
<refsection role="arguments">
-
<title>説定</title>
-
<variablelist>
-
<varlistentry>
-
- <term>-args Arguments</term>
-
+ <term>-args arg#1 arg#2 ..</term>
<listitem>
-
<para>
-
- このオプションが存在する場合,引数がScilabに渡されます.
-
- これらは,<link linkend="sciargs">sciargs</link>関数で取得することが
-
- できます.
-
- 複数の引数を指定する場合,以下のように一連の複数の単語を引用符で括り,
-
- 空白で分割してください: <literal>scilab -args 'foo1 foo2'</literal>.
-
- このオプションを指定しない場合,未知の引数は受け付けられません.
-
+ This option allows to send some data to the Scilab session:
+ <itemizedlist>
+ <listitem>Consecutive data are separated by one or several spaces.
+ </listitem>
+ <listitem>An expression between double-quotes is a single data.
+ </listitem>
+ <listitem>To include a double-quote in a data, write <literal>\"</literal> instead of <literal>"</literal>.
+ </listitem>
+ <listitem>The single quote <literal>'</literal> is a regular character. It has no special meaning.
+ </listitem>
+ </itemizedlist>
</para>
-
+ <para>
+ Inside the opened session, these data can be retrieved as separated strings with <link linkend="sciargs">sciargs()</link>.
+ </para>
+ <para>
+ Example:
+ <screen><![CDATA[C:\Users\Me> scilex -nb -args "Hello \"%USERNAME%\"" 1.2345 \"%cd%\"]]></screen>
+ <programlisting><![CDATA[
+// Inside the opened session:
+a = sciargs()
+i = find(a=="-args")
+a(i+1)
+evstr(a(i+2))*2
+"This session has been launched from " + a(i+3)
+ ]]>
+ </programlisting>
+ <screen><![CDATA[
+--> // Inside the opened session:
+--> a = sciargs()
+ a =
+!c:\SCIdir\bin\scilex -nw -nb -noatomsautoload -args Hello "John" 1.2345 "C:\Users\Me" !
+
+--> i = find(a=="-args")
+ i =
+ 5.
+
+--> a(i+1)
+ ans =
+ Hello "John"
+
+--> evstr(a(i+2))*2
+ ans =
+ 2.469
+
+--> "This session has been launched from " + a(i+3)
+ ans =
+ This session has been launched from "C:\Users\Me"
+
+-->
+]]></screen>
+ </para>
+ <para>
+ <note>Using <literal>-args</literal> as the <emphasis role="italic">last</emphasis> command line option is safer.
+ </note>
+ </para>
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>-display Display</term>
-
<listitem>
-
<para>
-
Xwindow システム上でのみ使用可能で, 表示する
-
Xサーバーを指定します.
-
デフォルトの表示先は unix:0.0 です.
-
</para>
-
<para>
-
<literal>-display</literal> は,
-
<literal>-d</literal>と短縮形で指定できます.
-
- </para>
-
- </listitem>
-
- </varlistentry>
-
- <varlistentry>
-
- <term>-debug</term>
-
- <listitem>
-
- <para>デバッガgdb上でScilabを開始します(Unix/Linux/Mac OS Xのみ).</para>
-
- <para>
-
- gdb にカスタムオプションを追加する場合,
-
- 変数<literal>SCILAB_GDB_OPT</literal>を定義します.
-
- </para>
-
- <para>助言: このオプションをScilabソースツリー上で使用してください.</para>
-
- </listitem>
-
- </varlistentry>
-
- <varlistentry>
-
- <term>-debug-kdbg</term>
-
- <listitem>
-
- <para>kdbg上でScilabを開始します (Unix/Linux/Mac OS X のみ).</para>
-
- <para>助言: このオプションをScilabソースツリー上で使用してください.</para>
-
- </listitem>
-
- </varlistentry>
-
- <varlistentry>
-
- <term>-profiling</term>
-
- <listitem>
-
- <para>valgrind上でScilabを開始します (Unix/Linux/Mac OS X のみ).</para>
-
- <para>
-
- valgrind にカスタムオプションを追加する場合
-
- (および既存の valgrind オプションを上書きする場合),SCILAB_VALGRIND_OPT
-
- を定義してください.
-
</para>
-
- <para>助言: このオプションをScilabソースツリー上で使用してください.</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
- <term>-profiling-visu</term>
-
- <listitem>
-
- <para>callgrind上でScilabを開始します (Unix/Linux/Mac OS X のみ).</para>
-
- <para>
-
- callgrind にカスタムオプションを追加する場合
-
- (および既存の callgrind オプションを上書きする場合),SCILAB_VALGRIND_OPT
-
- を定義してください.
-
- </para>
-
- <para>助言: このオプションをScilabソースツリー上で使用してください.</para>
-
- </listitem>
-
- </varlistentry>
-
- <varlistentry>
-
- <term>-electric-fence</term>
-
- <listitem>
-
- <para>Electric Fence を指定して Scilab を開始します(Unix/Linux/Mac OS Xのみ).</para>
-
- <para>助言: このオプションをScilabソースツリー上で使用してください.</para>
-
- </listitem>
-
- </varlistentry>
-
- <varlistentry>
-
- <term>-e 命令</term>
-
+ <term>-e Instructions</term>
<listitem>
-
- <para>
-
- このオプションを指定すると Scilab 命令
-
- <literal>Instruction</literal> が(スタートアップファイルの実行直後に)
-
- まずScilabで実行されます.
-
- <literal>-e</literal> および
-
- <literal>-f</literal> オプションは相互に排他的です.
-
- </para>
-
<para>
- <literal>-e</literal>により複数の命令を指定できることに注意してください.
+ At the end of the whole session startup, this option
+ <itemizedlist>
+ <listitem>
+ <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,
+ </para>
+ </listitem>
+ <listitem>
+ <para>executes Scilab <literal>Instructions</literal> provided in a string. Example:
+ <screen><![CDATA[ scilab-cli -e "disp(\"Hello\"); a=%pi+%i; disp(exp(a)); exit;" -nb]]></screen>
+ </para>
+ </listitem>
+ </itemizedlist>
</para>
-
- <programlisting role="no-scilab-exec">scilab-cli -e "a=1+%i; aPlusPi=a+%pi; disp(aPlusPi);exit;" -nb</programlisting>
-
+ <warning>
+ <literal>-e</literal> および <literal>-f</literal> オプションは相互に排他的です.
+ </warning>
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>-f file</term>
-
<listitem>
-
<para>
-
- このオプションを指定すると, Scilab はスクリプト <literal>file</literal>
-
- を(スタートアップファイルの実行直後,)Scilab上で最初に実行します.
-
-
-
- <literal>-e</literal> および
-
- <literal>-f</literal> オプションは相互に排他的です.
-
+ 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 --,
+ <itemizedlist>
+ <listitem>
+ <para>
+ the current Scilab working directory is set to the shell directory from which Scilab has been launched. For instance,
+ <screen><![CDATA[ D:\users\me\scilab\dev> C:\scilab-5.5.2\bin\scilex -f ..\test.sce]]></screen>
+ will do a <literal>cd("D:\users\me\scilab\dev")</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </itemizedlist>
</para>
-
<para>.xcos 拡張子を有するファイルはXcosで開かれます.</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
<term>-quit</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
<varlistentry>
-
<term>-l lang</term>
-
<listitem>
-
<para>このオプションを指定した場合,
-
ユーザ言語を指定します.
-
<emphasis>lang</emphasis> は以下の値を指定できます: <emphasis>ca_ES de_DE en_US es_ES
-
fr_FR ja_JP pt_BR ru_RU zh_CN zh_TW
-
</emphasis>
-
(Scilab 5.2以降).
-
</para>
-
<para>
-
互換性維持のため，その他に <literal>lang</literal> の値は,フランス語として
-
<literal>'fr'</literal> および英語として <literal>'en'</literal> を使用可能です.
-
デフォルト値は,<literal>scilab.start</literal>ファイルで指定されます.
-
</para>
-
<para>いくつかのシステムでは,UTF-8フォントを正しく描画するために,
-
ロケールをコンパイルする必要があります.
-
</para>
-
<para>Scilab を以下のようにコールすることも可能です:</para>
-
- <programlisting role="no-scilab-exec">LANG=ja_JP scilab
-
- # これは以下と等価です
-
- scilab -l ja_JP
-
- </programlisting>
-
+ <screen><![CDATA[ LANG=ja_JP scilab
+ # これは以下と等価です
+ scilab -l ja_JP
+]]></screen>
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>-nb</term>
-
<listitem>
-
- <para>
-
+ <para>"no banner" :
このオプションが指定された場合, Scilabの Welcome バナーは表示されません.
-
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>-ns</term>
-
<listitem>
-
- <para>
-
+ <para>"No Startup files" :
このオプションが指定された場合, スタートアップファイル
-
<literal>SCI/etc/scilab.start</literal> およびユーザスタートアップファイル
-
<literal>SCIHOME/.scilab</literal>,
-
<literal>SCIHOME/scilab.ini</literal> は実行されません.
-
</para>
-
<para>このオプションは, Scilabの多くの機能を無効にします (動作を理解している場合のみ
-
使用してください).
-
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>-nouserstartup</term>
-
<listitem>
-
<para>このオプションが指定された場合, スタートアップファイル
-
<literal>SCIHOME/.scilab</literal>,
-
<literal>SCIHOME/scilab.ini</literal> は実行されません.
-
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>-noatomsautoload</term>
-
<listitem>
-
<para>
-
このオプションが指定された場合,イントール済みのATOMモジュールは
-
このセッションでロードされません.
-
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>-nw</term>
-
<listitem>
-
<para>
-
このオプションが指定された場合, Scilab は
-
先進的な機能(グラフィック, export, xcos, scinotes, ヘルプブラウザ, ...)
-
と共にコマンドラインで起動されます.
-
</para>
-
- <para>
- このオプションは <literal>-f</literal>または <literal>-e</literal>
-
- オプションと同時に指定することができます.
- </para>
-
<para>Scilab 5.2以降:</para>
-
<itemizedlist>
-
<listitem>
-
+ <para>全てのオペレーティングシステムについて
+ パイプが有効です (詳細については例を参照ください).
+ </para>
+ </listitem>
+ <listitem>
<para>Scilab のディストリビューションには,
-
<literal>-nw</literal>と同様のバイナリを提供します:
-
<literal>scilab-adv-cli</literal>
-
(Scilab Advanced Command Line Interpreter).
-
</para>
-
</listitem>
-
- <listitem>
-
- <para>全てのオペレーティングシステムについて
-
- パイプが有効です (詳細については例を参照ください).
-
- </para>
-
- </listitem>
-
</itemizedlist>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>-nwni / -nogui</term>
-
<listitem>
-
+ <important>このモードでは Java 仮想マシンはロードされません.
+ (起動は高速化され,メモリ消費量は減少します)
+ </important>
<para>このオプションが指定された場合, Scilab は先進的な機能
-
(グラフィック, export, xcos, scinotes, ヘルプブラウザ, ...)なしで
-
コマンドラインで起動されます.
-
- </para>
-
- <para>
- このオプションは <literal>-f</literal> または <literal>-e</literal>
-
- オプションと同時に指定することができます.
</para>
-
<para>Scilab 5.2以降:</para>
-
<itemizedlist>
-
<listitem>
-
+ <para>全てのオペレーティングシステムについて
+ パイプが有効です (詳細については例を参照ください).
+ </para>
+ </listitem>
+ <listitem>
<para>
-
Scilab のディストリビューションでは,
-
<literal>-nwni</literal>と同じ専用バイナリが提供されています
-
: <literal>scilab-cli</literal>
-
(Scilab Command Line Interpreter).
-
- </para>
-
- </listitem>
-
- </itemizedlist>
-
- <itemizedlist>
-
- <listitem>
-
- <para>全てのオペレーティングシステムについて
-
- パイプが有効です (詳細については例を参照ください).
-
</para>
-
</listitem>
-
</itemizedlist>
-
- <para>このモードでは Java 仮想マシンはロードされません.
-
- (起動は高速化され,メモリ消費量は減少します)
-
- </para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>--texmacs</term>
-
<listitem>
-
<para>このオプションは TeXMacs用に予約されています.</para>
-
<para>
-
ATOMSモジュールをインストールしてください: <programlisting role="">atomsInstall('texmacs')</programlisting>
-
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>-version</term>
-
<listitem>
-
<para>このオプションはプロダクトのバージョンを出力し,終了します.</para>
-
</listitem>
-
</varlistentry>
-
</variablelist>
+ </refsection>
+ <refsection role="arguments">
+ <title>Additional options for Unix/Linux and Mac OS X</title>
+ <para>助言: これらのオプションをScilabソースツリー上で使用してください.</para>
+ <variablelist>
+ <varlistentry>
+ <term>-debug</term>
+ <listitem>
+ <para>デバッガgdb上でScilabを開始します.</para>
+ <para>
+ gdb にカスタムオプションを追加する場合,
+ 変数<literal>SCILAB_GDB_OPT</literal>を定義します.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>-debug-kdbg</term>
+ <listitem>
+ <para>kdbg上でScilabを開始します.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>-profiling</term>
+ <listitem>
+ <para>valgrind上でScilabを開始します.</para>
+ <para>
+ valgrind にカスタムオプションを追加する場合
+ (および既存の valgrind オプションを上書きする場合),SCILAB_VALGRIND_OPT
+ を定義してください.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>-profiling-visu</term>
+ <listitem>
+ <para>callgrind上でScilabを開始します.</para>
+ <para>
+ callgrind にカスタムオプションを追加する場合
+ (および既存の callgrind オプションを上書きする場合),SCILAB_VALGRIND_OPT
+ を定義してください.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>-electric-fence</term>
+ <listitem>
+ <para>Electric Fence を指定して Scilab を開始します.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsection>
<refsection role="description">
-
<title>環境変数の説明</title>
-
<variablelist>
-
<varlistentry>
-
<term>SCIVERBOSE</term>
-
<listitem>
-
<para>
-
この変数が存在した場合, Scilab起動スクリプトは起動時デバッグ情報を表示します.
-
主にバグレポートおよびデバッグ目的で使用されます.
-
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>JAVA_HOME</term>
-
<listitem>
-
<para>
-
使用するJavaを指定します. 例えば,
-
<literal>JAVA_HOME=/usr/lib/jvm/java-7-openjdk/ scilab</literal> は
-
Java 7 でScilabを起動します.
-
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>SCI_DISABLE_TK</term>
-
<listitem>
-
<para>Tk (Tclではなく) 機能を無効にします.</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>SCI_JAVA_ENABLE_HEADLESS</term>
-
<listitem>
-
<para>
-
ヘッドレスJava仮想マシン (すなわち,GUI機能なし).
-
</para>
-
</listitem>
-
</varlistentry>
-
</variablelist>
-
</refsection>
-
<refsection role="description">
-
<title>Java 仮想マシンオプション</title>
-
+ <warning>
+ The options described here-below are useless and are cancelled if the option <literal>-nwni</literal> is used.
+ </warning>
<para>Scilab 5.0以降, グラフィカルユーザインターフェイス (GUI) および
-
ドキュメントの構築は,Java機能に基づいています.
-
いくつかのケースでは,
-
JVM (Java仮想マシン)オプションを編集することが重要となります.
-
</para>
-
<para>これらのオプションは,
-
<emphasis>jvm_options.xml</emphasis>ファイルで利用可能です.
-
</para>
-
<para>5.0.X および 5.1.Xでは, このファイルは
-
<emphasis>SCI/modules/jvm/etc/jvm_options.xml</emphasis>に保存されています.
-
</para>
-
<para>>= 5.2.0以降, このファイルは
-
<emphasis>
-
etc/jvm_options.xml<emphasis> </emphasis>
-
</emphasis>
-
にあります.
-
</para>
-
<para>デフォルトで, 以下の3つのオプションが
-
設定ファイルで容易にアクセス可能です:
-
</para>
-
<variablelist>
-
<varlistentry>
-
<term>-XmxXXXm</term>
-
<listitem>
-
<para>
-
このオプションは,Java仮想マシンで利用可能なメモリ量を設定します.
-
デフォルトで, 256M が確保されます.
-
この値を変更した場合, その値がシステムで利用可能なメモリを
-
超えないことを確認してください.
-
</para>
-
<para>
-
Scilab 5.4.0以降, この値は設定メニュー内で変更可能です.
-
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>-Djava.compiler=JIT</term>
-
<listitem>
-
<para>
-
このオプションを引数<emphasis>JIT</emphasis>を付けて指定すると,
-
Java Just In Time compilerが有効になります.
-
このオプションはデフォルトで有効となります.
-
<emphasis>NONE</emphasis>によりJITは無効となり,
-
著しく性能が低下します.
-
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>-verbose:jni / -Xcheck:jni</term>
-
<listitem>
-
<para>
-
これらのオプションは,JNIコールとその出力をより詳細に確認します.
-
デバッグ時にはこれらのオプションを利用可能ですが,
-
性能を低下させるためデフォルトでは無効となっています.
-
</para>
-
</listitem>
-
</varlistentry>
-
</variablelist>
-
<para>より多くのオプションが利用可能です.
-
これにより性能を改善したり,ルックアンドフィールを変更したり,
-
メモリ管理を変更したりといったことが可能です.
-
参照: <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>
-
</para>
-
</refsection>
-
<refsection role="examples">
-
<title>例</title>
-
- <programlisting role="no-scilab-exec"><![CDATA[
+ <screen><![CDATA[
# Let's start Scilab in profiling mode without attaching a gdb once a SIGSEGV is met.
# We are under Bash shell
export SCILAB_VALGRIND_OPT="--db-attach=no --log-file=myfile.txt"
scilab -profiling
-
# Let's start Scilab in debug mode without stopping after each SIGSEGV
# First, we write a small command file
echo "handle SIGSEGV nostop" &> debug.txt
# We are under Bash shell
export SCILAB_GDB_OPT="--command=debug.txt"
# Start Scilab in debug mode
-scilab -debug]]></programlisting>
-
- <programlisting role="no-scilab-exec"><![CDATA[
+scilab -debug ]]></screen>
+ <para></para>
+ <screen><![CDATA[
# Under GNU/Linux, Mac OS X or Unix:
$ echo "disp(%pi)"|scilab-cli
or
$ echo "disp(%pi)"|scilab -nwni
-
# Only open the Scilab help window:
$ scilab-adv-cli -e "help()"
or
$ scilab -nw -e "help()"
-
-
# Scilab can be used for scripting aspects:
echo "if 1<>2 then exit(99) end"|scilab-cli
-echo $? ]]></programlisting>
-
+echo $? ]]></screen>
</refsection>
-
<refsection role="see also">
-
<title>参照</title>
-
<simplelist type="inline">
-
<member>
-
- <link linkend="exit">exit</link>
-
+ <link linkend="startup">startup</link>
</member>
-
<member>
-
- <link linkend="startup">startup</link>
-
+ <link linkend="sciargs">sciargs</link>
+ </member>
+ <member>
+ <link linkend="getpid">getpid</link>
+ </member>
+ <member>
+ <link linkend="getenv">getenv</link>
+ </member>
+ <member>
+ <link linkend="getenv">getversion</link>
+ </member>
+ <member>
+ <link linkend="consolebox">consolebox</link>
+ </member>
+ <member>
+ <link linkend="exit">exit</link>
</member>
-
</simplelist>
-
</refsection>
-
<refsection role="history">
-
<title>履歴</title>
-
<revhistory>
-
<revision>
-
<revnumber>5.4.0</revnumber>
-
<revremark>-noatomsautoload が追加されました.</revremark>
-
</revision>
-
<revision>
-
<revnumber>5.4.1</revnumber>
-
<revremark>scinotes と xcos 個別スクリプトが導入されました. SEP #87参照.</revremark>
-
</revision>
<revision>
<revnumber>6.0.0</revnumber>
</revremark>
</revision>
</revhistory>
-
</refsection>
-
-</refentry>
-
+</refentry>
\ No newline at end of file
projects / scilab.git / blobdiff