← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/fileio/help/en_US/fprintf.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/fileio/help/en_US/fprintf.xml
12
12
 *
13
13
 -->
14
14
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="fprintf">
15
 
  <refnamediv>
16
 
    <refname>fprintf</refname>
17
 
    <refpurpose>
18
 
      Emulator of C language fprintf function. <emphasis>This function
19
 
        is obsolete
20
 
      </emphasis>
21
 
    </refpurpose>
22
 
  </refnamediv>
23
 
  <refsynopsisdiv>
24
 
    <title>Calling Sequence</title>
25
 
    <synopsis>fprintf(file,format,value_1,..,value_n)</synopsis>
26
 
  </refsynopsisdiv>
27
 
  <refsection>
28
 
    <title>Arguments</title>
29
 
    <variablelist>
30
 
      <varlistentry>
31
 
        <term>format</term>
32
 
        <listitem>
33
 
          <para>a Scilab string. It specifies a character string combining literal characters with conversion specifications.</para>
34
 
        </listitem>
35
 
      </varlistentry>
36
 
      <varlistentry>
37
 
        <term>value_i</term>
38
 
        <listitem>
39
 
          <para>
40
 
            specifies the data to be converted according to the <varname>format</varname> parameter.
41
 
          </para>
42
 
        </listitem>
43
 
      </varlistentry>
44
 
      <varlistentry>
45
 
        <term>file</term>
46
 
        <listitem>
47
 
          <para>
48
 
            a Scilab string specifying a file name or a logical unit number (see<link linkend="file">file</link>)
49
 
          </para>
50
 
          <para>
51
 
            Note that if <varname>file</varname>=0, the message will be display on standard error stream (stderr).
52
 
          </para>
53
 
        </listitem>
54
 
      </varlistentry>
55
 
    </variablelist>
56
 
  </refsection>
57
 
  <refsection>
58
 
    <title>Description</title>
59
 
    <para>
60
 
      <caution>
61
 
        This function is obsolete, use preferabily the <link
 
15
    <refnamediv>
 
16
        <refname>fprintf</refname>
 
17
        <refpurpose>
 
18
            Emulator of C language fprintf function. <emphasis role="bold">This function is obsolete.</emphasis>
 
19
        </refpurpose>
 
20
    </refnamediv>
 
21
    <refsynopsisdiv>
 
22
        <title>Calling Sequence</title>
 
23
        <synopsis>fprintf(file, format, value_1, ..., value_n)</synopsis>
 
24
    </refsynopsisdiv>
 
25
    <refsection>
 
26
        <title>Arguments</title>
 
27
        <variablelist>
 
28
            <varlistentry>
 
29
                <term>format</term>
 
30
                <listitem>
 
31
                    <para>a Scilab string. It specifies a character string combining literal characters with conversion specifications.</para>
 
32
                </listitem>
 
33
            </varlistentry>
 
34
            <varlistentry>
 
35
                <term>value_i</term>
 
36
                <listitem>
 
37
                    <para>
 
38
                        specifies the data to be converted according to the <varname>format</varname> parameter.
 
39
                    </para>
 
40
                </listitem>
 
41
            </varlistentry>
 
42
            <varlistentry>
 
43
                <term>file</term>
 
44
                <listitem>
 
45
                    <para>
 
46
                        a Scilab string specifying a file name or a logical unit number (see <link linkend="file">file</link>)
 
47
                    </para>
 
48
                    <para>
 
49
                        Note that if <varname>file</varname>=0, the message will be display on standard error stream (stderr).
 
50
                    </para>
 
51
                </listitem>
 
52
            </varlistentry>
 
53
        </variablelist>
 
54
    </refsection>
 
55
    <refsection>
 
56
        <title>Description</title>
 
57
        <para>
 
58
            <caution>
 
59
                This function is obsolete, use preferabily the <link
62
60
        linkend="mfprintf">mfprintf</link> function which is much more
63
 
        compatible with the C <function>fprintf</function> functionalities.
64
 
      </caution>
65
 
    </para>
66
 
    <para>
67
 
      The <function>fprintf</function> function converts, formats, and writes
68
 
      its <varname>value</varname> parameters, under control of the <varname>format</varname>
69
 
      parameter, to the file specified by its <varname>file</varname> parameter.
70
 
    </para>
71
 
    <para>
72
 
      The <varname>format</varname> parameter is a character string that contains two
73
 
      types of objects:
74
 
    </para>
75
 
    <variablelist>
76
 
      <varlistentry>
77
 
        <term>Literal characters</term>
78
 
        <listitem>
79
 
          <para>which are copied to the output stream.</para>
80
 
        </listitem>
81
 
      </varlistentry>
82
 
      <varlistentry>
83
 
        <term>Conversion specifications</term>
84
 
        <listitem>
85
 
          <para>
86
 
            each of which causes zero or more items to be fetched from the <varname>value</varname> parameter list. See <link linkend="printf_conversion">printf_conversion</link> for details.
87
 
          </para>
88
 
        </listitem>
89
 
      </varlistentry>
90
 
    </variablelist>
91
 
    <para>
92
 
      If any <varname>value</varname>s remain after the entire <varname>format</varname> has been
93
 
      processed, they are ignored.
94
 
    </para>
95
 
  </refsection>
96
 
  <refsection>
97
 
    <title>Examples</title>
98
 
    <programlisting role="example"><![CDATA[ 
 
61
                compatible with the C <function>fprintf</function> functionalities.
 
62
            </caution>
 
63
        </para>
 
64
        <para>
 
65
            The <function>fprintf</function> function converts, formats, and writes
 
66
            its <varname>value</varname> parameters, under control of the <varname>format</varname>
 
67
            parameter, to the file specified by its <varname>file</varname> parameter.
 
68
        </para>
 
69
        <para>
 
70
            The <varname>format</varname> parameter is a character string that contains two
 
71
            types of objects:
 
72
        </para>
 
73
        <variablelist>
 
74
            <varlistentry>
 
75
                <term>Literal characters</term>
 
76
                <listitem>
 
77
                    <para>which are copied to the output stream.</para>
 
78
                </listitem>
 
79
            </varlistentry>
 
80
            <varlistentry>
 
81
                <term>Conversion specifications</term>
 
82
                <listitem>
 
83
                    <para>
 
84
                        each of which causes zero or more items to be fetched from the <varname>value</varname> parameter list. See <link linkend="printf_conversion">printf_conversion</link> for details.
 
85
                    </para>
 
86
                </listitem>
 
87
            </varlistentry>
 
88
        </variablelist>
 
89
        <para>
 
90
            If any <varname>value</varname>s remain after the entire <varname>format</varname> has been
 
91
            processed, they are ignored.
 
92
        </para>
 
93
    </refsection>
 
94
    <refsection>
 
95
        <title>Examples</title>
 
96
        <programlisting role="example"><![CDATA[ 
99
97
u=file('open',fullfile(TMPDIR,'results'),'unknown') //open the result file
100
98
t=0:0.1:2*%pi;
101
99
for tk=t
105
103
 
106
104
fprintf(0,'My error which is going to be displayed on the stderr') 
107
105
 ]]></programlisting>
108
 
  </refsection>
109
 
  <refsection role="see also">
110
 
    <title>See Also</title>
111
 
    <simplelist type="inline">
112
 
      <member>
113
 
        <link linkend="mfprintf">mfprintf</link>
114
 
      </member>
115
 
      <member>
116
 
        <link linkend="string">string</link>
117
 
      </member>
118
 
      <member>
119
 
        <link linkend="print">print</link>
120
 
      </member>
121
 
      <member>
122
 
        <link linkend="write">write</link>
123
 
      </member>
124
 
      <member>
125
 
        <link linkend="format">format</link>
126
 
      </member>
127
 
      <member>
128
 
        <link linkend="disp">disp</link>
129
 
      </member>
130
 
      <member>
131
 
        <link linkend="file">file</link>
132
 
      </member>
133
 
      <member>
134
 
        <link linkend="mprintf">mprintf</link>
135
 
      </member>
136
 
      <member>
137
 
        <link linkend="msprintf">msprintf</link>
138
 
      </member>
139
 
      <member>
140
 
        <link linkend="printf_conversion">printf_conversion</link>
141
 
      </member>
142
 
    </simplelist>
143
 
  </refsection>
 
106
    </refsection>
 
107
    <refsection role="see also">
 
108
        <title>See Also</title>
 
109
        <simplelist type="inline">
 
110
            <member>
 
111
                <link linkend="mfprintf">mfprintf</link>
 
112
            </member>
 
113
            <member>
 
114
                <link linkend="string">string</link>
 
115
            </member>
 
116
            <member>
 
117
                <link linkend="print">print</link>
 
118
            </member>
 
119
            <member>
 
120
                <link linkend="write">write</link>
 
121
            </member>
 
122
            <member>
 
123
                <link linkend="format">format</link>
 
124
            </member>
 
125
            <member>
 
126
                <link linkend="disp">disp</link>
 
127
            </member>
 
128
            <member>
 
129
                <link linkend="file">file</link>
 
130
            </member>
 
131
            <member>
 
132
                <link linkend="mprintf">mprintf</link>
 
133
            </member>
 
134
            <member>
 
135
                <link linkend="msprintf">msprintf</link>
 
136
            </member>
 
137
            <member>
 
138
                <link linkend="printf_conversion">printf_conversion</link>
 
139
            </member>
 
140
        </simplelist>
 
141
    </refsection>
144
142
</refentry>