flag to force scilab exit after -e or -f execution added.
[scilab.git] / scilab / modules / core / help / pt_BR / 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" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="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="pt">
3     <refnamediv>
4         <refname>scilab</refname>
5         <refpurpose>principal script para executar o Scilab e ferramentas de
6             miscelânea
7         </refpurpose>
8     </refnamediv>
9     <refsynopsisdiv>
10         <title>Sqeüência de Chamamento</title>
11         <synopsis>scilab &lt;Options&gt;</synopsis>
12     </refsynopsisdiv>
13     <refsection role="arguments">
14         <title>Parâmetros</title>
15         <variablelist>
16             <varlistentry>
17                 <term>-args Arguments</term>
18                 <listitem>
19                     <para>Se esta opção estiver presente, os argumentos são passados ao
20                         Scilab. Eles podem ser recebidos pela função <link linkend="sciargs">sciargs</link>. para passagem de múltiplos
21                         argumentos use, seqüências de palavras separadas por espaços entre
22                         aspas simples: <literal>scilab -args 'foo1 foo2'</literal>
23                     </para>
24                 </listitem>
25             </varlistentry>
26             <varlistentry>
27                 <term>-display Display</term>
28                 <listitem>
29                     <para>Para uso apenas em sistemas Xwindow para ajustar um display de
30                         servidor X. O display padrão é unix:0.0
31                     </para>
32                     <para>
33                         <literal>-display</literal> pode ser abreviado por
34                         <literal>-d</literal>
35                     </para>
36                 </listitem>
37             </varlistentry>
38             <varlistentry>
39                 <term>-debug</term>
40                 <listitem>
41                     <para>Inicia o Scilab no debugger gdb (apenas para
42                         Unix/Linux/Mac OS X).
43                     </para>
44                 </listitem>
45             </varlistentry>
46             <varlistentry>
47                 <term>-e Instrução</term>
48                 <listitem>
49                     <para>Se esta opção estiver presente, então a instrução Scilab
50                         <literal>Instrução</literal> é executada primeiro (logo após a
51                         execução do arquivo de inicialização) no Scilab. As opções
52                         <literal>-e</literal> e <literal>-f</literal> são mutuamente
53                         exclusivas
54                     </para>
55                 </listitem>
56             </varlistentry>
57             <varlistentry>
58                 <term>-f arquivo</term>
59                 <listitem>
60                     <para>Se esta opção estiver presente, então o script Scilab
61                         <literal>arquivo</literal> é executado primeiro (logo após a
62                         execução do arquivo de inicialização) no Scilab. As opções
63                         <literal>-e</literal> e <literal>-f</literal> são mutuamente
64                         exclusivas.
65                     </para>
66                 </listitem>
67             </varlistentry>
68             <varlistentry>
69                 <term>-quit</term>
70                 <listitem>
71                     This option forces scilab to always exit after the instruction(s) passed with the <literal>-e</literal>
72                     option, or the script referred to by the <literal>-f</literal> option, have been executed,
73                     even in case of a runtime error. This option should always be used in batch mode.
74                     It is ignored if neither <literal>-e</literal> nor <literal>-f</literal> options are present.
75                     </para>
76                 </listitem>
77             </varlistentry>
78             <varlistentry>
79                 <term>-l idioma</term>
80                 <listitem>
81                     <para>Se esta opção estiver presente, ela fica o idioma do usuário.
82                         Os possíveis valores para <literal>idioma</literal> são
83                         <literal>'fr'</literal> para francês, <literal>'en'</literal> para
84                         inglês e 'br' para português brasileiro. O idioma padrão é inglês. O
85                         valor padrão é fixado no arquivo
86                         <literal>scilab.start</literal>.
87                     </para>
88                 </listitem>
89             </varlistentry>
90             <varlistentry>
91                 <term>-nb</term>
92                 <listitem>
93                     <para>Se esta opção está presente, então o cartão de boas-vindas não
94                         é impresso.
95                     </para>
96                 </listitem>
97             </varlistentry>
98             <varlistentry>
99                 <term>-ns</term>
100                 <listitem>
101                     <para>Se esta opção está presente, o arquivo de inicialização
102                         <literal>SCI/etc/scilab.start</literal> e os arquivos de
103                         inicialização do usuário <literal>SCIHOME/.scilab</literal>,
104                         <literal>SCIHOME/scilab.ini</literal> não são executados.
105                     </para>
106                 </listitem>
107             </varlistentry>
108             <varlistentry>
109                 <term>-nouserstartup</term>
110                 <listitem>
111                     <para>Se esta opção estiver presente, os arquivos de inicialização
112                         do usuário <literal>SCIHOME/.scilab</literal>,
113                         <literal>SCIHOME/scilab.ini</literal> não são executados.
114                     </para>
115                 </listitem>
116             </varlistentry>
117             <varlistentry>
118                 <term>-nw</term>
119                 <listitem>
120                     <para>Se esta opção estiver presente, então o Scilab não é executado
121                         em uma janela específica.
122                     </para>
123                 </listitem>
124             </varlistentry>
125             <varlistentry>
126                 <term>-nwni / -nogui</term>
127                 <listitem>
128                     <para>Se esta opção estiver presente, então o Scilab não é executado
129                         em uma janela específica e não aceita interação do usuário. Esta
130                         opção pode ser utilizada com as opções -f ou -e .
131                     </para>
132                 </listitem>
133             </varlistentry>
134             <varlistentry>
135                 <term>--texmacs</term>
136                 <listitem>
137                     <para>Esta opção é reservada para TexMacs.</para>
138                 </listitem>
139             </varlistentry>
140             <varlistentry>
141                 <term>-version</term>
142                 <listitem>
143                     <para>Esta opção imprime a versão do produto e sai.</para>
144                 </listitem>
145             </varlistentry>
146         </variablelist>
147     </refsection>
148     <refsection role="description">
149         <title>Description of environment variables</title>
150         <variablelist>
151             <varlistentry>
152                 <term>SCIVERBOSE</term>
153                 <listitem>
154                     <para>
155                         If this variable is present, Scilab startup script will show a startup debug information.
156                         Mainly used for bug report and debugging purposes.
157                     </para>
158                 </listitem>
159             </varlistentry>
160             <varlistentry>
161                 <term>JAVA_HOME</term>
162                 <listitem>
163                     <para>
164                         Specify which Java to use. For example,
165                         <literal>JAVA_HOME=/usr/lib/jvm/java-7-openjdk/ scilab</literal> will start Scilab with Java 7.
166                     </para>
167                 </listitem>
168             </varlistentry>
169             <varlistentry>
170                 <term>SCI_DISABLE_TK</term>
171                 <listitem>
172                     <para>Disable Tk (but not Tcl) features.</para>
173                 </listitem>
174             </varlistentry>
175             <varlistentry>
176                 <term>SCI_JAVA_ENABLE_HEADLESS</term>
177                 <listitem>
178                     <para>
179                         Enable Java Headless VM (i.e. without GUI features).
180                     </para>
181                 </listitem>
182             </varlistentry>
183         </variablelist>
184     </refsection>
185     <refsection role="description">
186         <title>Java Virtual Machine options</title>
187         <para>Starting from Scilab 5.0, the graphical user interface (GUI) and the
188             build documentation are based on Java features. In some cases, it can be
189             important to edit the JVM options (Java Virtual Machine).
190         </para>
191         <para>These options are available in the
192             <emphasis>jvm_options.xml</emphasis> file.
193         </para>
194         <para>In version 5.0.X and 5.1.X, this file is stored as
195             <emphasis>SCI/modules/jvm/etc/jvm_options.xml</emphasis>.
196         </para>
197         <para>In version &gt;= 5.2.0, the file is available in
198             <emphasis>etc/jvm_options.xml</emphasis>.
199         </para>
200         <para>
201             <emphasis>
202                 By default, the three following options are
203                 easily accessible in the configuration file:
204             </emphasis>
205         </para>
206         <variablelist>
207             <varlistentry>
208                 <term>-XmxXXXm</term>
209                 <listitem>
210                     <para>This option set the amount of memory available by the Java
211                         Virtual Machine. By default, 256M are allocated. If you change this
212                         value, check that the value does not exceed the memory available on
213                         the system.
214                     </para>
215                     <para>Since Scilab 5.4.0, this value can be changed in the preferences menu.</para>
216                 </listitem>
217             </varlistentry>
218             <varlistentry>
219                 <term>-Djava.compiler=JIT</term>
220                 <listitem>
221                     <para>
222                         This option with the argument <emphasis>JIT</emphasis> enables
223                         the Java Just In Time compiler. It is activated by default.
224                         <emphasis>NONE</emphasis> disables the JIT and decreases
225                         dramatically performances.
226                     </para>
227                 </listitem>
228             </varlistentry>
229             <varlistentry>
230                 <term>-verbose:jni / -Xcheck:jni</term>
231                 <listitem>
232                     <para>These options enable more checks and output from the JNI
233                         calls. These options are useful in case of debugging and are
234                         disabled by default since they decreases performances.
235                     </para>
236                 </listitem>
237             </varlistentry>
238         </variablelist>
239         <para>Many more options are available. They can improve the performances,
240             change look and feel, change memory managements... See: <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>.
241         </para>
242     </refsection>
243     <refsection role="examples">
244         <title>Exemplos</title>
245         <programlisting role="no-scilab-exec"><![CDATA[
246 # Let's start Scilab in profiling mode without attaching a gdb once a SIGSEGV is met.
247 # We are under Bash shell
248 export SCILAB_VALGRIND_OPT="--db-attach=no --log-file=myfile.txt"
249 scilab -profiling
250
251 # Let's start Scilab in debug mode without stopping after each SIGSEGV
252 # First, we write a small command file
253 echo "handle SIGSEGV nostop" &> debug.txt
254 # Now set the custom option
255 # We are under Bash shell
256 export SCILAB_GDB_OPT="--command=debug.txt"
257 # Start Scilab in debug mode
258 scilab -debug]]></programlisting>
259         <programlisting role="no-scilab-exec"><![CDATA[
260 # Under GNU/Linux, Mac OS X or Unix:
261 $ echo "disp(%pi)"|scilab-cli
262 or
263 $ echo "disp(%pi)"|scilab -nwni
264
265 # Only open the Scilab help window:
266 $ scilab-adv-cli -e "help()"
267 or
268 $ scilab -nw -e "help()"
269
270
271 # Scilab can be used for scripting aspects:
272 echo "if 1<>2 then exit(99) end"|scilab-cli
273 echo $? ]]></programlisting>
274     </refsection>
275     <refsection role="see also">
276         <title>Ver também</title>
277         <simplelist type="inline">
278             <member>
279                 <link linkend="exit">exit</link>
280             </member>
281             <member>
282                 <link linkend="startup">startup</link>
283             </member>
284         </simplelist>
285     </refsection>
286     <refsection role="history">
287         <title>Histórico</title>
288         <revhistory>
289             <revision>
290                 <revnumber>5.4.0</revnumber>
291                 <revremark>-noatomsautoload added.</revremark>
292             </revision>
293             <revision>
294                 <revnumber>5.4.1</revnumber>
295                 <revremark>scinotes and xcos individual scripts introduced. See SEP #87.</revremark>
296             </revision>
297             <revision>
298                 <revnumber>6.0.0</revnumber>
299                 <revremark>
300                     <literal>-quit</literal> option added. <literal>-mem</literal> option removed.
301                 </revremark>
302             </revision>
303         </revhistory>
304     </refsection>
305 </refentry>