help: scilab|scilex page fixed & improved
[scilab.git] / scilab / modules / core / help / fr_FR / 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="fr">
6     <refnamediv xml:id="wscilex">
7     </refnamediv>
8     <refnamediv xml:id="scilex">
9     </refnamediv>
10     <refnamediv>
11         <refname>scilex | scilab</refname>
12         <refpurpose>lance Scilab en mode interactif ou batch avec options
13         </refpurpose>
14     </refnamediv>
15     <refsynopsisdiv>
16         <title>Syntaxe</title>
17         <synopsis>
18 #      MS Windows          |  # Linux / Unix / Mac OS X
19 wscilex     &lt;Options&gt;     |  scilab         &lt;Options&gt;
20 wscilex -nw &lt;Options&gt; |  scilab-adv-cli &lt;Options&gt;
21 scilex      &lt;Options&gt;      |  scilab-cli     &lt;Options&gt;
22         </synopsis>
23     </refsynopsisdiv>
24     <refsection role="arguments">
25         <title>Options</title>
26         <variablelist>
27             <varlistentry>
28                 <term>-args arg#1 arg#2 ..</term>
29                 <listitem>
30                     <para>
31                         Cette option permet de transmettre des données à la session Scilab à ouvrir :
32                         <itemizedlist>
33                             <listitem>Des données consécutives sont séparées par un ou plusieurs espaces.
34                             </listitem>
35                             <listitem>Une expression entre guillemets <literal>"</literal> constitue une donnée unique.
36                             </listitem>
37                             <listitem>Pour inclure un guillemet dans une donnée, écrire <literal>\"</literal> au lieu de <literal>"</literal>.
38                             </listitem>
39                             <listitem>L'apostrophe <literal>'</literal> est un caractère normal. Il n'a pas de signification particulière.
40                             </listitem>
41                         </itemizedlist>
42                     </para>
43                     <para>
44                       Dans la session ouverte, les données <literal>arg#1, arg#2, ..</literal> peuvent être récupérées comme autant d'expressions texte avec <link linkend="sciargs">sciargs()</link>.
45                      </para>
46                      <para>
47                       Exemple :
48                         <screen><![CDATA[C:\Users\Me> scilex -nb -args "Hello \"%USERNAME%\"" 1.2345 \"%cd%\" ]]></screen>
49                         <programlisting><![CDATA[
50 // Dans la session ouverte :
51 a = sciargs()
52 i = find(a=="-args")
53 a(i+1)
54 evstr(a(i+2))*2
55 "Cette session a été lancée depuis " + a(i+3)
56                         ]]>
57                         </programlisting>
58                         <screen><![CDATA[
59 --> // Dans la session ouverte :
60 --> a = sciargs()
61  a  =
62 !c:\SCIdir\bin\scilex  -nw  -nb  -noatomsautoload  -args  Hello "John"  1.2345  "C:\Users\Me" !
63
64 --> i = find(a=="-args")
65  i  =
66     5.
67
68 --> a(i+1)
69  ans  =
70  Hello "John"
71
72 --> evstr(a(i+2))*2
73  ans  =
74     2.469
75
76 --> "Cette session a été lancée depuis " + a(i+3)
77  ans  =
78  Cette session a été lancée depuis "C:\Users\Me"
79
80 -->
81 ]]></screen>
82                      </para>
83                      <para>
84                      <note>Utiliser <literal>-args</literal> comme <emphasis role="italic">dernière</emphasis> option sur la ligne de commande est plus sûr.
85                      </note>
86                      </para>
87                 </listitem>
88             </varlistentry>
89             <varlistentry>
90                 <term>-display Display</term>
91                 <listitem>
92                     <para>Cette option n'est valide que pour les version basées sur
93                         Xwindow, elle peut alors être utilisée pour specifier un server X.
94                         La valeur par défaut est unix:0.0
95                     </para>
96                     <para>
97                         <literal>-display</literal> peut être remplacé par
98                         <literal>-d</literal>
99                     </para>
100                 </listitem>
101             </varlistentry>
102             <varlistentry>
103                 <term>-e Instructions</term>
104                 <listitem>
105                     <para>
106                         À l'issue du démarrage complet de la session, cette option
107                         <itemizedlist>
108                             <listitem>
109                                 <para>fixe le dossier de travail de Scilab au dossier système depuis lequel Scilab a été lancé. Voir l'exemple donné plus bas pour l'option <literal>-f</literal>. Puis,
110                                 </para>
111                             </listitem>
112                             <listitem>
113                                 <para>éxécute les <literal>Instructions</literal> Scilab indiquées. Exemple :
114                                     <screen><![CDATA[ scilab-cli -e  "disp(\"Hello\"); a=%pi+%i; disp(exp(a)); exit;" -nb ]]></screen>
115                                 </para>
116                             </listitem>
117                         </itemizedlist>
118                     </para>
119                     <warning>
120                         Les options <literal>-e</literal> et <literal>-f</literal> ne peuvent pas être utilisées ensemble.
121                     </warning>
122                 </listitem>
123             </varlistentry>
124             <varlistentry>
125                 <term>-f Fichier</term>
126                 <listitem>
127                     <para>
128                         Si cette option est indiquée, alors au début de la session Scilab, après l'exécution des fichiers de démarrage de Scilab et de l'utilisateur, et après l'activation des Préférences de l'utilisateur -- dont celles concernant le dossier de travail par défaut --,
129                         <itemizedlist>
130                             <listitem>
131                                 <para>
132                                     le dossier de travail de Scilab est fixé au dossier système depuis lequel Scilab a été lancé. Par exemple,
133                                     <screen><![CDATA[D:\users\me\scilab\dev> C:\scilab-5.5.2\bin\scilex -f ..\test.sce]]></screen>
134                                     exécutera <literal>cd("D:\users\me\scilab\dev")</literal>.
135                                 </para>
136                             </listitem>
137                             <listitem>
138                                 <para>
139                                     le script Scilab <literal>Fichier</literal> est exécuté. S'il est indiqué avec un chemin relatif (<literal>.\</literal> par défaut, ou tel que <literal>..\</literal> dans l'exemple ci-dessus), celui-ci se réfère au nouveau dossier de travail de Scilab.
140                                 </para>
141                             </listitem>
142                         </itemizedlist>
143                     </para>
144                     <para>
145                         Un fichier avec l'extension .xcos sera ouvert par Xcos.
146                     </para>
147                 </listitem>
148             </varlistentry>
149             <varlistentry>
150                 <term>-quit</term>
151                 <listitem>
152                     <para>Cette option force Scilab à quitter la session après l'exécution des instructions
153                     données par l'option <literal>-e</literal> ou par le script indiqué via l'option
154                     <literal>-f</literal>, y compris en cas d'erreur d'exécution.
155                     Cette option doit toujours être utilisée en mode batch. Elle est ignorée lorsque
156                     l'option <literal>-e</literal> ou <literal>-f</literal> n'est pas utilisée.
157                     </para>
158                 </listitem>
159             </varlistentry>
160             <varlistentry>
161                 <term>-l lang</term>
162                 <listitem>
163                     <para>Cette option permet de sélectionner la langue de
164                         l'utilisateur. <emphasis>lang</emphasis> peut avoir les valeurs:
165                         <emphasis>ca_ES de_DE en_US es_ES fr_FR ja_JP pt_BR ru_RU zh_CN
166                             zh_TW
167                         </emphasis>
168                         (à partir de Scilab 5.2).
169                     </para>
170                     <para>
171                         Les valeurs possible pour sont <literal>-l fr</literal> pour
172                         sélectionner le francais et <literal>-l en</literal> pour
173                         sélectionner l'anglais. La langue par défaut est établie à l'anglais dans le fichier
174                         <literal>scilab.start</literal>.
175                     </para>
176                     <para>Avec certains systèmes, la compilation des locales peut être
177                         nécessaire pour rendre correctement les polices UTF-8.
178                     </para>
179                     <para>Scilab peut être aussi appellé de la manière suivante:</para>
180                     <screen><![CDATA[ LANG=ja_JP scilab
181  # équivalent à
182  scilab -l ja_JP
183 ]]></screen>
184                 </listitem>
185             </varlistentry>
186             <varlistentry>
187                 <term>-nb</term>
188                 <listitem>
189                     <para>"no banner" : supprime l'affichage du message de chargement de Scilab.
190                     </para>
191                 </listitem>
192             </varlistentry>
193             <varlistentry>
194                 <term>-ns</term>
195                 <listitem>
196                     <para>"no startup" : supprime l'éxécution du script de démarrage
197                         "principal" <literal>SCI/etc/scilab.start</literal> ainsi que les
198                         fichiers de démarrage "utilisateur"
199                         <literal>SCIHOME/.scilab</literal> et
200                         <literal>SCIHOME/scilab.ini</literal> ne sont pas pas
201                         exécutés.
202                     </para>
203                     <warning>
204                         Cette option désactive de nombreuses fonctionnalités de Scilab.
205                         À utiliser avec expertise et discernement.
206                     </warning>
207                 </listitem>
208             </varlistentry>
209             <varlistentry>
210                 <term>-nouserstartup</term>
211                 <listitem>
212                     <para>Si cette option est fournie, les fichiers de démarrage
213                         "utilisateur" <literal>SCIHOME/.scilab</literal>,
214                         <literal>SCIHOME/scilab.ini</literal> ne sont pas exécutés.
215                     </para>
216                 </listitem>
217             </varlistentry>
218             <varlistentry>
219                 <term>-noatomsautoload</term>
220                 <listitem>
221                     <para>
222                         supprime le chargement en début de session des modules ATOMS installés.
223                     </para>
224                 </listitem>
225             </varlistentry>
226             <varlistentry>
227                 <term>-nw</term>
228                 <listitem>
229                     <para>si cette option est présente, Scilab est lancé en tant
230                         qu'interprêteur de commandes avancé : la console est sans
231                         menus, mais les fonctionnalités Java sont disponibles
232                         (graphiques, export, xcos, scinotes, navigateur d'aide,
233                         module JIMS, etc).
234                     </para>
235                     <para>A partir de la version 5.2 de Scilab:</para>
236                     <itemizedlist>
237                         <listitem>
238                             <para>La distribution de Scilab fournit aussi un binaire dédié
239                                 faisant la même chose que l'option <emphasis>-nw</emphasis>:
240                                 <emphasis>scilab-adv-cli</emphasis> (Scilab Advanced Command
241                                 Line Interpreter).
242                             </para>
243                         </listitem>
244                         <listitem>
245                             <para>Les fonctionnalités de pipe sont accessibles pour tous les
246                                 systèmes d'exploitations (voir les examples pour plus de
247                                 détails)
248                             </para>
249                         </listitem>
250                     </itemizedlist>
251                 </listitem>
252             </varlistentry>
253             <varlistentry>
254                 <term>-nwni / -nogui</term>
255                 <listitem>
256                     <important>
257                         Cette option supprime le chargement de la Machine Virtuelle Java en mémoire.
258                         Elle accélère le démarrage de Scilab et réduit la mémoire consommée.
259                     </important>
260                     <para>si cette option est présente, Scilab est lancé en tant
261                         qu'interprêteur de commandes (sans graphiques ni interfaces
262                         ni fonctionnalité de construction de l'aide, etc).
263                     </para>
264                     <para>A partir de la version 5.2 de Scilab:</para>
265                     <itemizedlist>
266                         <listitem>
267                             <para>Les fonctionnalités de pipe sont accessibles pour tous les
268                                 systèmes d'exploitations (voir les exemples pour plus de
269                                 détails)
270                             </para>
271                         </listitem>
272                         <listitem>
273                             <para>La distribution de Scilab fournit aussi un binaire dédié
274                                 faisant la même chose que l'option <emphasis>-nw</emphasis>:
275                                 <emphasis>scilab-cli</emphasis> (Scilab Command Line
276                                 Interpreter).
277                             </para>
278                         </listitem>
279                     </itemizedlist>
280                 </listitem>
281             </varlistentry>
282             <varlistentry>
283                 <term>--texmacs</term>
284                 <listitem>
285                     <para>Cette option est réservée au module externe TeXMacs.</para>
286                     <para>
287                         Celui-ci peut être préalablement installé avec <code>atomsInstall('texmacs')</code>
288                     </para>
289                 </listitem>
290             </varlistentry>
291             <varlistentry>
292                 <term>-version</term>
293                 <listitem>
294                     <para>Cette option affiche la version de Scilab.</para>
295                 </listitem>
296             </varlistentry>
297         </variablelist>
298     </refsection>
299     <refsection role="arguments">
300         <title>Options supplémentaires sous Unix/Linux ou Mac OS X</title>
301         <para>Conseil: utiliser ces options à partir de l'arborescence source de Scilab.</para>
302         <variablelist>
303             <varlistentry>
304                 <term>-debug</term>
305                 <listitem>
306                     <para>Lance Scilab sous gdb.</para>
307                     <para>Définir la variable SCILAB_GDB_OPT pour ajouter des options
308                         supplémentaire à gdb.
309                     </para>
310                 </listitem>
311             </varlistentry>
312             <varlistentry>
313                 <term>-debug-kdbg</term>
314                 <listitem>
315                     <para>Lance Scilab sous kdbg.</para>
316                 </listitem>
317             </varlistentry>
318             <varlistentry>
319                 <term>-profiling</term>
320                 <listitem>
321                     <para>Lance Scilab sous valgrind.</para>
322                     <para>Définir la variable SCILAB_VALGRIND_OPT pour ajouter des
323                         options supplémentaire à valgrind (et surcharger les options de
324                         valgrind existantes).
325                     </para>
326                 </listitem>
327             </varlistentry>
328             <varlistentry>
329                 <term>-profiling-visu</term>
330                 <listitem>
331                     <para>Lance Scilab sous callgrind.</para>
332                     <para>Définir la variable SCILAB_VALGRIND_OPT pour ajouter des
333                         options supplémentaires à callgrind (et surcharger les options de
334                         callgrind existante).
335                     </para>
336                 </listitem>
337             </varlistentry>
338             <varlistentry>
339                 <term>-electric-fence</term>
340                 <listitem>
341                     <para>Lance Scilab sous Electric Fence.</para>
342                 </listitem>
343             </varlistentry>
344         </variablelist>
345     </refsection>
346     <refsection role="description">
347         <title>Variables d'environnement</title>
348         <variablelist>
349             <varlistentry>
350                 <term>SCIVERBOSE</term>
351                 <listitem>
352                     <para>Si cette variable d'environnement est présente, le script de démarrage de Scilab affichera les informations de debug. Principalement utilisée pour du debug ou le report de bugs.</para>
353                 </listitem>
354             </varlistentry>
355             <varlistentry>
356                 <term>JAVA_HOME</term>
357                 <listitem>
358                     <para>
359                         Indique quelle version de Java utiliser. Par exemple, <literal>JAVA_HOME=/usr/lib/jvm/java-7-openjdk/ scilab</literal> démarrera Scilab avec la version 7 de Java.
360                     </para>
361                 </listitem>
362             </varlistentry>
363             <varlistentry>
364                 <term>SCI_DISABLE_TK</term>
365                 <listitem>
366                     <para>Désactive les fonctionnalités Tk (mais pas Tcl)</para>
367                 </listitem>
368             </varlistentry>
369             <varlistentry>
370                 <term>SCI_JAVA_ENABLE_HEADLESS</term>
371                 <listitem>
372                     <para>Démarre Java en mode Headless (ie sans les fonctionnalités graphiques).
373                     </para>
374                 </listitem>
375             </varlistentry>
376         </variablelist>
377     </refsection>
378     <refsection role="description">
379         <title>Options JVM (Java Virtual Machine)</title>
380         <para>
381             Les options décrites ci-dessous sont inutiles et sans effet lorsque l'option <literal>-nwni</literal> est utilisée.
382         </para>
383         <para>A partir de la version 5.0 de Scilab, l'interface graphique et le
384             système de génération de la documentation sont basés sur des
385             fonctionnalités Java. Dans certains cas, il peut être intéressant de
386             modifier les options de la JVM (Java Virtual Machine).
387         </para>
388         <para>Ces options sont accessibles via le fichier
389             <emphasis>jvm_options.xml</emphasis>.
390         </para>
391         <para>Dans les version 5.0.X et 5.1.X, ce fichier est accessible dans
392             <emphasis>SCI/modules/jvm/etc/jvm_options.xml</emphasis>
393         </para>
394         <para>Dans les versions &gt;= 5.2.0, le fichier est accessible sous
395             <emphasis>
396                 etc/jvm_options.xml<emphasis> </emphasis>
397             </emphasis>
398         </para>
399         <para>
400             <emphasis>
401                 <emphasis>Par défault, les trois options suivantes sont
402                     facilement accessibles à partir du fichier de
403                     configuration:
404                 </emphasis>
405             </emphasis>
406         </para>
407         <variablelist>
408             <varlistentry>
409                 <term>-XmxXXXm</term>
410                 <listitem>
411                     <para>Cette option indique la quantité de mémoire mise à disposition
412                         de la machine virtuelle Java. Par défaut, la valeur est de 256M. Si
413                         vous changez cette valeur, assurez vous que cette valeur ne dépasse
414                         pas la quantité de mémoire accessible sur le système.
415                     </para>
416                 </listitem>
417             </varlistentry>
418             <varlistentry>
419                 <term>-Djava.compiler=JIT</term>
420                 <listitem>
421                     <para>Avec la valeur JIT, le compilateur Java Just In Time (JIT) est
422                         activé. Il est activé par défault. <emphasis>NONE</emphasis>
423                         désactive le JIT et diminue de manière importante les
424                         performances.
425                     </para>
426                 </listitem>
427             </varlistentry>
428             <varlistentry>
429                 <term>-verbose:jni / -Xcheck:jni</term>
430                 <listitem>
431                     <para>Ces options activent de nombreuses vérifications, message de
432                         débug et autres contrôles sur les appels JNI (appel natif Java). Ces
433                         options sont utiles pour le débuggage et désactivée par défaut à
434                         cause de l'impact sur les performances.
435                     </para>
436                 </listitem>
437             </varlistentry>
438         </variablelist>
439         <para>
440             De nombreuses options sont disponibles. Elles peuvent améliorer les performances, changer le rendu graphique, la gestion de la mémoire... Voir: <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>
441         </para>
442     </refsection>
443     <refsection role="examples">
444         <title>Exemples</title>
445         <screen><![CDATA[
446 # Lançons Scilab en mode profilage sans qu'un gdb soit lancé à chaque SIGSEGV.
447 # On est sous Bash
448 export SCILAB_VALGRIND_OPT="--db-attach=no --log-file=myfile.txt"
449 scilab -profiling
450
451 # Lançons Scilab en mode debug sans s'arrêter à chaque SIGSEGV
452 # D'abord écrivons un petit fichier de commandes
453 echo "handle SIGSEGV nostop" &amp;gt; debug.txt
454 # On règle l'option de gdb
455 # On est sous Bash
456 export SCILAB_GDB_OPT="--command=debug.txt"
457 # Lançons Scilab en mode debug
458 scilab -debug ]]></screen>
459         <para></para>
460         <screen><![CDATA[
461 # Sous GNU/Linux, Mac OS X or Unix:
462 $ echo "disp(%pi)"|scilab-cli
463 ou
464 $ echo "disp(%pi)"|scilab -nwni
465
466 # Ouvre uniquement la fenêtre d'aide Scilab:
467 $ scilab-adv-cli -e "help()"
468 or
469 $ scilab -nw -e "help()"
470
471 # Scilab utilisé en tant que moteur de scripting
472 echo "if 1&lt;&gt;2 then exit(99) end"|scilab-cli
473 echo $? ]]></screen>
474     </refsection>
475     <refsection role="see also">
476         <title>Voir aussi</title>
477         <simplelist type="inline">
478             <member>
479                 <link linkend="startup">startup</link>
480             </member>
481             <member>
482                 <link linkend="sciargs">sciargs</link>
483             </member>
484             <member>
485                 <link linkend="getpid">getpid</link>
486             </member>
487             <member>
488                 <link linkend="getenv">getenv</link>
489             </member>
490             <member>
491                 <link linkend="getenv">getversion</link>
492             </member>
493             <member>
494                 <link linkend="consolebox">consolebox</link>
495             </member>
496             <member>
497                 <link linkend="exit">exit</link>
498             </member>
499         </simplelist>
500     </refsection>
501     <refsection role="history">
502         <title>Historique</title>
503         <revhistory>
504             <revision>
505                 <revnumber>5.4.0</revnumber>
506                 <revremark>-noatomsautoload ajouté.</revremark>
507             </revision>
508             <revision>
509                 <revnumber>5.4.1</revnumber>
510                 <revremark>scinotes et xcos peuvent maintenant être démarrés en ligne de commande. Voir le SEP #87.</revremark>
511             </revision>
512             <revision>
513                 <revnumber>6.0.0</revnumber>
514                 <revremark>
515                     Option <literal>-quit</literal> ajoutée. Option <literal>-mem</literal> supprimée.
516                 </revremark>
517             </revision>
518         </revhistory>
519     </refsection>
520 </refentry>