fix online help examples
[scilab.git] / scilab / modules / graphic_export / help / en_US / xs2ps.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
18   <TITLE>xs2ps</TITLE>
19
20   <TYPE>Scilab Function</TYPE>
21
22   <DATE>$LastChangedDate$</DATE>
23
24   <SHORT_DESCRIPTION name="xs2ps">send graphics to a file in PS
25   syntax</SHORT_DESCRIPTION>
26
27   <CALLING_SEQUENCE>
28     <CALLING_SEQUENCE_ITEM>xs2ps(win_num,filen,[color])</CALLING_SEQUENCE_ITEM>
29   </CALLING_SEQUENCE>
30
31   <PARAM>
32     <PARAM_INDENT>
33       <PARAM_ITEM>
34         <PARAM_NAME>win_num</PARAM_NAME>
35
36         <PARAM_DESCRIPTION>
37           <SP>: integer scalar or vector .</SP>
38         </PARAM_DESCRIPTION>
39       </PARAM_ITEM>
40
41       <PARAM_ITEM>
42         <PARAM_NAME>filen</PARAM_NAME>
43
44         <PARAM_DESCRIPTION>
45           <SP>: string, file name.</SP>
46         </PARAM_DESCRIPTION>
47       </PARAM_ITEM>
48
49       <PARAM_ITEM>
50         <PARAM_NAME>color</PARAM_NAME>
51
52         <PARAM_DESCRIPTION>
53           <SP>: optional integer. 0 means black and white and 1 means color.
54           The default value is to use a value compatible with the screen
55           status.</SP>
56         </PARAM_DESCRIPTION>
57       </PARAM_ITEM>
58     </PARAM_INDENT>
59   </PARAM>
60
61   <DESCRIPTION>
62         <P>The function xs2ps will not be available in version alpha</P>
63     <P><VERB>xs2ps</VERB> saves the recorded graphics of the window
64     <VERB>win_num</VERB> to file <VERB>filen</VERB> in Postscript syntax. The
65     <VERB>filen</VERB> must not have suffix extension.</P>
66
67     <P>Note that the generated Postscript file cannot be direcly printed since
68     it requires a header file. The Scilab command <VERB>BEpsf</VERB> or others
69     can be used to add a header file. The function <VERB>xs2eps</VERB> can be
70     used to directly produce an encapsulated Postscript file with an
71     header.</P>
72
73     <P>This function works only if the selected driver is <VERB>"Rec"</VERB>
74     in the window <VERB>win_num</VERB> or if the window is in "new style". The
75     generated postscript file does not contrains the header part</P>
76   </DESCRIPTION>
77
78 <EXAMPLE><![CDATA[
79 scf(0);
80 plot2d();
81 // Postcript export
82 filename='foo.ps';
83 xs2ps(0,filename)
84 // Gif export
85 xs2gif(0,'foo.gif');
86 // ppm export
87 xs2ppm(0,'foo.ppm');
88 ]]></EXAMPLE>
89
90   <SEE_ALSO>
91     <SEE_ALSO_ITEM>
92       <LINK>set_posfig_dim</LINK>
93     </SEE_ALSO_ITEM>
94     <SEE_ALSO_ITEM>
95       <LINK>printing</LINK>
96     </SEE_ALSO_ITEM>
97         
98         <SEE_ALSO_ITEM>
99       <LINK>xbasimp</LINK>
100     </SEE_ALSO_ITEM>
101         
102         <SEE_ALSO_ITEM>
103       <LINK>xs2bmp</LINK>
104         </SEE_ALSO_ITEM>
105         
106         <SEE_ALSO_ITEM>
107       <LINK>xs2gif</LINK>
108         </SEE_ALSO_ITEM>
109         
110         <SEE_ALSO_ITEM>
111       <LINK>xs2jpg</LINK>
112     </SEE_ALSO_ITEM>
113         
114         <SEE_ALSO_ITEM>
115       <LINK>xs2png</LINK>
116         </SEE_ALSO_ITEM>
117         
118         <SEE_ALSO_ITEM>
119       <LINK>xs2ppm</LINK>
120     </SEE_ALSO_ITEM>
121         
122         <SEE_ALSO_ITEM>
123       <LINK>xs2eps</LINK>
124     </SEE_ALSO_ITEM>
125         
126         <SEE_ALSO_ITEM>
127       <LINK>xs2pdf</LINK>
128     </SEE_ALSO_ITEM>
129         
130         <SEE_ALSO_ITEM>
131       <LINK>xs2svg</LINK>
132     </SEE_ALSO_ITEM>
133   
134     <SEE_ALSO_ITEM>
135       <LINK>xs2fig</LINK>
136     </SEE_ALSO_ITEM>    
137
138     <SEE_ALSO_ITEM>
139       <LINK>xs2emf</LINK>
140     </SEE_ALSO_ITEM>
141   </SEE_ALSO>
142 </MAN>