Fix typos in help pages of module fileio (en_US, ru_RU)
[scilab.git] / scilab / modules / fileio / help / en_US / removedir.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) 2008 - INRIA - Allan CORNET
5  * ...
6  * 
7  * This file must be used under the terms of the CeCILL.
8  * This source file is licensed as described in the file COPYING, which
9  * you should have received as part of this distribution.  The terms
10  * are also available at    
11  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
12  *
13  -->
14 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="removedir">
15     <refnamediv>
16         <refname>removedir</refname>
17         <refpurpose>removes a directory</refpurpose>
18     </refnamediv>
19     <refsynopsisdiv>
20         <title>Calling Sequence</title>
21         <synopsis>
22             removedir(dirname)
23             [status] = removedir(dirname)
24         </synopsis>
25     </refsynopsisdiv>
26     <refsection>
27         <title>Arguments</title>
28         <variablelist>
29             <varlistentry>
30                 <term>dirname</term>
31                 <listitem>
32                     <para>a character string.</para>
33                 </listitem>
34             </varlistentry>
35             <varlistentry>
36                 <term>status</term>
37                 <listitem>
38                     <para>a boolean.</para>
39                 </listitem>
40             </varlistentry>
41         </variablelist>
42     </refsection>
43     <refsection>
44         <title>Description</title>
45         <para>
46             <code>removedir(dirname)</code> removes the directory <varname>dirname</varname> from the current directory. If the directory is not empty, files and subdirectories are removed. If <varname>dirname</varname> is not in the current directory, specify the relative path to the current directory or the full path for <varname>dirname</varname>.
47         </para>
48         <para>
49             <code>[status] = removedir(dirname)</code> removes the directory <varname>dirname</varname> and its contents from the current directory, returning the status. Here, <varname>status</varname> is <constant>%T</constant> for success and is <constant>%F</constant> for error.
50         </para>
51         <para>
52             <function>removedir</function> is used by <function>rmdir</function>.
53         </para>
54     </refsection>
55     <refsection>
56         <title>Examples</title>
57         <programlisting role="example"><![CDATA[ 
58 createdir(SCIHOME+'/Directory_test')
59 removedir(SCIHOME+'/Directory_test')
60  ]]></programlisting>
61     </refsection>
62     <refsection role="see also">
63         <title>See Also</title>
64         <simplelist type="inline">
65             <member>
66                 <link linkend="createdir">createdir</link>
67             </member>
68             <member>
69                 <link linkend="mkdir">mkdir</link>
70             </member>
71             <member>
72                 <link linkend="rmdir">rmdir</link>
73             </member>
74         </simplelist>
75     </refsection>
76 </refentry>