scilab/modules/fileio/help/en_US/mdelete.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
   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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="mdelete">
  15     <refnamediv>
  16         <refname>mdelete</refname>
  17         <refpurpose>deletes file(s)</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv>
  20         <title>Calling Sequence</title>
  21         <synopsis>mdelete(filename)</synopsis>
  22     </refsynopsisdiv>
  23     <refsection>
  24         <title>Arguments</title>
  25         <variablelist>
  26             <varlistentry>
  27                 <term>filename</term>
  28                 <listitem>
  29                     <para>
  30                         a character string: the pathname of the file(s) to delete.
  31                     </para>
  32                 </listitem>
  33             </varlistentry>
  34         </variablelist>
  35     </refsection>
  36     <refsection>
  37         <title>Description</title>
  38         <para>
  39             <function>mdelete</function> may be used to delete a file or a set of files if
  40             <varname>filename</varname> contains meta-characters.
  41         </para>
  42         <para>
  43             <caution>
  44                 Note that <function>mdelete</function> does not ask for confirmation
  45                 when you enter the delete command.
  46                 To avoid accidentally losing files, make sure that you have
  47                 accurately specified the items you want deleted.
  48             </caution>
  49         </para>
  50     </refsection>
  51     <refsection>
  52         <title>Examples</title>
  53         <programlisting role="example"><![CDATA[
  54 r = mputl('I am a dummy String', TMPDIR+'/dummyFile.dummy');
  55 mdelete(TMPDIR+"/dummyFile.dummy");
  56  ]]></programlisting>
  57     </refsection>
  58
  59     <refsection role="see also">
  60         <title>See Also</title>
  61         <simplelist type="inline">
  62             <member>
  63                 <link linkend="mopen">mopen</link>
  64             </member>
  65             <member>
  66                 <link linkend="mclose">mclose</link>
  67             </member>
  68             <member>
  69                 <link linkend="meof">meof</link>
  70             </member>
  71             <member>
  72                 <link linkend="mfprintf">mfprintf</link>
  73             </member>
  74             <member>
  75                 <link linkend="fprintfMat">fprintfMat</link>
  76             </member>
  77             <member>
  78                 <link linkend="mfscanf">mfscanf</link>
  79             </member>
  80             <member>
  81                 <link linkend="fscanfMat">fscanfMat</link>
  82             </member>
  83             <member>
  84                 <link linkend="mget">mget</link>
  85             </member>
  86             <member>
  87                 <link linkend="mgetstr">mgetstr</link>
  88             </member>
  89             <member>
  90                 <link linkend="mprintf">mprintf</link>
  91             </member>
  92             <member>
  93                 <link linkend="mput">mput</link>
  94             </member>
  95             <member>
  96                 <link linkend="mputstr">mputstr</link>
  97             </member>
  98             <member>
  99                 <link linkend="mscanf">mscanf</link>
 100             </member>
 101             <member>
 102                 <link linkend="mseek">mseek</link>
 103             </member>
 104             <member>
 105                 <link linkend="mtell">mtell</link>
 106             </member>
 107         </simplelist>
 108     </refsection>
 109 </refentry>