f93a0437ee25aaedc9d9b58d7138681572189976
[scilab.git] / scilab / modules / graphic_export / help / en_US / xs2gif.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 - Sylvestre Koumar
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-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="xs2gif" xml:lang="en">
14     <refnamediv>
15         <refname>xs2gif</refname>
16         <refpurpose>export graphics to GIF</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>
21             xs2gif(win_num, file_name)
22             xs2gif(fig, file_name)
23         </synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Arguments</title>
27         <variablelist>
28             <varlistentry>
29                 <term>win_num</term>
30                 <listitem>
31                     <para>an integer, ID of the figure to export.</para>
32                 </listitem>
33             </varlistentry>
34             <varlistentry>
35                 <term>fig</term>
36                 <listitem>
37                     <para>handle of the figure to export.</para>
38                 </listitem>
39             </varlistentry>
40             <varlistentry>
41                 <term>file_name</term>
42                 <listitem>
43                     <para>a string, name of the exported file.</para>
44                 </listitem>
45             </varlistentry>
46         </variablelist>
47     </refsection>
48     <refsection>
49         <title>Description</title>
50         <para>
51             <literal>xs2gif</literal> exports the display of a graphic window into a GIF file.
52         </para>
53         <para>
54             To convert a sequence of "GIF" files to an animated GIF
55             file one can use the "convert" program for ImageMagic
56             (<ulink url="http://www.imagemagick.org/">http://www.imagemagick.org/</ulink>)
57         </para>
58         <para>
59             For example if one has generated a sequence of Gif files
60             named <literal>img*.gif</literal> it is possible to build
61             an animated Gif file (named anim.gif) by
62         </para>
63         <synopsis>
64             convert -delay 10  img*.gif anim.gif
65         </synopsis>
66     </refsection>
67     <refsection>
68         <title>Examples</title>
69         <programlisting role="example"><![CDATA[ 
70 scf(0);
71 plot2d();
72 //GIF export
73 xs2gif(0,'foo.gif');
74 xs2gif(gcf(),'foo.gif');
75  ]]></programlisting>
76     </refsection>
77     <refsection role="see also">
78         <title>See Also</title>
79         <simplelist type="inline">
80             <member>
81                 <link linkend="toprint">toprint</link>
82             </member>
83             <member>
84                 <link linkend="printfigure">printfigure</link>
85             </member>
86             <member>
87                 <link linkend="xs2bmp">xs2bmp</link>
88             </member>
89             <member>
90                 <link linkend="xs2jpg">xs2jpg</link>
91             </member>
92             <member>
93                 <link linkend="xs2png">xs2png</link>
94             </member>
95             <member>
96                 <link linkend="xs2ppm">xs2ppm</link>
97             </member>
98             <member>
99                 <link linkend="xs2eps">xs2eps</link>
100             </member>
101             <member>
102                 <link linkend="xs2pdf">xs2pdf</link>
103             </member>
104             <member>
105                 <link linkend="xs2svg">xs2svg</link>
106             </member>
107             <member>
108                 <link linkend="xs2ps">xs2ps</link>
109             </member>
110             <member>
111                 <link linkend="xs2emf">xs2emf</link>
112             </member>
113         </simplelist>
114     </refsection>
115 </refentry>