← 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/path_filename/fullpath.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/path_filename/fullpath.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) 2008 - INRIA - Allan CORNET
 
5
 * Copyright (C) 2011 - 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: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="fullpath">
 
15
    <refnamediv>
 
16
        <refname>fullpath</refname>
 
17
        <refpurpose>creates an full path name for the specified relative path name.</refpurpose>
 
18
    </refnamediv>
 
19
    <refsynopsisdiv>
 
20
        <title>Calling Sequence</title>
 
21
        <synopsis>res = fullpath(relative_path)</synopsis>
 
22
    </refsynopsisdiv>
 
23
    <refsection>
 
24
        <title>Arguments</title>
 
25
        <variablelist>
 
26
            <varlistentry>
 
27
                <term>res</term>
 
28
                <listitem>
 
29
                    <para>a string or matrix of string.</para>
 
30
                </listitem>
 
31
            </varlistentry>
 
32
        </variablelist>
 
33
        <variablelist>
 
34
            <varlistentry>
 
35
                <term>relative_path</term>
 
36
                <listitem>
 
37
                    <para>a string or a matrix of string.</para>
 
38
                </listitem>
 
39
            </varlistentry>
 
40
        </variablelist>
 
41
    </refsection>
 
42
    <refsection>
 
43
        <title>Description</title>
 
44
        <para>
 
45
            <code>fullpath(relative_path)</code> сreates an full path name
 
46
            for the specified relative path name.
 
47
        </para>
 
48
        <para>
 
49
            On GNU/Linux <varname>relative_path</varname> needs to exist.
 
50
        </para>
 
51
    </refsection>
 
52
    <refsection>
 
53
        <title>Examples</title>
 
54
        <programlisting role="example"><![CDATA[ 
 
55
cd(TMPDIR);
 
56
mkdir(TMPDIR + "/niv1");
 
57
mkdir(TMPDIR + "/niv1/niv2");
 
58
mkdir(TMPDIR + "/niv1/niv2/niv3");
 
59
mputl(' ', TMPDIR + "/niv1/test1.txt");
 
60
mputl(' ' , TMPDIR + "/niv1/niv2/test2.txt");
 
61
 
 
62
cd(TMPDIR + "/niv1/niv2/niv3");
 
63
 
 
64
r1 = fullpath("../../test1.txt")
 
65
r2 = fullpath("../test2.txt")
 
66
M = ["../../test1.txt", "../test2.txt"];
 
67
R = fullpath(M)
 
68
 ]]></programlisting>
 
69
    </refsection>
 
70
    <refsection>
 
71
        <title>History</title>
 
72
        <revhistory>
 
73
            <revision>
 
74
                <revnumber>5.4.0</revnumber>
 
75
                <revremark>Matrix of String managed (SEP 72)</revremark>
 
76
            </revision>
 
77
        </revhistory>
 
78
    </refsection>
 
79
</refentry>