cdfcdf763372472a3081e7deed68b1cd695cfcb6
[scilab.git] / scilab / modules / graphic_export / help / en_US / xs2pdf.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="xs2pdf" xml:lang="en">
14     <refnamediv>
15         <refname>xs2pdf</refname>
16         <refpurpose>Export graphics to PDF.</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>
21             xs2pdf(win_num, file_name [,orientation])
22             xs2pdf(fig, file_name [,orientation])
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                     <para>If the extension is not provided, it is going to be automatically added.</para>
45                 </listitem>
46             </varlistentry>
47             <varlistentry>
48                 <term>orientation</term>
49                 <listitem>
50                     <para>an optional string, with possible values <literal>'portrait'</literal> or <literal>'landscape'</literal>. The default value is <literal>'portrait'</literal>.</para>
51                 </listitem>
52             </varlistentry>
53         </variablelist>
54     </refsection>
55     <refsection>
56         <title>Description</title>
57         <para>
58             <function>xs2pdf</function> exports the display of a graphic window into an PDF file.
59         </para>
60     </refsection>
61     <refsection>
62         <title>Examples</title>
63         <programlisting role="example"><![CDATA[ 
64 scf(0);
65 plot2d();
66 //PDF export
67 filename='foo';
68 xs2pdf(0,filename);
69 xs2pdf(gcf(),filename);
70  ]]></programlisting>
71     </refsection>
72     <refsection role="see also">
73         <title>See Also</title>
74         <simplelist type="inline">
75             <member>
76                 <link linkend="figure_properties"><literal>figure_size</literal> property</link>
77             </member>
78             <member>
79                 <link linkend="toprint">toprint</link>
80             </member>
81             <member>
82                 <link linkend="printfigure">printfigure</link>
83             </member>
84             <member>
85                 <link linkend="xs2bmp">xs2bmp</link>
86             </member>
87             <member>
88                 <link linkend="xs2gif">xs2gif</link>
89             </member>
90             <member>
91                 <link linkend="xs2jpg">xs2jpg</link>
92             </member>
93             <member>
94                 <link linkend="xs2png">xs2png</link>
95             </member>
96             <member>
97                 <link linkend="xs2ppm">xs2ppm</link>
98             </member>
99             <member>
100                 <link linkend="xs2eps">xs2eps</link>
101             </member>
102             <member>
103                 <link linkend="xs2svg">xs2svg</link>
104             </member>
105             <member>
106                 <link linkend="xs2ps">xs2ps</link>
107             </member>
108             <member>
109                 <link linkend="xs2emf">xs2emf</link>
110             </member>
111         </simplelist>
112     </refsection>
113 </refentry>