* Bug 14425 fixed - xpause() set obsolete, merged in sleep(). sleep(,'s') implemented
[scilab.git] / scilab / modules / time / help / fr_FR / sleep.xml
index d476045..db8a761 100644 (file)
@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
- * Copyright (C) INRIA - 
- * 
+ * Copyright (C) INRIA -
+ * Copyright (C) 2016 - Samuel GOUGEON
  * Copyright (C) 2012 - 2016 - Scilab Enterprises
  *
  * This file is hereby licensed under the terms of the GNU GPL v2.0,
 <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:lang="fr" xml:id="sleep">
     <refnamediv>
         <refname>sleep</refname>
-        <refpurpose>suspend Scilab</refpurpose>
+        <refpurpose>mise en sommeil de l'interprêteur (console, scripts, callbacks)</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
-        <title>Séquence d'appel</title>
-        <synopsis>sleep(milliseconds)</synopsis>
+        <title>Syntaxe</title>
+        <synopsis>
+            sleep(milliseconds)
+            sleep(seconds, "s")
+        </synopsis>
     </refsynopsisdiv>
+    <refsection role="arguments">
+        <title>Paramètres</title>
+        <variablelist>
+            <varlistentry>
+                <term>milliseconds</term>
+                <listitem>Durée du sommeil, en millisecondes (nombre décimal)
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>seconds</term>
+                <listitem>Durée du sommeil, en secondes (nombre décimal)
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>sleep</literal>Sleep suspend Scilab durant la durée specifiée en
-            millisecondes.
+            <literal>sleep</literal> arrête l'exécution des instructions Scilab
+            et attend la durée spécifiée, sans rien faire (ou presque):
+            <variablelist>
+                <varlistentry>
+                    <term>Console :</term>
+                    <listitem> les entrées et affichages sont suspendus.
+                        <warning>L'interruption avec CTRL-C est prise en compte mais
+                            est exécutée uniquement au terme de la période de sommeil
+                            programmée.
+                        </warning>
+                    </listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term>Scripts et functions :</term>
+                    <listitem>
+                         lorsque <function>sleep(..)</function>
+                        est appelée depuis un script ou une function, Scilab attend
+                        la durée indiquée avant d'exécuter la ligne d'instruction suivante
+                        dans le script ou la function. Pendant ce temps, la console
+                        est bloquée. L'interruption CTRL-C est prise en compte mais
+                        exécutée uniquement au terme du sommeil programmé.
+                    </listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term>callbacks :</term>
+                    <listitem> .. ce sont les actions programmées à exécuter
+                        lorsqu'on interagit avec les menus et les composants graphiques
+                        interactifs <literal>uicontrol</literal>. Durant le sommeil
+                        provoqué par sleep(..), les interactions avec les menus et les
+                        <literal>uicontrol</literal> sont possibles : les
+                        instructions/actions associées sont prises en compte et mémorises,
+                        mais leur exécution est différée au terme du sommeil.
+                    </listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term>Interactions graphiques :</term>
+                    <listitem>
+                        <function>sleep(..)</function>
+                        n'empêche pas les interactions avec les graphiques (courbes,
+                        titres,...), pour peu que le mode graphique interactif soit activé
+                        avant la mise en sommeil.
+                        Il est alors possible de déplacer les courbes, de modifier les
+                        titres des axes, ou d'éditer les points d'une courbe (si cela a
+                        été activé). Le réveil ne remet pas en cause le résultat de ces
+                        actions.
+                    </listitem>
+                </varlistentry>
+            </variablelist>
+            <note>Résolution temporelle :
+                <simplelist>
+                    <member>Sous Windows : 0.5 ms</member>
+                    <member>Sous Linux : 1 µs</member>
+                </simplelist>
+            </note>
+            <warning>Résolution... n'est pas justesse : la durée réelle du sommeil
+                peut s'avérer différente de la durée spécifiée, en particulier en
+                fonction de la charge du processeur ou du temps mis par Scilab pour
+                déclencher <function>sleep()</function>. Voir le test en exemple.
+            </warning>
         </para>
     </refsection>
     <refsection>
         <title>Exemples</title>
-        <programlisting role="example"><![CDATA[ 
-tic;sleep(6000);toc
+        <programlisting role="example"><![CDATA[
+// Exemples simples
+tic; sleep(4350); toc
+tic; sleep(4.35, "s"); toc
+
+// Comparaison entre les durées de sommeil programmée et réelle
+results = [];
+disp("SVP patienter... sleep()s et des réveils sont en cours...")
+for i = -1:4
+    dt = 10^i;        // durée spécifiée [ms]
+    tic;
+    sleep(dt);
+    dta = toc()*1000; // durée réelle mesurée [ms]
+    results = [results ; dt dta ];
+end
+results
+
+// Test d'interruption avec CTRL-C :
+mprintf("Presser les touches CTRL + C maintenant\n  => pas d''effet : sommeil de 15 s en cours...")
+sleep(15, "s")
+
+// Interactions avec les menus : test
+clf
+plot2d()
+// [Si vous êtes utilisateur MacOS, choisir le menu "Editer => Effacer la figure"]
+mprintf("Pendant ce sommeil de 30s, cliquer sur la fenêtre graphique,\n   puis menu Editer => Propriétés de la Figure")
+// L'éditeur de propriétés graphiques sera appelé uniquement au réveil de Scilab
  ]]></programlisting>
     </refsection>
     <refsection role="see also">
         <title>Voir aussi</title>
         <simplelist type="inline">
             <member>
-                <link linkend="xpause">xpause</link>
+                <link linkend="pause">pause</link>
             </member>
             <member>
-                <link linkend="pause">pause</link>
+                <link linkend="halt">halt</link>
             </member>
         </simplelist>
     </refsection>
+    <refsection role="history">
+        <title>Historique</title>
+        <revhistory>
+            <revision>
+                <revnumber>6.0</revnumber>
+                <revdescription>
+                    <itemizedlist>
+                        <listitem>Les fractions de millisecondes sont maintenant
+                            acceptées et prises en compte (remplace xpause(microsecondes)).
+                        </listitem>
+                        <listitem>Syntaxe sleep(secondes,"s") ajoutée.
+                        </listitem>
+                    </itemizedlist>
+                </revdescription>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>
+