Adding JMCR-Stable version
[Benchmarks_CSolver.git] / JMCR-Stable / real-world application / jigsaw / WWW / Doc / Reference / org.w3c.jigsaw.frames.CgiFrame.html
diff --git a/JMCR-Stable/real-world application/jigsaw/WWW/Doc/Reference/org.w3c.jigsaw.frames.CgiFrame.html b/JMCR-Stable/real-world application/jigsaw/WWW/Doc/Reference/org.w3c.jigsaw.frames.CgiFrame.html
new file mode 100644 (file)
index 0000000..5f1dfc9
--- /dev/null
@@ -0,0 +1,233 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">\r
+<HTML>\r
+<HEAD>\r
+  <link rel="stylesheet" type="text/css" href="../style/doc.css"><style type="text/css">\r
+body { margin: 20pt; color: black; background: white; font-family: helvetica;} \r
+</STYLE>\r
+  <TITLE>The CgiFrame reference manual</TITLE>\r
+  <LINK HREF="jigsaw@w3.org" REL="made">\r
+</HEAD>\r
+<BODY>\r
+<P>\r
+<A HREF="../../.." TARGET="_top_"><IMG SRC="../../../Icons//WWW/w3c_home.gif"\r
+    ALT="W3C" BORDER="0" WIDTH="72" HEIGHT="48">\r
+</A><A HREF="../../" TARGET="_top_">\r
+<IMG SRC="../../../Icons//jigsaw" ALT="Jigsaw"BORDER="0"></A>\r
+  <hr noshade size="1">\r
+<A HREF="resources.html">All resources</A> <A HREF="frames.html">All frames\r
+</A> \r
+  <hr noshade size="1">\r
+<H1>\r
+  CgiFrame\r
+</H1>\r
+<P>\r
+This resource class runs CGI scripts, conforming to the\r
+<A HREF="http://www.ast.cam.ac.uk/~drtr/cgi-spec.html">CGI/1.1\r
+specification</A>. You can use it as an extension template, to get automatic\r
+indexing of your CGI scripts, based on their extension. \r
+<P>\r
+It also has a special <A HREF="#interpreter">interpreter</A> attribute that\r
+makes running scripts on Windows easy to configure, and somwhow more efficient\r
+then you could expect. \r
+<P>\r
+  <hr noshade size="1">\r
+<H2>\r
+  Inherits\r
+</H2>\r
+<P>\r
+The\r
+<A HREF="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/jigsaw/frames/CgiFrame.html">CgiFrame</A>\r
+class inerits from the following classes:\r
+<UL>\r
+  <LI>\r
+    <A HREF="org.w3c.tools.resources.Resource.html">Resource</A>\r
+  <LI>\r
+    <A HREF="org.w3c.tools.resources.FramedResource.html">FramedResource</A>\r
+  <LI>\r
+    <A HREF="org.w3c.tools.resources.ResourceFrame.html">ResourceFrame</A>\r
+  <LI>\r
+    <A HREF="org.w3c.tools.resources.ProtocolFrame.html">ProtocolFrame</A>\r
+  <LI>\r
+    <A HREF="org.w3c.jigsaw.frames.HTTPFrame.html">HTTPFrame</A>\r
+</UL>\r
+<P>\r
+  <hr noshade size="1">\r
+<H2>\r
+  Attributes description\r
+</H2>\r
+<P>\r
+The CgiFrame defines the following attributes:\r
+<UL>\r
+  <LI>\r
+    <A HREF="#interpreter">interpreter</A>\r
+  <LI>\r
+    <A HREF="#command">command</A>\r
+  <LI>\r
+    <A HREF="#noheader">noheader</A>\r
+  <LI>\r
+    <A HREF="#generates-form">generates-form</A>\r
+  <LI>\r
+    <A HREF="#remote-host">remote-host</A>\r
+  <LI>\r
+    <A HREF="#cgi-debug">cgi-debug</A>\r
+  <LI>\r
+    <A HREF="#env">env</A>\r
+</UL>\r
+<P>\r
+  <hr noshade size="1">\r
+<CODE><A NAME="interpreter">interpreter</A></CODE>\r
+<DL>\r
+  <DT>\r
+    <I>semantics</I>\r
+  <DD>\r
+    Some operating systems don't support the nice UNIX feature !# that allows\r
+    UNIX to launch the appropriate interpreter for the appropriate script. This\r
+    attribute allows the CgiResource to be configured to use a certain interpreter\r
+    to interpret the script pointed to by the <A HREF="#command">command</A>\r
+    attribute. By using this attribute in the predefined extensions, you can\r
+    state that on Windows boxes, all .pl files are to be exported by the CgiResource,\r
+    with default interpreter /Perl/bin/perl.exe. This will allow you to automatically\r
+    index cgi scripts. \r
+  <DT>\r
+    <I>type</I>\r
+  <DD>\r
+    This attribute is an editable\r
+    <A HREF="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/StringAttribute.html">StringAttribute</A>\r
+  <DT>\r
+    <I>default value</I>\r
+  <DD>\r
+    This attribute defaults to <B>null</B>.\r
+</DL>\r
+<P>\r
+  <hr noshade size="1">\r
+<CODE><A NAME="command">command</A></CODE>\r
+<DL>\r
+  <DT>\r
+    <I>semantics</I>\r
+  <DD>\r
+    The command to launch in order to run the CGI script. This should provide\r
+    the full pat hto the executable script. Each entry of the (String) array\r
+    gives is passed as an extra argument to the script, the first one being (by\r
+    convention) the full script's path. \r
+  <DT>\r
+    <I>type</I>\r
+  <DD>\r
+    This attribute is an editable\r
+    <A HREF="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/StringArrayAttribute.html">StringArrayAttribute</A>\r
+  <DT>\r
+    <I>default value</I>\r
+  <DD>\r
+    This attribute defaults to <B>null</B>.\r
+</DL>\r
+<P>\r
+  <hr noshade size="1">\r
+<CODE><A NAME="noheader">noheader</A></CODE>\r
+<DL>\r
+  <DT>\r
+    <I>semantics</I>\r
+  <DD>\r
+    Will the script emits its one headers, or should <B>Jigsaw</B> emit them.\r
+    Classical CGI scripts will usually not emit any headers, so it is up to their\r
+    hosting server to emit them. However, in some situation (server push, for\r
+    example), the script might prefer to emit its own set of headers. When this\r
+    flag is set to <B>true</B> it is up to the script to emit the headers, otherwise,\r
+    the server will do it. \r
+  <DT>\r
+    <I>type</I>\r
+  <DD>\r
+    This attribute is an editable\r
+    <A HREF="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/BooleanAttribute.html">BooleanAttribute</A>\r
+  <DT>\r
+    <I>default value</I>\r
+  <DD>\r
+    This attribute defaults to <B>false</B>.\r
+</DL>\r
+<P>\r
+  <hr noshade size="1">\r
+<CODE><A NAME="generates-form">generates-form</A></CODE>\r
+<DL>\r
+  <DT>\r
+    <I>semantics</I>\r
+  <DD>\r
+    Should the script be used to generate the form to be filled-in ? This resource\r
+    allows you to put your form in a file, instead of having to launch the script\r
+    to generate it. For compatibilty, this flags is turned to <B>false</B> by\r
+    default, although, the second alternative (having the form in a separate\r
+    file) will probably be much (much) more efficient. \r
+  <DT>\r
+    <I>type</I>\r
+  <DD>\r
+    This attribute is an editable\r
+    <A HREF="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/BooleanAttribute.html">BooleanAttribute</A>\r
+  <DT>\r
+    <I>default value</I>\r
+  <DD>\r
+    This attribute defaults to <B>true</B>.\r
+</DL>\r
+<P>\r
+  <hr noshade size="1">\r
+<CODE><A NAME="remote-host">remote-host</A></CODE>\r
+<DL>\r
+  <DT>\r
+    <I>semantics</I>\r
+  <DD>\r
+    If turned on, this flag will enable the REMOTE_HOST env var computation.\r
+  <DT>\r
+    <I>type</I>\r
+  <DD>\r
+    This attribute is an editable\r
+    <A HREF="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/BooleanAttribute.html">BooleanAttribute</A>\r
+  <DT>\r
+    <I>default value</I>\r
+  <DD>\r
+    This attribute defaults to <B>null</B>.\r
+</DL>\r
+<P>\r
+  <hr noshade size="1">\r
+<CODE><A NAME="cgi-debug">cgi-debug</A></CODE>\r
+<DL>\r
+  <DT>\r
+    <I>semantics</I>\r
+  <DD>\r
+    Turns debug on for that script. This nifty feature allow you to debug your\r
+    script, by emitting a document containing the script output, instead of letting\r
+    the script generates the document. The returned document will be of content\r
+    type <B>text/plain</B>. \r
+  <DT>\r
+    <I>type</I>\r
+  <DD>\r
+    This attribute is an editable\r
+    <A HREF="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/BooleanAttribute.html">BooleanAttribute</A>\r
+  <DT>\r
+    <I>default value</I>\r
+  <DD>\r
+    This attribute defaults to <B>false</B>.\r
+</DL>\r
+<P>\r
+  <hr noshade size="1">\r
+<CODE><A NAME="env">env</A></CODE>\r
+<DL>\r
+  <DT>\r
+    <I>semantics</I>\r
+  <DD>\r
+    Gives additional environment variables to the script.\r
+    Windows users may find it useful to define WINDIR=%windir% and\r
+    SYSTEMROOT=%systemroot%.\r
+  <DT>\r
+    <I>type</I>\r
+  <DD>\r
+    This attribute is an editable\r
+    <A HREF="http://jigsaw.w3.org/Doc/Programmer/api/org/w3c/tools/resources/PropertiesAttribute.html">PropertiesAttribute</A>\r
+  <DT>\r
+    <I>default value</I>\r
+  <DD>\r
+    This attribute defaults to <B>null</B>.\r
+  </DL>\r
+<P>\r
+<P>\r
+  <hr noshade size="1">\r
+<P>\r
+<I><A HREF="mailto:jigsaw@w3.org">Jigsaw Team</A><BR>\r
+$Id: org.w3c.jigsaw.frames.CgiFrame.html,v 1.3 1998/03/27 08:19:05 bmahe\r
+Exp $</I>\r
+</BODY></HTML>\r