[doc] misc. fix & improvements
[scilab.git] / scilab / modules / fileio / help / fr_FR / directory / chdir.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
5  * ...
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  * Copyright (C) 2019 - Samuel GOUGEON
8  *
9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
11  * This file was originally licensed under the terms of the CeCILL v2.1,
12  * and continues to be available under such terms.
13  * For more information, see the COPYING file which you should have received
14  * along with this program.
15  *
16  -->
17 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
18           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
19           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
20           xml:lang="fr" xml:id="chdir">
21     <refnamediv>
22         <refname>chdir</refname>
23         <refpurpose>
24             change le répertoire courant de Scilab
25         </refpurpose>
26     </refnamediv>
27     <refnamediv xml:id="cd">
28         <refname>cd</refname>
29         <refpurpose>change le répertoire courant de Scilab
30         </refpurpose>
31     </refnamediv>
32     <refsynopsisdiv>
33         <title>Séquence d'appel</title>
34         <synopsis>
35             b = chdir(path)
36             realpath = cd(path)
37             cd path
38         </synopsis>
39     </refsynopsisdiv>
40     <refsection>
41         <title>Paramètres</title>
42         <variablelist>
43             <varlistentry>
44                 <term>path</term>
45                 <listitem>
46                     <para>une chaîne de caractères fournissant le chemin du
47                       répertoire. <literal>home</literal> par défaut.
48                     </para>
49                 </listitem>
50             </varlistentry>
51             <varlistentry>
52                 <term>b</term>
53                 <listitem>
54                     <para>
55                         booléen :  <constant>%t</constant> si le changement de répertoire courant
56                         a été effectué avec succès.
57                     </para>
58                 </listitem>
59             </varlistentry>
60             <varlistentry>
61                 <term>realpath</term>
62                 <listitem>
63                     <para>une chaîne de caractères, le chemin effectif après conversion
64                         (voir ci-dessous)
65                     </para>
66                 </listitem>
67             </varlistentry>
68         </variablelist>
69     </refsection>
70     <refsection>
71         <title>Description</title>
72         <para>Change le répertoire courrant de Scilab par celui donné par la
73             variable <literal>path</literal>.
74         </para>
75         <para>
76             <note>
77                 Notez que le chemin fourni est converti (constantes prédéfinis
78                 <link linkend="SCI">SCI</link>,
79                 <link linkend="SCIHOME">SCIHOME</link>,
80                 <link linkend="TMPDIR">TMPDIR</link>,
81                 <link linkend="home">home</link>, etc). Ainsi
82                 <literal>SCI/modules/fileio/macros</literal> est un chemin valide pour Unix et Windows. Si
83                 path est vide , le chemin de destination est alors "home".
84             </note>
85         </para>
86     </refsection>
87     <refsection>
88         <title>Exemples</title>
89         <programlisting role="example"><![CDATA[
90 chdir("SCI/etc")
91 pwd
92 cd ..
93 cd TMPDIR
94 p = cd()
95 p == home
96      ]]></programlisting>
97         <screen><![CDATA[
98 --> chdir("SCI/etc")
99  ans  =
100   T
101
102 --> pwd
103  ans  =
104  C:\Programs\scilab\scilab-6.0.2\etc
105
106
107 --> cd ..
108  ans  =
109  C:\Programs\scilab\scilab-6.0.2
110
111 --> cd TMPDIR
112  ans  =
113  C:\Users\Me\AppData\Local\Temp\SCI_TMP_5444_26901
114
115 --> p = cd()
116  p  =
117  C:\Users\Me
118
119 --> p == home
120  ans  =
121   T
122 ]]></screen>
123     </refsection>
124     <refsection role="see also">
125         <title>Voir aussi</title>
126         <simplelist type="inline">
127             <member>
128                 <link linkend="isdir">isdir</link>
129             </member>
130             <member>
131                 <link linkend="pwd">pwd</link>
132             </member>
133             <member>
134                 <link linkend="home">home</link>
135             </member>
136             <member>
137                 <link linkend="filebrowser">filebrowser</link>
138             </member>
139             <member>
140                 <link linkend="uigetdir">uigetdir</link>
141             </member>
142         </simplelist>
143     </refsection>
144 </refentry>