Merge remote-tracking branch 'origin/6.1'
[scilab.git] / scilab / modules / core / help / fr_FR / 2_control_flow / pause.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2006-2008 - INRIA
5  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  * Copyright (C) 2020 - Samuel GOUGEON
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
18           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
19           xml:lang="fr" xml:id="pause">
20     <refnamediv>
21         <refname>pause</refname>
22         <refpurpose>
23             suspend temporairement l'exécution en cours, et autorise les commandes en console
24         </refpurpose>
25     </refnamediv>
26     <refsynopsisdiv>
27         <title>Syntaxe</title>
28         <synopsis>
29             pause
30         </synopsis>
31     </refsynopsisdiv>
32     <refsection>
33         <title>Description</title>
34         <para>
35             Passage en mode de <function>pause</function>.
36             Inséré dans le code d'une fonction, <function>pause</function> interrompt momentanément
37             l'exécution de la fonction et donne la main à l'utilisateur dans la console Scilab.
38             Une invite de commande spécifique <literal>-#-></literal> est affichée, où # est
39             la profondeur d'exécution à laquelle la pause se trouve (e.g. <literal>-1-&gt;</literal>).
40             L'utilisateur se trouve dans un environnement dans lequel toutes les variables du niveau
41             correspondant sont accessibles (en particulier les variables locales de la fonction)
42             et peuvent si besoin être modifiées.
43         </para>
44         <para>
45             Pour reprendre et poursuivre l'exécution, taper <literal>resume</literal>.
46         </para>
47         <para>
48             Pour sortir du mode pause et mettre fin à l'exécution, taper <literal>abort</literal>.
49         </para>
50         <note>
51             L'instruction <function>pause</function> est très utile en phase de mise au point ou
52             de débogage.
53         </note>
54     </refsection>
55     <refsection>
56         <title>Exemples</title>
57         <programlisting role="example"><![CDATA[
58 function c = foo(b)
59     a = 42 + b
60     disp("En mode pause, la valeur courante de ''a'' peut être vérifiée.");
61     disp("La valeur des variables internes locales peuvent si besoin être modifiées.");
62     pause
63     c = a + 2
64 endfunction
65
66 a = 3;
67 foo(2)
68      ]]></programlisting>
69         <screen><![CDATA[
70 --> a = 3;
71 --> foo(2)
72   "En mode pause, la valeur courante de 'a' peut être vérifiée."
73   "La valeur des variables internes locales peuvent si besoin être modifiées."
74
75 Type 'resume' or 'abort' to return to standard level prompt.
76
77 -1-> a
78  a  =
79    44.
80
81 -1-> a = 0;
82
83 -1-> resume
84  ans  =
85    2.
86 ]]></screen>
87     </refsection>
88     <refsection role="see also">
89         <title>Voir aussi</title>
90         <simplelist type="inline">
91             <member>
92                 <link linkend="debug">debug</link>
93             </member>
94             <member>
95                 <link linkend="halt">halt</link>
96             </member>
97             <member>
98                 <link linkend="return">return</link>
99             </member>
100             <member>
101                 <link linkend="abort">abort</link>
102             </member>
103             <member>
104                 <link linkend="whereami">whereami</link>
105             </member>
106             <member>
107                 <link linkend="sleep">sleep</link>
108             </member>
109             <member>
110                 <link linkend="quit">quit</link>
111             </member>
112         </simplelist>
113     </refsection>
114     <refsection role="history">
115         <title>Historique</title>
116         <revhistory>
117             <revision>
118                 <revnumber>6.0.0</revnumber>
119                 <revdescription>
120                     Les nouvelles valeurs des variables locales modifiées durant une pause sont
121                     désormais prises en compte lorsque l'exécution du code restant est relancée
122                     avec <literal>resume</literal>.
123                 </revdescription>
124             </revision>
125         </revhistory>
126     </refsection>
127 </refentry>