← 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/removedir.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/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>Remove a directory</refpurpose>
18
 
  </refnamediv>
19
 
  <refsynopsisdiv>
20
 
    <title>Calling Sequence</title>
21
 
    <synopsis>removedir('dirname')
22
 
      [status] = removedir('dirname','s')
23
 
    </synopsis>
24
 
  </refsynopsisdiv>
25
 
  <refsection>
26
 
    <title>Description</title>
27
 
    <para>removedir('dirname') removes the directory dirname from the current
28
 
      directory. If the directory is not empty, files and subdirectories are removed. If
29
 
      dirname is not in the current directory, specify the relative path to the
30
 
      current directory or the full path for dirname.
31
 
    </para>
32
 
    <para>[status] = removedir('dirname') removes the directory dirname
33
 
      and its contents from the current directory, returning the status.
34
 
      Here, status is %T for success and is %F for error.
35
 
    </para>
36
 
    <para>removedir is used by rmdir.</para>
37
 
  </refsection>
38
 
  <refsection>
39
 
    <title>Examples</title>
40
 
    <programlisting role="example"><![CDATA[ 
41
 
createdir(SCIHOME+'/Directory_test')
42
 
removedir(SCIHOME+'/Directory_test')
43
 
 ]]></programlisting>
44
 
  </refsection>
45
 
  <refsection role="see also">
46
 
    <title>See Also</title>
47
 
    <simplelist type="inline">
48
 
      <member>
49
 
        <link linkend="mkdir">mkdir</link>
50
 
      </member>
51
 
      <member>
52
 
        <link linkend="rmdir">rmdir</link>
53
 
      </member>
54
 
    </simplelist>
55
 
  </refsection>
56
 
</refentry>