1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
|
.TH inviso_as_lib 3 "inviso 0.6" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
inviso_as_lib \- The Inviso Autostart Utility Library
.SH DESCRIPTION
.LP
The purpose of the Inviso autostart utility library is to facilitate the creation and modification of autostart configuration files used by the standard autostart\&.
.SH EXPORTS
.LP
.B
setup_autostart(Node, R, Opts, TracerData, CmdFiles, Bindings, Transl, RTtag) -> ok | {error, Reason}
.br
.RS
.TP
Types
Node = atom()
.br
R = int()
.br
Opts -- see inviso:add_nodes/2, 3
.br
TracerData -- see inviso:init_tracing/1, 2
.br
CmdFiles = [CmdFile]
.br
CmdFile = string()
.br
Bindings = [{Var, Val}]
.br
Var = atom()
.br
Val = term()
.br
Transl = [{{M1, F1, Arity}, {M2, F2, {Mt, Ft}}}]
.br
M1 = F1 = M2 = F2 = Mt = Ft = atom()
.br
Arity = int()
.br
RTtag = term()
.br
Reason = term()
.br
.RE
.RS
.LP
Creates an autostart configuration file on \fINode\fR\&. The name of the file is automatically deducted from consulting the Runtime_Tools configuration parameters at \fINode\fR\&.
.LP
\fIR\fR is the number of allowed autostarts remaining\&.
.LP
\fIOpts\fR is the options which shall be given to the runtime component\&. See inviso:add_nodes/2,3\&.
.LP
\fITracerData\fR is used when initiating tracing on this node\&. See inviso:init_tracing/1,2\&.
.LP
\fICmdFiles\fR points out files containing instructions understood by the \fIinviso_autostart_server\fR implementation of an autostart initiator\&.
.LP
\fIBindings\fR is a list of \fI{Var, Val}\fR tuples, where \fIVar\fR is the name of a variable and \fIVal\fR the actual value of the variable\&.
.LP
\fITransl\fR means that \fIM1:F1/Arity\fR shall be translated into \fIM2:F2\fR\&.
.LP
\fIRTtag\fR is the incarnation tag of the runtime component\&. See See inviso:add_nodes/2,3\&.
.RE
.LP
.B
set_repeat(Node, R) -> ok | {error, Reason}
.br
.RS
.TP
Types
Node = atom()
.br
R = int()
.br
Reason = term()
.br
.RE
.RS
.LP
Sets the repeat parameter in the autostart file at \fINode\fR without changing any of its other contents\&. The autostart configuration file must exist\&.
.LP
\fIR\fR is the number of allowed autostarts remaining\&.
.RE
.LP
.B
inhibit_autostart(Node) -> ok | {error, Reason}
.br
.RS
.TP
Types
Node = atom()
.br
Reason = term()
.br
.RE
.RS
.LP
Sets the repeat parameter in the autostart file at \fINode\fR to 0\&. Equivalent to \fIset_repeat(Node, 0)\fR\&.
.RE
|