* Bug 14425 fixed - xpause() set obsolete, merged in sleep(). sleep(,'s') implemented
[scilab.git] / scilab / modules / m2sci / help / en_US / m2sci_equivalents / o / pause.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2009 - DIGITEO - Vincent COUVERT
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
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" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="m2sci_pause">
17     <refnamediv>
18         <refname>pause (Matlab function)</refname>
19         <refpurpose>Halt execution temporarily</refpurpose>
20     </refnamediv>
21     <refsection>
22         <title>Matlab/Scilab equivalent</title>
23         <informaltable border="1" width="100%">
24             <tr>
25                 <td align="center">
26                     <emphasis role="bold">Matlab</emphasis>
27                 </td>
28                 <td align="center">
29                     <emphasis role="bold">Scilab</emphasis>
30                 </td>
31             </tr>
32             <tr>
33                 <td>
34                     <programlisting role="example"><![CDATA[
35 pause
36 ]]></programlisting>
37                 </td>
38                 <td>
39                     <programlisting role="example"><![CDATA[
40 sleep - halt
41 ]]></programlisting>
42                 </td>
43             </tr>
44         </informaltable>
45     </refsection>
46     <refsection>
47         <title>Particular cases</title>
48         <para>
49             Scilab equivalent for Matlab <emphasis role="bold">pause(n)</emphasis> is <emphasis role="bold">sleep(n)</emphasis>.
50         </para>
51         <variablelist>
52             <varlistentry>
53                 <term>The Matlab expression pause is translated into Scilab by halt():</term>
54                 <listitem>
55                     <para>
56                         Scilab halt() and Matlab pause are equivalents.
57                     </para>
58                 </listitem>
59             </varlistentry>
60             <varlistentry>
61                 <term>pause on/off:</term>
62                 <listitem>
63                     <para>
64                         There is no Scilab equivalent for Matlab <emphasis role="bold">pause</emphasis> on or <emphasis role="bold">pause off</emphasis>
65                     </para>
66                 </listitem>
67             </varlistentry>
68         </variablelist>
69     </refsection>
70 </refentry>
71