e0d3c2719003aa9b317a829d7bf5dfae8d83fac9
[scilab.git] / scilab / modules / xcos / help / en_US / scilab_utilities_functions / scicos_debug.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scicos
4  * 
5  * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
6  * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
7  * 
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  * 
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  * 
22  * See the file ./license.txt
23  -->
24 <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="scicos_debug">
25     <refnamediv>
26         <refname>scicos_debug</refname>
27         <refpurpose>Set the level of the Scicos debugging</refpurpose>
28     </refnamediv>
29     <refsynopsisdiv>
30         <title>Calling Sequence</title>
31         <synopsis>scicos_debug(level)
32             level = scicos_debug()
33         </synopsis>
34     </refsynopsisdiv>
35     <refsection id="Module_scicos_debug">
36         <title>Module</title>
37         <itemizedlist>
38             <listitem>
39                 <para>
40                     <link linkend="xcos">xcos</link>
41                 </para>
42             </listitem>
43         </itemizedlist>
44     </refsection>
45     <refsection id="Description_scicos_debug">
46         <title>Description</title>
47         <para>
48             This Scilab function is used to set the debug level of a Scicos simulation.  
49         </para>
50         <para>
51             One can used it in the "Calc" mode of the Scicos editor or as an instruction in a Scilab block or in an interfacing function.  
52         </para>
53     </refsection>
54     <refsection>
55         <title>Examples</title>
56         <programlisting role="example"><![CDATA[ 
57 scicos_debug(level)
58 level=scicos_debug()
59  ]]></programlisting>
60     </refsection>
61     <refsection id="Parameters_scicos_debug">
62         <title>Arguments</title>
63         <itemizedlist>
64             <listitem>
65                 <para>
66                     <emphasis role="bold">level :</emphasis> set/get the current level of the Scicos simulation debugging.
67                 </para>
68                 <itemizedlist>
69                     <listitem>
70                         <para>
71                             <emphasis role="bold">0:</emphasis>
72                             no debugging.
73                         </para>
74                     </listitem>
75                     <listitem>
76                         <para>
77                             <emphasis role="bold">1:</emphasis>
78                             light debugging information printout.
79                         </para>
80                     </listitem>
81                     <listitem>
82                         <para>
83                             <emphasis role="bold">2:</emphasis>
84                             more information printout and execution of Debug Block if any in diagram.
85                         </para>
86                     </listitem>
87                     <listitem>
88                         <para>
89                             <emphasis role="bold">3:</emphasis>
90                             silent debugging mode (no information printout) and execution of Debug Block if any in diagram.
91                         </para>
92                     </listitem>
93                 </itemizedlist>
94             </listitem>
95         </itemizedlist>
96     </refsection>
97 </refentry>