Re-indent XML Files
[scilab.git] / scilab / modules / graphic_export / help / en_US / xs2pdf.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="xs2pdf">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>xs2pdf</refname>
19     <refpurpose>save graphics to a Postscript file.</refpurpose>
20   </refnamediv>
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>xs2pdf(win_num,filen [,colored] [,orientation])</synopsis>
24   </refsynopsisdiv>
25   <refsection>
26     <title>Parameters</title>
27     <variablelist>
28       <varlistentry>
29         <term>win_num</term>
30         <listitem>
31           <para>integer scalar or vector .</para>
32         </listitem>
33       </varlistentry>
34       <varlistentry>
35         <term>filen</term>
36         <listitem>
37           <para>string, file name.</para>
38         </listitem>
39       </varlistentry>
40       <varlistentry>
41         <term>colored</term>
42         <listitem>
43           <para>optional integer or boolean. 0 (%f) means black and white and 1
44             (%t) means color.
45           The default value (-1) is to use a value compatible with the screen
46           status.</para>
47         </listitem>
48       </varlistentry>
49       <varlistentry>
50         <term>orientation</term>
51         <listitem>
52           <para>optional character, with possible values 'p' (portrait) or 'l' (landscape).
53           The default value  is 'p'.</para>
54         </listitem>
55       </varlistentry>
56     </variablelist>
57   </refsection>
58   <refsection>
59     <title>Description</title>
60     <para>The function xs2pdf will not be available in version alpha</para>
61     <para><literal>xs2pdf</literal> saves the recorded graphics of the window
62     <literal>win_num</literal> to file <literal>filen</literal> in Postscript syntax. 
63     Note that <literal>filen</literal> must not have extension.</para>
64     <para><literal>xs2pdf</literal> produces a complete encapsulated Postscrip file. 
65     It simply  calls <literal>xs2pdf</literal> and then <literal>BEpsf</literal>.</para>
66     <para>This function works only if the selected driver is <literal>"Rec"</literal>
67     in the window <literal>win_num</literal> or if the window is in "new style". The
68     generated postscript file does not contrains the header part</para>
69   </refsection>
70   <refsection>
71     <title>Examples</title>
72     <programlisting role="example"><![CDATA[ 
73     scf(0)
74     plot2d()
75     // Postscript export
76     filename='foo'; // ! no extension
77     xs2pdf(0,filename)
78   ]]></programlisting>
79   </refsection>
80   <refsection>
81     <title>See Also</title>
82     <simplelist type="inline">
83       <member>
84         <link linkend="set_posfig_dim">set_posfig_dim</link>
85       </member>
86       <member>
87         <link linkend="printing">printing</link>
88       </member>
89       <member>
90         <link linkend="xbasimp">xbasimp</link>
91       </member>
92       <member>
93         <link linkend="xs2bmp">xs2bmp</link>
94       </member>
95       <member>
96         <link linkend="xs2gif">xs2gif</link>
97       </member>
98       <member>
99         <link linkend="xs2jpg">xs2jpg</link>
100       </member>
101       <member>
102         <link linkend="xs2png">xs2png</link>
103       </member>
104       <member>
105         <link linkend="xs2ppm">xs2ppm</link>
106       </member>
107       <member>
108         <link linkend="xs2eps">xs2eps</link>
109       </member>
110       <member>
111         <link linkend="xs2svg">xs2svg</link>
112       </member>
113       <member>
114         <link linkend="xs2ps">xs2ps</link>
115       </member>
116       <member>
117         <link linkend="xs2fig">xs2fig</link>
118       </member>
119       <member>
120         <link linkend="xs2emf">xs2emf</link>
121       </member>
122     </simplelist>
123   </refsection>
124 </refentry>