remove functions declared obsolete for scilab 5.2
[scilab.git] / scilab / modules / graphic_export / help / en_US / xs2eps.xml
index 0d1c67a..dbacb7d 100644 (file)
   <refnamediv>
     <refname>xs2eps</refname>
 
-    <refpurpose>save graphics to a Postscript file.</refpurpose>
+    <refpurpose>send graphics to an EPS file.</refpurpose>
   </refnamediv>
 
   <refsynopsisdiv>
     <title>Calling Sequence</title>
 
-    <synopsis>xs2eps(win_num,filen [,orientation])</synopsis>
+    <synopsis>xs2eps(win_num, file_name [,orientation])
+xs2eps(fig, file_name [,orientation])</synopsis>
   </refsynopsisdiv>
 
   <refsection>
         <term>win_num</term>
 
         <listitem>
-          <para>integer scalar or vector .</para>
+          <para>integer, id of the figure to export.</para>
         </listitem>
       </varlistentry>
 
       <varlistentry>
-        <term>filen</term>
+        <term>fig</term>
 
         <listitem>
-          <para>string, file name.</para>
+          <para>handle of the figure to export.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>file_name</term>
+
+        <listitem>
+          <para>string, name of the exported file.</para>
         </listitem>
       </varlistentry>
 
@@ -57,8 +66,8 @@
         <term>orientation</term>
 
         <listitem>
-          <para>optional character, with possible values 'p' (portrait) or 'l'
-          (landscape). The default value is 'p'.</para>
+          <para>optional character, with possible values 'portrait' or
+          'landscape'. The default value is 'portrait'.</para>
         </listitem>
       </varlistentry>
     </variablelist>
   <refsection>
     <title>Description</title>
 
-    <para><literal>xs2eps</literal> saves the recorded graphics of the window
-    <literal>win_num</literal> to file <literal>filen</literal> in Postscript
-    syntax. Note that <literal>filen</literal> must not have extension.</para>
-
-    <para><literal>xs2eps</literal> produces a complete encapsulated Postscrip
-    file.<literal> </literal></para>
+    <para><literal>xs2eps</literal> exports the display of a graphic window
+    into a complete Encapsulated PostScript file.</para>
   </refsection>
 
   <refsection>
     <title>Examples</title>
 
-    <programlisting role="example"> 
-    scf(0)
-    plot2d()
-    //EPS export
-    filename='foo'; // ! no extension
-    xs2eps(0,filename)
-  </programlisting>
+    <programlisting role="example"><![CDATA[ 
+scf(0)
+plot2d()
+//EPS export
+xs2eps(0,'foo.eps')
+xs2eps(gcf(),'foo.eps')
+ ]]></programlisting>
   </refsection>
 
   <refsection>
     <title>See Also</title>
 
     <simplelist type="inline">
-      <member><link linkend="set_posfig_dim">set_posfig_dim</link></member>
+      <member>figure_size property</member>
 
       <member><link linkend="toprint">toprint</link></member>
 
       <member><link linkend="xs2emf">xs2emf</link></member>
     </simplelist>
   </refsection>
-</refentry>
\ No newline at end of file
+</refentry>