scilab/modules/graphic_export/help/en_US/xs2eps.xml

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