[doc] misc. fix & improvements
[scilab.git] / scilab / modules / m2sci / help / en_US / translatepaths.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) ???? - INRIA - Serge STEER
5     * Copyright (C) 2002-2004 - INRIA - Vincent COUVERT
6     *
7  * Copyright (C) 2012 - 2016 - Scilab Enterprises
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="en" xml:id="translatepaths">
21     <refnamediv>
22         <refname>translatepaths</refname>
23         <refpurpose>convert a set of Matlab M-files directories to Scilab</refpurpose>
24     </refnamediv>
25     <refsynopsisdiv>
26         <title>Syntax</title>
27         <synopsis>
28           translatepaths()  // GUI
29           translatepaths(dirs_path)
30           translatepaths(dirs_path, res_path)
31         </synopsis>
32     </refsynopsisdiv>
33     <refsection>
34         <title>Arguments</title>
35         <variablelist>
36             <varlistentry>
37                 <term>dirs_path</term>
38                 <listitem>
39                     <para>
40                       a character string vector which gives the paths of Matlab M-file
41                       directories to convert.
42                     </para>
43                 </listitem>
44             </varlistentry>
45             <varlistentry>
46                 <term>res_path</term>
47                 <listitem>
48                     <para>
49                         a character string which gives the path of the directory where the
50                         Scilab functions are written to. Default value is current directory.
51                     </para>
52                 </listitem>
53             </varlistentry>
54         </variablelist>
55     </refsection>
56     <refsection>
57         <title>Description</title>
58         <para>
59             <literal>translatepaths</literal>, converts all Matlab M-file contained in a set
60             of directories to Scilab functions. Each function is converted by
61             <literal>mfile2sci</literal>.
62         </para>
63         <para>
64             Trace of conversion information is stored in a file named <literal>"log"</literal> in
65             the <literal>res_path</literal> directory
66         </para>
67         <para>
68             When called without rhs, <literal>translatepaths()</literal> launches a GUI to help
69             to select a file/directory and options.
70         </para>
71     </refsection>
72     <refsection role="see also">
73         <title>See also</title>
74         <simplelist type="inline">
75             <member>
76                 <link linkend="mfile2sci">mfile2sci</link>
77             </member>
78         </simplelist>
79     </refsection>
80 </refentry>