Fix some misc errors in the help
[scilab.git] / scilab / modules / matio / help / en_US / savematfile.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!--
3     * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4     * Copyright (C) 2004-2007 - INRIA - Serge STEER 
5     * Copyright (C) 2004-2007 - INRIA - Vincent COUVERT 
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="savematfile">
15   <info>
16     <pubdate>$LastChangedDate$</pubdate>
17   </info>
18   <refnamediv>
19     <refname>savematfile</refname>
20     <refpurpose>write a Matlab MAT-file (binary or ASCII)</refpurpose>
21   </refnamediv>
22   <refsynopsisdiv>
23     <title>Calling Sequence</title>
24     <synopsis>savematfile('filename')
25 savematfile('filename', 'var1', 'var2', ...)
26 savematfile('filename', '-struct', 's')
27 savematfile('filename', '-struct', 's', 'f1', 'f2', ...)
28 savematfile(..., 'format')
29 savematfile filename var1 var2 ...</synopsis>
30   </refsynopsisdiv>
31   <refsection>
32     <title>Parameters</title>
33     <variablelist>
34       <varlistentry>
35         <term>filename</term>
36         <listitem>
37           <para>character string containing the path of the file (needed)</para>
38         </listitem>
39       </varlistentry>
40       <varlistentry>
41         <term>format</term>
42         <listitem>
43           <para>data format to use</para>
44           <variablelist>
45             <varlistentry>
46               <term>"-mat"</term>
47               <listitem>
48                 <para>binary MAT-file (default)</para>
49               </listitem>
50             </varlistentry>
51             <varlistentry>
52               <term>"-ascii"</term>
53               <listitem>
54                 <para>8-bit ASCII format</para>
55               </listitem>
56             </varlistentry>
57             <varlistentry>
58               <term>"-ascii" "-double"</term>
59               <listitem>
60                 <para>16-bit ASCII format</para>
61               </listitem>
62             </varlistentry>
63             <varlistentry>
64               <term>"-ascii" "-tabs"</term>
65               <listitem>
66                 <para>delimits with tabs</para>
67               </listitem>
68             </varlistentry>
69             <varlistentry>
70               <term>"-ascii" "-double" "-tabs"</term>
71               <listitem>
72                 <para>16-digit ASCII format, tab delimited</para>
73               </listitem>
74             </varlistentry>
75             <varlistentry>
76               <term>"-v4"</term>
77               <listitem>
78                 <para>A format that MATLAB Version 4 can open</para>
79               </listitem>
80             </varlistentry>
81             <varlistentry>
82               <term>"-v6"</term>
83               <listitem>
84                 <para>A format that MATLAB Version 6 and earlier can open (default)</para>
85               </listitem>
86             </varlistentry>
87           </variablelist>
88         </listitem>
89       </varlistentry>
90       <varlistentry>
91         <term>var1, var2</term>
92         <listitem>
93           <para>character strings containing the name of the variables to load (only for binary files)</para>
94         </listitem>
95       </varlistentry>
96       <varlistentry>
97         <term>"-struct" "s"</term>
98         <listitem>
99           <para>saves all fields of the scalar structure s as individual variables within the file filename.</para>
100         </listitem>
101       </varlistentry>
102       <varlistentry>
103         <term>"-struct" "s" "f1" "f2"</term>
104         <listitem>
105           <para>saves as individual variables only those structure fields specified (s.f1, s.f2, ...).</para>
106         </listitem>
107       </varlistentry>
108     </variablelist>
109   </refsection>
110   <refsection>
111     <title>Description</title>
112     <para>
113     saves variables in a Matlab MAT-file from Scilab. The Scilab data types are
114     converted into the Matlab equivalents.</para>
115   </refsection>
116   <refsection>
117     <title>See Also</title>
118     <simplelist type="inline">
119       <member>
120         <link linkend="load">load</link>
121       </member>
122       <member>
123         <link linkend="save">save</link>
124       </member>
125       <member>
126         <link linkend="loadmatfile">loadmatfile</link>
127       </member>
128       <member>
129         <link linkend="mfile2sci">mfile2sci</link>
130       </member>
131     </simplelist>
132   </refsection>
133   <refsection>
134     <title>Authors</title>
135     <simplelist type="vert">
136       <member>Serge Steer (INRIA)</member>
137       <member>V.C</member>
138     </simplelist>
139   </refsection>
140   <refsection>
141     <title>Bibliography</title>
142     <para>This function has been developped following the "MAT-File Format"
143   description: 
144 <literal><ulink url="http://www.mathworks.com/access/helpdesk/help/pdf_doc/matlab/matfile_format.pdf">Mat-File Format</ulink></literal></para>
145   </refsection>
146 </refentry>