-<?xml version="1.0" encoding="ISO-8859-1"?>
+<?xml version="1.0" encoding="UTF-8"?>
<!--
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) 2008 - INRIA - Sylvestre Koumar
* http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
*
-->
-<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="xs2ps">
+<refentry version="5.0-subset Scilab" xml:id="xs2ps" xml:lang="en"
+ xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:ns5="http://www.w3.org/1999/xhtml"
+ xmlns:mml="http://www.w3.org/1998/Math/MathML"
+ xmlns:db="http://docbook.org/ns/docbook">
<info>
<pubdate>$LastChangedDate$</pubdate>
</info>
+
<refnamediv>
<refname>xs2ps</refname>
- <refpurpose>send graphics to a file in PS
- syntax</refpurpose>
+
+ <refpurpose>send graphics to a file in PS syntax</refpurpose>
</refnamediv>
+
<refsynopsisdiv>
<title>Calling Sequence</title>
- <synopsis>xs2ps(win_num,filen,[color])</synopsis>
+
+ <synopsis>xs2ps(win_num,filen,[orientation])</synopsis>
</refsynopsisdiv>
+
<refsection>
<title>Parameters</title>
+
<variablelist>
<varlistentry>
<term>win_num</term>
+
<listitem>
<para>integer scalar or vector .</para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>filen</term>
+
<listitem>
<para>string, file name.</para>
</listitem>
</varlistentry>
+
<varlistentry>
- <term>color</term>
+ <term>orientation</term>
+
<listitem>
- <para>optional integer. 0 means black and white and 1 means color.
- The default value is to use a value compatible with the screen
- status.</para>
+ <para>optional character, with possible values 'p' (portrait) or 'l'
+ (landscape). The default value is 'p'.</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
+
<refsection>
<title>Description</title>
- <para>The function xs2ps will not be available in version alpha</para>
+
<para><literal>xs2ps</literal> saves the recorded graphics of the window
- <literal>win_num</literal> to file <literal>filen</literal> in Postscript syntax. The
- <literal>filen</literal> must not have suffix extension.</para>
- <para>Note that the generated Postscript file cannot be direcly printed since
- it requires a header file. The Scilab command <literal>BEpsf</literal> or others
- can be used to add a header file. The function <literal>xs2eps</literal> can be
- used to directly produce an encapsulated Postscript file with an
+ <literal>win_num</literal> to file <literal>filen</literal> in Postscript
+ syntax. The <literal>filen</literal> must not have suffix
+ extension.</para>
+
+ <para>Note that the generated Postscript file cannot be direcly printed
+ since it requires a header file. The function <literal>xs2eps</literal>
+ can be used to directly produce an encapsulated Postscript file with an
header.</para>
- <para>This function works only if the selected driver is <literal>"Rec"</literal>
- in the window <literal>win_num</literal> or if the window is in "new style". The
- generated postscript file does not contrains the header part</para>
</refsection>
+
<refsection>
<title>Examples</title>
- <programlisting role="example"><![CDATA[
+
+ <programlisting role="example">
scf(0);
plot2d();
// Postcript export
filename='foo.ps';
-xs2ps(0,filename)
-// Gif export
-xs2gif(0,'foo.gif');
-// ppm export
-xs2ppm(0,'foo.ppm');
-]]></programlisting>
+xs2ps(0,filename);</programlisting>
</refsection>
+
<refsection>
<title>See Also</title>
+
<simplelist type="inline">
- <member>
- <link linkend="set_posfig_dim">set_posfig_dim</link>
- </member>
- <member>
- <link linkend="printing">printing</link>
- </member>
- <member>
- <link linkend="xbasimp">xbasimp</link>
- </member>
- <member>
- <link linkend="xs2bmp">xs2bmp</link>
- </member>
- <member>
- <link linkend="xs2gif">xs2gif</link>
- </member>
- <member>
- <link linkend="xs2jpg">xs2jpg</link>
- </member>
- <member>
- <link linkend="xs2png">xs2png</link>
- </member>
- <member>
- <link linkend="xs2ppm">xs2ppm</link>
- </member>
- <member>
- <link linkend="xs2eps">xs2eps</link>
- </member>
- <member>
- <link linkend="xs2pdf">xs2pdf</link>
- </member>
- <member>
- <link linkend="xs2svg">xs2svg</link>
- </member>
- <member>
- <link linkend="xs2fig">xs2fig</link>
- </member>
- <member>
- <link linkend="xs2emf">xs2emf</link>
- </member>
+ <member><link linkend="set_posfig_dim">set_posfig_dim</link></member>
+
+ <member><link linkend="toprint">toprint</link></member>
+
+ <member><link linkend="printfigure">printfigure</link></member>
+
+ <member><link linkend="xbasimp">xbasimp</link></member>
+
+ <member><link linkend="xs2bmp">xs2bmp</link></member>
+
+ <member><link linkend="xs2gif">xs2gif</link></member>
+
+ <member><link linkend="xs2jpg">xs2jpg</link></member>
+
+ <member><link linkend="xs2png">xs2png</link></member>
+
+ <member><link linkend="xs2ppm">xs2ppm</link></member>
+
+ <member><link linkend="xs2eps">xs2eps</link></member>
+
+ <member><link linkend="xs2pdf">xs2pdf</link></member>
+
+ <member><link linkend="xs2svg">xs2svg</link></member>
+
+ <member><link linkend="xs2fig">xs2fig</link></member>
+
+ <member><link linkend="xs2emf">xs2emf</link></member>
</simplelist>
</refsection>
-</refentry>
+</refentry>
\ No newline at end of file
projects / scilab.git / blobdiff