<!doctype erlref PUBLIC "-//Stork//DTD erlref//EN">
<erlref>
  <header>
    <title>inviso_as_lib</title>
    <prepared></prepared>
    <docno></docno>
    <date></date>
    <rev></rev>
  </header>
  <module>inviso_as_lib</module>
  <modulesummary>The Inviso Autostart Utility Library</modulesummary>
  <description>
    <p>The purpose of the Inviso autostart utility library is to facilitate the creation and modification of autostart configuration files used by the standard autostart.</p>
  </description>

  <funcs>
    <func>
      <name>setup_autostart(Node, R, Opts, TracerData, CmdFiles,
	Bindings, Transl, RTtag) -> ok | {error, Reason}</name>
      <fsummary>Create an autostart configuration file</fsummary>
      <type>
	<v>Node = atom()</v>
	<v>R = int()</v>
	<v>Opts -- see inviso:add_nodes/2,3</v>
	<v>TracerData -- see inviso:init_tracing/1,2</v>
	<v>CmdFiles = [CmdFile]</v>
	<v>&nbsp;CmdFile = string()</v>
	<v>Bindings = [{Var,Val}]</v>
	<v>&nbsp;Var = atom()</v>
	<v>&nbsp;Val = term()</v>
	<v>Transl = [{{M1,F1,Arity}, {M2,F2,{Mt,Ft}}}]</v>
	<v>&nbsp;M1 = F1 = M2 = F2 = Mt = Ft = atom()</v>
	<v>&nbsp;Arity = int()</v>
	<v>RTtag = term()</v>
	<v>Reason = term()</v>
      </type>
      <desc>
	<p>Creates an autostart configuration file on <c>Node</c>. The name of the file is automatically deducted from consulting the Runtime_Tools configuration parameters at <c>Node</c>.</p>

	<p><c>R</c> is the number of allowed autostarts remaining.</p>

	<p><c>Opts</c> is the options which shall be given to the runtime component. See <seealso marker="inviso#add_nodes/2">inviso:add_nodes/2,3</seealso>.</p>

	<p><c>TracerData</c> is used when initiating tracing on this node. See <seealso marker="inviso#init_tracing/1">inviso:init_tracing/1,2</seealso>.</p>

	<p><c>CmdFiles</c> points out files containing instructions understood by the <c>inviso_autostart_server</c> implementation of an autostart initiator.</p>

	<p><c>Bindings</c> is a list of <c>{Var, Val}</c> tuples, where <c>Var</c> is the name of a variable and <c>Val</c> the actual value of the variable.</p>

	<p><c>Transl</c> means that <c>M1:F1/Arity</c> shall be translated into <c>M2:F2</c>.</p>

	<p><c>RTtag</c> is the incarnation tag of the runtime component. See See <seealso marker="inviso#add_nodes/2">inviso:add_nodes/2,3</seealso>.</p>
      </desc>
    </func>

    <func>
      <name>set_repeat(Node, R) -> ok | {error, Reason}</name>
      <fsummary>Set the repeat parameter in the autostart file</fsummary>
      <type>
	<v>Node = atom()</v>
	<v>R = int()</v>
	<v>Reason = term()</v>
      </type>
      <desc>
	<p>Sets the repeat parameter in the autostart file at <c>Node</c> without changing any of its other contents. The autostart configuration file must exist.</p>

	<p><c>R</c> is the number of allowed autostarts remaining.</p>
      </desc>
    </func>

    <func>
      <name>inhibit_autostart(Node) -> ok | {error, Reason}</name>
      <fsummary>Set the repeat parameter in the autostart file to 0
      </fsummary>
      <type>
	<v>Node = atom()</v>
	<v>Reason = term()</v>
      </type>
      <desc>
	<p>Sets the repeat parameter in the autostart file at <c>Node</c> to 0. Equivalent to <c>set_repeat(Node, 0)</c>.</p>
      </desc>
    </func>
  </funcs>

  <authors>
    <aname>Lennart &Ouml;hman</aname>
    <email>support@erlang.ericsson.se</email>
  </authors>
</erlref>
