<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="parallel.bootstrap" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
 <refnamediv>
  <refname>parallel\bootstrap</refname>
  <refpurpose>Bootstrapping</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>parallel\bootstrap</methodname>
   <methodparam><type>string</type><parameter>file</parameter></methodparam>
  </methodsynopsis>
  <para>
   Shall use the provided <parameter>file</parameter> to bootstrap all runtimes created for automatic scheduling via <function>parallel\run</function>.
  </para>
 </refsect1>

 <refsect1 role="exceptions">
  <title>Exceptions</title>
  <warning>
   <para>
    Shall throw <type>parallel\Runtime\Error\Bootstrap</type> if previously called for this process.
   </para>
  </warning>
  <warning>
   <para>
    Shall throw <type>parallel\Runtime\Error\Bootstrap</type> if called after <function>parallel\run</function>.
   </para>
  </warning>
 </refsect1>

 <refsect1 role="seealso">
   &reftitle.seealso;
   <simplelist>
    <member><xref linkend="parallel-runtime.run" /></member>
   </simplelist>
  </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->