Bug #10379 fixed - lines did not manage a 1x2 vector [nc, nl] as input argument.
[scilab.git] / scilab / modules / console / help / en_US / lines.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3     * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4     * Copyright (C) 2002 - INRIA
5     * Copyright (C) 2012 - DIGITEO - Allan CORNET
6     *
7     * This file must be used under the terms of the CeCILL.
8     * This source file is licensed as described in the file COPYING, which
9     * you should have received as part of this distribution.  The terms
10     * are also available at
11     * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
12     *
13     -->
14 <refentry 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" version="5.0-subset Scilab" xml:id="lines" xml:lang="en">
15   <info>
16     <pubdate>$LastChangedDate$</pubdate>
17   </info>
18   <refnamediv>
19     <refname>lines</refname>
20     <refpurpose>rows and columns used for display</refpurpose>
21   </refnamediv>
22   <refsynopsisdiv>
23     <title>Calling Sequence</title>
24     <synopsis>lines(nl)
25 lines(nl, nc)
26 lines(ncl)
27 ncl = lines()</synopsis>
28   </refsynopsisdiv>
29   <refsection>
30     <title>Arguments</title>
31     <variablelist>
32       <varlistentry>
33         <term>nl</term>
34         <listitem>
35           <para>An integer, the number of lines for vertical paging control.</para>
36           <itemizedlist>
37             <listitem>
38               <para>If 0: no vertical paging control is done.</para>
39             </listitem>
40             <listitem>
41               <para>If -1: reset vertical paging control to current size of the window.</para>
42             </listitem>
43           </itemizedlist>
44         </listitem>
45       </varlistentry>
46       <varlistentry>
47         <term>nc</term>
48         <listitem>
49           <para>An integer, the number of column of output. Used for
50           formatting output</para>
51         </listitem>
52       </varlistentry>
53       <varlistentry>
54         <term>ncl</term>
55         <listitem>
56           <para>A 1x2 vector [nc, nl]</para>
57         </listitem>
58       </varlistentry>
59     </variablelist>
60   </refsection>
61   <refsection>
62     <title>Description</title>
63     <para><literal>lines</literal> handles Scilab display paging.</para>
64     <para><literal>lines()</literal> returns the vector <literal>[# columns, #
65     rows]</literal> currently used by Scilab for displaying the
66     results.</para>
67     <para><literal>lines(nl)</literal> sets the number of displayed lines
68     (before user is asked for more) to <literal>nl</literal>.</para>
69     <para><literal>lines(0)</literal> disables vertical paging</para>
70     <para><literal>lines(nl,nc)</literal> and <literal>lines([nc,nl])</literal> changes also the size of the output
71     to <literal>nc</literal> columns.</para>
72     <para>When Scilab is launched without -nw option, the
73     <literal>lines</literal> parameters are automatically set according to the
74     output window size, these parameters are also automatically modified when
75     the window is resized.</para>
76   </refsection>
77   <refsection role="see also">
78     <title>See Also</title>
79     <simplelist type="inline">
80       <member>
81         <link linkend="disp">disp</link>
82       </member>
83       <member>
84         <link linkend="print">print</link>
85       </member>
86     </simplelist>
87   </refsection>
88   <refsection>
89     <title>History</title>
90     <revhistory>
91       <revision>
92         <revnumber>5.4.0</revnumber>
93         <revdescription>
94           <itemizedlist>
95             <listitem>lines is set by default to 0. Argument -1 added. See SEP #67 for more information.</listitem>
96             <listitem>lines manages a 1x2 vector [nc, nl] as input
97             argument</listitem>
98           </itemizedlist>
99         </revdescription>
100       </revision>
101     </revhistory>
102   </refsection>
103 </refentry>