The full pathname of the HTML file which should be processed by Embperl.

Optional. Has the same meaning as the environment variable QUERY_STRING when invoked as a CGI script. That is, QUERY_STRING contains everything following the first "?" in a URL. <query_string> should be URL-encoded. The default is no query string.

Optional. Gives the filename to which the output is written. The default is stdout.

Optional. Gives the filename of the logfile. The default is /tmp/embperl.log.

Optional. Specifies the level of debugging (what is written to the log file). The default is nothing. See EMBPERL_DEBUG for exact values.

The file which should be used as source. If input is also specified, this parameter should be given a unique name to identify the source. Every time Embperl sees the same text in inputfile, it assumes that you compiled the same source - that means that Embperl uses the same package name as in your last call, and only recompiles the code if mtime has changed or is undefined.

Call the Embperl subroutine named by this parameter(see also "[$ sub $]"). Currently the subroutine must be in the same file or if it's in another file, the other file has to be imported first.

Reference to a string which contains the source. inputfile must also be specified to give a name for the source. The name can be any text.

Last modification time of member input. If undef the code passed by input is always recompiled, else the code is only recompiled if mtime changes.

File to which the output should be written. If neither outputfile nor output is specified, ouput is written to stdout.

Reference to a scalar where the output should be written to.

A value of zero tells Embperl not to execute the page, but define all subrountines found inside. This is neccessary before calling them with Execute by the sub parameter or for a later import.

A value of one tells Embperl to define the subrountines inside the file (if not already done) and to import them as perl subroutines into the current namespace.

See [$ sub $] metacommand and section about subroutines for more info.

NOTE: The req_rec parameter isn't necessary anymore in versions >= 1.2b2

If used under mod_perl, you should set the req_rec parameter to the Apache request record object provided by mod_perl.

This value specifies if and when the cleanup of the package should be executed. (See Variable scope and cleanup below for more information on cleanup)

	cleanup = -1
	Never cleanup the variables
	cleanup = 0 or not specified
	If running under mod_perl, cleanup is delayed until the connection to the client is closed, so it does not lengthen the response time to the client. If the Execute function is called more the once before the end of the request, all cleanups take place after the end of the request and not between calls to Execute. If running as a CGI or offline, cleanup takes place immediately.
	cleanup = 1
	Immediate cleanup

Can be used to pass parameters to the Embperl document and back. Must contain a reference to an array.

 Example:

    HTML::Embperl::Execute(..., param => [1, 2, 3]) ;
    HTML::Embperl::Execute(..., param => \@parameters) ;

The array @Z<>param in the Embperl document is setup as an alias to the array. See eg/x/Excute.pl for a more detailed example.

Could be used to setup the two Embperl predefined variables.

Specifies the first linenumber of the sourcefile (Default: 1)

Same as EMBPERL_OPTIONS (see below), except for cleanup.

NOTE: You should set the optDisableFormData if you have already read the form data from stdin while in a POST request. Otherwise Execute will hang and try to read the data a second time.

Same as EMBPERL_DEBUG (see below).

Same as EMBPERL_ESCMODE (see below).

Same as EMBPERL_PACKAGE (see below).

Same as EMBPERL_VIRTLOG (see below). If virtlog is equal to uri the logfile is sent.

Same as EMBPERL_ALLOW (see below)

Same as EMBPERL_PATH (see below)

The URI of the request. Only needed for the virtlog feature.

Same as EMBPERL_COMPARTMENT (see below).

Same as EMBPERL_INPUT_FUNC (see below). Additionaly you can specify a code reference to a perl subroutine, which is used as input function; or an array reference, where the first element contains the code reference and further elements contain additional arguments passed to the function.

Same as EMBPERL_OUTPUT_FUNC (see below). Additionaly you can specify a code reference to a perl subroutine, which is used as output function; or an array reference, where the first element contains the code reference and further elements contain additional arguments passed to the function.

Same as EMBPERL_COOKIE_NAME (see below).

Same as EMBPERL_COOKIE_PATH (see below).

Same as EMBPERL_COOKIE_DOMAIN (see below).

Same as EMBPERL_COOKIE_EXPIRES (see below).

Takes a reference to an array. Upon return, the array will contain a copy of all errormessages, if any.

Takes a filename and returns an hashref that is blessed into the package of the given file. That's usefull, if you want to call the subs inside the given file, as methods. By using the isa parameter (see below) you are able to provide an inherence tree. Additionaly you can use the returned hashref to store data for that obeject.

  Example:

  [# the file eposubs.htm defines two subs: txt1 and txt2 #]
  [# first we create a new object #]
  [- $subs = Execute ({'object' => 'eposubs.htm'}) -]

  [# then we call methods inside the object #]
  txt1: [+ $subs -> txt1 +] <br>

  txt2: [+ $subs -> txt2 +] <br>

Takes a name of a file and pushes the package of that file into the @ISA array of the current file. By using this you can setup an inherence tree between Embperl documents. Is is also usefull within EmbperlObject.

  Example:

    [! Execute ({'isa' => '../eposubs.htm'}) !]

In 1.3.x the only value that is accepted is 'Text', this emulates the Embperl 2.0 behaviour of simply passing the whole text thru, without doing any processing.

This function can be used to setup the logfile path and (optionally) a default value for the debugflags, which will be used in further calls to Execute. There will always be only one logfile, but you can use Init to change it at any time.

NOTE: You do not need to call Init in version >= 0.27. The initialization of Embperl takes place automatically when it is loaded.

Scans %ENV, setting up %params for use by Execute. All Embperl runtime configuration options are recognized, except EMBPERL_LOG.