diff options
| author | Shashank | 2017-05-29 12:40:26 +0530 |
|---|---|---|
| committer | Shashank | 2017-05-29 12:40:26 +0530 |
| commit | 0345245e860375a32c9a437c4a9d9cae807134e9 (patch) | |
| tree | ad51ecbfa7bcd3cc5f09834f1bb8c08feaa526a4 /modules/fileio/help | |
| download | scilab_for_xcos_on_cloud-0345245e860375a32c9a437c4a9d9cae807134e9.tar.gz scilab_for_xcos_on_cloud-0345245e860375a32c9a437c4a9d9cae807134e9.tar.bz2 scilab_for_xcos_on_cloud-0345245e860375a32c9a437c4a9d9cae807134e9.zip | |
CMSCOPE changed
Diffstat (limited to 'modules/fileio/help')
211 files changed, 27708 insertions, 0 deletions
diff --git a/modules/fileio/help/en_US/addchapter.sce b/modules/fileio/help/en_US/addchapter.sce new file mode 100755 index 000000000..c22115ff3 --- /dev/null +++ b/modules/fileio/help/en_US/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Files : Input/Output functions",SCI+"/modules/fileio/help/en_US",%T); + diff --git a/modules/fileio/help/en_US/copyfile.xml b/modules/fileio/help/en_US/copyfile.xml new file mode 100755 index 000000000..6b1a79000 --- /dev/null +++ b/modules/fileio/help/en_US/copyfile.xml @@ -0,0 +1,90 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="copyfile" xml:lang="en"> + <refnamediv> + <refname>copyfile</refname> + <refpurpose>copies a file</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>copyfile(source, destination) + [status, message] = copyfile(source, destination) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>source</term> + <listitem> + <para> + a character string: a filename or a directory name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>destination</term> + <listitem> + <para>a character string: a directory name. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>copyfile(source,destination)</code> copies the file or + directory <varname>source</varname> (and subdirectories) to the file or + directory <varname>destination</varname>. + </para> + <para> + If <varname>source</varname> is a directory, <varname>destination</varname> can not be a file. + <warning> + <code>copyfile</code> replaces existing files without warning. + </warning> + </para> + <para> + <code>[status, message] = copyfile(source, destination)</code> + copies <varname>source</varname> to <varname>destination</varname>, returning the <varname>status</varname> and a <varname>message</varname>. + </para> + <para> + Whatever the operating system, if the copy succeeds, the <varname>status</varname> is 1 + and the <varname>message</varname> is empty; if the copy fails, the <varname>status</varname> is 0 and the + <varname>message</varname> is not empty. + </para> + <para> + The timestamp given to the destination file is identical to that + taken from source file. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"> + copyfile(SCI+"/etc/scilab.start",TMPDIR+"/scilab.start") + [status,message] = copyfile(SCI+"/etc/scilab.start",TMPDIR); + </programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="movefile">movefile</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/deletefile.xml b/modules/fileio/help/en_US/deletefile.xml new file mode 100755 index 000000000..ad945f1b4 --- /dev/null +++ b/modules/fileio/help/en_US/deletefile.xml @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="deletefile" xml:lang="en"> + <refnamediv> + <refname>deletefile</refname> + <refpurpose>deletes a file</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>f = deletefile(filename)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>filename</term> + <listitem> + <para>a string: a file name existing or not.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>f</term> + <listitem> + <para> + a boolean: <constant>%t</constant> or <constant>%f</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + This function deletes a file <varname>filename</varname>. If file <varname>filename</varname> has been deleted, it will return <constant>%t</constant> else + <constant>%f</constant>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +fd = mopen(TMPDIR+'/filetodelete.txt','wt'); +mclose(fd); + +if (fileinfo(TMPDIR+'/filetodelete.txt') <> []) then +deletefile(TMPDIR+'/filetodelete.txt') +end + +deletefile(TMPDIR+'/notexistingfile') + ]]></programlisting> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/directory/CHAPTER b/modules/fileio/help/en_US/directory/CHAPTER new file mode 100755 index 000000000..8f46dc5e9 --- /dev/null +++ b/modules/fileio/help/en_US/directory/CHAPTER @@ -0,0 +1,2 @@ +title= Directory + diff --git a/modules/fileio/help/en_US/directory/chdir.xml b/modules/fileio/help/en_US/directory/chdir.xml new file mode 100755 index 000000000..c81d92756 --- /dev/null +++ b/modules/fileio/help/en_US/directory/chdir.xml @@ -0,0 +1,96 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="chdir"> + <refnamediv> + <refname>chdir</refname> + <refpurpose>changes Scilab current directory</refpurpose> + </refnamediv> + <refnamediv xml:id="cd"> + <refname>cd</refname> + <refpurpose>changes Scilab current directory</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>b = chdir(path) + realpath = cd(path) + cd path + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>b</term> + <listitem> + <para> + a boolean <constant>%t</constant> if <function>chdir</function> operation is ok + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>path</term> + <listitem> + <para>a character string</para> + </listitem> + </varlistentry> + <varlistentry> + <term>realpath</term> + <listitem> + <para>a character string, the real path name after pathname + conversion (see below) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Change the current Scilab directory to those given by + <varname>path</varname>. + </para> + <para> + <note> + Note that path conversion is performed and for example + <literal>SCI/modules/core/macros</literal> is a valid pattern for both Unix and Windows. + If <varname>path</varname> is empty change to "home" directory. + </note> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +chdir(TMPDIR); +pwd +cd +cd SCI + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="pwd">pwd</link> + </member> + <member> + <link linkend="SCI">SCI</link> + </member> + <member> + <link linkend="SCIHOME">SCIHOME</link> + </member> + <member> + <link linkend="TMPDIR">TMPDIR</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/directory/createdir.xml b/modules/fileio/help/en_US/directory/createdir.xml new file mode 100755 index 000000000..31e5fc6ff --- /dev/null +++ b/modules/fileio/help/en_US/directory/createdir.xml @@ -0,0 +1,82 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="createdir"> + <refnamediv> + <refname>createdir</refname> + <refpurpose>makes new directory</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>createdir(dirname) + status = createdir(dirname) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>dirname</term> + <listitem> + <para>a character string.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>status</term> + <listitem> + <para>a boolean.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>createdir(dirname)</code> creates the directory + <varname>dirname</varname> in the current + directory, if <varname>dirname</varname> is not in the current + directory, specify the relative path to the current directory or the + full path for <varname>dirname</varname>. + </para> + <para> + <code>[status] = createdir(dirname)</code> creates the directory + <varname>dirname</varname> in the existing directory, returning the + status. Here, <varname>status</varname> is <constant>%T</constant> for + success and <constant>%F</constant> otherwise. + </para> + <para> + <function>createdir</function> is used by <function>mkdir</function>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +createdir(TMPDIR+'/Directory_test') +removedir(TMPDIR+'/Directory_test') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mkdir">mkdir</link> + </member> + <member> + <link linkend="rmdir">rmdir</link> + </member> + <member> + <link linkend="removedir">removedir</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/directory/dir.xml b/modules/fileio/help/en_US/directory/dir.xml new file mode 100755 index 000000000..4b75a2c16 --- /dev/null +++ b/modules/fileio/help/en_US/directory/dir.xml @@ -0,0 +1,114 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="dir"> + <refnamediv> + <refname>dir</refname> + <refpurpose>gets file list </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>dir path + S=dir([path]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para>a string matrix giving a directory pathname (eventually ended + by a pattern built with <literal>*</literal>). Default + value is <literal>.</literal> (a dot). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>S</term> + <listitem> + <para> + a <literal>tlist</literal> of type <literal>dir</literal> with fields : + <literal>name</literal>, <literal>date</literal>, <literal>bytes</literal> and <literal>isdir</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <function>dir</function> can be used to get the files which match + the patterns given by the <varname>path</varname> argument. + Patterns are given to the Unix <command>ls</command> or to the Windows + <command>dir</command> commands in order to get information about files. + Thus in order to write portable Scilab script valid wildcard patterns + for both OS are to be given. Note that pathname conversion is + performed and for example <literal>SCI/modules/core/macros/*.sci</literal> + is a valid pattern for both Unix and Windows. + </para> + <para> + The <literal>name</literal> field of the returned variable is the column vector + of the file names. + </para> + <para> + The <literal>date</literal> field of the returned variable is the column vector + of integers containing a last modification date coded in second from 1 Jan 1970. + </para> + <para> + The <literal>bytes</literal> field of the returned variable is the column vector + of integers containing the size of the files in bytes. + </para> + <para> + The <literal>isdir</literal> field of the returned variable is the column vector + of boolean true if the corresponding name is a directory. + </para> + <para> + The default display of the returned structure is a column formatted list + of files. It can be changed redefining the function <function>%dir_p</function>. + </para> + <para> + Since Scilab 5.3.1, a trailing "/" or "\" (see <link linkend="filesep">filesep</link>) is displayed for each directory. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +dir +dir SCI/modules/core/macros/*.bin +x=dir('SCI/modules/core/macros/*.bin') +dt=getdate(x.date); +mprintf("%s: %04d-%02d-%02d %02d:%02d:%02d\n",x.name,dt(:,[1 2 6 7:9])) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="listfiles">listfiles</link> + </member> + <member> + <link linkend="findfiles">findfiles</link> + </member> + <member> + <link linkend="ls">ls</link> + </member> + <member> + <link linkend="fileinfo">fileinfo</link> + </member> + <member> + <link linkend="date">date</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/directory/isdir.xml b/modules/fileio/help/en_US/directory/isdir.xml new file mode 100755 index 000000000..426e62bc7 --- /dev/null +++ b/modules/fileio/help/en_US/directory/isdir.xml @@ -0,0 +1,73 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Serge STEER + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="isdir"> + <refnamediv> + <refname>isdir</refname> + <refpurpose>checks if argument is a directory path</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>r = isdir(path)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para>a character string or a matrix of strings: a directory pathname.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>r</term> + <listitem> + <para> + a boolean: <constant>%t</constant> if <varname>path</varname> is a path to a directory. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>r = isdir(path)</code> checks if <varname>path</varname> is a path to a directory. + </para> + </refsection> + <refsection> + <title>Reference</title> + <para> + This function is based on the C function + <function>stat</function>. The <literal>SCI</literal> and <literal>~</literal> shortcuts for Scilab directory and home directory are handled. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +isdir(TMPDIR) +isdir SCI/etc/scilab.start + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="isfile">isfile</link> + </member> + <member> + <link linkend="fileinfo">fileinfo</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/directory/ls.xml b/modules/fileio/help/en_US/directory/ls.xml new file mode 100755 index 000000000..446ccdafc --- /dev/null +++ b/modules/fileio/help/en_US/directory/ls.xml @@ -0,0 +1,99 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="ls"> + <refnamediv> + <refname>ls</refname> + <refpurpose>shows files</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + files = ls [path] + files = ls( [path] ) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para> + a string matrix giving a directory pathname (eventually ended + by a pattern built with <literal>*</literal>). Default value is <literal>.</literal> (a dot). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>files</term> + <listitem> + <para> + a string column vector. By default it contains a column + formatted output. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <function>ls</function> can be used to list the files which match + the patterns given by the <varname>path</varname> argument. + Patterns are given to the Unix <command>ls</command> or to the Windows + <command>dir</command> commands in order to get information on files. + Thus in order to write portable Scilab script valid wildcard patterns + for both OS are to be given. Note that pathname conversion is + performed and for example <literal>SCI/modules/core/macros/*.sci</literal> is a valid + pattern for both Unix and Windows. + </para> + <para> + If you want to get a vector of all files matching a pattern use preferabily + the <link linkend="listfiles">listfiles</link> or the <link linkend="dir">dir</link> function. + </para> + <para> + <note> + Please note that starting from the version 5.0 of Scilab, the second + input argument has been removed (a sequence of strings which can + be added under Unix systems: the Unix <command>ls</command> command + options). This option has been removed mainly for security and portability reasons. + </note> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +ls +ls SCI/modules/core/macros/*.sci +x=ls('SCI/modules/core/macros/*.sci') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="listfiles">listfiles</link> + </member> + <member> + <link linkend="findfiles">findfiles</link> + </member> + <member> + <link linkend="dir">dir</link> + </member> + <member> + <link linkend="fileinfo">fileinfo</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/directory/mkdir.xml b/modules/fileio/help/en_US/directory/mkdir.xml new file mode 100755 index 000000000..5c443f3b0 --- /dev/null +++ b/modules/fileio/help/en_US/directory/mkdir.xml @@ -0,0 +1,164 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mkdir" xml:lang="en"> + <refnamediv> + <refname>mkdir</refname> + <refpurpose>makes a new directory</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + mkdir(dirname) + mkdir(parentdir, dirname) + status = mkdir( ... ) + [status, msg] = mkdir( ... ) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>dirname</term> + <listitem> + <para> + a character string: a directory to create. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>parentdir</term> + <listitem> + <para> + a character string: a directory in which the new directory <varname>dirname</varname> will be created. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>status</term> + <listitem> + <para> + an integer: the status of the operation. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>msg</term> + <listitem> + <para> + a character string: a message about an error. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>mkdir(dirname)</code> creates the directory <varname>dirname</varname> in the current directory, if <varname>dirname</varname> represents a relative path. Otherwise, <varname>dirname</varname> represents an absolute path and <function>mkdir</function> attempts to create the absolute directory <varname>dirname</varname>. + </para> + <para> + <code>mkdir(parentdir, dirname)</code> creates the directory <varname>dirname</varname> in the directory <varname>parentdir</varname> (if <varname>parentdir</varname> is not existing it will be created), where <varname>parentdir</varname> is an absolute or relative pathname. + </para> + <para> + <code>[status,msg] = mkdir(parentdir, dirname)</code> creates the directory <varname>dirname</varname> in the existing directory <varname>parentdir</varname>, returning the status and the message about an error. + </para> + <para> + <informaltable border="1"> + <tr> + <td> + <varname>status</varname> + </td> + <td> + <varname>msg</varname> + </td> + </tr> + <tr> + <td> + -2 + </td> + <td> + mkdir: An error occurred: A file with the same name already exists in dirname + + </td> + </tr> + <tr> + <td> + 0 + </td> + <td> + mkdir: An error occurred: Impossible to create directory dirname + + </td> + </tr> + <tr> + <td> + 1 + </td> + + <td> + + </td> + </tr> + <tr> + <td> + 2 + </td> + <td> + mkdir: An error occurred: This directory already exists in dirname + + </td> + </tr> + </informaltable> + + </para> + <para> + Whatever the operating system, if the creating of directory + succeeds, the <varname>status</varname> is 1 and the message + <varname>msg</varname> is empty. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"> + <![CDATA[ +// Absolute pathname +mkdir(TMPDIR+"/mkdir_example_1") +status_2 = mkdir(TMPDIR+"/mkdir_example_2") +[status_3,msg_3] = mkdir(TMPDIR+"/mkdir_example_3") + +// Absolute pathname (parentdir + dirname) +[status_4,msg_4] = mkdir(TMPDIR,"mkdir_example_4") + +// Relative pathname +cd TMPDIR; +[status_5,msg_5] = mkdir("mkdir_example_5") +[status_6,msg_6] = mkdir("mkdir_example_5/mkdir_example_6") + ]]> + </programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="chdir">chdir</link> + </member> + <member> + <link linkend="dir">dir</link> + </member> + <member> + <link linkend="rmdir">rmdir</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/directory/pwd.xml b/modules/fileio/help/en_US/directory/pwd.xml new file mode 100755 index 000000000..79749a16f --- /dev/null +++ b/modules/fileio/help/en_US/directory/pwd.xml @@ -0,0 +1,36 @@ +<?xml version="1.0" encoding="UTF-8"?> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="pwd"> + <refnamediv> + <refname>pwd</refname> + <refpurpose>gets Scilab current directory</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>pwd + x = pwd() + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + <code>pwd</code> returns in <varname>ans</varname> the Scilab current directory. + <code>x = pwd()</code> returns in <varname>x</varname> the Scilab current + directory. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +pwd +x=pwd() + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="chdir">chdir</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/directory/removedir.xml b/modules/fileio/help/en_US/directory/removedir.xml new file mode 100755 index 000000000..898997e87 --- /dev/null +++ b/modules/fileio/help/en_US/directory/removedir.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="removedir"> + <refnamediv> + <refname>removedir</refname> + <refpurpose>removes a directory</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + removedir(dirname) + [status] = removedir(dirname) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>dirname</term> + <listitem> + <para>a character string.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>status</term> + <listitem> + <para>a boolean.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>removedir(dirname)</code> removes the directory <varname>dirname</varname> from the current directory. If the directory is not empty, files and subdirectories are removed. If <varname>dirname</varname> is not in the current directory, specify the relative path to the current directory or the full path for <varname>dirname</varname>. + </para> + <para> + <code>[status] = removedir(dirname)</code> removes the directory <varname>dirname</varname> and its contents from the current directory, returning the status. Here, <varname>status</varname> is <constant>%T</constant> for success and is <constant>%F</constant> for error. + </para> + <para> + <function>removedir</function> is used by <function>rmdir</function>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +createdir(SCIHOME+'/Directory_test') +removedir(SCIHOME+'/Directory_test') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="createdir">createdir</link> + </member> + <member> + <link linkend="mkdir">mkdir</link> + </member> + <member> + <link linkend="rmdir">rmdir</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/directory/rmdir.xml b/modules/fileio/help/en_US/directory/rmdir.xml new file mode 100755 index 000000000..823f02de0 --- /dev/null +++ b/modules/fileio/help/en_US/directory/rmdir.xml @@ -0,0 +1,107 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="rmdir"> + <refnamediv> + <refname>rmdir</refname> + <refpurpose>removes a directory</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + rmdir(dirname) + rmdir(dirname,'s') + [status, message] = rmdir(dirname,'s') + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>dirname</term> + <listitem> + <para>a character string.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>'s'</term> + <listitem> + <para> + a mark to remove directory <varname>dirname</varname> with + subdirectories. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>status</term> + <listitem> + <para>a boolean.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>message</term> + <listitem> + <para> + a character string: a message about an error. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>rmdir(dirname)</code> removes the directory + <varname>dirname</varname> from the current directory. If the + directory is not empty, you must use the s argument. If + <varname>dirname</varname> is not in the current directory, specify + the relative path to the current directory or the full path for + <varname>dirname</varname>. + </para> + <para> + <code>rmdir(dirname,'s')</code> removes the directory <varname>dirname</varname> and its contents from the current directory. + </para> + <para> + <code>[status, message] = rmdir(dirname,'s')</code> removes the + directory <varname>dirname</varname> and its contents from the + current directory, returning the status, and a message. Here, + <varname>status</varname> is 1 for success and is 0 for error. + </para> + <para> + Whatever the operating system, if the removing of directory + succeeds, the <varname>status</varname> is 1 and the message + <varname>message</varname> is empty. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +mkdir(SCI,'Directory') +rmdir(SCI+'/Directory') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="createdir">createdir</link> + </member> + <member> + <link linkend="mkdir">mkdir</link> + </member> + <member> + <link linkend="removedir">removedir</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/dispfiles.xml b/modules/fileio/help/en_US/dispfiles.xml new file mode 100755 index 000000000..a384461f6 --- /dev/null +++ b/modules/fileio/help/en_US/dispfiles.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Serge STEER + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="dispfiles"> + <refnamediv> + <refname>dispfiles</refname> + <refpurpose>displays opened files properties</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>dispfiles([units])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>units</term> + <listitem> + <para>a vector of integer numbers, the file's logical units. By default all opened files.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <function>dispfiles</function> displays properties of currently opened files. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +dispfiles() + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="file">file</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/fileinfo.xml b/modules/fileio/help/en_US/fileinfo.xml new file mode 100755 index 000000000..8d18b207e --- /dev/null +++ b/modules/fileio/help/en_US/fileinfo.xml @@ -0,0 +1,225 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="fileinfo" xml:lang="en"> + <refnamediv> + <refname>fileinfo</refname> + <refpurpose>provides information about a file</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>[x, ierr] = fileinfo(files)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>files</term> + <listitem> + <para>a character string or a string column vector, file + pathname. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>x</term> + <listitem> + <para>an integer vector of size 13 containing information or an + empty matrix if file does not exist. + </para> + <para> + If <varname>files</varname> is a string column vector, <varname>x</varname> will be a matrix of + size <literal>m x 13</literal>. + </para> + <para> + If a filename does not exist, it will return as output + information a line of size 13 with <constant>Nan</constant> + in each element of this line. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ierr</term> + <listitem> + <para>error indicator, 0, if no error has occurred.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>x = fileinfo(file)</code> returns: + </para> + <variablelist> + <varlistentry> + <term>x(1)</term> + <listitem> + <para>The file size</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(2)</term> + <listitem> + <para>The file mode (decimal value)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(3)</term> + <listitem> + <para>The user id</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(4)</term> + <listitem> + <para>The group id</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(5)</term> + <listitem> + <para>The device number</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(6)</term> + <listitem> + <para>The date of last data modification</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(7)</term> + <listitem> + <para>The date of last file status change</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(8)</term> + <listitem> + <para>The date of last access</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(9)</term> + <listitem> + <para>The device type (if inode device)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(10)</term> + <listitem> + <para>The blocksize for filesystem I/O (always 0 on Windows)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(11)</term> + <listitem> + <para>The number of blocks allocated (always 0 on Windows)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(12)</term> + <listitem> + <para>The inode</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(13)</term> + <listitem> + <para>The number of hard links</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>References</title> + <para> + This function is an interface to the C function <function>stat</function>. + </para> + <para> + Permissions are typically specified as octal numbers: <code>dec2oct(x(2))</code> to convert. + </para> + <para>Numeric mode is from one to four octal digits (0-7), derived by + adding up the bits with values 4, 2, and 1. Any omitted digits are assumed + to be leading zeros. The first digit selects the set user ID (4) and set + group ID (2) and sticky (1) attributes. The second digit selects + permissions for the user who owns the file: read (4), write (2), and + execute (1); the third selects permissions for other users in the file's + group, with the same values; and the fourth for other users not in the + file's group, with the same values. + </para> + <para> + So, to check permissions, it is necessary to use masks. Let us take an example: + In octal, x(2)=1664, so first digit corresponds to sticky attributes. The second + indicates that file owner has permission of writing and reading. It is the same + for other users in the file's group. Finally, others users has just right to read. + To apply a mask, it is simpler to look at this octal in binary. + So: <varname>x</varname>(2)= 1 110 110 100. + To check if the owner has write permission, we must take a look at the second triplet: 110 + and compare it with write permission 010. So, the operation is: 110 000 000 & 010 000 000. + If result is not null (it is the case here), owner has write permission. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +w = fileinfo(SCI+'/etc/scilab.start') +// file permission +dec2oct(w(2)) +// file date +getdate(w(6)) + +// Permissions +S_IWRITE = 128; // mask write permission +S_IEXEC = 64; // mask exec permission +S_IREAD = 256; // mask read permission +S_IFCHR = 8192; // mask directory permission + +// Checks write permission +if ( bitand( w(2), S_IWRITE ) <> 0) then + disp('WRITE PERMISSION on this file.'); +else + disp('NO WRITE PERMISSION on this file.'); +end +// Checks read permission +if ( bitand( w(2), S_IREAD ) <> 0) then + disp('READ PERMISSION on this file.'); +else + disp('NO READ PERMISSION on this file.'); +end + +FILES = [SCI;SCIHOME;'not_exist_file';TMPDIR] +[X,ERRS] = fileinfo(FILES) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="getdate">getdate</link> + </member> + <member> + <link linkend="file">file</link> + </member> + <member> + <link linkend="dispfiles">dispfiles</link> + </member> + <member> + <link linkend="newest">newest</link> + </member> + <member> + <link linkend="isdir">isdir</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/findfiles.xml b/modules/fileio/help/en_US/findfiles.xml new file mode 100755 index 000000000..157eb759c --- /dev/null +++ b/modules/fileio/help/en_US/findfiles.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="findfiles"> + <refnamediv> + <refname>findfiles</refname> + <refpurpose> + finding all files with a given file specification + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>f = findfiles() + f = findfiles(path) + f = findfiles(path, filespec) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para>a character string, a path.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filespec</term> + <listitem> + <para> + a character stirng, a file specification, for example <literal>"*.sce"</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>f</term> + <listitem> + <para>a column vector of strings, filenames.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Finding all files with a given file specification + <varname>filespec</varname>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +f=findfiles() +f=findfiles(SCI) +f=findfiles(SCI+'/modules/core/macros','*.sci') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="listfiles">listfiles</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/fprintfMat.xml b/modules/fileio/help/en_US/fprintfMat.xml new file mode 100755 index 000000000..0b3f6b0a0 --- /dev/null +++ b/modules/fileio/help/en_US/fprintfMat.xml @@ -0,0 +1,150 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * Copyright (C) 2010 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="fprintfMat" xml:lang="en"> + <refnamediv> + <refname>fprintfMat</refname> + <refpurpose>writes a matrix in a file</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>fprintfMat(file, M [,format,text])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>file</term> + <listitem> + <para>a string, the pathname of the file to be written</para> + </listitem> + </varlistentry> + <varlistentry> + <term>M</term> + <listitem> + <para>a matrix of real numbers</para> + </listitem> + </varlistentry> + <varlistentry> + <term>format</term> + <listitem> + <para>a character string giving the format. This is an optional + parameter, the default value is <literal>"%lf"</literal>. + </para> + <para>Supported format: + <literal>%[width].[precision]type</literal> or + <literal>%type</literal>, where: + </para> + <para> + <literal>width</literal>: an optional number that specifies the minimum number of characters output; + </para> + <para> + <literal>precision</literal>: an optional number that + specifies the maximum number of characters printed for all + or part of the output field, or the minimum number of + digits printed for integer values; + </para> + <para> + <literal>type</literal>: lf, lg, d, i, e, f, g (see <link + linkend="scanf_conversion">scanf_conversion</link> for details). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>text</term> + <listitem> + <para> + a row (column) vector of strings giving non numerical + comments stored at the beginning of the file. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The <function>fprintfMat</function> function writes a matrix in a + formated file. Each row of the matrix give a line in the file. If + <varname>text</varname> is given then the elements of + <varname>text</varname> are inserted elementwise at the beginning of the + file one element per line. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +n = 50; +a = rand(n, n, "u"); +fprintfMat(TMPDIR + "/Mat", a, "%5.2f"); +a1 = fscanfMat(TMPDIR + "/Mat"); + +// Lets we create a file Mat1 and insert a comment into it +some_comment = ["This is a comment","This the second line of the comment.","This is the third line of the comment."]; +fprintfMat(TMPDIR + "/Mat1", a, "%5.2f",some_comment); + ]]> </programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="scanf_conversion">scanf_conversion</link> + </member> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mscanf">mscanf</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/fscanfMat.xml b/modules/fileio/help/en_US/fscanfMat.xml new file mode 100755 index 000000000..5f2b243e1 --- /dev/null +++ b/modules/fileio/help/en_US/fscanfMat.xml @@ -0,0 +1,178 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * Copyright (C) 2010 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="fscanfMat" xml:lang="en"> + <refnamediv> + <refname>fscanfMat</refname> + <refpurpose>reads a matrix from a text file</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>M = fscanfMat(filename[, fmt]); + [M, text] = fscanfMat(filename [, fmt]); + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>filename</term> + <listitem> + <para> + a character string giving the name of the file to be scanned. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>fmt</term> + <listitem> + <para> + a character string giving the format. This is an optional + parameter, the default value is <literal>"%lg"</literal>. + </para> + <para> + Supported format: <literal>%[width].[precision]type</literal> or <literal>%type</literal> where: + </para> + <para> + <literal>width</literal>: optional number that specifies + the minimum number of characters output; + </para> + <para> + <literal>precision</literal>: optional number that + specifies the maximum number of characters printed for all + or part of the output field, or the minimum number of + digits printed for integer values. + </para> + <para> + <literal>type</literal>: lf, lg, d, i, e, f, g (see <link + linkend="scanf_conversion">scanf_conversion</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>M</term> + <listitem> + <para>output variable. A matrix of real numbers.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>text</term> + <listitem> + <para> + output variable. A column vector of strings. It is + comments in the beginning of the file <varname>filename</varname>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The <function>fscanfMat</function> function is used to read a real + matrix from a text file. The first non-numeric lines of the file are + returned in <varname>text</varname> if requested and all the remaining + lines must have the same number of columns (column separator are assumed + to be either white spaces or tab characters, if there are the both, white + spaces are chosen by default). The number of columns of the matrix + will follow the number of columns found in the file and the number of + lines is fetched by detecting eof in the input file. This function can be + used to read back numerical data saved with the + <function>fprintfMat</function> (default separator used is a space). + </para> + <para> + <function>fscanfMat</function> supports files encoded as ANSI/ASCII and UTF-8. + </para> + <para> + To read a CSV formated file, the <link linkend="csvRead">csvRead</link> function is recommended. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"> + fd = mopen(TMPDIR + "/Mat", "w"); + mfprintf(fd, "Some text.....\n"); + mfprintf(fd, "Some text again\n"); + a = rand(6,6); + for i = 1:6 , + for j = 1:6, mfprintf(fd, "%5.2f ", a(i,j));end; + mfprintf(fd, "\n"); + end + mclose(fd); + a1 = fscanfMat(TMPDIR + "/Mat") + + A = ones(5,5) + 0.1; + fprintfMat(TMPDIR + "/Matrix.txt", A, "%lg"); + B = fscanfMat(TMPDIR + "/Matrix.txt", "%lg"); + A == B + + C = [%nan, %inf, -%inf, 1]; + fprintfMat(TMPDIR + "/MatrixNANINF.txt", C); + D = fscanfMat(TMPDIR + '/MatrixNANINF.txt') + + </programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="scanf_conversion">scanf_conversion</link> + </member> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + <member> + <link linkend="csvRead">csvRead</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/getURL.xml b/modules/fileio/help/en_US/getURL.xml new file mode 100755 index 000000000..1223d4603 --- /dev/null +++ b/modules/fileio/help/en_US/getURL.xml @@ -0,0 +1,163 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) - S/E - Sylvestre Ledru + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xml:id="getURL" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:scilab="http://www.scilab.org" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>getURL</refname> + + <refpurpose>Download an URL (HTTP, HTTPS, FTP...) </refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + + <synopsis>filename = getURL(URL); + [filename, [content]] = getURL(URL [, targetDir [, username [, password]]]]); + [filename, [content]] = getURL(URL [, targetFile [, username [, password]]]]); + </synopsis> + </refsynopsisdiv> + + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>URL</term> + <listitem> + <para>String: An URL. Supported and tested: HTTP, HTTPS, FTP (IPv4 and IPv6)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>targetDir</term> + <listitem> + <para>String optional parameter: In which directory the file will be stored (current directory if empty)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>targetFile</term> + <listitem> + <para>String optional parameter: Where (and under which name) the file will be stored (current directory if empty)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>username</term> + <listitem> + <para>String optional parameter: Username for the websites which require authentication</para> + </listitem> + </varlistentry> + <varlistentry> + <term>password</term> + <listitem> + <para>String optional parameter: Password for the websites which require authentication</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>String: The path to the downloaded file</para> + </listitem> + </varlistentry> + <varlistentry> + <term>content</term> + <listitem> + <para>String: The content to the downloaded file</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + + <refsection> + <title>Description</title> + + <para>Download a file from an URL</para> + + <para> + getURL will download a file from a remote URL. By default, getURL will use the same name as provided in the URL. However, under some circumstances (for example, <emphasis role="italic">http://www.scilab.org/</emphasis>), the filename is not provided by the URL itself, getURL will rename the file to <emphasis role="italic">index.html</emphasis> + </para> + + <para>content contains the content of a page pointed by an URL.</para> + + <para> + This function is based on the <ulink url="http://curl.haxx.se/libcurl/">curl library</ulink>. + </para> + + <para> Username and Password can be specified for the websites which required authentication. The authentication method used is the CURLAUTH_ANY provided by CURLOPT_HTTPAUTH parameter of the libcurl library.</para> + + <para>IPv6 (and obviously IPv4) are supported out-of-the box by getURL.</para> + + <para>Proxy configuration is enabled in this version, it can be modified in the Preferences under the rubric "Internet".</para> + + <para> + The <emphasis role="italic">CURLOPT_FOLLOWLOCATION</emphasis> curl option is activated to make sure the download follow the URL. + </para> + + <para> + <literal>getURL</literal> is based on libcurl. The version of this library in the official Scilab binary has been compiled with HTTP, HTTPS, FTP and FTPS support. If Scilab has been installed through a packaging system in a distribution, it is likely that <ulink url="http://curl.haxx.se/docs/features.html">other protocols</ulink> than HTTP, HTTPS and FTPS will work. However, they have not been tested enough. + </para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example"> + + // Will download the URL and name the file maths_simulation + getURL("http://www.scilab.org/products/scilab/features/maths_simulation"); + + // Save the Scilab homepage in the current directory (and rename the file) + getURL("http://www.scilab.org","scilab_homepage.html"); + + // Download a Scilab example and execute it + myFile = getURL("http://fileexchange.scilab.org/toolboxes/contour3d/10.03/files/contour3d.sci",TMPDIR) + exec(myFile); + contour3d(); + + // Use authentication + getURL("http://httpbin.org/basic-auth/user/passwd",TMPDIR+"/testfile.html","user","passwd") + + // Needs IPv6 connectivity + getURL("http://ipv6.google.com/intl/en_com/images/srpr/logo3w.png") + + // Retrieve the content + [myFile, content] = getURL("http://fileexchange.scilab.org/toolboxes/contour3d/10.03/files/contour3d.sci",TMPDIR) + </programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="splitURL">splitURL</link> + </member> + </simplelist> + </refsection> + + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark> + Function <literal>getURL()</literal> introduced + </revremark> + </revision> + </revhistory> + </refsection> + +</refentry> diff --git a/modules/fileio/help/en_US/getmd5.xml b/modules/fileio/help/en_US/getmd5.xml new file mode 100755 index 000000000..4e1aa6cee --- /dev/null +++ b/modules/fileio/help/en_US/getmd5.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="getmd5"> + <refnamediv> + <refname>getmd5</refname> + <refpurpose>get md5 checksum</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>res = getmd5(filename) + res = getmd5(ParamString,'string') + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>res</term> + <listitem> + <para>md5 result (a string)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>filename (a string or a matrix of strings)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>ParamString</term> + <listitem> + <para>a string or a matrix of strings</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <function>getmd5</function> get md5 checksum of a file <varname>filename</varname> or a string <varname>ParamString</varname>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +getmd5('hello world','string') +getmd5(['hello' 'world'],'string') +getmd5(['hello' ; 'world'],'string') + +getmd5( SCI+'/modules/core/etc/core.start' ) +getmd5( SCI+'/modules/core/etc/'+['core.start' 'core.quit']) + ]]></programlisting> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/io.xml b/modules/fileio/help/en_US/io.xml new file mode 100755 index 000000000..95ef2bcdf --- /dev/null +++ b/modules/fileio/help/en_US/io.xml @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2009 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="percentio" xml:lang="en"> + <refnamediv> + <refname>%io</refname> + <refpurpose>a variable, which keeps standard input and standard output (file + descriptor) + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>%io(1) + %io(2) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + <code>%io(1)</code> returns standard input (file descriptor 5). + </para> + <para> + <code>%io(2)</code> returns standard output (file descriptor 6). + </para> + <para>File descriptor 0 is the standard error.</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +mfprintf(%io(2),'Scilab stdout (C)'); +mfprintf(0,'Scilab stderr (C)'); +write(%io(2),'Scilab stdout (Fortran)'); +write(0,'Scilab stderr (Fortran)'); +[units,typ,names]=file() + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="write">write</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="file">file</link> + </member> + <member> + <link linkend="dispfiles">dispfiles</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/isfile.xml b/modules/fileio/help/en_US/isfile.xml new file mode 100755 index 000000000..cd2ef060f --- /dev/null +++ b/modules/fileio/help/en_US/isfile.xml @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2009 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="isfile" xml:lang="en"> + <refnamediv> + <refname>isfile</refname> + <refpurpose>checks whether argument is an existing file</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>x = isfile(filenames)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>filenames</term> + <listitem> + <para>a character string or a string matrix.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x</term> + <listitem> + <para> + a matrix of boolean (<constant>%t</constant> if <varname>filenames</varname> are + existing files). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>x = isfile(filenames)</code> checks whether <varname>filenames</varname> is an existing file or not (a + directory is not a file). See also <link linkend="isdir">isdir</link>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"> + filenames = ls(SCI) + + x = isfile(filenames) + + isfile(SCI + '/etc') + isdir(SCI + '/etc') + </programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="fileinfo">fileinfo</link> + </member> + <member> + <link linkend="isdir">isdir</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/listfiles.xml b/modules/fileio/help/en_US/listfiles.xml new file mode 100755 index 000000000..500192171 --- /dev/null +++ b/modules/fileio/help/en_US/listfiles.xml @@ -0,0 +1,110 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="listfiles"> + <refnamediv> + <refname>listfiles</refname> + <refpurpose>list of files</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>files = listfiles(paths [, flag, flagexpand])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>paths</term> + <listitem> + <para> + a string matrix giving a set of pathnames (eventually ended by a pattern built with <literal>*</literal>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>flag, flagexpand</term> + <listitem> + <para> + boolean optional parameters (default value is <constant>%t</constant>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>files</term> + <listitem> + <para>a string matrix.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <function>listfiles</function> can be used to list the files which match + the patterns given by one of the paths entries. + Patterns are given to the Unix <command>ls</command> or to the Windows + <command>dir</command> commands in order to get information about files. + Thus in order to write portable Scilab script valid wildcard patterns + for both OS are to be given. Note that pathname conversion is + performed and for example <literal>SCI/core/macros/*.sci</literal> is a valid + pattern for both Unix and Windows. + </para> + <para> + If <varname>flag</varname> is true the pathnames given by + <varname>paths</varname> are converted according to the <code>getos() == 'Windows'</code> + value (see also <link linkend="pathconvert">pathconvert</link>). + Moreover, if <varname>flagexpand</varname> is true leading strings like + <literal>SCIHOME</literal>, <literal>SCI</literal> or + <literal>~</literal> are expanded using environment variables. + </para> + <para> + If the input argument <varname>paths</varname> is the name of a directory, the returned <varname>files</varname> + are the names relative to that directory. + </para> + <para> + If the input argument <varname>paths</varname> contains more than one element, or if it contains + a pattern (e.g. <literal>"/*"</literal>, <literal>"*.c"</literal>), the returned <varname>files</varname> are the absolute paths (i.e. + file name prepended with the name of the directory). + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"> + <![CDATA[ +files=listfiles(['SCI/modules/core/macros/*.sci';'SCI/modules/core/macros/*.bin']); + ]]> + </programlisting> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.4.0</revnumber> + <revremark>If paths is not a single string, all returned files are homogenized with the absolute path form.</revremark> + </revision> + </revhistory> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="findfiles">findfiles</link> + </member> + <member> + <link linkend="basename">basename</link> + </member> + <member> + <link linkend="pathconvert">pathconvert</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/listvarinfile.xml b/modules/fileio/help/en_US/listvarinfile.xml new file mode 100755 index 000000000..2b766b9d6 --- /dev/null +++ b/modules/fileio/help/en_US/listvarinfile.xml @@ -0,0 +1,100 @@ +<?xml version="1.0" encoding="UTF-8"?> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="listvarinfile"> + <refnamediv> + <refname>listvarinfile</refname> + <refpurpose>list of variables in a saved data file</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>listvarinfile(filename) + [names, typs, dims, vols] = listvarinfile(filename) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>filename</term> + <listitem> + <para> + a character string, the pathname of the file to be inspected. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>nams</term> + <listitem> + <para> + a matrix of strings, names of the variables saved in the file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>dims</term> + <listitem> + <para> + a list, dimensions of the variables saved in the file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>typs</term> + <listitem> + <para> + a numeric matrix, types of the variables saved in the file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>vols</term> + <listitem> + <para> + a numeric matrix, size in bytes of the variables saved in the file. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + This utility function lists "a la <link linkend="whos">whos</link>" the variables contained in + a Scilab data file produced by <link linkend="save">save</link>. + </para> + <para> + <note> + Hypermatrices are reported as plain mlists; + rationals and state-spaces are reported as plain tlists; + graphic handles are not recognized. + </note> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +a=eye(2,2); b=int16(ones(a)); c=rand(2,3,3); +save(fullfile(TMPDIR,"vals.sod"),'a','b','c') +[names,typs,dims,vols] = listvarinfile(fullfile(TMPDIR,"vals.sod")) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="whos">whos</link> + </member> + <member> + <link linkend="save">save</link> + </member> + <member> + <link linkend="load">load</link> + </member> + <member> + <link linkend="save_format">save_format</link> + </member> + <member> + <link linkend="type">type</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/maxfiles.xml b/modules/fileio/help/en_US/maxfiles.xml new file mode 100755 index 000000000..119e1a4f1 --- /dev/null +++ b/modules/fileio/help/en_US/maxfiles.xml @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="maxfiles"> + <refnamediv> + <refname>maxfiles</refname> + <refpurpose>sets the limit for the number of files a Scilab is allowed to have open simultaneously</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>r = maxfiles(newnumbermax)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>newnumbermax</term> + <listitem> + <para>an integer the new value.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>r</term> + <listitem> + <para>an integer: effective new value.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <function>maxfiles</function> sets the limit for the number of files a Scilab is allowed to have open simultaneously. + </para> + <para>Minimum : 20</para> + <para>Maximum : 100</para> + <para>Default : 20</para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +r = maxfiles(50); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mopen">mopen</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/mclearerr.xml b/modules/fileio/help/en_US/mclearerr.xml new file mode 100755 index 000000000..e5ff6275b --- /dev/null +++ b/modules/fileio/help/en_US/mclearerr.xml @@ -0,0 +1,80 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="mclearerr"> + <refnamediv> + <refname>mclearerr</refname> + <refpurpose>resets binary file access errors</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>mclearerr([fd])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>fd</term> + <listitem> + <para> + a scalar: the <varname>fd</varname> parameter returned by the + function <function>mopen</function>. -1 stands for last opened + file. Default value is -1. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The function <function>mclearerr</function> is used to reset the error + indicator and EOF indicator to zero. + </para> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="merror">merror</link> + </member> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/mclose.xml b/modules/fileio/help/en_US/mclose.xml new file mode 100755 index 000000000..2c8a8a3a4 --- /dev/null +++ b/modules/fileio/help/en_US/mclose.xml @@ -0,0 +1,131 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="mclose"> + <refnamediv> + <refname>mclose</refname> + <refpurpose>closes an opened file</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + err = mclose([fd]) + mclose('all') + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>fd</term> + <listitem> + <para> + a scalar: the <varname>fd</varname> parameter returned by the function <function>mopen</function> is used as a file descriptor. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>err</term> + <listitem> + <para>a scalar: an error indicator.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <function>mclose</function> must be used to close a file opened by + <function>mopen</function>. If <varname>fd</varname> is omitted + <function>mclose</function> closes the last opend file. + </para> + <para> + <code>mclose('all')</code> closes all files opened by + <code>file('open',..)</code> or <function>mopen</function>. + <caution> + Be careful with this use of <function>mclose</function> because when + it is used inside a Scilab script file, it also closes the script and + Scilab will not execute commands written after + <code>mclose('all')</code>. + </caution> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +fd = mopen(TMPDIR + filesep() + 'mclose_tst','wt'); +mclose(TMPDIR + filesep() + 'mclose_tst'); + +fd=mopen('SCI/etc/scilab.start','r') +mgetl(fd,10) +mclose(fd) + ]]></programlisting> + </refsection> + + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetl">mgetl</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputl">mputl</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="file">file</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/mdelete.xml b/modules/fileio/help/en_US/mdelete.xml new file mode 100755 index 000000000..f994f690f --- /dev/null +++ b/modules/fileio/help/en_US/mdelete.xml @@ -0,0 +1,109 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="mdelete"> + <refnamediv> + <refname>mdelete</refname> + <refpurpose>deletes file(s)</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>mdelete(filename)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>filename</term> + <listitem> + <para> + a character string: the pathname of the file(s) to delete. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <function>mdelete</function> may be used to delete a file or a set of files if + <varname>filename</varname> contains meta-characters. + </para> + <para> + <caution> + Note that <function>mdelete</function> does not ask for confirmation + when you enter the delete command. + To avoid accidentally losing files, make sure that you have + accurately specified the items you want deleted. + </caution> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +r = mputl('I am a dummy String', TMPDIR+'/dummyFile.dummy'); +mdelete(TMPDIR+"/dummyFile.dummy"); + ]]></programlisting> + </refsection> + + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mscanf">mscanf</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/meof.xml b/modules/fileio/help/en_US/meof.xml new file mode 100755 index 000000000..1ba59a0cc --- /dev/null +++ b/modules/fileio/help/en_US/meof.xml @@ -0,0 +1,124 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="meof"> + <refnamediv> + <refname>meof</refname> + <refpurpose>checks if end of file has been reached</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>err=meof(fd)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>fd</term> + <listitem> + <para> + a scalar: the <varname>fd</varname> parameter returned by the function <function>mopen</function>. -1 stands for last opened file. Default value is -1. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>err</term> + <listitem> + <para>a scalar: an error indicator.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The function <function>meof</function> will return a non null value if + end of file has been reached in a previous call to + <function>mget</function> or <function>mgetstr</function>. The function + <function>mclearerr</function> is used to reset the error flag and EOF + flag to zero. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ + +// Write a temporary file with some text in it +this_file = pathconvert(TMPDIR+"/mputstr.txt", %F); + +fd = mopen(this_file, "wt"); +mputstr("Scilab is a numerical computing software.", fd); +mclose(fd); + +fd = mopen(this_file,'rt'); +i = 0; +while ~meof(fd) do + mfscanf(1, fd, "%c"); + i = i + 1; +end + +mclose(fd); + +disp("Scilab has found " + string(i) + " chars in the file"); + + ]]></programlisting> + </refsection> + + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/merror.xml b/modules/fileio/help/en_US/merror.xml new file mode 100755 index 000000000..aaa9d2b8e --- /dev/null +++ b/modules/fileio/help/en_US/merror.xml @@ -0,0 +1,120 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * Copyright (C) 2009 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="merror" xml:lang="en"> + <refnamediv> + <refname>merror</refname> + <refpurpose>tests the file access errors indicator</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + err = merror([fd]) + [err, msg] = merror([fd]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>fd</term> + <listitem> + <para> + a scalar: the <varname>fd</varname> parameter returned by the + function <function>mopen</function> is used as a file descriptor + (it's a positive integer). -1 stands for last opened file. The + default value is -1. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>err</term> + <listitem> + <para>a scalar: an error status number of the most + recent file I/O operation associated with the specified file. + </para> + <para> + If the most recent I/O operation performed on the specified + file was successful, the value of <varname>msg</varname> is empty + and <function>merror</function> returns an <varname>err</varname> + value of 0. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>msg</term> + <listitem> + <para>a string: an error string message.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The function <function>merror</function> is used to test the file + access errors indicator returning non-zero if it is set. The error + indicator can only be reset by the <function>mclearerr</function> + function. + </para> + <para> + A nonzero <varname>err</varname> indicates that an error occurred in the most recent file I/O operation. The value of message is a string that can contain information about the nature of the error. If the message is not helpful, consult the C run-time library manual for your host operating system for further details. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +fd = mopen(TMPDIR +'/filetxt.txt','wt'); +[err,msg] = merror(fd) +if (err <> 0) then + mprintf('Problem\n'); +end +mclose(fd); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mclearerr">mclearerr</link> + </member> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/mfprintf.xml b/modules/fileio/help/en_US/mfprintf.xml new file mode 100755 index 000000000..3a52b023e --- /dev/null +++ b/modules/fileio/help/en_US/mfprintf.xml @@ -0,0 +1,173 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mfprintf" xml:lang="en"> + <refnamediv> + <refname>mfprintf</refname> + <refpurpose>converts, formats, and writes data to a file</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>mfprintf(fd, format, a1, ..., an);</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>fd</term> + <listitem> + <para> + a scalar, file descriptor given by <function>mopen</function> + (it's a positive integer). + </para> + <para> + If <varname>fd</varname> equals 0 redirection in stderr. + </para> + <para> + If <varname>fd</varname> equals 6 redirection in stdout. + </para> + <para> + OBSOLETE: The value <literal>-1</literal> refers to the + default file (i.e the last opened file). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>format</term> + <listitem> + <para> + a Scilab string describing the format to use to write the + remaining operands. The + <varname> + format + </varname> + operand follows, + as close as possible, the C + <function> + printf + </function> + format + operand syntax. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>str</term> + <listitem> + <para>a character string: a string to be scanned.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>a1, ..., an</term> + <listitem> + <para> + the data to be converted and printed according to + the format parameter. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The <function>mfprintf</function> function is a interface for C-coded + version of <function>fprintf</function> function. + </para> + <para> + The <function>mfprintf</function> function writes formatted operands + to the file specified by the file desciptor <varname>fd</varname>. The + argument operands are formatted under control of the + <varname>format</varname> operand. + </para> + <para> + This function may be used to output column vectors of numbers + and string vectors without an explicit loop on the elements. In that + case this function iterates on the rows. The shortest vector gives the + number of time the format has to be iterated. + </para> + <para> + An homogeneous sequence of identical type parameters can be replaced + by a matrix. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ + +fd = mopen(TMPDIR+'/text.txt','wt'); +mfprintf(fd,'hello %s %d.\n','world',1); +mfprintf(fd,'hello %s %d.\n','scilab',2); +mfprintf(fd,'This line is built with a column vector (26:28) %d.\n',[26:28].'); +mfprintf(fd,'This line is built with a row vector (26:28) %d.\n',[26:28]); +A = rand(3,6); +mfprintf(fd,'This line is built with a matrix %.3f.\n',A); +mclose(fd); +if (isdef('editor') | (funptr('editor')<>0)) then + editor(TMPDIR+'/text.txt') +end +mfprintf(0,'stderr output.\n'); +mfprintf(6,'stdout output.\n'); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + <member> + <link linkend="printf_conversion">printf_conversion</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/mfscanf.xml b/modules/fileio/help/en_US/mfscanf.xml new file mode 100755 index 000000000..f41578f7e --- /dev/null +++ b/modules/fileio/help/en_US/mfscanf.xml @@ -0,0 +1,260 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mfscanf" xml:lang="en"> + <refnamediv> + <refname>mfscanf</refname> + <refpurpose> + reads input from the stream pointer stream (interface to the C + fscanf function) + </refpurpose> + </refnamediv> + <refnamediv xml:id="mscanf"> + <refname>mscanf</refname> + <refpurpose> + reads input from the standard input (interface to the C scanf + function) + </refpurpose> + </refnamediv> + <refnamediv xml:id="msscanf"> + <refname>msscanf</refname> + <refpurpose>reads its input from the character string (interface to the C + sscanf function) + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + [n, v_1,..., v_m] = mfscanf([niter,]fd, format) + L = mfscanf([niter,] fd,format) + + [n, v_1,..., v_m] = mscanf([niter,] format) + L = mscanf([niter,]format) + + [n, v_1,..., v_m] = msscanf([niter,]str, format) + L = msscanf([niter,] str, format) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>format</term> + <listitem> + <para> + a Scilab string describing the format to use to write the + remaining operands. The <varname>format</varname> operand + follows, as close as possible, the C <function>printf</function> + format operand syntax as described in + <link linkend="scanf_conversion">scanf_conversion</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>fd</term> + <listitem> + <para> + a positive integer: a file descriptor returned by the function + <function>mopen</function>. The value -1 refers to the last + opened file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>str</term> + <listitem> + <para>a Scilab string or string vector.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>niter</term> + <listitem> + <para> + an integer: the number of times the + <varname>format</varname> + to be used. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>n</term> + <listitem> + <para>an integer: the number of data read or -1 if EOL has been + encountered before any datum has been read. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>v_i</term> + <listitem> + <para> + Each function reads characters, interprets them according to a + <varname>format</varname>, and stores the results in its output + arguments. If more than <varname>n</varname> output arguments are + provided, the last ones <varname>v_n+1, ..., v_m</varname> are + set to empty matrices. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>L</term> + <listitem> + <para> + if all data are homogeneous they are stored in a unique vector + which is returned, otherwise subsequences of same data type are + stored in matrices and a <literal>mlist</literal> (with type + <literal>cblock</literal>) containing all the built matrices is + returned. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The <function>mfscanf</function> function reads characters from the + stream <varname>fd</varname>. + </para> + <para> + The <function>mscanf</function> function reads characters from Scilab + window. + </para> + <para> + The <function>msscanf</function> function reads characters from the + Scilab string <varname>str</varname>. + </para> + <para> + The <varname>niter</varname> optional argument specifies how many + time the format has to used. One iteration produces one line in the output + matrix. If <code>niter==-1</code> the function iterates up to the + end of file. The <varname>niter</varname> default value is 1. + </para> + <para>Comments about precision:</para> + <para> + <function>mfscanf</function> is based on C function + <function>fscanf</function>. If you use <literal>'%f'</literal>, + <literal>'%g'</literal>, <literal>'%e'</literal> as format your data + will be cast to float and returned in a Scilab variable. + </para> + <para> + If this Scilab variable is a double then you can have some precision + errors. In this case, it is better to use <literal>'%lg'</literal> format. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +//---------------------------------------------------------- +//-- Simple use -- +//---------------------------------------------------------- +s='1 1.3' //a string +[n,a,b]=msscanf(s,"%i %e") +L=msscanf(s,"%i %e") + +//---------------------------------------------------------- +//-- Formats samples -- +//---------------------------------------------------------- + +msscanf(" 12\n",'%c%c%c%c') //scan characters + +msscanf('0xabc','%x') //scan with hexadecimal format + +msscanf('012345abczoo','%[0-9abc]%s') //[] notation + +// reading float and double +msscanf('4345.988','%g')-4345.988 // scan as a float +msscanf('4345.988','%lg')-4345.988 // scan as a double + +//---------------------------------------------------------- +//-- scanning multi-line data files -- +//---------------------------------------------------------- +//create a file with data +u=mopen(TMPDIR+'/foo','w'); +t=(0:0.1:%pi)';mfprintf(u,"%6.3f %6.3f\n",t,sin(t)) +mclose(u); + +u=mopen(TMPDIR+'/foo','r'); // open the file for reading +//read the file line by line +[n,a,b]=mfscanf(u,'%e %e') //first line using multiple LHS syntax +l=mfscanf(u,'%e %e') //second one using single LHS syntax +//use niter to read 5 more lines +l=mfscanf(5,u,'%e %e') + +//use niter=-1 to read up to the end of file +l=mfscanf(-1,u,'%e %e') + +mclose(u); //close the file + +//---------------------------------------------------------- +//-- scanning multi-line strings vectors -- +//---------------------------------------------------------- +//use niter to scan a string vector +[n,Names,Ages]=msscanf(-1,["Alain 19";"Pierre 15";"Tom 12"],'%s %d') +D=msscanf(-1,["Alain 19";"Pierre 15";"Tom 12"],'%s %d') +typeof(D) +Names=D(:,1) //strings +Age=D(:,2) //numerical values + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + <member> + <link linkend="scanf_conversion">scanf_conversion</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/mget.xml b/modules/fileio/help/en_US/mget.xml new file mode 100755 index 000000000..08029e57e --- /dev/null +++ b/modules/fileio/help/en_US/mget.xml @@ -0,0 +1,258 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mget" xml:lang="en"> + <refnamediv> + <refname>mget</refname> + <refpurpose>reads byte or word in a given binary format and converts to + a double type + </refpurpose> + </refnamediv> + <refnamediv xml:id="mgeti"> + <refname>mgeti</refname> + <refpurpose> + reads byte or word in a given binary format and returns an int type + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + x = mget([n, type, fd]) + x = mgeti([n, type, fd]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>n</term> + <listitem> + <para>a positive integer scalar: the number of items to be read.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>fd</term> + <listitem> + <para> + a scalar: a file descriptor returned by the function <function>mopen</function>. <literal>-1</literal> + stands for last opened file. Default value is + <literal>-1</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>type</term> + <listitem> + <para> + a string: the binary format used to write all the entries of + <varname>x</varname>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>x</term> + <listitem> + <para>a vector of floating point or integer numbers.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The <function>mget</function> function reads data in the input + specified by the stream parameter <varname>fd</varname> and returns a + vector of floating point data. + </para> + + <para> + The <function>mgeti</function> function reads data in the input + specified by the stream parameter <varname>fd</varname> and returns a + vector of integer data. + </para> + <para> + Data is read at the position at which the file pointer is currently + pointing and advances the indicator appropriately. + </para> + <para> + The <varname>type</varname> parameter is a conversion specifier + which may be set to any of the following flag characters (with default + value <literal>"l"</literal>): + </para> + <para> + <note> + On Windows, default behavior is to skip byte 13 (<literal>0x0D</literal>). + <function>mopen</function> should be called with the + <literal>'b'</literal> option, e.g. + <code>fd1 = mopen(file1,'rb')</code>, so that all bytes will be read + without exception. + </note> + </para> + <para>Data type:</para> + <variablelist> + <varlistentry> + <term>d</term> + <listitem> + <para>double</para> + </listitem> + </varlistentry> + <varlistentry> + <term>f</term> + <listitem> + <para>float</para> + </listitem> + </varlistentry> + <varlistentry> + <term>l</term> + <listitem> + <para>long long int</para> + </listitem> + </varlistentry> + <varlistentry> + <term>i</term> + <listitem> + <para>int or long int</para> + </listitem> + </varlistentry> + <varlistentry> + <term>s</term> + <listitem> + <para>short</para> + </listitem> + </varlistentry> + <varlistentry> + <term>c</term> + <listitem> + <para>character</para> + </listitem> + </varlistentry> + </variablelist> + <para>Optional flag:</para> + <variablelist> + <varlistentry> + <term>u..</term> + <listitem> + <para>unsigned (in combination with one of the above types)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>..l</term> + <listitem> + <para> + little endian (in combination with one of the above types) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>..b</term> + <listitem> + <para> + big endian (in combination with one of the above types) + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + Bytes read is automatically swapped if necessary (by checking + <literal>little=endian</literal> status). + </para> + <para> + This default swapping behavior can be suprressed by adding a flag in + the <function>mopen</function> function. + </para> + <para> + Formats <literal>"l"</literal>, <literal>"d"</literal> and + <literal>"f"</literal> are only valid with the + <function>mget</function> function. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +file1 = fullfile(TMPDIR,'test1.bin'); +file2 = fullfile(TMPDIR,'test2.bin'); +fd1=mopen(file1,'wb'); +fd2=mopen(file2,'wb'); +mput(1996,'ull',fd1); +mput(1996,'ull',fd2); +mclose(fd1); +mclose(fd2); + +fd1=mopen(file1,'rb'); +if 1996<>mget(1,'ull',fd1) + write(%io(2),'Bug'); +end + +fd2=mopen(file2,'rb'); +if 1996<>mget(1,'ull',fd2) + write(%io(2),'Bug'); +end + +mclose(fd1); +mclose(fd2); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mgetl">mgetl</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputl">mputl</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/mgetl.xml b/modules/fileio/help/en_US/mgetl.xml new file mode 100755 index 000000000..a60664261 --- /dev/null +++ b/modules/fileio/help/en_US/mgetl.xml @@ -0,0 +1,115 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Serge STEER + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="mgetl"> + <refnamediv> + <refname>mgetl</refname> + <refpurpose>reads lines from an text file</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>txt = mgetl(file_desc [,m])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>file_desc</term> + <listitem> + <para> + a character string giving the file name or an integer giving a logical unit returned by <function>mopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>m</term> + <listitem> + <para> + an integer scalar: a number of lines to read. Default value is -1. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>txt</term> + <listitem> + <para>a column vector of strings.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <function>mgetl</function> function allows to read a lines from an text file. + </para> + <para> + If <varname>m</varname> is omitted or is <literal>-1</literal> all lines till end of file occurs are read. + </para> + <para> + If <varname>m</varname> is given <function>mgetl</function> tries to + read exactly <varname>m</varname> lines. This option is useful to + sequentialy read part of a file. In this case if an end of file (EOF) + occurs before <varname>m</varname> lines are read the read lines are + returned (it is possible to check if EOF had occurred using the + <function>meof</function> function) issued. + </para> + <para> + <function>mgetl</function> allows to read files coming from Unix, + Windows or Mac operating systems. + </para> + <para> + <function>mgetl</function> supports only UTF-8 and ANSI file encoding. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +mgetl('SCI/etc/scilab.start',5) + +mgetl SCI/modules/elementary_functions/macros/erf.sci + +fd=mopen('SCI/etc/scilab.start','r') +mgetl(fd,10) +mclose(fd) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mputl">mputl</link> + </member> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="read">read</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/mgetstr.xml b/modules/fileio/help/en_US/mgetstr.xml new file mode 100755 index 000000000..c1d7d9da4 --- /dev/null +++ b/modules/fileio/help/en_US/mgetstr.xml @@ -0,0 +1,135 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * Copyright (C) 2010 - Digiteo - Vincent LIARD + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mgetstr" xml:lang="en"> + <refnamediv> + <refname>mgetstr</refname> + <refpurpose>reads a character string from a file</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>str = mgetstr(n, [fd])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>n</term> + <listitem> + <para>non-negative integer: how many characters should be + read. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>fd</term> + <listitem> + <para> + an integer: file descriptor as returned by + <link linkend="mopen">mopen</link>: where characters should be read. The value <literal>-1</literal> stands for the last opened file and is the default. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>str</term> + <listitem> + <para>the character string to be read.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The <function>mgetstr</function> function attempts to read up + to <varname>n</varname> characters from a file. If end of file is + reached before <varname>n</varname> characters are read, + <function>mgetstr</function> returns the properly read values + only. As a consequence, when the read cursor is already at the end + of the file when <function>mgetstr</function> is called, it returns + an empty string no matter what value is provided for + <varname>n</varname>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ + fn = SCI + '/ACKNOWLEDGEMENTS'; // absolute path to some file + details = fileinfo(fn); // retrieve file details + len = details(1); // get file length + fd = mopen(fn, 'rt'); // open file as text with read mode + str1 = mgetstr(33, fd) // read 33 characters from fd + length(str1) // 33 characters read + str2 = mgetstr(272, fd) // read the next 272 characters from fd + length(str2) // 272 characters read + mseek(len - 5); // jump to the 5th character before end of file + str3 = mgetstr(10, fd) // try to read 10 characters: returns 5 characters only, no more available + length(str3) // yes, there are 5 characters: you just can't see the linefeed :) + str4 = mgetstr(10, fd) // read 10 characters: returns empty string + length(str4) // empty string + mclose(fd); // close file descriptor + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + <member>"Input/Output functions" section</member> + <!-- TODO: link to "Input/Output functions" index page --> + <!-- next link does not work when reading doc in scilab --> + <!-- <member><link linkend="section_efa4cbf5c15e166f34901f827390e756">Input/Output functions</link></member> --> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/mopen.xml b/modules/fileio/help/en_US/mopen.xml new file mode 100755 index 000000000..f8efdd53f --- /dev/null +++ b/modules/fileio/help/en_US/mopen.xml @@ -0,0 +1,324 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * Copyright (C) 2011 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mopen" xml:lang="en"> + <refnamediv> + <refname>mopen</refname> + <refpurpose>opens a file in Scilab</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>[fd, err] = mopen(file [, mode, swap ])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>file</term> + <listitem> + <para>a character string containing the path of the file to open.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>mode</term> + <listitem> + <para>a character string specifying the access mode requested for the file.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>swap</term> + <listitem> + <para> + a scalar. If <varname>swap</varname> is present and + <code>swap = 0</code> then automatic bytes swap is + disabled. + </para> + <para>The default value is 1.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>err</term> + <listitem> + <para>a scalar. Error indicator.</para> + <informaltable border="1"> + <tr> + <td>error value:</td> + <td>error message:</td> + </tr> + <tr> + <td>0</td> + <td>No error</td> + </tr> + <tr> + <td>-1</td> + <td>no more logical units</td> + </tr> + <tr> + <td>-2</td> + <td>cannot open file</td> + </tr> + <tr> + <td>-3</td> + <td>no more memory</td> + </tr> + <tr> + <td>-4</td> + <td>invalid name</td> + </tr> + <tr> + <td>-5</td> + <td>invalid status</td> + </tr> + </informaltable> + </listitem> + </varlistentry> + <varlistentry> + <term>fd</term> + <listitem> + <para> + a scalar: a file descriptor (it's a positive integer). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <function>mopen</function> may be used to open a <varname>file</varname> in a way + compatible with the C <function>fopen</function> procedure. Without + <varname>swap</varname> argument the <varname>file</varname> is supposed to be coded in "little endian IEEE + format" and data are swapped if necessary to match the IEEE format of + the processor. + </para> + <para> + The <varname>mode</varname> parameter controls the access type requested for + the stream. The parameter can have one of the following values: + <variablelist> + <varlistentry> + <term>r</term> + <listitem> + <para>opens for reading (default). The file must exist, otherwise it fails.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>w</term> + <listitem> + <para>opens for writing. If the file exists, its contents are destroyed.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>a</term> + <listitem> + <para>opens for appending. It creates the file if it does not exist.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>r+</term> + <listitem> + <para>opens for both reading and writing. The file must exist, otherwise it fails.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>w+</term> + <listitem> + <para>opens for both reading and writing. If the file exists, its contents are destroyed.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>a+</term> + <listitem> + <para>opens for both reading and appending. It creates the file if it does not exist.</para> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + In addition, the following characters can be used to specify the type of file: + <variablelist> + <varlistentry> + <term>t</term> + <listitem> + <para>text file.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>binary file (default).</para> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + The default access mode is <literal>'rb'</literal> (binary + file reading). + </para> + <para> + <note> + Note: on Windows, in text file mode, CR (carriage + return) - LF (linefeed) combinations are translated into + LF on reading, and LF are translated to CR-LF + combinations on writing. + </note> + </para> + <para> + When you open a file for update, you can perform both input and output + operations on the resulting stream. However, an output operation cannot + be directly followed by an input operation without a file-positioning + operation (<function>mseek</function> function). Also, an input + operation cannot be directly followed by an output operation without an + intervening file positioning operation, unless the input operation + encounters the end of the file. + </para> + <para> + When you open a file for append (that is, when the + <varname>mode</varname> parameter is <literal>a</literal> or + <literal>a+</literal>), it is impossible to overwrite information + already in the file. You can use the <function>mseek</function> + function to reposition the file pointer to any position in the file, + but when output is written to the file, the current file pointer is + ignored. All output is written at the end of the file and the file + pointer is repositioned to the end of the output. + </para> + <para> + To open files in a way compatible with Fortran-like functions use function <function>file</function>. + </para> + </refsection> + <refsection> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// open a SCI+'/ACKNOWLEDGEMENTS' as text and read only +fd_r = mopen(SCI+'/ACKNOWLEDGEMENTS', 'rt') + +// read five lines of fd_r +mgetl(fd_r, 5) + +// another way to read file +// here read five words +mfscanf(5, fd_r, '%s') + +// close file descriptor associated to SCI+'/ACKNOWLEDGEMENTS' as text and read only +mclose(fd_r); + ]]></programlisting> + </refsection> + <refsection> + </refsection> + <refsection> + <programlisting role="example"><![CDATA[ +// open a file as text with write property +fd_w = mopen(TMPDIR+'/write.txt', 'wt'); + +// write a line in fd_w +mputl('This is a line of text', fd_w); +mclose(fd_w); + +// read text +fd_r2 = mopen(TMPDIR+'/write.txt', 'rt'); +mgetl(fd_r2) +mclose(fd_r2); + ]]></programlisting> + </refsection> + <refsection> + </refsection> + <refsection> + <programlisting role="example"><![CDATA[ +// read/write a file as binary + +// first we write file +fd_wb = mopen(TMPDIR+'/writeread.bin', 'wb') + +// put values as binary +mput(2003, 'l', fd_wb); +mput(2008, 'i', fd_wb); +mput(2012, 's', fd_wb); +mput(98, 'c', fd_wb); + +// close file descriptor associated to TMPDIR+'/writeread.bin' +mclose(fd_wb); + +// we read file +fd_rb = mopen(TMPDIR+'/writeread.bin', 'rb') + +mget(fd_rb, 'l') +mget(fd_rb, 'i') +mget(fd_rb, 's') +mget(fd_rb, 'c') + +mclose(fd_rb) + ]]></programlisting> + </refsection> + <refsection> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="file">file</link> + </member> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="merror">merror</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetl">mgetl</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputl">mputl</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/movefile.xml b/modules/fileio/help/en_US/movefile.xml new file mode 100755 index 000000000..44013df9d --- /dev/null +++ b/modules/fileio/help/en_US/movefile.xml @@ -0,0 +1,101 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2009 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="movefile" xml:lang="en"> + <refnamediv> + <refname>movefile</refname> + <refpurpose>moves file or directory</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>movefile(source, destination) + [status, message] = movefile(source, destination) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>source</term> + <listitem> + <para> + a character string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>destination</term> + <listitem> + <para> + a character string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>status</term> + <listitem> + <para> + an integer: the status of the operation. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>message</term> + <listitem> + <para> + a character string: a message about an error. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + + <refsection> + <title>Description</title> + <para> + <code>movefile(source, destination)</code> moves the file or directory + <varname>source</varname> (and subdirectories) to the file or directory + <varname>destination</varname>. + </para> + <para> + If <varname>source</varname> is a directory, <varname>destination</varname> cannot be a file. + <warning> + <function>movefile</function> replaces existing files without + warning. + </warning> + </para> + <para> + <code>[status, message] = movefile(source, destination)</code> moves <varname>source</varname> to <varname>destination</varname>, returning the <varname>status</varname> and a <varname>message</varname>. + </para> + <para> + Whatever the operating system, if the move succeeds, the + <varname>status</varname> is 1 and the <varname>message</varname> is + empty; if the move fails, the <varname>status</varname> is 0 and the + <varname>message</varname> is not empty. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ + copyfile(SCI+"/etc/scilab.start",TMPDIR+"/scilab.start") + [status,message] = movefile(TMPDIR+"/scilab.start",TMPDIR+"/renamed_scilab.start") + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="copyfile">copyfile</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/mput.xml b/modules/fileio/help/en_US/mput.xml new file mode 100755 index 000000000..9fe4160ad --- /dev/null +++ b/modules/fileio/help/en_US/mput.xml @@ -0,0 +1,176 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="mput"> + <refnamediv> + <refname>mput</refname> + <refpurpose>writes byte or word in a given binary format</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>mput(x [, type, fd])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para>a vector of floating point or integer type numbers</para> + </listitem> + </varlistentry> + <varlistentry> + <term>fd</term> + <listitem> + <para> + a scalar: a file descriptor returned by the function <function>mopen</function>. <literal>-1</literal> + stands for last opened file. Default value is + <literal>-1</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>type</term> + <listitem> + <para> + a string: the binary format used to write all the entries of <varname>x</varname>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The <function>mput</function> function writes data to the output specified by the + stream parameter <varname>fd</varname>. Data is written at the + position at which the file pointer is currently pointing and + advances the indicator appropriately. + </para> + <para> + The <varname>type</varname> parameter is a conversion specifier which may be set to any of the + following flag characters (with default value <literal>"l"</literal>): + </para> + <variablelist> + <varlistentry> + <term>"l", "i", "s", "ul", "ui", "us", "d", "f", "c", "uc"</term> + <listitem> + <para> + for writing respectively a long long, an int (long + int), a short, an unsigned long long int, an unsigned int (long int), an unsigned short, a double, a float, a char and an unsigned char. The bytes which are wrote are automatically swapped if necessary (by checking little-endian status) in order to produce machine independent binary files (in little-endian mode). This default swapping mode can be suppressed by adding a flag <code>swap = 0</code> in the <function>mopen</function> function. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"..l" or "..b"</term> + <listitem> + <para> + It is also possible to write in little-endian or big-endian + mode by adding a <literal>"l"</literal> or + <literal>"b"</literal> character at the end of a + <varname>type</varname> specification. For example + <literal>"db"</literal> will write a double in big-endian mode. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +filen = 'test.bin'; +mopen(filen,'wb'); +mput(1996,'l');mput(1996,'i');mput(1996,'s');mput(98,'c'); + +// force little-endian +mput(1996,'ll');mput(1996,'il');mput(1996,'sl');mput(98,'cl'); + +// force big-endian +mput(1996,'lb');mput(1996,'ib');mput(1996,'sb');mput(98,'cb'); + +mclose(); +mopen(filen,'rb'); +if 1996<>mget(1,'l') then pause,end +if 1996<>mget(1,'i') then pause,end +if 1996<>mget(1,'s') then pause,end +if 98<>mget(1,'c') then pause,end + +// force little-endian +if 1996<>mget(1,'ll') then pause,end +if 1996<>mget(1,'il') then pause,end +if 1996<>mget(1,'sl') then pause,end +if 98<>mget(1,'cl') then pause,end + +// force big-endian +if 1996<>mget(1,'lb') then pause,end +if 1996<>mget(1,'ib') then pause,end +if 1996<>mget(1,'sb') then pause,end +if 98<>mget(1,'cb') then pause,end + +mclose(); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetl">mgetl</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mputl">mputl</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/mputl.xml b/modules/fileio/help/en_US/mputl.xml new file mode 100755 index 000000000..7147e48d9 --- /dev/null +++ b/modules/fileio/help/en_US/mputl.xml @@ -0,0 +1,108 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Serge STEER + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mputl" xml:lang="en"> + <refnamediv> + <refname>mputl</refname> + <refpurpose>writes strings in a text file</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>r = mputl(txt, file_desc)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>r</term> + <listitem> + <para> + returns <literal>%t</literal> or <literal>%f</literal> to check + if function has correctly wrote on the file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>file_desc</term> + <listitem> + <para> + a character string giving the name of the file or + </para> + <para> + an integer scalar: a file descriptor returned by + <function>mopen</function> function. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>txt</term> + <listitem> + <para>a vector of strings.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <function>mputl</function> function allows to write a vector of + strings as a sequence of lines in a text file. + </para> + <para> + <function>mputl</function> supports strings encoded as ANSI/ASCII and UTF-8. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +fd = mopen(TMPDIR+'/text_mputl.txt','wt'); +mputl('Hello World',fd); +mclose(fd); + +mputl('Simple Hello World',TMPDIR+"/text_mputl_simple.txt"); + +fd = mopen(TMPDIR+'/text_mputl.txt','rt'); +disp(mgetl(fd)); +mclose(fd); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetl">mgetl</link> + </member> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="write">write</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/mputstr.xml b/modules/fileio/help/en_US/mputstr.xml new file mode 100755 index 000000000..364a45afb --- /dev/null +++ b/modules/fileio/help/en_US/mputstr.xml @@ -0,0 +1,109 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="mputstr"> + <refnamediv> + <refname>mputstr</refname> + <refpurpose>writes a character string in a file</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>mputstr(str [, fd]);</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>fd</term> + <listitem> + <para> + a scalar: a file descriptor returned by the function <function>mopen</function>. <literal>-1</literal> stands for last opened file. Default value is <literal>-1</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>str</term> + <listitem> + <para>a character string.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The <function>mputstr</function> function allows to write a character string <varname>str</varname> in a binary file. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ + +this_file = pathconvert(TMPDIR+"/mputstr.txt", %F); + +fd = mopen(this_file, "wt"); +mputstr("Scilab", fd); +mclose(fd); + +mgetl(this_file) // Scilab + + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/mseek.xml b/modules/fileio/help/en_US/mseek.xml new file mode 100755 index 000000000..f452d4e65 --- /dev/null +++ b/modules/fileio/help/en_US/mseek.xml @@ -0,0 +1,146 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="mseek"> + <refnamediv> + <refname>mseek</refname> + <refpurpose>sets current position in a binary file</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>mseek(n [,fd, flag])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>n</term> + <listitem> + <para>a scalar: the offset in a number of bytes.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>fd</term> + <listitem> + <para> + a scalar: a file descriptor returned by the function + <function>mopen</function>. <literal>-1</literal> + stands for last opened file. Default value is + <literal>-1</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>flag</term> + <listitem> + <para> + a string: specifies the origin. Default value <literal>'set'</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The function <function>mseek</function> sets the position of the next input or output operation on the stream <varname>fd</varname>. The new position is at the signed distance given by <varname>n</varname> bytes from the beginning, from the current position, or from the end of the file, according to the <varname>flag</varname> value which can be <literal>'set'</literal>, <literal>'cur'</literal> or <literal>'end'</literal>. This is the reason why <varname>n</varname> must be positive when <varname>flag</varname> is equal to <literal>'set'</literal>. + </para> + <para> + <function>mseek</function> allows the file position indicator to be + set beyond the end of the existing data in the file. If data is + later written at this point, subsequent reads of data in the gap + will return zero until data is actually written into the gap. + <function>mseek</function>, by itself, does not extend the size of + the file. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +file3=fullfile(TMPDIR,'test3.bin'); +fd1= mopen(file3,'wb'); +for i=1:10 + mput(i,'d'); +end +mseek(0); +mput(678,'d'); +mseek(0,fd1,'end'); +mput(932,'d'); +mclose(fd1) + +fd1= mopen(file3,'rb'); +res=mget(11,'d') +res1=[1:11]; res1(1)=678;res1($)=932; +if res1<>res then + write(%io(2),'Bug'); +end +mseek(0,fd1,'set'); + +// trying to read more than stored data +res1=mget(100,'d',fd1); +if res1<>res then + write(%io(2),'Bug'); +end +meof(fd1) +mclearerr(fd1) +mclose(fd1); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/mtell.xml b/modules/fileio/help/en_US/mtell.xml new file mode 100755 index 000000000..4abf019be --- /dev/null +++ b/modules/fileio/help/en_US/mtell.xml @@ -0,0 +1,115 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="mtell"> + <refnamediv> + <refname>mtell</refname> + <refpurpose>Returns the offset of the current byte relative to the beginning of a file</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>mtell([fd])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>fd</term> + <listitem> + <para> + a scalar: a file descriptor returned by the function + <function>mopen</function>. <literal>-1</literal> + stands for last opened file. Default value is + <literal>-1</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The function <function>mtell</function> returns the offset of the + current byte relative to the beginning of the file associated with + the named stream <varname>fd</varname>. + </para> + </refsection> + + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// Open in binary write a temporary file +testFile=TMPDIR + '/testFile.bin'; +fd = mopen(testFile,'wb'); + +mput(42,'d'); // Will write 42 in last opened file +mtell() // Will return 8, the current position in the file descriptor + +mput(42+2,'d', fd); // Will open fd transparently to write 42 +mtell(fd) // Will return 16, the current position in the file descriptor + +mseek(0, fd); // return at the beginning of the file +mtell(fd) // Will return 0 + +mclose(fd); + ]]></programlisting> + </refsection> + + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/newest.xml b/modules/fileio/help/en_US/newest.xml new file mode 100755 index 000000000..4fd84a386 --- /dev/null +++ b/modules/fileio/help/en_US/newest.xml @@ -0,0 +1,74 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="newest"> + <refnamediv> + <refname>newest</refname> + <refpurpose>returns newest file of a set of files</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>k = newest(paths) + k = newest(path1, path2, ..., pathn) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>k</term> + <listitem> + <para>an integer: the index of the newest file.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>paths</term> + <listitem> + <para> + a character string vector, <code>paths(i)</code> is the pathname of <literal>i</literal>-th file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>pathi</term> + <listitem> + <para> + a character string, the pathname of <literal>i</literal>-th file + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Given a set of pathnames <function>newest</function> returns the index of the newest + one. Non existant files are supposed to be the oldest. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +newest('SCI/modules/graphics/macros/bode.sci','SCI/modules/graphics/macros/bode.bin') +newest(['SCI/modules/graphics/macros/bode.sci','SCI/modules/graphics/macros/bode.bin']) +newest('SCI/modules/graphics/macros/bode.'+['sci','bin']) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="fileinfo">fileinfo</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/path_filename/CHAPTER b/modules/fileio/help/en_US/path_filename/CHAPTER new file mode 100755 index 000000000..7475b052d --- /dev/null +++ b/modules/fileio/help/en_US/path_filename/CHAPTER @@ -0,0 +1,2 @@ +title = Paths - Filenames + diff --git a/modules/fileio/help/en_US/path_filename/basename.xml b/modules/fileio/help/en_US/path_filename/basename.xml new file mode 100755 index 000000000..4ce08a74a --- /dev/null +++ b/modules/fileio/help/en_US/path_filename/basename.xml @@ -0,0 +1,105 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="basename" xml:lang="en"> + <refnamediv> + <refname>basename</refname> + <refpurpose>strip directory and suffix from filenames</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>processedfiles = basename(files[,flag [,flagexpand]])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>files</term> + <listitem> + <para>a string matrix giving a set of file names.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>flag</term> + <listitem> + <para>optional boolean, used to convert the given path(s) for the current operating system. + Default value is true (<constant>%t</constant>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>flagexpand</term> + <listitem> + <para>optional boolean, used to expand leading + variables in paths. Only used with + <varname>flag</varname> argument. Default value + is true (<constant>%t</constant>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>processedFiles</term> + <listitem> + <para>a string matrix containing the processed filenames.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>basename(files)</code> returns the suffixs of paths, i.e. the last string following the final file separator for each path given in <varname>files</varname>. + </para> + <para> + If <varname>flag</varname> is true the paths are first converted for the current operating system (for example, 'C:/Tmp/folder' will be converted on Windows to 'C:\Tmp\folder'). + </para> + <para> + if <varname>flagexpand</varname> is true, leading path variables (HOME, SCI, SCIHOME, ...) are expanded for the current operating system + (for example, 'HOME\tmp' will be converted on Linux to 'home/<user>/tmp', where <user> is the current user logged on). + </para> + <para> + See more details on <varname>flag</varname> and <varname>flagexpand</varname> in <link linkend="pathconvert">pathconvert</link> section. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +files=basename('/tmp/poo') +files=basename('/tmp/poo.sci') +files=basename('/tmp/poo.bak.sci') +files=basename('/tmp/') + +files=basename('C:\tmp\poo') +files=basename('C:\tmp\poo.sci') +files=basename('C:\tmp\poo.bak.sci') + +files=basename('C:\tmp\') + +files=basename(['SCI/etc/scilab.start', 'SCI/etc/scilab.quit']) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="listfiles">listfiles</link> + </member> + <member> + <link linkend="pathconvert">pathconvert</link> + </member> + <member> + <link linkend="fileparts">fileparts</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/path_filename/dirname.xml b/modules/fileio/help/en_US/path_filename/dirname.xml new file mode 100755 index 000000000..80580d653 --- /dev/null +++ b/modules/fileio/help/en_US/path_filename/dirname.xml @@ -0,0 +1,117 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="dirname"> + <refnamediv> + <refname>dirname</refname> + <refpurpose>gets directory from filenames</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>dirs = dirname(files[, flag [,flagexpand]])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>files</term> + <listitem> + <para>a string matrix containing file paths</para> + </listitem> + </varlistentry> + <varlistentry> + <term>flag</term> + <listitem> + <para> + optional boolean, used to convert the given + path(s) for the current operating system. + Default value is true (<constant>%t</constant>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>flagexpand</term> + <listitem> + <para> + optional boolean, used to expand leading + variables in paths. Only used with + <varname>flag</varname> argument. Default value + is true (<constant>%t</constant>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>dirs</term> + <listitem> + <para>string matrices</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <function>dirname</function> returns the directory paths of the file entries + given in <varname>files</varname>. + </para> + <para> + If <varname>flag</varname> is true the paths are first + converted for the current operating system (for example, + <code>C:/Tmp/folder'</code> will be converted on Windows to + <code>'C:\Tmp\folder'</code>). + </para> + <para> + If <varname>flagexpand</varname> is true, leading path + variables (<literal>home</literal>, + <constant>SCI</constant>, <constant>SCIHOME</constant>, + ...) are expanded for the current operating system (for + example, <code>'home\tmp'</code> will be converted on + GNU/Linux to <literal>'home/<user>/tmp'</literal>, + where <literal><user></literal> is the current user + logged on). + </para> + <para> + See more details on <varname>flag</varname> and + <varname>flagexpand</varname> + in <link linkend="pathconvert">pathconvert</link> section. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +dirs=dirname('/tmp/folder/poo') +dirs=dirname('/tmp/folder/') +dirs=dirname('/') + +dirs=dirname('C:\tmp\folder\poo') +dirs=dirname('C:\tmp\folder\') +dirs=dirname('C:\') + +dirs=dirname(['SCI/etc/scilab.start', 'SCI/etc/scilab.quit']) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="basename">basename</link> + </member> + <member> + <link linkend="listfiles">listfiles</link> + </member> + <member> + <link linkend="pathconvert">pathconvert</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/path_filename/fileext.xml b/modules/fileio/help/en_US/path_filename/fileext.xml new file mode 100755 index 000000000..b009f7838 --- /dev/null +++ b/modules/fileio/help/en_US/path_filename/fileext.xml @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="fileext"> + <refnamediv> + <refname>fileext</refname> + <refpurpose>returns extension for a file path</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>extension = fileext(fullpath)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>fullpath</term> + <listitem> + <para>a string matrix, the given file path.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>extension</term> + <listitem> + <para> + a string matrix, the extension part is any or <literal>''</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>extension = fileext(fullpath)</code> splits the fullpath character string in the extension part including the dot. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +extension = fileext('SCI/etc/scilab.start') +extension = fileext(['SCI/etc/scilab.start';'SCI/etc/scilab.quit']) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="fileparts">fileparts</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/path_filename/fileparts.xml b/modules/fileio/help/en_US/path_filename/fileparts.xml new file mode 100755 index 000000000..55719a168 --- /dev/null +++ b/modules/fileio/help/en_US/path_filename/fileparts.xml @@ -0,0 +1,108 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Serge STEER + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="fileparts"> + <refnamediv> + <refname>fileparts</refname> + <refpurpose>returns the path, filename and extension for a file path</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>[path, fname, extension] = fileparts(fullpath) + value = fileparts(fullpath, sel) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>fullpath</term> + <listitem> + <para> a string or a string matrix, the given file path.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>sel</term> + <listitem> + <para>a optional character string selector, with possible values: + <literal>'path'</literal>, <literal>'fname'</literal> or <literal>'extension'</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>path</term> + <listitem> + <para> + a string or a string matrix, the path of the directory pointed to by <varname>fullpath</varname>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>fname</term> + <listitem> + <para> + a string or a string matrix, the filename part is any or <literal>''</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>extension</term> + <listitem> + <para> + a string or a string matrix, the extension part is any or <literal>''</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>value</term> + <listitem> + <para> + a string or a string matrix, depending on <varname>sel</varname> value. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>[path, fname, extension] = fileparts(fullpath)</code> splits the + <varname>fullpath</varname> character string in its three parts: the path of the + directory pointed to, the filename part, the extension part + including the dot. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +[path,fname,extension]=fileparts('SCI/etc/scilab.start') +fileparts('SCI/etc/scilab.start','extension') +[path,fname,extension]=fileparts(['SCI/etc/scilab.start', 'SCI/etc/scilab.start']) +fileparts(['SCI/etc/scilab.start', 'SCI/etc/scilab.start'],'extension') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="pathconvert">pathconvert</link> + </member> + <member> + <link linkend="basename">basename</link> + </member> + <member> + <link linkend="fullfile">fullfile</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/path_filename/filesep.xml b/modules/fileio/help/en_US/path_filename/filesep.xml new file mode 100755 index 000000000..7302f2dc3 --- /dev/null +++ b/modules/fileio/help/en_US/path_filename/filesep.xml @@ -0,0 +1,46 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="filesep"> + <refnamediv> + <refname>filesep</refname> + <refpurpose>returns directory separator for current platform</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>s = filesep()</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>s</term> + <listitem> + <para>a string</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The <function>filesep</function> returns directory separator (<literal>'/'</literal> on GNU/Linux or <literal>'\'</literal> on Windows). + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +filesep() + ]]></programlisting> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/path_filename/fullfile.xml b/modules/fileio/help/en_US/path_filename/fullfile.xml new file mode 100755 index 000000000..4929d894e --- /dev/null +++ b/modules/fileio/help/en_US/path_filename/fullfile.xml @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Vincent COUVERT + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="fullfile"> + <refnamediv> + <refname>fullfile</refname> + <refpurpose>builds a full filename from parts</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>f = fullfile(varargin)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>varargin</term> + <listitem> + <para> + character strings, all directories and filename used to + build the full filename (at least one directory and + filename). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>f</term> + <listitem> + <para> + a character string or matrix of strings, full filename. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>f = fullfile(varargin)</code> builds a full filename taking care of platform on which it is run + and handling the cases when the directories begin or end with a directory separator. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[f = fullfile("/home/", "\scilab", "macros", "\util", "fullfile.sci") +f = fullfile("C:", "\scilab", "macros", "\util", "fullfile.sci") +r = fullfile("/home/","\scilab","macros","\util", ["fullfile.sci"; "toto.sci"])]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="pathconvert">pathconvert</link> + </member> + <member> + <link linkend="fileparts">fileparts</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/path_filename/fullpath.xml b/modules/fileio/help/en_US/path_filename/fullpath.xml new file mode 100755 index 000000000..d0a38b90b --- /dev/null +++ b/modules/fileio/help/en_US/path_filename/fullpath.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * Copyright (C) 2011 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="fullpath"> + <refnamediv> + <refname>fullpath</refname> + <refpurpose>creates an full path name for the specified relative path name.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>res = fullpath(relative_path)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>res</term> + <listitem> + <para>a string or matrix of string.</para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term>relative_path</term> + <listitem> + <para>a string or a matrix of string.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>fullpath(relative_path)</code> сreates a full path name + for the specified relative path name. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +cd(TMPDIR); +mkdir(TMPDIR + "/niv1"); +mkdir(TMPDIR + "/niv1/niv2"); +mkdir(TMPDIR + "/niv1/niv2/niv3"); +mputl(' ', TMPDIR + "/niv1/test1.txt"); +mputl(' ' , TMPDIR + "/niv1/niv2/test2.txt"); + +cd(TMPDIR + "/niv1/niv2/niv3"); + +r1 = fullpath("../../test1.txt") +r2 = fullpath("../test2.txt") +M = ["../../test1.txt", "../test2.txt"]; +R = fullpath(M) + ]]></programlisting> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.4.0</revnumber> + <revremark>Matrix of String managed (SEP 72)</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/path_filename/get_absolute_file_path.xml b/modules/fileio/help/en_US/path_filename/get_absolute_file_path.xml new file mode 100755 index 000000000..2f39b7f6a --- /dev/null +++ b/modules/fileio/help/en_US/path_filename/get_absolute_file_path.xml @@ -0,0 +1,87 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="get_absolute_file_path" xml:lang="en"> + <refnamediv> + <refname>get_absolute_file_path</refname> + <refpurpose> + gives an absolute pathname of a file opened in Scilab + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>pathname = get_absolute_file_path(filename)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>filename</term> + <listitem> + <para>a character string: filename.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>pathname</term> + <listitem> + <para>a character string: an absolute pathname.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <function>get_absolute_file_path</function> gives an absolute pathname + of a file already opened in Scilab. + </para> + <para> + <function>get_absolute_file_path</function> searches in Scilab's + internal list of files currently opened <varname>filename</varname> + and returns its path <varname>pathname</varname>. + </para> + <para>If file is not opened, it will return an error.</para> + <para> + <warning> + In previous version (Scilab 5.0.x) current directory was + returned if file was not found. + </warning> + </para> + <para>This function can be used to find from where (path) is executed a + Scilab script. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// exec this script + +a=mopen(TMPDIR+'test.sce','wt'); +disp(get_absolute_file_path('test.sce')); +mclose(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="getshortpathname">getshortpathname</link> + </member> + <member> + <link linkend="getlongpathname">getlongpathname</link> + </member> + <member> + <link linkend="pwd">pwd</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/path_filename/getdrives.xml b/modules/fileio/help/en_US/path_filename/getdrives.xml new file mode 100755 index 000000000..cefe023cd --- /dev/null +++ b/modules/fileio/help/en_US/path_filename/getdrives.xml @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="getdrives"> + <refnamediv> + <refname>getdrives</refname> + <refpurpose>gets the drive letters of all mounted filesystems on the computer</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>drives = getdrives()</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>drives</term> + <listitem> + <para>a matrix of strings.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The function <function>getdrives</function> gets the drive letters of all + mounted filesystems on the computer. + </para> + <para> + <function>getdrives</function> returns the roots of all mounted filesystems on the computer as a matrix of strings. + </para> + <para> + For GNU/Linux this list consists solely of the root directory, <literal>/</literal>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +getdrives() + ]]></programlisting> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/path_filename/getlongpathname.xml b/modules/fileio/help/en_US/path_filename/getlongpathname.xml new file mode 100755 index 000000000..e2bb6382d --- /dev/null +++ b/modules/fileio/help/en_US/path_filename/getlongpathname.xml @@ -0,0 +1,90 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="getlongpathname" xml:lang="en"> + <refnamediv> + <refname>getlongpathname</refname> + <refpurpose>gets long path name</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + longpath = getlongpathname(shortpath) + [longpath, bOK] = getlongpathname(shortpath) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>shortpath</term> + <listitem> + <para>a character string or matrix of strings: the short path.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>longpath</term> + <listitem> + <para>a character string or matrix of strings: the long path.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bOK</term> + <listitem> + <para> + a boolean or a matrix of boolean: <constant>%T</constant> if + path has been converted else <constant>%F</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The <function>getlongpathname</function> primitive converts the + specified path <varname>shortpath</varname> to its long form. If no long path is found, this + primitive returns the specified name. + </para> + <para> + <note> + Note: If the path cannot be converted (<varname>bOK</varname> is <constant>%F</constant>) and in particular if the + operating system is not Windows, the returned long path is identical to the + input short path. + </note> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"> + <![CDATA[ +[longpath,bOK]=getlongpathname(SCI) +[longpaths,bOKs]=getlongpathname([SCI;SCI]) + ]]> + </programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="getshortpathname">getshortpathname</link> + </member> + <member> + <link linkend="getrelativefilename">getrelativefilehname</link> + </member> + <member> + <link linkend="pwd">pwd</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/path_filename/getrelativefilename.xml b/modules/fileio/help/en_US/path_filename/getrelativefilename.xml new file mode 100755 index 000000000..61e0bc4af --- /dev/null +++ b/modules/fileio/help/en_US/path_filename/getrelativefilename.xml @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="getrelativefilename"> + <refnamediv> + <refname>getrelativefilename</refname> + <refpurpose>given absolute directories and absolute filenames, returns relative file names</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>rel_file = getrelativefilename(abs_dir, abs_file)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>abs_dir</term> + <listitem> + <para>a character string or matrix of character strings: absolute directories.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>abs_file</term> + <listitem> + <para>a character string or matrix of character strings: absolute filenames.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>rel_file</term> + <listitem> + <para>a character string or a matrix of character strings: relative filenames.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + Given absolute directories <varname>abs_dir</varname> and absolute filenames <varname>abs_file</varname>, <function>getrelativefilename</function> returns relative file names <varname>rel_file</varname>. That is, if the input arguments are some string matrices (m x n), for indexes (i, j), <function>getrelativefilename</function> returns <literal>rel_file(i,j)</literal> associated with <literal>abs_dir(i,j)</literal> and <literal>abs_file(i,j)</literal>. + This implies that <varname>abs_dir</varname> and <varname>abs_file</varname> must have the same dimensions. + </para> + <para> + For example, if the current directory is + <literal>C:\scilab\bin</literal> and the filename + <literal>C:\scilab\modules\helptools\readme.txt</literal> is + given, <function>getrelativefilename</function> will return + <literal>..\modules\helptools\readme.txt</literal>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +getrelativefilename(pwd(), SCI+'/COPYING') +getrelativefilename(TMPDIR, SCI+'/COPYING') +getrelativefilename(SCI+'/bin', SCI+'/COPYING') +getrelativefilename(pwd(), SCI+'/ACKNOWLEDGMENTS') +getrelativefilename(TMPDIR, SCI+'/ACKNOWLEDGMENTS') +getrelativefilename(SCI+'/bin', SCI+'/ACKNOWLEDGMENTS') +getrelativefilename([SCI+'/bin',SCI+'/bin'], [SCI+'/ACKNOWLEDGMENTS',SCI+'/ACKNOWLEDGMENTS']) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="getshortpathname">getshortpathname</link> + </member> + <member> + <link linkend="getlongpathname">getlongpathname</link> + </member> + <member> + <link linkend="pwd">pwd</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/path_filename/getshortpathname.xml b/modules/fileio/help/en_US/path_filename/getshortpathname.xml new file mode 100755 index 000000000..1da4b574e --- /dev/null +++ b/modules/fileio/help/en_US/path_filename/getshortpathname.xml @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="getshortpathname" xml:lang="en"> + <refnamediv> + <refname>getshortpathname</refname> + <refpurpose>gets short path name</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + shortpath = getshortgpathname(longpath) + [shortpath, bOK] = getshortpathname(longpath) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>longpath</term> + <listitem> + <para>a character string or matrix of strings: the long path.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>shortpath</term> + <listitem> + <para> + a character string or a matrix of strings: the short path. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>bOK</term> + <listitem> + <para> + a boolean or a matrix of boolean: <constant>%T</constant> if + path has been converted else <constant>%F</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The <function>getshortpathname</function> primitive converts the + specified path <varname>longpath</varname> to its short form. + </para> + <para> + <note> + Note: If the path cannot be converted (<varname>bOK</varname> is <constant>%F</constant>) and in particular if the + operating system is not Windows, the returned short path is identical to the + input long path. + </note> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"> + <![CDATA[ +[shortpath,bOK]=getshortpathname(SCI) +[shortpaths,bOKs]=getshortpathname([SCI;SCI]) + ]]> + </programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="getlongpathname">getlongpathname</link> + </member> + <member> + <link linkend="getrelativefilename">getrelativefilehname</link> + </member> + <member> + <link linkend="pwd">pwd</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/path_filename/is_absolute_path.xml b/modules/fileio/help/en_US/path_filename/is_absolute_path.xml new file mode 100755 index 000000000..afaf4199b --- /dev/null +++ b/modules/fileio/help/en_US/path_filename/is_absolute_path.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2013 - Scilab Enterprises - Charlotte HECQUET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="is_absolute_path"> + <refnamediv> + <refname>is_absolute_path</refname> + <refpurpose>checks if argument is an absolute path</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>r = is_absolute_path(path)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para>a character string or a matrix of strings: a directory pathname.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>r</term> + <listitem> + <para> + a boolean: <constant>%t</constant> if <varname>path</varname> is an absolute path. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <code>r = is_absolute_path(path)</code> checks if <varname>path</varname> is an absolute path. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +is_absolute_path(TMPDIR) +is_absolute_path("./scilab/modules/fileio") + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="get_absolute_file_path">get_absolute_file_path</link> + </member> + <member> + <link linkend="fileparts">fileparts</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/path_filename/pathconvert.xml b/modules/fileio/help/en_US/path_filename/pathconvert.xml new file mode 100755 index 000000000..85bffb99a --- /dev/null +++ b/modules/fileio/help/en_US/path_filename/pathconvert.xml @@ -0,0 +1,138 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="pathconvert"> + <refnamediv> + <refname>pathconvert</refname> + <refpurpose>converts a path to an OS path format.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>paths = pathconvert(paths [,flagtrail [,flagexpand [,type]]])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>paths</term> + <listitem> + <para>a string matrix giving a set of file paths</para> + </listitem> + </varlistentry> + <varlistentry> + <term>flagtrail</term> + <listitem> + <para> + optional boolean, used to add a trailing file separator to the + paths (<literal>\</literal> or <literal>/</literal>, + depending on the target path format). Default value is true + (<constant>%t</constant>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>flagexpand</term> + <listitem> + <para> + optional boolean, used to expand leading variables in paths. + Default value is true (<constant>%t</constant>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>type</term> + <listitem> + <para> + optional string, used to specify the target path format: <literal>'u'</literal> for POSIX path format (GNU/Linux,...), and <literal>'w'</literal> for Windows path format. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <function>pathconvert</function> is used to convert a set of paths, + to be compatible with an OS (Operating System) path format. For example Windows path style uses <literal>/</literal> for file separator, while it is <literal>\</literal> on other OS. + </para> + <para> + By default, the paths are converted to the current OS path format (but another path format can be specified with argument <varname>type</varname>). + </para> + <para> + <note> + Note: Windows paths starting with a drive letter prefix are converted to + the POSIX paths using the cygwin convention (with <literal>/cygdrive</literal>). + For example: <literal>C:\tmp</literal> will be converted to <literal>/cygdrive/C/tmp</literal>. + </note> + </para> + <para> + <varname>flagtrail</varname> is used to add or remove a file + separator (depending on the target path format) to the end + of paths. When the parameter is set to true, a trailing file + separator is added if missing. Otherwise, the trailing file + separators are removed. + </para> + <para> + <varname>flagexpand</varname> is used to expand the leading + Scilab environment variables in paths. The following + variables are accepted: + <itemizedlist> + <listitem> + <constant>SCI</constant> + </listitem> + <listitem> + <constant>WSCI</constant> + </listitem> + <listitem> + <constant>SCIHOME</constant> + </listitem> + <listitem> + <constant>TMPDIR</constant> + </listitem> + <listitem> + <literal>home</literal> (or <literal>~</literal>) + </listitem> + </itemizedlist> + <caution> + <constant>WSCI</constant> is unknown on GNU/Linux and + <literal>~</literal> in term "path" is unknown on Windows. + </caution> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +pathconvert("SCI/modules/foo", %f, %t, "w") +pathconvert("SCI\modules\foo", %f, %t, "u") +pathconvert("SCI\modules\foo", %t, %t, "u") +pathconvert("SCI/modules/foo", %f, %f, "w") +pathconvert("SCI/modules/foo", %t, %f, "w") +pathconvert("C:/tmp", %f, %f, "u") +pathconvert("/cygdrive/c/tmp", %f, %f, "w") + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="basename">basename</link> + </member> + <member> + <link linkend="listfiles">listfiles</link> + </member> + <member> + <link linkend="dirname">dirname</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/path_filename/pathsep.xml b/modules/fileio/help/en_US/path_filename/pathsep.xml new file mode 100755 index 000000000..d3f235bc2 --- /dev/null +++ b/modules/fileio/help/en_US/path_filename/pathsep.xml @@ -0,0 +1,46 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="pathsep"> + <refnamediv> + <refname>pathsep</refname> + <refpurpose>returns path separator for current platform</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>s = pathsep()</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>s</term> + <listitem> + <para>a string</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <function>pathsep</function> returns path separator (<literal>':'</literal> on GNU/Linux or <literal>';'</literal> on Windows ). + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +pathsep() +]]></programlisting> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/path_filename/splitURL.xml b/modules/fileio/help/en_US/path_filename/splitURL.xml new file mode 100755 index 000000000..09809c551 --- /dev/null +++ b/modules/fileio/help/en_US/path_filename/splitURL.xml @@ -0,0 +1,163 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) - S/E - Sylvestre Ledru + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xml:id="splitURL" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:scilab="http://www.scilab.org" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>splitURL</refname> + + <refpurpose>Split an URL (HTTP, HTTPS, FTP...) </refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + + <synopsis>[proto, server, path, query, username, port, fragment] = splitURL(URL); + </synopsis> + </refsynopsisdiv> + + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>URL</term> + <listitem> + <para>String: An URL. Supported and tested: HTTP, HTTPS, FTP (IPv4 and IPv6)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>proto</term> + <listitem> + <para> + String: the protocol (ex: <emphasis role="italic">http, ftp, etc</emphasis>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>server</term> + <listitem> + <para> + String: the server (ex: <emphasis role="italic">www.scilab.org</emphasis>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>path</term> + <listitem> + <para> + String: the path (ex: <emphasis role="italic">/products/scilab</emphasis>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>query</term> + <listitem> + <para> + String: query (ex: <emphasis role="italic">?SearchText=plot3d</emphasis>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>username</term> + <listitem> + <para> + String: username (ex: <emphasis role="italic">username:pass</emphasis>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>port</term> + <listitem> + <para> + int: port (ex: <emphasis role="italic">80</emphasis>) + </para> + <para> + <note> + Note that if the port is not provided in the URL, the value will be 0. + </note> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>fragment</term> + <listitem> + <para> + String: fragment (ex: <emphasis role="italic">#chapter1</emphasis>) + </para> + <para>The fragment is also called anchor and it is used to create a bookmark inside an HTML document.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + + <refsection> + <title>Description</title> + + <para>Split an URL by component </para> + + <para> + This function is based on the <ulink url="http://xmlsoft.org/html/libxml-uri.html#xmlParseURI">libxml2 library (in particular, the function xmlParseURI)</ulink>. + </para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example"> + [proto, server, path, query, username, port, fragment] = splitURL("http://xmlsoft.org/html/libxml-uri.html#xmlParseURI") + + [proto, server, path] = splitURL("ftp://ftp.free.fr/pub/Distributions_Linux/debian/README") + + [a,b,c,d]=splitURL("http://www.scilab.org/content/search?SearchText=plot") + + </programlisting> + <!-- +// This example fails for now (probably a bug on evstr) +// Retrieve the content and execute it +[f,content]=getURL("http://fileexchange.scilab.org/toolboxes/161000/1.0/files/cshift.sci") +evstr(content); +M = grand(3,4,"uin",0,9); +cshift(M,1); +--> + + </refsection> + + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="getURL">getURL</link> + </member> + </simplelist> + </refsection> + + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark> + Function <literal>splitURL()</literal> introduced + </revremark> + </revision> + </revhistory> + </refsection> + +</refentry> diff --git a/modules/fileio/help/en_US/path_filename/tempname.xml b/modules/fileio/help/en_US/path_filename/tempname.xml new file mode 100755 index 000000000..f49c2c82e --- /dev/null +++ b/modules/fileio/help/en_US/path_filename/tempname.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2011 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="tempname"> + <refnamediv> + <refname>tempname</refname> + <refpurpose> + creates a file with an unique filename + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>tmp_name = tempname([prefix])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>tmp_name</term> + <listitem> + <para>a string</para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term>prefix</term> + <listitem> + <para> + a string: prefix of filename (On Windows, 3 characters maximum). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The <function>tempname</function> creates a file with an unique + filename in the <literal>TMPDIR</literal> directory. + </para> + <para> + <code>tmp_name = tempname()</code> returns an unique string, + <varname>tmp_name</varname>, suitable for use as a temporary filename. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ + F1 = tempname() + isfile(F1) + F2 = tempname('TMP') + isfile(F2) + ]]></programlisting> + </refsection> + <refsection> + <title>History</title> + <revhistory> + <revision> + <revnumber>5.4.0</revnumber> + <revremark> + Function <function>tempname</function> introduced. + </revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/save_format.xml b/modules/fileio/help/en_US/save_format.xml new file mode 100755 index 000000000..74a0960fd --- /dev/null +++ b/modules/fileio/help/en_US/save_format.xml @@ -0,0 +1,708 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="save_format" xml:lang="en"> + <refnamediv> + <refname>save format</refname> + <refpurpose>format of files produced by "save"</refpurpose> + </refnamediv> + <refsection> + <title>Abstract</title> + <para>The goal of this document is to specify the HDF5 format used by Scilab to store its data.</para> + <para>The format is called SOD for Scilab Open Data.</para> + <para>The first public release of SOD has been done with Scilab 5.4.0.</para> + </refsection> + <refsection> + <title>Rationale</title> + <para>Interoperability is one of the key aspects of modern software. In order to improve more and more this aspect, a standard definition of the HDF5 format is proposed in this SEP.</para> + <para>Since Scilab 5.2.0, an export / import capability has been developed and maintain to exchange data. This is already one of the base components of Xcos to store and exchange data.</para> + </refsection> + <refsection> + <title>Supported data types</title> + <para>All Scilab data types are supported. For example:</para> + <informaltable border="1"> + <tbody> + <tr> + <td> + <emphasis role="bold">Name</emphasis> + </td> + <td> + <emphasis role="bold">Example in Scilab</emphasis> + </td> + </tr> + <tr> + <td> + <emphasis role="bold">double</emphasis> + </td> + <programlisting> + A=32; + b=[32,2]; + c=[2,2;3,4]; + d=rand(10,10); + </programlisting> + </tr> + <tr> + <td> + <emphasis role="bold">string</emphasis> + </td> + <programlisting> + a="my string"; + b=["string 1";"my string 2"]; + </programlisting> + </tr> + <tr> + <td> + <emphasis role="bold">boolean</emphasis> + </td> + <programlisting> + a=%t; + b=[%t, %f]; + </programlisting> + </tr> + <tr> + <td> + <emphasis role="bold">integer</emphasis> + </td> + <td> + <programlisting> + int8([1 -120 127 312]) + x=int32(-200:100:400) + </programlisting> + </td> + </tr> + <tr> + <td> + <emphasis role="bold">polynomial</emphasis> + </td> + <td> + <programlisting> + s=poly([2 3],"s") + poly(1:4,'s','c') + </programlisting> + </td> + </tr> + <tr> + <td> + <emphasis role="bold">sparse</emphasis> + </td> + <td align="justify"> + <programlisting> + sp=sparse([1,2;4,5;3,10],[1,2,3]) + </programlisting> + </td> + </tr> + <tr> + <td> + <emphasis role="bold">boolean sparse</emphasis> + </td> + <td align="justify"> + <programlisting> + dense=[%F, %F, %T, %F, %F + %T, %F, %F, %F, %F + %F, %F, %F, %F, %F + %F, %F, %F, %F, %T]; + sp=sparse(dense) + </programlisting> + </td> + </tr> + <tr> + <td> + <emphasis role="bold">list</emphasis> + </td> + <td align="justify"> + <programlisting> + l = list(1,["a" "b"]) + </programlisting> + </td> + </tr> + <tr> + <td> + <emphasis role="bold">tlist</emphasis> + </td> + <td align="justify"> + <programlisting> + t = tlist(["listtype","field1","field2"], [], []); + </programlisting> + </td> + </tr> + <tr> + <td> + <emphasis role="bold">mlist</emphasis> + </td> + <td align="justify"> + <programlisting> + M=mlist(['V','name','value'],['a','b';'c' 'd'],[1 2; 3 4]); + </programlisting> + </td> + </tr> + </tbody> + </informaltable> + <para> + Several "types" are based on <emphasis>tlist</emphasis> or <emphasis>mlist</emphasis>. It is the case of <emphasis>rational</emphasis>, <emphasis>state-space</emphasis>, <emphasis>hypermat</emphasis>, <emphasis>cell</emphasis> and <emphasis>struct</emphasis>. They are therefore transparently saved. + </para> + <para> + <emphasis>void </emphasis>and <emphasis>undefined </emphasis>are two specific elements created to manage special cases in the list management. They are described later in this document. + </para> + </refsection> + <refsection> + <title>HDF5 File Structure</title> + <para>Scilab HDF5 architecture is pretty straightforward. </para> + <emphasis role="bold">General</emphasis> + <para>For each Scilab variable, a dataset at the root position is declared. The name of the dataset is the name of Scilab variable. </para> + <para>Example, the following code:</para> + <programlisting> + emptyuint32matrix = uint32([]); + uint32scalar = uint32(1); + uint32rowvector = uint32([1 4 7]); + uint32colvector = uint32([1;4;7]); + uint32matrix = uint32([1 4 7;9 6 3]); + save("uint32.sod","emptyuint32matrix","uint32scalar","uint32rowvector","uint32colvector","uint32matrix"); + </programlisting> + <para>produces:</para> + <mediaobject> + <imageobject> + <imagedata fileref="../images/img001.png" width="5.95cm" depth="1.64cm"/> + </imageobject> + </mediaobject> + <para> + Each root dataset has an attribute called <literal>SCILAB_Class</literal>. This attribute defines which types is the variable stored in the HDF5 file. + </para> + <para>If the variable is a primitive type and without complex values associated, data are stored directly into the dataset. Otherwise, the dataset contains references to the actual data.</para> + <para>Every SOD file contains two specific variables:</para> + <itemizedlist> + <listitem> + <para> + <literal>SCILAB_scilab_version</literal> – Describe which version of Scilab has been used to save the SOD file. + </para> + <para>For example, with Scilab 5.4.0, the data will be:</para> + <para> + <emphasis>SCILAB_scilab_version = scilab-5.4.0</emphasis> + </para> + </listitem> + <listitem> + <para>SCILAB_sod_version – Describe which version of the SOD specification has been used to save the file.</para> + <para>For example, with Scilab 5.4.0, the data will be:</para> + <para> + <emphasis>SCILAB_sod_version = 2</emphasis> + </para> + </listitem> + </itemizedlist> + <para> + Types where data are stored straight into the dataset. + </para> + <informaltable border="1"> + <tbody> + <tr> + <td align="left"> + <emphasis role="bold">Scilab Type</emphasis> + </td> + <td align="left"> + <emphasis role="bold">HDF5 Scilab type attribute</emphasis> + </td> + <td align="left"> + <emphasis role="bold">HDF5 attributes</emphasis> + </td> + <td align="left"> + <emphasis role="bold">HDF data types mapping</emphasis> + </td> + </tr> + <tr> + <td align="left"> + <para>string</para> + </td> + <td align="left"> + <para>SCILAB_Class = string</para> + </td> + <td align="left"> + + </td> + <td align="left"> + <para>String</para> + </td> + </tr> + <tr> + <td align="left"> + <para>boolean</para> + </td> + <td namest="c2" nameend="c3" align="left"> + <para>SCILAB_Class = boolean</para> + </td> + <td align="left"> + + </td> + <td align="left"> + <para>32-bit integer</para> + </td> + </tr> + <tr> + <td align="left"> + <para>integer</para> + </td> + <td namest="c2" nameend="c3" align="left"> + <para>SCILAB_Class = integer</para> + </td> + <td align="left"> + <para>SCILAB_precision = {8, 16, 32, u8, u16, u32}</para> + </td> + <td namest="c1" nameend="c2" align="left"> + <para>8 = 8-bit character</para> + <para>16 = 16-bit integer</para> + <para>32 = 32-bit integer</para> + <para>u8 = 8-bit unsigned character</para> + <para>u16 = 16-bit unsigned integer</para> + <para>u32 = 32-bit unsigned integer</para> + </td> + </tr> + </tbody> + </informaltable> + <para>For these types, like in Scilab, the data are stored in a one dimension array. Data are stored by column wise.</para> + <para>To reconstruct the matrix, vector or scalar, two attributes provides the number of columns and rows. </para> + <para> + Since the 5.4.0 release of Scilab and SOD v2, <literal>SCILAB_cols</literal> and <literal>SCILAB_rows</literal> are no longer used for matrices of double, integer, polynomial and string. SOD uses the native multidimensional HDF5 feature. + </para> + <para> + <emphasis role="bold">Example</emphasis> + </para> + <para> + The saving of the declaration: <code>int32([1 -4 7;-9 6 -3])</code> will be displayed as: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="../images/img002.png" width="5.95cm" depth="1.64cm"/> + </imageobject> + </mediaobject> + <para>in hdfview.</para> + <para>And the metadata will be:</para> + <emphasis role="italic"> + <para>int32matrix (800, 2)</para> + <para>32-bit integer, 3 x 2 => the size of the variable</para> + <para>Number of attributes = 2</para> + <para>SCILAB_Class = integer</para> + <para>SCILAB_precision = 32</para> + </emphasis> + <para> + <note> + Scalar value are stored as a matrix of size 1 by 1. + </note> + </para> + <para> + An empty variable (<literal>[]</literal>) will have the attribute <literal>SCILAB_empty</literal> set to true. + </para> + <para> + <emphasis role="bold">Types where data are stored in a dedicated group</emphasis> + </para> + <para>Many of Scilab datatypes are stored using groups. This allows a clear separations of the value but also an easy access.</para> + <para> + Groups are named from the variables enclosed by "#". For example, for a matrix of double called matrixofdouble, the name of the root dataset will be matrixofdouble, the name of the associated group will be <emphasis role="strong">#matrixofdouble#</emphasis>. + </para> + <para>For recursive data type (list, mlist, tlist, etc), names of subgroup are constructed the following way:</para> + <para> + The <literal>#</literal> allows the creation of an unique identifier. The number of initial <literal>#</literal> shows the level of depth. Therefore, the sublist <emphasis>###listnested#_#2##_#1##</emphasis> will indicate that it is located at the second level. + </para> + <para>The underscore "_" is a way to represent the depth. Usually, the "/" character is used in such case but it is a reserved keyword in the HDF5 specification.</para> + <para> + The integers used in the naming shows the position in the data structure, both in term of position in the current structure but also regarding the parent element. In the example, <emphasis>###listnested#_#2##_#1##</emphasis>, the 1 shows that it is dealing with the second element of the third structure of the main element (elements are indexed from 0). + </para> + <para> + For example, the group named <emphasis>###listnested#_#2##_#1##</emphasis>, will point to the value [32, 42] from the example: + </para> + <programlisting> + listnested=list(2,%i,'f',ones(3,3)) + listnested(3) = list( %t, [32,42]); + </programlisting> + <para> + <emphasis role="bold">Sparse</emphasis> + </para> + <para> + <emphasis role="strong">Scilab type:</emphasis> sparse + </para> + <para> + <emphasis role="strong">HDF5 Scilab type attribute:</emphasis> SCILAB_Class = sparse + </para> + <para> + <emphasis role="strong">HDF5 attributes: </emphasis> + </para> + <para>SCILAB_rows = <int></para> + <para>Number of rows</para> + <para> + <emphasis>SCILAB_cols = <int></emphasis> + </para> + <para>Number of columns</para> + <para> + <emphasis>SCILAB_items = <int></emphasis> + </para> + <para>Define the number of elements in the sparse matrix</para> + <para> + <emphasis role="strong">Root dataset values:</emphasis> + </para> + <para> + First value (<literal>#0#</literal>): Each element of this data structure shows the number of non-null element per line. Therefore, the first element shows the number of element in the first line of the sparse matrix. + </para> + <para> + Second value (<literal>#1#</literal>): Provides the position of the column of each elements of the sparse matrix. + </para> + <para> + Third value (<literal>#2#</literal>): Stores the reference to the actual values of the element in the sparse matrix (which will be stored in a specific group). + </para> + <para>Example, taking this matrix:</para> + <programlisting role="no-scilab-exec"> + 0. 1. 0. 0. 0. 0. 0. 0. 0. 0. + 0. 0. 0. 0. 0. 0. 0. 0. 0. 0. + 0. 0. 0. 0. 0. 0. 0. 0. 0. 3. + 0. 0. 0. 0. 2. 0. 0. 0. 0. 0. + </programlisting> + <para>which is generated by the function:</para> + <programlisting role="scilab_code"> + sparse([1,2;4,5;3,10],[1,2,3]) + </programlisting> + <para> + will have: + </para> + <para> + <emphasis>#0#</emphasis> contains <emphasis>1;0;1;1</emphasis> + </para> + <para> + <emphasis>#1#</emphasis> contains <emphasis>2;10;5</emphasis> + </para> + <para> + <emphasis>#2#</emphasis> references a matrix of double (not complex in this example) which contains <emphasis>1.0; 3.0; 2.0</emphasis> + </para> + <para> + <emphasis role="bold">Boolean sparse</emphasis> + </para> + <para> + <emphasis role="strong">Scilab type:</emphasis> boolean sparse + </para> + <para> + <emphasis role="strong">HDF5 Scilab type attribute:</emphasis> SCILAB_Class = boolean sparse + </para> + <para> + <emphasis>HDF5 attributes:</emphasis> + </para> + <para> + <emphasis>SCILAB_rows = <int></emphasis> + </para> + <para>Number of rows</para> + <para> + <emphasis>SCILAB_cols = <int></emphasis> + </para> + <para>Number of columns</para> + <para> + <emphasis>SCILAB_items = <int></emphasis> + </para> + <para>Define the number of elements in the sparse matrix</para> + <para> + <emphasis role="strong">Root dataset values:</emphasis> While a sparse has 3 datasets, the boolean sparse has only 2 because defined values are automatically considered as true. + </para> + <para> + First value (<literal>#0#</literal>): Each element of this data structure shows the number of non-null element per line. + </para> + <para>Therefore, the first element shows the number of element in the first line of the sparse matrix.</para> + <para> + Second value (<literal>#1#</literal>): Provides the position of the column of each elements of the sparse matrix. + </para> + <para>With the boolean sparse matrix:</para> + <programlisting> + dense=[%F, %F, %T, %F, %F + %T, %F, %F, %F, %F + %F, %F, %F, %F, %F + %F, %F, %F, %F, %T]; + </programlisting> + <para> + <emphasis>#0#</emphasis> contains <emphasis>1;1;0;1</emphasis>. + </para> + <para> + <emphasis>#1#</emphasis> contains <emphasis>3;1;5</emphasis>. + </para> + <para>Only the two information are necessary to recreate the boolean sparse.</para> + <para>HDF data types mapping:</para> + <para>32-bit integer</para> + <para> + <emphasis role="bold">Double</emphasis> + </para> + <para> + <emphasis role="strong">Scilab type:</emphasis> double + </para> + <para> + <emphasis role="strong">HDF5 Scilab type attribute:</emphasis> SCILAB_Class = double + </para> + <para> + <emphasis role="strong">Root dataset values:</emphasis> Both real and complex values are stored in a group called <literal>#<variable name>#</literal>. + </para> + <para> + First value: Reference to the real values. Named <literal>#0#</literal>. + </para> + <para> + If the matrix is complex, the second value will reference the complex values. Named <literal>#1#</literal>. + </para> + <para> + <emphasis role="strong">HDF data types mapping:</emphasis> 64-bit floating-point + </para> + <para> + <emphasis role="bold">Polynomial</emphasis> + </para> + <para> + <emphasis role="strong">Scilab type:</emphasis> polynomial + </para> + <para> + <emphasis role="strong">HDF5 Scilab type attribute:</emphasis> SCILAB_Class = polynomial + </para> + <para> + <emphasis role="strong">HDF5 attributes: </emphasis> + </para> + <para>SCILAB_Class = polynomial</para> + <para>SCILAB_varname = <string></para> + <para>The symbolic variable name</para> + <para> + <emphasis>SCILAB_Complex = <boolean></emphasis> + </para> + <para>If the polynomial is complex (not set if false)</para> + <para> + <emphasis role="strong">Root dataset values:</emphasis> + </para> + <para>Coefficients are stored under the form of a matrix of double (cf the relative section to double storage). It is interesting to note that coefficients can be complex and, therefore, be stored as a matrix of complex. Rules of naming of the (sub-)groups and dataset are described at the beginning of the chapter.</para> + <para> + <emphasis role="strong">HDF data types mapping:</emphasis> Object reference + </para> + <para> + <emphasis role="bold">list</emphasis> + </para> + <para> + <emphasis role="strong">Scilab type:</emphasis> list + </para> + <para> + <emphasis role="strong">HDF5 Scilab type attribute:</emphasis> + </para> + <para>SCILAB_Class = list</para> + <para> + <emphasis role="strong">HDF5 attributes:</emphasis> SCILAB_items = <number of items in the list> + </para> + <para> + <emphasis role="strong">Root dataset values:</emphasis> + </para> + <para> + Associated to the root dataset, values stored in this dataset are the references to the values stored in the list. The values are stored in the group called <literal>#<variable name>#</literal>. In the <literal>#<variable name>#</literal> group, data can be any type. They are included straight into the group. Their representations are the same as in other cases, based in recursive structure (meaning that list of list of list of various types can stored and loaded). + </para> + <para>Rules of naming of the (sub-)groups and dataset are described at the beginning of the chapter.</para> + <para> + <emphasis role="strong">HDF data types mapping:</emphasis> Object reference + </para> + <para> + <emphasis role="bold">tlist </emphasis> + </para> + <para> + <emphasis role="strong">Scilab type:</emphasis> tlist + </para> + <para> + <emphasis role="strong">HDF5 Scilab type attribute:</emphasis> + </para> + <para> SCILAB_Class = tlist</para> + <para> + <emphasis role="strong">HDF5 attributes:</emphasis> cf list + </para> + <para> + <emphasis role="bold">mlist </emphasis> + </para> + <para> + <emphasis role="strong">Scilab type:</emphasis> mlist + </para> + <para> + <emphasis role="strong">HDF5 Scilab type attribute:</emphasis> + </para> + <para>SCILAB_Class = mlist</para> + <para> + <emphasis role="strong">HDF5 attributes:</emphasis> cf list + </para> + <para> + <emphasis role="bold">void </emphasis> + </para> + <para> + <emphasis role="strong">Scilab type:</emphasis> void + </para> + <para> + <emphasis role="strong">HDF5 Scilab type attribute:</emphasis> + </para> + <para>SCILAB_Class = void</para> + <para>A void value can only be found in very special usages of list, tlist and mlist. It can be created with the following syntax:</para> + <programlisting>voidelement_ref=list(1,,3);</programlisting> + <para> + <emphasis role="bold">undefined </emphasis> + </para> + <para> + <emphasis role="strong">Scilab type:</emphasis> undefined + </para> + <para> + <emphasis role="strong">HDF5 Scilab type attribute:</emphasis> + </para> + <para> SCILAB_Class = undefined</para> + <para> + An undefined value is generated when the size of a list is increased and some elements not defined. They will be generated with the syntax: + </para> + <programlisting> + undefinedelement_ref=list(2,%i,'f',ones(3,3)); + undefinedelement_ref(6)="toto" + </programlisting> + </refsection> + <refsection> + <title>Real life examples</title> + <para> + Sample files of all these variables are provided into the Scilab distribution. They are available in the directory: <emphasis>SCI/modules/hdf5/tests/sample_scilab_data/</emphasis> + </para> + <para>At the date of redaction of this document, the following files are provided with the Scilab distribution:</para> + <emphasis role="italic"> + <para> + booleanmatrix.sod + </para> + <para>booleanscalar.sod + </para> + <para>booleansparse.sod + </para> + <para>emptymatrix.sod + </para> + <para>emptysparse.sod + </para> + <para>hypermatrixcomplex.sod + </para> + <para>hypermatrix.sod + </para> + <para>int16.sod + </para> + <para>int32.sod + </para> + <para>int8.sod + </para> + <para>listnested.sod + </para> + <para>list.sod + </para> + <para>matricedoublecomplexscalar.sod + </para> + <para>matricedoublecomplex.sod + </para> + <para>matricedoublescalar.sod + </para> + <para>matricedouble.sod + </para> + <para>matricestringscalar.sod + </para> + <para>matricestring.sod + </para> + <para>mlist.sod + </para> + <para>polynomialscoef.sod + </para> + <para>polynomials.sod + </para> + <para>sparsematrix.sod + </para> + <para>tlist.sod + </para> + <para>uint16.sod + </para> + <para>uint32.sod + </para> + <para>uint8.sod + </para> + <para>undefinedelement.sod + </para> + <para>voidelement.sod + </para> + </emphasis> + </refsection> + <refsection> + <title>Format evolutions</title> + <informaltable border="1"> + <tbody> + <tr> + <td align="justify"> + <emphasis role="bold">SOD version</emphasis> + </td> + <td align="justify"> + <emphasis role="bold">Scilab version</emphasis> + </td> + <td align="justify"> + <emphasis role="bold">Description</emphasis> + </td> + </tr> + <tr> + <td align="justify"> + <para>0</para> + </td> + <td align="justify"> + <para>5.2.0</para> + </td> + <td align="justify"> + <para>Initial version of the Scilab/HDF5 format</para> + </td> + </tr> + <tr> + <td align="justify"> + <para>1</para> + </td> + <td align="justify"> + <para>5.4.0 alpha / beta</para> + </td> + <td align="left"> + <para>Default format for load and save</para> + <para>Previous format (.bin) still supported</para> + </td> + </tr> + <tr> + <td> + <para>2</para> + </td> + <td> + <para>5.4.0</para> + </td> + <td> + <para> + For matrices of double, integer, polynomial and string <emphasis>SCILAB_cols</emphasis> / <emphasis>SCILAB_rows</emphasis> have been removed to use multidimensional HDF5 + </para> + </td> + </tr> + <tr> + <td align="justify"> + + </td> + <td align="justify"> + <para>6.0.0 (future)</para> + </td> + <td align="justify"> + <para>.bin support dropped.</para> + </td> + </tr> + </tbody> + </informaltable> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="save">save</link> + </member> + <member> + <link linkend="load">load</link> + </member> + <member> + <link linkend="listvarinfile">listvarinfile</link> + </member> + <member> + <link linkend="type">type</link> + </member> + <member> + <link linkend="typeof">typeof</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/en_US/scanf.xml b/modules/fileio/help/en_US/scanf.xml new file mode 100755 index 000000000..16f7f54ef --- /dev/null +++ b/modules/fileio/help/en_US/scanf.xml @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="scanf"> + <refnamediv> + <refname>scanf</refname> + <refpurpose>converts formatted input on standard input</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>[v_1, ..., v_n] = scanf(format);</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>format</term> + <listitem> + <para>a character string: specifies the format conversion.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>v_1, ..., v_n</term> + <listitem> + <para>converted results.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + The <function>scanf</function> function gets character data on standard input (<code>%io(1)</code>), interprets it according + to a <varname>format</varname>, and returns the converted results <varname>v_1</varname>, ..., <varname>v_n</varname>. + </para> + <para> + The <varname>format</varname> parameter contains conversion specifications + used to interpret the input. + </para> + <para> + The <varname>format</varname> parameter can contain + white-space characters (blanks, tabs, newline, or formfeed) + that, except in the following two cases, read the input up to the + next nonwhite-space character. Unless there is a match in the control + string, trailing white-space (including a newline character) is not + read. + </para> + <itemizedlist> + <listitem> + <para> + Any character except <literal>%</literal> (percent sign), which must match the next character of the input stream. + </para> + </listitem> + <listitem> + <para> + A conversion specification that directs the conversion of the next input field. See <link linkend="scanf_conversion">scanf_conversion</link> for details. + </para> + </listitem> + </itemizedlist> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="read">read</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="scanf_conversion">scanf_conversion</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/en_US/scanf_conversion.xml b/modules/fileio/help/en_US/scanf_conversion.xml new file mode 100755 index 000000000..a7547df2a --- /dev/null +++ b/modules/fileio/help/en_US/scanf_conversion.xml @@ -0,0 +1,157 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="scanf_conversion"> + <refnamediv> + <refname>scanf_conversion</refname> + <refpurpose>mscanf, msscanf, mfscanf conversion specifications</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + Each conversion specification in the <varname>format</varname> parameter contains the following elements: + </para> + <itemizedlist> + <listitem> + <para> + the character <literal>%</literal> (percent sign); + </para> + </listitem> + <listitem> + <para> + the optional assignment suppression character <literal>*</literal> (asterisk); + </para> + </listitem> + <listitem> + <para> + an optional numeric maximum field width; + </para> + </listitem> + <listitem> + <para> + a conversion code. + </para> + </listitem> + </itemizedlist> + <para> + The conversion specification has the following syntax: + </para> + <para> + <literal>[*][width][size]convcode</literal>. + </para> + <para> + The results from the conversion are placed in <varname>v_i</varname> arguments unless you specify assignment suppression with <literal>*</literal> (asterisk). Assignment suppression provides a way to describe an input field that is to be skipped. The input field is a string of nonwhite-space characters. It extends to the next inappropriate character or until the field width, if specified, is exhausted. + </para> + <para> + The conversion code indicates how to interpret the input field. + You should not specify the <varname>v_i</varname> parameter for a + suppressed field. You can use the following conversion codes: + </para> + <variablelist> + <varlistentry> + <term>%</term> + <listitem> + <para> + accepts a single <literal>%</literal> (percent sign) input at this point; no assignment is done. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>d, i</term> + <listitem> + <para>accepts a decimal integer.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>u</term> + <listitem> + <para>accepts an unsigned decimal integer.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>o</term> + <listitem> + <para>accepts an octal integer.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x</term> + <listitem> + <para>accepts a hexadecimal integer.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>e, f, g</term> + <listitem> + <para> + accepts a floating-point number. The next field is converted accordingly and stored through the corresponding parameter, which should be a pointer to a float. The input format for floating-point numbers is a string of digits, with the following optional characteristics: + </para> + <itemizedlist> + <listitem> + <para> + it can be a signed value; + </para> + </listitem> + <listitem> + <para> + it can be an exponential value, containing a decimal point followed by an exponent field, which consists of an <literal>E</literal> or an <literal>e</literal> followed by an (optionally signed) integer; + </para> + </listitem> + <listitem> + <para> + it can be one of the special values <constant>%inf</constant>, <constant>%nan</constant>; + </para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + <varlistentry> + <term>s</term> + <listitem> + <para>accepts a string of characters.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>c</term> + <listitem> + <para> + character value is expected. The normal skip over white-space is suppressed. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>%lg</term> + <listitem> + <para>gets value as a double.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="msscanf">msscanf</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="mscanf">mscanf</link> + </member> + <member> + <link linkend="printf_conversion">printf_conversion</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/fr_FR/addchapter.sce b/modules/fileio/help/fr_FR/addchapter.sce new file mode 100755 index 000000000..5161b0f9d --- /dev/null +++ b/modules/fileio/help/fr_FR/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Entrées/Sorties [fichiers]",SCI+"/modules/fileio/help/fr_FR",%T); + diff --git a/modules/fileio/help/fr_FR/directory/CHAPTER b/modules/fileio/help/fr_FR/directory/CHAPTER new file mode 100755 index 000000000..cf7f4739a --- /dev/null +++ b/modules/fileio/help/fr_FR/directory/CHAPTER @@ -0,0 +1,2 @@ +title= Répertoire + diff --git a/modules/fileio/help/fr_FR/directory/chdir.xml b/modules/fileio/help/fr_FR/directory/chdir.xml new file mode 100755 index 000000000..b51c5ee02 --- /dev/null +++ b/modules/fileio/help/fr_FR/directory/chdir.xml @@ -0,0 +1,73 @@ +<?xml version="1.0" encoding="UTF-8"?> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="chdir"> + <refnamediv> + <refname>chdir</refname> + <refpurpose>change le répertoire courant de + Scilab + </refpurpose> + </refnamediv> + <refnamediv xml:id="cd"> + <refname>cd</refname> + <refpurpose>change le répertoire courant de + Scilab + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>chdir(path) + realpath=cd(path) + cd path + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para>une chaîne de caractères fournissant le chemin du + répertoire. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>realpath</term> + <listitem> + <para>une chaîne de caractères, le chemin effectif après conversion + (voir ci-dessous) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Change le répertoire courrant de Scilab par celui donné par la + variable <literal>path</literal>. + </para> + <para> + <note> + Notez que le chemin fourni est converti. Ainsi + <literal>SCI/modules/fileio/macros</literal> est un chemin valide pour Unix et Windows. Si + path est vide , le chemin de destination est alors "home". + </note> + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +chdir(TMPDIR); +pwd +cd +cd SCI + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="pwd">pwd</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/fr_FR/directory/mkdir.xml b/modules/fileio/help/fr_FR/directory/mkdir.xml new file mode 100755 index 000000000..b3cdc4707 --- /dev/null +++ b/modules/fileio/help/fr_FR/directory/mkdir.xml @@ -0,0 +1,72 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mkdir" xml:lang="fr"> + <refnamediv> + <refname>mkdir</refname> + <refpurpose>Crée un nouveau répertoire</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis> + mkdir('dirname') + mkdir('parentdir','newdir') + status=mkdir( ... ) + [status,msg]=mkdir( ... ) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + <literal>mkdir('dirname')</literal> crée le répertoire <literal>dirname</literal>. + Si dirname représente un chemin relatif, le + répertoire dirname est créé dans le répertoire + courant. + </para> + <para> + <literal>mkdir('parentdir', 'dirname')</literal> crée le répertoire + <literal>dirname</literal> dans le répertoire existant + <literal>parentdir</literal>, ou <literal>parentdir</literal> est un + chemin relatif ou absolu. + </para> + <para> + <literal>[status,message] = mkdir('parentdir', 'dirname')</literal> crée le répertoire + <literal>dirname</literal> dans le répertoire existant + <literal>parentdir</literal>, retourne le statut, et un message. Ici, + <literal>status</literal> vaut 1 si tout c'est bien passé, 2 si le + répertoire existe déjà, -2 si c'est un nom de fichiers, 0 dans + un autre cas. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"> + <![CDATA[ +// Chemin absolu +mkdir(TMPDIR+"/mkdir_example_1") +status_2 = mkdir(TMPDIR+"/mkdir_example_2") +[status_3,msg_3] = mkdir(TMPDIR+"/mkdir_example_3") + +// Chemin absolu (parentdir + dirname) +[status_4,msg_4] = mkdir(TMPDIR,"mkdir_example_4") + +// Chemin relatif +cd TMPDIR; +[status_5,msg_5] = mkdir("mkdir_example_5") +[status_6,msg_6] = mkdir("mkdir_example_5/mkdir_example_6") + ]]> + </programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="cd">cd</link> + </member> + <member> + <link linkend="dir">dir</link> + </member> + <member> + <link linkend="rmdir">rmdir</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/fr_FR/directory/pwd.xml b/modules/fileio/help/fr_FR/directory/pwd.xml new file mode 100755 index 000000000..2db1d03d3 --- /dev/null +++ b/modules/fileio/help/fr_FR/directory/pwd.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8"?> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="pwd"> + <refnamediv> + <refname>pwd</refname> + <refpurpose>affiche le répertoire courant de Scilab </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>pwd + x=pwd() + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + <literal>pwd</literal> renvoie dans <literal>ans</literal> le répertoire courant de Scilab. + <literal>x=pwd()</literal> renvoie dans <literal>x</literal> le répertoire courant de Scilab. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +pwd +x=pwd() + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="chdir">chdir</link> + </member> + <member> + <link linkend="cd">cd</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/fr_FR/directory/rmdir.xml b/modules/fileio/help/fr_FR/directory/rmdir.xml new file mode 100755 index 000000000..18f0f57ab --- /dev/null +++ b/modules/fileio/help/fr_FR/directory/rmdir.xml @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="UTF-8"?> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="rmdir"> + <refnamediv> + <refname>rmdir</refname> + <refpurpose>Supprime un répertoire</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>rmdir('dirname') + rmdir('dirname','s') + [status,message] = rmdir('dirname','s') + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para>rmdir('dirname') supprime le répertoire dirname depuis le répertoire + courant. Si le répertoire n'est pas vide, vous devez utiliser l'argument + s. Si dirname n'est pas dans le répertoire courant , vous devez specifier + le chemin relatif ou complet pour acceder a dirname. + </para> + <para>rmdir('dirname','s') suppprime le répertoire dirname depuis le + répertoire courant et ses sous répertoires ainsi que leurs contenus. + </para> + <para>[status, message] = rmdir('dirname','s') supprime le répertoire dirname + et son contenu depuis le répertoire courant et retourne la variable status + et un message. Ici, status vaut 1 si l'execution s'est bien passé et 0 en + cas d'erreur. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +mkdir(SCI,'Directory') +rmdir(SCI+'/Directory') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="cd">cd</link> + </member> + <member> + <link linkend="dir">dir</link> + </member> + <member> + <link linkend="mkdir">mkdir</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/fr_FR/path_filename/CHAPTER b/modules/fileio/help/fr_FR/path_filename/CHAPTER new file mode 100755 index 000000000..74627e0b8 --- /dev/null +++ b/modules/fileio/help/fr_FR/path_filename/CHAPTER @@ -0,0 +1,2 @@ +title = Chemins - nom de fichiers + diff --git a/modules/fileio/help/fr_FR/path_filename/fullfile.xml b/modules/fileio/help/fr_FR/path_filename/fullfile.xml new file mode 100755 index 000000000..503592016 --- /dev/null +++ b/modules/fileio/help/fr_FR/path_filename/fullfile.xml @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="UTF-8"?> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="fullfile"> + <refnamediv> + <refname>fullfile</refname> + <refpurpose>Construit un nom de fichier complet</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>f = fullfile(varargin)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>varargin</term> + <listitem> + <para>tous les répertoires et le nom de fichier utilisés pour créer le nom de fichier complet (au moins un répertoire et un nom de fichier)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>f</term> + <listitem> + <para>nom de fichier complet</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>f= fullfile(varargin)</literal> construit un nom de fichier complet en prenant en compte la plateforme actuelle et en gérant les cas où les noms de répertoires commencent ou finissent par un séparateur de répertoire. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[f = fullfile("/home/", "\scilab", "macros", "\util", "fullfile.sci") +f = fullfile("C:", "\scilab", "macros", "\util", "fullfile.sci") +r = fullfile("/home/","\scilab","macros","\util", ["fullfile.sci"; "toto.sci"])]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="pathconvert">pathconvert</link> + </member> + <member> + <link linkend="fileparts">fileparts</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/fr_FR/path_filename/getlongpathname.xml b/modules/fileio/help/fr_FR/path_filename/getlongpathname.xml new file mode 100755 index 000000000..e80f7383b --- /dev/null +++ b/modules/fileio/help/fr_FR/path_filename/getlongpathname.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="getlongpathname" xml:lang="fr"> + <refnamediv> + <refname>getlongpathname</refname> + <refpurpose>retourne le chemin au format nom long (Seulement pour + Windows) + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>longpath=getlongpathname(shortpath) + [longpath,bOK]=getlongpathname(shortpath) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>shortpath</term> + <listitem> + <para>Une chaine de caracteres ou une matrice de chaines de + caracteres contenant le chemin au format court + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>longpath</term> + <listitem> + <para>Une chaine de caracteres ou une matrice de chaines de + caracteres contenant le chemin au format long. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>bOK</term> + <listitem> + <para>retourne %T si le chemin a ete converti ou %F dans le cas + contraire. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>La primitive getlongpathname convertie le chemin au format court en + un nom de chemin au format long. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +[longpath,bOK]=getlongpathname(SCI) +[longpaths,bOKs]=getlongpathname([SCI;SCI]) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="getshortpathname">getshortpathname</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/fr_FR/path_filename/getshortpathname.xml b/modules/fileio/help/fr_FR/path_filename/getshortpathname.xml new file mode 100755 index 000000000..7053e075c --- /dev/null +++ b/modules/fileio/help/fr_FR/path_filename/getshortpathname.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="getshortpathname" xml:lang="fr"> + <refnamediv> + <refname>getshortpathname</refname> + <refpurpose>retourne le chemin au format court (Seulement pour + Windows) + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Séquence d'appel</title> + <synopsis>shortpath=getshortgpathname(longpath) + [shortpath,bOK]=getshortpathname(longpath) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Paramètres</title> + <variablelist> + <varlistentry> + <term>longpath</term> + <listitem> + <para>Une chaine de caractere ou une matrice de chaines de + caracteres contenant le chemin au format long. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>shortpath</term> + <listitem> + <para>Une chaine de caractere ou une matrice de chaines de + caracteres contenant le chemin au format court + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>bOK</term> + <listitem> + <para>contient %T si le chemin a ete converti ou %F si ce n'est pas + le cas. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>La primitive getshortpathname convertie un chemin au format long en + un chemin au format court. + </para> + </refsection> + <refsection> + <title>Exemples</title> + <programlisting role="example"><![CDATA[ +[shortpath,bOK]=getshortpathname(SCI) +[shortpaths,bOKs]=getshortpathname([SCI,SCI]) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Voir aussi</title> + <simplelist type="inline"> + <member> + <link linkend="getlongpathname">getlongpathname</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/images/img001.png b/modules/fileio/help/images/img001.png Binary files differnew file mode 100755 index 000000000..6d0607dd8 --- /dev/null +++ b/modules/fileio/help/images/img001.png diff --git a/modules/fileio/help/images/img002.png b/modules/fileio/help/images/img002.png Binary files differnew file mode 100755 index 000000000..1b2cc33c0 --- /dev/null +++ b/modules/fileio/help/images/img002.png diff --git a/modules/fileio/help/ja_JP/addchapter.sce b/modules/fileio/help/ja_JP/addchapter.sce new file mode 100755 index 000000000..50bfd2d84 --- /dev/null +++ b/modules/fileio/help/ja_JP/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Files : Input/Output functions",SCI+"/modules/fileio/help/ja_JP",%T); + diff --git a/modules/fileio/help/ja_JP/copyfile.xml b/modules/fileio/help/ja_JP/copyfile.xml new file mode 100755 index 000000000..ccd071c83 --- /dev/null +++ b/modules/fileio/help/ja_JP/copyfile.xml @@ -0,0 +1,181 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="copyfile" xml:lang="ja"> + + <refnamediv> + + <refname>copyfile</refname> + + <refpurpose>ファイルをコピー</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>copyfile(source, destination) + + [status, message] = copyfile(source, destination) + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>source</term> + + <listitem> + + <para> + + 文字列: ファイル名またはディレクトリ名. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>destination</term> + + <listitem> + + <para>文字列: ディレクトリ名. + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <code>copyfile(source,destination)</code> は, + + ファイルまたはディレクトリ<varname>source</varname>を, + + ファイルまたはディレクトリ<varname>destination</varname>に + + コピーします. + + </para> + + <para> + + <varname>source</varname>がディレクトリの場合, + + <varname>destination</varname>にファイルを指定することは + + できません. + + <warning> + + <code>copyfile</code> 警告を発生せずに既存のファイルを置換します. + + </warning> + + </para> + + <para> + + <code>[status, message] = copyfile(source, destination)</code>は, + + <varname>source</varname> から <varname>destination</varname>にコピーし, + + <varname>status</varname> および <varname>message</varname>を返します. + + </para> + + <para> + + どのようなオペレーティン部システムであろうと, + + コピーに成功した場合,<varname>status</varname>は1となり, + + <varname>message</varname>は空になります ; + + コピーに失敗した場合, + + <varname>status</varname>は0となり,<varname>message</varname>は空でなくなります. + + </para> + + <para> + + コピー先のファイルに指定されるタイムスタンプは + + コピー元のファイルのものと同じになります. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"> + + copyfile(SCI+"/etc/scilab.start",TMPDIR+"/scilab.start") + + [status,message] = copyfile(SCI+"/etc/scilab.start",TMPDIR); + + </programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="movefile">movefile</link> + + </member> + + <member> + + <link linkend="mdelete">mdelete</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/deletefile.xml b/modules/fileio/help/ja_JP/deletefile.xml new file mode 100755 index 000000000..3dd1f458c --- /dev/null +++ b/modules/fileio/help/ja_JP/deletefile.xml @@ -0,0 +1,104 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="deletefile" xml:lang="ja"> + + <refnamediv> + + <refname>deletefile</refname> + + <refpurpose>ファイルを削除する</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>f = deletefile(filename)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>filename</term> + + <listitem> + + <para>文字列: 存在または存在しないファイルの名前.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>f</term> + + <listitem> + + <para> + + 論理値: <literal>%t</literal> または <literal>%f</literal> + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + この関数は,ファイル<varname>filename</varname>を削除します. + + ファイル<varname>filename</varname>が削除された場合に <literal>%t</literal> , + + それ以外の場合に<literal>%f</literal>を返します. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +fd = mopen(TMPDIR+'/filetodelete.txt','wt'); +mclose(fd); +if (fileinfo(TMPDIR+'/filetodelete.txt') <> []) then +deletefile(TMPDIR+'/filetodelete.txt') +end +deletefile(TMPDIR+'/notexistingfile') + ]]></programlisting> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/directory/CHAPTER b/modules/fileio/help/ja_JP/directory/CHAPTER new file mode 100755 index 000000000..8f46dc5e9 --- /dev/null +++ b/modules/fileio/help/ja_JP/directory/CHAPTER @@ -0,0 +1,2 @@ +title= Directory + diff --git a/modules/fileio/help/ja_JP/directory/chdir.xml b/modules/fileio/help/ja_JP/directory/chdir.xml new file mode 100755 index 000000000..b2d7542bf --- /dev/null +++ b/modules/fileio/help/ja_JP/directory/chdir.xml @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8"?> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="chdir"> + <refnamediv> + <refname>chdir</refname> + <refpurpose>Scilab カレントディレクトリを変更する</refpurpose> + </refnamediv> + <refnamediv xml:id="cd"> + <refname>cd</refname> + <refpurpose>Scilab カレントディレクトリを変更する</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>b=chdir(path) + realpath=cd(path) + cd path + </synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>b</term> + <listitem> + <para>chdir処理がokの場合に論理値 %t. </para> + </listitem> + </varlistentry> + <varlistentry> + <term>path</term> + <listitem> + <para>文字列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>realpath</term> + <listitem> + <para>文字列, パス名変換の後に実際のパス名(以下参照)</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + カレントの Scilab ディレクトリを<literal>path</literal> + で指定したディレクトリに変更します. + パス変換が実行されるため,例えば, + <literal>SCI/modules/core/macros</literal>は unix および windows の両方で + 有効であることに注意してください. + path が空の場合, "home" ディレクトリに変更されます. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +chdir(TMPDIR); +pwd +cd +cd SCI + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="pwd">pwd</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/directory/createdir.xml b/modules/fileio/help/ja_JP/directory/createdir.xml new file mode 100755 index 000000000..36dc1ff77 --- /dev/null +++ b/modules/fileio/help/ja_JP/directory/createdir.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="createdir"> + <refnamediv> + <refname>createdir</refname> + <refpurpose>新規ディレクトリを作成</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>createdir('dirname') + status = createdir('dirname') + </synopsis> + </refsynopsisdiv> + <refsection> + <title>説明</title> + <para>createdir('dirname') はカレントのディレクトリに + ディレクトリ dirname を作成します. + dirname がカレントのディレクトリでない場合, + カレントのディレクトリに対する相対パスまたは dirname への絶対パスを + 指定してください. + </para> + <para>[status] = createdir('dirname') は + 既存のディレクトリ parentdir の中にディレクトリ dirname を作成し, + ステータスとメッセージを返します. + ここで,ステータスは成功時に %T, その他の場合 %F となります. + </para> + <para>createdir は mkdirで使用されます.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +createdir(SCIHOME+'/Directory_test') +removedir(SCIHOME+'/Directory_test') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="mkdir">mkdir</link> + </member> + <member> + <link linkend="rmdir">rmdir</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/directory/dir.xml b/modules/fileio/help/ja_JP/directory/dir.xml new file mode 100755 index 000000000..0b7e94b0e --- /dev/null +++ b/modules/fileio/help/ja_JP/directory/dir.xml @@ -0,0 +1,114 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="dir"> + <refnamediv> + <refname>dir</refname> + <refpurpose>ファイル一覧を取得する</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>dir path + S=dir([path]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para> + ディレクトリpathnameを指定する文字列行列 + (<literal>*</literal>を含むパターンで終わる場合もあります). + デフォルト値は<literal>.</literal>です. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>S</term> + <listitem> + <para> + <literal>dir</literal>型の<literal>tlist</literal>で + 以下のフィールドを有します : + <literal>name</literal>, <literal>date</literal> および + <literal>isdir</literal> + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + <literal>dir</literal> は path 引数により指定したパターンに + 一致するファイルを取得するために使用することができます. + パターンは,ファイルに関する情報を取得するために, + unix <literal>ls</literal> または + Windows <literal>dir</literal> コマンドに指定されます. + よって, ポータブルな Scilab スクリプトを書くためには, + 両方のOSで有効なワイルドカードパターンを指定する必要があります. + pathname 変換が行われるため, + 例えば, <literal>SCI/modules/core/macros/*.sci</literal> は + unix および windows の両方で有効なパターンとなることに注意してください. + </para> + <para> + 戻り値の変数の<literal>name</literal> フィールドファイル名の + 列ベクトルです. + </para> + <para> + 戻り値の + <literal>date</literal> フィールドは, 1970年1月1日からの積算日でコード化された + 直近の修正日を含む整数の列ベクトルです. + </para> + <para> + 戻り値の変数のフィールド<literal>isdir</literal>は, + 対応する名前がディレクトリの場合に true となる + 論理値の列ベクトルです. + </para> + <para> + デフォルトで表示される戻り値の構造はファイルの整形済みの列です. + これは,関数<literal>%dir_p</literal>を再定義することにより変更することが可能です. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +dir +dir SCI/modules/core/macros/*.bin +x=dir('SCI/modules/core/macros/*.bin') +dt=getdate(x.date); +mprintf("%s: %04d-%02d-%02d %02d:%02d:%02d\n",x.name,dt(:,[1 2 6 7:9])) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="listfiles">listfiles</link> + </member> + <member> + <link linkend="findfiles">findfiles</link> + </member> + <member> + <link linkend="ls">ls</link> + </member> + <member> + <link linkend="fileinfo">fileinfo</link> + </member> + <member> + <link linkend="date">date</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/directory/isdir.xml b/modules/fileio/help/ja_JP/directory/isdir.xml new file mode 100755 index 000000000..bb58ddc83 --- /dev/null +++ b/modules/fileio/help/ja_JP/directory/isdir.xml @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Serge STEER + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="isdir"> + <refnamediv> + <refname>isdir</refname> + <refpurpose>引数がディレクトリパスかどうかを調べる</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>r=isdir(path)</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para>文字列または文字列の行列, ファイルのパス名</para> + </listitem> + </varlistentry> + <varlistentry> + <term>r</term> + <listitem> + <para> + 論理値, <literal>path</literal> がディレクトリへのパスの場合に真. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + <literal>r=isdir(path)</literal> は, <literal>path</literal> がディレクトリへのパスかどうかを調べます. + </para> + </refsection> + <refsection role="see also"> + <title>参照</title> + <para> + この関数はC関数 stat に基づいています. <literal>SCI</literal> および + Scilabディレクトリに関するショートカット<literal>~</literal> + およびホームディレクトリが処理されます. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +isdir(TMPDIR) +isdir SCI/etc/scilab.start + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="fileinfo">fileinfo</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/directory/ls.xml b/modules/fileio/help/ja_JP/directory/ls.xml new file mode 100755 index 000000000..0bbe76f95 --- /dev/null +++ b/modules/fileio/help/ja_JP/directory/ls.xml @@ -0,0 +1,100 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="ls"> + <refnamediv> + <refname>ls</refname> + <refpurpose>ファイルを表示</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>ls path options + files=ls( [path] ) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para>ディレクトリパス名を指定する文字列行列 (多くの場合,末尾が + <literal>*</literal>のパターンとなります).デフォルト値は + <literal>.</literal>です. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>files</term> + <listitem> + <para>文字列の列ベクトル. デフォルトで, + 列整形された出力を含みます.オプションの一つが + <literal>'-1'</literal>の場合, <literal>files</literal> は各ファイルに関する + エントリを含みます. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + <literal>ls</literal> は, + path引数で指定したパターンに一致するファイルの一覧を得るために + 使用することができます. + パターンは,ファイルに関する情報を取得するために + Unixでは<literal>ls</literal>,Windowsでは + <literal>dir</literal>コマンドに指定されます. + このため, ポータブルなScilabスクリプトを書くためには, + 両方のOSに有効なワイルドカードパターンを指定する必要があります. + パス名の変換が行われ,例えば<literal>SCI/core/macros/*.sci</literal> + はUnixとWindowsの両方で有効なパターンであることに注意してください. + </para> + <para> + 全てのファイルのベクトルを取得したい場合には, + <link linkend="listfiles">listfiles</link> または <link linkend="dir">dir</link>関数 + を使用することが推奨されます. + </para> + <para> + Scilab バージョン 5.0 以降, 2番目の入力引数 + (Unixシステムで指定可能な一連の文字列: Unix ls コマンドオプション) + が削除されたことに注意してください. + このオプションは,主にセキュリティおよび移植性のため削除されました. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +ls +ls SCI/modules/core/macros/*.sci +x=ls('SCI/modules/core/macros/*.sci') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="listfiles">listfiles</link> + </member> + <member> + <link linkend="findfiles">findfiles</link> + </member> + <member> + <link linkend="dir">dir</link> + </member> + <member> + <link linkend="fileinfo">fileinfo</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/directory/mkdir.xml b/modules/fileio/help/ja_JP/directory/mkdir.xml new file mode 100755 index 000000000..059f50c3d --- /dev/null +++ b/modules/fileio/help/ja_JP/directory/mkdir.xml @@ -0,0 +1,75 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mkdir" xml:lang="ja"> + <refnamediv> + <refname>mkdir</refname> + <refpurpose>新規ディレクトリ</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>mkdir('dirname') + mkdir('parentdir','newdir') + status=mkdir( ... ) + [status,msg]=mkdir( ... ) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>説明</title> + <para>mkdir('dirname') は,dirname が相対パスを表す場合, + カレントのディレクトリにディレクトリ dirname を作成します. + その他の場合, dirname は絶対パスを表し, + mkdir は絶対ディレクトリ dirname の作成を試みます. + </para> + <para>mkdir('parentdir','dirname') は既存のディレクトリ + parentdir にディレクトリ dirname を作成します. + ただし, parentdir は絶対またｈ相対パス名です. + </para> + <para>[status,message] = mkdir(...,'dirname') は, + 既存のディレクトリ parentdir に + ディレクトリ dirname を作成し, + メッセージ status を返します. + ここで, status は,成功の場合に1,ファイルがすでに存在する場合に2, + ファイル名の場合に-2,その他の場合に 0になります. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// 絶対パス名 +mkdir(TMPDIR+"/mkdir_example_1") +status_2 = mkdir(TMPDIR+"/mkdir_example_2") +[status_3,msg_3] = mkdir(TMPDIR+"/mkdir_example_3") +// 絶対パス名 (parentdir + dirname) +[status_4,msg_4] = mkdir(TMPDIR,"mkdir_example_4") +// 相対パス名 +cd TMPDIR; +[status_5,msg_5] = mkdir("mkdir_example_5") +[status_6,msg_6] = mkdir("mkdir_example_5/mkdir_example_6") + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="cd">cd</link> + </member> + <member> + <link linkend="dir">dir</link> + </member> + <member> + <link linkend="rmdir">rmdir</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/directory/pwd.xml b/modules/fileio/help/ja_JP/directory/pwd.xml new file mode 100755 index 000000000..bbf914d3d --- /dev/null +++ b/modules/fileio/help/ja_JP/directory/pwd.xml @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="UTF-8"?> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="pwd"> + <refnamediv> + <refname>pwd</refname> + <refpurpose>Scilab カレントディレクトリを出力</refpurpose> + </refnamediv> + <refnamediv> + <refname>pwd</refname> + <refpurpose>Scilab カレントディレクトリを取得</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>pwd + x=pwd() + </synopsis> + </refsynopsisdiv> + <refsection> + <title>説明</title> + <para> + <literal>pwd</literal> は, Scilab カレントディレクトリ を <literal>ans</literal> に返します. + <literal>x=pwd()</literal> は <literal>x</literal> にScilab カレントディレクトリを返します. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +pwd +x=pwd() + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="chdir">chdir</link> + </member> + <member> + <link linkend="cd">cd</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/directory/removedir.xml b/modules/fileio/help/ja_JP/directory/removedir.xml new file mode 100755 index 000000000..d825ff090 --- /dev/null +++ b/modules/fileio/help/ja_JP/directory/removedir.xml @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="removedir"> + <refnamediv> + <refname>removedir</refname> + <refpurpose>ディレクトリを削除</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>removedir('dirname') + [status] = removedir('dirname','s') + </synopsis> + </refsynopsisdiv> + <refsection> + <title>説明</title> + <para>removedir('dirname') は + カレントのディレクトリからディレクトリ dirname を削除します. + ディレクトリが空でない場合, + ファイルおよびサブディレクトリは削除されます. + dirnameがカレントディレクトリでない場合, + カレントディレクトリへの相対パスまたは dirname のフルパスを + 指定してください. + </para> + <para>[status] = removedir('dirname') はディレクトリ dirname と + その中身をカレントのディレクトリから削除し, + status を返します. + ここで, status は成功時に %T, エラー時に %F となります. + </para> + <para>removedir は rmdirで使用されます.</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +createdir(SCIHOME+'/Directory_test') +removedir(SCIHOME+'/Directory_test') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="mkdir">mkdir</link> + </member> + <member> + <link linkend="rmdir">rmdir</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/directory/rmdir.xml b/modules/fileio/help/ja_JP/directory/rmdir.xml new file mode 100755 index 000000000..4b9ff9f96 --- /dev/null +++ b/modules/fileio/help/ja_JP/directory/rmdir.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="rmdir"> + <refnamediv> + <refname>rmdir</refname> + <refpurpose>ディレクトリを削除</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>rmdir('dirname') + rmdir('dirname','s') + [status,message] = rmdir('dirname','s') + </synopsis> + </refsynopsisdiv> + <refsection> + <title>説明</title> + <para>rmdir('dirname') はカレントのディレクトリからディレクトリ dirname を + 削除します. + ディレクトリが空でない場合, + 引数 s を指定する必要があります. + dirname がカレントのディレクトリにない場合, + カレントディレクトリに対する相対パスまたは + dirname のフルパスを指定してください. + </para> + <para>rmdir('dirname','s') はディレクトリ dirname と + その中身をカレントのディレクトリから削除します. + </para> + <para>[status, message] = rmdir('dirname','s') はディレクトリ dirname + との中身をカレントのディレクトリから削除し, statusとメッセージを返します. + ここで statusは成功時に 1,エラー時に 0 となります. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +mkdir(SCI,'Directory') +rmdir(SCI+'/Directory') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="cd">cd</link> + </member> + <member> + <link linkend="dir">dir</link> + </member> + <member> + <link linkend="mkdir">mkdir</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/dispfiles.xml b/modules/fileio/help/ja_JP/dispfiles.xml new file mode 100755 index 000000000..a624fa06a --- /dev/null +++ b/modules/fileio/help/ja_JP/dispfiles.xml @@ -0,0 +1,109 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Serge STEER + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="dispfiles"> + + <refnamediv> + + <refname>dispfiles</refname> + + <refpurpose>オープンされているファイルのプロパティを表示</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>dispfiles([units])</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>units</term> + + <listitem> + + <para> + + 整数値のベクトル, ファイルの論理ユニット. + + デフォルトではオープンされている全ファイル. + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <function>dispfiles</function> は, + + 現在オープンされているファイルのプロパティを表示します. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +dispfiles() + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="file">file</link> + + </member> + + <member> + + <link linkend="mopen">mopen</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/fileinfo.xml b/modules/fileio/help/ja_JP/fileinfo.xml new file mode 100755 index 000000000..61424b7cd --- /dev/null +++ b/modules/fileio/help/ja_JP/fileinfo.xml @@ -0,0 +1,431 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="fileinfo" xml:lang="ja"> + + <refnamediv> + + <refname>fileinfo</refname> + + <refpurpose>ファイルに関する情報を出力</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>[x,ierr] = fileinfo(files)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>files</term> + + <listitem> + + <para>文字列または文字列の列ベクトル, ファイルパス名 + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>x</term> + + <listitem> + + <para> + + 情報を含む大きさ13の整数ベクトルまたは + + ファイルが存在しない場合に空の行列. + + </para> + + <para> + + <varname>files</varname>が文字列の列ベクトルの場合, + + <varname>x</varname> は + + 大きさ<literal>m x 13</literal>の行列となります. + + </para> + + <para> + + あるファイル名が存在しない場合, 出力情報として, + + 各要素に<constant>Nan</constant>を有する + + 大きさ13の行を返します. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>ierr</term> + + <listitem> + + <para>エラーインジケータ, エラーが発生していない場合に 0</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <code>x = fileinfo(file)</code> は以下を返します: + + </para> + + <variablelist> + + <varlistentry> + + <term>x(1)</term> + + <listitem> + + <para>ファイルの大きさ</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>x(2)</term> + + <listitem> + + <para>ファイルモード (10進値).</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>x(3)</term> + + <listitem> + + <para>ユーザid</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>x(4)</term> + + <listitem> + + <para>グループid</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>x(5)</term> + + <listitem> + + <para>デバイス番号</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>x(6)</term> + + <listitem> + + <para>直近の修正日</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>x(7)</term> + + <listitem> + + <para>直近の変更日</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>x(8)</term> + + <listitem> + + <para>直近のアクセス日</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>x(9)</term> + + <listitem> + + <para>デバイス型 (inode デバイスの場合)</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>x(10)</term> + + <listitem> + + <para>ファイルシステム I/O のブロックサイズ (Windowsでは常に0)</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>x(11)</term> + + <listitem> + + <para>確保されたブロック数 (Windowsでは常に0)</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>x(12)</term> + + <listitem> + + <para>inode</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>x(13)</term> + + <listitem> + + <para>ハードリンクの数</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>参考</title> + + <para> + + この関数はC関数<function>stat</function>へのインターフェイスです. + + </para> + + <para> + + 許可属性は,通常,8進数で指定されます : 変換には<code>dec2oct(x(2))</code> + + を使用します + + </para> + + <para> + + 数値モードは,1から4個の8進数 (0-7), + + 4, 2, および 1でビットを加算することにより導かれます. + + 全ての省略された桁は先頭にゼロがあると仮定されます. + + 最初の桁はユーザID(4)を選択し, + + グループID(2)およびスティッキー(1)属性を設定します. + + 2番目の桁は,fileを所有するユーザの許可属性を選択します + + : 読み込み(4), 書き込み(2),実行(1); + + 3桁目はファイルのグループの同じ値を有する + + 他のユーザの許可属性を選択します; + + 4桁目はファイルグループにない同じ値を有する許可属性を + + 選択します. + + </para> + + <para> + + 許可属性を確認するには, マスクを使用する必要があります. + + 次の例を見てみましょう: + + 8進数, x(2)=1664, 最初の桁はsticky属性に対応します. + + 2桁目はファイル所有者が書き込みおよび読込権限を有することを示します. + + これは,このファイルのグループ内の他のユーザも同じです. + + 最後に他のユーザは読込権限のみ有します. + + マスクを適用するには, この8進数をバイナリ(2進数)形式で見るだけで構いません. + + つまり:<varname>x</varname>(2)= 1 110 110 100. + + 所有者が書き込み権限を有するかどうか確認するには, + + 2番目のトリプレット: 110 を見て, 書き込み許可 010 を有するものと比較します. + + つまり,処理は以下のようになります: 110 000 000 & 010 000 000. + + 結果がヌルでない場合 (本ケースが相当), 所有者が書き込み権限を有します. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +w = fileinfo(SCI+'/etc/scilab.start') +// ファイル許可属性 +dec2oct(w(2)) +// ファイルの日付 +getdate(w(6)) + +// 許可 +S_IWRITE = 128; // 書き込み許可属性をマスク +S_IEXEC = 64; // 実行許可属性をマスク +S_IREAD = 256; // 読み込み許可属性をマスク +S_IFCHR = 8192; // ディレクトリ許可属性をマスク + +// 書き込み許可を確認 +if ( bitand( w(2), S_IWRITE ) <> 0) then + disp('WRITE PERMISSION on this file.'); +else + disp('NO WRITE PERMISSION on this file.'); +end + +// 読込許可を確認 +if ( bitand( w(2), S_IREAD ) <> 0) then + disp('READ PERMISSION on this file.'); +else + disp('NO READ PERMISSION on this file.'); +end + +FILES = [SCI;SCIHOME;'not_exist_file';TMPDIR] +[X,ERRS] = fileinfo(FILES) + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="getdate">getdate</link> + + </member> + + <member> + + <link linkend="file">file</link> + + </member> + + <member> + + <link linkend="dispfiles">dispfiles</link> + + </member> + + <member> + + <link linkend="newest">newest</link> + + </member> + + <member> + + <link linkend="isdir">isdir</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/findfiles.xml b/modules/fileio/help/ja_JP/findfiles.xml new file mode 100755 index 000000000..808d62960 --- /dev/null +++ b/modules/fileio/help/ja_JP/findfiles.xml @@ -0,0 +1,137 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="findfiles"> + + <refnamediv> + + <refname>findfiles</refname> + + <refpurpose> + + 指定したファイル仕様を有する全てのファイルを見つける + + </refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>f = findfiles() + + f = findfiles(path) + + f = findfiles(path, filespec) + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>path</term> + + <listitem> + + <para>文字列, パス.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>filespec</term> + + <listitem> + + <para> + + 文字列, ファイル仕様, 例えば <literal>"*.sce"</literal>. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>f</term> + + <listitem> + + <para>文字列の列ベクトル, ファイル名.</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + 指定したファイル仕様<varname>filespec</varname>を有する + + ファイルを全て見つけます. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +f=findfiles() +f=findfiles(SCI) +f=findfiles(SCI+'/modules/core/macros','*.sci') + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="listfiles">listfiles</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/fprintfMat.xml b/modules/fileio/help/ja_JP/fprintfMat.xml new file mode 100755 index 000000000..2fbdd4819 --- /dev/null +++ b/modules/fileio/help/ja_JP/fprintfMat.xml @@ -0,0 +1,285 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="fprintfMat"> + + <refnamediv> + + <refname>fprintfMat</refname> + + <refpurpose>行列をファイルに書き込む</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>fprintfMat(file, M [,format,text])</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>fil</term> + + <listitem> + + <para>文字列, 書き込むファイルのパス名</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>M</term> + + <listitem> + + <para>実数の行列</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>format</term> + + <listitem> + + <para> + + 形式を指定する文字列. オプションのパラメータで, + + デフォルト値は<literal>"%lf"</literal>. + + </para> + + <para>サポートされる形式: + + <literal>%[width].[precision]type</literal> または + + <literal>%type</literal>, ただし: + + </para> + + <para> + + <literal>width</literal>: + + 文字出力の最小数を指定するオプションの数値; + + </para> + + <para> + + <literal>precision</literal>: + + 出力フィールド全てまたは一部に関する + + 出力される文字の最大数を指定するオプションの数値; + + または整数値を印字する桁の最小数; + + </para> + + <para> + + <literal>type</literal>: lf, lg, d, i, e, f, g (詳細は<link + linkend="scanf_conversion">scanf_conversion</link> を参照). + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>text</term> + + <listitem> + + <para> + + ファイルの先頭に保存される + + 数値以外のコメントを指定する文字列の行(列)ベクトル. + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <function>fprintfMat</function> 関数は,整形済みのファイルに + + 行列を書き込みます. + + 行列の各行はファイルの中で1行となります. + + <varname>text</varname>が指定された場合, + + ファイルの先頭に1行に1要素/行で + + <varname>text</varname>の要素が要素毎に挿入されます. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +n = 50; +a = rand(n, n, "u"); +fprintfMat(TMPDIR + "/Mat", a, "%5.2f"); +a1 = fscanfMat(TMPDIR + "/Mat"); + +// ファイルMat1を作成し, コメントを挿入します +some_comment = ["This is a comment","This the second line of the comment.","This is the third line of the comment."]; +fprintfMat(TMPDIR + "/Mat1", a, "%5.2f",some_comment); + ]]> </programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="scanf_conversion">scanf_conversion</link> + + </member> + + <member> + + <link linkend="mclose">mclose</link> + + </member> + + <member> + + <link linkend="meof">meof</link> + + </member> + + <member> + + <link linkend="mfprintf">mfprintf</link> + + </member> + + <member> + + <link linkend="mfscanf">mfscanf</link> + + </member> + + <member> + + <link linkend="fscanfMat">fscanfMat</link> + + </member> + + <member> + + <link linkend="mget">mget</link> + + </member> + + <member> + + <link linkend="mgetstr">mgetstr</link> + + </member> + + <member> + + <link linkend="mopen">mopen</link> + + </member> + + <member> + + <link linkend="mprintf">mprintf</link> + + </member> + + <member> + + <link linkend="mput">mput</link> + + </member> + + <member> + + <link linkend="mputstr">mputstr</link> + + </member> + + <member> + + <link linkend="mscanf">mscanf</link> + + </member> + + <member> + + <link linkend="mseek">mseek</link> + + </member> + + <member> + + <link linkend="mtell">mtell</link> + + </member> + + <member> + + <link linkend="mdelete">mdelete</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/fscanfMat.xml b/modules/fileio/help/ja_JP/fscanfMat.xml new file mode 100755 index 000000000..e50510717 --- /dev/null +++ b/modules/fileio/help/ja_JP/fscanfMat.xml @@ -0,0 +1,344 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="fscanfMat"> + + <refnamediv> + + <refname>fscanfMat</refname> + + <refpurpose>テキストファイルから行列を読み込む</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>M = fscanfMat(filename[, fmt]); + + [M, text] = fscanfMat(filename [, fmt]); + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>filename</term> + + <listitem> + + <para>スキャンするファイルの名前を指定する文字列.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>fmt</term> + + <listitem> + + <para> + + a character string giving the format. This is an optional + + parameter, the default value is <literal>"%lg"</literal>. + + </para> + + <para> + + Supported format: <literal>%[width].[precision]type</literal> or <literal>%type</literal> where: + + </para> + + <para> + + <literal>width</literal>: optional number that specifies + + the minimum number of characters output; + + </para> + + <para> + + <literal>precision</literal>: optional number that + + specifies the maximum number of characters printed for all + + or part of the output field, or the minimum number of + + digits printed for integer values. + + </para> + + <para> + + <literal>type</literal>: lf, lg, d, i, e, f, g (see <link + linkend="scanf_conversion">scanf_conversion</link>). + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>M</term> + + <listitem> + + <para>出力変数. 実数の行列.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>text</term> + + <listitem> + + <para> + + 出力変数. 文字列の列ベクトル. + + ファイル<varname>filename</varname>の先頭のコメントです. + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <function>fscanfMat</function>関数はテキストファイルからスカラー行列を読み込むために + + 使用されます. + + <varname>text</varname>が指定された場合,ファイルの先頭の非数値の行が + + 返されます.残りの行の列の数は同じである必要があります + + (コロンセパレータは空白文字またはタブ文字であるとみなされます). + + 行列の列の数はファイルでみつかった列の数となり, + + 行の数は入力ファイルの終端を検出するまでに取得した行数と + + なります. + + この関数は<function>fprintfMat</function>で保存した数値データを + + 読み戻すために使用することができます. + + </para> + + <para> + + <function>fscanfMat</function>は,ANSI/ASCII および UTF-8でエンコードされた + + ファイルをサポートします.. + + </para> + + <para> + + CSV形式のファイルを読み込む場合, + + <link linkend="csvRead">csvRead</link>関数の使用が推奨されます. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"> + + fd = mopen(TMPDIR + "/Mat", "w"); + + mfprintf(fd, "Some text.....\n"); + + mfprintf(fd, "Some text again\n"); + + a = rand(6,6); + + for i = 1:6 , + + for j = 1:6, mfprintf(fd, "%5.2f ", a(i,j));end; + + mfprintf(fd, "\n"); + + end + + mclose(fd); + + a1 = fscanfMat(TMPDIR + "/Mat") + + + + A = ones(5,5) + 0.1; + + fprintfMat(TMPDIR + "/Matrix.txt", A, "%lg"); + + B = fscanfMat(TMPDIR + "/Matrix.txt", "%lg"); + + A == B + + + + C = [%nan, %inf, -%inf, 1]; + + fprintfMat(TMPDIR + "/MatrixNANINF.txt", C); + + D = fscanfMat(TMPDIR + '/MatrixNANINF.txt') + + + + </programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="scanf_conversion">scanf_conversion</link> + + </member> + + <member> + + <link linkend="mclose">mclose</link> + + </member> + + <member> + + <link linkend="meof">meof</link> + + </member> + + <member> + + <link linkend="mfprintf">mfprintf</link> + + </member> + + <member> + + <link linkend="fprintfMat">fprintfMat</link> + + </member> + + <member> + + <link linkend="mfscanf">mfscanf</link> + + </member> + + <member> + + <link linkend="mget">mget</link> + + </member> + + <member> + + <link linkend="mgetstr">mgetstr</link> + + </member> + + <member> + + <link linkend="mopen">mopen</link> + + </member> + + <member> + + <link linkend="mprintf">mprintf</link> + + </member> + + <member> + + <link linkend="mput">mput</link> + + </member> + + <member> + + <link linkend="mputstr">mputstr</link> + + </member> + + <member> + + <link linkend="mseek">mseek</link> + + </member> + + <member> + + <link linkend="mtell">mtell</link> + + </member> + + <member> + + <link linkend="mdelete">mdelete</link> + + </member> + + <member> + + <link linkend="csvRead">csvRead</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/getURL.xml b/modules/fileio/help/ja_JP/getURL.xml new file mode 100755 index 000000000..3740ee11e --- /dev/null +++ b/modules/fileio/help/ja_JP/getURL.xml @@ -0,0 +1,287 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) - S/E - Sylvestre Ledru + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xml:id="getURL" xml:lang="ja" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:scilab="http://www.scilab.org" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + + <refname>getURL</refname> + + <refpurpose>URL (HTTP, HTTPS, FTP...) をダウンロード</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>filename = getURL(URL); + + [filename, [content]] = getURL(URL [, targetDir [, username [, password]]]]); + + [filename, [content]] = getURL(URL [, targetFile [, username [, password]]]]); + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>URL</term> + + <listitem> + + <para>文字列: URL. サポートされており,テスト済みです: HTTP, HTTPS, FTP (IPv4 およびIPv6)</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>targetDir</term> + + <listitem> + + <para>文字列オプションパラメータ:ファイルを保存するディレクトリ (空の場合はカレントディレクトリ)</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>targetFile</term> + + <listitem> + + <para>文字列オプションパラメータ: ファイルの保存先(空の場合はカレントディレクトリ) + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>username</term> + + <listitem> + + <para>文字列オプションパラメータ: 認証が必要なWebサイト用のユーザ名</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>password</term> + + <listitem> + + <para>文字列オプションパラメータ: 認証が必要なWebサイト用のパスワード</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>filename</term> + + <listitem> + + <para>文字列: ファイルをダウンロードするパス</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>content</term> + + <listitem> + + <para>文字列: ダウンロードしたファイルの内容</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para>URLからファイルをダウンロード.</para> + + <para> + + getURL はリモートURLからファイルをダウンロードします. + + getURLはURLで指定するものと同じ名前を使用します. + + しかし,いくつかの習慣に基づき(例えば,<emphasis role="italic">http://www.scilab.org/</emphasis>) + + ファイル名がURLで指定されない場合に, + + getURLはファイル名を<emphasis role="italic">index.html</emphasis>に変更します. + + </para> + + <para>content はURLに指定されたページの内容を有します.</para> + + <para> + + この関数は <ulink url="http://curl.haxx.se/libcurl/">curlライブラリ</ulink>にもとづいています. + + </para> + + <para> 認証が必要なWebサイト用にusername と password を指定できます. + + 使用される認証方法はCURLAUTH_ANYで, + + libcurlライブラリのCURLOPT_HTTPAUTHパラメータで指定されます. + + </para> + + <para>IPv6 (そして当然 IPv4) が getURLにより標準でサポートされます.</para> + + <para>このバージョンではプロキシ設定が有効となっています. + + ATOMS設定ファイルのパラメータを使用します. + + </para> + + <para> + + URLに追従して確実にダウンロードを行うには, + + curlオプション<emphasis role="italic">CURLOPT_FOLLOWLOCATION</emphasis> を有効にします. + + </para> + + <para> + + <literal>getURL</literal> は libcurlにもとづいています. + + 公式のScilabバイナリにおけるこのライブラリのバージョンは, + + HTTP, HTTPS, FTP および FTPS サポートを有効にしてコンパイルされています. + + Scilabがディストリビューションのパッケージシステムによりインストールされた場合, + + HTTP, HTTPS および FTPS以外の + + <ulink url="http://curl.haxx.se/docs/features.html">他のプロトコル</ulink> + + も動作する可能性があります.しかし, これらはまだ十分に試験されていません. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"> + + // URLをダウンロードし, ファイル maths_simulation に保存します + + getURL("http://www.scilab.org/products/scilab/features/maths_simulation"); + + // Scilabホームページをカレントディレクトリに保存します (そしてファイルにリネーム) + + getURL("http://www.scilab.org","scilab_homepage.html"); + + // Scilabの例をダウンロードし, 実行します + + myFile = getURL("http://fileexchange.scilab.org/toolboxes/contour3d/10.03/files/contour3d.sci",TMPDIR) + + exec(myFile); + + contour3d(); + + // 認証を使用 + + getURL("http://httpbin.org/basic-auth/user/passwd",TMPDIR+"/testfile.html","user","passwd") + + // IPv6接続を使用 + + getURL("http://ipv6.google.com/intl/en_com/images/srpr/logo3w.png") + + // 内容を取得 + + [myFile, content] = getURL("http://fileexchange.scilab.org/toolboxes/contour3d/10.03/files/contour3d.sci",TMPDIR) + + </programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="splitURL">splitURL</link> + + </member> + + </simplelist> + + </refsection> + + <refsection> + + <title>History</title> + + <revhistory> + + <revision> + + <revnumber>5.5.0</revnumber> + + <revremark>この関数はScilab 5.5.0で追加されました</revremark> + + </revision> + + </revhistory> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/getmd5.xml b/modules/fileio/help/ja_JP/getmd5.xml new file mode 100755 index 000000000..e6d2ccac5 --- /dev/null +++ b/modules/fileio/help/ja_JP/getmd5.xml @@ -0,0 +1,102 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="getmd5"> + + <refnamediv> + + <refname>getmd5</refname> + + <refpurpose>md5 チェックサムを取得</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼出し手順</title> + + <synopsis>res=getmd5(filename) + + res=getmd5(ParamString,'string') + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>res</term> + + <listitem> + + <para>md5 結果 (文字列)</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>filename</term> + + <listitem> + + <para>ファイル名 (文字列または文字列の行列)</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>ParamString</term> + + <listitem> + + <para>文字列または文字列の行列</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <function>getmd5</function>は, + + ファイル<varname>filename</varname>または文字列<varname>ParamString</varname>の + + md5 チェックサムを取得します. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +getmd5('hello world','string') +getmd5(['hello' 'world'],'string') +getmd5(['hello' ; 'world'],'string') +getmd5( SCI+'/modules/core/etc/core.start' ) +getmd5( SCI+'/modules/core/etc/'+['core.start' 'core.quit']) + ]]></programlisting> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/io.xml b/modules/fileio/help/ja_JP/io.xml new file mode 100755 index 000000000..6c76b23e1 --- /dev/null +++ b/modules/fileio/help/ja_JP/io.xml @@ -0,0 +1,102 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2009 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="io" xml:lang="ja"> + + <refnamediv> + + <refname>%io</refname> + + <refpurpose> + + 標準入力および標準出力を保持する変数(ファイル記述子). + + </refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>%io(1) + + %io(2) + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>説明</title> + + <para>%io(1) は標準入力を返します (ファイル記述子 5).</para> + + <para>%io(2) は標準出力を返します (ファイル記述子 6).</para> + + <para>ファイル記述子 0 は標準エラーです.</para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +mfprintf(%io(2),'Scilab stdout (C)'); +mfprintf(0,'Scilab stderr (C)'); +write(%io(2),'Scilab stdout (Fortran)'); +write(0,'Scilab stderr (Fortran'); +[units,typ,names]=file() + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="write">write</link> + + </member> + + <member> + + <link linkend="mfprintf">mfprintf</link> + + </member> + + <member> + + <link linkend="file">file</link> + + </member> + + <member> + + <link linkend="dispfiles">dispfiles</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/isfile.xml b/modules/fileio/help/ja_JP/isfile.xml new file mode 100755 index 000000000..8880499c6 --- /dev/null +++ b/modules/fileio/help/ja_JP/isfile.xml @@ -0,0 +1,136 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2009 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="isfile" xml:lang="ja"> + + <refnamediv> + + <refname>isfile</refname> + + <refpurpose>引数が既存のファイルかどうか調べる</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>x = isfile(filenames)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>filenames</term> + + <listitem> + + <para>文字列または文字列の行列.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>x</term> + + <listitem> + + <para> + + 論理値の行列 (<varname>filenames</varname>が + + 存在する場合に<constant>%t</constant>). + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <code>x = isfile(filenames)</code>は,<varname>filenames</varname>が + + 既存のファイルかどうかを調べます. + + (ディレクトリはファイルではありません. + + <link linkend="isdir">isdir</link>を参照ください.) + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"> + + filenames = ls(SCI) + + + + x = isfile(filenames) + + + + isfile(SCI + '/etc') + + isdir(SCI + '/etc') + + </programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="fileinfo">fileinfo</link> + + </member> + + <member> + + <link linkend="isdir">isdir</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/listfiles.xml b/modules/fileio/help/ja_JP/listfiles.xml new file mode 100755 index 000000000..33808fa51 --- /dev/null +++ b/modules/fileio/help/ja_JP/listfiles.xml @@ -0,0 +1,225 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="listfiles"> + + <refnamediv> + + <refname>listfiles</refname> + + <refpurpose>ファイルのリスト</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>files = listfiles(paths [, flag, flagexpand])</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>paths</term> + + <listitem> + + <para> + + パス名の集合を指定する文字列の行列 + + (多くの場合, 末尾が <literal>*</literal> のパターンとなります) + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>flag, flagexpand</term> + + <listitem> + + <para> + + オプションの論理値パラメータ + + (デフォルト値は<constant>%t</constant>です). + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>files</term> + + <listitem> + + <para>文字列の行列.</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <function>listfiles</function> は, + + パスエントリの指定したパターンのどれかに一致するファイル + + の一覧を得るために使用されます. + + パターンは,ファイルに関する情報を取得するために + + Unixでは<command>ls</command>,Windowsでは + + <command>dir</command>コマンドに指定されます. + + このため, ポータブルなScilabスクリプトを書くためには, + + 両方のOSに有効なワイルドカードパターンを指定する必要があります. + + パス名の変換が行われ,例えば<literal>SCI/core/macros/*.sci</literal> + + はUnixとWindowsの両方で有効なパターンであることに注意してください. + + </para> + + <para> + + <varname>flag</varname> が真の場合,<varname>paths</varname>で + + 指定したパス名は <code>getos() == 'Windows'</code> の値に基づき変換されます + + (<link linkend="pathconvert">pathconvert</link>参照). + + さらに,<varname>flagexpand</varname> が真の場合, + + <literal>HOME</literal>, <literal>SCI</literal> または <literal>~</literal> のような + + 主要な文字列は環境変数を用いて展開されます. + + </para> + + <para> + + 入力引数 <varname>paths</varname> がディレクトリ名の場合, + + 返される<varname>files</varname>はディレクトリのネーティブな名前です. + + </para> + + <para> + + 入力引数<varname>paths</varname>が複数の要素を有する場合,または + + パターン<varname>files</varname> + + (例: <literal>"/*"</literal>, <literal>"*.c"</literal>)を有する場合, + + 返される<varname>files</varname>は絶対パス + + (すなわち,ディレクトリ名の末尾にファイル名を追加したもの)です. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +files=listfiles(['SCI/modules/core/macros/*.sci';'SCI/modules/core/macros/*.bin']); + ]]> + + </programlisting> + + </refsection> + + <refsection> + + <title>履歴</title> + + <revhistory> + + <revision> + + <revnumber>5.4.0</revnumber> + + <revremark> + + pathsが単一の文字列でない場合, + + 返されるファイルは全て絶対パス形式に統一されます. + + </revremark> + + </revision> + + </revhistory> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="findfiles">findfiles</link> + + </member> + + <member> + + <link linkend="basename">basename</link> + + </member> + + <member> + + <link linkend="pathconvert">pathconvert</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/listvarinfile.xml b/modules/fileio/help/ja_JP/listvarinfile.xml new file mode 100755 index 000000000..1aa5c90e0 --- /dev/null +++ b/modules/fileio/help/ja_JP/listvarinfile.xml @@ -0,0 +1,196 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="listvarinfile"> + + <refnamediv> + + <refname>listvarinfile</refname> + + <refpurpose>保存されたデータファイルの中の変数の一覧を得る</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>listvarinfile(filename) + + [names, typs, dims, vols] = listvarinfile(filename) + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>filename</term> + + <listitem> + + <para>文字列, 調べるファイルのパス名 + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>nams</term> + + <listitem> + + <para>文字列の行列, ファイルに保存した変数の名前 + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>dims</term> + + <listitem> + + <para>リスト, ファイルに保存した変数の次元 + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>typs</term> + + <listitem> + + <para>数値行列, ファイルに保存した変数の型 + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>vols</term> + + <listitem> + + <para>数値行列, ファイルに保存した変数の大きさ(単位:バイト) + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <itemizedlist> + + <listitem> + + <para> + + このユーティリティ関数は, + + <link linkend="save">save</link>により作成されたScilabデータファイルに含まれる + + 変数の一覧 "a la <link linkend="whos">whos</link>" を取得します. + + </para> + + <para> + + <note> + + ハイパー行列はプレーンな mlist として報告されます; + + 有理数および状態空間はプレーンな tlist として報告されます; + + グラフィックハンドルは認識されません. + + </note> + + </para> + + </listitem> + + </itemizedlist> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +a=eye(2,2); b=int16(ones(a)); c=rand(2,3,3); +save(fullfile(TMPDIR,"vals.sod"),'a','b','c') +[names,typs,dims,vols] = listvarinfile(fullfile(TMPDIR,"vals.sod")) + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="whos">whos</link> + + </member> + + <member> + + <link linkend="save">save</link> + + </member> + + <member> + + <link linkend="load">load</link> + + </member> + + <member> + + <link linkend="save_format">save_format</link> + + </member> + + <member> + + <link linkend="type">type</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/maxfiles.xml b/modules/fileio/help/ja_JP/maxfiles.xml new file mode 100755 index 000000000..2b4b64fa1 --- /dev/null +++ b/modules/fileio/help/ja_JP/maxfiles.xml @@ -0,0 +1,119 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="maxfiles"> + + <refnamediv> + + <refname>maxfiles</refname> + + <refpurpose> + + Scilabが同時にオープンできるファイル数を最大値を指定する. + + </refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>r= maxfiles(newnumbermax)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>newnumbermax</term> + + <listitem> + + <para>整数, 新しい値</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>r</term> + + <listitem> + + <para>整数: 新しい実効値.</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <function>maxfiles</function>は, + + Scilabが同時にオープンできるファイル数を最大値を指定します. + + </para> + + <para>最小値 : 20</para> + + <para>最大値 : 100</para> + + <para>デフォルト : 20</para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +r = maxfiles(50); + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="mopen">mopen</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/mclearerr.xml b/modules/fileio/help/ja_JP/mclearerr.xml new file mode 100755 index 000000000..806372d9c --- /dev/null +++ b/modules/fileio/help/ja_JP/mclearerr.xml @@ -0,0 +1,151 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="mclearerr"> + + <refnamediv> + + <refname>mclearerr</refname> + + <refpurpose>バイナリファイルアクセスエラーをリセット</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>mclearerr([fd])</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>fd</term> + + <listitem> + + <para> + + スカラー: <function>mopen</function>関数により返された + + <varname>fd</varname>パラメータ. + + -1 は直近にオープンされたファイルを意味します. + + デフォルト値は -1 です. + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + 関数<function>mclearerr</function>は,エラーインジケータおよび + + EOFインジケータを 0にリセットするために使用されます. + + </para> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="merror">merror</link> + + </member> + + <member> + + <link linkend="mclose">mclose</link> + + </member> + + <member> + + <link linkend="mopen">mopen</link> + + </member> + + <member> + + <link linkend="mput">mput</link> + + </member> + + <member> + + <link linkend="mget">mget</link> + + </member> + + <member> + + <link linkend="mgetstr">mgetstr</link> + + </member> + + <member> + + <link linkend="mputstr">mputstr</link> + + </member> + + <member> + + <link linkend="meof">meof</link> + + </member> + + <member> + + <link linkend="mseek">mseek</link> + + </member> + + <member> + + <link linkend="mtell">mtell</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/mclose.xml b/modules/fileio/help/ja_JP/mclose.xml new file mode 100755 index 000000000..7135d951b --- /dev/null +++ b/modules/fileio/help/ja_JP/mclose.xml @@ -0,0 +1,252 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="mclose"> + + <refnamediv> + + <refname>mclose</refname> + + <refpurpose>オープンされているファイルを閉じる</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis> + + err = mclose([fd]) + + mclose('all') + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>fd</term> + + <listitem> + + <para> + + スカラー: 関数<function>mopen</function>により返された + + <varname>fd</varname>パラメータがファイル記述子として使用されます. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>err</term> + + <listitem> + + <para>スカラー: エラーインジケータ.</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <function>mclose</function>は,<function>mopen</function>によりオープンされた + + ファイルを閉じるために使用されます. + + <varname>fd</varname>が省略された場合, + + <function>mclose</function>は直近にオープンされたファイルを閉じます. + + </para> + + <para> + + <code>mclose('all')</code>は, + + <code>file('open',..)</code> または <function>mopen</function>により + + オープンされた全てのファイルを閉じます. + + <caution> + + これをScilabスクリプトファイルの中で使用する場合には注意してください. + + スクリプト自体も閉じられるため, Scilab は + + <code>mclose('all')</code>の後に書かれたコマンドを実行しません. + + </caution> + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +fd = mopen(TMPDIR + filesep() + 'mclose_tst','wt'); +mclose(TMPDIR + filesep() + 'mclose_tst'); + +fd=mopen('SCI/etc/scilab.start','r') +mgetl(fd,10) +mclose(fd) + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="meof">meof</link> + + </member> + + <member> + + <link linkend="mfprintf">mfprintf</link> + + </member> + + <member> + + <link linkend="fprintfMat">fprintfMat</link> + + </member> + + <member> + + <link linkend="mfscanf">mfscanf</link> + + </member> + + <member> + + <link linkend="fscanfMat">fscanfMat</link> + + </member> + + <member> + + <link linkend="mget">mget</link> + + </member> + + <member> + + <link linkend="mgetl">mgetl</link> + + </member> + + <member> + + <link linkend="mgetstr">mgetstr</link> + + </member> + + <member> + + <link linkend="mopen">mopen</link> + + </member> + + <member> + + <link linkend="mprintf">mprintf</link> + + </member> + + <member> + + <link linkend="mput">mput</link> + + </member> + + <member> + + <link linkend="mputl">mputl</link> + + </member> + + <member> + + <link linkend="mputstr">mputstr</link> + + </member> + + <member> + + <link linkend="mscanf">mscanf</link> + + </member> + + <member> + + <link linkend="mseek">mseek</link> + + </member> + + <member> + + <link linkend="mtell">mtell</link> + + </member> + + <member> + + <link linkend="file">file</link> + + </member> + + <member> + + <link linkend="mdelete">mdelete</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/mdelete.xml b/modules/fileio/help/ja_JP/mdelete.xml new file mode 100755 index 000000000..1281eba14 --- /dev/null +++ b/modules/fileio/help/ja_JP/mdelete.xml @@ -0,0 +1,206 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="mdelete"> + + <refnamediv> + + <refname>mdelete</refname> + + <refpurpose>ファイルを削除</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>mdelete(filename)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>filename</term> + + <listitem> + + <para>文字列: 削除するファイルのパス名.</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <function>mdelete</function> は, + + ファイルまたは<varname>filename</varname>がメタ文字を含む場合に + + ファイルの集合を削除するために使用できます. + + </para> + + <para> + + <caution> + + 削除コマンドを入力する時, + + <function>mdelete</function>は確認をしないことに注意してください. + + ファイル失う事故を避けるため, 削除したいアイテムを正確に指定していることを + + 確認してください. + + </caution> + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +r = mputl('I am a dummy String', TMPDIR+'/dummyFile.dummy'); +mdelete(TMPDIR+"/dummyFile.dummy"); + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="mopen">mopen</link> + + </member> + + <member> + + <link linkend="mclose">mclose</link> + + </member> + + <member> + + <link linkend="meof">meof</link> + + </member> + + <member> + + <link linkend="mfprintf">mfprintf</link> + + </member> + + <member> + + <link linkend="fprintfMat">fprintfMat</link> + + </member> + + <member> + + <link linkend="mfscanf">mfscanf</link> + + </member> + + <member> + + <link linkend="fscanfMat">fscanfMat</link> + + </member> + + <member> + + <link linkend="mget">mget</link> + + </member> + + <member> + + <link linkend="mgetstr">mgetstr</link> + + </member> + + <member> + + <link linkend="mopen">mopen</link> + + </member> + + <member> + + <link linkend="mprintf">mprintf</link> + + </member> + + <member> + + <link linkend="mput">mput</link> + + </member> + + <member> + + <link linkend="mputstr">mputstr</link> + + </member> + + <member> + + <link linkend="mscanf">mscanf</link> + + </member> + + <member> + + <link linkend="mseek">mseek</link> + + </member> + + <member> + + <link linkend="mtell">mtell</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/meof.xml b/modules/fileio/help/ja_JP/meof.xml new file mode 100755 index 000000000..ba5061f39 --- /dev/null +++ b/modules/fileio/help/ja_JP/meof.xml @@ -0,0 +1,235 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="meof"> + + <refnamediv> + + <refname>meof</refname> + + <refpurpose>ファイルの終端に達したかどうかを確認する</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>err=meof(fd)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>fd</term> + + <listitem> + + <para> + + スカラー: 関数<function>mopen</function>により返された + + <varname>fd</varname>パラメータ. + + -1 は直近にオープンされたファイルを意味します. + + デフォルト値は -1です. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>err</term> + + <listitem> + + <para>スカラー: エラーインジケータ</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + 関数<function>meof</function>は,前の + + <function>mget</function> または <function>mgetstr</function> + + のコールにより + + ファイル終端に達している場合にヌル以外の値を返します. + + エラーフラグおよびEOFフラグをゼロにリセットするために, + + 関数<function>mclearerr</function>が使用されます. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ + +// Write a temporary file with some text in it +this_file = pathconvert(TMPDIR+"/mputstr.txt", %F); + +fd = mopen(this_file, "wt"); +mputstr("Scilab is a numerical computing software.", fd); +mclose(fd); + +fd = mopen(this_file,'rt'); +i = 0; +while ~meof(fd) do + mfscanf(1, fd, "%c"); + i = i + 1; +end + +mclose(fd); + +disp("Scilab has found " + string(i) + " chars in the file"); + + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="mclose">mclose</link> + + </member> + + <member> + + <link linkend="meof">meof</link> + + </member> + + <member> + + <link linkend="mfprintf">mfprintf</link> + + </member> + + <member> + + <link linkend="fprintfMat">fprintfMat</link> + + </member> + + <member> + + <link linkend="mfscanf">mfscanf</link> + + </member> + + <member> + + <link linkend="fscanfMat">fscanfMat</link> + + </member> + + <member> + + <link linkend="mget">mget</link> + + </member> + + <member> + + <link linkend="mgetstr">mgetstr</link> + + </member> + + <member> + + <link linkend="mopen">mopen</link> + + </member> + + <member> + + <link linkend="mprintf">mprintf</link> + + </member> + + <member> + + <link linkend="mput">mput</link> + + </member> + + <member> + + <link linkend="mputstr">mputstr</link> + + </member> + + <member> + + <link linkend="mscanf">mscanf</link> + + </member> + + <member> + + <link linkend="mseek">mseek</link> + + </member> + + <member> + + <link linkend="mtell">mtell</link> + + </member> + + <member> + + <link linkend="mdelete">mdelete</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/merror.xml b/modules/fileio/help/ja_JP/merror.xml new file mode 100755 index 000000000..9b10ce120 --- /dev/null +++ b/modules/fileio/help/ja_JP/merror.xml @@ -0,0 +1,234 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * Copyright (C) 2009 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="merror" xml:lang="ja"> + + <refnamediv> + + <refname>merror</refname> + + <refpurpose>ファイルアクセスに関するエラーインジケータを調べる</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis> + + err = merror([fd]) + + [err, msg] = merror([fd]) + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>fd</term> + + <listitem> + + <para> + + スカラー: 関数<function>mopen</function>により返された + + <varname>fd</varname>パラメータがファイル記述子(正の整数)として使用されます. + + -1 は直近にオープンされたファイルを意味します. + + デフォルト値は -1です. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>err</term> + + <listitem> + + <para> + + スカラー: + + 指定したファイルに関する直近のファイルI/O処理のエラーステータス番号 + + を返します. + + </para> + + <para> + + 指定したファイルで実行された直近のI/O処理が成功した場合, + + <varname>msg</varname>の値は空となり, <function>merror</function>は + + <varname>err</varname>の値として 0 を返します. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>msg</term> + + <listitem> + + <para>文字列: エラー文字列メッセージ.</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + 関数 <function>merror</function>はファイルアクセスエラーインジケータ + + をテストするため使用されます. + + エラーが設定されている場合, ゼロでない要素を返します. + + エラーインジケータは<function>mclearerr</function>関数により + + リセットすることのみが可能です. + + </para> + + <para> + + ゼロでない<varname>err</varname>は,直近のI/O処理で発生したエラーを指します. + + メッセージの値は,エラーの特性に関する情報を含む文字列です. + + このメッセージが役に立たない場合, + + 詳細については使用するオペレーティングシステム用の + + C言語のランタイムライブラリのマニュアルを参照してください. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +fd = mopen(TMPDIR +'/filetxt.txt','wt'); +[err,msg] = merror(fd) +if (err <> 0) then + mprintf('Problem\n'); +end +mclose(fd); + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="mclearerr">mclearerr</link> + + </member> + + <member> + + <link linkend="mclose">mclose</link> + + </member> + + <member> + + <link linkend="mopen">mopen</link> + + </member> + + <member> + + <link linkend="mput">mput</link> + + </member> + + <member> + + <link linkend="mget">mget</link> + + </member> + + <member> + + <link linkend="mgetstr">mgetstr</link> + + </member> + + <member> + + <link linkend="mputstr">mputstr</link> + + </member> + + <member> + + <link linkend="meof">meof</link> + + </member> + + <member> + + <link linkend="mseek">mseek</link> + + </member> + + <member> + + <link linkend="mtell">mtell</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/mfprintf.xml b/modules/fileio/help/ja_JP/mfprintf.xml new file mode 100755 index 000000000..64c99eaac --- /dev/null +++ b/modules/fileio/help/ja_JP/mfprintf.xml @@ -0,0 +1,305 @@ +<?xml version="1.0" encoding="utf-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mfprintf" xml:lang="ja"> + + <refnamediv> + + <refname>mfprintf</refname> + + <refpurpose>変換,整形し,ファイルにデータを書き込む</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>mfprintf(fd, format, a1, ..., an);</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>fd</term> + + <listitem> + + <para> + + スカラー, <function>mopen</function>で指定したファイル記述子 + + (正の整数). + + </para> + + <para> + + <varname>fd</varname> が 0 の場合, stderr へのリダイレクション. + + </para> + + <para> + + <varname>fd</varname>が 6 の場合, stdout へのリダイレクション. + + </para> + + <para> + + 古い仕様 :値 <literal>-1</literal> はデフォルトのファイル + + ( すなわち直近にオープンされたファイル)を指します. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>format</term> + + <listitem> + + <para> + + 残りのオペランドを書き込む際に使用されるフォーマットを指定する + + Scilab 文字列. + + <varname>format</varname>オペランドはCの<function>printf</function> + + のフォーマットオペランドの構文に可能な限り似せられています. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>str</term> + + <listitem> + + <para>文字列: スキャンされる文字列.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>a1, ..., an</term> + + <listitem> + + <para> + + formatパラメータに基づき変換,出力されるデータ. + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <function>mfprintf</function> 関数は, C言語の<function>fprintf</function>関数への + + インターフェイスです. + + </para> + + <para> + + <function>mfprintf</function>関数は,整形されたオペランドを + + ファイル記述子<varname>fd</varname>で指定したファイルに書き込みます. + + 引数のオペランドは,<varname>format</varname>オペランドの制御のもとで整形されます. + + </para> + + <para> + + この関数は数値の列ベクトルおよび文字列ベクトルを要素に関する + + 明示的なループ処理を行うことなく出力する際に使用することができます. + + この場合,この関数は行に関する反復処理を行ないます. + + 最も短いベクトルはフォーマットの反復回数を指定します. + + </para> + + <para> + + 同じ型パラメータの一様なシーケンスは + + 行列で置換することができます. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +fd = mopen(TMPDIR+'/text.txt','wt'); +mfprintf(fd,'hello %s %d.\n','world',1); +mfprintf(fd,'hello %s %d.\n','scilab',2); +mfprintf(fd,'This line is built with a column vector (26:28) %d.\n',[26:28].'); +mfprintf(fd,'This line is built with a row vector (26:28) %d.\n',[26:28]); +A = rand(3,6); +mfprintf(fd,'This line is built with a matrix %.3f.\n',A); +mclose(fd); +if (isdef('editor') | (funptr('editor')<>0)) then + editor(TMPDIR+'/text.txt') +end +mfprintf(0,'stderr output.\n'); +mfprintf(6,'stdout output.\n'); + ]]></programlisting> + + </refsection> + + <refsection> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="mclose">mclose</link> + + </member> + + <member> + + <link linkend="meof">meof</link> + + </member> + + <member> + + <link linkend="fprintfMat">fprintfMat</link> + + </member> + + <member> + + <link linkend="mfscanf">mfscanf</link> + + </member> + + <member> + + <link linkend="fscanfMat">fscanfMat</link> + + </member> + + <member> + + <link linkend="mget">mget</link> + + </member> + + <member> + + <link linkend="mgetstr">mgetstr</link> + + </member> + + <member> + + <link linkend="mopen">mopen</link> + + </member> + + <member> + + <link linkend="mprintf">mprintf</link> + + </member> + + <member> + + <link linkend="mput">mput</link> + + </member> + + <member> + + <link linkend="mputstr">mputstr</link> + + </member> + + <member> + + <link linkend="mscanf">mscanf</link> + + </member> + + <member> + + <link linkend="mseek">mseek</link> + + </member> + + <member> + + <link linkend="mtell">mtell</link> + + </member> + + <member> + + <link linkend="mdelete">mdelete</link> + + </member> + + <member> + + <link linkend="printf_conversion">printf_conversion</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/mfscanf.xml b/modules/fileio/help/ja_JP/mfscanf.xml new file mode 100755 index 000000000..220c339cd --- /dev/null +++ b/modules/fileio/help/ja_JP/mfscanf.xml @@ -0,0 +1,472 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mfscanf" xml:lang="ja"> + + <refnamediv xml:id="mscanf"> + + <refname>mscanf</refname> + + <refpurpose> + + 標準入力から入力を読み込む (C言語の scanf + + 関数へのインターフェイス) + + </refpurpose> + + </refnamediv> + + <refnamediv> + + <refname>mfscanf</refname> + + <refpurpose> + + ストリームへのポインタから入力を読み込む (C言語の + + fscanf 関数へのインターフェイス) + + </refpurpose> + + </refnamediv> + + <refnamediv xml:id="msscanf"> + + <refname>msscanf</refname> + + <refpurpose> + + 文字列から入力を読み込む (C言語の + + sscanf 関数へのインターフェイス) + + </refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis> + + [n, v_1,..., v_m] = mfscanf([niter,]fd, format) + + L = mfscanf([niter,] fd,format) + + + + [n, v_1,..., v_m] = mscanf([niter,] format) + + L = mscanf([niter,]format) + + + + [n, v_1,..., v_m] = msscanf([niter,]str, format) + + L = msscanf([niter,] str, format) + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>format</term> + + <listitem> + + <para> + + 残りのオペランドを書き込む際に使用されるフォーマットを記述する + + Scilab 文字列. <varname>format</varname>オペランドは, + + <link linkend="scanf_conversion">scanf_conversion</link>に記述された + + C 言語の<function>printf</function>のフォーマット記述子にできるだけ + + 近くなるよう作成されています. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>fd</term> + + <listitem> + + <para> + + <function>mopen</function>により返された + + ファイル記述子. + + 値 -1 は直近にオープンされたファイルを指します. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>str</term> + + <listitem> + + <para>Scilab 文字列または文字列ベクトル.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>niter</term> + + <listitem> + + <para>整数, フォーマットの使用回数.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>n</term> + + <listitem> + + <para> + + 整数: 読み込まれたデータの数または + + データを読み込む前にEOLに達した場合は -1. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>v_i</term> + + <listitem> + + <para> + + 各関数は文字を読み込み,<varname>format</varname>に基づき解釈し, + + 結果をその出力引数に保存します. + + <varname>n</varname>個より多くの出力引数が指定された場合, + + 最後の変数<varname>v_n+1, ..., v_m</varname>が空の行列に設定されます. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>L</term> + + <listitem> + + <para> + + 全てのデータが同種である場合, + + 戻り値の一つのベクトルに保存されます. + + そうでない場合,同じデータ型のシーケンスは + + 行列に保存され, 作成された全ての行列を含む + + (<literal>cblock</literal>型を有する)<literal>mlist</literal> + + が返されます. + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <function>mfscanf</function>関数はストリーム<varname>fd</varname> + + から文字を読み込みます. + + </para> + + <para> + + <function>mfscanf</function>関数は Scilabウインドウから + + 文字を読み込みます. + + </para> + + <para> + + <function>mfscanf</function>関数はScilab文字列 + + <varname>str</varname>から文字を読み込みます. + + </para> + + <para> + + オプション引数<varname>niter</varname>は + + フォーマットの反復使用回数を指定します. + + 1回の反復は出力行列に1つの行を出力します. + + <code>niter==-1</code>の場合, + + 関数はファイル終端まで反復処理を行ないます. + + <varname>niter</varname>のデフォルト値は 1です. + + </para> + + <para>精度に関するコメント :</para> + + <para> + + <function>mfscanf</function>は,Cの関数<function>fscanf</function>に基づいています. + + <literal>'%f'</literal>, + + <literal>'%g'</literal>, <literal>'%e'</literal> + + をフォーマットに指定した場合, + + データはfloatにキャストされ,Scilab変数に出力されます. + + </para> + + <para> + + このScilab変数がdoubleの場合,精度が劣化する可能性があります. + + このような場合は, <literal>'%lg'</literal>フォーマットを使用する方が良いでしょう. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +//---------------------------------------------------------- +//-- 簡単な例 -- +//---------------------------------------------------------- +s='1 1.3' //文字列 +[n,a,b]=msscanf(s,"%i %e") +L=msscanf(s,"%i %e") + +//---------------------------------------------------------- +//-- フォーマットのサンプル -- +//---------------------------------------------------------- + +msscanf(" 12\n",'%c%c%c%c') //スキャン文字列 + +msscanf('0xabc','%x') //16進形式でスキャン + +msscanf('012345abczoo','%[0-9abc]%s') //[] 表記 + +// float および doubleを読み込み +msscanf('4345.988','%g')-4345.988 // floatとしてスキャン +msscanf('4345.988','%lg')-4345.988 // doubleとしてスキャン + +//---------------------------------------------------------- +//-- 複数行のデータファイルをスキャン -- +//---------------------------------------------------------- +//データを有するファイルを作成 +u=mopen(TMPDIR+'/foo','w'); +t=(0:0.1:%pi)';mfprintf(u,"%6.3f %6.3f\n",t,sin(t)) +mclose(u); + +u=mopen(TMPDIR+'/foo','r'); // 読み込むファイルをオープン +//read the file line by line +[n,a,b]=mfscanf(u,'%e %e') //最初の行に複数の出力引数構文を適用 +l=mfscanf(u,'%e %e') //2行目に単一の出力引数構文を適用 +//niterを使用して更に5つの行を読み込む +l=mfscanf(5,u,'%e %e') + +//ファイル終端まで読み込むために niter=-1 を使用 +l=mfscanf(-1,u,'%e %e') + +mclose(u); //ファイルを閉じる + +//---------------------------------------------------------- +//-- scanning multi-line strings vectors -- +//---------------------------------------------------------- +//文字列ベクトルをスキャンするためにniterを使用 +[n,Names,Ages]=msscanf(-1,["Alain 19";"Pierre 15";"Tom 12"],'%s %d') +D=msscanf(-1,["Alain 19";"Pierre 15";"Tom 12"],'%s %d') +typeof(D) +Names=D(:,1) //文字列 +Age=D(:,2) //数値 + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="mclose">mclose</link> + + </member> + + <member> + + <link linkend="meof">meof</link> + + </member> + + <member> + + <link linkend="mfprintf">mfprintf</link> + + </member> + + <member> + + <link linkend="fprintfMat">fprintfMat</link> + + </member> + + <member> + + <link linkend="mfscanf">mfscanf</link> + + </member> + + <member> + + <link linkend="fscanfMat">fscanfMat</link> + + </member> + + <member> + + <link linkend="mget">mget</link> + + </member> + + <member> + + <link linkend="mgetstr">mgetstr</link> + + </member> + + <member> + + <link linkend="mopen">mopen</link> + + </member> + + <member> + + <link linkend="mprintf">mprintf</link> + + </member> + + <member> + + <link linkend="mput">mput</link> + + </member> + + <member> + + <link linkend="mputstr">mputstr</link> + + </member> + + <member> + + <link linkend="mscanf">mscanf</link> + + </member> + + <member> + + <link linkend="mseek">mseek</link> + + </member> + + <member> + + <link linkend="mtell">mtell</link> + + </member> + + <member> + + <link linkend="mdelete">mdelete</link> + + </member> + + <member> + + <link linkend="scanf_conversion">scanf_conversion</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/mget.xml b/modules/fileio/help/ja_JP/mget.xml new file mode 100755 index 000000000..610b95063 --- /dev/null +++ b/modules/fileio/help/ja_JP/mget.xml @@ -0,0 +1,485 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mget" xml:lang="ja"> + + <refnamediv> + + <refname>mget</refname> + + <refpurpose> + + 指定したバイナリ形式で + + バイトまたはワードを読み込み, double に変換 + + </refpurpose> + + </refnamediv> + + <refnamediv xml:id="mgeti"> + + <refname>mgeti</refname> + + <refpurpose> + + 指定したバイナリ形式で + + バイトまたはワードを読み込み, int型に変換 + + </refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis> + + x = mget([n, type, fd]) + + x = mgeti([n, type, fd]) + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>n</term> + + <listitem> + + <para>正のスカラー: 読み込むデータの数.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>fd</term> + + <listitem> + + <para> + + スカラー: + + <function>mopen</function>により返されたファイル記述子. + + <literal>-1</literal>は直近にオープンされたファイルを意味します. + + デフォルト値は<literal>-1</literal>です. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>type</term> + + <listitem> + + <para> + + 文字列: <varname>x</varname>の全エントリを書き込むために使用する + + バイナリフォーマットを指定. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>x</term> + + <listitem> + + <para>浮動小数点数または整数値のベクトル</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <function>mget</function> 関数は, + + ストリームパラメータ<varname>fd</varname>により指定された入力の + + データを読み込み,浮動小数点数データのベクトルを返します. + + </para> + + <para> + + <function>mgeti</function> 関数は, + + ストリームパラメータ<varname>fd</varname>により指定された入力の + + データを読み込み,整数データのベクトルを返します. + + </para> + + <para> + + ファイルポインタが現在指している場所からデータが読み込まれ, + + 適当にインジケータが進まされます. + + </para> + + <para> + + <varname>type</varname>パラメータは変換指定子で, + + 以下のフラグ文字のどれか (デフォルト値は<literal>"l"</literal>)を設定できます: + + </para> + + <para> + + <note> + + Windowsにおけるデフォルトの動作では,バイト13 + + (<literal>0x0D</literal>)をスキップします. + + <literal>'b'</literal>を指定して<function>mopen</function>を + + コールする必要があります. + + 例えば, 例外なく全てのバイトを読み込むには, + + <code>fd1 = mopen(file1,'rb')</code> とします. + + </note> + + </para> + + <para>データ型:</para> + + <variablelist> + + <varlistentry> + + <term>d</term> + + <listitem> + + <para>double</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>f</term> + + <listitem> + + <para>float</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>l</term> + + <listitem> + + <para>long</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>i</term> + + <listitem> + + <para>int</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>s</term> + + <listitem> + + <para>short</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>c</term> + + <listitem> + + <para>character</para> + + </listitem> + + </varlistentry> + + </variablelist> + + <para>オプションのフラグ:</para> + + <variablelist> + + <varlistentry> + + <term>u..</term> + + <listitem> + + <para>符号なし (上記の型のどれかと組み合わせます)</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>..l</term> + + <listitem> + + <para>リトルインディアン (上記の型のどれかと組み合わせます)</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>..b</term> + + <listitem> + + <para>ビッグインディアン (上記の型のどれかと組み合わせます)</para> + + </listitem> + + </varlistentry> + + </variablelist> + + <para> + + (<literal>little=endian</literal>ステータスをチェックすることにより) + + 読み込まれたバイトは必要に応じて自動的にスワップされます. + + </para> + + <para> + + このデフォルトのスワップ動作は + + <function>mopen</function>関数にフラグを追加することにより抑制することが + + できます. + + </para> + + <para> + フォーマット <literal>"l"</literal>, <literal>"d"</literal> + + および <literal>"f"</literal> は, <function>mget</function> + + 関数でのみ有効です. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +file1 = fullfile(TMPDIR,'test1.bin'); +file2 = fullfile(TMPDIR,'test2.bin'); +fd1=mopen(file1,'wb'); +fd2=mopen(file2,'wb'); +mput(1996,'ull',fd1); +mput(1996,'ull',fd2); +mclose(fd1); +mclose(fd2); +fd1=mopen(file1,'rb'); +if 1996<>mget(1,'ull',fd1) + write(%io(2),'Bug'); +end + +fd2=mopen(file2,'rb'); +if 1996<>mget(1,'ull',fd2) + write(%io(2),'Bug'); +end + +mclose(fd1); +mclose(fd2); + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="mclose">mclose</link> + + </member> + + <member> + + <link linkend="meof">meof</link> + + </member> + + <member> + + <link linkend="mfprintf">mfprintf</link> + + </member> + + <member> + + <link linkend="fprintfMat">fprintfMat</link> + + </member> + + <member> + + <link linkend="mfscanf">mfscanf</link> + + </member> + + <member> + + <link linkend="fscanfMat">fscanfMat</link> + + </member> + + <member> + + <link linkend="mgetl">mgetl</link> + + </member> + + <member> + + <link linkend="mgetstr">mgetstr</link> + + </member> + + <member> + + <link linkend="mopen">mopen</link> + + </member> + + <member> + + <link linkend="mprintf">mprintf</link> + + </member> + + <member> + + <link linkend="mput">mput</link> + + </member> + + <member> + + <link linkend="mputl">mputl</link> + + </member> + + <member> + + <link linkend="mputstr">mputstr</link> + + </member> + + <member> + + <link linkend="mscanf">mscanf</link> + + </member> + + <member> + + <link linkend="mseek">mseek</link> + + </member> + + <member> + + <link linkend="mtell">mtell</link> + + </member> + + <member> + + <link linkend="mdelete">mdelete</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/mgetl.xml b/modules/fileio/help/ja_JP/mgetl.xml new file mode 100755 index 000000000..ea9e8f7a5 --- /dev/null +++ b/modules/fileio/help/ja_JP/mgetl.xml @@ -0,0 +1,203 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Serge STEER + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="mgetl"> + + <refnamediv> + + <refname>mgetl</refname> + + <refpurpose>アスキーファイルから行を読み込む</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>txt = mgetl(file_desc [,m])</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>file_desc</term> + + <listitem> + + <para> + + ファイル名を指定する文字列または<function>mopen</function> + + により返された論理ユニットを指定する整数 + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>m</term> + + <listitem> + + <para>整数スカラー: 読み込む行の数. デフォルト値は -1です.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>txt</term> + + <listitem> + + <para>文字列の列ベクトル</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <function>mgetl</function>関数はアスキーファイルから行を読み込みます. + + </para> + + <para> + + <varname>m</varname>が省略されるか <literal>-1</literal> の場合, + + ファイルの終わりまで全ての行が読み込まれます. + + </para> + + <para> + + <varname>m</varname>が指定された場合, + + <function>mgetl</function>は正しく<varname>m</varname>行を読み込もうとします. + + このオプションはファイルの一部を連続的に読み込む場合に有用です. + + この際, <varname>m</varname>行が読み込まれる前にファイル終端(EOF)に + + 到達した場合,読み込まれた行が返されます + + (<function>meof</function>関数によりEOFに達したかどうかを調べることができます). + + </para> + + <para> + + <function>mgetl</function>は, Unix, Windows, または Mac + + オペレーティングシステムからファイルを読み込むことができます. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +mgetl('SCI/etc/scilab.start',5) +mgetl SCI/modules/elementary_functions/macros/erf.sci +fd=mopen('SCI/etc/scilab.start','r') +mgetl(fd,10) +mclose(fd) + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="mputl">mputl</link> + + </member> + + <member> + + <link linkend="mclose">mclose</link> + + </member> + + <member> + + <link linkend="mfscanf">mfscanf</link> + + </member> + + <member> + + <link linkend="mget">mget</link> + + </member> + + <member> + + <link linkend="mput">mput</link> + + </member> + + <member> + + <link linkend="mgetstr">mgetstr</link> + + </member> + + <member> + + <link linkend="mopen">mopen</link> + + </member> + + <member> + + <link linkend="read">read</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/mgetstr.xml b/modules/fileio/help/ja_JP/mgetstr.xml new file mode 100755 index 000000000..33a9a3ee1 --- /dev/null +++ b/modules/fileio/help/ja_JP/mgetstr.xml @@ -0,0 +1,256 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mgetstr" xml:lang="ja"> + + <refnamediv> + + <refname>mgetstr</refname> + + <refpurpose>ファイルから文字列を読み込む</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>str = mgetstr(n [,fd])</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>n</term> + + <listitem> + + <para> + + 非負の整数: 読み込む文字数. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>fd</term> + + <listitem> + + <para> + + 整数:<link linkend="mopen">mopen</link> + + から返され, 文字を読み込むファイル記述子. + + <literal>-1</literal>は, + + 直近にオープンされたファイルを意味します. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>str</term> + + <listitem> + + <para>読み込まれた文字列</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <function>mgetstr</function>関数は, + + ファイルから最大<varname>n</varname>文字を + + 読込みます. + + <varname>n</varname>文字を読み込む前に + + ファイル終端に達した場合, + + <function>mgetstr</function>は + + 適切に読み込まれた値のみを返します. + + この結果, <function>mgetstr</function>コール時に + + リードカーソルが既にファイル終端にあった場合, + + <varname>n</varname>の設定値によらず + + 空の文字列が返されます. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ + fn = SCI + '/ACKNOWLEDGEMENTS'; // ファイルへの絶対パス + details = fileinfo(fn); // ファイルの詳細を取得 + len = details(1); // ファイルの長さを取得 + fd = mopen(fn, 'rt'); // 読込モードでテキストとしてファイルをオープン + str1 = mgetstr(33, fd) // fdから33文字読み込む + length(str1) // 33文字読み込む + str2 = mgetstr(272, fd) // fdから次の272文字を読み込む + length(str2) // 272文字読込まれた + mseek(len - 5); // ファイル終端から5文字目にジャンプ + str3 = mgetstr(10, fd) // 10文字読み込む: 5文字のみ返され, 残りはなし + length(str3) // 5文字あることを確認: 改行はみつかりません :) + str4 = mgetstr(10, fd) // 10文字読込み: 空の文字列が返されます + length(str4) // 空の文字列 + mclose(fd); // ファイル記述子を閉じる + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="mclose">mclose</link> + + </member> + + <member> + + <link linkend="meof">meof</link> + + </member> + + <member> + + <link linkend="mfprintf">mfprintf</link> + + </member> + + <member> + + <link linkend="fprintfMat">fprintfMat</link> + + </member> + + <member> + + <link linkend="mfscanf">mfscanf</link> + + </member> + + <member> + + <link linkend="fscanfMat">fscanfMat</link> + + </member> + + <member> + + <link linkend="mget">mget</link> + + </member> + + <member> + + <link linkend="mgetstr">mgetstr</link> + + </member> + + <member> + + <link linkend="mopen">mopen</link> + + </member> + + <member> + + <link linkend="mprintf">mprintf</link> + + </member> + + <member> + + <link linkend="mput">mput</link> + + </member> + + <member> + + <link linkend="mputstr">mputstr</link> + + </member> + + <member> + + <link linkend="mscanf">mscanf</link> + + </member> + + <member> + + <link linkend="mseek">mseek</link> + + </member> + + <member> + + <link linkend="mtell">mtell</link> + + </member> + + <member> + + <link linkend="mdelete">mdelete</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/mopen.xml b/modules/fileio/help/ja_JP/mopen.xml new file mode 100755 index 000000000..48610f334 --- /dev/null +++ b/modules/fileio/help/ja_JP/mopen.xml @@ -0,0 +1,632 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mopen" xml:lang="ja"> + + <refnamediv> + + <refname>mopen</refname> + + <refpurpose>ファイルをオープン</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>[fd, err] = mopen(file [, mode, swap ])</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>file</term> + + <listitem> + + <para>オープンするファイルのパスを有する文字列.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>mode</term> + + <listitem> + + <para> + + ファイルにリクエストするアクセスモードを指定する文字列. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>swap</term> + + <listitem> + + <para> + + スカラー. <varname>swap</varname> が存在し, + + <code>swap = 0</code>の場合, + + 自動バイトスワップは無効になります. + + </para> + + <para>デフォルト値は 1です.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>err</term> + + <listitem> + + <para>スカラー. エラーインジケータ. </para> + + <informaltable border="1"> + + <tr> + + <td>エラー値:</td> + + <td>エラーメッセージ:</td> + + </tr> + + <tr> + + <td>0</td> + + <td>エラー無し</td> + + </tr> + + <tr> + + <td>-1</td> + + <td>論理ユニットがなくなりました</td> + + </tr> + + <tr> + + <td>-2</td> + + <td>ファイルをオープンできませんでした</td> + + </tr> + + <tr> + + <td>-3</td> + + <td>メモリがなくなりました</td> + + </tr> + + <tr> + + <td>-4</td> + + <td>名前が無効</td> + + </tr> + + <tr> + + <td>-5</td> + + <td>無効なステータス</td> + + </tr> + + </informaltable> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>fd</term> + + <listitem> + + <para> + + スカラー: ファイル記述子(正の整数). + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <function>mopen</function>は,C言語の<function>fopen</function> + + プロシージャと互換の方法で<varname>file</varname>をオープンするために + + 使用できます. + + <varname>swap</varname>引数が指定されない場合, + + ファイルが"リトルインディアン IEEE 形式"でコード化されていると + + 仮定されます. + + プロセッサのIEEE形式と一致させる必要がある場合, + + データはスワップされます. + + </para> + + <para> + + <varname>mode</varname>パラメータは,ストリームにリクエストされる + + アクセス型を制御します. + + パラメータには以下の値の一つを指定することができます: + + <variablelist> + + <varlistentry> + + <term>r</term> + + <listitem> + + <para> + + 読み込み用にオープン(デフォルト). + + ファイルは存在する必要があり,そうでない場合は失敗します. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>w</term> + + <listitem> + + <para> + + 書き込み用にオープン. + + ファイルが存在する場合,その内容は破棄されます. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>a</term> + + <listitem> + + <para> + + 追記用にオープン. + + ファイルが存在しない場合は作成されます. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>r+</term> + + <listitem> + + <para> + + 読込みおよび書き込み両方でオープン. + + ファイルは存在する必要があり,そうでない場合は失敗します. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>w+</term> + + <listitem> + + <para> + + 読込みおよび書き込み両方でオープン. + + ファイルが存在する場合,その内容は破棄されます. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>a+</term> + + <listitem> + + <para> + + 読込みおよび書き込み両方でオープン. + + ファイルが存在しない場合は作成されます. + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </para> + + <para> + + 加えて, ファイルの型を指定するために以下の文字を使用できます: + + <variablelist> + + <varlistentry> + + <term>t</term> + + <listitem> + + <para>テキストファイル.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>b</term> + + <listitem> + + <para>バイナリファイル (デフォルト).</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </para> + + <para> + + デフォルトのアクセスモードは <literal>'rb'</literal> + + (バイナリファイル読込み)です. + + </para> + + <para> + + <note> + + 注意: Windowsでは, テキストファイルモードで, CR (復改) - LF (ラインフィード) + + の組は読込み次にLFに変換され, + + LFは書き込み時に CR-LF の組に変換されます. + + </note> + + </para> + + <para> + + 更新用にファイルをオープンする際, + + 結果のストリームに入力および出力の両方の処理を行うことができます. + + しかし,ファイル中の位置決め処理(<function>mseek</function>関数)を行わずに + + 出力処理を入力処理の直後に行うことはできません. + + また,入力処理がファイルの終端に達しない限り, + + ファイルの位置決め処理を中断せずに + + 入力処理を出力処理の直後に行うことはできません. + + </para> + + <para> + + ファイルを追記用にオープンする場合(つまり,<varname>mode</varname>パラメータが + + <literal>a</literal>または<literal>a+</literal>の場合), + + ファイルにすでにある情報を上書きすることは + + できません. <function>mseek</function>関数により, + + ファイルの任意の位置にファイルポインタを移動することができますが, + + 出力をファイルに書き込む際に,カレントのファイルポインタは無視されます. + + 全ての出力はファイルの終端に書き込まれ, + + ファイル位置は出力の末尾に移動されます. + + </para> + + <para> + + Fortran関数と互換性のある方法でファイルをオープンするには, + + <function>file</function>関数を使用してください. + + </para> + + </refsection> + + <refsection> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +// SCI+'/ACKNOWLEDGEMENTS'をテキスト,読込みのみとしてオープン +fd_r = mopen(SCI+'/ACKNOWLEDGEMENTS','rt') + +// fd_rから5行読み込む +mgetl(fd_r, 5) + +// ファイルを読み込む他の方法 +// 5ワードを読み込む +mfscanf(5,fd_r,'%s') + +// テキスト,読込みのみのSCI+'/ACKNOWLEDGEMENTS'のファイル記述子を閉じる +mclose(fd_r); + ]]></programlisting> + + </refsection> + + <refsection> + + </refsection> + + <refsection> + + <programlisting role="example"><![CDATA[ +// ファイルを書き込みプロパティ付きテキストとしてオープン +fd_w = mopen(TMPDIR+'/write.txt','wt'); + +// fd_w に1行書き込み +mputl('This is a line of text', fwd_w); +mclose(fd_w); + +// テキスト読み込み +fd_r2 = mopen(TMPDIR+'/write.txt','rt'); +mgetl(fd_r2) +mclose(fd_r2); + ]]></programlisting> + + </refsection> + + <refsection> + + </refsection> + + <refsection> + + <programlisting role="example"><![CDATA[ +// 書き込んだファイルをバイナリとして読み込む + +// まずファイルに書き込む +fd_wb = mopen(TMPDIR+'/writeread.bin','wb') + +// バイナリとして値を出力 +mput(2003,'l',fd_wb); +mput(2008,'i',fd_wb); +mput(2012,'s',fd_wb); +mput(98,'c',fd_wb); + +// TMPDIR+'/writeread.bin'を指すファイル記述子を閉じる +mclose(fd_wb); + +// ファイルを読み込む +fd_rb = mopen(TMPDIR+'/writeread.bin','rb') + +mget(fd_rb, 'l') +mget(fd_rb, 'i') +mget(fd_rb, 's') +mget(fd_rb, 'c') + +mclose(fd_rb) + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="mclose">mclose</link> + + </member> + + <member> + + <link linkend="merror">merror</link> + + </member> + + <member> + + <link linkend="meof">meof</link> + + </member> + + <member> + + <link linkend="mfprintf">mfprintf</link> + + </member> + + <member> + + <link linkend="fprintfMat">fprintfMat</link> + + </member> + + <member> + + <link linkend="mfscanf">mfscanf</link> + + </member> + + <member> + + <link linkend="fscanfMat">fscanfMat</link> + + </member> + + <member> + + <link linkend="mget">mget</link> + + </member> + + <member> + + <link linkend="mgetl">mgetl</link> + + </member> + + <member> + + <link linkend="mgetstr">mgetstr</link> + + </member> + + <member> + + <link linkend="mprintf">mprintf</link> + + </member> + + <member> + + <link linkend="mput">mput</link> + + </member> + + <member> + + <link linkend="mputl">mputl</link> + + </member> + + <member> + + <link linkend="mputstr">mputstr</link> + + </member> + + <member> + + <link linkend="mscanf">mscanf</link> + + </member> + + <member> + + <link linkend="mseek">mseek</link> + + </member> + + <member> + + <link linkend="mtell">mtell</link> + + </member> + + <member> + + <link linkend="mdelete">mdelete</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/movefile.xml b/modules/fileio/help/ja_JP/movefile.xml new file mode 100755 index 000000000..f76b24ad9 --- /dev/null +++ b/modules/fileio/help/ja_JP/movefile.xml @@ -0,0 +1,201 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2009 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="movefile" xml:lang="ja"> + + <refnamediv> + + <refname>movefile</refname> + + <refpurpose>ファイルまたはディレクトリを移動する</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>movefile(source, destination) + + [status, message] = movefile(source, destination) + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>source</term> + + <listitem> + + <para> + + 文字列. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>destination</term> + + <listitem> + + <para> + + 文字列. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>status</term> + + <listitem> + + <para> + + 整数: 処理ステータス. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>message</term> + + <listitem> + + <para> + + 文字列: エラーに関するメッセージ. + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <code>movefile(source, destination)</code>は, + + ファイルまたはディレクトリ + + <varname>source</varname>(およびサブディレクトリ)を + + をファイルまたはディレクトリ<varname>destination</varname> + + に移動します. + + </para> + + <para> + + <varname>source</varname>がディレクトリの場合, + + <varname>destination</varname>にファイルを指定することは + + できません. + + <warning> + + <function>movefile</function> + + は,警告を発生せずに既存のファイルを置換します. + + </warning> + + </para> + + <para> + + <code>[status, message] = movefile(source, destination)</code>は, + + <varname>source</varname>から<varname>destination</varname> + + に移動し,<varname>status</varname>と<varname>message</varname>を返します. + + </para> + + <para> + + どのようなオペレーティングシステムであろうと, + + 移動に成功した場合,<varname>status</varname>は1となり, + + <varname>message</varname>は空になります ; + + 移動に失敗した場合, + + <varname>status</varname>は0となり,<varname>message</varname>は空でなくなります. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ + copyfile(SCI+"/etc/scilab.start",TMPDIR+"/scilab.start") + [status,message] = movefile(TMPDIR+"/scilab.start",TMPDIR+"/renamed_scilab.start") + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="copyfile">copyfile</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/mput.xml b/modules/fileio/help/ja_JP/mput.xml new file mode 100755 index 000000000..a864c0a80 --- /dev/null +++ b/modules/fileio/help/ja_JP/mput.xml @@ -0,0 +1,330 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="mput"> + + <refnamediv> + + <refname>mput</refname> + + <refpurpose>指定したバイナリ形式でバイトまたはワードを書き込む</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>mput(x [, type, fd])</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>x</term> + + <listitem> + + <para>浮動小数点数または整数型の数値のベクトル</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>fd</term> + + <listitem> + + <para> + + スカラー: <function>mopen</function>関数により返された + + ファイル記述子. + + <literal>-1</literal>は,直近にオープンされたファイルを意味します. + + デフォルト値は<literal>-1</literal>です. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>type</term> + + <listitem> + + <para> + + 文字列: <varname>x</varname>の全エントリを書き込む際に + + 使用されるバイナリ形式を指定. + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <function>mput</function> 関数は, + + ストリームパラメータ<varname>fd</varname>で指定した出力先にデータを + + を書き込みます. + + データはポインタのカレントの位置に書き込まれ, + + ポインタのインジケータは前に適当に前に移動されます. + + </para> + + <para> + + <varname>type</varname>パラメータは変換指定子で, + + 以下のフラグ文字(デフォルト値 <literal>"l"</literal>) + + のどれかを指定します: + + </para> + + <variablelist> + + <varlistentry> + + <term>"l", "i", "s", "ul", "ui", "us", "d", "f", "c", "uc"</term> + + <listitem> + + <para> + + それぞれ long long, int (long int), short, unsigned long long int, + + unsigned int (long int), unsigned short, + + double, float, char, unsigned char を書き込みます. + + 書き込んだバイトは,(リトルインディアンモードで)マシンに + + 依存するバイナリファイルを出力するために + + (リトルインディアンステータスを確認することにより) + + 必要に応じて自動的にスワップされます. + + このデフォルトのスワップモードは,<function>mopen</function>関数に + + フラグ<code>swap = 0</code>を追加することにより抑制できます. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>"..l" または "..b"</term> + + <listitem> + + <para> + + <literal>"l"</literal>または<literal>"b"</literal>文字を + + <varname>type</varname>指定子の末尾に追加することにより, + + リトルインディアンまたはビッグインディアンモードで書き込むことも可能です. + + 例えば,<literal>"db"</literal>はビッグインディアンモードでdoubleを書き込みます. + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +filen = 'test.bin'; +mopen(filen,'wb'); +mput(1996,'l');mput(1996,'i');mput(1996,'s');mput(98,'c'); +// force little-endian +mput(1996,'ll');mput(1996,'il');mput(1996,'sl');mput(98,'cl'); +// force big-endian +mput(1996,'lb');mput(1996,'ib');mput(1996,'sb');mput(98,'cb'); +mclose(); +mopen(filen,'rb'); +if 1996<>mget(1,'l') then pause,end +if 1996<>mget(1,'i') then pause,end +if 1996<>mget(1,'s') then pause,end +if 98<>mget(1,'c') then pause,end +// リトルインディアンを強制 +if 1996<>mget(1,'ll') then pause,end +if 1996<>mget(1,'il') then pause,end +if 1996<>mget(1,'sl') then pause,end +if 98<>mget(1,'cl') then pause,end +// ビッグインディアンを強制 +if 1996<>mget(1,'lb') then pause,end +if 1996<>mget(1,'ib') then pause,end +if 1996<>mget(1,'sb') then pause,end +if 98<>mget(1,'cb') then pause,end +mclose(); + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="mclose">mclose</link> + + </member> + + <member> + + <link linkend="meof">meof</link> + + </member> + + <member> + + <link linkend="mfprintf">mfprintf</link> + + </member> + + <member> + + <link linkend="fprintfMat">fprintfMat</link> + + </member> + + <member> + + <link linkend="mfscanf">mfscanf</link> + + </member> + + <member> + + <link linkend="fscanfMat">fscanfMat</link> + + </member> + + <member> + + <link linkend="mget">mget</link> + + </member> + + <member> + + <link linkend="mgetl">mgetl</link> + + </member> + + <member> + + <link linkend="mgetstr">mgetstr</link> + + </member> + + <member> + + <link linkend="mopen">mopen</link> + + </member> + + <member> + + <link linkend="mprintf">mprintf</link> + + </member> + + <member> + + <link linkend="mputl">mputl</link> + + </member> + + <member> + + <link linkend="mputstr">mputstr</link> + + </member> + + <member> + + <link linkend="mscanf">mscanf</link> + + </member> + + <member> + + <link linkend="mseek">mseek</link> + + </member> + + <member> + + <link linkend="mtell">mtell</link> + + </member> + + <member> + + <link linkend="mdelete">mdelete</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/mputl.xml b/modules/fileio/help/ja_JP/mputl.xml new file mode 100755 index 000000000..0283fd195 --- /dev/null +++ b/modules/fileio/help/ja_JP/mputl.xml @@ -0,0 +1,195 @@ +<?xml version="1.0" encoding="utf-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Serge STEER + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mputl" xml:lang="ja"> + + <refnamediv> + + <refname>mputl</refname> + + <refpurpose>テキストファイルに文字列を書き込む</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>r = mputl(txt, file_desc)</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>r</term> + + <listitem> + + <para> + + 関数がファイルに正しく書き込んだかどうかをチェックするために + + <literal>%t</literal>または<literal>%f</literal>を返します. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>file_desc</term> + + <listitem> + + <para> + + ファイル名を指定する文字列または + + </para> + + <para> + + 整数スカラー: + + <function>mopen</function>関すから返されたファイル記述子. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>txt</term> + + <listitem> + + <para>文字列のベクトル.</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <function>mputl</function>関数により,文字列ベクトルを + + 一連の行としてテキストファイルに書き込むことができます. + + </para> + + <para> + + <function>mputl</function> は,ANSI/アスキー および UTF-8 + + でエンコードされた文字列をサポートします. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +fd = mopen(TMPDIR+'/text_mputl.txt','wt'); +mputl('Hello World',fd); +mclose(fd); +mputl('Simple Hello World',TMPDIR+"/text_mputl_simple.txt"); +fd = mopen(TMPDIR+'/text_mputl.txt','rt'); +disp(mgetl(fd)); +mclose(fd); + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="mget">mget</link> + + </member> + + <member> + + <link linkend="mgetl">mgetl</link> + + </member> + + <member> + + <link linkend="mclose">mclose</link> + + </member> + + <member> + + <link linkend="mfprintf">mfprintf</link> + + </member> + + <member> + + <link linkend="mput">mput</link> + + </member> + + <member> + + <link linkend="mputstr">mputstr</link> + + </member> + + <member> + + <link linkend="mopen">mopen</link> + + </member> + + <member> + + <link linkend="write">write</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/mputstr.xml b/modules/fileio/help/ja_JP/mputstr.xml new file mode 100755 index 000000000..54fa3e2df --- /dev/null +++ b/modules/fileio/help/ja_JP/mputstr.xml @@ -0,0 +1,215 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="mputstr"> + + <refnamediv> + + <refname>mputstr</refname> + + <refpurpose>ファイルに文字列を書き込む</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>mputstr(str [, fd]);</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>fd</term> + + <listitem> + + <para> + + スカラー: <function>mopen</function>関数により返されたファイル記述子. + + <literal>-1</literal>は直近にオープンされたファイルを意味します. + + デフォルト値は<literal>-1</literal>です. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>str</term> + + <listitem> + + <para>文字列.</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <function>mputstr</function> 関数により文字列<varname>str</varname>を + + バイナリファイルに書き込むことが可能です. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ + +this_file = pathconvert(TMPDIR+"/mputstr.txt", %F); + +fd = mopen(this_file, "wt"); +mputstr("Scilab", fd); +mclose(fd); + +mgetl(this_file) // Scilab + + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="mclose">mclose</link> + + </member> + + <member> + + <link linkend="meof">meof</link> + + </member> + + <member> + + <link linkend="mfprintf">mfprintf</link> + + </member> + + <member> + + <link linkend="fprintfMat">fprintfMat</link> + + </member> + + <member> + + <link linkend="mfscanf">mfscanf</link> + + </member> + + <member> + + <link linkend="fscanfMat">fscanfMat</link> + + </member> + + <member> + + <link linkend="mget">mget</link> + + </member> + + <member> + + <link linkend="mgetstr">mgetstr</link> + + </member> + + <member> + + <link linkend="mopen">mopen</link> + + </member> + + <member> + + <link linkend="mprintf">mprintf</link> + + </member> + + <member> + + <link linkend="mput">mput</link> + + </member> + + <member> + + <link linkend="mputstr">mputstr</link> + + </member> + + <member> + + <link linkend="mscanf">mscanf</link> + + </member> + + <member> + + <link linkend="mseek">mseek</link> + + </member> + + <member> + + <link linkend="mtell">mtell</link> + + </member> + + <member> + + <link linkend="mdelete">mdelete</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/mseek.xml b/modules/fileio/help/ja_JP/mseek.xml new file mode 100755 index 000000000..b4d859d88 --- /dev/null +++ b/modules/fileio/help/ja_JP/mseek.xml @@ -0,0 +1,283 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="mseek"> + + <refnamediv> + + <refname>mseek</refname> + + <refpurpose>バイナリファイルの中でカレントの位置を設定する. </refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>mseek(n [,fd, flag])</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>n</term> + + <listitem> + + <para>スカラー: オフセット(単位:バイト数).</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>fd</term> + + <listitem> + + <para> + + スカラー: <function>mopen</function>関数により返されたファイル記述子. + + <literal>-1</literal>は直近にオープンされたファイルを意味します. + + デフォルト値は<literal>-1</literal>です. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>flag</term> + + <listitem> + + <para> + + 文字列: 原点を指定. デフォルト値 <literal>'set'</literal>. + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + 関数 <function>mseek</function>は,ストリーム<varname>fd</varname>上での + + 次の入力または出力処理の位置を設定します. + + 新たな位置は,符号付きの位置を表すバイト数<varname>n</varname>で指定した位置となります. + + この値の意味は, <literal>flag</literal> の値,つまり, + + <literal>'set'</literal>, <literal>'cur'</literal> または <literal>'end'</literal> + + に基づき,先頭位置から,または,現在位置から,または,ファイル終端からとなります. + + これが, <varname>flag</varname> が <literal>'set'</literal>の場合に + + <varname>n</varname>を正としなければならない理由です. + + </para> + + <para> + + <function>mseek</function> により + + ファイルの既存のデータの終端より後の部分にファイル位置インジケータを + + 設定することができるようになります. + + データがこのような場所に書き込まれた時, + + 隙間にあるデータが読み込まれた場合に, + + 隙間に実際に書き込まれたデータに達するまでは + + 0 が返されます. + + <function>mseek</function>は,それ自体では, + + ファイルの大きさを拡張しません. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +file3=fullfile(TMPDIR,'test3.bin'); +fd1= mopen(file3,'wb'); +for i=1:10 + mput(i,'d'); +end +mseek(0); +mput(678,'d'); +mseek(0,fd1,'end'); +mput(932,'d'); +mclose(fd1) + +fd1= mopen(file3,'rb'); +res=mget(11,'d') +res1=[1:11]; res1(1)=678;res1($)=932; +if res1<>res then + write(%io(2),'Bug'); +end +mseek(0,fd1,'set'); + +// 保存されたデータより多くのデータを読み込む +res1=mget(100,'d',fd1); +if res1<>res then + write(%io(2),'Bug'); +end +meof(fd1) +mclearerr(fd1) +mclose(fd1); + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="mclose">mclose</link> + + </member> + + <member> + + <link linkend="meof">meof</link> + + </member> + + <member> + + <link linkend="mfprintf">mfprintf</link> + + </member> + + <member> + + <link linkend="fprintfMat">fprintfMat</link> + + </member> + + <member> + + <link linkend="mfscanf">mfscanf</link> + + </member> + + <member> + + <link linkend="fscanfMat">fscanfMat</link> + + </member> + + <member> + + <link linkend="mget">mget</link> + + </member> + + <member> + + <link linkend="mgetstr">mgetstr</link> + + </member> + + <member> + + <link linkend="mopen">mopen</link> + + </member> + + <member> + + <link linkend="mprintf">mprintf</link> + + </member> + + <member> + + <link linkend="mput">mput</link> + + </member> + + <member> + + <link linkend="mputstr">mputstr</link> + + </member> + + <member> + + <link linkend="mscanf">mscanf</link> + + </member> + + <member> + + <link linkend="mseek">mseek</link> + + </member> + + <member> + + <link linkend="mtell">mtell</link> + + </member> + + <member> + + <link linkend="mdelete">mdelete</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/mtell.xml b/modules/fileio/help/ja_JP/mtell.xml new file mode 100755 index 000000000..5cfed12bb --- /dev/null +++ b/modules/fileio/help/ja_JP/mtell.xml @@ -0,0 +1,210 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="mtell"> + + <refnamediv> + + <refname>mtell</refname> + + <refpurpose>ファイル先頭基準でカレントバイトのオフセットを返す</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>mtell([fd])</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>fd</term> + + <listitem> + + <para> + + スカラー: <function>mopen</function>関数により返されたファイル記述子. + + <literal>-1</literal>は直近にオープンされたファイルを意味します. + + デフォルト値は<literal>-1</literal>です. + + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + 関数 <function>mtell</function> は, + + 名前付きのストリーム<varname>fd</varname>が指すファイルの先頭を基準として + + カレントのバイトのオフセットを返します. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +// バイナリ書き込みでテンポラリファイルをオープン +testFile=TMPDIR + '/testFile.bin'; +fd = mopen(testFile,'wb'); + +mput(42,'d'); // 直近にオープンされたファイルに 42を書き込みます +mtell() // ファイル記述子のカレントの位置, 8を返します + +mput(42+2,'d', fd); // オープンされたfdに透過的に42を書き込みます +mtell(fd) // ファイル記述子のカレントの位置, 16を返します + +mseek(0, fd); // ファイル先端に戻る +mtell(fd) // 0を返します + +mclose(fd); + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="mclose">mclose</link> + + </member> + + <member> + + <link linkend="meof">meof</link> + + </member> + + <member> + + <link linkend="mfprintf">mfprintf</link> + + </member> + + <member> + + <link linkend="fprintfMat">fprintfMat</link> + + </member> + + <member> + + <link linkend="mfscanf">mfscanf</link> + + </member> + + <member> + + <link linkend="fscanfMat">fscanfMat</link> + + </member> + + <member> + + <link linkend="mget">mget</link> + + </member> + + <member> + + <link linkend="mgetstr">mgetstr</link> + + </member> + + <member> + + <link linkend="mopen">mopen</link> + + </member> + + <member> + + <link linkend="mprintf">mprintf</link> + + </member> + + <member> + + <link linkend="mput">mput</link> + + </member> + + <member> + + <link linkend="mputstr">mputstr</link> + + </member> + + <member> + + <link linkend="mscanf">mscanf</link> + + </member> + + <member> + + <link linkend="mseek">mseek</link> + + </member> + + <member> + + <link linkend="mtell">mtell</link> + + </member> + + <member> + + <link linkend="mdelete">mdelete</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/newest.xml b/modules/fileio/help/ja_JP/newest.xml new file mode 100755 index 000000000..950cd8116 --- /dev/null +++ b/modules/fileio/help/ja_JP/newest.xml @@ -0,0 +1,132 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="newest"> + + <refnamediv> + + <refname>newest</refname> + + <refpurpose>ファイルの集合の中で最新のファイルを返す</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>k = newest(paths) + + k = newest(path1, path2, ..., pathn) + + </synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>k</term> + + <listitem> + + <para>整数: 最新のファイルの添字</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>paths</term> + + <listitem> + + <para> + 文字列ベクトル, <code>paths(i)</code> は<literal>i</literal>番目のファイルの名前 + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>pathi</term> + + <listitem> + + <para> + 文字列, <literal>i</literal>番目のファイルのパス名 + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + パス名の集合を指定すると,<function>newest</function>は, + + 最新のファイルの添字を返します. + + 存在しないファイルは最も古いと仮定されます. + + </para> + + </refsection> + + <refsection> + + <title>例</title> + + <programlisting role="example"><![CDATA[ +newest('SCI/modules/graphics/macros/bode.sci','SCI/modules/graphics/macros/bode.bin') +newest(['SCI/modules/graphics/macros/bode.sci','SCI/modules/graphics/macros/bode.bin']) +newest('SCI/modules/graphics/macros/bode.'+['sci','bin']) + ]]></programlisting> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="fileinfo">fileinfo</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/path_filename/CHAPTER b/modules/fileio/help/ja_JP/path_filename/CHAPTER new file mode 100755 index 000000000..7475b052d --- /dev/null +++ b/modules/fileio/help/ja_JP/path_filename/CHAPTER @@ -0,0 +1,2 @@ +title = Paths - Filenames + diff --git a/modules/fileio/help/ja_JP/path_filename/basename.xml b/modules/fileio/help/ja_JP/path_filename/basename.xml new file mode 100755 index 000000000..e5aea04d0 --- /dev/null +++ b/modules/fileio/help/ja_JP/path_filename/basename.xml @@ -0,0 +1,84 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="basename" xml:lang="ja"> + <refnamediv> + <refname>basename</refname> + <refpurpose>ファイル名からディレクトリと接尾辞を取り除く</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>files= basename(files[,flag [,flagexpand]])</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>files</term> + <listitem> + <para>ファイル名の集合を指定する文字列行列.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>flag,flagexpand</term> + <listitem> + <para>オプションの論理値パラメータ. (デフォルト値 + <literal>%t</literal>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>files</term> + <listitem> + <para>文字列行列.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + <literal>basename</literal> は指定したファイル名の + エントリの基本部分を返します. + </para> + <para> + <literal>flag</literal> が真の場合,ファイルは + <literal>getos() == 'Windows'</literal>変数で指定した目標型にまず変換されます. + さらに, <literal>flagexpand</literal>が真の場合, + <literal>HOME</literal>, <literal>SCI</literal> または <literal>~</literal> + のような基準となる変数は環境変数により展開されます. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +files=basename('SCI/modules/fileio/macros/poo.sci') +files=basename('SCI/modules\fileio/macros/poo.sci') +files=basename('SCI/modules\fileio/macros/poo.sci.k') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="listfiles">listfiles</link> + </member> + <member> + <link linkend="pathconvert">pathconvert</link> + </member> + <member> + <link linkend="fileparts">fileparts</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/path_filename/dirname.xml b/modules/fileio/help/ja_JP/path_filename/dirname.xml new file mode 100755 index 000000000..76b0bf4eb --- /dev/null +++ b/modules/fileio/help/ja_JP/path_filename/dirname.xml @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="dirname"> + <refnamediv> + <refname>dirname</refname> + <refpurpose>ファイル名からディレクトリを得る</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>dirs = dirname(files[,flag [,flagexpand]])</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>files</term> + <listitem> + <para>ファイル名の集合を指定する文字列行列.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>flag, flagexpand</term> + <listitem> + <para> + オプションの論理値パラメータ. (デフォルト値 <literal>%t</literal>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>files, dirs</term> + <listitem> + <para>文字列行列.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + <literal>dirname</literal> は <literal>files</literal> で指定したファイルエントリの + ディレクトリ名を返します. + </para> + <para> + <literal>flag</literal> が真の場合, <literal>files</literal> は + <literal>getos() == 'Windows'</literal>変数で指定した目標型にまず + 変換されます. + 更に, <literal>flagexpand</literal> が真の場合, + <literal>HOME</literal>, <literal>SCI</literal> または <literal>~</literal> + のような接頭文字列は環境変数を用いて展開されます. + </para> + <para> + <literal>dirname(files,%f)</literal> は, + files に指定したパス名が + <literal>getos() == 'Windows'</literal>変数により指定される変換に従わない + 場合に間違った結果を出力することがあるため,注意を要します. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +dirs=dirname('SCI/modules/fileio/macros/poo.sci') +dirs=dirname('SCI/modules\fileio/macros/poo.sci') +dirs=dirname('SCI/modules\fileio/macros/poo.sci.k') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="basename">basename</link> + </member> + <member> + <link linkend="listfiles">listfiles</link> + </member> + <member> + <link linkend="pathconvert">pathconvert</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/path_filename/fileext.xml b/modules/fileio/help/ja_JP/path_filename/fileext.xml new file mode 100755 index 000000000..1beaa8c94 --- /dev/null +++ b/modules/fileio/help/ja_JP/path_filename/fileext.xml @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="fileext"> + <refnamediv> + <refname>fileext</refname> + <refpurpose>ファイルパスの拡張子を返す</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>extension = fileext(fullpath)</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>fullpath</term> + <listitem> + <para>文字列, 指定するファイルパス</para> + </listitem> + </varlistentry> + <varlistentry> + <term>extension</term> + <listitem> + <para>文字列, 拡張子部または ''</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + <literal>extension=fileext(fullpath)</literal> は + フルパス文字列をドットを含む拡張子部に分割します. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +extension = fileext('SCI/etc/scilab.start') +extension = fileext(['SCI/etc/scilab.start';'SCI/etc/scilab.quit']) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="fileparts">fileparts</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/path_filename/fileparts.xml b/modules/fileio/help/ja_JP/path_filename/fileparts.xml new file mode 100755 index 000000000..5550cba75 --- /dev/null +++ b/modules/fileio/help/ja_JP/path_filename/fileparts.xml @@ -0,0 +1,100 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Serge STEER + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="fileparts"> + <refnamediv> + <refname>fileparts</refname> + <refpurpose>ファイルパスのパス,ファイル名,拡張子を返す</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>[path,fname,extension]=fileparts(fullpath) + v=fileparts(fullpath,sel) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>fullpath</term> + <listitem> + <para>文字列, 指定したファイルパス</para> + </listitem> + </varlistentry> + <varlistentry> + <term>sel</term> + <listitem> + <para>オプションの文字列セレクタ, 以下の値を指定可能: + <literal>'path'</literal>, <literal>'fname'</literal> または <literal>'extension'</literal> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>path</term> + <listitem> + <para>文字列, フルパスで指定したディレクトリパス</para> + </listitem> + </varlistentry> + <varlistentry> + <term>fname</term> + <listitem> + <para>文字列, ファイル名または ''</para> + </listitem> + </varlistentry> + <varlistentry> + <term>extension</term> + <listitem> + <para>文字列, 拡張子部または ''</para> + </listitem> + </varlistentry> + <varlistentry> + <term>value</term> + <listitem> + <para> + 文字列, <literal>sel</literal>の値に依存 + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + <literal>[path,fname,extension]=fileparts(fullpath)</literal> は + フルパスの文字列を以下の3つの部分に分割します: + ディレクトリを指すパス, ファイル名の部分, + ドットを含む拡張子の部分. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +[path,fname,extension]=fileparts('SCI/etc/scilab.start') +fileparts('SCI/etc/scilab.start','extension') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="pathconvert">pathconvert</link> + </member> + <member> + <link linkend="basename">basename</link> + </member> + <member> + <link linkend="fullfile">fullfile</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/path_filename/filesep.xml b/modules/fileio/help/ja_JP/path_filename/filesep.xml new file mode 100755 index 000000000..0f558e4b3 --- /dev/null +++ b/modules/fileio/help/ja_JP/path_filename/filesep.xml @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="filesep"> + <refnamediv> + <refname>filesep</refname> + <refpurpose>カレントのプラットフォームにおけるディレクトのリセパレータを返す + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>s = filesep()</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>s</term> + <listitem> + <para>a string</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>rディレクトのリセパレータを返します. + ( GNU/Linuxでは'/', Windowsでは'\' ) + </para> + </refsection> + <refsection> + <title>rei + </title> + <programlisting role="example"><![CDATA[ +filesep() + ]]></programlisting> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/path_filename/fullfile.xml b/modules/fileio/help/ja_JP/path_filename/fullfile.xml new file mode 100755 index 000000000..104db0c18 --- /dev/null +++ b/modules/fileio/help/ja_JP/path_filename/fullfile.xml @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Vincent COUVERT + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="fullfile"> + <refnamediv> + <refname>fullfile</refname> + <refpurpose>パーツから完全なファイル名を構築</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>f = fullfile(varargin)</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>varargin</term> + <listitem> + <para> + 完全なファイル名を構築するために使用される全てのディレクトリとファイル名 + (少なくとも一つのディレクトリおよびファイル名) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>f</term> + <listitem> + <para>完全なファイル名</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + <literal>f= fullfile(varargin)</literal> は, + 実行されるプラットフォームを考慮した + 完全なファイル名を構築します. + この際,ディレクトリがディレクトリセパレータで + 開始または終了するケースを処理します. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[f = fullfile("/home/", "\scilab", "macros", "\util", "fullfile.sci") +f = fullfile("C:", "\scilab", "macros", "\util", "fullfile.sci") +r = fullfile("/home/","\scilab","macros","\util", ["fullfile.sci"; "toto.sci"])]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="pathconvert">pathconvert</link> + </member> + <member> + <link linkend="fileparts">fileparts</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/path_filename/fullpath.xml b/modules/fileio/help/ja_JP/path_filename/fullpath.xml new file mode 100755 index 000000000..943672516 --- /dev/null +++ b/modules/fileio/help/ja_JP/path_filename/fullpath.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="fullpath"> + <refnamediv> + <refname>fullpath</refname> + <refpurpose> + 指定した相対パス名に関する完全なパス名を作成する. + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>res = fullpath(relative_path)</synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>res</term> + <listitem> + <para>文字列または文字列の行列</para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term>relative_path</term> + <listitem> + <para>文字列または文字列の行列</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + <code>fullpath(relative_path)</code>は, + 指定した相対パス名に関する完全なパス名を作成します. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +cd(TMPDIR); +mkdir(TMPDIR + "/niv1"); +mkdir(TMPDIR + "/niv1/niv2"); +mkdir(TMPDIR + "/niv1/niv2/niv3"); +mputl(' ', TMPDIR + "/niv1/test1.txt"); +mputl(' ' , TMPDIR + "/niv1/niv2/test2.txt"); +cd(TMPDIR + "/niv1/niv2/niv3"); +r1 = fullpath("../../test1.txt") +r2 = fullpath("../test2.txt") +M = ["../../test1.txt", "../test2.txt"]; +R = fullpath(M) + ]]></programlisting> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.4.0</revnumber> + <revremark>管理された文字列の行列 (SEP 72)</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/path_filename/get_absolute_file_path.xml b/modules/fileio/help/ja_JP/path_filename/get_absolute_file_path.xml new file mode 100755 index 000000000..f2b857cf4 --- /dev/null +++ b/modules/fileio/help/ja_JP/path_filename/get_absolute_file_path.xml @@ -0,0 +1,88 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="get_absolute_file_path" xml:lang="ja"> + <refnamediv> + <refname>get_absolute_file_path</refname> + <refpurpose> + Scilabでオープンしたファイルの絶対パス名を出力します. + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>pathname = get_absolute_file_path(filename)</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>filename</term> + <listitem> + <para>文字列 : ファイル名</para> + </listitem> + </varlistentry> + <varlistentry> + <term>pathname</term> + <listitem> + <para>文字列 : 絶対パス名</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + Scilabですでにオープンしている + ファイルの絶対パス名を出力します. + </para> + <para>get_absolute_file_path は + Scilabで現在オープンしているファイルの内部リストの中で + filename を検索し,そのパスを返します. + </para> + <para>"get_absolute_file_path" は, + Scilabが現在オープンしているファイルの内部リストの中で + "filename" を検索し,そのパスを出力します. + </para> + <para>オープンされていない場合,エラーを返します.</para> + <para>警告 : 以前のバージョン (scilab 5.0.x) では, + ファイルが見つからない場合, + カレントのディレクトが返されていました. + </para> + <para>この関数は, + Scilabスクリプトを実行する(パス)を見つけるために + 使用することができます. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +// このスクリプトを実行 +a=mopen(TMPDIR+'test.sce','wt'); +disp(get_absolute_file_path('test.sce')); +mclose(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="getshortpathname">getshortpathname</link> + </member> + <member> + <link linkend="getlongpathname">getlongpathname</link> + </member> + <member> + <link linkend="pwd">pwd</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/path_filename/getdrives.xml b/modules/fileio/help/ja_JP/path_filename/getdrives.xml new file mode 100755 index 000000000..5d06ecdca --- /dev/null +++ b/modules/fileio/help/ja_JP/path_filename/getdrives.xml @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="getdrives"> + <refnamediv> + <refname>getdrives</refname> + <refpurpose> + コンピュータのファイルシステムにマウントされている全ての + ドライブ名を取得する. + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>drives = getdrives()</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>drives</term> + <listitem> + <para>文字列の行列</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>コンピュータのファイルシステムにマウントされている全てのドライブ名を取得します.</para> + <para> + コンピュータのファイルシステムにマウントされている全てのルートを + 文字列の行列として返します. + </para> + <para>Linuxでは, + このリストはただ一つのルートディレクトリ / により構成されます. + this list consists solely of the root directory, / . + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +getdrives() + ]]></programlisting> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/path_filename/getlongpathname.xml b/modules/fileio/help/ja_JP/path_filename/getlongpathname.xml new file mode 100755 index 000000000..58304d4d6 --- /dev/null +++ b/modules/fileio/help/ja_JP/path_filename/getlongpathname.xml @@ -0,0 +1,73 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="getlongpathname" xml:lang="ja"> + <refnamediv> + <refname>getlongpathname</refname> + <refpurpose>ロングパス名を取得 (Windows専用)</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>longpath=getlongpathname(shortpath) + [longpath,bOK]=getlongpathname(shortpath) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>shortpath</term> + <listitem> + <para>ショートパスの文字列または文字列行列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>longpath</term> + <listitem> + <para>ロングパスの文字列または文字列行列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bOK</term> + <listitem> + <para>パスが変換された場合は論理値 %T または論理値の行列, + そうでない場合は %F + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>getlongpathname プリミティブは, + 指定されたパスをそのロング名に変換します. + ロングパス名が見つからない場合, + このプリミティブは指定した名前を返します. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +[longpath,bOK]=getlongpathname(SCI) +[longpaths,bOKs]=getlongpathname([SCI;SCI]) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="getshortpathname">getshortpathname</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/path_filename/getrelativefilename.xml b/modules/fileio/help/ja_JP/path_filename/getrelativefilename.xml new file mode 100755 index 000000000..c8a9b42e2 --- /dev/null +++ b/modules/fileio/help/ja_JP/path_filename/getrelativefilename.xml @@ -0,0 +1,88 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="getrelativefilename"> + <refnamediv> + <refname>getrelativefilename</refname> + <refpurpose>絶対ディレクトリおよび絶対ファイル名を指定すると, + 相対ファイル名を返す. + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>rel_file = getrelativefilename(abs_dir,abs_file)</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>abs_dir</term> + <listitem> + <para>文字列 : 絶対ディレクトリ</para> + </listitem> + </varlistentry> + <varlistentry> + <term>abs_file</term> + <listitem> + <para>文字列 : 絶対ファイル名</para> + </listitem> + </varlistentry> + <varlistentry> + <term>rel_file</term> + <listitem> + <para>文字列 : 相対ファイル名</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>絶対ディレクトリおよび絶対ファイル名を指定すると, + 相対ファイル名を返します. + </para> + <para>例えば, カレントのディレクトが C:\scilab\bin の場合,ファイル名 + C:\scilab\modules\helptools\readme.txt が指定されると, + getrelativefilename は ..\modules\helptools\readme.txt を返します. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +if getos() == "Windows" then + getrelativefilename('C:\program file\scilab-4.0\bin','C:\program file\scilab-4.0\modules\helptools\help.dtd') + getrelativefilename('C:\program file\scilab-4.0\bin\','C:\program file\scilab-4.0\modules\helptools\help.dtd') + getrelativefilename(SCI+'\bin',SCI+'\modules\helptools\help.dtd') + getrelativefilename(WSCI+'\bin',WSCI+'\modules\helptools\help.dtd') + getrelativefilename(pwd(),WSCI+'\bin\Wscilex') +else + getrelativefilename('/usr/local/scilab-4.0/bin','/usr/local/scilab-4.0/modules/helptools/help.dtd') + getrelativefilename('/usr/local/scilab-4.0/bin/','/usr/local/scilab-4.0/modules/helptools/help.dtd') + getrelativefilename(SCI+'/bin',SCI+'/modules/helptools/help.dtd') + getrelativefilename(pwd(),SCI+'/bin/scilex') +end + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="getshortpathname">getshortpathname</link> + </member> + <member> + <link linkend="getlongpathname">getlongpathname</link> + </member> + <member> + <link linkend="pwd">pwd</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/path_filename/getshortpathname.xml b/modules/fileio/help/ja_JP/path_filename/getshortpathname.xml new file mode 100755 index 000000000..f0e2489b6 --- /dev/null +++ b/modules/fileio/help/ja_JP/path_filename/getshortpathname.xml @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="getshortpathname" xml:lang="ja"> + <refnamediv> + <refname>getshortpathname</refname> + <refpurpose>ショートパス名を取得 (Windows専用)</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>shortpath=getshortgpathname(longpath) + [shortpath,bOK]=getshortpathname(longpath) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>longpath</term> + <listitem> + <para>ロングパスの文字列または文字列行列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>shortpath</term> + <listitem> + <para>ショートパスの文字列または文字列行列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bOK</term> + <listitem> + <para>パスが変換された場合は論理値 %T または論理値行列 + そうでない場合は %F + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>getshortpathname プリミティブは指定したパスを + そのショート形式に変換します. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +[shortpath,bOK]=getshortpathname(SCI) +[shortpaths,bOKs]=getshortpathname([SCI;SCI]) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="getlongpathname">getlongpathname</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/path_filename/is_absolute_path.xml b/modules/fileio/help/ja_JP/path_filename/is_absolute_path.xml new file mode 100755 index 000000000..31ddd3684 --- /dev/null +++ b/modules/fileio/help/ja_JP/path_filename/is_absolute_path.xml @@ -0,0 +1,68 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2013 - Scilab Enterprises - Charlotte HECQUET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="is_absolute_path"> + <refnamediv> + <refname>is_absolute_path</refname> + <refpurpose>引数が絶対パスかどうか調べる</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>r = is_absolute_path(path)</synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para>文字列または文字列の行列: ディレクトリパス名.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>r</term> + <listitem> + <para> + 論理値: <varname>path</varname> が絶対パスの場合に + <constant>%t</constant> + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + <code>r = is_absolute_path(path)</code> は + <varname>path</varname>が絶対パスかどうかを調べます. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +is_absolute_path(TMPDIR) +is_absolute_path("./scilab/modules/fileio") + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="get_absolute_file_path">get_absolute_file_path</link> + </member> + <member> + <link linkend="fileparts">fileparts</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/path_filename/pathconvert.xml b/modules/fileio/help/ja_JP/path_filename/pathconvert.xml new file mode 100755 index 000000000..01300ff3a --- /dev/null +++ b/modules/fileio/help/ja_JP/path_filename/pathconvert.xml @@ -0,0 +1,112 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="pathconvert"> + <refnamediv> + <refname>pathconvert</refname> + <refpurpose>POSIXおよびwindowsの間でパス名を変換. </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>paths=pathconvert(paths [,flagtrail [,flagexpand [,type]]])</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>paths</term> + <listitem> + <para>パス名を指定する文字列行列</para> + </listitem> + </varlistentry> + <varlistentry> + <term>flagtrail</term> + <listitem> + <para>オプションの論理値パラメータ.デフォルト値は TRUE.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>flagexpand</term> + <listitem> + <para>オプションの論理値パラメータ. デフォルト値はMSDOS変数に依存.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>type</term> + <listitem> + <para> + 文字列 <literal>'u'</literal> または <literal>'w'</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + <literal>pathconvert</literal> は, + (文字列行列 <literal>paths</literal>で指定した) + パス名の集合を + windowsネーティブなファイル名からPOSIX形式のファイル名に変換したり, + 戻すことができます. + 変換後の形式はオプションの文字列<literal>type</literal>で指定でき, + Unixの場合は <literal>'u'</literal>,Windowsの場合は<literal>'w'</literal> + を指定できます. + デフォルトの形式は<literal>getos() == "Windows"</literal>の値に基づき設定されます. + <literal>getos() == "Windows"</literal>が TRUE (またはFALSE) の場合, + デフォルトの形式は <literal>'w'</literal> (または <literal>'u'</literal>)となります. + </para> + <para> + <literal>name:</literal>で始まる + Windows のパス名は cygwinの表記法に基づき + <literal>/cygdrive/name/</literal>で始まるパス名に変換されます. + </para> + <para> + <literal>flagtrail</literal> はオプションの論理値パラメータです. + その値をTRUE (デフォルト値)にした時, + 末尾セパレータ + (<literal>'\'</literal> または <literal>'/'</literal>) + が抜けている場合にパスの最後に追加されます. + <literal>flagtrail</literal> が FALSE に設定されている場合, + 末尾セパレータは削除されます. + </para> + <para> + <literal>flagexpand</literal> はオプションの論理値パラメータです. + この値が TRUEの場合, + <literal>HOME</literal>, <literal>SCI</literal> または <literal>~</literal> + のような先頭文字列は環境変数により展開されます. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +pathconvert("SCI/modules/fileio\macros/foo.sci",%f,%f,"u") +pathconvert("SCI/modules/fileio\macros/foo.sci",%f,%f,"w") +pathconvert("SCI/modules/fileio/macros/foo.sci",%f,%t,"w") +pathconvert("HOME/modules/fileio/macros/foo.sci",%t,%t,"w") +pathconvert("c:/tmp",%f,%t,"u") +pathconvert("/cygdrive/c/tmp",%f,%f,"w") + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="basename">basename</link> + </member> + <member> + <link linkend="listfiles">listfiles</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/path_filename/pathsep.xml b/modules/fileio/help/ja_JP/path_filename/pathsep.xml new file mode 100755 index 000000000..e08ca8426 --- /dev/null +++ b/modules/fileio/help/ja_JP/path_filename/pathsep.xml @@ -0,0 +1,44 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="pathsep"> + <refnamediv> + <refname>pathsep</refname> + <refpurpose>カレントのプラットフォームのパスセパレータを返す</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>s = pathsep()</synopsis> + </refsynopsisdiv> + <refsection> + <title>パラメータ</title> + <variablelist> + <varlistentry> + <term>s</term> + <listitem> + <para>文字列</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>パスセパレータを返します. ( Linuxでは ':', Windows では ';' )</para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ +pathsep() +]]></programlisting> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/path_filename/splitURL.xml b/modules/fileio/help/ja_JP/path_filename/splitURL.xml new file mode 100755 index 000000000..31567b6be --- /dev/null +++ b/modules/fileio/help/ja_JP/path_filename/splitURL.xml @@ -0,0 +1,144 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) - S/E - Sylvestre Ledru + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xml:id="splitURL" xml:lang="ja" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:scilab="http://www.scilab.org" + xmlns:db="http://docbook.org/ns/docbook"> + <refnamediv> + <refname>splitURL</refname> + <refpurpose>URL (HTTP, HTTPS, FTP...) を分解</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>[proto, server, path, query, username, port, fragment] = splitURL(URL); + </synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>URL</term> + <listitem> + <para>文字列: URL. サポート/テスト済み: HTTP, HTTPS, FTP (IPv4 および IPv6)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>proto</term> + <listitem> + <para> + 文字列: プロトコル (例: <emphasis role="italic">http, ftp, 等</emphasis>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>server</term> + <listitem> + <para> + 文字列: サーバー (例: <emphasis role="italic">www.scilab.org</emphasis>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>path</term> + <listitem> + <para> + 文字列: パス (例: <emphasis role="italic">/products/scilab</emphasis>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>query</term> + <listitem> + <para> + 文字列: クエリ (例: <emphasis role="italic">?SearchText=plot3d</emphasis>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>username</term> + <listitem> + <para> + 文字列: ユーザ名 (例: <emphasis role="italic">username:pass</emphasis>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>port</term> + <listitem> + <para> + int: ポート (例: <emphasis role="italic">80</emphasis>) + </para> + <para>URLにポートが指定されない場合, 値は 0となることに注意してください.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>fragment</term> + <listitem> + <para> + 文字列: フラグメント (例: <emphasis role="italic">#chapter1</emphasis>) + </para> + <para>フラグメントはアンカーとも呼ばれ, + HTML文書内にブックマークを作成する際に使用されます. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para>URLを要素毎に分解します. </para> + <para> + この関数は <ulink url="http://xmlsoft.org/html/libxml-uri.html#xmlParseURI">libxml2ライブラリ + (特に, 関数 xmlParseURI) + </ulink> + に基づいています. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"> + [proto, server, path, query, username, port, fragment] = splitURL("http://xmlsoft.org/html/libxml-uri.html#xmlParseURI") + [proto, server, path] = splitURL("ftp://ftp.free.fr/pub/Distributions_Linux/debian/README") + [a,b,c,d]=splitURL("http://www.scilab.org/content/search?SearchText=plot") + </programlisting> + <!-- +// This example fails for now (probably a bug on evstr) +// Retrieve the content and execute it +[f,content]=getURL("http://fileexchange.scilab.org/toolboxes/161000/1.0/files/cshift.sci") +evstr(content); +M = grand(3,4,"uin",0,9); +cshift(M,1); +--> + </refsection> + <refsection role="see also"> + <title>参照</title> + <simplelist type="inline"> + <member> + <link linkend="getURL">getURL</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.5.0</revnumber> + <revremark>この関数はScilab 5.5.0で追加されました</revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/path_filename/tempname.xml b/modules/fileio/help/ja_JP/path_filename/tempname.xml new file mode 100755 index 000000000..f12ea54c4 --- /dev/null +++ b/modules/fileio/help/ja_JP/path_filename/tempname.xml @@ -0,0 +1,74 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2011 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="tempname"> + <refnamediv> + <refname>tempname</refname> + <refpurpose> + ユニークなファイル名を有するファイルを作成 + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>呼び出し手順</title> + <synopsis>tmp_name = tempname([prefix])</synopsis> + </refsynopsisdiv> + <refsection> + <title>引数</title> + <variablelist> + <varlistentry> + <term>tmp_name</term> + <listitem> + <para>文字列</para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term>prefix</term> + <listitem> + <para>文字列: ファイル名の接頭辞(Windowsでは,最大3文字).</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>説明</title> + <para> + <function>tempname</function>は, + ユニークなファイル名を有するファイルを<literal>TMPDIR</literal> ディレクトリに作成します. + </para> + <para> + <code>tmp_name = tempname()</code> は,テンポラリなファイル名として使用可能な + ユニークな文字列, <varname>tmp_name</varname>を返します. + </para> + </refsection> + <refsection> + <title>例</title> + <programlisting role="example"><![CDATA[ + F1 = tempname() + isfile(F1) + F2 = tempname('TMP') + isfile(F2) + ]]></programlisting> + </refsection> + <refsection> + <title>履歴</title> + <revhistory> + <revision> + <revnumber>5.4.0</revnumber> + <revremark> + 関数<function>tempname</function>が導入されました. + </revremark> + </revision> + </revhistory> + </refsection> +</refentry> diff --git a/modules/fileio/help/ja_JP/save_format.xml b/modules/fileio/help/ja_JP/save_format.xml new file mode 100755 index 000000000..ea1d55e31 --- /dev/null +++ b/modules/fileio/help/ja_JP/save_format.xml @@ -0,0 +1,1595 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="save_format" xml:lang="ja"> + + <refnamediv> + + <refname>save_format</refname> + + <refpurpose>"save"で作成されるファイルの形式</refpurpose> + + </refnamediv> + + <refsection> + + <title>概要</title> + + <para>本文書の目的はデータをScilabでデータ保存に使用されるHDF5形式について規定することです. + + </para> + + <para>この形式はSOD (Scilab Open Data) と呼ばれます.</para> + + <para>SODの最初の公開リリースは Scilab 5.4.0で行われました.</para> + + </refsection> + + <refsection> + + <title>動機</title> + + <para> + + 相互運用性は近代的なソフトウエアの主要な特性の一つです. + + この特性をより改善するため, このSEPにおいて HDF5 形式の標準定義 + + が提案されました. + + </para> + + <para> + + Scilab 5.2.0以降, + + エキスポート/インポート機能が開発され, データ交換用に管理されています. + + これは, 既にデータを保存および交換するためのXcosの基本要素の一つです. + + </para> + + </refsection> + + <refsection> + + <title>サポートされるデータ型</title> + + <para>全てのScilabデータ型がサポートされます. 例えば:</para> + + <informaltable border="1"> + + <tbody> + + <tr> + + <td> + + <emphasis role="bold">名前</emphasis> + + </td> + + <td> + + <emphasis role="bold">Scilabにおける例</emphasis> + + </td> + + </tr> + + <tr> + + <td> + + <emphasis role="bold">double</emphasis> + + </td> + + <programlisting> + + A=32; + + b=[32,2]; + + c=[2,2;3,4]; + + d=rand(10,10); + + </programlisting> + + </tr> + + <tr> + + <td> + + <emphasis role="bold">string</emphasis> + + </td> + + <programlisting> + + a="my string"; + + b=["string 1";"my string 2"]; + + </programlisting> + + </tr> + + <tr> + + <td> + + <emphasis role="bold">boolean</emphasis> + + </td> + + <programlisting> + + a=%t; + + b=[%t, %f]; + + </programlisting> + + </tr> + + <tr> + + <td> + + <emphasis role="bold">integer</emphasis> + + </td> + + <td> + + <programlisting> + + int8([1 -120 127 312]) + + x=int32(-200:100:400) + + </programlisting> + + </td> + + </tr> + + <tr> + + <td> + + <emphasis role="bold">polynomial</emphasis> + + </td> + + <td> + + <programlisting> + + s=poly([2 3],"s") + + poly(1:4,'s','c') + + </programlisting> + + </td> + + </tr> + + <tr> + + <td> + + <emphasis role="bold">sparse</emphasis> + + </td> + + <td align="justify"> + + <programlisting> + + sp=sparse([1,2;4,5;3,10],[1,2,3]) + + </programlisting> + + </td> + + </tr> + + <tr> + + <td> + + <emphasis role="bold">boolean sparse</emphasis> + + </td> + + <td align="justify"> + + <programlisting> + + dense=[%F, %F, %T, %F, %F + + %T, %F, %F, %F, %F + + %F, %F, %F, %F, %F + + %F, %F, %F, %F, %T]; + + sp=sparse(dense) + + </programlisting> + + </td> + + </tr> + + <tr> + + <td> + + <emphasis role="bold">list</emphasis> + + </td> + + <td align="justify"> + + <programlisting> + + l = list(1,["a" "b"]) + + </programlisting> + + </td> + + </tr> + + <tr> + + <td> + + <emphasis role="bold">tlist</emphasis> + + </td> + + <td align="justify"> + + <programlisting> + + t = tlist(["listtype","field1","field2"], [], []); + + </programlisting> + + </td> + + </tr> + + <tr> + + <td> + + <emphasis role="bold">mlist</emphasis> + + </td> + + <td align="justify"> + + <programlisting> + + M=mlist(['V','name','value'],['a','b';'c' 'd'],[1 2; 3 4]); + + </programlisting> + + </td> + + </tr> + + </tbody> + + </informaltable> + + <para> + + 複数の"types"は,<emphasis>tlist</emphasis> または <emphasis>mlist</emphasis> + + に基づいています. + + これは, + + <emphasis>rational</emphasis>, <emphasis>state-space</emphasis>, + + <emphasis>hypermat</emphasis>, <emphasis>cell</emphasis> および + + <emphasis>struct</emphasis>の場合です. + + これらは透過的に保存されます. + + </para> + + <para> + + <emphasis>void</emphasis>および <emphasis>undefined</emphasis>は, + + リスト管理において特別な場合を管理するために作成された特殊な要素です. + + これらはこの文書にて後述します. + + </para> + + </refsection> + + <refsection> + + <title>HDF5ファイルの構造</title> + + <para>Scilab HDF5 アーキテクチャは非常に簡単です. </para> + + <emphasis role="bold">General</emphasis> + + <para> + + 各Scilab変数について, ルート位置におけるデータセットが宣言されます. + + データセットの名前はScilab変数の名前です. + + </para> + + <para>例, 以下のコード:</para> + + <programlisting> + + emptyuint32matrix = uint32([]); + + uint32scalar = uint32(1); + + uint32rowvector = uint32([1 4 7]); + + uint32colvector = uint32([1;4;7]); + + uint32matrix = uint32([1 4 7;9 6 3]); + + save("uint32.sod","emptyuint32matrix","uint32scalar","uint32rowvector","uint32colvector","uint32matrix"); + + </programlisting> + + <para>produces:</para> + + <mediaobject> + + <imageobject> + + <imagedata fileref="../images/img001.png" width="5.95cm" depth="1.64cm"/> + + </imageobject> + + </mediaobject> + + <para> + + 各ルートデータセットは<literal>SCILAB_Class</literal>と呼ばれる + + 属性を有します.この属性は, HDF5ファイルに保持される変数の型を定義します. + + </para> + + <para> + + 変数がプリミティブ型で関連する複合値がない場合, + + データは直接データセットに保存されます. + + それ以外の場合, データセットは実際のデータへのリファレンスを有します. + + </para> + + <para>各 SOD ファイルは2つの固有の変数を有します:</para> + + <itemizedlist> + + <listitem> + + <para> + + <literal>SCILAB_scilab_version</literal> ? + + SODファイルに保存する際に使用された Scilabのバージョンを記述します. + + </para> + + <para>例えば, Scilab 5.4.0の場合, このデータは以下となります:</para> + + <para> + + <emphasis>SCILAB_scilab_version = scilab-5.4.0</emphasis> + + </para> + + </listitem> + + <listitem> + + <para>SCILAB_sod_version ? + + SODファイルに保存する際に使用された SOD規約のバージョンを記述します. + + </para> + + <para>例えば, Scilab 5.4.0の場合, このデータは以下となります:</para> + + <para> + + <emphasis>SCILAB_sod_version = 2</emphasis> + + </para> + + </listitem> + + </itemizedlist> + + <para> + + データがデータセット内で直線的に保存される型 + + </para> + + <informaltable border="1"> + + <tbody> + + <tr> + + <td align="left"> + + <emphasis role="bold">Scilab 型</emphasis> + + </td> + + <td align="left"> + + <emphasis role="bold">HDF5 Scilab 型属性</emphasis> + + </td> + + <td align="left"> + + <emphasis role="bold">HDF5 属性</emphasis> + + </td> + + <td align="left"> + + <emphasis role="bold">HDF データ型マッピング</emphasis> + + </td> + + </tr> + + <tr> + + <td align="left"> + + <para>string</para> + + </td> + + <td align="left"> + + <para>SCILAB_Class = string</para> + + </td> + + <td align="left"> + + + + </td> + + <td align="left"> + + <para>String</para> + + </td> + + </tr> + + <tr> + + <td align="left"> + + <para>boolean</para> + + </td> + + <td namest="c2" nameend="c3" align="left"> + + <para>SCILAB_Class = boolean</para> + + </td> + + <td align="left"> + + + + </td> + + <td align="left"> + + <para>32ビット 整数</para> + + </td> + + </tr> + + <tr> + + <td align="left"> + + <para>integer</para> + + </td> + + <td namest="c2" nameend="c3" align="left"> + + <para>SCILAB_Class = integer</para> + + </td> + + <td align="left"> + + <para>SCILAB_precision = {8, 16, 32, u8, u16, u32}</para> + + </td> + + <td namest="c1" nameend="c2" align="left"> + + <para>8 = 8ビット文字</para> + + <para>16 = 16ビット整数</para> + + <para>32 = 32ビット整数</para> + + <para>u8 = 8ビット符号無し文字</para> + + <para>u16 = 16ビット符号無し整数</para> + + <para>u32 = 32ビット符号無し整数</para> + + </td> + + </tr> + + </tbody> + + </informaltable> + + <para> + + これらの型について, Scilabにおける場合と同様に, + + データは1次元配列に保存されます.データは列方向に保存されます. + + </para> + + <para> + + 行列, ベクトルまたはスカラーを再構築するために, + + 2つの属性が列と行の数を指定します. + + </para> + + <para> + + 5.4.0リリースおよび SOD v2以降, + + <literal>SCILAB_cols</literal> および<literal>SCILAB_rows</literal> は + + double, 整数, 多項式および文字列の行列ではもはや使用されなくなりました. + + SOD はネーティブな多次元HDF5機能を使用します. + + </para> + + <para> + + <emphasis role="bold">例</emphasis> + + </para> + + <para> + + 宣言の保存: <code>int32([1 -4 7;-9 6 -3])</code> は,hdfviewで以下のように表示されます: + + </para> + + <mediaobject> + + <imageobject> + + <imagedata fileref="../images/img002.png" width="5.95cm" depth="1.64cm"/> + + </imageobject> + + </mediaobject> + + <para>metadataは以下のようになります:</para> + + <emphasis role="italic"> + + <para>int32matrix (800, 2)</para> + + <para>32-bit integer, 3 x 2 => the size of the variable</para> + + <para>Number of attributes = 2</para> + + <para>SCILAB_Class = integer</para> + + <para>SCILAB_precision = 32</para> + + </emphasis> + + <para> + + <note> + + スカラー値は1行1列の行列に保存されます. + + </note> + + </para> + + <para> + + 空の変数 (<literal>[]</literal>) はtrueに設定された属性<literal>SCILAB_empty</literal>を有します. + + </para> + + <para> + + <emphasis role="bold">データが専用のグループに保存される型</emphasis> + + </para> + + <para> + + Scilabデータ型の多くはグループで保存されます. + + これにより,値の分離を明確にでき,アクセスも容易になります. + + </para> + + <para> + + グループは"#"で括られた変数から命名されます.例えば, + + matrixofdoubleと呼ばれるdoubleの行列の場合, + + ルートデータセットの名前は matrixofdoubleとなり, + + 関連するグループの名前は + + <emphasis role="strong">#matrixofdouble#</emphasis>となります. + + </para> + + <para> + + 再帰的なデータ型(list, mlist, tlist, etc)の場合, + + サブグループの名前が以下のように構築されます: + </para> + + <para> + + この <literal>#</literal> によりユニークなIDを作成できるようになります. + + 最初の<literal>#</literal>の数は深さのレベルを示します. + + 例えば, サブリスト <emphasis>###listnested#_#2##_#1##</emphasis>は, + + 2番目のレベ得るに位置することを示します. + + </para> + + <para> + + アンダースコア "_" は深さを表す手段です. + + 通常, "/" 文字がこのような場合に使用されますが, + + HDF5規約では予約済みキーワードとなっています. + + </para> + + <para> + + 名前で使用される整数は, + + カレントの構造における位置と親要素に関する位置の両方の意味で + + データ構造における位置を表します. + + 例えば, + + <emphasis>###listnested#_#2##_#1##</emphasis>, + + は,親要素の3番目の構造の2番目の要素として扱われることを示します + + (要素は0から番号付けられます). + + </para> + + <para> + + 例えば, <emphasis>###listnested#_#2##_#1##</emphasis>という名前のグループは, + + 以下の例では値 [32, 42] を指します: + + </para> + + <programlisting> + + listnested=list(2,%i,'f',ones(3,3)) + + listnested(3) = list( %t, [32,42]); + + </programlisting> + + <para> + + <emphasis role="bold">疎行列</emphasis> + + </para> + + <para> + + <emphasis role="strong">Scilab 型:</emphasis> sparse + + </para> + + <para> + + <emphasis role="strong">HDF5 Scilab 型属性:</emphasis> SCILAB_Class = sparse + + </para> + + <para> + + <emphasis role="strong">HDF5 属性: </emphasis> + + </para> + + <para>SCILAB_rows = <int></para> + + <para>行数</para> + + <para> + + <emphasis>SCILAB_cols = <int></emphasis> + + </para> + + <para>列数</para> + + <para> + + <emphasis>SCILAB_items = <int></emphasis> + + </para> + + <para>疎行列における要素数を定義</para> + + <para> + + <emphasis role="strong">ルートデータセットの値:</emphasis> + + </para> + + <para> + + 最初の値 (<literal>#0#</literal>): + + このデータ構造の各要素は各行の非ヌル要素の数を示します. + + つまり, 最初の要素は疎行列の最初の行の要素数を示します. + + </para> + + <para> + + 2番目の値 (<literal>#1#</literal>): + + 疎行列の各要素の列の位置を示します. + + </para> + + <para> + + 3番目の値 (<literal>#2#</literal>): + + 疎行列における要素の実際の値へのリファレンスを保存します + + (この値は専用のグループに保存されます). + + </para> + + <para>例えば, この行列を考えると:</para> + + <programlisting role="no-scilab-exec"> + + 0. 1. 0. 0. 0. 0. 0. 0. 0. 0. + + 0. 0. 0. 0. 0. 0. 0. 0. 0. 0. + + 0. 0. 0. 0. 0. 0. 0. 0. 0. 3. + + 0. 0. 0. 0. 2. 0. 0. 0. 0. 0. + + </programlisting> + + <para>これは以下の関数で生成されます:</para> + + <programlisting role="scilab_code"> + + sparse([1,2;4,5;3,10],[1,2,3]) + + </programlisting> + + <para> + + これは以下となります: + + </para> + + <para> + + <emphasis>#0#</emphasis> は,<emphasis>1;0;1;1</emphasis>を有します + + </para> + + <para> + + <emphasis>#1#</emphasis> は,<emphasis>2;10;5</emphasis>を有します + + </para> + + <para> + + <emphasis>#2#</emphasis> は,<emphasis>1.0; 3.0; 2.0</emphasis>を有する + + double(この例では複素数ではありません)の行列を参照します + + </para> + + <para> + + <emphasis role="bold">論理値疎行列</emphasis> + + </para> + + <para> + + <emphasis role="strong">Scilab型:</emphasis> boolean sparse + + </para> + + <para> + + <emphasis role="strong">HDF5 Scilab 型属性:</emphasis> SCILAB_Class = boolean sparse + + </para> + + <para> + + <emphasis>HDF5属性:</emphasis> + + </para> + + <para> + + <emphasis>SCILAB_rows = <int></emphasis> + + </para> + + <para>行数</para> + + <para> + + <emphasis>SCILAB_cols = <int></emphasis> + + </para> + + <para>列数</para> + + <para> + + <emphasis>SCILAB_items = <int></emphasis> + + </para> + + <para>疎行列の要素数を定義</para> + + <para> + + <emphasis role="strong">ルートデータセットの値:</emphasis> 疎行列は3つのデータセットを有しますが, + + 論理値疎行列は2つのみです.これは定義される値は自動的にtrueとみなされるためです. + + </para> + + <para> + + 最初の値 (<literal>#0#</literal>): このデータ構造の各要素は各行の非ゼロ要素の数を示します. + + </para> + + <para> + + つまり, 最初の要素は疎行列の最初の行の要素数を示します. + + </para> + + <para> + + 2番目の値 (<literal>#1#</literal>): + + 疎行列の各要素の列の位置を示します. + + </para> + + <para>以下の論理値疎行列について:</para> + + <programlisting> + + dense=[%F, %F, %T, %F, %F + + %T, %F, %F, %F, %F + + %F, %F, %F, %F, %F + + %F, %F, %F, %F, %T]; + + </programlisting> + + <para> + + <emphasis>#0#</emphasis> は <emphasis>1;1;0;1</emphasis>を有します. + + </para> + + <para> + + <emphasis>#1#</emphasis> は <emphasis>3;1;5</emphasis>を有します. + + </para> + + <para> + + 論理値疎行列を再生するために必要な情報は2つのみです. + + </para> + + <para>HDFデータ型マッピング:</para> + + <para>32ビット整数</para> + + <para> + + <emphasis role="bold">Double</emphasis> + + </para> + + <para> + + <emphasis role="strong">Scilab 型:</emphasis> double + + </para> + + <para> + + <emphasis role="strong">HDF5 Scilab 型属性:</emphasis> SCILAB_Class = double + + </para> + + <para> + + <emphasis role="strong">ルートデータセットの値:</emphasis> + + 実数および複素数の値は共に<literal>#<variable name>#</literal>と + + 呼ばれるグループに保存されます. + + </para> + + <para> + + 最初の値: 実数値へのリファレンス. 名前は<literal>#0#</literal>. + + </para> + + <para> + + 行列が複素数の場合, 2番目の値は複素数の値へのリファレンスとなります. 名前は<literal>#1#</literal>. + + </para> + + <para> + + <emphasis role="strong">HDF データ型マッピング:</emphasis> 64-bit floating-point + + </para> + + <para> + + <emphasis role="bold">多項式</emphasis> + + </para> + + <para> + + <emphasis role="strong">Scilab 型:</emphasis> polynomial + + </para> + + <para> + + <emphasis role="strong">HDF5 Scilab 型属性:</emphasis> SCILAB_Class = polynomial + + </para> + + <para> + + <emphasis role="strong">HDF5 属性: </emphasis> + + </para> + + <para>SCILAB_Class = polynomial</para> + + <para>SCILAB_varname = <string></para> + + <para>シンボル変数の名前</para> + + <para> + + <emphasis>SCILAB_Complex = <boolean></emphasis> + + </para> + + <para>多項式が複素数の場合 (そうでない場合は設定されません)</para> + + <para> + + <emphasis role="strong">ルートデータセットの値:</emphasis> + + </para> + + <para> + + 係数はdoubleの行列の形式で(double記憶領域の関連部分に)保存されます. + + 係数は,複素数にできるため,複素数の行列に保存されることに注意してください. + + (サブ)グループとデータセットの命名規則は + + 本章の先頭に記述されています. + + </para> + + <para> + + <emphasis role="strong">HDF データ型マッピング:</emphasis> Object reference + + </para> + + <para> + + <emphasis role="bold">list</emphasis> + + </para> + + <para> + + <emphasis role="strong">Scilab 型:</emphasis> list + + </para> + + <para> + + <emphasis role="strong">HDF5 Scilab 型属性:</emphasis> + + </para> + + <para>SCILAB_Class = list</para> + + <para> + + <emphasis role="strong">HDF5 属性:</emphasis> SCILAB_items = <リストの要素数> + + </para> + + <para> + + <emphasis role="strong">ルートデータセットの値:</emphasis> + + </para> + + <para> + + ルートデータセットに関連して,このデータセットで保存される値は + + リストに保存された値へのリファレンスです. + + 値は<literal>#<variable name>#</literal>と呼ばれるグループに保存されます. + + この <literal>#<variable name>#</literal> グループにおいて, + + データは任意の型とすることができます. + + これらはグループに直線的に保存されます. + + その表現は他の場合と同様で,再帰的な構造にもとづきます + + (種々の型のリストのリストのリストが保存および読込みできることを意味します). + + </para> + + <para> + + (サブ)グループとデータセットの命名規則は本章の先頭に記述されています. + + </para> + + <para> + + <emphasis role="strong">HDF データ型マッピング:</emphasis> Object reference + + </para> + + <para> + + <emphasis role="bold">tlist </emphasis> + + </para> + + <para> + + <emphasis role="strong">Scilab型:</emphasis> tlist + + </para> + + <para> + + <emphasis role="strong">HDF5 Scilab 型属性:</emphasis> + + </para> + + <para> SCILAB_Class = tlist</para> + + <para> + + <emphasis role="strong">HDF5 属性:</emphasis> cf list + + </para> + + <para> + + <emphasis role="bold">mlist </emphasis> + + </para> + + <para> + + <emphasis role="strong">Scilab type:</emphasis> mlist + + </para> + + <para> + + <emphasis role="strong">HDF5 Scilab 型属性:</emphasis> + + </para> + + <para>SCILAB_Class = mlist</para> + + <para> + + <emphasis role="strong">HDF5 attributes:</emphasis> cf list + + </para> + + <para> + + <emphasis role="bold">void </emphasis> + + </para> + + <para> + + <emphasis role="strong">Scilab型:</emphasis> void + + </para> + + <para> + + <emphasis role="strong">HDF5 Scilab 型属性:</emphasis> + + </para> + + <para>SCILAB_Class = void</para> + + <para> + + void値はlist, tlistおよびmlistの非常に特殊な使用法でのみ + + 現れます. + + 以下の構文で作成することができます: + + </para> + + <programlisting>voidelement_ref=list(1,,3);</programlisting> + + <para> + + <emphasis role="bold">undefined </emphasis> + + </para> + + <para> + + <emphasis role="strong">Scilab 型:</emphasis> undefined + + </para> + + <para> + + <emphasis role="strong">HDF5 Scilab 型属性:</emphasis> + + </para> + + <para> SCILAB_Class = undefined</para> + + <para> + + undefined 値はリストの大きさが増加し, いくつかの要素が未定義となった + + 場合に生成されます. + + これらは以下の構文で生成されます: + + </para> + + <programlisting> + + undefinedelement_ref=list(2,%i,'f',ones(3,3)); + + undefinedelement_ref(6)="toto" + + </programlisting> + + </refsection> + + <refsection> + + <title>実際の例</title> + + <para> + + これらの変数全てについてサンプルファイルがScilabディストリビューションで + + 提供されています. + + これらは,以下のディレクトリで入手可能です: + + <emphasis>SCI/modules/hdf5/tests/sample_scilab_data/</emphasis> + + </para> + + <para> + + 本文書の編集時点で, + + 以下のファイルがScilabディストリビューションで提供されています: + + </para> + + <emphasis role="italic"> + + <para> + + booleanmatrix.sod + + </para> + + <para>booleanscalar.sod + + </para> + + <para>booleansparse.sod + + </para> + + <para>emptymatrix.sod + + </para> + + <para>emptysparse.sod + + </para> + + <para>hypermatrixcomplex.sod + + </para> + + <para>hypermatrix.sod + + </para> + + <para>int16.sod + + </para> + + <para>int32.sod + + </para> + + <para>int8.sod + + </para> + + <para>listnested.sod + + </para> + + <para>list.sod + + </para> + + <para>matricedoublecomplexscalar.sod + + </para> + + <para>matricedoublecomplex.sod + + </para> + + <para>matricedoublescalar.sod + + </para> + + <para>matricedouble.sod + + </para> + + <para>matricestringscalar.sod + + </para> + + <para>matricestring.sod + + </para> + + <para>mlist.sod + + </para> + + <para>polynomialscoef.sod + + </para> + + <para>polynomials.sod + + </para> + + <para>sparsematrix.sod + + </para> + + <para>tlist.sod + + </para> + + <para>uint16.sod + + </para> + + <para>uint32.sod + + </para> + + <para>uint8.sod + + </para> + + <para>undefinedelement.sod + + </para> + + <para>voidelement.sod + + </para> + + </emphasis> + + </refsection> + + <refsection> + + <title>フォーマットの進化</title> + + <informaltable border="1"> + + <tbody> + + <tr> + + <td align="justify"> + + <emphasis role="bold">SOD バージョン</emphasis> + + </td> + + <td align="justify"> + + <emphasis role="bold">Scilab バージョン</emphasis> + + </td> + + <td align="justify"> + + <emphasis role="bold">説明</emphasis> + + </td> + + </tr> + + <tr> + + <td align="justify"> + + <para>0</para> + + </td> + + <td align="justify"> + + <para>5.2.0</para> + + </td> + + <td align="justify"> + + <para>Scilab/HDF5 形式の最初のバージョン</para> + + </td> + + </tr> + + <tr> + + <td align="justify"> + + <para>1</para> + + </td> + + <td align="justify"> + + <para>5.4.0 alpha / beta</para> + + </td> + + <td align="left"> + + <para>読込み/保存のデフォルト形式</para> + + <para>前の形式 (.bin) はまだサポートされます</para> + + </td> + + </tr> + + <tr> + + <td> + + <para>2</para> + + </td> + + <td> + + <para>5.4.0</para> + + </td> + + <td> + + <para> + + double, 整数, 多項式および文字列について, + + 多次元 HDF5 を使用するため, + + <emphasis>SCILAB_cols</emphasis> / <emphasis>SCILAB_rows</emphasis> + + が削除されました. + + </para> + + </td> + + </tr> + + <tr> + + <td align="justify"> + + + + </td> + + <td align="justify"> + + <para>6.0.0 (将来)</para> + + </td> + + <td align="justify"> + + <para>.bin サポートを廃止.</para> + + </td> + + </tr> + + </tbody> + + </informaltable> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="save">save</link> + + </member> + + <member> + + <link linkend="load">load</link> + + </member> + + <member> + + <link linkend="listvarinfile">listvarinfile</link> + + </member> + + <member> + + <link linkend="type">type</link> + + </member> + + <member> + + <link linkend="typeof">typeof</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/scanf.xml b/modules/fileio/help/ja_JP/scanf.xml new file mode 100755 index 000000000..7bbed5c21 --- /dev/null +++ b/modules/fileio/help/ja_JP/scanf.xml @@ -0,0 +1,156 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="scanf"> + + <refnamediv> + + <refname>scanf</refname> + + <refpurpose>標準入力を整形された入力に変換する</refpurpose> + + </refnamediv> + + <refsynopsisdiv> + + <title>呼び出し手順</title> + + <synopsis>[v_1, ..., v_n] = scanf(format);</synopsis> + + </refsynopsisdiv> + + <refsection> + + <title>引数</title> + + <variablelist> + + <varlistentry> + + <term>format</term> + + <listitem> + + <para>文字列: フォーマット変換を指定します.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>v_1, ..., v_n</term> + + <listitem> + + <para>変換された結果.</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + + <title>説明</title> + + <para> + + <function>scanf</function>関数は標準入力(<code>%io(1)</code>)から文字データを取得し, + + これを<varname>format</varname>に基づき解釈し,変換した結果 + + <varname>v_1</varname>, ..., <varname>v_n</varname>を返します. + + </para> + + <para> + + <varname>format</varname>パラメータには入力を解釈する際に使用される変換指定子が含まれます. + + </para> + + <para> + + <varname>format</varname>パラメータには空白文字(空白,タブ,改行,またはフォームフィード)を + + 含めることができ,以下の2つの場合を除き, + + 入力を次の非空白文字まで読み込みます.制御文字に一致しない限り, + + (改行文字を含む)後続の空白文字は読み込まれません. + + </para> + + <itemizedlist> + + <listitem> + + <para> + <literal>%</literal>(パーセント記号)以外の任意の文字は, + + 入力ストリームの次の文字に一致する必要があります. + + </para> + + </listitem> + + <listitem> + + <para>次の入力フィールドの変換を指示する変換指定子. + + 詳細は <link linkend="scanf_conversion">scanf_conversion</link> 参照. + + </para> + + </listitem> + + </itemizedlist> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="read">read</link> + + </member> + + <member> + + <link linkend="mfscanf">mfscanf</link> + + </member> + + <member> + + <link linkend="scanf_conversion">scanf_conversion</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/ja_JP/scanf_conversion.xml b/modules/fileio/help/ja_JP/scanf_conversion.xml new file mode 100755 index 000000000..f0c238900 --- /dev/null +++ b/modules/fileio/help/ja_JP/scanf_conversion.xml @@ -0,0 +1,335 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> + +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="scanf_conversion"> + + <refnamediv> + + <refname>scanf_conversion</refname> + + <refpurpose>mscanf, msscanf, mfscanf 変換指定子</refpurpose> + + </refnamediv> + + <refsection> + + <title>説明</title> + + <para> + + <varname>format</varname>パラメータの各変換指定子には以下の要素が含まれます: + + </para> + + <itemizedlist> + + <listitem> + + <para> + + <literal>%</literal>文字 (パーセント記号); + + </para> + + </listitem> + + <listitem> + + <para> + + オプションの代入抑制文字 <literal>*</literal> (アスタリスク); + + </para> + + </listitem> + + <listitem> + + <para> + + オプションの数値最大フィールド幅; + + </para> + + </listitem> + + <listitem> + + <para> + + 変換コード. + + </para> + + </listitem> + + </itemizedlist> + + <para> + + 変換指定子は以下のような構文となります: + + </para> + + <para> + + <literal>[*][width][size]convcode</literal>. + + </para> + + <para> + + 変換の結果は,代入禁止を<literal>*</literal>(アスタリスク)で指定しない限り, + + <varname>v_i</varname>引数に代入されます. + + 代入禁止により入力フィールドをスキップできるようになります. + + 入力フィールドは非空白文字の文字列です. + + 次の不適切な文字まで,またはフィールド幅が指定された場合には + + これがあふれた場合に拡張されます. + + </para> + + <para> + + 変換コードは入力フィールドの解釈の方法を指定します. + + 代入禁止されたフィールドの<varname>v_i</varname>パラメータを指定する + + 必要はありません. + + 以下の変換コードを使用することが可能です: + + </para> + + <variablelist> + + <varlistentry> + + <term>%</term> + + <listitem> + + <para> + + ここまでは1個の<literal>%</literal> (パーセント記号)入力; 代入は行われません. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>d, i</term> + + <listitem> + + <para>10進整数を取得します.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>u</term> + + <listitem> + + <para>符号なしの10進整数を取得します.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>o</term> + + <listitem> + + <para>8進整数を取得します.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>x</term> + + <listitem> + + <para>16進整数を取得します.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>e, f, g</term> + + <listitem> + + <para> + + 浮動小数点数を取得します. + + 次のフィールドは同時に変換され, + + 対応するパラメータは保存されます.これは, + + float へのポインタである必要があります. + + 浮動小数点数の入力形式は数値の文字列で,以下のオプションの文字を + + 指定できます: + + </para> + + <itemizedlist> + + <listitem> + + <para> + + 以下の符号付きの値とすることができます; + + </para> + + </listitem> + + <listitem> + + <para> + + 小数点の後に指数フィールドを指定することで, + + 指数の値とすることができます,. + + 指数フィールドは,<literal>E</literal> または <literal>e</literal> + + の後に(オプションで符号付きの)整数を続けます; + + </para> + + </listitem> + + <listitem> + + <para> + + 特殊な値 + + <constant>%inf</constant>, <constant>%nan</constant>のどちらかと + + することができます; + + </para> + + </listitem> + + </itemizedlist> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>s</term> + + <listitem> + + <para>文字列を取得します.</para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>c</term> + + <listitem> + + <para> + + 文字の値を取得します. 空白文字をまたがるスキップ処理は禁止されます. + + </para> + + </listitem> + + </varlistentry> + + <varlistentry> + + <term>%lg</term> + + <listitem> + + <para>doubleとして値を取得.</para> + + </listitem> + + </varlistentry> + + </variablelist> + + </refsection> + + <refsection role="see also"> + + <title>参照</title> + + <simplelist type="inline"> + + <member> + + <link linkend="msscanf">msscanf</link> + + </member> + + <member> + + <link linkend="mfscanf">mfscanf</link> + + </member> + + <member> + + <link linkend="mscanf">mscanf</link> + + </member> + + <member> + + <link linkend="printf_conversion">printf_conversion</link> + + </member> + + </simplelist> + + </refsection> + +</refentry> + diff --git a/modules/fileio/help/pt_BR/addchapter.sce b/modules/fileio/help/pt_BR/addchapter.sce new file mode 100755 index 000000000..c872c3bde --- /dev/null +++ b/modules/fileio/help/pt_BR/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Arquivos : funções de Entrada/Saída",SCI+"/modules/fileio/help/pt_BR",%T); + diff --git a/modules/fileio/help/pt_BR/directory/CHAPTER b/modules/fileio/help/pt_BR/directory/CHAPTER new file mode 100755 index 000000000..8f46dc5e9 --- /dev/null +++ b/modules/fileio/help/pt_BR/directory/CHAPTER @@ -0,0 +1,2 @@ +title= Directory + diff --git a/modules/fileio/help/pt_BR/directory/chdir.xml b/modules/fileio/help/pt_BR/directory/chdir.xml new file mode 100755 index 000000000..1b5f20bf8 --- /dev/null +++ b/modules/fileio/help/pt_BR/directory/chdir.xml @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="chdir" xml:lang="en"> + <refnamediv> + <refname>chdir</refname> + <refpurpose>muda o diretório corrente do Scilab</refpurpose> + </refnamediv> + <refnamediv xml:id="cd"> + <refname>cd</refname> + <refpurpose>muda o diretório corrente do Scilab</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqüência de Chamamento</title> + <synopsis>b=chdir(path) + realpath=cd(path) + cd path + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Parâmetros</title> + <variablelist> + <varlistentry> + <term>b</term> + <listitem> + <para>um booleano %t se a operação chdir estiver ok.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>path</term> + <listitem> + <para>um string</para> + </listitem> + </varlistentry> + <varlistentry> + <term>realpath</term> + <listitem> + <para>um string, o nome real do endereço após a conversão do nome do + endereço (ver abaixo) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrição</title> + <para>Muda o diretório corrente do Scilab para aquele dado por + <literal>path</literal>. Note que a conversão de endereço é realizada e. + por exemplo <literal>SCI/modules/core/macros</literal> é um padrão válido + tanto pra Unix quanto para Windows. Se path for vazio, muda para diretório + "home". + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +chdir(TMPDIR); +pwd +cd +cd SCI + ]]></programlisting> + </refsection> + <refsection> + <title>Ver Também</title> + <simplelist type="inline"> + <member> + <link linkend="pwd">pwd</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/pt_BR/fileinfo.xml b/modules/fileio/help/pt_BR/fileinfo.xml new file mode 100755 index 000000000..1aa8d1125 --- /dev/null +++ b/modules/fileio/help/pt_BR/fileinfo.xml @@ -0,0 +1,206 @@ +<?xml version="1.0" encoding="windows-1251"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="fileinfo" xml:lang="en"> + <refnamediv> + <refname>fileinfo</refname> + <refpurpose>Fornece informações sobre um arquivo</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqüência de Chamamento</title> + <synopsis>[x,ierr]=fileinfo(file)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parâmetros</title> + <variablelist> + <varlistentry> + <term>file</term> + <listitem> + <para>string, o endereço do arquivo</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x</term> + <listitem> + <para>um vetor de inteiros de tamanho 13 contendo + informações ou uma matriz vazia se o arquivo não + existir. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ierr</term> + <listitem> + <para>indicador de erro, 0, se não for encontrado nenhum + erro. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrição</title> + <para>x=fileinfo(file) retorna</para> + <variablelist> + <varlistentry> + <term>x(1)</term> + <listitem> + <para>O tamanho do arquivo</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(2)</term> + <listitem> + <para>O modo do arquivo (valor decimal)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(3)</term> + <listitem> + <para>O id do usuário</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(4)</term> + <listitem> + <para>O id do grupo</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(5)</term> + <listitem> + <para>O número do dispositivo</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(6)</term> + <listitem> + <para>A data da última modificação</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(7)</term> + <listitem> + <para>A data da última mudança</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(8)</term> + <listitem> + <para>A data do último acesso</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(9)</term> + <listitem> + <para>O tipo de dispositivo (se o dispositivo for inode)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(10)</term> + <listitem> + <para>O tamanho de bloco para a entrada/saída do sismtema de + arquivos (sempre 0 no Windows) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(11)</term> + <listitem> + <para>O número de blocos alocados (sempre 0 no Windows)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(12)</term> + <listitem> + <para>O inode</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(13)</term> + <listitem> + <para>O número de hard links.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Referência</title> + <para>Esta função é uma interface para a função C + stat. + </para> + <para>Permissões são tipicamente especificadas como números + octais : dec2oct(x(2)) para conversão. + </para> + <para>O modo numérico possui de um a quatro dígitos octais + (0-7), derivados através da soma de bits com os valores 4, 2, e 1. + Quaisquer dígitos omitidos são supostos como zeros à + esquerda. O primeiro dígito seleciona o ID de usuário (4) e + ajusta o ID do grupo (2) e atributos "sticky" (1). O segundo dígito + seleciona permissões para o usuário que possui o arquivo: + leitura (4), escrita (2), e execução (1); o terceiro dígito + seleciona permissões para os outros usuários no grupo do + arquivo, com os mesmos valores; e o quarto seleciona permissões para + outros usuários que não estão no grupo do arquivo, com os + mesmos valores. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +w = fileinfo(SCI+'/etc/scilab.start') +// permissão do arquivo +dec2oct(w(2)) +// data do arquivo +getdate(w(6)) + +// Verificando a permissão de escrita em um arquivo +w = fileinfo(SCI+'/etc/scilab.start') + +S_IWRITE = 128; // mascarando a permissão de escrita +S_IEXEC = 64; // mascarando a permissão de execução +S_IREAD = 256; // mascarando a permissão de leitura +S_IFCHR = 8192; // mascarando a permissão de diretório + +if ( bitand( w(2), S_IWRITE ) <> 0) then + disp('PERIMISSÃO DE ESCRITA neste arquivo.'); +else + disp('NÃO HÁ PERIMISSÃO DE ESCRITA neste arquivo.'); +end + ]]></programlisting> + </refsection> + <refsection> + <title>Ver Também</title> + <simplelist type="inline"> + <member> + <link linkend="getdate">getdate</link> + </member> + <member> + <link linkend="file">file</link> + </member> + <member> + <link linkend="dispfiles">dispfiles</link> + </member> + <member> + <link linkend="newest">newest</link> + </member> + <member> + <link linkend="isdir">isdir</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>Autores</title> + <para>S. Steer INRIA</para> + <para>A.C</para> + </refsection> +</refentry> diff --git a/modules/fileio/help/pt_BR/getmd5.xml b/modules/fileio/help/pt_BR/getmd5.xml new file mode 100755 index 000000000..50553c867 --- /dev/null +++ b/modules/fileio/help/pt_BR/getmd5.xml @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="getmd5" xml:lang="en"> + <refnamediv> + <refname>getmd5</refname> + <refpurpose>retorna soma de verificao md5</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>res=getmd5(filename) + res=getmd5(ParamString,'string') + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>res</term> + <listitem> + <para>resultado md5 (string)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>nome do arquivo (string ou matrizes de strings)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>ParamString</term> + <listitem> + <para>string ou matrizes de strings</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para> + <literal>getmd5(...)</literal> retorna a soma de verificao md5 de + um arquivo ou um string. + </para> + </refsection> + <refsection> + <title> Exemplos </title> + <programlisting role="example"><![CDATA[ +getmd5('ola mundo','string') +getmd5(['ola' 'mundo'],'string') +getmd5(['ola' ; 'mundo'],'string') + +getmd5( SCI+'/modules/core/etc/core.start' ) +getmd5( SCI+'/modules/core/etc/'+['core.start' 'core.quit']) + ]]></programlisting> + </refsection> +</refentry> diff --git a/modules/fileio/help/pt_BR/newest.xml b/modules/fileio/help/pt_BR/newest.xml new file mode 100755 index 000000000..f61be24fe --- /dev/null +++ b/modules/fileio/help/pt_BR/newest.xml @@ -0,0 +1,73 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="newest" xml:lang="en"> + <refnamediv> + <refname>newest</refname> + <refpurpose>retorna o arquivo mais novo de um conjunto de + arquivos + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>k=newest(paths) + k=newest(path1,path2,...,pathn) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>k</term> + <listitem> + <para>o ndice do arquivo mais novo</para> + </listitem> + </varlistentry> + <varlistentry> + <term>paths</term> + <listitem> + <para>vetor de strings, paths(i) o endereo do i-simo + arquivo + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>pathi</term> + <listitem> + <para>string, o endereo do i-simo arquivo</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para>Dado um conjunto de endereos, newest retorna o ndice do mais novo. + Arquivos no existentes so supostos como mais antigos. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +newest('SCI/modules/graphics/macros/bode.sci','SCI/modules/graphics/macros/bode.bin') +newest(['SCI/modules/graphics/macros/bode.sci','SCI/modules/graphics/macros/bode.bin']) +newest('SCI/modules/graphics/macros/bode.'+['sci','bin']) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="fileinfo">fileinfo</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/pt_BR/path_filename/CHAPTER b/modules/fileio/help/pt_BR/path_filename/CHAPTER new file mode 100755 index 000000000..7475b052d --- /dev/null +++ b/modules/fileio/help/pt_BR/path_filename/CHAPTER @@ -0,0 +1,2 @@ +title = Paths - Filenames + diff --git a/modules/fileio/help/pt_BR/path_filename/get_absolute_file_path.xml b/modules/fileio/help/pt_BR/path_filename/get_absolute_file_path.xml new file mode 100755 index 000000000..a9efb583c --- /dev/null +++ b/modules/fileio/help/pt_BR/path_filename/get_absolute_file_path.xml @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="get_absolute_file_path" xml:lang="en"> + <refnamediv> + <refname>get_absolute_file_path</refname> + <refpurpose>fornece o nome de endereço absoluto de um arquivo aberto no + Scilab + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqüência de Chamamento</title> + <synopsis>pathname = get_absolute_file_path(filename)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parâmetros</title> + <variablelist> + <varlistentry> + <term>filename</term> + <listitem> + <para>string : nome do arquivo</para> + </listitem> + </varlistentry> + <varlistentry> + <term>pathname</term> + <listitem> + <para>string : o nome de endereço absoluto</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrição</title> + <para>Fornece o nome de endereço absoluto de um arquivo já aberto no + Scilab. + </para> + <para>get_absolute_file_path procura na lista interna de arquivos abertos + correntemente do Scilab, filename e retorna seu endereço. + </para> + <para>Se o arquivo não for aberto, um erro é retornado.</para> + <para>Aviso : na versão anterior (Scilab 5.0.x) o diretório corrente era + retornado se o arquivo não fosse encontrado. + </para> + <para>Esta função pode ser utilizada para encontrar de onde (endereço) um + script Scilab é executado. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +// executando este script + +a=mopen(TMPDIR+'test.sce','wt'); +disp(get_absolute_file_path('test.sce')); +mclose(a); + ]]></programlisting> + </refsection> + <refsection> + <title>Ver Também</title> + <simplelist type="inline"> + <member> + <link linkend="getshortpathname">getshortpathname</link> + </member> + <member> + <link linkend="getlongpathname">getlongpathname</link> + </member> + <member> + <link linkend="pwd">pwd</link> + </member> + </simplelist> + </refsection> + <refsection> + <title>Autores</title> + <para>Allan CORNET</para> + </refsection> +</refentry> diff --git a/modules/fileio/help/pt_BR/path_filename/getrelativefilename.xml b/modules/fileio/help/pt_BR/path_filename/getrelativefilename.xml new file mode 100755 index 000000000..d52da7fc5 --- /dev/null +++ b/modules/fileio/help/pt_BR/path_filename/getrelativefilename.xml @@ -0,0 +1,88 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="getrelativefilename" xml:lang="en"> + <refnamediv> + <refname>getrelativefilename</refname> + <refpurpose>dado um nome de diretrio absoluto e um nome de arquivo + relativo, retorna um nome de arquivo relativo. + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Seqncia de Chamamento</title> + <synopsis>rel_file = getrelativefilename(abs_dir,abs_file)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Parmetros</title> + <variablelist> + <varlistentry> + <term>abs_dir</term> + <listitem> + <para>string : o diretrio absoluto</para> + </listitem> + </varlistentry> + <varlistentry> + <term>abs_file</term> + <listitem> + <para>string : o nome de arquivo absoluto</para> + </listitem> + </varlistentry> + <varlistentry> + <term>rel_file</term> + <listitem> + <para>string : o nome de arquivo relativo</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Descrio</title> + <para>dado um nome de diretrio absoluto e um nome de arquivo relativo, + retorna um nome de arquivo relativo. + </para> + <para>Por exemplo, se o diretrio corrente C:\scilab\bin e o nome de + arquivo C:\scilab\modules\helptools\readme.txt dado, getrelativefilename + retornar ..\modules\helptools\readme.txt. + </para> + </refsection> + <refsection> + <title>Exemplos</title> + <programlisting role="example"><![CDATA[ +if getos() == 'Windows' then + getrelativefilename('C:\program file\scilab-4.0\bin','C:\program file\scilab-4.0\modules\helptools\help.dtd') + getrelativefilename('C:\program file\scilab-4.0\bin\','C:\program file\scilab-4.0\modules\helptools\help.dtd') + getrelativefilename(SCI+'\bin',SCI+'\modules\helptools\help.dtd') + getrelativefilename(WSCI+'\bin',WSCI+'\modules\helptools\help.dtd') + getrelativefilename(pwd(),WSCI+'\bin\Wscilex') +else + getrelativefilename('/usr/local/scilab-4.0/bin','/usr/local/scilab-4.0/modules/helptools/help.dtd') + getrelativefilename('/usr/local/scilab-4.0/bin/','/usr/local/scilab-4.0/modules/helptools/help.dtd') + getrelativefilename(SCI+'/bin',SCI+'/modules/helptools/help.dtd') + getrelativefilename(pwd(),SCI+'/bin/scilex') +end + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Ver Tambm</title> + <simplelist type="inline"> + <member> + <link linkend="getshortpathname">getshortpathname</link> + </member> + <member> + <link linkend="getlongpathname">getlongpathname</link> + </member> + <member> + <link linkend="pwd">pwd</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ru_RU/addchapter.sce b/modules/fileio/help/ru_RU/addchapter.sce new file mode 100755 index 000000000..cada2dff5 --- /dev/null +++ b/modules/fileio/help/ru_RU/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Файлы: функции ввода/вывода",SCI+"/modules/fileio/help/ru_RU",%T); + diff --git a/modules/fileio/help/ru_RU/copyfile.xml b/modules/fileio/help/ru_RU/copyfile.xml new file mode 100755 index 000000000..3f21444be --- /dev/null +++ b/modules/fileio/help/ru_RU/copyfile.xml @@ -0,0 +1,95 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="copyfile" xml:lang="ru"> + <info> + <pubdate>$LastChangedDate$ + </pubdate> + </info> + <refnamediv> + <refname>copyfile</refname> + <refpurpose>копирование файла</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + copyfile(source, destination) + [status, message] = copyfile(source, destination) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>source</term> + <listitem> + <para> + символьная строка: имя файла или директории (источник). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>destination</term> + <listitem> + <para> + символьная строка: имя директории (назначение). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <code>copyfile(source, destination)</code> копирует файл или + директорию <varname>source</varname> в файл или директорию + <varname>destination</varname> (и поддиректории). + </para> + <para> + Если источник является директорией, то назначение не может быть файлом. + <warning> + <code>copyfile</code> замещает существующие файлы без предупреждения. + </warning> + </para> + <para> + <code>[status, message] = copyfile(source,destination)</code> + копирует из источника <varname>source</varname> в назначение <varname>destination</varname>, + возвращая статус <varname>status</varname> и сообщение <varname>message</varname>. + </para> + <para> + Для любой операционной системы, если копирование завершилось успешно, то + статус <varname>status</varname> равен 1, а сообщение <varname>message</varname> пустое; если же копирование завершилось неудачно, то статус <varname>status</varname> равен 0 и сообщение <varname>message</varname> не пустое. + </para> + <para> + Временная отметка у файла назначения такая же, как временная отметка исходного файла. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"> + copyfile(SCI+"/etc/scilab.start",TMPDIR+"/scilab.start") + [status,message] = copyfile(SCI+"/etc/scilab.start",TMPDIR); + </programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="movefile">movefile</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/deletefile.xml b/modules/fileio/help/ru_RU/deletefile.xml new file mode 100755 index 000000000..210d65ce4 --- /dev/null +++ b/modules/fileio/help/ru_RU/deletefile.xml @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="deletefile" xml:lang="ru"> + <refnamediv> + <refname>deletefile</refname> + <refpurpose>удаляет файл</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>f = deletefile(filename)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>filename</term> + <listitem> + <para>строка, имя файла (существующего или нет)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>f</term> + <listitem> + <para> + логическое значение: <constant>%t</constant> или <constant>%f</constant> + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Эта функция удаляет файл <varname>filename</varname>. Если файл <varname>filename</varname> удалён, то она возвращает + <constant>%t</constant>, а иначе <constant>%f</constant>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +fd = mopen(TMPDIR+'/filetodelete.txt','wt'); +mclose(fd); + +if (fileinfo(TMPDIR+'/filetodelete.txt') <> []) then +deletefile(TMPDIR+'/filetodelete.txt') +end + +deletefile(TMPDIR+'/notexistingfile') + ]]></programlisting> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/directory/CHAPTER b/modules/fileio/help/ru_RU/directory/CHAPTER new file mode 100755 index 000000000..cdae3cb74 --- /dev/null +++ b/modules/fileio/help/ru_RU/directory/CHAPTER @@ -0,0 +1,2 @@ +title= Директория + diff --git a/modules/fileio/help/ru_RU/directory/chdir.xml b/modules/fileio/help/ru_RU/directory/chdir.xml new file mode 100755 index 000000000..abdfe1d86 --- /dev/null +++ b/modules/fileio/help/ru_RU/directory/chdir.xml @@ -0,0 +1,98 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="chdir"> + <info> + <pubdate>$LastChangedDate$</pubdate> + </info> + <refnamediv> + <refname>chdir</refname> + <refpurpose>меняет текущую директорию Scilab'а</refpurpose> + </refnamediv> + <refnamediv xml:id="cd"> + <refname>cd</refname> + <refpurpose>меняет текущую директорию Scilab'а</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>b=chdir(path) + realpath=cd(path) + cd path + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>b</term> + <listitem> + <para> + логическое значение: <constant>%t</constant>, если работа <function>chdir</function> завершилась успешно + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>path</term> + <listitem> + <para>символьная строка: путь</para> + </listitem> + </varlistentry> + <varlistentry> + <term>realpath</term> + <listitem> + <para> + символьная строка: настоящее название пути после преобразования + имени пути (см. ниже) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Изменение текущей директории Scilab'а на ту, которая указана в + <varname>path</varname>. Обратите внимание, что выполняется преобразование + пути и, например, <literal>SCI/modules/core/macros</literal> является + корректным как для Unix, так и для Windows. Если путь <varname>path</varname> не указан (пуст), + то производится смена на "домашнюю" директорию. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +chdir(TMPDIR); +pwd +cd +cd SCI + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="pwd">pwd</link> + </member> + <member> + <link linkend="SCI">SCI</link> + </member> + <member> + <link linkend="SCIHOME">SCIHOME</link> + </member> + <member> + <link linkend="TMPDIR">TMPDIR</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/directory/createdir.xml b/modules/fileio/help/ru_RU/directory/createdir.xml new file mode 100755 index 000000000..f80801a56 --- /dev/null +++ b/modules/fileio/help/ru_RU/directory/createdir.xml @@ -0,0 +1,80 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="createdir"> + <info> + <pubdate>$LastChangedDate$</pubdate> + </info> + <refnamediv> + <refname>createdir</refname> + <refpurpose>создаёт новую директорию</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + createdir(dirname) + status = createdir(dirname) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>dirname</term> + <listitem> + <para>символьная строка: имя директории.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>status</term> + <listitem> + <para>логическое значение: статус.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <code>createdir(dirname)</code> создаёт директорию + <varname>dirname</varname> в текущей директории. Если + <varname>dirname</varname> находится не в текущей директории, то + определите относительный путь к текущей директории, либо + полный путь для <varname>dirname</varname>. + </para> + <para> + <code>[status] = createdir(dirname)</code> создаёт директорию <varname>dirname</varname> в существующей директории, возвращая статус <varname>status</varname>. Здесь <varname>status</varname> равен <constant>%T</constant> в случае успеха, иначе <constant>%F</constant>. + </para> + <para> + <function>createdir</function> используется <function>mkdir</function>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +createdir(TMPDIR+'/Directory_test') +removedir(TMPDIR+'/Directory_test') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="mkdir">mkdir</link> + </member> + <member> + <link linkend="rmdir">rmdir</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/directory/dir.xml b/modules/fileio/help/ru_RU/directory/dir.xml new file mode 100755 index 000000000..0e6791b97 --- /dev/null +++ b/modules/fileio/help/ru_RU/directory/dir.xml @@ -0,0 +1,122 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="dir"> + <refnamediv> + <refname>dir</refname> + <refpurpose>получает список файлов</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>dir path + S=dir([path]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para> + строковая матрица, указывающая путь до директории (обычно + заканчивающаяся маской <literal>*</literal>). Значение по + умолчанию <literal>.</literal> (точка). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>S</term> + <listitem> + <para> + типизированный список <literal>tlist</literal> типа + <literal>dir</literal> с полями: + <literal>name</literal>, <literal>date</literal>, <literal>bytes</literal> и <literal>isdir</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <function>dir</function> может использоваться для получения + файлов, которые соответствуют шаблонам, указанным аргументом + <varname>path</varname>. Шаблоны указываются для команды Unix + <command>ls</command> либо для команды Windows + <command>dir</command> для того, чтобы получить информацию о + файлах. Таким образом, чтобы написать переносимый Scilab-сценарий, + требуется указать шаблоны для обеих ОС. Заметьте, что + выполняется преобразование имени пути, например, + <literal>SCI/modules/core/macros/*.sci</literal> является + корректным шаблоном как для Unix, так и для Windows. + </para> + <para> + Поле <literal>name</literal> возвращаемой переменной является + вектор-столбцом имён файлов. + </para> + <para> + Поле <literal>date</literal> возвращаемой переменной является вектор-столбцом + целых чисел, содержащих дату последней модификации, кодированную + в секундах от 1 Янв 1970. + </para> + <para> + Поле <literal>bytes</literal> возвращаемой переменной является вектор-столбцом + целых чисел, содержащих размер файлов в байтах. + </para> + <para> + Поле <literal>isdir</literal> возвращаемой переменной является вектор-столбцом + логического значения ИСТИНА, если соответствующее имя расположено в директории. + </para> + <para> + Возвращаемая структура по умолчанию отображается в виде списка файлов, + форматированного в виде столбца. Это можно изменить, + переопределив функцию <function>%dir_p</function>. + </para> + <para> + Начиная с Scilab 5.3.1, завершение "/" или "\" (см. <link + linkend="filesep">filesep</link>) отображается для каждой директории. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +dir +dir SCI/modules/core/macros/*.bin +x=dir('SCI/modules/core/macros/*.bin') +dt=getdate(x.date); +mprintf("%s: %04d-%02d-%02d %02d:%02d:%02d\n",x.name,dt(:,[1 2 6 7:9])) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="listfiles">listfiles</link> + </member> + <member> + <link linkend="findfiles">findfiles</link> + </member> + <member> + <link linkend="ls">ls</link> + </member> + <member> + <link linkend="fileinfo">fileinfo</link> + </member> + <member> + <link linkend="date">date</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/directory/isdir.xml b/modules/fileio/help/ru_RU/directory/isdir.xml new file mode 100755 index 000000000..6dfdbceef --- /dev/null +++ b/modules/fileio/help/ru_RU/directory/isdir.xml @@ -0,0 +1,75 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Serge STEER + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="isdir"> + <refnamediv> + <refname>isdir</refname> + <refpurpose>проверяет является ли аргумент путём до директории</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>r=isdir(path)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para>символьная строка или матрица строк: имя пути до директории</para> + </listitem> + </varlistentry> + <varlistentry> + <term>r</term> + <listitem> + <para> + логическое значение: <constant>%t</constant>, если <varname>path</varname> является путём до директории. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <code>r = isdir(path)</code> проверяет является ли путь <varname>path</varname> путём до директории. + </para> + </refsection> + <refsection> + <title>Сcылка</title> + <para> + Эта функция основана на C-функции <function>stat</function>. Можно + использовать краткие обозначения <literal>SCI</literal> и + <literal>~</literal> для директории Scilab'а и домашней директории. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +isdir(TMPDIR) +isdir SCI/etc/scilab.start + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="isfile">isfile</link> + </member> + <member> + <link linkend="fileinfo">fileinfo</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/directory/ls.xml b/modules/fileio/help/ru_RU/directory/ls.xml new file mode 100755 index 000000000..03f8de61e --- /dev/null +++ b/modules/fileio/help/ru_RU/directory/ls.xml @@ -0,0 +1,103 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="ls"> + <refnamediv> + <refname>ls</refname> + <refpurpose>показывает файлы</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + files = ls [path] + files = ls( [path] ) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para> + матрица строк, указывающая путь к директории (обычно + заканчивающаяся шаблоном, содержащим <literal>*</literal>). Значение по умолчанию <literal>.</literal> (точка). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>files</term> + <listitem> + <para> + вектор-столбец строковых значений. По умолчанию он содержит вывод, отформатированный в столбец. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>ls</function> может быть использована для + составления списка файлов, которые соответствуют шаблонам, + заданным аргументом <varname>path</varname>. Шаблоны указываются + Unix-команде <command>ls</command> или Windows-команде + <command>dir</command> для получения информации о файлах. Таким + образом, чтобы написать переносимый Scilab-сценарий, необходимо + указать допустимые символы замещения в шаблонах для обоих ОС. + Заметьте, что выполняется преобразование имени пути, и, например, + <literal>SCI/modules/core/macros/*.sci</literal> является + допустимым шаблоном как для Unix, так и для Windows. + </para> + <para> + Если вы хотите получить вектор всех файлов, соответствующих + шаблону, то лучше использовать функцию <link linkend="listfiles">listfiles</link> + или функцию <link linkend="dir">dir</link>. + </para> + <para> + <note> + Пожалуйста, заметьте, что, начиная с версии 5.0 Scilab'а, + второй входной аргумент удалён (последовательность строк, + которую можно добавить в Unix-системах: опции Unix-команды + <command>ls</command>). Эта опция была удалена, главным + образом, по причинам безопасности и переносимости. + </note> + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +ls +ls SCI/modules/core/macros/*.sci +x=ls('SCI/modules/core/macros/*.sci') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="listfiles">listfiles</link> + </member> + <member> + <link linkend="findfiles">findfiles</link> + </member> + <member> + <link linkend="dir">dir</link> + </member> + <member> + <link linkend="fileinfo">fileinfo</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/directory/mkdir.xml b/modules/fileio/help/ru_RU/directory/mkdir.xml new file mode 100755 index 000000000..54c76ce0e --- /dev/null +++ b/modules/fileio/help/ru_RU/directory/mkdir.xml @@ -0,0 +1,176 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mkdir" xml:lang="ru"> + <refnamediv> + <refname>mkdir</refname> + <refpurpose>создаёт новую директорию</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + mkdir(dirname) + mkdir(parentdir, dirname) + status = mkdir( ... ) + [status, msg] = mkdir( ... ) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>dirname</term> + <listitem> + <para> + символьная строка: имя директории, которую требуется создать. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>parentdir</term> + <listitem> + <para> + символьная строка: имя директории в которой будет создана новая + директория <varname>dirname</varname>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>status</term> + <listitem> + <para> + целое число: статус работы. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>msg</term> + <listitem> + <para> + символьная строка: сообщение об ошибке. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Инструкция <code>mkdir(dirname)</code> создаёт директорию + <varname>dirname</varname> в текущей директории, если + <varname>dirname</varname> представляет относительный путь. + Иначе, <varname>dirname</varname> представляет абсолютный путь и + функция <function>mkdir</function> пытается создать директорию с + абсолютным именем <varname>dirname</varname>. + </para> + <para> + Инструкция <code>mkdir(parentdir, dirname)</code> создаёт + директорию <varname>dirname</varname> в директории + <varname>parentdir</varname> (если <varname>parentdir</varname> + не существует, то она будет создана), где + <varname>parentdir</varname> -- абсолютное или относительное имя. + </para> + <para> + Инструкция <code>[status,msg] = mkdir(parentdir, dirname)</code> + создаёт директорию <varname>dirname</varname> в существующей + директории <varname>parentdir</varname>, возвращая статус работы + <varname>status</varname> и сообщение об ошибке + <varname>msg</varname>. + </para> + <para> + <informaltable border="1"> + <tr> + <td> + <varname>status</varname> + </td> + <td> + <varname>msg</varname> + </td> + </tr> + <tr> + <td> + -2 + </td> + <td> + mkdir: Произошла ошибка: Файл с таким именем уже существует в dirname + + </td> + </tr> + <tr> + <td> + 0 + </td> + <td> + mkdir: Произошла ошибка: Невозможно создать каталог dirname + + </td> + </tr> + <tr> + <td> + 1 + </td> + + <td> + + </td> + </tr> + <tr> + <td> + 2 + </td> + <td> + mkdir: Произошла ошибка: Этот каталог уже существует в dirname + + </td> + </tr> + </informaltable> + </para> + <para> + В любой операционной системе, если создание директории удалось, то статус <varname>status</varname> равен 1, а сообщение <varname>msg</varname> пустое. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"> + <![CDATA[ +// Абсолютное имя пути +mkdir(TMPDIR+"/mkdir_example_1") +status_2 = mkdir(TMPDIR+"/mkdir_example_2") +[status_3,msg_3] = mkdir(TMPDIR+"/mkdir_example_3") + +// Абсолютное имя пути (parentdir + dirname) +[status_4,msg_4] = mkdir(TMPDIR,"mkdir_example_4") + +// Относительное имя пути +cd TMPDIR; +[status_5,msg_5] = mkdir("mkdir_example_5") +[status_6,msg_6] = mkdir("mkdir_example_5/mkdir_example_6") + ]]> + </programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="chdir">chdir</link> + </member> + <member> + <link linkend="dir">dir</link> + </member> + <member> + <link linkend="rmdir">rmdir</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/directory/pwd.xml b/modules/fileio/help/ru_RU/directory/pwd.xml new file mode 100755 index 000000000..25e3eaeea --- /dev/null +++ b/modules/fileio/help/ru_RU/directory/pwd.xml @@ -0,0 +1,36 @@ +<?xml version="1.0" encoding="UTF-8"?> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="pwd"> + <refnamediv> + <refname>pwd</refname> + <refpurpose>получает текущую директорию Scilab'а</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>pwd + x = pwd() + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Описание</title> + <para> + <code>pwd</code> возвращает в <varname>ans</varname> текущую директорию Scilab'а. + <code>x = pwd()</code> возвращает в <varname>x</varname> текущую директорию Scilab'а. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +pwd +x=pwd() + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="chdir">chdir</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/directory/removedir.xml b/modules/fileio/help/ru_RU/directory/removedir.xml new file mode 100755 index 000000000..969b3700c --- /dev/null +++ b/modules/fileio/help/ru_RU/directory/removedir.xml @@ -0,0 +1,86 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="removedir"> + <refnamediv> + <refname>removedir</refname> + <refpurpose>удаляет директорию</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + removedir(dirname) + [status] = removedir(dirname) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>dirname</term> + <listitem> + <para>символьная строка: имя директории, которую нужно удалить.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>status</term> + <listitem> + <para>логическое значение: статус.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <code>removedir(dirname)</code> удаляет директорию + <varname>dirname</varname> из текущей директории. Если директория не + пуста, то файлы и поддиректории удаляются. Если + <varname>dirname</varname> не является текущей директорией, то укажите + относительный путь к текущей директории или абсолютный путь для + <varname>dirname</varname>. + </para> + <para> + <code>[status] = removedir(dirname)</code> удаляет директорию + <varname>dirname</varname> и всё её содержимое, возвращая статус + <varname>status</varname>. Здесь <varname>status</varname> равен + <constant>%T</constant> в случае успеха и <constant>%F</constant> в + случае ошибки. + </para> + <para> + Функция <function>removedir</function> используется в <function>rmdir</function>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +createdir(SCIHOME+'/Directory_test') +removedir(SCIHOME+'/Directory_test') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="createdir">createdir</link> + </member> + <member> + <link linkend="mkdir">mkdir</link> + </member> + <member> + <link linkend="rmdir">rmdir</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/directory/rmdir.xml b/modules/fileio/help/ru_RU/directory/rmdir.xml new file mode 100755 index 000000000..ae022f7be --- /dev/null +++ b/modules/fileio/help/ru_RU/directory/rmdir.xml @@ -0,0 +1,102 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="rmdir"> + <refnamediv> + <refname>rmdir</refname> + <refpurpose>удаляет директорию</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + rmdir(dirname) + rmdir(dirname,'s') + [status, message] = rmdir(dirname,'s') + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>dirname</term> + <listitem> + <para>символьная строка: имя директории.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>'s'</term> + <listitem> + <para> + признак удаления директории <varname>dirname</varname> с поддиректориями. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>status</term> + <listitem> + <para>логическое значение: статус.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>message</term> + <listitem> + <para> + символьная строка: сообщение об ошибке. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <code>rmdir(dirname)</code> удаляет директорию + <varname>dirname</varname> из текущей директории. Если директория не + пуста, вы должны использовать аргумент <constant>'s'</constant>. Если + <varname>dirname</varname> нет в текущей директории, то укажите + относительный путь до текущей директории или полный путь для + <varname>dirname</varname>. + </para> + <para> + <code>rmdir(dirname,'s')</code> удаляет директорию <varname>dirname</varname> и всё её содержимое из текущей директории. + </para> + <para> + <code>[status, message] = rmdir(dirname,'s')</code> удаляет директорию <varname>dirname</varname> и всё её содержимое из текущей директории, возвращая статус <varname>status</varname> и сообщение <varname>message</varname>. Здесь <varname>status</varname> равен 1 в случае успеха и равен 0 в случае ошибки. + </para> + <para> + В любой операционной системе, если создание директории удалось, то статус <varname>status</varname> равен 1, а сообщение <varname>message</varname> пустое. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +mkdir(SCI,'Directory') +rmdir(SCI+'/Directory') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="createdir">createdir</link> + </member> + <member> + <link linkend="mkdir">mkdir</link> + </member> + <member> + <link linkend="removedir">removedir</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/dispfiles.xml b/modules/fileio/help/ru_RU/dispfiles.xml new file mode 100755 index 000000000..e66b80162 --- /dev/null +++ b/modules/fileio/help/ru_RU/dispfiles.xml @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Serge STEER + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="dispfiles"> + <refnamediv> + <refname>dispfiles</refname> + <refpurpose>выводит на экран свойства открытых файлов</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>dispfiles([units])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>units</term> + <listitem> + <para> + вектор целых чисел: номера логических блоков. По умолчанию + все открытые файлы. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>dispfiles</function> выводит на экран свойства файлов, + открытых на данный момент. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +dispfiles() + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="file">file</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/fileinfo.xml b/modules/fileio/help/ru_RU/fileinfo.xml new file mode 100755 index 000000000..2a1cdd288 --- /dev/null +++ b/modules/fileio/help/ru_RU/fileinfo.xml @@ -0,0 +1,229 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="fileinfo" xml:lang="ru"> + <refnamediv> + <refname>fileinfo</refname> + <refpurpose>предоставляет информацию о файле</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>[x,ierr] = fileinfo(files)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>files</term> + <listitem> + <para> + символьная строка или вектор-столбец строк, имя файла и + путь до него + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>x</term> + <listitem> + <para> + вектор целых чисел размером 13 элементов, содержащий + информацию, либо пустую матрицу, если файла не существует. + </para> + <para> + Если <varname>files</varname> является вектор-столбцом + строк, то <varname>x</varname> будет матрицей размером + <literal>m x 13</literal>. + </para> + <para> + Если файла с указанным именем не существует, то в качестве + выходной информации будет возвращена строка из 13 элементов и в каждом элементе <constant>Nan</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ierr</term> + <listitem> + <para> + указатель ошибки, 0, если ошибки не произошло. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <code>x = fileinfo(file)</code> возвращает: + </para> + <variablelist> + <varlistentry> + <term>x(1)</term> + <listitem> + <para>Размер файла</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(2)</term> + <listitem> + <para>Режимный код файла (десятичное значение)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(3)</term> + <listitem> + <para>Идентификатор пользователя</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(4)</term> + <listitem> + <para>Идентификатор группы</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(5)</term> + <listitem> + <para>Номер устройства</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(6)</term> + <listitem> + <para>Дата последнего изменения данных</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(7)</term> + <listitem> + <para>Дата последнего изменения статуса файла</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(8)</term> + <listitem> + <para>Дата последнего доступа</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(9)</term> + <listitem> + <para>Тип устройства (если инодное устройство)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(10)</term> + <listitem> + <para> + Размер блока для ввода/вывода файловой системы (в Windows всегда 0) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(11)</term> + <listitem> + <para>Количество распределённых блоков (в Windows всегда 0)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(12)</term> + <listitem> + <para>Индексный дескриптор</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x(13)</term> + <listitem> + <para>Количество жёстких ссылок</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Ссылки</title> + <para> + Эта функция является интерфейсом к C-функции <function>stat</function>. + </para> + <para> + Права обычно определяются в виде восьмеричных чисел: используйте + для преобразования <code>dec2oct(x(2))</code>. + </para> + <para> + Числовой режим представляет собой от одной до четырёх восьмеричных цифр + (0-7), полученных добавлением битов со значениями 4, 2 и + 1. Любые опущенные цифры предполагаются предварёнными + нулями. Первая цифра выбирает набор атрибутов идентификатора пользователя + (4), группы пользователя (2) и sticky-бита (1). Вторая цифра + выбирает права пользователя, который владеет файлом: чтение (4), + запись (2) и исполнение (1); третье число выбирает права для + других пользователей в группе файлов с теми же самыми значениями. + </para> + <para> + So, to check permissions, it is necessary to use masks. Let us take an example: + In octal, x(2)=1664, so first digit corresponds to sticky attributes. The second + indicates that file owner has permission of writing and reading. It is the same + for other users in the file's group. Finally, others users has just right to read. + To apply a mask, it is simpler to look at this octal in binary. + So: <varname>x</varname>(2)= 1 110 110 100. + To check if the owner has write permission, we must take a look at the second triplet: 110 + and compare it with write permission 010. So, the operation is: 110 000 000 & 010 000 000. + If result is not null (it is the case here), owner has write permission. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +w = fileinfo(SCI+'/etc/scilab.start') +// права на файл +dec2oct(w(2)) +// дата файла +getdate(w(6)) + +// Проверка прав на запись +w = fileinfo(SCI+'/etc/scilab.start') + +S_IWRITE = 128; // маска прав на запись +S_IEXEC = 64; // маска прав на исполнение +S_IREAD = 256; // маска прав на чтение +S_IFCHR = 8192; // маска прав директории + +if ( bitand( w(2), S_IWRITE ) <> 0) then + disp('Для этого файла есть ПРАВО НА ЗАПИСЬ.'); +else + disp('Для этого файла НЕТ ПРАВА НА ЗАПИСЬ.'); +end + +FILES = [SCI;SCIHOME;'несуществующий_файл';TMPDIR] +[X,ERRS] = fileinfo(FILES) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="getdate">getdate</link> + </member> + <member> + <link linkend="file">file</link> + </member> + <member> + <link linkend="dispfiles">dispfiles</link> + </member> + <member> + <link linkend="newest">newest</link> + </member> + <member> + <link linkend="isdir">isdir</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/findfiles.xml b/modules/fileio/help/ru_RU/findfiles.xml new file mode 100755 index 000000000..55961cfac --- /dev/null +++ b/modules/fileio/help/ru_RU/findfiles.xml @@ -0,0 +1,78 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="findfiles"> + <refnamediv> + <refname>findfiles</refname> + <refpurpose> + поиск всех файлов с указанным уточнением файла + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>f = findfiles() + f = findfiles(path) + f = findfiles(path,filespec) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para>символьная строка, путь.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filespec</term> + <listitem> + <para> + символьная строка, уточнение файла, например, + <literal>"*.sce"</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>f</term> + <listitem> + <para>вектор-столбец строк, имена файлов.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Поиск всех файлов с указанным уточнением файла + <varname>filespec</varname>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +f=findfiles() +f=findfiles(SCI) +f=findfiles(SCI+'/modules/core/macros','*.sci') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="listfiles">listfiles</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/fprintfMat.xml b/modules/fileio/help/ru_RU/fprintfMat.xml new file mode 100755 index 000000000..3f2e44dd9 --- /dev/null +++ b/modules/fileio/help/ru_RU/fprintfMat.xml @@ -0,0 +1,150 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * Copyright (C) 2010 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="fprintfMat" xml:lang="ru"> + <refnamediv> + <refname>fprintfMat</refname> + <refpurpose>записывает матрицу в файл</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>fprintfMat(file, M [,format, text])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>file</term> + <listitem> + <para>строка, путь к файлу, который нужно записать</para> + </listitem> + </varlistentry> + <varlistentry> + <term>M</term> + <listitem> + <para>матрица вещественных чисел</para> + </listitem> + </varlistentry> + <varlistentry> + <term>format</term> + <listitem> + <para> + символьная строка, задающая формат. Это необязательный + параметр, значение по умолчанию <literal>"%lf"</literal>. + </para> + <para> + Поддерживаемый формат: + <literal>%[width].[precision]type</literal> или + <literal>%type</literal>, где: + </para> + <para> + <literal>width</literal>: необязательное число, которое + определяет минимальное количество символов на выходе; + </para> + <para> + <literal>precision</literal>: необязательное число, + которое определяет максимальное количество символов, + напечатанных для всего или части выходного поля, или + минимальное количество цифр, печатаемых для целых значений; + </para> + <para> + <literal>type</literal>: lf, lg, d, i, e, f, g (см. <link + linkend="scanf_conversion">scanf_conversion</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>text</term> + <listitem> + <para> + вектор-строка или вектор-столбец строк, указывающий + нечисловые комментарии в начале файла. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>fprintfMat</function> записывает матрицу в + форматированном файле. Каждая строка матрицы даёт строчку в + файле. Если указан <varname>text</varname>, то его элементы + вносятся (поэлементно) в начало файла, один элемент на строку. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +n = 50; +a = rand(n, n, "u"); +fprintfMat(TMPDIR + "/Mat", a, "%5.2f"); +a1 = fscanfMat(TMPDIR + "/Mat"); + +// Создадим файл Mat1 и внесём в него комментарий +some_comment = ["Это комментарий.","Это вторая строчка комментария.","Это третья строчка комментария."]; +fprintfMat(TMPDIR + "/Mat1", a, "%5.2f",some_comment); + ]]> </programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="scanf_conversion">scanf_conversion</link> + </member> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/fscanfMat.xml b/modules/fileio/help/ru_RU/fscanfMat.xml new file mode 100755 index 000000000..9284d5458 --- /dev/null +++ b/modules/fileio/help/ru_RU/fscanfMat.xml @@ -0,0 +1,188 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * Copyright (C) 2010 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="fscanfMat" xml:lang="ru"> + <refnamediv> + <refname>fscanfMat</refname> + <refpurpose>считывает матрицу из текстового файла</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>M = fscanfMat(filename[, fmt]); + [M, text] = fscanfMat(filename [, fmt]); + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>filename</term> + <listitem> + <para> + символьная строка, указывающая имя файла, который + необходимо просканировать. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>fmt</term> + <listitem> + <para> + символьная строка, указывающая формат. Это необязательный + параметр. Значение по умолчанию <literal>"%lg"</literal>. + </para> + <para> + Поддерживаемый формат: + <literal>%[width].[precision]type</literal> или + <literal>%type</literal>, где: + </para> + <para> + <literal>width</literal>: необязательное число, которое + определяет минимальное количество знаков на выходе; + </para> + <para> + <literal>precision</literal>: необязательное число, + которое определяет максимальное количество знаков, + выводимых для всех или части выходных полей, или + минимальное количество цифр, выводимых для целочисленных значений. + </para> + <para> + <literal>type</literal>: lf, lg, d, i, e, f, g (см. <link + linkend="scanf_conversion">scanf_conversion</link>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>M</term> + <listitem> + <para> + выходная переменная. Матрица вещественных чисел. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>text</term> + <listitem> + <para> + выходная переменная. Вектор-столбец строк. Это комментарии + в начале файла с именем <varname>filename</varname>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>fscanfMat</function> используется для считывания + вещественной матрицы из текстового файла с именем + <varname>filename</varname>. Первые нечисловые строчки файла + возвращаются в переменной <varname>text</varname>, если это + запрошено, а все оставшиеся строчки должны иметь одинаковое + количество столбцов (разделителем столбцов могут быть либо + пробелы либо символы табуляции, если же есть и те и другие, + то, по умолчанию, будут выбраны пробелы). Количество столбцов матрицы должно + соответствовать количеству столбцов, обнаруженных в файле + <varname>filename</varname>, а количество строк получается при + обнаружении конца файла (EOF) во входном файле. Эта функция + может быть использована для чтения числовых данных, сохранённых + с помощью функции <function>fprintfMat</function> (по умолчанию в + качестве разделителя используется пробел). + </para> + <para> + <function>fscanfMat</function> поддерживает файлы с кодировкой ANSI/ASCII и UTF-8. + </para> + <para> + Для чтения CSV-файлов, рекомендуется функция <link linkend="csvRead">csvRead</link>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"> + fd = mopen(TMPDIR + "/Mat", "w"); + mfprintf(fd, "Какой-то текст.....\n"); + mfprintf(fd, "Ещё какой-то текст...\n"); + a = rand(6,6); + for i = 1:6 , + for j = 1:6, mfprintf(fd, "%5.2f ", a(i,j));end; + mfprintf(fd, "\n"); + end + mclose(fd); + a1 = fscanfMat(TMPDIR + "/Mat") + + A = ones(5,5) + 0.1; + fprintfMat(TMPDIR + "/Matrix.txt", A, "%lg"); + B = fscanfMat(TMPDIR + "/Matrix.txt", "%lg"); + A == B + + C = [%nan, %inf, -%inf, 1]; + fprintfMat(TMPDIR + "/MatrixNANINF.txt", C); + D = fscanfMat(TMPDIR + '/MatrixNANINF.txt') + + </programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="scanf_conversion">scanf_conversion</link> + </member> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + <member> + <link linkend="csvRead">csvRead</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/getmd5.xml b/modules/fileio/help/ru_RU/getmd5.xml new file mode 100755 index 000000000..94aba13b0 --- /dev/null +++ b/modules/fileio/help/ru_RU/getmd5.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="getmd5"> + <refnamediv> + <refname>getmd5</refname> + <refpurpose>получение контрольной суммы md5</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + res=getmd5(filename) + res=getmd5(ParamString,'string') + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>res</term> + <listitem> + <para>результат, контрольная сумма md5 (строка)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>filename</term> + <listitem> + <para>имя файла (строка или матрица строк)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>ParamString</term> + <listitem> + <para>строка или матрица строк</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>getmd5</function> получает контрольную сумму md5 файла <varname>filename</varname> или строки <varname>ParamString</varname>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +getmd5('Привет, мир!','string') +getmd5(['Привет,' 'мир!'],'string') +getmd5(['Привет,' ; 'мир!'],'string') + +getmd5( SCI+'/modules/core/etc/core.start' ) +getmd5( SCI+'/modules/core/etc/'+['core.start' 'core.quit']) + ]]></programlisting> + </refsection> +</refentry> diff --git a/modules/fileio/help/ru_RU/io.xml b/modules/fileio/help/ru_RU/io.xml new file mode 100755 index 000000000..d4495205b --- /dev/null +++ b/modules/fileio/help/ru_RU/io.xml @@ -0,0 +1,67 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2009 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="percentio" xml:lang="ru"> + <refnamediv> + <refname>%io</refname> + <refpurpose> + переменная, которая хранит стандартный ввод и стандартный вывод + (дескриптор файла) + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>%io(1) + %io(2) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Описание</title> + <para> + <function>%io(1)</function> возвращает стандартное устройство ввода (дескриптор файла 5). + </para> + <para> + <function>%io(2)</function> возвращает стандартное устройство вывода (дескриптор файла 6). + </para> + <para> + Дескриптор файла 0 является стандартным устройством вывода сообщений об ошибке. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +mfprintf(%io(2),'Scilab stdout (C)'); +mfprintf(0,'Scilab stderr (C)'); +write(%io(2),'Scilab stdout (Fortran)'); +write(0,'Scilab stderr (Fortran)'); +[units,typ,names]=file() + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="write">write</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="file">file</link> + </member> + <member> + <link linkend="dispfiles">dispfiles</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/isfile.xml b/modules/fileio/help/ru_RU/isfile.xml new file mode 100755 index 000000000..ed46cb0e0 --- /dev/null +++ b/modules/fileio/help/ru_RU/isfile.xml @@ -0,0 +1,74 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2009 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="isfile" xml:lang="ru"> + <refnamediv> + <refname>isfile</refname> + <refpurpose> + проверяет является ли аргумент существующим файлом + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>x = isfile(filenames)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>filenames</term> + <listitem> + <para>символьная строка или матрица строк: имена файлов.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x</term> + <listitem> + <para> + матрица логических значений (<constant>%t</constant>, если имена в <varname>filenames</varname> являются именами существующих файлов). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <code>x = isfile(filenames)</code> проверяет являются ли имена в + <varname>filenames</varname> именами существующих файлов или нет + (директория не является файлом). См. также <link linkend="isdir">isdir</link>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"> + filenames = ls(SCI) + + x = isfile(filenames) + + isfile(SCI + '/etc') + isdir(SCI + '/etc') + </programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="fileinfo">fileinfo</link> + </member> + <member> + <link linkend="isdir">isdir</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/listfiles.xml b/modules/fileio/help/ru_RU/listfiles.xml new file mode 100755 index 000000000..5c087bb3e --- /dev/null +++ b/modules/fileio/help/ru_RU/listfiles.xml @@ -0,0 +1,115 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="listfiles"> + <refnamediv> + <refname>listfiles</refname> + <refpurpose>список файлов</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>files = listfiles(paths [,flag,flagexpand])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>paths</term> + <listitem> + <para> + матрица строк, указывающая набор имён путей (обычно + оканчивающихся шаблоном, построенным с <literal>*</literal>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>flag, flagexpand</term> + <listitem> + <para> + логические необязательные параметры (значение по умолчанию равно + <constant>%t</constant>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>files</term> + <listitem> + <para>матрица строк.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>listfiles</function> может быть использована для + составления списка файлов, которые соответствуют шаблонам, указанным + одним из элементов путей. Шаблоны указываются Unix-команде + <command>ls</command> или Windows-команде <command>dir</command> для + получения информации о файлах. Таким образом, чтобы написать переносимый + Scilab-сценарий, следует указывать корректные знаки шаблонов для обеих + ОС. Заметьте, что выполняется преобразование имени пути и, например, + <literal>SCI/core/macros/*.sci</literal> является корректным шаблоном + как для Unix, так и для Windows. + </para> + <para> + Если <varname>flag</varname> равен ИСТИНЕ, то имена пути, указанные с + помощью <varname>paths</varname>, преобразуются в соответствии со + значением <code>getos() == 'Windows'</code> (см. также <link linkend="pathconvert">pathconvert</link>). + Более того, если <varname>flagexpand</varname> равен ИСТИНЕ, то + начальные строки, такие как <literal>SCIHOME</literal>, + <literal>SCI</literal> или <literal>~</literal> расширяются с помощью + переменных окружения. + </para> + <para> + Если входной путь является именем директории, то возвращаемые имена + файлов <varname>files</varname> относятся к этой директории. + </para> + <para> + Если входные пути содержат шаблон (например <literal>"/*"</literal>, <literal>"*.c"</literal>), то к возвращаемым именам файлов <varname>files</varname> добавляется начало входного пути. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"> + <![CDATA[ +files=listfiles(['SCI/modules/core/macros/*.sci';'SCI/modules/core/macros/*.bin']); + ]]> + </programlisting> + </refsection> + <refsection> + <title>История</title> + <revhistory> + <revision> + <revnumber>5.4.0</revnumber> + <revremark> + Если пути не являются одиночной строкой, то все возвращаемые файлы представляются единообразно в форме абсолютного пути. + </revremark> + </revision> + </revhistory> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="findfiles">findfiles</link> + </member> + <member> + <link linkend="basename">basename</link> + </member> + <member> + <link linkend="pathconvert">pathconvert</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/listvarinfile.xml b/modules/fileio/help/ru_RU/listvarinfile.xml new file mode 100755 index 000000000..0b345edeb --- /dev/null +++ b/modules/fileio/help/ru_RU/listvarinfile.xml @@ -0,0 +1,105 @@ +<?xml version="1.0" encoding="UTF-8"?> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="listvarinfile"> + <refnamediv> + <refname>listvarinfile</refname> + <refpurpose>список переменных в файле сохранённых данных</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>listvarinfile(filename) + [names, typs, dims, vols] = listvarinfile(filename) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>filename</term> + <listitem> + <para> + символьная строка, имя файла (и путь), который следует + проинспектировать. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>nams</term> + <listitem> + <para> + матрица строк, имена переменных, сохранённых в файле <varname>filename</varname>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>dims</term> + <listitem> + <para> + список, размерности переменных, сохранённых в файле + <varname>filename</varname>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>typs</term> + <listitem> + <para> + числовая матрица, типы переменных, сохранённых в файле + <varname>filename</varname>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>vols</term> + <listitem> + <para> + числовая матрица, размер (в байтах) переменных, сохранённых в файле <varname>filename</varname>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Эта служебная функция составляет список переменных (наподобие <link linkend="whos">whos</link>), + содержащихся в файле данных Scilab'а, полученного с помощью <link linkend="save">save</link>. + </para> + <para> + <note> + Гиперматрицы представляются в виде простых матричноориентированных списков (mlist); + рациональные числа и пространства состояний представляются в виде + простых типизированных списков (tlist); + графические дескрипторы не распознаются. + </note> + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +a=eye(2,2); b=int16(ones(a)); c=rand(2,3,3); +save(fullfile(TMPDIR,"vals.sod"),'a','b','c') +[names,typs,dims,vols] = listvarinfile(fullfile(TMPDIR,"vals.sod")) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="whos">whos</link> + </member> + <member> + <link linkend="save">save</link> + </member> + <member> + <link linkend="load">load</link> + </member> + <member> + <link linkend="save_format">save_format</link> + </member> + <member> + <link linkend="type">type</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/maxfiles.xml b/modules/fileio/help/ru_RU/maxfiles.xml new file mode 100755 index 000000000..3b925612e --- /dev/null +++ b/modules/fileio/help/ru_RU/maxfiles.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="maxfiles"> + <refnamediv> + <refname>maxfiles</refname> + <refpurpose> + устанавливает предел количества одновременно открытых файлов + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>r = maxfiles(newnumbermax)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>newnumbermax</term> + <listitem> + <para>целое число: новое значение.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>r</term> + <listitem> + <para>целое число: фактическое новое значение.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>maxfiles</function> устанавливает предел количества одновременно открытых файлов. + </para> + <para>Минимум : 20.</para> + <para>Максимум : 100.</para> + <para>По умолчанию : 20.</para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +r = maxfiles(50); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="mopen">mopen</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/mclearerr.xml b/modules/fileio/help/ru_RU/mclearerr.xml new file mode 100755 index 000000000..883437884 --- /dev/null +++ b/modules/fileio/help/ru_RU/mclearerr.xml @@ -0,0 +1,79 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="mclearerr"> + <refnamediv> + <refname>mclearerr</refname> + <refpurpose>сбрасывает ошибки доступа к бинарному файлу</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>mclearerr([fd])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>fd</term> + <listitem> + <para> + скаляр: параметр <varname>fd</varname> возвращённый функцией + <function>mopen</function>. Для последнего открытого файла значение равно -1. Значение по умолчанию -1. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>mclearerr</function> используется для сброса индикатора ошибки и индикатора конца файла в ноль. + </para> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="merror">merror</link> + </member> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/mclose.xml b/modules/fileio/help/ru_RU/mclose.xml new file mode 100755 index 000000000..24b79701c --- /dev/null +++ b/modules/fileio/help/ru_RU/mclose.xml @@ -0,0 +1,128 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="mclose"> + <refnamediv> + <refname>mclose</refname> + <refpurpose>закрывает открытые файлы</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + err = mclose([fd]) + mclose('all') + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>fd</term> + <listitem> + <para> + скаляр: параметр <varname>fd</varname>, возвращённый функцией + <function>mopen</function>, используется в качестве файлового + дескриптора. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>err</term> + <listitem> + <para>скаляр: индикатор ошибки.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>mclose</function> должна использоваться для закрытия файла, открытого функцией <function>mopen</function>. Если <varname>fd</varname> опущен, то <function>mclose</function> закрывает последний открытый файл. + </para> + <para> + <code>mclose('all')</code> закрывает все файлы, открытые с помощью + <code>file('open',..)</code> или <function>mopen</function>. + <caution> + Будьте осторожны с использованием <function>mclose</function>, поскольку, когда вы используете её внутри файла-сценария Scilab, то она также закроет и сам сценарий, и Scilab не выполнит команды, написанные после <code>mclose('all')</code>. + </caution> + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +fd = mopen(TMPDIR + filesep() + 'mclose_tst','wt'); +mclose(TMPDIR + filesep() + 'mclose_tst'); + +fd=mopen('SCI/etc/scilab.start','r') +mgetl(fd,10) +mclose(fd) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetl">mgetl</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputl">mputl</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="file">file</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/mdelete.xml b/modules/fileio/help/ru_RU/mdelete.xml new file mode 100755 index 000000000..3decad59d --- /dev/null +++ b/modules/fileio/help/ru_RU/mdelete.xml @@ -0,0 +1,104 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="mdelete"> + <refnamediv> + <refname>mdelete</refname> + <refpurpose>удаляет файлы</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>mdelete(filename)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>filename</term> + <listitem> + <para> + символьная строка: имя файлов (и путь), которые нужно удалить. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <function>mdelete</function> может быть использована для удаления файла + или набора файлов, если <varname>filename</varname> содержит + метасимволы. + </para> + <para> + <caution> + Заметьте, что функция <function>mdelete</function> не спрашивает подтверждения, если вы вводите команду на удаление. Во избежание потери файлов, убедитесь, что вы точно указали файлы, которые вы хотите удалить. + </caution> + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +r = mputl('Эта строчка просто для образца.', TMPDIR+'/dummyFile.dummy'); +mdelete(TMPDIR+"/dummyFile.dummy"); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/meof.xml b/modules/fileio/help/ru_RU/meof.xml new file mode 100755 index 000000000..99b991baa --- /dev/null +++ b/modules/fileio/help/ru_RU/meof.xml @@ -0,0 +1,125 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="meof"> + <refnamediv> + <refname>meof</refname> + <refpurpose>проверяет достигнут ли конец файла</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>err = meof(fd)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>fd</term> + <listitem> + <para> + скаляр: параметр <varname>fd</varname>, возвращённый функцией + <function>mopen</function>, используется в качестве файлового + дескриптора. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>err</term> + <listitem> + <para>скаляр: индикатор ошибки.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>meof</function> вернёт ненулевое значение, если конец + файла был достигнут в предыдущем вызове <function>mget</function> или + <function>mgetstr</function>. Функция <function>mclearerr</function> + используется для сброса флага ошибки и флага конца файла в ноль. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ + +// Запись временного файла с неким текстом внутри него +this_file = pathconvert(TMPDIR+"/mputstr.txt", %F); + +fd = mopen(this_file, "wt"); +mputstr("Scilab is a numerical computing software.", fd); +mclose(fd); + +fd = mopen(this_file,'rt'); +i = 0; +while ~meof(fd) do + mfscanf(1, fd, "%c"); + i = i + 1; +end + +mclose(fd); + +disp("Scilab has found " + string(i) + " chars in the file"); + + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/merror.xml b/modules/fileio/help/ru_RU/merror.xml new file mode 100755 index 000000000..ab6abeb64 --- /dev/null +++ b/modules/fileio/help/ru_RU/merror.xml @@ -0,0 +1,118 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * Copyright (C) 2009 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="merror" xml:lang="ru"> + <refnamediv> + <refname>merror</refname> + <refpurpose>проверяет индикатор ошибок доступа к файлу</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + err = merror([fd]) + [err, msg] = merror([fd]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>fd</term> + <listitem> + <para> + скаляр: параметр <varname>fd</varname> возвращённый функцией + <function>mopen</function>, используемый в качестве файлового + дескриптора. Для последнего открытого файла значение равно -1. + Значение по умолчанию -1. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>err</term> + <listitem> + <para> + скаляр: номер статуса ошибки самой последней операции ввода/вывода файла, связанная с указанным файлом. + </para> + <para> + Если самая последняя операция ввода/вывода, выполненная для + указанного файла, была успешной, то значение + <varname>msg</varname> пустое и <function>merror</function> + возвращает нулевое значение <varname>err</varname>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>msg</term> + <listitem> + <para>строка: строковое сообщение об ошибке.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>merror</function> используется для проверки индикатора ошибок доступа к файлу, возвращая ненулевое значение, если она установлена. Индикатор ошибки может быть сброшен только с помощью функции <function>mclearerr</function>. + </para> + <para> + Ненулевое значение <varname>err</varname> указывает на то, что произошла ошибка в самой последней операции ввода-вывода файла. Значение сообщения является строковым и может содержать информацию о природе ошибки. Если сообщение не помогает, то обратитесь за справкой в руководство по C-библиотекам времени запуска для вашей операционной системы. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +fd = mopen(TMPDIR +'/filetxt.txt','wt'); +[err,msg] = merror(fd) +if (err <> 0) then + mprintf('Problem\n'); +end +mclose(fd); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="mclearerr">mclearerr</link> + </member> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/mfprintf.xml b/modules/fileio/help/ru_RU/mfprintf.xml new file mode 100755 index 000000000..f6cfa870b --- /dev/null +++ b/modules/fileio/help/ru_RU/mfprintf.xml @@ -0,0 +1,167 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mfprintf" xml:lang="ru"> + <refnamediv> + <refname>mfprintf</refname> + <refpurpose>преобразует, форматирует и записывает данные в файл</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>mfprintf(fd, format, a1, ..., an);</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>fd</term> + <listitem> + <para> + скаляр, файловый дескриптор, предоставленный с помощью + <function>mopen</function> (это положительное число). + </para> + <para> + Если <varname>fd</varname> равен 0, то перенаправление в + стандартное устройство вывода сообщений об ошибках (stderr). + </para> + <para> + Если <varname>fd</varname> равен 6, то перенаправление в + стандартное устройство вывода (stdout). + </para> + <para> + УСТАРЕЛО: значение <literal>-1</literal> относится к файлу по + умолчанию (т. е. последнему открытому файлу). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>format</term> + <listitem> + <para> + Scilab-строка, описывающая формат, который нужно использовать для + записи оставшихся операндов. Операнд <varname>format</varname> + следует как можно ближе к синтаксису операндов формата + <function>printf</function> в языке C. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>str</term> + <listitem> + <para> + символьная строка: строка, которую нужно отсканировать. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>a1, ..., an</term> + <listitem> + <para> + данные, которые преобразуются и распечатываются в соответствии с параметром формата. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>mfprintf</function> является интерфейсом для версии функции <function>fprintf</function> на языке C. + </para> + <para> + Функция <function>mfprintf</function> записывает форматированные + операнды в файл, указанный файловым дескриптором <varname>fd</varname>. + Операнды аргумента форматируются по управлением операнда + <varname>format</varname>. + </para> + <para> + Эта функция может быть использована для вывода векторов-столбцов чисел и + строковых векторов без явных циклов по элементам. В этом случае функция + проводит итерации по строкам. Наиболее короткий вектор даёт количество раз, сколько формат будет повторён. + </para> + <para> + Однородная последовательность параметров одинакового типа может быть + заменена матрицей. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ + +fd = mopen(TMPDIR+'/text.txt','wt'); +mfprintf(fd,'Привет, %s %d.\n','мир!',1); +mfprintf(fd,'Привет, %s %d.\n','Scilab',2); +mfprintf(fd,'Эта строка построена с помощью вектор-столбца (26:28) %d.\n',[26:28].'); +mfprintf(fd,'Эта строка построена с помощью вектор-строки (26:28) %d.\n',[26:28]); +A = rand(3,6); +mfprintf(fd,'Эта строка построена с помощью матрицы %.3f.\n',A); +mclose(fd); +if (isdef('editor') | (funptr('editor')<>0)) then + editor(TMPDIR+'/text.txt') +end +mfprintf(0,'stderr output.\n'); +mfprintf(6,'stdout output.\n'); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + <member> + <link linkend="printf_conversion">преобразование в printf</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/mfscanf.xml b/modules/fileio/help/ru_RU/mfscanf.xml new file mode 100755 index 000000000..57f044309 --- /dev/null +++ b/modules/fileio/help/ru_RU/mfscanf.xml @@ -0,0 +1,259 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mfscanf" xml:lang="ru"> + <refnamediv> + <refname>mfscanf</refname> + <refpurpose> + считывает входные данные из потока, указанного указателем потока (интерфейс с C-функцией fscanf) + </refpurpose> + </refnamediv> + <refnamediv xml:id="mscanf"> + <refname>mscanf</refname> + <refpurpose> + считывает входные данные с устройства стандартного ввода данных (интерфейс с C-функцией scanf) + </refpurpose> + </refnamediv> + <refnamediv xml:id="msscanf"> + <refname>msscanf</refname> + <refpurpose> + считывает свои входные данные из символьной строки (интерфейс с C-функцией sscanf) + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + [n, v_1,..., v_m] = mfscanf([niter,]fd, format) + L = mfscanf([niter,] fd,format) + + [n, v_1,..., v_m] = mscanf([niter,] format) + L = mscanf([niter,]format) + + [n, v_1,..., v_m] = msscanf([niter,]str, format) + L = msscanf([niter,] str, format) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>format</term> + <listitem> + <para> + Scilab-строка, описывающая формат, который нужно использовать для + записи оставшихся операндов. Операнд <varname>format</varname> + следует, как можно ближе синтаксису операндов формата C-функции + <function>printf</function>, как описано в + <link linkend="scanf_conversion">преобразовании в scanf</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>fd</term> + <listitem> + <para> + положительное целое число: файловый дескриптор, возвращённый функцией <function>mopen</function>. Значение -1 относится к последнему открытому файлу. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>str</term> + <listitem> + <para>Scilab-строка или вектор строк.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>niter</term> + <listitem> + <para> + целое число: сколько раз использовать <varname>format</varname>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>n</term> + <listitem> + <para> + целое число: количество данных, которое необходимо прочитать или -1, если конец файла был достигнут прежде, чем что-либо из данных было прочитано. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>v_i</term> + <listitem> + <para> + каждая из функций считывает символы, интерпретирует их в + соответствии с форматом <varname>format</varname> и сохраняет + результаты в своих выходных аргументах. Если выходных аргументов + указано больше, чем <varname>n</varname>, то последние аргументы + <varname>v_n+1, ..., v_m</varname> устанавливаются пустыми + матрицами. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>L</term> + <listitem> + <para> + если все данные однородны, то они сохраняются в уникальном + векторе, который возвращается, в противном случае + последовательности одного типа данных сохраняются в матрицах, а + возвращается матричноориентированный типизированный список <literal>mlist</literal> (с типом <literal>cblock</literal>), содержащий все построенные матрицы. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>mfscanf</function> считывает символы из потока + <varname>fd</varname>. + </para> + <para> + Функция <function>mscanf</function> считывает символы из окна Scilab. + </para> + <para> + Функция <function>msscanf</function> считывает символы из Scilab-строки + <varname>str</varname>. + </para> + <para> + Необязательный аргумент <varname>niter</varname> определяет сколько раз + использовать формат. Одна итерация формирует одну строку в выходной + матрице. Если <code>niter==-1</code>, то функция выполняет итерации до + конца файла. Значение <varname>niter</varname> по умолчанию равно 1. + </para> + <para>Комментарии о точности:</para> + <para> + <function>mfscanf</function> основана на C-функции + <function>fscanf</function>. Если вы используете + <literal>'%f'</literal>, <literal>'%g'</literal>, + <literal>'%e'</literal> в качестве формата, то ваши данные будут + приведены в тип плавающей запятой и возвращены в Scilab-переменную. + </para> + <para> + Если эта Scilab-переменная является числом двойной точности, то вы + можете получить некоторые ошибки по точности. В этом случае лучше + использовать формат <literal>'%lg'</literal>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +//---------------------------------------------------------- +//-- Простое использование -- +//---------------------------------------------------------- +s='1 1.3' // строка +[n,a,b]=msscanf(s,"%i %e") +L=msscanf(s,"%i %e") + +//---------------------------------------------------------- +//-- Примеры форматов -- +//---------------------------------------------------------- + +msscanf(" 12\n",'%c%c%c%c') // сканирование символов + +msscanf('0xabc','%x') // сканирование в шестнадцатеричном формате + +msscanf('012345abczoo','%[0-9abc]%s') //обозначение [] + +// считывание чисел типов float и double +msscanf('4345.988','%g')-4345.988 // сканирование числа float +msscanf('4345.988','%lg')-4345.988 // сканирование числа double + +//---------------------------------------------------------- +//-- сканирование файлов с многострочными данными +//---------------------------------------------------------- +// создание файла с данными +u=mopen(TMPDIR+'/foo','w'); +t=(0:0.1:%pi)';mfprintf(u,"%6.3f %6.3f\n",t,sin(t)) +mclose(u); + +// открытие файла на чтение +u=mopen(TMPDIR+'/foo','r'); +// чтение файла строка за строкой +[n,a,b]=mfscanf(u,'%e %e') // первая строка, используя синтаксис множества данных с левой стороны +l=mfscanf(u,'%e %e') // вторая строка, используя синтаксис одной переменной с левой стороны + +//использование niter для чтения ещё пяти строк +l=mfscanf(5,u,'%e %e') + +// использование niter=-1 для чтения до конца файла +l=mfscanf(-1,u,'%e %e') + +// закрытие файла +mclose(u); + +//------------------------------------------------------------------ +//-- сканирование векторов с многострочными строковыми значениями -- +//------------------------------------------------------------------ +//использование niter для сканирования вектора строковых значений +[n,Names,Ages]=msscanf(-1,["Alain 19";"Pierre 15";"Tom 12"],'%s %d') +D=msscanf(-1,["Alain 19";"Pierre 15";"Tom 12"],'%s %d') +typeof(D) +Names=D(:,1) // строки +Age=D(:,2) // числовые значения + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + <member> + <link linkend="scanf_conversion">преобразование в scanf</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/mget.xml b/modules/fileio/help/ru_RU/mget.xml new file mode 100755 index 000000000..c49ad6c3e --- /dev/null +++ b/modules/fileio/help/ru_RU/mget.xml @@ -0,0 +1,254 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mget" xml:lang="ru"> + <refnamediv> + <refname>mget</refname> + <refpurpose> + считывает байт или слово в заданном двоичном формате и преобразует в + число удвоенной точности + </refpurpose> + </refnamediv> + <refnamediv xml:id="mgeti"> + <refname>mgeti</refname> + <refpurpose> + считывает байт или слово в заданном двоичном формате и возвращает + целочисленное значение типа int + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + x = mget([n, type, fd]) + x = mgeti([n, type, fd]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>n</term> + <listitem> + <para>положительный скаляр: количество считываемых данных.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>fd</term> + <listitem> + <para> + скаляр: параметр <varname>fd</varname>, возращённый функцией <function>mopen</function>. Для последнего открытого файла ставится -1. Значение по умолчанию -1. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>type</term> + <listitem> + <para> + строка: двоичный формат, используемый для записи всех элементов + <varname>x</varname>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>x</term> + <listitem> + <para> + вектор целых чисел или чисел с плавающей запятой. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>mget</function> считывает данные со входа, определённого параметром потока <varname>fd</varname> и возвращает вектор данных с плавающей запятой. + </para> + + <para> + Функция <function>mgeti</function> считывает данные со входа, определённого параметром потока <varname>fd</varname> и возвращает вектор целочисленных данных. + </para> + <para> + Данные считываются в положении, на которое в данный момент указывает указатель файла и передвигает индикатор далее соответствующим образом. + </para> + <para> + Параметр <varname>type</varname> является указателем преобразования, который может быть установлен в любой из следующих символов-флагов (со значением по умолчанию <literal>"l"</literal>): + </para> + <para> + <note> + В Windows, поведение по умолчанию состоит в пропуске байта 13 (<literal>0x0D</literal>). + Функцию <function>mopen</function> следует вызывать с опцией + <literal>'b'</literal>, например, <code>fd1 = mopen(file1,'rb')</code>, так что все байты без исключения будут прочитаны. + </note> + </para> + <para>Тип данных:</para> + <variablelist> + <varlistentry> + <term>d</term> + <listitem> + <para>удвоенная точность, double</para> + </listitem> + </varlistentry> + <varlistentry> + <term>f</term> + <listitem> + <para>плавающая запятая, float</para> + </listitem> + </varlistentry> + <varlistentry> + <term>l</term> + <listitem> + <para>длинное, long long</para> + </listitem> + </varlistentry> + <varlistentry> + <term>i</term> + <listitem> + <para>целочисленное, int (long int)</para> + </listitem> + </varlistentry> + <varlistentry> + <term>s</term> + <listitem> + <para>короткое, short</para> + </listitem> + </varlistentry> + <varlistentry> + <term>c</term> + <listitem> + <para>символ, character</para> + </listitem> + </varlistentry> + </variablelist> + <para>Необязательный флаг:</para> + <variablelist> + <varlistentry> + <term>u..</term> + <listitem> + <para> + беззнаковый (в сочетании с одним из вышеперечисленных типов) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>..l</term> + <listitem> + <para> + прямой порядок байтов (в сочетании с одним из вышеперечисленных + типов) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>..b</term> + <listitem> + <para> + обратный порядок байтов (в сочетании с одним из вышеперечисленных + типов) + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + Чтение байтов автоматически переключается при необходимости (с помощью проверки статуса <literal>little=endian</literal>). + </para> + <para> + Такое поведение переключения можно подавить, если добавить флаг в функцию <function>mopen</function>. + </para> + <para> + Форматы <literal>"l"</literal>, <literal>"d"</literal> и + <literal>"f"</literal> корректны только с функцией + <function>mget</function>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +file1 = fullfile(TMPDIR,'test1.bin'); +file2 = fullfile(TMPDIR,'test2.bin'); +fd1=mopen(file1,'wb'); +fd2=mopen(file2,'wb'); +mput(1996,'ull',fd1); +mput(1996,'ull',fd2); +mclose(fd1); +mclose(fd2); + +fd1=mopen(file1,'rb'); +if 1996<>mget(1,'ull',fd1) + write(%io(2),'Bug'); +end + +fd2=mopen(file2,'rb'); +if 1996<>mget(1,'ull',fd2) + write(%io(2),'Bug'); +end + +mclose(fd1); +mclose(fd2); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mgetl">mgetl</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputl">mputl</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/mgetl.xml b/modules/fileio/help/ru_RU/mgetl.xml new file mode 100755 index 000000000..9b70c1d71 --- /dev/null +++ b/modules/fileio/help/ru_RU/mgetl.xml @@ -0,0 +1,121 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Serge STEER + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="mgetl"> + <refnamediv> + <refname>mgetl</refname> + <refpurpose>считывает строки из текстового файла</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>txt = mgetl(file_desc [,m])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>file_desc</term> + <listitem> + <para> + символьная строка, указывающая имя файла или логический блок, возвращаемый функцией <function>mopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>m</term> + <listitem> + <para> + целочисленный скаляр: количество строк, которое нужно прочитать. + Значение по умолчанию равно -1. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>txt</term> + <listitem> + <para>вектор-столбец строковых значений.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>mgetl</function> позволяет считывать строки из + текстового файла. + </para> + <para> + Если <varname>m</varname> не указано или равно <literal>-1</literal>, + то будут считываться все строки до тех пор, пока не встретится конец + файла. + </para> + <para> + Если <varname>m</varname> указано, то функция <function>mgetl</function> + пытается прочитать точно <varname>m</varname> строк. Эта опция полезна + для последовательного чтения части файла. В этом случае, если конец + файла встретится прежде, чем будет прочитано <varname>m</varname> строк, + то прочитанные строки будут возвращены оформленными (можно проверять + встретился ли конец файла используя функцию <function>meof</function>). + </para> + <para> + Функция <function>mgetl</function> позволяет считывать файлы в + операционных системах Unix, Windows или Mac. + </para> + <para> + Функция <function>mgetl</function> поддерживает лишь кодировки UTF-8 и + ANSI. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +mgetl('SCI/etc/scilab.start',5) + +mgetl SCI/modules/elementary_functions/macros/erf.sci + +fd=mopen('SCI/etc/scilab.start','r') +mgetl(fd,10) +mclose(fd) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="mputl">mputl</link> + </member> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="read">read</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/mgetstr.xml b/modules/fileio/help/ru_RU/mgetstr.xml new file mode 100755 index 000000000..c36ca2dab --- /dev/null +++ b/modules/fileio/help/ru_RU/mgetstr.xml @@ -0,0 +1,139 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * Copyright (C) 2010 - Digiteo - Vincent LIARD + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mgetstr" xml:lang="ru"> + <refnamediv> + <refname>mgetstr</refname> + <refpurpose>считывает символьную строку из файла</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>str = mgetstr(n, [fd])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>n</term> + <listitem> + <para> + неотрицательное целое число: количество символов, которое + необходимо прочитать. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>fd</term> + <listitem> + <para> + целое число: дескриптор файла, возвращаемый функцией + <link linkend="mopen">mopen</link>, в котором необходимо + прочитать символы. Значение <literal>-1</literal> ставится для + последнего открытого файла и оно является значением по умолчанию. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>str</term> + <listitem> + <para>символьная строка, которую нужно прочитать.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>mgetstr</function> пытается прочитать + <varname>n</varname> символов из файла. Если конец файла достигнут + прежде, чем будут прочитаны <varname>n</varname> символов, то + <function>mgetstr</function> возвращает лишь те значения, которые + удалось прочитать. Как следствие, когда курсор чтения уже в конце файла, + когда вызывается функция <function>mgetstr</function>, то она возвращает + пустую строку, и при этом не важно какое значение указано для + <varname>n</varname>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ + fn = SCI + '/ACKNOWLEDGEMENTS'; // абсолютный пут до некоторого файла + details = fileinfo(fn); // получение деталей о файле + len = details(1); // получение длины файла + fd = mopen(fn, 'rt'); // открыть файл как текст в режиме чтения + str1 = mgetstr(33, fd) // прочитать 33 символа из fd + length(str1) // чтение 33 символов + str2 = mgetstr(272, fd) // чтение следующих 272 символов из fd + length(str2) // 272 прочитанных символа + mseek(len - 5); // прыжок на 5-тый символ до конца файла + str3 = mgetstr(10, fd) // попытка прочесть 10 символов: возвращаются только 5 символов, больше не доступно + length(str3) // да, есть 5 символов: вы просто не видите символ перевода строки :) + str4 = mgetstr(10, fd) // чтение 10 символов: возврат пустой строки + length(str4) // пустая строка + mclose(fd); // закрытие файла + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + <member>"Input/Output functions" section</member> + <!-- TODO: link to "Input/Output functions" index page --> + <!-- next link does not work when reading doc in scilab --> + <!-- <member><link linkend="section_efa4cbf5c15e166f34901f827390e756">Input/Output functions</link></member> --> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/mopen.xml b/modules/fileio/help/ru_RU/mopen.xml new file mode 100755 index 000000000..b35cb818a --- /dev/null +++ b/modules/fileio/help/ru_RU/mopen.xml @@ -0,0 +1,349 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * Copyright (C) 2011 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mopen" xml:lang="ru"> + <refnamediv> + <refname>mopen</refname> + <refpurpose>открывает файл в Scilab'е</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>[fd, err] = mopen(file [, mode, swap ])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>file</term> + <listitem> + <para> + символьная строка, содержащая имя файла, который требуется открыть. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>mode</term> + <listitem> + <para> + символьная строка, определяющая требуемый режим доступа к файлу. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>swap</term> + <listitem> + <para> + скаляр. Если есть <varname>swap</varname> и <code>swap = 0</code>, тогда автоматическая перестановка байтов отключается. + </para> + <para>Значение по умолчанию равно 1.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>err</term> + <listitem> + <para>скаляр. Индикатор ошибки.</para> + <informaltable border="1"> + <tr> + <td>значение ошибки:</td> + <td>сообщение об ошибке:</td> + </tr> + <tr> + <td>0</td> + <td>нет ошибки</td> + </tr> + <tr> + <td>-1</td> + <td>больше нет логических модулей</td> + </tr> + <tr> + <td>-2</td> + <td>не могу открыть файл</td> + </tr> + <tr> + <td>-3</td> + <td>больше нет памяти</td> + </tr> + <tr> + <td>-4</td> + <td>некорректное имя</td> + </tr> + <tr> + <td>-5</td> + <td>некорректный статус</td> + </tr> + </informaltable> + </listitem> + </varlistentry> + <varlistentry> + <term>fd</term> + <listitem> + <para> + скаляр: дескриптор файла (это положительное целое число). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>mopen</function> может использоваться для + того, чтобы открыть файл <varname>file</varname> способом, + совместимым с C-процедурой <function>fopen</function>. Без + аргумента <varname>swap</varname> файл + <varname>file</varname> предполагается закодированным в + формате IEEE "с прямым порядком байтов" и байты данных + автоматически переставляются, если необходимо + соответствовать формату IEEE процессора. + </para> + <para> + Параметр <varname>mode</varname> управляет типом доступа к потоку. Этот параметр может иметь одно из + следующих значений: + </para> + <variablelist> + <varlistentry> + <term>r</term> + <listitem> + <para> + открывает файл для чтения (по умолчанию). Файл + должен существовать, в противном случае ничего + не получится. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>w</term> + <listitem> + <para> + открывает файл на запись. Если этот файл + существует, то его содержимое будет уничтожено. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>a</term> + <listitem> + <para> + открывает файл для добавления записи. Создаёт + файл если он не существует. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>r+</term> + <listitem> + <para> + открывает файл как для чтения, так и для записи. + Файл должен существовать, иначе ничего не + получится. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>w+</term> + <listitem> + <para> + открывает файл как для чтения, так и для записи. + Если файл существует, то его содержимое будет + уничтожено. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>a+</term> + <listitem> + <para> + открывает файл как на чтение, так и на + добавление записи. Создаёт файл если он не + существует. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + Кроме того могут быть использованы следующие символы для определения типа файла: + <variablelist> + <varlistentry> + <term>t</term> + <listitem> + <para>текстовый файл.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>b</term> + <listitem> + <para>двоичный файл (по умолчанию).</para> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + По умолчанию режим доступа <literal>'rb'</literal> (чтение + двоичного файла). + </para> + <para> + <note> + Заметьте: в Windows, в режиме текстового файла комбинации CR (возврат каретки) - LF (конец строки) преобразуются в LF при чтении, а LF преобразуются в комбинации CR-LF при записи. + </note> + </para> + <para> + Когда вы открываете файл для обновления, вы можете выполнять операции + как ввода, так и вывода в результирующем потоке. Однако за операцией + вывода не может напрямую идти операция ввода без операции + позиционирования файла (функция <function>mseek</function>). Также, + за операцией ввода не может идти операция вывода без промежуточной + операции позиционирования файла пока операция ввода не встретит конец + файла. + </para> + <para> + Когда вы открываете файл для добавления записи (то есть, когда + параметр <varname>mode</varname> равен <literal>a</literal> или + <literal>a+</literal>), то невозможно перезаписать информацию, + которая уже есть в файле. Вы можете использовать функцию + <function>mseek</function> для смены положения указателя позиции в + файле в любое место файла, но, когда вывод записан в файл, текущий + указатель позиции в файле игнорируется. Весь вывод записывается в + конец файла и указатель позиции в файле перемещается в конец вывода. + </para> + <para> + Чтобы открыть файлы способом, совместимым с Fortran-функциями используйте функцию <function>file</function>. + </para> + </refsection> + <refsection> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +// открываем SCI+'/ACKNOWLEDGEMENTS' как текст только для чтения +fd_r = mopen(SCI+'/ACKNOWLEDGEMENTS', 'rt') + +// читаем пять строк в fd_r +mgetl(fd_r, 5) + +// другой способ чтения файла +// здесь читаются пять слов +mfscanf(5, fd_r, '%s') + +// закрываем дескриптор файл, связанный с SCI+'/ACKNOWLEDGEMENTS' +mclose(fd_r); + ]]></programlisting> + </refsection> + <refsection> + </refsection> + <refsection> + <programlisting role="example"><![CDATA[ +// открываем файл как текст с возможностью записи +fd_w = mopen(TMPDIR+'/write.txt', 'wt'); + +// записываем строчку в fd_w +mputl('This is a line of text', fd_w); +mclose(fd_w); + +// читаем текст +fd_r2 = mopen(TMPDIR+'/write.txt', 'rt'); +mgetl(fd_r2) +mclose(fd_r2); + ]]></programlisting> + </refsection> + <refsection> + </refsection> + <refsection> + <programlisting role="example"><![CDATA[ +// читаем/записываем файл как двоичный + +// сперва мы запишем файл +fd_wb = mopen(TMPDIR+'/writeread.bin', 'wb') + +// положим значения в двоичном виде +mput(2003, 'l', fd_wb); +mput(2008, 'i', fd_wb); +mput(2012, 's', fd_wb); +mput(98, 'c', fd_wb); + +// закроем дескриптор файла, связанный с TMPDIR+'/writeread.bin' +mclose(fd_wb); + +// прочитаем файл +fd_rb = mopen(TMPDIR+'/writeread.bin', 'rb') + +mget(fd_rb, 'l') +mget(fd_rb, 'i') +mget(fd_rb, 's') +mget(fd_rb, 'c') + +mclose(fd_rb) + ]]></programlisting> + </refsection> + <refsection> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="file">file</link> + </member> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="merror">merror</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetl">mgetl</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputl">mputl</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/movefile.xml b/modules/fileio/help/ru_RU/movefile.xml new file mode 100755 index 000000000..6c49b65f7 --- /dev/null +++ b/modules/fileio/help/ru_RU/movefile.xml @@ -0,0 +1,102 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2009 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="movefile" xml:lang="ru"> + <refnamediv> + <refname>movefile</refname> + <refpurpose>перемещает файл или директорию</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>movefile(source, destination) + [status, message] = movefile(source, destination) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>source</term> + <listitem> + <para> + символьная строка: источник. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>destination</term> + <listitem> + <para> + символьная строка: назначение. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>status</term> + <listitem> + <para> + целое число: статус работы. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>message</term> + <listitem> + <para> + символьная строка: сообщение об ошибке. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + + <refsection> + <title>Описание</title> + <para> + Инструкция <code>movefile(source, destination)</code> перемещает файл + или директорию <varname>source</varname> (и поддиректории) в файл или + директорию <varname>destination</varname>. + </para> + <para> + Если <varname>source</varname> является директорией, то + <varname>destination</varname> не может быть файлом. + <warning> + Функция <function>movefile</function> заменяет существующие файлы без предупреждения. + </warning> + </para> + <para> + Инструкция <code>[status, message] = movefile(source, destination)</code> перемещает источник <varname>source</varname> в + назначение <varname>destination</varname>, возвращая статус + <varname>status</varname> и сообщение <varname>message</varname>. + </para> + <para> + Для любой операционной системы если перемещение удалось, то статус + <varname>status</varname> будет равен 1, а сообщение <varname>message</varname> будет пустым; если же перемещение не удалось, то статус <varname>status</varname> будет равен 0, а сообщение <varname>message</varname> не будет пустым. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ + copyfile(SCI+"/etc/scilab.start",TMPDIR+"/scilab.start") + [status,message] = movefile(TMPDIR+"/scilab.start",TMPDIR+"/renamed_scilab.start") + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="copyfile">copyfile</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/mput.xml b/modules/fileio/help/ru_RU/mput.xml new file mode 100755 index 000000000..4021d82ec --- /dev/null +++ b/modules/fileio/help/ru_RU/mput.xml @@ -0,0 +1,179 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="mput"> + <refnamediv> + <refname>mput</refname> + <refpurpose> + записывает байт или слово в заданном двоичном формате + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>mput(x [, type, fd])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>x</term> + <listitem> + <para> + вектор целых чисел или чисел с плавающей запятой. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>fd</term> + <listitem> + <para> + скаляр: дескриптор файла, возвращённый функцией + <function>mopen</function>. Значение по умолчанию равно -1, + что означает последний файл, открытый функцией + <function>mopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>type</term> + <listitem> + <para> + строка: двоичный формат, используемый для записи всех элементов <varname>x</varname>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>mput</function> записывает данные в выход, + определённый параметром потока <varname>fd</varname>. Данные + записываются в место, на которое в данный момент указывает указатель + положения в файле, и передвигает указатель дальше соответствующим + образом. + </para> + <para> + Параметр <varname>type</varname> -- это определитель преобразования, который может быть установлен любым из следующих символов (значение по умолчанию <literal>"l"</literal>): + </para> + <variablelist> + <varlistentry> + <term>"l", "i", "s", "ul", "ui", "us", "d", "f", "c", "uc"</term> + <listitem> + <para> + для записи соответственно типов long long, int(long + int), short, unsigned long long, unsigned int(long int), unsigned short, double, float, char и unsigned char. Байты, которые записываются, автоматически переставляются, если нужно (это проверяется статусом прямого порядка байтов) для того, чтобы сделать двоичные файлы, независимые от машины. Режим перестановки байтов по умолчанию может быть подавлен добавлением флага <code>swap = 0</code> в функции <function>mopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>"..l" или "..b"</term> + <listitem> + <para> + Можно также записывать в режиме обратной и прямой последовательности байтов, добавляя символ <literal>"l"</literal> или <literal>"b"</literal> в конец указателя типа <varname>type</varname>. Например, + <literal>"db"</literal> будет записывать тип double в режиме обратного порядка байтов. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +filen = 'test.bin'; +mopen(filen,'wb'); +mput(1996,'l');mput(1996,'i');mput(1996,'s');mput(98,'c'); + +// force little-endian +mput(1996,'ll');mput(1996,'il');mput(1996,'sl');mput(98,'cl'); + +// force big-endian +mput(1996,'lb');mput(1996,'ib');mput(1996,'sb');mput(98,'cb'); + +mclose(); +mopen(filen,'rb'); +if 1996<>mget(1,'l') then pause,end +if 1996<>mget(1,'i') then pause,end +if 1996<>mget(1,'s') then pause,end +if 98<>mget(1,'c') then pause,end + +// force little-endian +if 1996<>mget(1,'ll') then pause,end +if 1996<>mget(1,'il') then pause,end +if 1996<>mget(1,'sl') then pause,end +if 98<>mget(1,'cl') then pause,end + +// force big-endian +if 1996<>mget(1,'lb') then pause,end +if 1996<>mget(1,'ib') then pause,end +if 1996<>mget(1,'sb') then pause,end +if 98<>mget(1,'cb') then pause,end + +mclose(); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetl">mgetl</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mputl">mputl</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/mputl.xml b/modules/fileio/help/ru_RU/mputl.xml new file mode 100755 index 000000000..370f90afa --- /dev/null +++ b/modules/fileio/help/ru_RU/mputl.xml @@ -0,0 +1,108 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Serge STEER + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="mputl" xml:lang="ru"> + <refnamediv> + <refname>mputl</refname> + <refpurpose>записывает строки в текстовый файл</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>r = mputl(txt, file_desc)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>r</term> + <listitem> + <para> + возвращает <literal>%t</literal> или <literal>%f</literal> для проверки правильно ли функция записала файл. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>file_desc</term> + <listitem> + <para> + символьная строка, указывающая имя файла или + </para> + <para> + целочисленный скаляр: дескриптор файла, возвращённый функцией <function>mopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>txt</term> + <listitem> + <para> + вектор строк, текст для записи в файл. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>mputl</function> позволяет записывать вектор строковых значений в виде последовательности строк в текстовый файл. + </para> + <para> + Функция <function>mputl</function> поддерживает запись строк, закодированных в ANSI/ASCII и UTF-8. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +fd = mopen(TMPDIR+'/text_mputl.txt','wt'); +mputl('Привет, Мир!',fd); +mclose(fd); + +mputl('Незатейливый ""Привет, Мир!""',TMPDIR+"/text_mputl_simple.txt"); + +fd = mopen(TMPDIR+'/text_mputl.txt','rt'); +disp(mgetl(fd)); +mclose(fd); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetl">mgetl</link> + </member> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="write">write</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/mputstr.xml b/modules/fileio/help/ru_RU/mputstr.xml new file mode 100755 index 000000000..d21de9ff3 --- /dev/null +++ b/modules/fileio/help/ru_RU/mputstr.xml @@ -0,0 +1,110 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="mputstr"> + <refnamediv> + <refname>mputstr</refname> + <refpurpose>записывает символьную строку в файл</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>mputstr(str [, fd]);</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>fd</term> + <listitem> + <para> + скаляр: дескриптор файла, возвращённый функцией <function>mopen</function>. Для последнего открытого файла ставится <literal>-1</literal>. Значение по умолчанию <literal>-1</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>str</term> + <listitem> + <para>символьная строка.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>mputstr</function> позволяет записать символьную строку <varname>str</varname> в двоичный файл. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ + +this_file = pathconvert(TMPDIR+"/mputstr.txt", %F); + +fd = mopen(this_file, "wt"); +mputstr("Scilab", fd); +mclose(fd); + +mgetl(this_file) // Scilab + + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/mseek.xml b/modules/fileio/help/ru_RU/mseek.xml new file mode 100755 index 000000000..aa1bc4bcb --- /dev/null +++ b/modules/fileio/help/ru_RU/mseek.xml @@ -0,0 +1,155 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="mseek"> + <refnamediv> + <refname>mseek</refname> + <refpurpose>устанавливает текущую позицию в двоичном файле</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>mseek(n [,fd, flag])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>n</term> + <listitem> + <para> + положительный скаляр: смещение от исходного положения в количестве байтов. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>fd</term> + <listitem> + <para> + скаляр: дескриптор файла, возвращённый функцией <function>mopen</function>. <literal>-1</literal> + указывает на последний открытый файл. Значение по умолчанию равно <literal>-1</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>flag</term> + <listitem> + <para> + строка: определяет исходное положение. Значение по умолчанию -- + <literal>'set'</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>mseek</function> устанавливает положение следующей + операции ввода или вывода потока <varname>fd</varname>. Новое + положение находится на расстоянии (со знаком), указанном в + <varname>n</varname> байт от начала, от текущего положения или от + конца файла в соответствии со значением <varname>flag</varname>, + которое может быть <literal>'set'</literal>, <literal>'cur'</literal> + или <literal>'end'</literal>. + </para> + <para> + Функция <function>mseek</function> позволяет индикатору положения в + файле быть установленным за пределами конца существующих данных в + файле. Если данные будут позднее записаны в это место, то последующее + чтение этих данных в пропущенном месте будет возвращать ноль до тех + пор, пока данные не будут действительно записаны в пропущенное место. + Функция <function>mseek</function> сама по себе не увеличивает + размер файла. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +file3=fullfile(TMPDIR,'test3.bin'); +fd1= mopen(file3,'wb'); +for i=1:10 + mput(i,'d'); +end +mseek(0); +mput(678,'d'); +mseek(0,fd1,'end'); +mput(932,'d'); +mclose(fd1) + +fd1= mopen(file3,'rb'); +res=mget(11,'d') +res1=[1:11]; res1(1)=678;res1($)=932; +if res1<>res then + write(%io(2),'Ошибка в программе'); +end +mseek(0,fd1,'set'); + +// попытка чтения данных более, чем сохранено +res1=mget(100,'d',fd1); +if res1<>res then + write(%io(2),'Ошибка в программе'); +end +meof(fd1) +mclearerr(fd1) +mclose(fd1); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mtell">mtell</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/mtell.xml b/modules/fileio/help/ru_RU/mtell.xml new file mode 100755 index 000000000..bda6c78d8 --- /dev/null +++ b/modules/fileio/help/ru_RU/mtell.xml @@ -0,0 +1,110 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="mtell"> + <refnamediv> + <refname>mtell</refname> + <refpurpose>возвращает смещение текущего байта относительно начала файла</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>mtell([fd])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>fd</term> + <listitem> + <para> + скаляр: дескриптор файла, возвращённый функцией <function>mopen</function>. <literal>-1</literal> + указывает на последний открытый файл. Значение по умолчанию равно <literal>-1</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>mtell</function> возвращает смещение текущего байта относительно начала файла, связанного с именованным потоком <varname>fd</varname>. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// Откроем запись временного двоичного файла +testFile=TMPDIR + '/testFile.bin'; +fd = mopen(testFile,'wb'); + +mput(42,'d'); // Запишем 42 в последний открытый файл +mtell() // Вернёт 8, текущее положение в дескрипторе файла + +mput(42+2,'d', fd); // Откроем непосредственно fd, чтобы записать 42 +mtell(fd) // Вернёт 16, текущее положение в дескрипторе файла + +mseek(0, fd); // возврат в начало файла +mtell(fd) // Вернёт 0 + +mclose(fd); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="mclose">mclose</link> + </member> + <member> + <link linkend="meof">meof</link> + </member> + <member> + <link linkend="mfprintf">mfprintf</link> + </member> + <member> + <link linkend="fprintfMat">fprintfMat</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="fscanfMat">fscanfMat</link> + </member> + <member> + <link linkend="mget">mget</link> + </member> + <member> + <link linkend="mgetstr">mgetstr</link> + </member> + <member> + <link linkend="mopen">mopen</link> + </member> + <member> + <link linkend="mprintf">mprintf</link> + </member> + <member> + <link linkend="mput">mput</link> + </member> + <member> + <link linkend="mputstr">mputstr</link> + </member> + <member> + <link linkend="mseek">mseek</link> + </member> + <member> + <link linkend="mdelete">mdelete</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/newest.xml b/modules/fileio/help/ru_RU/newest.xml new file mode 100755 index 000000000..1826b19e0 --- /dev/null +++ b/modules/fileio/help/ru_RU/newest.xml @@ -0,0 +1,77 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="newest"> + <refnamediv> + <refname>newest</refname> + <refpurpose>возвращает самый новый файл из набора файлов</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis> + k = newest(paths) + k = newest(path1, path2, ..., pathn) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>k</term> + <listitem> + <para> + целое число: индекс самого нового файла. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>paths</term> + <listitem> + <para> + вектор символьных строк, <code>paths(i)</code> -- имя пути <literal>i</literal>-того файла. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>pathi</term> + <listitem> + <para> + символьная строка, имя пути <literal>i</literal>-того файла. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Для указанного набора имён путей <function>newest</function> возвращает индекс самого нового файла. Несуществующие файлы считаются самыми старыми. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +newest('SCI/modules/graphics/macros/bode.sci','SCI/modules/graphics/macros/bode.bin') +newest(['SCI/modules/graphics/macros/bode.sci','SCI/modules/graphics/macros/bode.bin']) +newest('SCI/modules/graphics/macros/bode.'+['sci','bin']) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="fileinfo">fileinfo</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/path_filename/CHAPTER b/modules/fileio/help/ru_RU/path_filename/CHAPTER new file mode 100755 index 000000000..b0e4557b2 --- /dev/null +++ b/modules/fileio/help/ru_RU/path_filename/CHAPTER @@ -0,0 +1,2 @@ +title = Пути - Имена файлов + diff --git a/modules/fileio/help/ru_RU/path_filename/basename.xml b/modules/fileio/help/ru_RU/path_filename/basename.xml new file mode 100755 index 000000000..3c8e61514 --- /dev/null +++ b/modules/fileio/help/ru_RU/path_filename/basename.xml @@ -0,0 +1,104 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="basename" xml:lang="ru"> + <refnamediv> + <refname>basename</refname> + <refpurpose>отсекает директорию и расширение от имён файлов</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>processedfiles = basename(files[,flag [,flagexpand]])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>files</term> + <listitem> + <para> + матрица строковых значений, указывающая набор имён файлов + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>flag</term> + <listitem> + <para> + логический необязательный параметр, используемые + для преобразования указанных путей в текущей + операционной системе. Значение по умолчанию + "истина" (<constant>%t</constant>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>flagexpand</term> + <listitem> + <para> + логический необязательный параметр, используемый + для расширения переменных, идущих впереди, в + пути. Используется только с аргументом + <varname>flag</varname> argument. Значение по + умолчанию "истина" (<constant>%t</constant>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>processedFiles</term> + <listitem> + <para> + матрица строковых значений, содержащая имена обработанных файлов. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <code>basename(files)</code> возвращает основное имя файлов, + указанных в <varname>files</varname>. + </para> + <para> + Если <varname>flag</varname> равен ИСТИНЕ, то файлы <varname>files</varname> сначала преобразуются + в целевой тип, указанный переменной <code>getos() == 'Windows'</code>. + Более того, если <varname>flagexpand</varname> равен ИСТИНЕ, то первые + строковые значение, такие, как <literal>SCIHOME</literal>, <literal>SCI</literal> + или <literal>~</literal> разворачиваются с помощью переменных окружения. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +files=basename('SCI/modules/fileio/macros/poo.sci') +files=basename('SCI/modules\fileio/macros/poo.sci') +files=basename('SCI/modules\fileio/macros/poo.sci.k') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="listfiles">listfiles</link> + </member> + <member> + <link linkend="pathconvert">pathconvert</link> + </member> + <member> + <link linkend="fileparts">fileparts</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/path_filename/dirname.xml b/modules/fileio/help/ru_RU/path_filename/dirname.xml new file mode 100755 index 000000000..8fccb4557 --- /dev/null +++ b/modules/fileio/help/ru_RU/path_filename/dirname.xml @@ -0,0 +1,115 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="dirname"> + <refnamediv> + <refname>dirname</refname> + <refpurpose>получает имя директории из имён файлов</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>dirs = dirname(files[, flag [,flagexpand]])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>files</term> + <listitem> + <para> + матрица строк, содержащая пути к файлам. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>flag</term> + <listitem> + <para> + необязательное логическое значение, используемое для + преобразования указанных путей для текущей операционной + системы. Значение по умолчанию ИСТИНА (<constant>%t</constant>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>flagexpand</term> + <listitem> + <para> + необязательный логическое значение, используемое для + составления пути из переменных, идущих впереди. Используется + только вместе с аргументом <varname>flag</varname>. Значение + по умолчанию ИСТИНА (<constant>%t</constant>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>dirs</term> + <listitem> + <para>матрица строк.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>dirname</function> возвращает путь директории, составленный + из файлов, указанных в <varname>files</varname>. + </para> + <para> + Если <varname>flag</varname> равен ИСТИНЕ, то пути сначала преобразуются для + текущей операционной системы (например, <code>'C:/Tmp/folder'</code> будет + преобразован в Windows в <code>'C:\Tmp\folder'</code>). + </para> + <para> + Если <varname>flagexpand</varname> равен ИСТИНЕ, то переменные в начале пути + (<literal>home</literal>, <constant>SCI</constant>, <constant>SCIHOME</constant>, + ...) расширяются для текущей операционной системы (например, <code>'home\tmp'</code> + будет преобразован в GNU/Linux в <literal>'home/<user>/tmp'</literal>, + где <literal><user></literal> - это имя учётной записи пользователя). + </para> + <para> + Смотрите подробную информацию о <varname>flag</varname> и <varname>flagexpand</varname> + в разделе, посвящённому <link linkend="pathconvert">pathconvert</link>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +dirs=dirname('/tmp/folder/poo') +dirs=dirname('/tmp/folder/') +dirs=dirname('/') + +dirs=dirname('C:\tmp\folder\poo') +dirs=dirname('C:\tmp\folder\') +dirs=dirname('C:\') + +dirs=dirname(['SCI/etc/scilab.start', 'SCI/etc/scilab.quit']) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="basename">basename</link> + </member> + <member> + <link linkend="listfiles">listfiles</link> + </member> + <member> + <link linkend="pathconvert">pathconvert</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/path_filename/fileext.xml b/modules/fileio/help/ru_RU/path_filename/fileext.xml new file mode 100755 index 000000000..ccf8c147e --- /dev/null +++ b/modules/fileio/help/ru_RU/path_filename/fileext.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="fileext"> + <refnamediv> + <refname>fileext</refname> + <refpurpose>возвращает расширение файла</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>extension = fileext(fullpath)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>fullpath</term> + <listitem> + <para>строковая матрица, указывающая путь до файла.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>extension</term> + <listitem> + <para>строковая матрица, часть, относящаяся к расширению; + может быть любой или <literal>''</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <code>extension = fileext(fullpath)</code> изымает из + символьной строки часть, относящуюся к расширению, включая точку. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +extension = fileext('SCI/etc/scilab.start') +extension = fileext(['SCI/etc/scilab.start';'SCI/etc/scilab.quit']) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="fileparts">fileparts</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/path_filename/fileparts.xml b/modules/fileio/help/ru_RU/path_filename/fileparts.xml new file mode 100755 index 000000000..f03c11c8e --- /dev/null +++ b/modules/fileio/help/ru_RU/path_filename/fileparts.xml @@ -0,0 +1,110 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Serge STEER + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="fileparts"> + <refnamediv> + <refname>fileparts</refname> + <refpurpose>возвращает путь, имя файла и расширение для указанного пути к файлу</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>[path, fname, extension] = fileparts(fullpath) + value = fileparts(fullpath, sel) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>fullpath</term> + <listitem> + <para>символьная строка, указанный путь к файлу</para> + </listitem> + </varlistentry> + <varlistentry> + <term>sel</term> + <listitem> + <para> + необязательная символьная строка: выбор с возможными значениями: + <literal>'path'</literal>, <literal>'fname'</literal> или <literal>'extension'</literal> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>path</term> + <listitem> + <para> + символьная строка; путь к директории, указанной в <varname>fullpath</varname>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>fname</term> + <listitem> + <para> + символьная строка; часть, относящаяся к имени файла, может быть + любой или <literal>''</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>extension</term> + <listitem> + <para> + символьная строка; часть, относящаяся к расширению, может + быть любой или <literal>''</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>value</term> + <listitem> + <para> + символьная строка в зависимости от значения <varname>sel</varname>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <code>[path, fname, extension] = fileparts(fullpath)</code> разделяет + символьную строку <varname>fullpath</varname> на три части: часть, + относящуюся к пути до директории, часть, относящуюся к имени файла и + часть, относящуюся к расширению, включая точку. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +[path,fname,extension]=fileparts('SCI/etc/scilab.start') +fileparts('SCI/etc/scilab.start','extension') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="pathconvert">pathconvert</link> + </member> + <member> + <link linkend="basename">basename</link> + </member> + <member> + <link linkend="fullfile">fullfile</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/path_filename/filesep.xml b/modules/fileio/help/ru_RU/path_filename/filesep.xml new file mode 100755 index 000000000..681a14706 --- /dev/null +++ b/modules/fileio/help/ru_RU/path_filename/filesep.xml @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="filesep"> + <refnamediv> + <refname>filesep</refname> + <refpurpose>возвращает разделитель директорий для текущей платформы</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>s = filesep()</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>s</term> + <listitem> + <para>строка</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>filesep</function> возвращает разделитель директорий (<literal>'/'</literal> в GNU/Linux или <literal>'\'</literal> в Windows). + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +filesep() + ]]></programlisting> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/path_filename/fullfile.xml b/modules/fileio/help/ru_RU/path_filename/fullfile.xml new file mode 100755 index 000000000..3c82fa232 --- /dev/null +++ b/modules/fileio/help/ru_RU/path_filename/fullfile.xml @@ -0,0 +1,75 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Vincent COUVERT + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="fullfile"> + <refnamediv> + <refname>fullfile</refname> + <refpurpose>формирует полное имя файла из частей</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>f = fullfile(varargin)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>varargin</term> + <listitem> + <para> + символьные строки, все директории и имена файлов, + используемые для формирования полного имени файла (хотя бы + одна директория и имя файла). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>f</term> + <listitem> + <para> + символьная строка или матрица строк, полное имя файла. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <code>f = fullfile(varargin)</code> формирует полное имя + файла учитывая платформу, на которой она работает и обрабатывает + случаи, когда директории начинаются или заканчиваются + разделителем директорий. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +f = fullfile("/home/", "\scilab", "macros", "\util", "fullfile.sci") +f = fullfile("C:", "\scilab", "macros", "\util", "fullfile.sci") +r = fullfile("/home/","\scilab","macros","\util", ["fullfile.sci";"toto.sci"]) +]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="pathconvert">pathconvert</link> + </member> + <member> + <link linkend="fileparts">fileparts</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/path_filename/fullpath.xml b/modules/fileio/help/ru_RU/path_filename/fullpath.xml new file mode 100755 index 000000000..abbc79d72 --- /dev/null +++ b/modules/fileio/help/ru_RU/path_filename/fullpath.xml @@ -0,0 +1,86 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * Copyright (C) 2011 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="fullpath"> + <refnamediv> + <refname>fullpath</refname> + <refpurpose> + создаёт имя полного пути для определённого имени относительного пути + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>res = fullpath(relative_path)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>res</term> + <listitem> + <para>строка или матрица строк, имя полного пути.</para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term>relative_path</term> + <listitem> + <para>строка или матрица строк, имя относительного пути.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <code>fullpath(relative_path)</code> создаёт имя полного + пути для определённого имени относительного пути + <varname>relative_path</varname>. + </para> + <para> + В GNU/Linux нужно, чтобы относительный путь + <varname>relative_path</varname> существовал. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +cd(TMPDIR); +mkdir(TMPDIR + "/niv1"); +mkdir(TMPDIR + "/niv1/niv2"); +mkdir(TMPDIR + "/niv1/niv2/niv3"); +mputl(' ', TMPDIR + "/niv1/test1.txt"); +mputl(' ' , TMPDIR + "/niv1/niv2/test2.txt"); + +cd(TMPDIR + "/niv1/niv2/niv3"); + +r1 = fullpath("../../test1.txt") +r2 = fullpath("../test2.txt") +M = ["../../test1.txt", "../test2.txt"]; +R = fullpath(M) + ]]></programlisting> + </refsection> + <refsection> + <title>История</title> + <revhistory> + <revision> + <revnumber>5.4.0</revnumber> + <revremark>Управление матрицей строк (SEP + 72) + </revremark> + </revision> + </revhistory> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/path_filename/get_absolute_file_path.xml b/modules/fileio/help/ru_RU/path_filename/get_absolute_file_path.xml new file mode 100755 index 000000000..12ed021f5 --- /dev/null +++ b/modules/fileio/help/ru_RU/path_filename/get_absolute_file_path.xml @@ -0,0 +1,86 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="get_absolute_file_path" xml:lang="ru"> + <refnamediv> + <refname>get_absolute_file_path</refname> + <refpurpose> + даёт имя абсолютного пути к файлу, открытому в Scilab'е + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>pathname = get_absolute_file_path(filename)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>filename</term> + <listitem> + <para>символьная строка: имя файла.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>pathname</term> + <listitem> + <para>символьная строка: имя абсолютного пути.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <function>get_absolute_file_path</function> даёт имя абсолютного пути к файлу <varname>filename</varname>, который уже открыт в Scilab'е. + </para> + <para> + <function>get_absolute_file_path</function> ищет во внутреннем списке + файлов Scilab'а открытый в данный момент файл <varname>filename</varname> + и возвращает его путь <varname>pathname</varname>. + </para> + <para>Если файл не открыт, то будет возвращена ошибка.</para> + <para> + <warning> + В предыдущих версиях (Scilab 5.0.x) возвращалась текущая директория, если файл не был найден. + </warning> + </para> + <para> + Эта функция может быть использована для определения того, откуда (путь) исполняется сценарий Scilab'а. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +// Выполните следующий сценарий + +a=mopen(TMPDIR+'test.sce','wt'); +disp(get_absolute_file_path('test.sce')); +mclose(a); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="getshortpathname">getshortpathname</link> + </member> + <member> + <link linkend="getlongpathname">getlongpathname</link> + </member> + <member> + <link linkend="pwd">pwd</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/path_filename/getdrives.xml b/modules/fileio/help/ru_RU/path_filename/getdrives.xml new file mode 100755 index 000000000..7cd07e41c --- /dev/null +++ b/modules/fileio/help/ru_RU/path_filename/getdrives.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="getdrives"> + <refnamediv> + <refname>getdrives</refname> + <refpurpose> + получает буквы дисков всех подключенных файловых систем на компьютере + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>drives = getdrives()</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>drives</term> + <listitem> + <para>матрица строк, диски.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>getdrives</function> получает буквы дисков всех + подключенных файловых систем на компьютере. + </para> + <para> + Функция <function>getdrives</function> возвращает корневые каталоги всех + файловых систем в виде матрицы строк. + </para> + <para> + Для GNU/Linux этот список состоит лишь из корневой директории, <literal>/</literal>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +getdrives() + ]]></programlisting> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/path_filename/getlongpathname.xml b/modules/fileio/help/ru_RU/path_filename/getlongpathname.xml new file mode 100755 index 000000000..ac23ae994 --- /dev/null +++ b/modules/fileio/help/ru_RU/path_filename/getlongpathname.xml @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="getlongpathname" xml:lang="ru"> + <refnamediv> + <refname>getlongpathname</refname> + <refpurpose>получает длинное имя пути (только для Windows)</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>longpath = getlongpathname(shortpath) + [longpath, bOK] = getlongpathname(shortpath) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>shortpath</term> + <listitem> + <para>символьная строка или матрица строк: короткое имя пути.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>longpath</term> + <listitem> + <para>символьная строка или матрица строк: длинное имя пути.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>bOK</term> + <listitem> + <para> + логическое значение или матрица логических значений: <constant>%T</constant>, если путь был преобразован, в противном случае -- <constant>%F</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Примитив <function>getlongpathname</function> преобразует указанное имя + пути <varname>shortpath</varname> в его длинную форму. Если не было + найдено длинного имени пути, то этот примитив возвращает указанное имя. + </para> + <para> + <note> + Примечание: если путь нельзя преобразовать (<varname>bOK</varname> равен <constant>%F</constant>), в особенности, если операционная система не Windows, то возвращаемый длинный путь идентичен входному краткому пути. + </note> + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +[longpath,bOK]=getlongpathname(SCI) +[longpaths,bOKs]=getlongpathname([SCI;SCI]) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="getshortpathname">getshortpathname</link> + </member> + <member> + <link linkend="getrelativefilename">getrelativefilehname</link> + </member> + <member> + <link linkend="pwd">pwd</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/path_filename/getrelativefilename.xml b/modules/fileio/help/ru_RU/path_filename/getrelativefilename.xml new file mode 100755 index 000000000..8da9a84a8 --- /dev/null +++ b/modules/fileio/help/ru_RU/path_filename/getrelativefilename.xml @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) XXXX-2008 - INRIA + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="getrelativefilename"> + <refnamediv> + <refname>getrelativefilename</refname> + <refpurpose> + для указанного имени полного пути к директории и абсолютного имени файла данная функция возвращает относительное имя файла + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>rel_file = getrelativefilename(abs_dir, abs_file)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>abs_dir</term> + <listitem> + <para>символьная строка: абсолютный путь к директории.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>abs_file</term> + <listitem> + <para>символьная строка: абсолютное имя файла.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>rel_file</term> + <listitem> + <para>символьная строка: относительное имя файла.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Для указанных абсолютного пути к директории <varname>abs_dir</varname> и абсолютного имени файла <varname>abs_file</varname>, функция <function>getrelativefilename</function> возвращает относительное имя файла <varname>rel_file</varname>. + </para> + <para> + Например, если текущая директория + <literal>C:\scilab\bin</literal>, а имя файла + <literal>C:\scilab\modules\helptools\readme.txt</literal>, то <function>getrelativefilename</function> возвратит + <literal>..\modules\helptools\readme.txt</literal>. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +getrelativefilename(pwd(), SCI+'/COPYING') +getrelativefilename(TMPDIR, SCI+'/COPYING') +getrelativefilename(SCI+'/bin', SCI+'/COPYING') +getrelativefilename(pwd(), SCI+'/ACKNOLEDGMENTS') +getrelativefilename(TMPDIR, SCI+'/ACKNOLEDGMENTS') +getrelativefilename(SCI+'/bin', SCI+'/ACKNOLEDGMENTS') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="getshortpathname">getshortpathname</link> + </member> + <member> + <link linkend="getlongpathname">getlongpathname</link> + </member> + <member> + <link linkend="pwd">pwd</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/path_filename/getshortpathname.xml b/modules/fileio/help/ru_RU/path_filename/getshortpathname.xml new file mode 100755 index 000000000..6cd68847b --- /dev/null +++ b/modules/fileio/help/ru_RU/path_filename/getshortpathname.xml @@ -0,0 +1,88 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="getshortpathname" xml:lang="ru"> + <refnamediv> + <refname>getshortpathname</refname> + <refpurpose>получает короткое имя (только для Windows)</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>shortpath=getshortgpathname(longpath) + [shortpath,bOK]=getshortpathname(longpath) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>longpath</term> + <listitem> + <para>символьная строка или матрица строк: длинное имя пути.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>shortpath</term> + <listitem> + <para> + символьная строка или матрица строк: короткое имя пути. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>bOK</term> + <listitem> + <para> + логическое значение или матрица логических значений: + <literal>%T</literal>, если путь был преобразован, в противном + случае -- <literal>%F</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Примитив <function>getshortpathname</function> преобразует указанное имя + пути <varname>longpath</varname> в его краткую форму. + </para> + <para> + <note> + Примечание: если путь нельзя преобразовать (<varname>bOK</varname> равен <constant>%F</constant>), в особенности, если операционная система не Windows, то возвращаемый короткий путь идентичен входному длинному пути. + </note> + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +[shortpath,bOK]=getshortpathname(SCI) +[shortpaths,bOKs]=getshortpathname([SCI;SCI]) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="getlongpathname">getlongpathname</link> + </member> + <member> + <link linkend="getrelativefilename">getrelativefilehname</link> + </member> + <member> + <link linkend="pwd">pwd</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/path_filename/is_absolute_path.xml b/modules/fileio/help/ru_RU/path_filename/is_absolute_path.xml new file mode 100755 index 000000000..175f82f2f --- /dev/null +++ b/modules/fileio/help/ru_RU/path_filename/is_absolute_path.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2013 - Scilab Enterprises - Charlotte HECQUET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="is_absolute_path"> + <refnamediv> + <refname>is_absolute_path</refname> + <refpurpose>проверяет, является ли аргумент абсолютным путём</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>r = is_absolute_path(path)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>path</term> + <listitem> + <para>символьная строка или матрица строк: путь до директории.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>r</term> + <listitem> + <para> + логическое значение: <constant>%t</constant>, если путь <varname>path</varname> является абсолютным. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <code>r = is_absolute_path(path)</code> проверяет, является ли путь <varname>path</varname> абсолютным. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +is_absolute_path(TMPDIR) +is_absolute_path("./scilab/modules/fileio") + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="get_absolute_file_path">get_absolute_file_path</link> + </member> + <member> + <link linkend="fileparts">fileparts</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ru_RU/path_filename/pathconvert.xml b/modules/fileio/help/ru_RU/path_filename/pathconvert.xml new file mode 100755 index 000000000..2602ba69b --- /dev/null +++ b/modules/fileio/help/ru_RU/path_filename/pathconvert.xml @@ -0,0 +1,150 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="pathconvert"> + <refnamediv> + <refname>pathconvert</refname> + <refpurpose>преобразование имён путей между POSIX и Windows.</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>paths = pathconvert(paths [,flagtrail [,flagexpand [,type]]])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>paths</term> + <listitem> + <para> + матрица строк, указывающая набор путей к файлам. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>flagtrail</term> + <listitem> + <para> + необязательное логическое значение, используемое для + добавления завершающего разделителя к путям (<literal>\</literal> + или <literal>/</literal> в зависимости от целевого формата пути). + Его значение по умолчанию равно <constant>%t</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>flagexpand</term> + <listitem> + <para> + необязательное логическое значение, используемое для составления + пути из переменных, идущих впереди. Его значение по умолчанию + ИСТИНА (<constant>%t</constant>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>type</term> + <listitem> + <para> + необязательное строковое значение, используемое для определения + целевого формата пути: <literal>'u'</literal> для формата пути + POSIX (GNU/Linux, ...) и <literal>'w'</literal> формата пути Windows. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>pathconvert</function> используется для преобразования + набора имён путей в формат, совместимый с операционной системой. Например, + стиль путей в Windows использует <literal>/</literal> для разделителей + файлов, в то время как в других операционных системах это <literal>\</literal>. + </para> + <para> + По умолчанию пути преобразуются в формат путей текущей операционной + системы (но можно определить и другой формат путей с помощью + аргумента <varname>type</varname>). + </para> + <para> + <note> + Заметьте: пути в Windows, начинающиеся с префикса буквы диска, + преобразуются в пути POSIX, используя соглашение cygwin (с + <literal>/cygdrive</literal>). Например: <literal>C:\tmp</literal> + будет преобразовано в <literal>/cygdrive/C/tmp</literal>. + </note> + </para> + <para> + <varname>flagtrail</varname> используется для добавления или удаления + разделителя файлов (в зависимости от целевого формата пути) к концу + путей. Когда этот параметр установлен в ИСТИНУ, то заключительный + разделитель файлов добавляется. В противном случае заключительный + разделитель удаляется. + </para> + <para> + <varname>flagexpand</varname> используется для развёртывания + переменных окружения Scilab'а, стоящих в путях впереди. + Принимаются следующие переменные: + <itemizedlist> + <listitem> + <constant>SCI</constant> + </listitem> + <listitem> + <constant>WSCI</constant> + </listitem> + <listitem> + <constant>SCIHOME</constant> + </listitem> + <listitem> + <constant>TMPDIR</constant> + </listitem> + <listitem> + <literal>home</literal> (или <literal>~</literal>) + </listitem> + </itemizedlist> + <caution> + <constant>WSCI</constant> не известна в GNU/Linux, а + <literal>~</literal> в значении "путь" неизвестна в + Windows. + </caution> + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +pathconvert("SCI/modules/foo", %f, %t, "w") +pathconvert("SCI\modules\foo", %f, %t, "u") +pathconvert("SCI\modules\foo", %t, %t, "u") +pathconvert("SCI/modules/foo", %f, %f, "w") +pathconvert("SCI/modules/foo", %t, %f, "w") +pathconvert("C:/tmp", %f, %f, "u") +pathconvert("/cygdrive/c/tmp", %f, %f, "w") + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="basename">basename</link> + </member> + <member> + <link linkend="listfiles">listfiles</link> + </member> + <member> + <link linkend="dirname">dirname</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/path_filename/pathsep.xml b/modules/fileio/help/ru_RU/path_filename/pathsep.xml new file mode 100755 index 000000000..e56f615d3 --- /dev/null +++ b/modules/fileio/help/ru_RU/path_filename/pathsep.xml @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA - Allan CORNET + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="pathsep"> + <refnamediv> + <refname>pathsep</refname> + <refpurpose>возвращает разделитель пути для текущей платформы</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>s = pathsep()</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>s</term> + <listitem> + <para>строковое значение</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + <function>pathsep</function> возвращает разделитель пути (<literal>':'</literal> в GNU/Linux или <literal>';'</literal> в Windows). + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ +pathsep() +]]></programlisting> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/path_filename/tempname.xml b/modules/fileio/help/ru_RU/path_filename/tempname.xml new file mode 100755 index 000000000..4abd9950f --- /dev/null +++ b/modules/fileio/help/ru_RU/path_filename/tempname.xml @@ -0,0 +1,78 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2011 - DIGITEO - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="tempname"> + <refnamediv> + <refname>tempname</refname> + <refpurpose> + создаёт файл с уникальным именем + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>tmp_name = tempname([prefix])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>tmp_name</term> + <listitem> + <para>строка: имя файла</para> + </listitem> + </varlistentry> + </variablelist> + <variablelist> + <varlistentry> + <term>prefix</term> + <listitem> + <para> + строка: префикс имени файла (в Windows максимум 3 символа). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>tempname</function> создаёт файл с уникальным + именем в директории <literal>TMPDIR</literal>. + </para> + <para> + <code>tmp_name = tempname()</code> возвращает уникальную строку, + <varname>tmp_name</varname>, подходящую для использования в + качестве временного файла. + </para> + </refsection> + <refsection> + <title>Примеры</title> + <programlisting role="example"><![CDATA[ + F1 = tempname() + isfile(F1) + F2 = tempname('TMP') + isfile(F2) + ]]></programlisting> + </refsection> + <refsection> + <title>История</title> + <revhistory> + <revision> + <revnumber>5.4.0</revnumber> + <revremark> + Введена функция <function>tempname</function>. + </revremark> + </revision> + </revhistory> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/save_format.xml b/modules/fileio/help/ru_RU/save_format.xml new file mode 100755 index 000000000..e42ba90d3 --- /dev/null +++ b/modules/fileio/help/ru_RU/save_format.xml @@ -0,0 +1,892 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * +--> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="save_format" xml:lang="ru"> + <refnamediv> + <refname>save format</refname> + <refpurpose>формат файлов, полученных с помощью функции "save"</refpurpose> + </refnamediv> + <refsection> + <title>Аннотация</title> + <para> + Целью данного документа является определения формата HDF5, + используемого Scilab'ом для хранения своих данных. + </para> + <para> + Этот формат называется SOD от английского Scilab Open Data + ("открытые данные Scilab'а"). + </para> + <para> + Первый публичный релиз SOD был сделан в Scilab 5.4.0. + </para> + </refsection> + <refsection> + <title>Основная причина</title> + <para> + Интероперабельность является одним из ключевых аспектов + современного программного обеспечения. Для того, чтобы + больше и больше улучшать этот аспект был предложено + стандартное определение формата HDF5. + </para> + <para> + Со времён Scilab 5.2.0 была разработана возможность + экспорта/импорта, которая используется для обмена данными. + Это уже один из основных компонентов Xcos для хранения и + обмена данными. + </para> + </refsection> + <refsection> + <title>Поддерживаемые типы данных</title> + <para> + Поддерживаются все типы данных Scilab'а. Например: + </para> + <informaltable border="1"> + <tbody> + <tr> + <td> + <emphasis role="bold">Имя</emphasis> + </td> + <td> + <emphasis role="bold">Пример в Scilab'е</emphasis> + </td> + </tr> + <tr> + <td> + <emphasis role="bold">double</emphasis> + </td> + <programlisting> + A=32; + b=[32,2]; + c=[2,2;3,4]; + d=rand(10,10); + </programlisting> + </tr> + <tr> + <td> + <emphasis role="bold">string</emphasis> + </td> + <programlisting> + a="my string"; + b=["string 1";"my string 2"]; + </programlisting> + </tr> + <tr> + <td> + <emphasis role="bold">boolean</emphasis> + </td> + <programlisting> + a=%t; + b=[%t, %f]; + </programlisting> + </tr> + <tr> + <td> + <emphasis role="bold">integer</emphasis> + </td> + <td> + <programlisting> + int8([1 -120 127 312]) + x=int32(-200:100:400) + </programlisting> + </td> + </tr> + <tr> + <td> + <emphasis role="bold">polynomial</emphasis> + </td> + <td> + <programlisting> + s=poly([2 3],"s") + poly(1:4,'s','c') + </programlisting> + </td> + </tr> + <tr> + <td> + <emphasis role="bold">sparse</emphasis> + </td> + <td align="justify"> + <programlisting> + sp=sparse([1,2;4,5;3,10],[1,2,3]) + </programlisting> + </td> + </tr> + <tr> + <td> + <emphasis role="bold">boolean sparse</emphasis> + </td> + <td align="justify"> + <programlisting> + dense=[%F, %F, %T, %F, %F + %T, %F, %F, %F, %F + %F, %F, %F, %F, %F + %F, %F, %F, %F, %T]; + sp=sparse(dense) + </programlisting> + </td> + </tr> + <tr> + <td> + <emphasis role="bold">list</emphasis> + </td> + <td align="justify"> + <programlisting> + l = list(1,["a" "b"]) + </programlisting> + </td> + </tr> + <tr> + <td> + <emphasis role="bold">tlist</emphasis> + </td> + <td align="justify"> + <programlisting> + t = tlist(["listtype","field1","field2"], [], []); + </programlisting> + </td> + </tr> + <tr> + <td> + <emphasis role="bold">mlist</emphasis> + </td> + <td align="justify"> + <programlisting> + M=mlist(['V','name','value'],['a','b';'c' 'd'],[1 2; 3 4]); + </programlisting> + </td> + </tr> + </tbody> + </informaltable> + <para> + Несколько "типов" основаны на <emphasis>tlist</emphasis> или + <emphasis>mlist</emphasis>. Это <emphasis>rational</emphasis>, + <emphasis>state-space</emphasis>, <emphasis>hypermat</emphasis>, + <emphasis>cell</emphasis> и <emphasis>struct</emphasis>. + Следовательно, они явно сохраняются. + </para> + <para> + <emphasis>void</emphasis> и <emphasis>undefined</emphasis> - + это два особых элемента, созданных для управления особыми + случаями в управлении списками. Они описаны ниже. + </para> + </refsection> + <refsection> + <title>Структура файла HDF5</title> + <para> + Архитектура HDF5 Scilab'а довольно проста. + </para> + <emphasis role="bold">Основные сведения</emphasis> + <para> + Для каждой переменной Scilab'а декларируется набор данных в + корне. Имя набора данных - это имя переменной Scilab'а. + </para> + <para> + Например, следующий код: + </para> + <programlisting> + emptyuint32matrix = uint32([]); + uint32scalar = uint32(1); + uint32rowvector = uint32([1 4 7]); + uint32colvector = uint32([1;4;7]); + uint32matrix = uint32([1 4 7;9 6 3]); + save("uint32.sod","emptyuint32matrix","uint32scalar","uint32rowvector","uint32colvector","uint32matrix"); + </programlisting> + <para>формирует:</para> + <mediaobject> + <imageobject> + <imagedata fileref="../images/img001.png" width="5.95cm" depth="1.64cm"/> + </imageobject> + </mediaobject> + <para> + Каждый корневой набор данных имеет атрибут, именуемый + <literal>SCILAB_Class</literal>. Этот атрибут определяет + какие типы переменных хранятся в HDF5-файле. + </para> + <para> + Если переменная является основным типом и без связанных с + ним комплексных значений, то данные сохраняются + непосредственно в набор данных. В противном случае, набор + данных содержит ссылки на фактические данные. + </para> + <para> + Каждый SOD-файл содержит две особые переменные: + </para> + <itemizedlist> + <listitem> + <para> + <literal>SCILAB_scilab_version</literal> - описывает + какая версия Scilab'а использовалась для сохранения + SOD-файла. + </para> + <para> + Например, для Scilab 5.4.0 эти данные будут иметь вид: + </para> + <para> + <emphasis>SCILAB_scilab_version = scilab-5.4.0</emphasis> + </para> + </listitem> + <listitem> + <para> + <literal>SCILAB_sod_version</literal> - описывает + какая версия спецификации SOD использовалась для + сохранения файла. + </para> + <para> + Например, для Scilab 5.4.0 эти данные будут иметь вид: + </para> + <para> + <emphasis>SCILAB_sod_version = 2</emphasis> + </para> + </listitem> + </itemizedlist> + <para> + Типы, данные которых сохраняются непосредственно в набор + данных. + </para> + <informaltable border="1"> + <tbody> + <tr> + <td align="left"> + <emphasis role="bold">Тип Scilab'а</emphasis> + </td> + <td align="left"> + <emphasis role="bold">Атрибут HDF5 типа Scilab'а</emphasis> + </td> + <td align="left"> + <emphasis role="bold">Атрибуты HDF5</emphasis> + </td> + <td align="left"> + <emphasis role="bold">Расположение типов данных HDF</emphasis> + </td> + </tr> + <tr> + <td align="left"> + <para>string</para> + </td> + <td align="left"> + <para>SCILAB_Class = string</para> + </td> + <td align="left"> + + </td> + <td align="left"> + <para>строковое значение</para> + </td> + </tr> + <tr> + <td align="left"> + <para>boolean</para> + </td> + <td namest="c2" nameend="c3" align="left"> + <para>SCILAB_Class = boolean</para> + </td> + <td align="left"> + + </td> + <td align="left"> + <para>32-битное целое число</para> + </td> + </tr> + <tr> + <td align="left"> + <para>integer</para> + </td> + <td namest="c2" nameend="c3" align="left"> + <para>SCILAB_Class = integer</para> + </td> + <td align="left"> + <para>SCILAB_precision = {8, 16, 32, u8, u16, u32}</para> + </td> + <td namest="c1" nameend="c2" align="left"> + <para>8 = 8-битный символ</para> + <para>16 = 16-битное целое число</para> + <para>32 = 32-битное целое число</para> + <para>u8 = 8-битное целое беззнаковое число</para> + <para>u16 = 16-битное целое беззнаковое число</para> + <para>u32 = 32-битное целое беззнаковое число</para> + </td> + </tr> + </tbody> + </informaltable> + <para> + Для этих типов, как в Scilab'е, данные хранятся в одномерном + массиве. Данные сохраняются столбец на столбцом. + </para> + <para> + Для восстановления матрицы, вектора или скаляра, два + атрибута дают количество столбцов и строк. + </para> + <para> + Начиная с релиза 5.4.0 Scilab'а и SOD v2, <literal>SCILAB_cols</literal> и + <literal>SCILAB_rows</literal> больше не используются для + матриц типа double, integer, polynomial и string. SOD + использует родную многомерную возможность HDF5. + </para> + <para> + <emphasis role="bold">Пример</emphasis> + </para> + <para> + Сохранение декларации: <code>int32([1 -4 7;-9 6 -3])</code> + будет отображено как: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="../images/img002.png" width="5.95cm" depth="1.64cm"/> + </imageobject> + </mediaobject> + <para>в hdfview.</para> + <para>А метаданные будут отображены как:</para> + <emphasis role="italic"> + <para>int32matrix (800, 2)</para> + <para>32-bit integer, 3 x 2 => размер переменной</para> + <para>Number of attributes = 2</para> + <para>SCILAB_Class = integer</para> + <para>SCILAB_precision = 32</para> + </emphasis> + <para> + <note> + Скалярное значение хранится в виде матрицы размером 1 на 1. + </note> + </para> + <para> + Пустая переменная (<literal>[]</literal>) будет иметь + атрибут <literal>SCILAB_empty</literal>, установленный в + значение ИСТИНА. + </para> + <para> + <emphasis role="bold">Типы, в которых данные хранятся в + соответствующей группе + </emphasis> + </para> + <para> + Многие типы данных Scilab'а хранятся с помощью групп. Это + позволяет не только явно разделять значения, но и иметь + лёгкий доступ к ним. + </para> + <para> + Группы именуются по переменным, заключённым в знак "#". + Например, для матрицы значений типа double, названной + matrixofdouble, имя корневого набора данных будет + matrixofdouble, имя связанной с ней группы будет <emphasis + role="strong">#matrixofdouble#</emphasis>. + </para> + <para> + Для рекурсивного типа данных (list, mlist, tlist и т. д.) + имена подгрупп построены следующим образом: + </para> + <para> + Знак <literal>#</literal> позволяет создавать уникальный + идентификатор. Количество начальных знаков + <literal>#</literal> показывает уровень глубины. + Следовательно подсписок + <emphasis>###listnested#_#2##_#1##</emphasis> будет + указывать, что он помещён на второй уровень. + </para> + <para> + Символ подчёркивания "_" является способом представить + глубину. Обычно в таких случаях используется символ "/", но + это зарезервированное ключевое слово в спецификации HDF5. + </para> + <para> + Целые числа, используемые в названии, показывают положение в + структуре данных, оба в терминах положения в текущей + структуре, но также относительно родительского элемента. В + примере <emphasis>###listnested#_#2##_#1##</emphasis>, 1 + показывает, что мы имеем дело со вторым элементом третьей + структуры главного элемента (элементы индексируются начиная + с 0). + </para> + <para> + В следующем примере, группа, названная + <emphasis>###listnested#_#2##_#1##</emphasis>, + будет указывать на значение [32, 42]: + </para> + <programlisting> + listnested=list(2,%i,'f',ones(3,3)) + listnested(3) = list( %t, [32,42]); + </programlisting> + <para> + <emphasis role="bold">Разрежённая матрица</emphasis> + </para> + <para> + <emphasis role="strong">Тип Scilab'а:</emphasis> sparse + </para> + <para> + <emphasis role="strong">атрибут HDF5 типа + Scilab'а: + </emphasis> + SCILAB_Class = sparse + </para> + <para> + <emphasis role="strong">атрибуты HDF5: </emphasis> + </para> + <para>SCILAB_rows = <int></para> + <para>Количество строк</para> + <para> + <emphasis>SCILAB_cols = <int></emphasis> + </para> + <para>Количество столбцов</para> + <para> + <emphasis>SCILAB_items = <int></emphasis> + </para> + <para> + Определение количества элементов разрежённой матрице + </para> + <para> + <emphasis role="strong">Значения корневого набора данных:</emphasis> + </para> + <para> + Первое значение (<literal>#0#</literal>): каждый элемент из + этой структуры данных показывает количество ненулевых + элементов на строку. Следовательно, первый элемент + показывает количество элементов в первой строке разрежённой + матрицы. + </para> + <para> + Второе значение (<literal>#1#</literal>): указывает + положение столбца каждого элемента разрежённой матрицы. + </para> + <para> + Третье значение (<literal>#2#</literal>): хранит ссылку на + фактические значения элементов в разрежённой матрице (каждое + будет сохранено в особой группе). + </para> + <para>Например, взяв такую матрицу:</para> + <programlisting role="no-scilab-exec"> + 0. 1. 0. 0. 0. 0. 0. 0. 0. 0. + 0. 0. 0. 0. 0. 0. 0. 0. 0. 0. + 0. 0. 0. 0. 0. 0. 0. 0. 0. 3. + 0. 0. 0. 0. 2. 0. 0. 0. 0. 0. + </programlisting> + <para>которая формируется функцией:</para> + <programlisting role="scilab_code"> + sparse([1,2;4,5;3,10],[1,2,3]) + </programlisting> + <para> + будем иметь: + </para> + <para> + <emphasis>#0#</emphasis> содержит <emphasis>1;0;1;1</emphasis> + </para> + <para> + <emphasis>#1#</emphasis> содержит <emphasis>2;10;5</emphasis> + </para> + <para> + <emphasis>#2#</emphasis> обращается к матрице чисел типа + double (в этом примере они не комплексные), которая содержит + <emphasis>1.0; 3.0; 2.0</emphasis>. + </para> + <para> + <emphasis role="bold">Разрежённая матрица логических значений</emphasis> + </para> + <para> + <emphasis role="strong">Тип Scilab'а:</emphasis> boolean sparse + </para> + <para> + <emphasis role="strong">атрибут HDF5 типа Scilab'а:</emphasis> SCILAB_Class = boolean sparse + </para> + <para> + <emphasis>атрибуты HDF5:</emphasis> + </para> + <para> + <emphasis>SCILAB_rows = <int></emphasis> + </para> + <para>Количество строк</para> + <para> + <emphasis>SCILAB_cols = <int></emphasis> + </para> + <para>Количество столбцов</para> + <para> + <emphasis>SCILAB_items = <int></emphasis> + </para> + <para> + Определение количества элементов в разрежённой матрице + </para> + <para> + <emphasis role="strong">Значения корневого набора + данных: + </emphasis> + в то время как разрежённая матрица имеет + 3 набора данных, разрежённая матрица логических значений + имеет только 2, поскольку определяемые значения + автоматически рассматриваются как истинные. + </para> + <para> + Первое значение (<literal>#0#</literal>): каждый элемент + этой структуры данных показывает количество ненулевых + элементов в строке. + </para> + <para> + Следовательно, первый элемент показывает количество + элементов в первой строке разрежённой матрицы. + </para> + <para> + Второе значение (<literal>#1#</literal>): указывает + положение столбца каждого из элементов разрежённой матрицы. + </para> + <para>В разрежённой матрице логических значений:</para> + <programlisting> + dense=[%F, %F, %T, %F, %F + %T, %F, %F, %F, %F + %F, %F, %F, %F, %F + %F, %F, %F, %F, %T]; + </programlisting> + <para> + <emphasis>#0#</emphasis> содержит <emphasis>1;1;0;1</emphasis>. + </para> + <para> + <emphasis>#1#</emphasis> содержит <emphasis>3;1;5</emphasis>. + </para> + <para> + Для восстановления разрежённой матрицы логических значений + требуется только два значения. + </para> + <para> + <emphasis role="bold">Расположение типов данных + HDF + </emphasis> + :32-битное целое + </para> + <para> + <emphasis role="bold">Числа удвоенной точности</emphasis> + </para> + <para> + <emphasis role="strong">Тип Scilab'а:</emphasis> double + </para> + <para> + <emphasis role="strong">атрибут HDF5 типа Scilab'а:</emphasis> SCILAB_Class = double + </para> + <para> + <emphasis role="strong">Значения корневого набора данных:</emphasis> + </para> + <para> + Как вещественные так и комплексные значения хранятся в + группе, именуемой <literal>#<имя переменной>#</literal>. + </para> + <para> + Первое значение: ссылка на вещественные значения. Названо + <literal>#0#</literal>. + </para> + <para> + Если матрица комплексная, то второе значение будет ссылаться + на комплексные значения. Названо <literal>#1#</literal>. + </para> + <para> + <emphasis role="bold">Расположение типов данных + HDF + </emphasis> + 64-битное с плавающей запятой + </para> + <para> + <emphasis role="bold">Полином</emphasis> + </para> + <para> + <emphasis role="strong">Тип Scilab'а:</emphasis> polynomial + </para> + <para> + <emphasis role="strong">атрибут HDF5 типа + Scilab'а: + </emphasis> + SCILAB_Class = polynomial + </para> + <para> + <emphasis role="strong">атрибуты HDF5: </emphasis> + </para> + <para>SCILAB_Class = polynomial</para> + <para>SCILAB_varname = <string></para> + <para>Имя символьной переменной</para> + <para> + <emphasis>SCILAB_Complex = <boolean></emphasis> + </para> + <para> + Если полином комплексный (не устанавливается, если ложь). + </para> + <para> + <emphasis role="strong">Значения корневого набора + данных: + </emphasis> + </para> + <para> + Коэффициенты хранятся в виде матрицы чисел удвоенной + точности (сравни соответствующий раздел, посвящённый + хранению чисел удвоенной точности). Интересно отметить, что + коэффициенты могут быть комплексными и, следовательно, могут + храниться в виде матрицы комплексных значений. Правила + наименования (под-)групп и набора данных описаны в начале + этого раздела. + </para> + <para> + <emphasis role="bold">Расположение типов данных HDF</emphasis> ссылка на объект + </para> + <para> + <emphasis role="bold">Список</emphasis> + </para> + <para> + <emphasis role="strong">Тип Scilab'а:</emphasis> list + </para> + <para> + <emphasis role="strong">атрибут HDF5 типа Scilab'а:</emphasis> + </para> + <para>SCILAB_Class = list</para> + <para> + <emphasis role="strong">атрибуты HDF5:</emphasis> + SCILAB_items = <количество пунктов в списке> + </para> + <para> + <emphasis role="strong">Значения корневого набора данных:</emphasis> + </para> + <para> + Привязанные к корневому набору данных значения хранятся в + этом наборе и являются ссылками на значения, хранимые в + списке. Значения хранятся в группе, названной + <literal>#<имя переменной>#</literal>. В группе + <literal>#<имя переменной>#</literal> данные могут + быть любого типа. Они прямо включены в группу. Их + представления те же самые, что и в других случаях, + основанных на рекурсивной структуре (имеется в виду, что + можно сохранить и загрузить список списка списка различных + типов). + </para> + <para> + Правила наименования (под-)групп и набора данных описаны в + начале этого раздела. + </para> + <para> + <emphasis role="bold">Расположение типов данных HDF</emphasis> ссылка на объект + </para> + <para> + <emphasis role="bold">Типизированный список</emphasis> + </para> + <para> + <emphasis role="strong">Тип Scilab'а:</emphasis> tlist + </para> + <para> + <emphasis role="strong">атрибут HDF5 типа Scilab'а:</emphasis> + </para> + <para> SCILAB_Class = tlist</para> + <para> + <emphasis role="strong">атрибуты HDF5:</emphasis> см. список + </para> + <para> + <emphasis role="bold">матричноориентированный список</emphasis> + </para> + <para> + <emphasis role="strong">Тип Scilab'а:</emphasis> mlist + </para> + <para> + <emphasis role="strong">атрибут HDF5 типа Scilab'а:</emphasis> + </para> + <para>SCILAB_Class = mlist</para> + <para> + <emphasis role="strong">атрибуты HDF5:</emphasis> см. список + </para> + <para> + <emphasis role="bold">Пустое значение</emphasis> + </para> + <para> + <emphasis role="strong">Тип Scilab'а:</emphasis> void + </para> + <para> + <emphasis role="strong">атрибут HDF5 типа Scilab'а:</emphasis> + </para> + <para>SCILAB_Class = void</para> + <para> + Пустое значение можно найти только в очень особых случаях + использования списков, типизированных списков и + матричноориентированных списков. Оно может быть создано с + помощью следующего синтаксиса: + </para> + <programlisting>voidelement_ref=list(1,,3);</programlisting> + <para> + <emphasis role="bold">Неопределённое значение</emphasis> + </para> + <para> + <emphasis role="strong">Тип Scilab'а:</emphasis> undefined + </para> + <para> + <emphasis role="strong">атрибут HDF5 типа Scilab'а:</emphasis> + </para> + <para> SCILAB_Class = undefined</para> + <para> + Неопределённое значение формируется, когда размер списка + увеличивается, а некоторые элементы не определены. Они будут + сформированы с помощью следующего синтаксиса: + </para> + <programlisting> + undefinedelement_ref=list(2,%i,'f',ones(3,3)); + undefinedelement_ref(6)="toto" + </programlisting> + </refsection> + <refsection> + <title>Примеры из жизни</title> + <para> + Файлы с образцами всех этих переменных прилагаются к + дистрибутиву Scilab'а. Они лежат в директории: + <emphasis>SCI/modules/hdf5/tests/sample_scilab_data/</emphasis> + </para> + <para> + На момент редактирования этого документа были приложены + следующие файлы: + </para> + <emphasis role="italic"> + <para> + booleanmatrix.sod + </para> + <para>booleanscalar.sod + </para> + <para>booleansparse.sod + </para> + <para>emptymatrix.sod + </para> + <para>emptysparse.sod + </para> + <para>hypermatrixcomplex.sod + </para> + <para>hypermatrix.sod + </para> + <para>int16.sod + </para> + <para>int32.sod + </para> + <para>int8.sod + </para> + <para>listnested.sod + </para> + <para>list.sod + </para> + <para>matricedoublecomplexscalar.sod + </para> + <para>matricedoublecomplex.sod + </para> + <para>matricedoublescalar.sod + </para> + <para>matricedouble.sod + </para> + <para>matricestringscalar.sod + </para> + <para>matricestring.sod + </para> + <para>mlist.sod + </para> + <para>polynomialscoef.sod + </para> + <para>polynomials.sod + </para> + <para>sparsematrix.sod + </para> + <para>tlist.sod + </para> + <para>uint16.sod + </para> + <para>uint32.sod + </para> + <para>uint8.sod + </para> + <para>undefinedelement.sod + </para> + <para>voidelement.sod + </para> + </emphasis> + </refsection> + <refsection> + <title>История развития формата</title> + <informaltable border="1"> + <tbody> + <tr> + <td align="justify"> + <emphasis role="bold">Версия SOD</emphasis> + </td> + <td align="justify"> + <emphasis role="bold">Версия Scilab'а</emphasis> + </td> + <td align="justify"> + <emphasis role="bold">Описание</emphasis> + </td> + </tr> + <tr> + <td align="justify"> + <para>0</para> + </td> + <td align="justify"> + <para>5.2.0</para> + </td> + <td align="justify"> + <para>Начальная версия формата Scilab/HDF5</para> + </td> + </tr> + <tr> + <td align="justify"> + <para>1</para> + </td> + <td align="justify"> + <para>5.4.0 alpha / beta</para> + </td> + <td align="left"> + <para> + Формат по умолчанию для загрузки и сохранения. + </para> + <para> + Предыдущий формат (.bin) по-прежнему поддерживается. + </para> + </td> + </tr> + <tr> + <td> + <para>2</para> + </td> + <td> + <para>5.4.0</para> + </td> + <td> + <para> + Для матриц значений тип double, integer, polynomial и string + <emphasis>SCILAB_cols</emphasis> / <emphasis>SCILAB_rows</emphasis> были + удалены, чтобы использовать многомерные HDF5. + </para> + </td> + </tr> + <tr> + <td align="justify"> + + </td> + <td align="justify"> + <para>6.0.0 (будущая)</para> + </td> + <td align="justify"> + <para>.bin не поддерживается.</para> + </td> + </tr> + </tbody> + </informaltable> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="save">save</link> + </member> + <member> + <link linkend="load">load</link> + </member> + <member> + <link linkend="listvarinfile">listvarinfile</link> + </member> + <member> + <link linkend="type">type</link> + </member> + <member> + <link linkend="typeof">typeof</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/fileio/help/ru_RU/scanf.xml b/modules/fileio/help/ru_RU/scanf.xml new file mode 100755 index 000000000..ca7d90ef7 --- /dev/null +++ b/modules/fileio/help/ru_RU/scanf.xml @@ -0,0 +1,79 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- +* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +* Copyright (C) 2008 - INRIA +* ... +* +* This file must be used under the terms of the CeCILL. +* This source file is licensed as described in the file COPYING, which +* you should have received as part of this distribution. The terms +* are also available at +* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +* + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="scanf"> + <refnamediv> + <refname>scanf</refname> + <refpurpose>преобразует форматированный ввод в стандартном устройстве ввода</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Последовательность вызова</title> + <synopsis>[v_1, ..., v_n] = scanf(format);</synopsis> + </refsynopsisdiv> + <refsection> + <title>Аргументы</title> + <variablelist> + <varlistentry> + <term>format</term> + <listitem> + <para>указывает преобразование формата.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>v_1, ..., v_n</term> + <listitem> + <para>результаты преобразования.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Описание</title> + <para> + Функция <function>scanf</function> получает символьные данные в стандартном устройстве ввода (<code>%io(1)</code>), интерпретирует их в соответствии с форматом <varname>format</varname> и возвращает преобразованные результаты <varname>v_1</varname>, ..., <varname>v_n</varname>. + </para> + <para> + Параметр <varname>format</varname> содержит спецификации преобразования, используемые для интерпретации ввода. + </para> + <para> + Параметр <varname>format</varname> может содержать символы пробелов (пробелы, табуляторы, символы перевода строки и прогона страницы), которые, за исключением двух следующих случаев, считывают ввод до следующего символа-непробела. За исключением совпадения с управляющей строкой, завершающие пробелы (включая символы новой строки) не считываются. + </para> + <itemizedlist> + <listitem> + <para> + Любой символ, за исключением <literal>%</literal> (знак "процент"), который должен соответствовать следующему символу входного потока. + </para> + </listitem> + <listitem> + <para> + Спецификация преобразования, которая направляет преобразование следующего входного поля. См. подробности в <link linkend="scanf_conversion">преобразовании scanf</link>. + </para> + </listitem> + </itemizedlist> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="read">read</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="scanf_conversion">преобразование scanf</link> + </member> + </simplelist> + </refsection> +</refentry> + diff --git a/modules/fileio/help/ru_RU/scanf_conversion.xml b/modules/fileio/help/ru_RU/scanf_conversion.xml new file mode 100755 index 000000000..0b2ca33f4 --- /dev/null +++ b/modules/fileio/help/ru_RU/scanf_conversion.xml @@ -0,0 +1,158 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2008 - INRIA + * ... + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<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" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="scanf_conversion"> + <refnamediv> + <refname>преобразование scanf</refname> + <refpurpose> + спецификации преобразования mscanf, msscanf, mfscanf + </refpurpose> + </refnamediv> + <refsection> + <title>Описание</title> + <para> + Каждая спецификация преобразования в параметре <varname>format</varname> содержит следующие элементы: + </para> + <itemizedlist> + <listitem> + <para> + символ <literal>%</literal> (знак "процент"); + </para> + </listitem> + <listitem> + <para> + необязательный символ подавления присвоения <literal>*</literal> ("звёздочка"); + </para> + </listitem> + <listitem> + <para> + необязательное числовое значение максимальной ширины поля; + </para> + </listitem> + <listitem> + <para> + код преобразования. + </para> + </listitem> + </itemizedlist> + <para> + Спецификация преобразования имеет следующий синтаксис: + </para> + <para> + <literal>[*][ширина][размер]код_преобразования</literal>. + </para> + <para> + Результаты преобразования помещаются в аргументы <varname>v_i</varname> если вы не укажете подавление присвоения с помощью символа <literal>*</literal> ("звёздочка"). Подавления присвоения предоставляет способ описать входное поле, которое следует пропустить. Входное поле является строкой символов-непробелов. Оно простирается до ближайшего некорректного символа или до тех пор, пока ширина поля, если она указана, не кончится. + </para> + <para> + Код преобразования указывает как интерпретировать входное поле. Вам не нужно указывать параметр <varname>v_i</varname> для подавленного поля. Вы можете использовать следующие коды преобразования: + </para> + <variablelist> + <varlistentry> + <term>%</term> + <listitem> + <para> + принимает отдельный символ <literal>%</literal> (знак "процент"), вводимый в этом месте; присвоение не делается. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>d, i</term> + <listitem> + <para>принимает десятичное целое число.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>u</term> + <listitem> + <para>принимает беззнаковое десятичное целое число.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>o</term> + <listitem> + <para>принимает восьмеричное целое число.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>x</term> + <listitem> + <para>принимает шестнадцатеричное целое число.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>e, f, g</term> + <listitem> + <para> + принимает число с плавающей запятой. Следующее поле преобразуется соответствующим образом и сохраняется через соответствующий параметр, который должен быть указателем на число с плавающей запятой. Формат ввода для чисел с плавающей запятой является строкой цифр со следующими необязательными характеристиками: + </para> + <itemizedlist> + <listitem> + <para> + это может быть значение со знаком; + </para> + </listitem> + <listitem> + <para> + это может быть экспоненциальное значение, содержащее десятичную запятую, за которой следует экспоненциальное поле, которое состоит из <literal>E</literal> или <literal>e</literal>, за которым следует целое число (может быть со знаком); + </para> + </listitem> + <listitem> + <para> + это может быть одно из специальных значений <constant>%inf</constant>, <constant>%nan</constant>. + </para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + <varlistentry> + <term>s</term> + <listitem> + <para>принимает строку символов;</para> + </listitem> + </varlistentry> + <varlistentry> + <term>c</term> + <listitem> + <para> + ожидается символьное значение. Нормальный пропуск пробела подавляется. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>%lg</term> + <listitem> + <para>получает значение в виде числа удвоенной точности (double).</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection role="see also"> + <title>Смотрите также</title> + <simplelist type="inline"> + <member> + <link linkend="msscanf">msscanf</link> + </member> + <member> + <link linkend="mfscanf">mfscanf</link> + </member> + <member> + <link linkend="mscanf">mscanf</link> + </member> + <member> + <link linkend="printf_conversion">преобразование printf</link> + </member> + </simplelist> + </refsection> +</refentry> + |
