<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2008 - INRIA
 *
 * 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="help">
    <refnamediv>
        <refname>help</refname>
        <refpurpose>on-line help command</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>help(key)
            help
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>key</term>
                <listitem>
                    <para>character string. The requested help page</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            <literal>help</literal> without argument displays the hypertext  page
            containing the list of help chapters.
        </para>
        <para>
            <literal>help(key)</literal> displays the Scilab help file associated with the
            given  <literal>key</literal>. If no help file is found, <literal>help(key)</literal>
            automatically launches a search with the <literal>key</literal> word as search arguments.
        </para>
        <para>
            See <link linkend="man">man</link> for more explanation on how to write new help
            pages .
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
help();
help plot3d
help("plot")

 ]]></programlisting>
    </refsection>

    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="apropos">apropos</link>
            </member>
            <member>
                <link linkend="man">Scilab documentation format</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
