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