<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) ENPC - Jean-Philippe Chancelier
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<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" xmlns:scilab="http://www.scilab.org"  xml:lang="en" xml:id="xname">
    <refnamediv>
        <refname>xname</refname>
        <refpurpose>
            change the name of the current graphics window
            <emphasis role="bold">(obsolete)</emphasis>)
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>xname(name)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>name</term>
                <listitem>
                    <para>string, new name of the graphics window.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <warning>
            <literal>xname()</literal> is obsolete. It will be removed in Scilab 6.2.x.
            Please use <literal>gcf().figure_name = "New name"</literal> instead.
        </warning>
        <para>
            <function>xname</function> changes the name of the current graphics window.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
xname("Empty graphic")
x=-%pi*2:0.1:%pi*2;
plot(x,sin(x))
xname("sin(x) with x between -%pi*2 and %pi*2")
 ]]></programlisting>
    </refsection>
    <refsection role="history">
        <title>History</title>
        <revhistory>
            <revision>
                <revnumber>6.1.1</revnumber>
                <revdescription>
                    xname() declared obsolete. Replaced with gcf().figure_name="New name".
                </revdescription>
            </revision>
        </revhistory>
    </refsection>
</refentry>
