Remove obsolete function xbasimp() (Please use toprint() or xs2ps() instead)
[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,filen [,orientation])</synopsis>
34   </refsynopsisdiv>
35
36   <refsection>
37     <title>Parameters</title>
38
39     <variablelist>
40       <varlistentry>
41         <term>win_num</term>
42
43         <listitem>
44           <para>integer scalar .</para>
45         </listitem>
46       </varlistentry>
47
48       <varlistentry>
49         <term>filen</term>
50
51         <listitem>
52           <para>string, file name.</para>
53         </listitem>
54       </varlistentry>
55
56       <varlistentry>
57         <term>orientation</term>
58
59         <listitem>
60           <para>optional character, with possible values 'p' (portrait) or 'l'
61           (landscape). The default value is 'p'.</para>
62         </listitem>
63       </varlistentry>
64     </variablelist>
65   </refsection>
66
67   <refsection>
68     <title>Description</title>
69
70     <para><literal>xs2pdf</literal> saves the recorded graphics of the window
71     <literal>win_num</literal> to file <literal>filen</literal> in PDF syntax.
72     Note that <literal>filen</literal> must not have extension.</para>
73   </refsection>
74
75   <refsection>
76     <title>Examples</title>
77
78     <programlisting role="example"> 
79     scf(0)
80     plot2d()
81     //PDF export
82     filename='foo'; // ! no extension
83     xs2pdf(0,filename)
84   </programlisting>
85   </refsection>
86
87   <refsection>
88     <title>See Also</title>
89
90     <simplelist type="inline">
91       <member><link linkend="set_posfig_dim">set_posfig_dim</link></member>
92
93       <member><link linkend="toprint">toprint</link></member>
94
95       <member><link linkend="printfigure">printfigure</link></member>
96
97       <member><link linkend="xs2bmp">xs2bmp</link></member>
98
99       <member><link linkend="xs2gif">xs2gif</link></member>
100
101       <member><link linkend="xs2jpg">xs2jpg</link></member>
102
103       <member><link linkend="xs2png">xs2png</link></member>
104
105       <member><link linkend="xs2ppm">xs2ppm</link></member>
106
107       <member><link linkend="xs2eps">xs2eps</link></member>
108
109       <member><link linkend="xs2svg">xs2svg</link></member>
110
111       <member><link linkend="xs2ps">xs2ps</link></member>
112
113       <member><link linkend="xs2fig">xs2fig</link></member>
114
115       <member><link linkend="xs2emf">xs2emf</link></member>
116     </simplelist>
117   </refsection>
118 </refentry>