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

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
   3 <MAN>
   4   <LANGUAGE>eng</LANGUAGE>
   5
   6   <TITLE>xs2ps</TITLE>
   7
   8   <TYPE>Scilab Function</TYPE>
   9
  10   <DATE>$LastChangedDate: 2006-08-03 16:16:36 +0200 (jeu., 03 août 2006) $</DATE>
  11
  12   <SHORT_DESCRIPTION name="xs2ps">send graphics to a file in PS
  13   syntax</SHORT_DESCRIPTION>
  14
  15   <CALLING_SEQUENCE>
  16     <CALLING_SEQUENCE_ITEM>xs2ps(win_num,filen,[color])</CALLING_SEQUENCE_ITEM>
  17   </CALLING_SEQUENCE>
  18
  19   <PARAM>
  20     <PARAM_INDENT>
  21       <PARAM_ITEM>
  22         <PARAM_NAME>win_num</PARAM_NAME>
  23
  24         <PARAM_DESCRIPTION>
  25           <SP>: integer scalar or vector .</SP>
  26         </PARAM_DESCRIPTION>
  27       </PARAM_ITEM>
  28
  29       <PARAM_ITEM>
  30         <PARAM_NAME>filen</PARAM_NAME>
  31
  32         <PARAM_DESCRIPTION>
  33           <SP>: string, file name.</SP>
  34         </PARAM_DESCRIPTION>
  35       </PARAM_ITEM>
  36
  37       <PARAM_ITEM>
  38         <PARAM_NAME>color</PARAM_NAME>
  39
  40         <PARAM_DESCRIPTION>
  41           <SP>: optional integer. 0 means black and white and 1 means color.
  42           The default value is to use a value compatible with the screen
  43           status.</SP>
  44         </PARAM_DESCRIPTION>
  45       </PARAM_ITEM>
  46     </PARAM_INDENT>
  47   </PARAM>
  48
  49   <DESCRIPTION>
  50         <P>The function xs2ps will not be available in version alpha</P>
  51     <P><VERB>xs2ps</VERB> saves the recorded graphics of the window
  52     <VERB>win_num</VERB> to file <VERB>filen</VERB> in Postscript syntax. The
  53     <VERB>filen</VERB> must not have suffix extension.</P>
  54
  55     <P>Note that the generated Postscript file cannot be direcly printed since
  56     it requires a header file. The Scilab command <VERB>BEpsf</VERB> or others
  57     can be used to add a header file. The function <VERB>xs2eps</VERB> can be
  58     used to directly produce an encapsulated Postscript file with an
  59     header.</P>
  60
  61     <P>This function works only if the selected driver is <VERB>"Rec"</VERB>
  62     in the window <VERB>win_num</VERB> or if the window is in "new style". The
  63     generated postscript file does not contrains the header part</P>
  64   </DESCRIPTION>
  65
  66   <EXAMPLE><![CDATA[
  67     scf(0)
  68     plot2d()
  69     // Postcript export
  70     filename='foo'; // ! no extension
  71     xs2ps(0,filename)
  72     //add the Postscript file header and create <filename>.eps file
  73     if MSDOS then
  74       unix_s(pathconvert('""'+WSCI+'/bin/BEpsf'+'""',%f)+' -p ' +filename)
  75     else
  76       unix_s(pathconvert('SCI/bin/BEpsf',%f)+' -p ' +filename)
  77     end
  78     // Gif export
  79     xs2gif(0,'foo.gif')
  80     // ppm export
  81     xs2ppm(0,'foo.ppm')
  82   ]]></EXAMPLE>
  83
  84   <SEE_ALSO>
  85     <SEE_ALSO_ITEM>
  86       <LINK>set_posfig_dim</LINK>
  87     </SEE_ALSO_ITEM>
  88     <SEE_ALSO_ITEM>
  89       <LINK>printing</LINK>
  90     </SEE_ALSO_ITEM>
  91
  92         <SEE_ALSO_ITEM>
  93       <LINK>xbasimp</LINK>
  94     </SEE_ALSO_ITEM>
  95
  96         <SEE_ALSO_ITEM>
  97       <LINK>xs2bmp</LINK>
  98         </SEE_ALSO_ITEM>
  99
 100         <SEE_ALSO_ITEM>
 101       <LINK>xs2gif</LINK>
 102         </SEE_ALSO_ITEM>
 103
 104         <SEE_ALSO_ITEM>
 105       <LINK>xs2jpg</LINK>
 106     </SEE_ALSO_ITEM>
 107
 108         <SEE_ALSO_ITEM>
 109       <LINK>xs2png</LINK>
 110         </SEE_ALSO_ITEM>
 111
 112         <SEE_ALSO_ITEM>
 113       <LINK>xs2ppm</LINK>
 114     </SEE_ALSO_ITEM>
 115
 116         <SEE_ALSO_ITEM>
 117       <LINK>xs2eps</LINK>
 118     </SEE_ALSO_ITEM>
 119
 120         <SEE_ALSO_ITEM>
 121       <LINK>xs2pdf</LINK>
 122     </SEE_ALSO_ITEM>
 123
 124         <SEE_ALSO_ITEM>
 125       <LINK>xs2svg</LINK>
 126     </SEE_ALSO_ITEM>
 127
 128     <SEE_ALSO_ITEM>
 129       <LINK>xs2fig</LINK>
 130     </SEE_ALSO_ITEM>
 131
 132     <SEE_ALSO_ITEM>
 133       <LINK>xs2emf</LINK>
 134     </SEE_ALSO_ITEM>
 135   </SEE_ALSO>
 136 </MAN>