Fix typos in help pages of module fileio (en_US, ru_RU)
[scilab.git] / scilab / modules / fileio / help / en_US / listvarinfile.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <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="listvarinfile">
3     <refnamediv>
4         <refname>listvarinfile</refname>
5         <refpurpose>list of variables in a saved data file</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Calling Sequence</title>
9         <synopsis>listvarinfile(filename)
10             [names, typs, dims, vols] = listvarinfile(filename)
11         </synopsis>
12     </refsynopsisdiv>
13     <refsection>
14         <title>Arguments</title>
15         <variablelist>
16             <varlistentry>
17                 <term>filename</term>
18                 <listitem>
19                     <para>
20                         a character string, the pathname of the file to be inspected.
21                     </para>
22                 </listitem>
23             </varlistentry>
24             <varlistentry>
25                 <term>nams</term>
26                 <listitem>
27                     <para>
28                         a matrix of strings, names of the variables saved in the file.
29                     </para>
30                 </listitem>
31             </varlistentry>
32             <varlistentry>
33                 <term>dims</term>
34                 <listitem>
35                     <para>
36                         a list, dimensions of the variables saved in the file.
37                     </para>
38                 </listitem>
39             </varlistentry>
40             <varlistentry>
41                 <term>typs</term>
42                 <listitem>
43                     <para>
44                         a numeric matrix, types of the variables saved in the file.
45                     </para>
46                 </listitem>
47             </varlistentry>
48             <varlistentry>
49                 <term>vols</term>
50                 <listitem>
51                     <para>
52                         a numeric matrix, size in bytes of the variables saved in the file.
53                     </para>
54                 </listitem>
55             </varlistentry>
56         </variablelist>
57     </refsection>
58     <refsection>
59         <title>Description</title>
60         <para>
61             This utility function lists "a la <link linkend="whos">whos</link>" the variables contained in
62             a Scilab data file produced by <link linkend="save">save</link>.
63         </para>
64         <para>
65             <note>
66                 Hypermatrices are reported as plain mlists;
67                 rationals and state-spaces are reported as plain tlists;
68                 graphic handles are not recognized.
69             </note>
70         </para>
71     </refsection>
72     <refsection>
73         <title>Examples</title>
74         <programlisting role="example"><![CDATA[ 
75 a=eye(2,2); b=int16(ones(a)); c=rand(2,3,3);
76 save(fullfile(TMPDIR,"vals.sod"),'a','b','c')
77 [names,typs,dims,vols] = listvarinfile(fullfile(TMPDIR,"vals.sod"))
78  ]]></programlisting>
79     </refsection>
80     <refsection role="see also">
81         <title>See Also</title>
82         <simplelist type="inline">
83             <member>
84                 <link linkend="whos">whos</link>
85             </member>
86             <member>
87                 <link linkend="save">save</link>
88             </member>
89             <member>
90                 <link linkend="load">load</link>
91             </member>
92             <member>
93                 <link linkend="save_format">save_format</link>
94             </member>
95             <member>
96                 <link linkend="type">type</link>
97             </member>
98         </simplelist>
99     </refsection>
100 </refentry>