← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/fileio/help/en_US/directory/rmdir.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/fileio/help/en_US/directory/rmdir.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="rmdir">
 
15
    <refnamediv>
 
16
        <refname>rmdir</refname>
 
17
        <refpurpose>removes a directory</refpurpose>
 
18
    </refnamediv>
 
19
    <refsynopsisdiv>
 
20
        <title>Calling Sequence</title>
 
21
        <synopsis>
 
22
            rmdir(dirname)
 
23
            rmdir(dirname,'s')
 
24
            [status, message] = rmdir(dirname,'s')
 
25
        </synopsis>
 
26
    </refsynopsisdiv>
 
27
    <refsection>
 
28
        <title>Arguments</title>
 
29
        <variablelist>
 
30
            <varlistentry>
 
31
                <term>dirname</term>
 
32
                <listitem>
 
33
                    <para>a character string.</para>
 
34
                </listitem>
 
35
            </varlistentry>
 
36
            <varlistentry>
 
37
                <term>'s'</term>
 
38
                <listitem>
 
39
                    <para>
 
40
                        a mark to remove directory <varname>dirname</varname> with 
 
41
                        subdirectories.
 
42
                    </para>
 
43
                </listitem>
 
44
            </varlistentry>
 
45
            <varlistentry>
 
46
                <term>status</term>
 
47
                <listitem>
 
48
                    <para>a boolean.</para>
 
49
                </listitem>
 
50
            </varlistentry>
 
51
            <varlistentry>
 
52
                <term>message</term>
 
53
                <listitem>
 
54
                    <para>
 
55
                        a character string: a message about an error.
 
56
                    </para>
 
57
                </listitem>
 
58
            </varlistentry>
 
59
        </variablelist>
 
60
    </refsection>
 
61
    <refsection>
 
62
        <title>Description</title>
 
63
        <para>
 
64
            <code>rmdir(dirname)</code> removes the directory 
 
65
            <varname>dirname</varname> from the current directory. If the 
 
66
            directory is not empty, you must use the s argument. If 
 
67
            <varname>dirname</varname> is not in the current directory, specify 
 
68
            the relative path to the current directory or the full path for 
 
69
            <varname>dirname</varname>.
 
70
        </para>
 
71
        <para>
 
72
            <code>rmdir(dirname,'s')</code> removes the directory <varname>dirname</varname> and its contents from the current directory. 
 
73
        </para>
 
74
        <para>
 
75
            <code>[status, message] = rmdir(dirname,'s')</code> removes the 
 
76
            directory <varname>dirname</varname> and its contents from the 
 
77
            current directory, returning the status, and a message. Here, 
 
78
            <varname>status</varname> is 1 for success and is 0 for error.
 
79
        </para>
 
80
        <para>
 
81
            Whatever the operating system, if the removing of directory
 
82
            succeeds, the <varname>status</varname> is 1 and the message
 
83
            <varname>message</varname> is empty.
 
84
        </para>
 
85
    </refsection>
 
86
    <refsection>
 
87
        <title>Examples</title>
 
88
        <programlisting role="example"><![CDATA[ 
 
89
mkdir(SCI,'Directory')
 
90
rmdir(SCI+'/Directory')
 
91
 ]]></programlisting>
 
92
    </refsection>
 
93
    <refsection role="see also">
 
94
        <title>See Also</title>
 
95
        <simplelist type="inline">
 
96
            <member>
 
97
                <link linkend="createdir">createdir</link>
 
98
            </member>
 
99
            <member>
 
100
                <link linkend="mkdir">mkdir</link>
 
101
            </member>
 
102
            <member>
 
103
                <link linkend="removedir">removedir</link>
 
104
            </member>
 
105
        </simplelist>
 
106
    </refsection>
 
107
</refentry>