* Bug 13855 fixed [doc]: pause() page updated & improved
[scilab.git] / scilab / modules / core / help / pt_BR / 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:ns4="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
19           xmlns:scilab="http://www.scilab.org" xml:id="pause" xml:lang="pt">
20     <refnamediv>
21         <refname>pause</refname>
22         <refpurpose>
23             pausa temporariamente a execução atual e permite instruções no console.
24         </refpurpose>
25     </refnamediv>
26     <refsynopsisdiv>
27         <title>Seqüência de Chamamento</title>
28         <synopsis>
29             pause
30         </synopsis>
31     </refsynopsisdiv>
32     <refsection>
33         <title>Descrição</title>
34         <para>
35             Alterna para o modo <function>pause</function> ; inserido no código de
36             uma função, <function>pause</function> interrompe a execução da mesma:
37             recebe-se um símbolo de prompt para indicar o nível de
38             <function>pause</function> (exemplo: <literal>-1-&gt;</literal>). O usuário
39             está agora num novo espaço de trabalho em que todas as variáveis de nível
40             infeiror (em particular todas as variáveis da função) estão disponíveis
41             e podem ser alteradas propositalmente.
42         </para>
43         <para>
44             Para retomar e continuar a execução, entre <literal>resume</literal>.
45         </para>
46         <para>
47             Este modo pode ser cancelado pelo comando <literal>abort</literal>.
48         </para>
49         <note>
50             <function>pause</function> é extremamente útil para propósitos de depuramento.
51         </note>
52     </refsection>
53     <refsection>
54         <title>Exemplos</title>
55         <programlisting role="example"><![CDATA[
56 function c = foo(b)
57     a = 42 + b
58     disp("Thanks to the pause, you can investigate if ''a'' has the right value");
59     disp("Values of local variables can be changed too if required.");
60     pause
61     c = a + 2
62 endfunction
63
64 a = 3;
65 foo(2)
66      ]]></programlisting>
67         <screen><![CDATA[
68 --> a = 3;
69 --> foo(2)
70   "Thanks to the pause, you can investigate if 'a' has the right value"
71   "Values of local variables can be changed too if required."
72
73 Type 'resume' or 'abort' to return to standard level prompt.
74
75 -1-> a
76  a  =
77    44.
78
79 -1-> a = 0;
80
81 -1-> resume
82  ans  =
83    2.
84 ]]></screen>
85     </refsection>
86     <refsection>
87         <title> Ver Também </title>
88         <simplelist type="inline">
89             <member>
90                 <link linkend="debug">debug</link>
91             </member>
92             <member>
93                 <link linkend="halt">halt</link>
94             </member>
95             <member>
96                 <link linkend="return">return</link>
97             </member>
98             <member>
99                 <link linkend="abort">abort</link>
100             </member>
101             <member>
102                 <link linkend="whereami">whereami</link>
103             </member>
104             <member>
105                 <link linkend="sleep">sleep</link>
106             </member>
107             <member>
108                 <link linkend="quit">quit</link>
109             </member>
110         </simplelist>
111     </refsection>
112     <refsection role="history">
113         <title>Histórico</title>
114         <revhistory>
115             <revision>
116                 <revnumber>6.0.0</revnumber>
117                 <revdescription>
118                     The new values of local variables changed during a pause are now taken
119                     into account when resuming the execution with <literal>resume</literal>.
120                 </revdescription>
121             </revision>
122         </revhistory>
123     </refsection>
124 </refentry>