← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/fileio/help/en_US/findfiles.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/fileio/help/en_US/findfiles.xml
12
12
 *
13
13
 -->
14
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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="findfiles">
15
 
  <refnamediv>
16
 
    <refname>findfiles</refname>
17
 
    <refpurpose>
18
 
      finding all files with a given file specification
19
 
    </refpurpose>
20
 
  </refnamediv>
21
 
  <refsynopsisdiv>
22
 
    <title>Calling Sequence</title>
23
 
    <synopsis>f = findfiles()
24
 
      f=findfiles(path)
25
 
      f=findfiles(path,filespec)
26
 
    </synopsis>
27
 
  </refsynopsisdiv>
28
 
  <refsection>
29
 
    <title>Arguments</title>
30
 
    <variablelist>
31
 
      <varlistentry>
32
 
        <term>path</term>
33
 
        <listitem>
34
 
          <para>a character string, a path.</para>
35
 
        </listitem>
36
 
      </varlistentry>
37
 
      <varlistentry>
38
 
        <term>filespec</term>
39
 
        <listitem>
40
 
          <para>a character stirng, a file specification, for example <literal>"*.sce"</literal>.</para>
41
 
        </listitem>
42
 
      </varlistentry>
43
 
      <varlistentry>
44
 
        <term>f</term>
45
 
        <listitem>
46
 
          <para>a column vector of strings, filenames.</para>
47
 
        </listitem>
48
 
      </varlistentry>
49
 
    </variablelist>
50
 
  </refsection>
51
 
  <refsection>
52
 
    <title>Description</title>
53
 
    <para>
54
 
      Finding all files with a given file specification
55
 
      <varname>filespec</varname>.
56
 
    </para>
57
 
  </refsection>
58
 
  <refsection>
59
 
    <title>Examples</title>
60
 
    <programlisting role="example"><![CDATA[ 
 
15
    <refnamediv>
 
16
        <refname>findfiles</refname>
 
17
        <refpurpose>
 
18
            finding all files with a given file specification
 
19
        </refpurpose>
 
20
    </refnamediv>
 
21
    <refsynopsisdiv>
 
22
        <title>Calling Sequence</title>
 
23
        <synopsis>f = findfiles()
 
24
            f = findfiles(path)
 
25
            f = findfiles(path, filespec)
 
26
        </synopsis>
 
27
    </refsynopsisdiv>
 
28
    <refsection>
 
29
        <title>Arguments</title>
 
30
        <variablelist>
 
31
            <varlistentry>
 
32
                <term>path</term>
 
33
                <listitem>
 
34
                    <para>a character string, a path.</para>
 
35
                </listitem>
 
36
            </varlistentry>
 
37
            <varlistentry>
 
38
                <term>filespec</term>
 
39
                <listitem>
 
40
                    <para>
 
41
                        a character stirng, a file specification, for example <literal>"*.sce"</literal>.
 
42
                    </para>
 
43
                </listitem>
 
44
            </varlistentry>
 
45
            <varlistentry>
 
46
                <term>f</term>
 
47
                <listitem>
 
48
                    <para>a column vector of strings, filenames.</para>
 
49
                </listitem>
 
50
            </varlistentry>
 
51
        </variablelist>
 
52
    </refsection>
 
53
    <refsection>
 
54
        <title>Description</title>
 
55
        <para>
 
56
            Finding all files with a given file specification
 
57
            <varname>filespec</varname>.
 
58
        </para>
 
59
    </refsection>
 
60
    <refsection>
 
61
        <title>Examples</title>
 
62
        <programlisting role="example"><![CDATA[ 
61
63
f=findfiles()
62
64
f=findfiles(SCI)
63
65
f=findfiles(SCI+'/modules/core/macros','*.sci') 
64
66
 ]]></programlisting>
65
 
  </refsection>
66
 
  <refsection role="see also">
67
 
    <title>See Also</title>
68
 
    <simplelist type="inline">
69
 
      <member>
70
 
        <link linkend="listfiles">listfiles</link>
71
 
      </member>
72
 
    </simplelist>
73
 
  </refsection>
 
67
    </refsection>
 
68
    <refsection role="see also">
 
69
        <title>See Also</title>
 
70
        <simplelist type="inline">
 
71
            <member>
 
72
                <link linkend="listfiles">listfiles</link>
 
73
            </member>
 
74
        </simplelist>
 
75
    </refsection>
74
76
</refentry>