131e72b796d84b683dfce2b8ff3e85912c0a4249
[scilab.git] / scilab / modules / fileio / help / en_US / ls.xml
1 <?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
2 <!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
3 <MAN>
4   <LANGUAGE>eng</LANGUAGE>
5   <TITLE>ls</TITLE>
6   <TYPE>Scilab Function</TYPE>
7   <DATE>$LastChangedDate$</DATE>
8   <SHORT_DESCRIPTION name="ls"> show files</SHORT_DESCRIPTION>
9   <CALLING_SEQUENCE>
10     <CALLING_SEQUENCE_ITEM>ls path options</CALLING_SEQUENCE_ITEM>
11     <CALLING_SEQUENCE_ITEM>files=ls( [path] )</CALLING_SEQUENCE_ITEM>
12   </CALLING_SEQUENCE>
13   <PARAM>
14     <PARAM_INDENT>
15       <PARAM_ITEM>
16         <PARAM_NAME>path</PARAM_NAME>
17         <PARAM_DESCRIPTION>
18           <SP>: a string matrix giving a directory pathname (eventually  ended
19             by a pattern built with <VERB>*</VERB>). Default value is <VERB>.</VERB></SP>
20         </PARAM_DESCRIPTION>
21       </PARAM_ITEM>
22       <PARAM_ITEM>
23         <PARAM_NAME>files</PARAM_NAME>
24         <PARAM_DESCRIPTION>
25           <SP>: a string column vector. By default it contains a column
26             formatted output. if one of the option is
27             <VERB>'-1'</VERB>. <VERB>files</VERB> contains an entry for each
28             files</SP>
29
30         </PARAM_DESCRIPTION>
31       </PARAM_ITEM>
32     </PARAM_INDENT>
33   </PARAM>
34   <DESCRIPTION>
35     <P>
36       <VERB>ls</VERB> can be used to list the files which match 
37       the patterns given by the path argument. 
38       Patterns are given to the unix <VERB>ls</VERB> or to the windows
39       <VERB>dir</VERB> commands in order to get information on files. 
40       Thus in order to write portable Scilab script valid wildcard patterns 
41       for both os are to be given. Note that Pathname conversion is
42       performed and for example <VERB>SCI/modules/core/macros/*.sci</VERB> is a valid 
43       pattern for both unix and windows.
44     </P>
45     <P>
46       If you want to get a vector of all files matching a pattern use preferabily
47       the  <LINK>listfiles</LINK>  or the <LINK>dir</LINK>function.
48     </P>
49         <P>
50           Please note that starting from the version 5.0 of Scilab, the second 
51           input argument has been removed (<i>a sequence of strings which can 
52           be added under Unix systems: the Unix ls command options</i>). 
53           This option has been removed mainly for security and portability reasons.
54         </P>
55   </DESCRIPTION>
56   <EXAMPLE>
57     <![CDATA[
58     ls
59     ls SCI/modules/core/macros/*.sci
60     x=ls('SCI/modules/core/macros/*.sci')
61     ]]>
62   </EXAMPLE>
63   <SEE_ALSO>
64     <SEE_ALSO_ITEM>
65       <LINK>listfiles</LINK>
66     </SEE_ALSO_ITEM>
67     <SEE_ALSO_ITEM>
68       <LINK>findfiles</LINK>
69     </SEE_ALSO_ITEM>
70     <SEE_ALSO_ITEM>
71       <LINK>dir</LINK>
72     </SEE_ALSO_ITEM>
73     <SEE_ALSO_ITEM>
74       <LINK>fileinfo</LINK>
75     </SEE_ALSO_ITEM>
76   </SEE_ALSO>
77 </MAN>