remove functions declared obsolete for scilab 5.2
[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 version="5.0-subset Scilab" xml:id="xs2pdf" xml:lang="en"
14           xmlns="http://docbook.org/ns/docbook"
15           xmlns:xlink="http://www.w3.org/1999/xlink"
16           xmlns:svg="http://www.w3.org/2000/svg"
17           xmlns:ns5="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML"
19           xmlns:db="http://docbook.org/ns/docbook">
20   <info>
21     <pubdate>$LastChangedDate$</pubdate>
22   </info>
23
24   <refnamediv>
25     <refname>xs2pdf</refname>
26
27     <refpurpose>save graphics to a PDF file.</refpurpose>
28   </refnamediv>
29
30   <refsynopsisdiv>
31     <title>Calling Sequence</title>
32
33     <synopsis>xs2pdf(win_num, file_name [,orientation])
34 xs2pdf(fig, file_name [,orientation])</synopsis>
35   </refsynopsisdiv>
36
37   <refsection>
38     <title>Parameters</title>
39
40     <variablelist>
41       <varlistentry>
42         <term>win_num</term>
43
44         <listitem>
45           <para>integer, id of the figure to export.</para>
46         </listitem>
47       </varlistentry>
48           
49           <varlistentry>
50         <term>fig</term>
51
52         <listitem>
53           <para>handle of the figure to export.</para>
54         </listitem>
55       </varlistentry>
56
57       <varlistentry>
58         <term>file_name</term>
59
60         <listitem>
61           <para>string, name of the exported file.</para>
62         </listitem>
63       </varlistentry>
64
65       <varlistentry>
66         <term>orientation</term>
67
68         <listitem>
69           <para>optional character, with possible values 'portrait' or 'landscape'. The default value is 'portrait'.</para>
70         </listitem>
71       </varlistentry>
72     </variablelist>
73   </refsection>
74
75   <refsection>
76     <title>Description</title>
77
78     <para><literal>xs2pdf</literal> exports the display of a graphic window into an PDF file.</para>
79   </refsection>
80
81   <refsection>
82     <title>Examples</title>
83
84     <programlisting role="example"><![CDATA[ 
85 scf(0);
86 plot2d();
87 //PDF export
88 filename='foo'; // ! no extension
89 xs2pdf(0,filename);
90 xs2pdf(gcf(),filename);
91  ]]></programlisting>
92   </refsection>
93
94   <refsection>
95     <title>See Also</title>
96
97     <simplelist type="inline">
98       <member>figure_size property</member>
99
100       <member><link linkend="toprint">toprint</link></member>
101
102       <member><link linkend="printfigure">printfigure</link></member>
103
104       <member><link linkend="xs2bmp">xs2bmp</link></member>
105
106       <member><link linkend="xs2gif">xs2gif</link></member>
107
108       <member><link linkend="xs2jpg">xs2jpg</link></member>
109
110       <member><link linkend="xs2png">xs2png</link></member>
111
112       <member><link linkend="xs2ppm">xs2ppm</link></member>
113
114       <member><link linkend="xs2eps">xs2eps</link></member>
115
116       <member><link linkend="xs2svg">xs2svg</link></member>
117
118       <member><link linkend="xs2ps">xs2ps</link></member>
119
120       <member><link linkend="xs2fig">xs2fig</link></member>
121
122       <member><link linkend="xs2emf">xs2emf</link></member>
123     </simplelist>
124   </refsection>
125 </refentry>