Example for the beep function
[scilab.git] / scilab / modules / sound / help / en_US / beep.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 - INRIA - Allan CORNET 
5     * 
6     * This file must be used under the terms of the CeCILL.
7     * This source file is licensed as described in the file COPYING, which
8     * you should have received as part of this distribution.  The terms
9     * are also available at    
10     * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11     *
12     -->
13 <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="en" xml:id="beep">
14     <refnamediv>
15         <refname>beep</refname>
16         <refpurpose>Produce a beep sound</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>beep();
21             beep('on')
22             beep('off')
23             s=beep()
24         </synopsis>
25     </refsynopsisdiv>
26     <refsection>
27         <title>Description</title>
28         <para>
29             <literal>beep()</literal> produces your computer's default beep sound.
30         </para>
31         <para>
32             <literal>beep('on')</literal> turns the beep on
33         </para>
34         <para>
35             <literal>beep('off')</literal> turns the beep off
36         </para>
37         <para>
38             <literal>s=beep()</literal> returns the current beep mode (on or off).
39         </para>
40     </refsection>
41     <refsection>
42         <title>Examples</title>
43         <programlisting role="example"><![CDATA[
44 beep() // Make a sound
45 beep("off") // disable the sound
46 ]]></programlisting>
47     </refsection>
48 </refentry>