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