← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/graphic_export/help/en_US/xs2gif.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

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