74ad48b44902d5b16dc901dc22975f2f4a0d91db
[scilab.git] / scilab / modules / graphic_export / help / en_US / xs2gif.xml
1 <?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
2 <!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
3 <MAN>
4   <LANGUAGE>eng</LANGUAGE>
5   <TITLE>xs2gif</TITLE>
6   <TYPE>Scilab Function</TYPE>
7   <DATE>$LastChangedDate: 2006-08-03 16:16:36 +0200 (jeu., 03 août 2006) $</DATE>
8   <SHORT_DESCRIPTION name="xs2gif"> send graphics to a file in GIF syntax</SHORT_DESCRIPTION>
9   <CALLING_SEQUENCE>
10     <CALLING_SEQUENCE_ITEM>xs2gif(win_num,filen,[color])  </CALLING_SEQUENCE_ITEM>
11   </CALLING_SEQUENCE>
12   <PARAM>
13     <PARAM_INDENT>
14       <PARAM_ITEM>
15         <PARAM_NAME>win_num</PARAM_NAME>
16         <PARAM_DESCRIPTION>
17           <SP>: integer scalar or vector .</SP>
18         </PARAM_DESCRIPTION>
19       </PARAM_ITEM>
20       <PARAM_ITEM>
21         <PARAM_NAME>filen</PARAM_NAME>
22         <PARAM_DESCRIPTION>
23           <SP>: string, file name.</SP>
24         </PARAM_DESCRIPTION>
25       </PARAM_ITEM>
26       <PARAM_ITEM>
27         <PARAM_NAME>color</PARAM_NAME>
28         <PARAM_DESCRIPTION>
29           <SP>: optional integer. 0 means black and white and 1 means color. The default value is to use a value compatible  with the screen status.</SP>
30         </PARAM_DESCRIPTION>
31       </PARAM_ITEM>
32     </PARAM_INDENT>
33   </PARAM>
34   <DESCRIPTION>
35     <P><VERB>xs2gif</VERB> sends the recorded graphics of the
36     window <VERB>win_num</VERB> in the file <VERB>filen</VERB> in GIF format.
37     This function works only if the selected 
38     driver is <VERB>&quot;Rec&quot;</VERB> in the window
39     <VERB>win_num</VERB>  or if the window is in &quot;new style&quot;.</P>
40     <P>To convert a sequence of &quot;GIF&quot;  files to an animated GIF file
41       one can use the &quot;convert&quot; program for ImageMagic
42       (http://www.imagemagick.org/)</P>
43
44     <P>For example if one has generated a sequence of Gif files named
45       <VERB>img*.gif</VERB> it is possible to build an animated Gif file (named
46       anim.gif) by</P> 
47     <VERBATIM>
48     <![CDATA[
49     convert -delay 10  img*.gif anim.gif  
50      ]]>
51     </VERBATIM>
52
53   </DESCRIPTION>
54   <EXAMPLE><![CDATA[ 
55     //simple example
56     scf(0)
57     plot2d()
58     xs2gif(0,'foo.gif')
59   ]]></EXAMPLE>
60   <SEE_ALSO>
61     <SEE_ALSO_ITEM>
62       <LINK>xs2bmp</LINK>
63         </SEE_ALSO_ITEM>
64         
65         <SEE_ALSO_ITEM>
66       <LINK>xs2jpg</LINK>
67         </SEE_ALSO_ITEM>
68         
69         <SEE_ALSO_ITEM>
70       <LINK>xs2png</LINK>
71         </SEE_ALSO_ITEM>
72         
73         <SEE_ALSO_ITEM>
74       <LINK>xs2ppm</LINK>
75     </SEE_ALSO_ITEM>
76         
77         <SEE_ALSO_ITEM>
78       <LINK>xs2eps</LINK>
79     </SEE_ALSO_ITEM>
80         
81         <SEE_ALSO_ITEM>
82       <LINK>xs2pdf</LINK>
83     </SEE_ALSO_ITEM>
84         
85         <SEE_ALSO_ITEM>
86       <LINK>xs2svg</LINK>
87     </SEE_ALSO_ITEM>
88         
89         <SEE_ALSO_ITEM>
90       <LINK>xs2ps</LINK>
91     </SEE_ALSO_ITEM>
92   
93     <SEE_ALSO_ITEM>
94       <LINK>xs2fig</LINK>
95     </SEE_ALSO_ITEM>    
96
97     <SEE_ALSO_ITEM>
98       <LINK>xs2emf</LINK>
99     </SEE_ALSO_ITEM>
100   </SEE_ALSO>
101 </MAN>