← 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/getrelativefilename.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/getrelativefilename.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) XXXX-2008 - INRIA
5
 
 *
6
 
 * This file must be used under the terms of the CeCILL.
7
 
 * This source file is licensed as described in the file COPYING, which
8
 
 * you should have received as part of this distribution.  The terms
9
 
 * are also available at
10
 
 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11
 
 *
12
 
 -->
13
 
<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="getrelativefilename">
14
 
  <refnamediv>
15
 
    <refname>getrelativefilename</refname>
16
 
    <refpurpose>given an absolute directory and an absolute filename, returns a relative file name</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>rel_file = getrelativefilename(abs_dir,abs_file)</synopsis>
21
 
  </refsynopsisdiv>
22
 
  <refsection>
23
 
    <title>Arguments</title>
24
 
    <variablelist>
25
 
      <varlistentry>
26
 
        <term>abs_dir</term>
27
 
        <listitem>
28
 
          <para>a character string: an absolute directory.</para>
29
 
        </listitem>
30
 
      </varlistentry>
31
 
      <varlistentry>
32
 
        <term>abs_file</term>
33
 
        <listitem>
34
 
          <para>a character string: an absolute filename.</para>
35
 
        </listitem>
36
 
      </varlistentry>
37
 
      <varlistentry>
38
 
        <term>rel_file</term>
39
 
        <listitem>
40
 
          <para>a character string : relative filename.</para>
41
 
        </listitem>
42
 
      </varlistentry>
43
 
    </variablelist>
44
 
  </refsection>
45
 
  <refsection>
46
 
    <title>Description</title>
47
 
    <para>
48
 
      Given an absolute directory <varname>abs_dir</varname> and an absolute filename <varname>abs_file</varname>,  <function>getrelativefilename</function> returns a
49
 
      relative file name <varname>rel_file</varname>.
50
 
    </para>
51
 
    <para>
52
 
      For example, if the current directory is
53
 
      <literal>C:\scilab\bin</literal> and the filename
54
 
      <literal>C:\scilab\modules\helptools\readme.txt</literal> is
55
 
      given, <function>getrelativefilename</function> will return
56
 
      <literal>..\modules\helptools\readme.txt</literal>.
57
 
    </para>
58
 
  </refsection>
59
 
  <refsection>
60
 
    <title>Examples</title>
61
 
    <programlisting role="example"><![CDATA[
62
 
getrelativefilename(pwd(), SCI+'/COPYING')
63
 
getrelativefilename(TMPDIR, SCI+'/COPYING')
64
 
getrelativefilename(SCI+'/bin', SCI+'/COPYING')
65
 
getrelativefilename(pwd(), SCI+'/ACKNOLEDGMENTS')
66
 
getrelativefilename(TMPDIR, SCI+'/ACKNOLEDGMENTS')
67
 
getrelativefilename(SCI+'/bin', SCI+'/ACKNOLEDGMENTS')
68
 
 ]]></programlisting>
69
 
  </refsection>
70
 
  <refsection role="see also">
71
 
    <title>See Also</title>
72
 
    <simplelist type="inline">
73
 
      <member>
74
 
        <link linkend="getshortpathname">getshortpathname</link>
75
 
      </member>
76
 
      <member>
77
 
        <link linkend="getlongpathname">getlongpathname</link>
78
 
      </member>
79
 
      <member>
80
 
        <link linkend="pwd">pwd</link>
81
 
      </member>
82
 
    </simplelist>
83
 
  </refsection>
84
 
</refentry>