<!-- Converted to DocBook/SGML by Kevin Conder -->
<refentry id="fprintks">
  <refmeta>
    <refentrytitle>fprintks</refentrytitle>
  </refmeta>
 
  <refnamediv>
    <refname>fprintks</refname>
    <refpurpose>
      Similar to printks but prints to a file.
      <indexterm id="IndexFprintks"><primary>fprintks</primary></indexterm>
    </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Similar to <link linkend="printks"><citetitle>printks</citetitle></link> but prints to a file.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis><command>fprintks</command> &quot;filename&quot;, &quot;string&quot;, [, kval1] [, kval2] [...]</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>&quot;filename&quot;</emphasis> -- name of the output file.
    </para>

    <para>
      <emphasis>&quot;string&quot;</emphasis> -- the text string to be printed. Can be up to 8192 characters and must be in double quotes.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>kval1, kval2, ...</emphasis> (optional) -- The k-rate values to be printed. These are specified in <emphasis><quote>string</quote></emphasis> with the standard C value specifier (%f, %d, etc.) in the order given.
    </para>

    <para>
      <emphasis>fprintks</emphasis> is similar to the <emphasis>printks</emphasis> opcode except it outputs to a file and doesn't have a <emphasis>itime</emphasis> parameter. For more information about output formatting, please look at <link linkend="printks"><citetitle>printks's documentation</citetitle></link>.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the fprintks opcode. It uses the files <ulink url="examples/fprintks.orc"><citetitle>fprintks.orc</citetitle></ulink> and <ulink url="examples/fprintks.sco"><citetitle>fprintks.sco</citetitle></ulink>.

      <example>
        <title>Example of the fprintks opcode.</title>

        <programlisting>
<inlinemediaobject>
            <imageobject>
              <imagedata fileref="examples/fprintks.orc" format="linespecific">
            </imageobject>
          </inlinemediaobject>
        </programlisting>

        <programlisting>
<inlinemediaobject>
            <imageobject>
              <imagedata fileref="examples/fprintks.sco" format="linespecific">
            </imageobject>
          </inlinemediaobject>
        </programlisting>
      </example>

      This example will generate a file called <quote>my.sco</quote>. It should contain lines like this:

      <screen>
i1      0.00    3.94    10.26
i1      0.20    3.35    6.22
i1      0.67    3.65    11.33
i1      1.31    1.42    4.13
      </screen>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="printks"><citetitle>printks</citetitle></link>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namematt;</member>
        <member>January 2003</member>
      </simplelist>
    </para>
  </refsect1>
</refentry>
