archiveList complete with gateways, primitives, test and help
[scilab.git] / scilab / modules / fileio / help / en_US / archiveList.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) 2015 - Kartik Gupta
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="archiveList" xml:lang="en">
14     <refnamediv>
15         <refname>archiveList</refname>
16         <refpurpose>Lists the contents of an archive</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>x = archiveList(archive)</synopsis>
21     </refsynopsisdiv>
22     <refsection>
23         <title>Arguments</title>
24         <variablelist>
25             <varlistentry>
26                 <term>archive</term>
27                 <listitem>
28                     <para>a character string containing the absolute or relative path to the archive.
29                     </para>
30                 </listitem>
31             </varlistentry>
32             <varlistentry>
33                 <term>ierr</term>
34                 <listitem>
35                     <para>error indicator, 0, if no error has occurred.</para>
36                 </listitem>
37             </varlistentry>
38         </variablelist>
39     </refsection>
40     <refsection>
41         <title>Description</title>
42         <para>
43             <code>x = archiveList(archive)</code> returns:
44         </para>
45         <variablelist>
46             <varlistentry>
47                 <term>x</term>
48                 <listitem>
49                     <para>The list containing the filenames in the archive</para>
50                 </listitem>
51             </varlistentry>
52         </variablelist>
53     </refsection>
54      
55     <refsection>
56         <title>Examples</title>
57         <programlisting role="example"><![CDATA[ 
58 x = archiveList("example.tar");
59 y = archiveList("example.tar.gz");
60 z = archiveList("example.tar.zip");
61  ]]></programlisting>
62     </refsection>
63     <refsection>
64         <title>History</title>
65         <revhistory>
66             <revision>
67                 <revnumber>5.6.0</revnumber>
68                 <revremark>
69                     Function <literal>archiveList(archive)</literal> introduced
70                 </revremark>
71             </revision>
72         </revhistory>
73     </refsection>
74      
75 </refentry>