SSI Command Reference Table

config

(see Config Command )

errmsg

your own wording

Configure format for displaying the time and file size. Also used to customize the SSI error message, or change character translation, or generate a new random number.

<!--#config timefmt="%B %D %Y"-->

<!--#config errmsg="An error was encountered in the processing of this SSI

command"-->

<!--#config sizefmt="abbrev"-->

<!--#config charset="latin1"-->

<!--#config newrandom="500"-->

timefmt

See Timefmt Field Descriptors .

sizefmt

bytes, abbrev

charset

normal, latin1, ascii

newrandom

integer between 2 and 10,000 inclusive

counter

(see Counter Command )

var

name of counter

The counter command increments a named counter variable, and inserts the new value into the HTML output stream.

<!--#counter var="my_page_counter"-->

<!--#counter display="off"-->

display

true, false, off, on, yes, no

echo

(see Echo Command )

var

See Environmental Variables .

Echo an environment or WebSTAR API variable.

<!--#echo var="HTTP_USER_AGENT"-->

exec

(see Exec Command )

cgi

path to be executed by the CGI script

Execute a command, CGI, script or WebSTAR API service.

<!--#exec cgi="/ProcessSale.qry" post="sales=19.95"-->

<!--#exec script="/salesscript" post="sales=19.95"-->

<!--#exec piservice="FORMMAIL_SSI" param="from=eric@starnine.com&to=marc@starnine.com&subject=Hello&body=I%20hope%20you're%20having%20 fun!&host=email.starnine.com"-->

script

path to the CGI script

piservice

name of the WebSTAR API service to execute

flastmod

(see FLastMod Command )

virtual

file path to local URL

File's last modification date.

<!--#flastmod virtual="/stuff/address.shtml"-->

<!--#flastmod file="Macintosh HD:WebSTAR:stuff:address.shtml"-->

file

Macintosh file pathname

fsize

(see FSize Command )

virtual

file path to local URL

File's size in bytes or kilobytes.

<!--#fsize virtual="/stuff/address.shtml"-->

<!--#fsize file="Macintosh HD:WebSTAR 4.0:stuff:address.shtml"-->

file

Macintosh file pathname

hide

(see Hide and Show Commands , see also show below)

none required

defaults to =

To conditionally turn off the HTML output stream based upon environmental variables, operators and values.

<!--#hide-->

<!--#hide variable="date_gmt"-->

<!--#hide variable="date_gmt" operator="contains" value="1998" -->

operator

contains, start, end, =, ==, !=, <>, <, <=, =<, >, >=, =>
(see Operators for Show and Hide Commands )

value

optional (defaults to empty string)

variable

See Environmental Variables .

include

(see Include Command )

virtual

file path to local URL

Include another document into the HTML output stream.

<!--#include virtual="/stuff/address.shtml"-->

<!--#include file="Web HD:WebSTAR 4.0:stuff:address.shtml"-->

file

Macintosh file pathname

postarg

(see PostArg Command )

var

name of the form variable from the page

Display named variables that have been sent to an SSI page from an HTML form.

Hello, <!--#postarg var="your_name"-->!

show

(see Hide and Show Commands , see also hide above)

none required

defaults to =

To conditionally turn on the HTML output stream based upon environmental variables, operators and values.

<!--#show-->

<!--#show variable="date_gmt"-->

<!--#show variable="date_gmt" operator="contains" value="1997" -->

operator

contains, start, end, =, ==, !=, <>, <, <=, =<, >, >=, =>
(see Operators for Show and Hide Commands )

value

optional (defaults to empty string)

variable

See Environmental Variables .

store

(see Store Command )

variable

your preferred variable name, up to 33 characters

Saves text or numbers for later use by the echo, hide, or show commands.

<!-- #store special_offer="Upgrade for only $299!"-->

kind

optional: local (default), shared or persist