← Back to branch summary

~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/fileio/mgetl.man

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2002-03-21 16:57:43 UTC
  • Revision ID: james.westby@ubuntu.com-20020321165743-e9mv12c1tb1plztg
Tags: upstream-2.6
Import upstream version 2.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/fileio/mgetl.man
 
1
.TH mgetl 1 "April 2000" "Scilab Group" "Scilab Function"
 
2
.so ../sci.an
 
3
.SH NAME
 
4
mgetl - read lines from an ascii file
 
5
.SH CALLING SEQUENCE
 
6
.nf
 
7
txt=mgetl(file_desc [,m]) 
 
8
.fi
 
9
.SH PARAMETERS
 
10
.TP 10
 
11
file_desc
 
12
:a character string giving the file name or a logical unit returned by mopen
 
13
.TP
 
14
m
 
15
: an integer scalar. Default value is -1.
 
16
.TP 
 
17
txt
 
18
: a column vector of string
 
19
.SH DESCRIPTION
 
20
\fVmgetl\fR function allows to read a lines from an ascii file. 
 
21
.LP
 
22
If \fVm\fR is
 
23
omitted or is \fV-1\fR all lines till end of file occurs are read.
 
24
.LP
 
25
If \fVm\fR is given \fVmgetl\fR tries to read exactly m lines, if an
 
26
end of file occurs before \fVm\fR lines are read an error is
 
27
issued. This option is useful to sequentialy read part of a file
 
28
as follow
 
29
 
 
30
.LP
 
31
\fVmgetl\fR allows to read files coming from Unix, Windows, or Mac
 
32
operating systems.
 
33
 
 
34
.SH EXAMPLE
 
35
.nf
 
36
mgetl('SCI/scilab.star',5)
 
37
 
 
38
mgetl SCI/macros/elem/and.sci
 
39
 
 
40
fd=mopen('SCI/scilab.star','r')
 
41
mgetl(fd,10)
 
42
mclose(fd)
 
43
.fi
 
44
.SH SEE ALSO
 
45
mputl, mclose,  mfscanf, mget, mgetstr, mopen, read
 
46
.SH AUTHOR
 
47
S. Steer