← 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/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/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>Remove a directory</refpurpose>
18
 
  </refnamediv>
19
 
  <refsynopsisdiv>
20
 
    <title>Calling Sequence</title>
21
 
    <synopsis>rmdir('dirname')
22
 
      rmdir('dirname','s')
23
 
      [status,message] = rmdir('dirname','s')
24
 
    </synopsis>
25
 
  </refsynopsisdiv>
26
 
  <refsection>
27
 
    <title>Description</title>
28
 
    <para>rmdir('dirname') removes the directory dirname from the current
29
 
      directory. If the directory is not empty, you must use the s argument. If
30
 
      dirname is not in the current directory, specify the relative path to the
31
 
      current directory or the full path for dirname.
32
 
    </para>
33
 
    <para>rmdir('dirname','s') removes the directory dirname and its contents
34
 
      from the current directory. 
35
 
    </para>
36
 
    <para>[status, message] = rmdir('dirname','s') removes the directory dirname
37
 
      and its contents from the current directory, returning the status, and a
38
 
      message. Here, status is 1 for success and is 0 for error.
39
 
    </para>
40
 
  </refsection>
41
 
  <refsection>
42
 
    <title>Examples</title>
43
 
    <programlisting role="example"><![CDATA[ 
44
 
mkdir(SCI,'Directory')
45
 
rmdir(SCI+'/Directory')
46
 
 ]]></programlisting>
47
 
  </refsection>
48
 
  <refsection role="see also">
49
 
    <title>See Also</title>
50
 
    <simplelist type="inline">
51
 
      <member>
52
 
        <link linkend="cd">cd</link>
53
 
      </member>
54
 
      <member>
55
 
        <link linkend="dir">dir</link>
56
 
      </member>
57
 
      <member>
58
 
        <link linkend="mkdir">mkdir</link>
59
 
      </member>
60
 
    </simplelist>
61
 
  </refsection>
62
 
</refentry>