(index ("procdebug" 0) ("init" 189) ("arg" 572) ("execline" 1107) ("execscript" 1957) ("execprefab" 2285) ("end" 2594) ("getvar" 2743) ("setvar" 2901) ("proc" 3068))
(def (sig (procedure " procdebug:: [BOOL] => VOID " (id procdebug))) (p "If this parameter is set to " (tt "#t") ", every line of a ploticus procedure will be printed as it is executed."))
(def (sig (procedure " init:: SYMBOL * STRING => INTEGER " (id init))) (p "Initializes " (tt "ploticus") ". The first argument is the output device, which is a symbol that can be one of 'png, 'gif, 'x11, 'svg, 'jpeg, 'eps, or 'swf. (Not all devices may be available, depending on the build.)  The second argument is a string pathname of the file where the result will be written."))
(def (sig (procedure " arg:: STRING [* STRING] => INTEGER " (id arg))) (p "Specifies a " (link "http://ploticus.sourceforge.net/doc/pl.1.html#options" "ploticus command line argument") ".  The first argument specifies the argument name and the second is the argument value. If there is no argument value, the value is passed as empty string. Arguments " (tt "-f") ", " (tt "-prefab") ", and " (tt "-ver") " are not supported. If needed, this procedure should be called after " (tt "init") " but before any other ploticus procedure."))
(def (sig (procedure " execline:: STRING => INTEGER  " (id execline))) (p "Executes one " (link "http://ploticus.sourceforge.net/doc/scripts.html" "ploticus script line") ".") (p "Script lines can contain only these directives: " (tt "#proc") ", " (tt "#procdef") ", " (tt "#endproc") ", " (tt "#clone") " and " (tt "#saveas") ". They cannot contain flow-of-control directives and do not undergo a variable-evaluation pass, so variables cannot be referenced, and select statements (etc.) that reference data field names should use one at sign (@) instead of two (@@).") (p (tt "ploticus") " variables can be accessed by " (tt "getvar") ", described below.") (p "An alternative is to use " (tt "execscript") " (described below) to execute an entire script file. " (tt "execline") " and " (tt "execscript") " cannot be used in the same application."))
(def (sig (procedure " execscript:: STRING => INTEGER  " (id execscript))) (p "Executes an entire " (link "http://ploticus.sourceforge.net/doc/scripts.html" "ploticus script file") ". The argument is the name of a ploticus script file.") (p (tt "execscript") " and " (tt "execline") " cannot be used in the same application."))
(def (sig (procedure " execprefab:: STRING => INTEGER  " (id execprefab))) (p "Executes a " (link "http://ploticus.sourceforge.net/doc/prefabs.html" "ploticus prefab") ".") (p "The argument is the name of the prefab.") (p (tt "execprefab") " and " (tt "execline") " cannot be used in the same application."))
(def (sig (procedure " end:: VOID => INTEGER  " (id end))) (p "Finishes up the plot, writes it to the output file, and frees up allocated memory."))
(def (sig (procedure " getvar:: STRING => STRING " (id getvar))) (p "Returns the contents of the given " (tt "ploticus") " variable name or " (tt "#f") "."))
(def (sig (procedure " setvar:: STRING * STRING => INTEGER " (id setvar))) (p "Sets the contents of the given " (tt "ploticus") " variable name to the given value."))
(def (sig (procedure " proc:: STRING * FIELD-LIST => INTEGER " (id proc))) (p "A convenience procedure for " (tt "#proc") " directives (" (link "http://ploticus.sourceforge.net/doc/scriptsyntax.html#directives" "ploticus procedures") ").") (p "The first arguments is the name of the procedure, the second argument is a list of elements of the form (NAME . VALUE), where " (tt "NAME") " is a field name, and " (tt "VALUE") " is the corresponding field value."))
