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
|
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
|
-
+
-
-
-
-
+
+
+
+
+
|
<h1>Usage</h1>
The command line options for plugins are:
* -plugin plugin : Use plugin
* -plugininfo info : Pass info to plugin (plugin specific)
* -plugindump plugin : Dump plugin source to stdout
* -pluginlist : List known plugins
* -pluginallow : Allow full access for a plugin.
* -pluginallow : Allow full access privilege for a plugin.
A plugin may further define command line options that it accepts.
<h1>General Format</h1>
A plugin is a Tcl script file that must start with the verbatim sequence
"##Eskil Plugin :". A plugin is sourced and used in its own safe
interpreter and thus have free access to its own global space. Hookup
points are defined by declaring specifically named procedures as specified
below, and apart from those, a plugin can define and do whatever within
the limits of a safe interpreter.
In addition to the standard safe interpreter environment, a plugin has
access to stdout as well. By using the command line option -pluginallow,
the plugin is run in a standard interpreter and may e.g. do exec to utilize
external tools.
A plugin is set up with these global variables filled in:
* ::WhoAmI : The name of the plugin
* ::Info : The contents of -plugininfo parameter
* ::Pref : A copy if Eskil's internal preferences array.
* ::argv : A copy of the command line from Eskil's invocation
* ::WhoAmI : The name of the plugin
* ::WhoAmIFull : The full path to the plugin source
* ::Info : The contents of -plugininfo parameter
* ::Pref : A copy if Eskil's internal preferences array.
* ::argv : A copy of the command line from Eskil's invocation
<h2>Additional options</h2>
A plugin can declare command line options that should be accepted by Eskil.
They will be passed on to the plugin through the ::argv list.
If the initial "##Eskil" line is followed by comments formatted as below,
it adds options. Any empty line will end parsing for such lines.
|