Licence added (with correction)
[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  
14 <!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
15 <MAN>
16   <LANGUAGE>eng</LANGUAGE>
17   <TITLE>xs2pdf</TITLE>
18   <TYPE>Scilab Function</TYPE>
19   <DATE>$LastChangedDate$</DATE>
20   <SHORT_DESCRIPTION name="xs2pdf">save graphics to a Postscript file.</SHORT_DESCRIPTION>
21   <CALLING_SEQUENCE>
22     <CALLING_SEQUENCE_ITEM>xs2pdf(win_num,filen [,colored] [,orientation])</CALLING_SEQUENCE_ITEM>
23   </CALLING_SEQUENCE>
24   <PARAM>
25     <PARAM_INDENT>
26       <PARAM_ITEM>
27         <PARAM_NAME>win_num</PARAM_NAME>
28         <PARAM_DESCRIPTION>
29           <SP>: integer scalar or vector .</SP>
30         </PARAM_DESCRIPTION>
31       </PARAM_ITEM>
32       <PARAM_ITEM>
33         <PARAM_NAME>filen</PARAM_NAME>
34         <PARAM_DESCRIPTION>
35           <SP>: string, file name.</SP>
36         </PARAM_DESCRIPTION>
37       </PARAM_ITEM>
38       <PARAM_ITEM>
39         <PARAM_NAME>colored</PARAM_NAME>
40         <PARAM_DESCRIPTION>
41           <SP>: optional integer or boolean. 0 (%f) means black and white and 1
42             (%t) means color.
43           The default value (-1) is to use a value compatible with the screen
44           status.</SP>
45         </PARAM_DESCRIPTION>
46       </PARAM_ITEM>
47       <PARAM_ITEM>
48         <PARAM_NAME>orientation</PARAM_NAME>
49         <PARAM_DESCRIPTION>
50           <SP>: optional character, with possible values 'p' (portrait) or 'l' (landscape).
51           The default value  is 'p'.</SP>
52         </PARAM_DESCRIPTION>
53       </PARAM_ITEM>
54     </PARAM_INDENT>
55   </PARAM>
56   <DESCRIPTION>
57     <P>The function xs2pdf will not be available in version alpha</P>
58     <P><VERB>xs2pdf</VERB> saves the recorded graphics of the window
59     <VERB>win_num</VERB> to file <VERB>filen</VERB> in Postscript syntax. 
60     Note that <VERB>filen</VERB> must not have extension.</P>
61
62     <P><VERB>xs2pdf</VERB> produces a complete encapsulated Postscrip file. 
63     It simply  calls <VERB>xs2pdf</VERB> and then <VERB>BEpsf</VERB>.</P>
64
65     <P>This function works only if the selected driver is <VERB>"Rec"</VERB>
66     in the window <VERB>win_num</VERB> or if the window is in "new style". The
67     generated postscript file does not contrains the header part</P>
68   </DESCRIPTION>
69
70   <EXAMPLE><![CDATA[ 
71     scf(0)
72     plot2d()
73     // Postscript export
74     filename='foo'; // ! no extension
75     xs2pdf(0,filename)
76   ]]></EXAMPLE>
77
78   <SEE_ALSO>
79     <SEE_ALSO_ITEM>
80       <LINK>set_posfig_dim</LINK>
81     </SEE_ALSO_ITEM>
82     <SEE_ALSO_ITEM>
83       <LINK>printing</LINK>
84     </SEE_ALSO_ITEM>
85         
86         <SEE_ALSO_ITEM>
87       <LINK>xbasimp</LINK>
88     </SEE_ALSO_ITEM>
89         
90         <SEE_ALSO_ITEM>
91       <LINK>xs2bmp</LINK>
92         </SEE_ALSO_ITEM>
93         
94         <SEE_ALSO_ITEM>
95       <LINK>xs2gif</LINK>
96         </SEE_ALSO_ITEM>
97         
98         <SEE_ALSO_ITEM>
99       <LINK>xs2jpg</LINK>
100     </SEE_ALSO_ITEM>
101         
102         <SEE_ALSO_ITEM>
103       <LINK>xs2png</LINK>
104         </SEE_ALSO_ITEM>
105         
106         <SEE_ALSO_ITEM>
107       <LINK>xs2ppm</LINK>
108     </SEE_ALSO_ITEM>
109         
110         <SEE_ALSO_ITEM>
111       <LINK>xs2eps</LINK>
112     </SEE_ALSO_ITEM>
113         
114         <SEE_ALSO_ITEM>
115       <LINK>xs2svg</LINK>
116     </SEE_ALSO_ITEM>
117         
118         <SEE_ALSO_ITEM>
119       <LINK>xs2ps</LINK>
120     </SEE_ALSO_ITEM>
121   
122     <SEE_ALSO_ITEM>
123       <LINK>xs2fig</LINK>
124     </SEE_ALSO_ITEM>    
125
126     <SEE_ALSO_ITEM>
127       <LINK>xs2emf</LINK>
128     </SEE_ALSO_ITEM>
129   </SEE_ALSO>
130 </MAN>