You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-cvs@tcl.apache.org by ro...@apache.org on 2009/09/14 19:04:52 UTC
svn commit: r814735 [1/3] - in /tcl/site/websh: ./ quickref/
Author: ronnie
Date: Mon Sep 14 17:04:52 2009
New Revision: 814735
URL: http://svn.apache.org/viewvc?rev=814735&view=rev
Log:
- updated to version 3.6.0b5
Modified:
tcl/site/websh/download.ws3
tcl/site/websh/index.ws3
tcl/site/websh/quickref.ws3
tcl/site/websh/quickref/Apache_module_specific_commands.html
tcl/site/websh/quickref/command_dispatching_and_session_management.html
tcl/site/websh/quickref/configuration.html
tcl/site/websh/quickref/context_handling.html
tcl/site/websh/quickref/data_encryption.html
tcl/site/websh/quickref/file_handling_and_file_IO.html
tcl/site/websh/quickref/index.html
tcl/site/websh/quickref/inter-process_and_-system_communication.html
tcl/site/websh/quickref/logging.html
tcl/site/websh/quickref/misc_commands.html
tcl/site/websh/quickref/request_data_handling.html
tcl/site/websh/quickref/response_data_handling.html
tcl/site/websh/quickref/uri-html-_en-decoding.html
Modified: tcl/site/websh/download.ws3
URL: http://svn.apache.org/viewvc/tcl/site/websh/download.ws3?rev=814735&r1=814734&r2=814735&view=diff
==============================================================================
--- tcl/site/websh/download.ws3 (original)
+++ tcl/site/websh/download.ws3 Mon Sep 14 17:04:52 2009
@@ -19,12 +19,12 @@
<td>
Download the latest source code from a mirror:<p>
- <a href="http://www.apache.org/dyn/closer.cgi/tcl/websh/source/websh-3.6.0b4-src.tar.gz">websh-3.6.0b4-src.tar.gz</a><br>
- <a href="http://svn.apache.org/repos/asf/tcl/websh/tags/3.6.0b4/CHANGES">Overview of changes in 3.6.0b4</a>
+ <a href="http://www.apache.org/dyn/closer.cgi/tcl/websh/source/websh-3.6.0b5-src.tar.gz">websh-3.6.0b5-src.tar.gz</a><br>
+ <a href="http://svn.apache.org/repos/asf/tcl/websh/tags/3.6.0b5/CHANGES">Overview of changes in 3.6.0b5</a>
<p>Download the latest quick reference (included in the source):
- <p> <a href="http://www.apache.org/dyn/closer.cgi/tcl/websh/source/quickref-3.6.0b4.tar.gz">quickref-3.6.0b4.tar.gz</a>
+ <p> <a href="http://www.apache.org/dyn/closer.cgi/tcl/websh/source/quickref-3.6.0b5.tar.gz">quickref-3.6.0b5.tar.gz</a>
</td>
</tr>
</table>
@@ -55,8 +55,8 @@
<p>
<b>Important note</b>: The latest release now also features a Windows XP
- Makefile for Visual Studio nmake. Websh 3.6.0b4 is known to work
- with Sun Solaris 8 and 9, Linux RedHat 8, Suse9.1, Windows XP, Mac OSX 8.2 und 8.3.
+ Makefile for Visual Studio nmake. Websh 3.6.0b5 is known to work
+ with Sun Solaris 8, 9, and 10, Linux RedHat 8, CenOS 4.6, Suse9.1, Windows XP, Mac OSX 8.2 und 8.3.
Other Unix platforms are likely to work too.
</p>
</td>
Modified: tcl/site/websh/index.ws3
URL: http://svn.apache.org/viewvc/tcl/site/websh/index.ws3?rev=814735&r1=814734&r2=814735&view=diff
==============================================================================
--- tcl/site/websh/index.ws3 (original)
+++ tcl/site/websh/index.ws3 Mon Sep 14 17:04:52 2009
@@ -27,13 +27,19 @@
of Websh applications on this site.
</p>
<p>
- Changes in the latest Release: {pageLink http://svn.apache.org/repos/asf/tcl/websh/tags/3.6.0b4/CHANGES -show "Changes in Websh 3.6.0.b4"}
+ Changes in the latest Release: {pageLink http://svn.apache.org/repos/asf/tcl/websh/tags/3.6.0b5/CHANGES -show "Changes in Websh 3.6.0.b5"}
</p>
</td>
<td width="145">
<table border="0" cellpadding="0" cellspacing="0" width="145">
+{newsBarElement "2009-09-14" \
+ {<b>Websh 3.6.0b5 available</b>: Pick the {pageLink http://www.apache.org/dyn/closer.cgi/tcl/websh/source/websh-3.6.0b5-src.tar.gz -show "tarball"}
+ or browse the {pageLink /websh/download.ws3 -show "download area"}.
+ }
+}
+
{newsBarElement "2006-03-05" \
{<b>Websh 3.6.0b4 available</b>: Pick the {pageLink http://www.apache.org/dyn/closer.cgi/tcl/websh/source/websh-3.6.0b4-src.tar.gz -show "tarball"}
or browse the {pageLink /websh/download.ws3 -show "download area"}.
Modified: tcl/site/websh/quickref.ws3
URL: http://svn.apache.org/viewvc/tcl/site/websh/quickref.ws3?rev=814735&r1=814734&r2=814735&view=diff
==============================================================================
--- tcl/site/websh/quickref.ws3 (original)
+++ tcl/site/websh/quickref.ws3 Mon Sep 14 17:04:52 2009
@@ -16,7 +16,7 @@
<p>Download the quick reference as tar file</p>
- <p> <a href="http://www.apache.org/dyn/closer.cgi/tcl/websh/source/quickref-3.6.0b4.tar.gz">quickref-3.6.0b4.tar.gz</a>
+ <p> <a href="http://www.apache.org/dyn/closer.cgi/tcl/websh/source/quickref-3.6.0b5.tar.gz">quickref-3.6.0b5.tar.gz</a>
<h2>Online</h2>
Modified: tcl/site/websh/quickref/Apache_module_specific_commands.html
URL: http://svn.apache.org/viewvc/tcl/site/websh/quickref/Apache_module_specific_commands.html?rev=814735&r1=814734&r2=814735&view=diff
==============================================================================
--- tcl/site/websh/quickref/Apache_module_specific_commands.html (original)
+++ tcl/site/websh/quickref/Apache_module_specific_commands.html Mon Sep 14 17:04:52 2009
@@ -1,39 +1,37 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>Apache module specific commands</title><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"><link rel="start" href="index.html" title="Websh Reference 3.6.0b4"><link rel="up" href="index.html" title="Websh Reference 3.6.0b4"><link rel="prev" href="inter-process_and_-system_communication.html" title="Inter-process/-system communication"><link rel="next" href="misc_commands.html" title="Miscellaneous commands"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Apache module specific commands</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="inter-process_and_-system_communication.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="misc_commands.html">Next</a>
</td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><hr><h2 class="title" style="clear: both"><a name="Apache_module_specific_commands"></a>Apache module specific commands</h2></div></div></div><p style="width:90%">
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Apache module specific commands</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"><link rel="home" href="index.html" title="Websh Reference 3.6.0b5"><link rel="up" href="index.html" title="Websh Reference 3.6.0b5"><link rel="prev" href="inter-process_and_-system_communication.html" title="Inter-process/-system communication"><link rel="next" href="misc_commands.html" title="Miscellaneous commands"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Apache module specific commands</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="inter-process_and_-system_communication.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="misc_commands.html">Next</a><
/td></tr></table><hr></div><div class="section" title="Apache module specific commands"><div class="titlepage"><div><div><hr><h2 class="title" style="clear: both"><a name="Apache_module_specific_commands"></a>Apache module specific commands</h2></div></div></div><p style="width:90%">
Note that these commands are implemented as dummies in the CGI
version of Websh only. They don't do anything except for
web::initializer and web::finalizer, which just evaluate the
code provided in the argument.
- </p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::initializer"></a>web::initializer</h3></div></div></div><p style="width:90%">
+ </p><div class="section" title="web::initializer"><div class="titlepage"><div><div><h3 class="title"><a name="web::initializer"></a>web::initializer</h3></div></div></div><p style="width:90%">
</p><div class="cmdsynopsis"><span style="background:#bbbbff"><span style="font-weight:bold"><code class="command">web::initializer</code></span> <em class="replaceable"><code>code</code></em></span></div><p style="width:90%">
This code is executed only when a new interpreter is created.
- Note that the "main" Websh script can
- <span style="font-family:monospace"><span><strong class="command">source</strong></span></span> several modules which each call
+ Note that the "main" Websh script can
+ <span style="font-family:monospace"><span class="command"><strong>source</strong></span></span> several modules which each call
their initialization code.
Also note that this code eval'd when it is first requested and read in its normal script sequence, and not prior to any other code in the script.
</p><p style="width:90%">
-Calling <span style="font-family:monospace"><span><strong class="command">web::loglevel</strong></span></span> and <span style="font-family:monospace"><span><strong class="command">web::logdest</strong></span></span> in any <span style="font-family:monospace"><span><strong class="command">web::initializer</strong></span></span> will tag these log levels and destinations as not to be deleted, after the request ends. This log condifguration will therefore also be available in the finalizer code, which is only eval'd after
+Calling <span style="font-family:monospace"><span class="command"><strong>web::loglevel</strong></span></span> and <span style="font-family:monospace"><span class="command"><strong>web::logdest</strong></span></span> in any <span style="font-family:monospace"><span class="command"><strong>web::initializer</strong></span></span> will tag these log levels and destinations as not to be deleted, after the request ends. This log condifguration will therefore also be available in the finalizer code, which is only eval'd after
the last request in the interpreter has been cleaned up.
- </p><div class="example"><a name="id360741"></a><p class="title"><b>Example 14. logging in web::initializer</b></p><pre style="background:#bbffbb ; width:75%" class="programlisting">
+ </p><div class="example"><a name="id3109745"></a><p class="title"><b>Example 17. logging in web::initializer</b></p><div class="example-contents"><pre style="background:#bbffbb ; width:75%" class="programlisting">
> cat test.ws3
web::initializer {
web::logdest add user.-debug file -unbuffered /tmp/test.log
web::logfilter add *.-debug
- web::log info "initializing interp"
+ web::log info "initializing interp"
}
web::command default {
- web::log info "command default call number [web::interpcfg numreq]"
+ web::log info "command default call number [web::interpcfg numreq]"
web::putxfile /tmp/dummypage.html
}
-
web::finalizer {
- web::log info "shutting down interp"
+ web::log info "shutting down interp"
}
web::dispatch
@@ -44,52 +42,52 @@
10/28/05 14:13:45 [20639] user.info: command default call number 0
10/28/05 14:13:46 [20639] user.info: command default call number 1
10/28/05 14:13:47 [20639] user.info: command default call number 2
-10/28/05 14:13:47 [20639] user.info: shutting down interp</pre></div><p style="width:90%">
-Note that in the above example the lifetime of the interpreter class is set to 3 requests. (See command <span style="font-family:monospace"><span><strong class="command">web::interpclasscfg</strong></span></span>.)
+10/28/05 14:13:47 [20639] user.info: shutting down interp</pre></div></div><br class="example-break"><p style="width:90%">
+Note that in the above example the lifetime of the interpreter class is set to 3 requests. (See command <span style="font-family:monospace"><span class="command"><strong>web::interpclasscfg</strong></span></span>.)
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::finalizer"></a>web::finalizer</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="web::finalizer"><div class="titlepage"><div><div><h3 class="title"><a name="web::finalizer"></a>web::finalizer</h3></div></div></div><p style="width:90%">
</p><div class="cmdsynopsis"><span style="background:#bbbbff"><span style="font-weight:bold"><code class="command">web::finalizer</code></span> <em class="replaceable"><code>code</code></em></span></div><p style="width:90%">
Register code to be exectuted when the interpreter for this
- Websh script is deleted. <span style="font-family:monospace"><span><strong class="command">web::dofinalize</strong></span></span>
+ Websh script is deleted. <span style="font-family:monospace"><span class="command"><strong>web::finalize</strong></span></span>
will then call each <tt>code</tt> block that has been
registered, starting with the most recently added
<tt>code</tt>.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::finalize"></a>web::finalize</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="web::finalize"><div class="titlepage"><div><div><h3 class="title"><a name="web::finalize"></a>web::finalize</h3></div></div></div><p style="width:90%">
</p><div class="cmdsynopsis"><span style="background:#bbbbff"><span style="font-weight:bold"><code class="command">web::finalize</code></span> </span></div><p style="width:90%">
Execute finalizer code that has been registerd using
- <span style="font-family:monospace"><span><strong class="command">web::finalizer</strong></span></span>, starting with the most
+ <span style="font-family:monospace"><span class="command"><strong>web::finalizer</strong></span></span>, starting with the most
recently added <tt>code</tt>. Note that this command
is executed automatically and does not have to be called
manually. However, it can be used as a hook, when the
interpreter is deleted:
- </p><div class="example"><a name="id360926"></a><p class="title"><b>Example 15. web::finalize hook</b></p><pre style="background:#bbffbb ; width:75%" class="programlisting">
+ </p><div class="example"><a name="id3109871"></a><p class="title"><b>Example 18. web::finalize hook</b></p><div class="example-contents"><pre style="background:#bbffbb ; width:75%" class="programlisting">
rename web::finalize web::finalize.orig
proc web::myFinalize {} {
# code to eval before finalize.orig
finalize.orig
# code to eval after finalize.orig
-} </pre></div><p style="width:90%">
+} </pre></div></div><p style="width:90%"><br class="example-break">
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::maineval"></a>web::maineval</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="web::maineval"><div class="titlepage"><div><div><h3 class="title"><a name="web::maineval"></a>web::maineval</h3></div></div></div><p style="width:90%">
</p><div class="cmdsynopsis"><span style="background:#bbbbff"><span style="font-weight:bold"><code class="command">web::maineval</code></span> <em class="replaceable"><code>code</code></em></span></div><p style="width:90%">
- Execute code in the "main" interpreter of mod_websh. (Note
+ Execute code in the "main" interpreter of mod_websh. (Note
that this is synchronized, i.e. the main interpreter is locked for
exclusive access by the current thread within the process. However,
running Apache in a prefork setting sets up a main interpreter per
child, so the exclusive access does not refer to server wide
exclusivity, but only to child process wide exclusiveity.)
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::interpclasscfg"></a>web::interpclasscfg</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="web::interpclasscfg"><div class="titlepage"><div><div><h3 class="title"><a name="web::interpclasscfg"></a>web::interpclasscfg</h3></div></div></div><p style="width:90%">
</p><div class="cmdsynopsis"><span style="background:#bbbbff"><span style="font-weight:bold"><code class="command">web::interpclasscfg</code></span> <em class="replaceable"><code>classid</code></em> <em class="replaceable"><code>property</code></em> ?<em class="replaceable"><code>value</code></em>?</span></div><p style="width:90%">
@@ -101,7 +99,7 @@
<tt>classid</tt>.
</p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term">
- <span style="font-family:monospace"><span><strong class="command">web::interpclasscfg</strong></span></span>
+ <span style="font-family:monospace"><span class="command"><strong>web::interpclasscfg</strong></span></span>
<tt><em class="replaceable"><code>classid</code></em></tt>
<tt>maxrequests</tt>
?<span class="optional"><tt><em class="replaceable"><code>value</code></em></tt></span>?
@@ -110,7 +108,7 @@
interpreters of this class should handle. If
<tt>value</tt> is 0, handle an unlimited
number of requests. Default: 1.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::interpclasscfg</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::interpclasscfg</strong></span></span>
<tt><em class="replaceable"><code>classid</code></em></tt>
<tt>maxttl</tt>
?<span class="optional"><tt><em class="replaceable"><code>value</code></em></tt></span>?</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
@@ -118,7 +116,7 @@
interpreters of this class should live. If
<tt>value</tt> is 0, it lives
forever. Default: 0.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::interpclasscfg</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::interpclasscfg</strong></span></span>
<tt><em class="replaceable"><code>classid</code></em></tt> <tt>maxidletime</tt>
?<span class="optional"><tt><em class="replaceable"><code>value</code></em></tt></span>?
</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
@@ -128,7 +126,7 @@
assumed. Default: 0.
</div></div></dd></dl></div><p style="width:90%">
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::interpcfg"></a>web::interpcfg</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="web::interpcfg"><div class="titlepage"><div><div><h3 class="title"><a name="web::interpcfg"></a>web::interpcfg</h3></div></div></div><p style="width:90%">
</p><div class="cmdsynopsis"><span style="background:#bbbbff"><span style="font-weight:bold"><code class="command">web::interpcfg</code></span> ?<em class="replaceable"><code>property</code></em>? ?<em class="replaceable"><code>value</code></em>?</span></div><p style="width:90%">
@@ -139,30 +137,30 @@
Sets or accesses properties of the current interpreter.
- </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::interpcfg</strong></span></span></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
+ </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::interpcfg</strong></span></span></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
returns <tt>classid</tt> of current
interpreter.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::interpcfg</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::interpcfg</strong></span></span>
<tt>numreq</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
gets the number of requests handled by this
interpreter.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::interpcfg</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::interpcfg</strong></span></span>
<tt>retire</tt>
?<span class="optional"><tt>boolean</tt></span>?</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
gets or sets the flag indicating this interpreter
should be removed after handling the current request.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::interpcfg</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::interpcfg</strong></span></span>
<tt>starttime</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
returns the time in seconds since the epoch, this
interpreter was started.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::interpcfg</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::interpcfg</strong></span></span>
<tt>lastusedtime</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
returns the time in seconds since the epoch, this
interpreter was last used (starttime in case of first
request).
</div></div></dd></dl></div><p style="width:90%">
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::interpmap"></a>web::interpmap</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="web::interpmap"><div class="titlepage"><div><div><h3 class="title"><a name="web::interpmap"></a>web::interpmap</h3></div></div></div><p style="width:90%">
</p><div class="cmdsynopsis"><span style="background:#bbbbff"><span style="font-weight:bold"><code class="command">web::interpmap</code></span> <em class="replaceable"><code>filename</code></em></span></div><p style="width:90%">
@@ -173,27 +171,27 @@
</p><p style="width:90%">
When a request is directed to mod_websh, Websh needs to determine the
interpreter class for that reqest. It does that by calling
- <span style="font-family:monospace"><span><strong class="command">web::interpmap</strong></span></span> with the requested file as argument.
+ <span style="font-family:monospace"><span class="command"><strong>web::interpmap</strong></span></span> with the requested file as argument.
The return value of that command is the name of the interpreter class
and at the same time the filename of the script for this interpreter
class.
- </p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id361539"></a>Example</h4></div></div></div><p style="width:90%">
- </p><pre style="background:#bbffbb ; width:75%" class="programlisting">
+
+ </p><div class="example"><a name="id3110345"></a><p class="title"><b>Example 19. web::interpmap</b></p><div class="example-contents"><pre style="background:#bbffbb ; width:75%" class="programlisting">
proc web::interpmap {filename} {
- if {[string match "/path/to/myApp" $filename]} {
+ if {[string match "/path/to/myApp" $filename]} {
# this is my special app
return /real/path/to/myApp
}
- if {[string match "*.ws3"]} {
+ if {[string match "*.ws3"]} {
# scripts have their own interp class
return $filename
}
# default: all templates are handled by my handler
return /my/special/template/handler
-} </pre><p style="width:90%">
- </p><p style="width:90%">
+} </pre></div></div><p style="width:90%"><br class="example-break">
+
The default implementation of web::interpmap is
</p><pre style="background:#bbffbb ; width:75%" class="programlisting">proc web::interpmap {filename} {return $filename}</pre><p style="width:90%">
which sets up a separate interpreter class for every requested URL
and takes the file itself as script.
- </p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="inter-process_and_-system_communication.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="misc_commands.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Inter-process/-system communication </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Miscellaneous commands</td></tr></table></div></body></html>
+ </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="inter-process_and_-system_communication.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="misc_commands.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Inter-process/-system communication </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Miscellaneous commands</td></tr></table></div></body></html>
Modified: tcl/site/websh/quickref/command_dispatching_and_session_management.html
URL: http://svn.apache.org/viewvc/tcl/site/websh/quickref/command_dispatching_and_session_management.html?rev=814735&r1=814734&r2=814735&view=diff
==============================================================================
--- tcl/site/websh/quickref/command_dispatching_and_session_management.html (original)
+++ tcl/site/websh/quickref/command_dispatching_and_session_management.html Mon Sep 14 17:04:52 2009
@@ -1,30 +1,59 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>Command dispatching and session management</title><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"><link rel="start" href="index.html" title="Websh Reference 3.6.0b4"><link rel="up" href="index.html" title="Websh Reference 3.6.0b4"><link rel="prev" href="configuration.html" title="Configuration"><link rel="next" href="request_data_handling.html" title="Request data handling"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Command dispatching and session management</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="configuration.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="request_data_handling.html">Next</a></td></tr></table><hr></div><div clas
s="section" lang="en"><div class="titlepage"><div><div><hr><h2 class="title" style="clear: both"><a name="command_dispatching_and_session_management"></a>Command dispatching and session management</h2></div></div></div><p style="width:90%">
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Command dispatching and session management</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"><link rel="home" href="index.html" title="Websh Reference 3.6.0b5"><link rel="up" href="index.html" title="Websh Reference 3.6.0b5"><link rel="prev" href="configuration.html" title="Configuration"><link rel="next" href="request_data_handling.html" title="Request data handling"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Command dispatching and session management</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="configuration.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="request_data_handling.html">Next</a></td></tr></table><hr></div><div class
="section" title="Command dispatching and session management"><div class="titlepage"><div><div><hr><h2 class="title" style="clear: both"><a name="command_dispatching_and_session_management"></a>Command dispatching and session management</h2></div></div></div><p style="width:90%">
Websh provides a command dispatching mechanism to produce,
- for example, different HTML pages within one "application",
+ for example, different HTML pages within one "application",
which is most likely one file on the file system. The name of
the command to be used for a particular page is encoded in the
- querystring (see <span style="font-family:monospace"><span><strong class="command">web::cmdurl</strong></span></span> for details on
+ querystring (see <span style="font-family:monospace"><span class="command"><strong>web::cmdurl</strong></span></span> for details on
how to produce such querystrings). Command dispatching is
- initiated with the command <span style="font-family:monospace"><span><strong class="command">web::dispatch</strong></span></span>.
- Commands are defined with <span style="font-family:monospace"><span><strong class="command">web::command</strong></span></span>.
- </p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::command"></a>web::command</h3></div></div></div><p style="width:90%">
+ initiated with the command <span style="font-family:monospace"><span class="command"><strong>web::dispatch</strong></span></span>.
+ Commands are defined with <span style="font-family:monospace"><span class="command"><strong>web::command</strong></span></span>.
+ </p><div class="section" title="web::command"><div class="titlepage"><div><div><h3 class="title"><a name="web::command"></a>web::command</h3></div></div></div><p style="width:90%">
</p><div class="cmdsynopsis"><span style="background:#bbbbff"><span style="font-weight:bold"><code class="command">web::command</code></span> ?<em class="replaceable"><code>cmdName</code></em>? <em class="replaceable"><code>cmdBody</code></em></span></div><p style="width:90%">
Registers <tt>cmdBody</tt> as
<tt>cmdName</tt>. If <tt>cmdName</tt> is
- omitted, "default" is used.
+ omitted, "default" is used.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::getcommand"></a>web::getcommand</h3></div></div></div><p style="width:90%">
+ </p><div class="example"><a name="id3044464"></a><p class="title"><b>Example 2. Simple command dispatching</b></p><div class="example-contents"><pre style="background:#bbffbb ; width:75%" class="programlisting">
+proc page {title code} {
+ web::put "<html><title>[web::htmlify $title]</title><body>"
+ web::put "<h1>[web::htmlify $title]</h1>"
+ uplevel 1 $code
+ web::put {</body></html>}
+}
+
+web::command default {
+ page "Home" {
+ web::put "<a href=\"[web::cmdurl page1]\">Link to Page 1</a>"
+ web::put "<br/>"
+ web::put "<a href=\"[web::cmdurl page2]\">Link to Page 2</a>"
+ }
+}
+
+web::command page1 {
+ page "Page 1" {
+ web::put "<a href=\"[web::cmdurl default]\">Home</a>"
+ }
+}
+
+web::command page2 {
+ page "Page 2" {
+ web::put "<a href=\"[web::cmdurl default]\">Home</a>"
+ }
+}
+
+web::dispatch</pre></div></div><p style="width:90%"><br class="example-break">
+
+ </p></div><div class="section" title="web::getcommand"><div class="titlepage"><div><div><h3 class="title"><a name="web::getcommand"></a>web::getcommand</h3></div></div></div><p style="width:90%">
</p><div class="cmdsynopsis"><span style="background:#bbbbff"><span style="font-weight:bold"><code class="command">web::getcommand</code></span> ?<em class="replaceable"><code>cmdName</code></em>?</span></div><p style="width:90%">
Retrieves the body of the command <tt>commandName</tt>
- or of the command "default" if
+ or of the command "default" if
<tt>cmdName</tt> is omitted.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::cmdurl"></a>web::cmdurl</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="web::cmdurl"><div class="titlepage"><div><div><h3 class="title"><a name="web::cmdurl"></a>web::cmdurl</h3></div></div></div><p style="width:90%">
</p><div class="cmdsynopsis"><span style="background:#bbbbff"><span style="font-weight:bold"><code class="command">web::cmdurl</code></span> ?<em class="replaceable"><code>options</code></em>? <em class="replaceable"><code>cmdName</code></em> ?<em class="replaceable"><code>key-value-list</code></em>?</span></div><p style="width:90%">
@@ -38,56 +67,56 @@
self-referencing, but the exact output is subject to
configuration. The querystring is encrypted, using the
encryption method specified by configuration (see
- <span style="font-family:monospace"><span><strong class="command">web::config</strong></span></span>). If <tt>cmdName</tt>
- is "", no command parameter is produced in the query
+ <span style="font-family:monospace"><span class="command"><strong>web::config</strong></span></span>). If <tt>cmdName</tt>
+ is "", no command parameter is produced in the query
string.
</p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><tt>-notimestamp</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
do not add a timestamp to the URL.
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>-urlformat</tt> <tt><em class="replaceable"><code>list</code></em></tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
specify what items will be used to format just this
- URL. Default is: <span style="font-family:monospace"><span><strong class="command">{scriptname pathinfo
+ URL. Default is: <span style="font-family:monospace"><span class="command"><strong>{scriptname pathinfo
querystring}</strong></span></span>.
</div><div style="margin-bottom:6">
- Note: Use <span style="font-family:monospace"><span><strong class="command">web::cmdurlcfg</strong></span></span> to define the
+ Note: Use <span style="font-family:monospace"><span class="command"><strong>web::cmdurlcfg</strong></span></span> to define the
url format for all URLs produced by
- <span style="font-family:monospace"><span><strong class="command">web::cmdurl</strong></span></span> in one request.
+ <span style="font-family:monospace"><span class="command"><strong>web::cmdurl</strong></span></span> in one request.
</div><div style="margin-bottom:6">
<div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><tt>scheme</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
- include the protocol, only "http"
- and "https" are currently supported.
+ include the protocol, only "http"
+ and "https" are currently supported.
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>host</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
include the host name,
- e.g. "websh.com".
+ e.g. "websh.com".
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>port</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
include the port,
- e.g. "80"</div><div style="margin-bottom:6"> Trying to set
+ e.g. "80"</div><div style="margin-bottom:6"> Trying to set
this item without host will throw an error.
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>scriptname</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
include scriptname,
- e.g. "/cgi-bin/orderbooks".
+ e.g. "/cgi-bin/orderbooks".
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>pathinfo</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
include pathinfo,
- e.g. "/merchants/shop1".
+ e.g. "/merchants/shop1".
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>querystring</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
include the querystring,
- e.g. "select=download".
+ e.g. "select=download".
</div></div></dd></dl></div>
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p style="width:90%">
+ <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p style="width:90%">
Note that there are two more commands that control
- the output of <span style="font-family:monospace"><span><strong class="command">web::cmdurl</strong></span></span>:
- <span style="font-family:monospace"><span><strong class="command">web::config</strong></span></span> <tt>cmdparam</tt> and
- <span style="font-family:monospace"><span><strong class="command">web::config</strong></span></span> <tt>timeparam</tt>.
+ the output of <span style="font-family:monospace"><span class="command"><strong>web::cmdurl</strong></span></span>:
+ <span style="font-family:monospace"><span class="command"><strong>web::config</strong></span></span> <tt>cmdparam</tt> and
+ <span style="font-family:monospace"><span class="command"><strong>web::config</strong></span></span> <tt>timeparam</tt>.
</p></div>
</div></div></dd></dl></div><p style="width:90%">
- </p><div class="example"><a name="id281800"></a><p class="title"><b>Example 2. web::cmdurl</b></p><pre style="background:#bbffbb ; width:75%" class="programlisting">
-% web::cmdurl -notimestamp -urlformat [list scheme host scriptname pathinfo querystring] "test"
+ </p><div class="example"><a name="id3102392"></a><p class="title"><b>Example 3. web::cmdurl</b></p><div class="example-contents"><pre style="background:#bbffbb ; width:75%" class="programlisting">
+% web::cmdurl -notimestamp -urlformat [list scheme host scriptname pathinfo querystring] "test"
http://websh.com/bin/returnmail/member?XDZuRD2rnsfHjFH
-% </pre></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::cmdurlcfg"></a>web::cmdurlcfg</h3></div></div></div><p style="width:90%">
+% </pre></div></div><br class="example-break"></div><div class="section" title="web::cmdurlcfg"><div class="titlepage"><div><div><h3 class="title"><a name="web::cmdurlcfg"></a>web::cmdurlcfg</h3></div></div></div><p style="width:90%">
</p><div class="cmdsynopsis"><span style="background:#bbbbff"><span style="font-weight:bold"><code class="command">web::cmdurlcfg</code></span> ?<em class="replaceable"><code>option</code></em>? ?<em class="replaceable"><code>key</code></em>? ?<em class="replaceable"><code>value</code></em>?</span></div><p style="width:90%">
</p><p style="width:90%">
Command options are exactly like those of
- <span style="font-family:monospace"><span><strong class="command">web::param</strong></span></span>.
+ <span style="font-family:monospace"><span class="command"><strong>web::param</strong></span></span>.
</p><p style="width:90%">
</p><div class="cmdsynopsis"><span style="background:#bbbbff"><span style="font-weight:bold"><code class="command">web::cmdurlcfg</code></span> <em class="replaceable"><code>option</code></em> ?<em class="replaceable"><code>value</code></em>?</span></div><p style="width:90%">
</p><p style="width:90%">
@@ -101,41 +130,42 @@
returned. Otherwise, the <tt>value</tt> is stored.
Configuration for web::cmdurl. This command serves two purposes:
- </p><div class="orderedlist"><ol type="1"><li><div style="margin-bottom:6">management of static parameters</div></li><li><div style="margin-bottom:6">configuration for <span style="font-family:monospace"><span><strong class="command">web::cmdurl</strong></span></span></div></li></ol></div><p style="width:90%">
- By "static parameters", we mean those which are set for every
+ </p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><div style="margin-bottom:6">management of static parameters</div></li><li class="listitem"><div style="margin-bottom:6">configuration for <span style="font-family:monospace"><span class="command"><strong>web::cmdurl</strong></span></span></div></li></ol></div><p style="width:90%">
+ By "static parameters", we mean those which are set for every
page, instead of set on a per-page basis.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="management_of_static_parameters"></a>Management of static parameters</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="Management of static parameters"><div class="titlepage"><div><div><h3 class="title"><a name="management_of_static_parameters"></a>Management of static parameters</h3></div></div></div><p style="width:90%">
In addition to the easy way of tracking parameters using
- <span style="font-family:monospace"><span><strong class="command">web::dispatch -track ...</strong></span></span>, specific values
- for parameters can be set using <span style="font-family:monospace"><span><strong class="command">web::cmdurlcfg</strong></span></span>:
+ <span style="font-family:monospace"><span class="command"><strong>web::dispatch -track ...</strong></span></span>, specific values
+ for parameters can be set using <span style="font-family:monospace"><span class="command"><strong>web::cmdurlcfg</strong></span></span>:
In order to explicitly set, retrieve, append or unset static
- parameters, use the syntax of the <span style="font-family:monospace"><span><strong class="command">web::param</strong></span></span>
+ parameters, use the syntax of the <span style="font-family:monospace"><span class="command"><strong>web::param</strong></span></span>
command, for example:
- </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::cmdurlcfg</strong></span></span> -set
+ </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::cmdurlcfg</strong></span></span> -set
<tt><em class="replaceable"><code>key</code></em></tt>
<tt><em class="replaceable"><code>value</code></em></tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
add the static parameter <tt>key</tt>.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::cmdurlcfg</strong></span></span> -names</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::cmdurlcfg</strong></span></span> -names</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
returns a list of all known static parameters.
</div></div></dd></dl></div><p style="width:90%">
</p><p style="width:90%">
- <span class="emphasis"><em>Important</em></span>: <span style="font-family:monospace"><span><strong class="command">web::cmdurl</strong></span></span>
+ <span class="emphasis"><em>Important</em></span>: <span style="font-family:monospace"><span class="command"><strong>web::cmdurl</strong></span></span>
compares every key from the static parameters (see
- <span style="font-family:monospace"><span><strong class="command">web::cmdurlcfg</strong></span></span>) against the keys from the
+ <span style="font-family:monospace"><span class="command"><strong>web::cmdurlcfg</strong></span></span>) against the keys from the
command line. The static parameter is only used if there is no
parameter of the same name given on the command line.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="configuration_for_web_cmdurl"></a>Configuration for <span style="font-family:monospace"><span><strong class="command">web::cmdurl</strong></span></span></h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="Configuration for web::cmdurl"><div class="titlepage"><div><div><h3 class="title"><a name="configuration_for_web_cmdurl"></a>Configuration for <span style="font-family:monospace"><span class="command"><strong>web::cmdurl</strong></span></span></h3></div></div></div><p style="width:90%">
- </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><tt>-protocol</tt> ?<span class="optional"><tt><em class="replaceable"><code>value</code></em></tt></span>?</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
+ </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><tt>-scheme</tt> ?<span class="optional"><tt><em class="replaceable"><code>value</code></em></tt></span>?</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
protocol to be used. Defaults to the scheme used to
- access the page, which is overridden if the user gives
+ access the page, which is overridden if the user
sets a value.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>-servername</tt> ?<span class="optional"><tt><em class="replaceable"><code>value</code></em></tt></span>?</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>-host</tt> ?<span class="optional"><tt><em class="replaceable"><code>value</code></em></tt></span>?</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
server name to be used. Default: taken from request.
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>-port</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
- port number to be used. Default: 80.
+ port number to be used. Default: taken from request, 80 if
+ not available.
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>-scriptname</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
name of CGI executable. Default: taken from request.
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>-pathinfo</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
@@ -143,38 +173,64 @@
request.
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>-urlformat</tt> <tt><em class="replaceable"><code>list</code></em></tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
changes the urlformat permanently. See
- <span style="font-family:monospace"><span><strong class="command">web::cmdurl</strong></span></span> for the description of
+ <span style="font-family:monospace"><span class="command"><strong>web::cmdurl</strong></span></span> for the description of
this option.
</div></div></dd></dl></div><p style="width:90%">
- In all cases, "web::cmdurlcfg -option
- <tt>value</tt>" sets the value of the given
+ In all these cases, "web::cmdurlcfg -option
+ <tt>value</tt>" sets the value of the given
option and returns the value that was used before the change,
- while "web::cmdurlcfg -option" returns the current
+ while "web::cmdurlcfg -option" returns the current
value. If no value has been set using web::cmdurlcfg, but is
requested for the URL generation, the value from the request
will be used. This value, however, can not be retrieved using
web::cmdurlcfg.
- </p><p style="width:90%">
- Note that setting a value to an empty string amounts to
- <span style="font-family:monospace"><span><strong class="command">unset</strong></span></span>.
+ </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><tt>-reset</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
+ will reset the <span style="font-family:monospace"><span class="command"><strong>web::cmdurlcfg</strong></span></span> configuration.
+ Note however, that static parameters will not be reset by this option. To get
+ rid of static parameters configured with the <span style="font-family:monospace"><span class="command"><strong>-set</strong></span></span> option,
+ use <span style="font-family:monospace"><span class="command"><strong>-unset</strong></span></span> with (for a specific parameter) or without (for all parameters) key.
+ </div></div></dd></dl></div><p style="width:90%">
- <span class="emphasis"><em>Note also</em></span>: web::cmdurl compares every key
- from the static parameters see -->(web::cmdurlcfg) against
+ </p><p style="width:90%">
+ <span class="emphasis"><em>Note</em></span> that setting a value to an empty string is the same as using
+ <span style="font-family:monospace"><span class="command"><strong>-unset</strong></span></span>.
+ </p><p style="width:90%">
+ <span class="emphasis"><em>Also note</em></span>: <span style="font-family:monospace"><span class="command"><strong>web::cmdurl</strong></span></span> compares every key
+ from the static parameters against
the keys from the command line. The static parameter is only
used if there is no such parameter on the command line.
- </p><div class="example"><a name="id279659"></a><p class="title"><b>Example 3. web::cmdurl</b></p><pre style="background:#bbffbb ; width:75%" class="programlisting">
-% web::cmdurl ""
+ </p><div class="example"><a name="id3102883"></a><p class="title"><b>Example 4. web::cmdurl and web::cmdurlcfg</b></p><div class="example-contents"><pre style="background:#bbffbb ; width:75%" class="programlisting">
+% web::cmdurl ""
?XDqPtk34XvyPh41gUBo
% web::cmdurlcfg -scriptname bin/test_script
-% web::cmdurl ""
+% web::cmdurl ""
bin/test_script?XDqPtk34XvyPh41gUBo
-% web::cmdurlcfg -scriptname ""
-% web::cmdurl ""
+% web::cmdurlcfg -scriptname ""
+% web::cmdurl ""
?XDqPtk34XvyPh41gUBo
-% </pre></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::dispatch"></a>web::dispatch</h3></div></div></div><p style="width:90%">
+% web::cmdurlcfg -urlformat {scheme host port querystring}
+scriptname pathinfo querystring
+% # for clearer view on what happens: disable querystring encryption
+% web::config encryptchain {}
+web::encryptd
+% web::cmdurlcfg -set foo bar
+bar
+% web::cmdurlcfg -host tcl.apache.org
+% web::cmdurl zoo
+http://tcl.apache.org:80?foo=bar&cmd=zoo&t=1141776460
+% web::cmdurlcfg -reset
+% web::cmdurl zoo
+?foo=bar&cmd=zoo&t=1141776496
+% web::config cmdurltimestamp 0
+1
+% web::config cmdparam page
+cmd
+% web::cmdurl zoo
+?foo=bar&page=zoo
+% </pre></div></div><br class="example-break"></div><div class="section" title="web::dispatch"><div class="titlepage"><div><div><h3 class="title"><a name="web::dispatch"></a>web::dispatch</h3></div></div></div><p style="width:90%">
</p><div class="cmdsynopsis"><span style="background:#bbbbff"><span style="font-weight:bold"><code class="command">web::dispatch</code></span> ?<em class="replaceable"><code>options</code></em>?</span></div><p style="width:90%">
@@ -198,7 +254,7 @@
querystring parsing is turned off. By default,
querystring is taken from the request data (CGI
environment or apache module request object).
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>-postdata</tt> <tt>""</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>-postdata</tt> <tt>""</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
do not parse any post data.
</div></div></dd><dt><span style="background:#bbbbff"><span class="term">
<tt>-postdata</tt> ?<span class="optional"><tt>#</tt></span>?<tt><em class="replaceable"><code>channelName</code></em></tt>
@@ -221,14 +277,14 @@
<tt>content_length</tt> to indicate that
Websh should read all content.</div><div style="margin-bottom:6">
Supported content types are:
- <div class="itemizedlist"><ul type="disc"><li><div style="margin-bottom:6"><code class="literal">multipart/form-data; boundary=xxxx</code></div></li><li><div style="margin-bottom:6"><code class="literal">application/x-www-form-urlencoded</code> (default)</div></li></ul></div>
+ <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><div style="margin-bottom:6"><code class="literal">multipart/form-data; boundary=xxxx</code></div></li><li class="listitem"><div style="margin-bottom:6"><code class="literal">application/x-www-form-urlencoded</code> (default)</div></li></ul></div>
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>-track</tt> <tt><em class="replaceable"><code>paramKeyList</code></em></tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
- Track a parameter: register it as "static"
+ Track a parameter: register it as "static"
for the generation of URLs with web::cmdurl. Thus,
each parameter with the key in
<tt>paramKeyList</tt> will be repeated in
every URL generated with web::cmdurl. See the
- documentation of <span style="font-family:monospace"><span><strong class="command">web::cmdurl</strong></span></span> for
+ documentation of <span style="font-family:monospace"><span class="command"><strong>web::cmdurl</strong></span></span> for
details.
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>-hook</tt> <tt><em class="replaceable"><code>code</code></em></tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
Causes web::dispatch to eval <tt>code</tt>
@@ -239,46 +295,46 @@
information when <tt>code</tt> is evaluated.
</div></div></dd></dl></div><p style="width:90%">
- <span class="emphasis"><em>Note</em></span> that, if no command is passed to
+ <span class="emphasis"><em>Note</em></span>: If no command is passed to
web::dispatch either in the querystring or with the
<tt>-cmd</tt> option, web::dispatch will call the
- command "default".
+ command "default".
- </p><div class="example"><a name="id280138"></a><p class="title"><b>Example 4. web::command and web::dispatch</b></p><pre style="background:#bbffbb ; width:75%" class="programlisting">
-% set tst {puts "On the hook"}
-puts "On the hook"
-% web::command acmd {puts "this is acmd"}
-% web::dispatch -cmd acmd -querystring "" -postdata ""
+ </p><div class="example"><a name="id3103284"></a><p class="title"><b>Example 5. web::command and web::dispatch</b></p><div class="example-contents"><pre style="background:#bbffbb ; width:75%" class="programlisting">
+% set tst {puts "On the hook"}
+puts "On the hook"
+% web::command acmd {puts "this is acmd"}
+% web::dispatch -cmd acmd -querystring "" -postdata ""
this is acmd
-% web::dispatch -cmd acmd -querystring "" -postdata "" -hook $tst
+% web::dispatch -cmd acmd -querystring "" -postdata "" -hook $tst
On the hook
this is acmd
-% set data "a=b&c=d"
+% set data "a=b&c=d"
a=b&c=d
-% web::dispatch -cmd "" -querystring "" -postdata #data
+% web::dispatch -cmd "" -querystring "" -postdata #data
% web::formvar a
b
% web::formvar c
d
-% </pre></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="session_management"></a>Session management</h3></div></div></div><p style="width:90%">
+% </pre></div></div><br class="example-break"></div><div class="section" title="Session management"><div class="titlepage"><div><div><h3 class="title"><a name="session_management"></a>Session management</h3></div></div></div><p style="width:90%">
Websh session management consits of two parts:
- </p><div class="itemizedlist"><ul type="disc"><li><div style="margin-bottom:6">session id tracking</div></li><li><div style="margin-bottom:6">session context management</div></li></ul></div><p style="width:90%">
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><div style="margin-bottom:6">session id tracking</div></li><li class="listitem"><div style="margin-bottom:6">session context management</div></li></ul></div><p style="width:90%">
</p><p style="width:90%">
Session context managers are described in detail below
- (<span style="font-family:monospace"><span><strong class="command">web::filecontext</strong></span></span>,
- <span style="font-family:monospace"><span><strong class="command">web::cookiecontext</strong></span></span>). Session id tracking is
- managed by <span style="font-family:monospace"><span><strong class="command">web::dispatch -track</strong></span></span>. The two
+ (<span style="font-family:monospace"><span class="command"><strong>web::filecontext</strong></span></span>,
+ <span style="font-family:monospace"><span class="command"><strong>web::cookiecontext</strong></span></span>). Session id tracking is
+ managed by <span style="font-family:monospace"><span class="command"><strong>web::dispatch -track</strong></span></span>. The two
parts are connected with the <tt>-attachto</tt> option
of the session context manager. The control is as follows:
</p><p style="width:90%">
- </p><div class="itemizedlist"><ul type="disc"><li><div style="margin-bottom:6">
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><div style="margin-bottom:6">
A user uses the Websh script for the first
- time.<span style="font-family:monospace"><span><strong class="command">web::dispatch -track</strong></span></span> will not
+ time.<span style="font-family:monospace"><span class="command"><strong>web::dispatch -track</strong></span></span> will not
see any session id, and, consequently, not set the
static parameter <code class="literal">id</code>.
- </div></li><li><div style="margin-bottom:6">
+ </div></li><li class="listitem"><div style="margin-bottom:6">
Within the application, the session is initialized using
- <span style="font-family:monospace"><span><strong class="command">mgr::init</strong></span></span>. <span style="font-family:monospace"><span><strong class="command">init</strong></span></span>
+ <span style="font-family:monospace"><span class="command"><strong>mgr::init</strong></span></span>. <span style="font-family:monospace"><span class="command"><strong>init</strong></span></span>
will find no static parameter <code class="literal">id</code> (which has been specified at
creation time of the session manager using the
<tt>-attachto</tt> option). Now, it tries to
@@ -287,17 +343,17 @@
was created using the <tt>-idgen</tt> option.
From now, on the session id will be a static parameter,
and will therefore be present in every URL generated
- with <span style="font-family:monospace"><span><strong class="command">web::cmdurl</strong></span></span>.
- </div></li><li><div style="margin-bottom:6">
+ with <span style="font-family:monospace"><span class="command"><strong>web::cmdurl</strong></span></span>.
+ </div></li><li class="listitem"><div style="margin-bottom:6">
The next time the user visits the Websh application
using one of these URLs,
- <span style="font-family:monospace"><span><strong class="command">web::dispatch</strong></span></span> will detect the
- session id, and <span style="font-family:monospace"><span><strong class="command">mgr::init</strong></span></span> will directly load
+ <span style="font-family:monospace"><span class="command"><strong>web::dispatch</strong></span></span> will detect the
+ session id, and <span style="font-family:monospace"><span class="command"><strong>mgr::init</strong></span></span> will directly load
the corresponding session context without generating a
new session id.
</div></li></ul></div><p style="width:90%">
- </p><div class="example"><a name="id280360"></a><p class="title"><b>Example 5. Examples</b></p><p style="width:90%">
- See <a href="http://tcl.apache.org/websh/examples.ws3" target="_top">http://tcl.apache.org/websh/examples.ws3</a>
+ </p><div class="example"><a name="id3103459"></a><p class="title"><b>Example 6. Examples</b></p><div class="example-contents"><p style="width:90%">
+ See <a class="ulink" href="http://tcl.apache.org/websh/examples.ws3" target="_top">http://tcl.apache.org/websh/examples.ws3</a>
for several sample application demonstrating Websh's
session management facilities.
- </p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="configuration.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="request_data_handling.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Configuration </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Request data handling</td></tr></table></div></body></html>
+ </p></div></div><br class="example-break"></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="configuration.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="request_data_handling.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Configuration </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Request data handling</td></tr></table></div></body></html>
Modified: tcl/site/websh/quickref/configuration.html
URL: http://svn.apache.org/viewvc/tcl/site/websh/quickref/configuration.html?rev=814735&r1=814734&r2=814735&view=diff
==============================================================================
--- tcl/site/websh/quickref/configuration.html (original)
+++ tcl/site/websh/quickref/configuration.html Mon Sep 14 17:04:52 2009
@@ -1,52 +1,78 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>Configuration</title><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"><link rel="start" href="index.html" title="Websh Reference 3.6.0b4"><link rel="up" href="index.html" title="Websh Reference 3.6.0b4"><link rel="prev" href="index.html" title="Websh Reference 3.6.0b4"><link rel="next" href="command_dispatching_and_session_management.html" title="Command dispatching and session management"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Configuration</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="command_dispatching_and_session_management.html">Next</a></td></tr></table><hr></div><div class
="section" lang="en"><div class="titlepage"><div><div><hr><h2 class="title" style="clear: both"><a name="configuration"></a>Configuration</h2></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::config"></a>web::config</h3></div></div></div><div class="cmdsynopsis"><span style="background:#bbbbff"><span style="font-weight:bold"><code class="command">web::config</code></span> <em class="replaceable"><code>key</code></em> ?<em class="replaceable"><code>value</code></em>?</span></div><p style="width:90%">
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Configuration</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"><link rel="home" href="index.html" title="Websh Reference 3.6.0b5"><link rel="up" href="index.html" title="Websh Reference 3.6.0b5"><link rel="prev" href="index.html" title="Websh Reference 3.6.0b5"><link rel="next" href="command_dispatching_and_session_management.html" title="Command dispatching and session management"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Configuration</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="command_dispatching_and_session_management.html">Next</a></td></tr></table><hr></div><div class=
"section" title="Configuration"><div class="titlepage"><div><div><hr><h2 class="title" style="clear: both"><a name="configuration"></a>Configuration</h2></div></div></div><div class="section" title="web::config"><div class="titlepage"><div><div><h3 class="title"><a name="web::config"></a>web::config</h3></div></div></div><div class="cmdsynopsis"><span style="background:#bbbbff"><span style="font-weight:bold"><code class="command">web::config</code></span> <em class="replaceable"><code>key</code></em> ?<em class="replaceable"><code>value</code></em>?</span></div><p style="width:90%">
If <tt><em class="replaceable"><code>value</code></em></tt> is
ommitted, the current value of
<tt><em class="replaceable"><code>key</code></em></tt> is returned. Note that
- unlike the <span style="font-family:monospace"><span><strong class="command">set</strong></span></span> command
- <span style="font-family:monospace"><span><strong class="command">web::config</strong></span></span> always returns the value
- for the given key before the new value is set. This allows to keep
+ unlike the <span style="font-family:monospace"><span class="command"><strong>set</strong></span></span> command
+ <span style="font-family:monospace"><span class="command"><strong>web::config</strong></span></span> always returns the value
+ for the given key <span class="emphasis"><em>before</em></span> the new value is set. This allows to keep
the old value and set it back later.
</p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><tt>uploadfilesize</tt>
?<span class="optional"><tt><em class="replaceable"><code>size</code></em></tt></span>?</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
Sets the maximum number of bytes that will be saved, when files are uploaded in a multipart form.
Default: 0.
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>cmdparam</tt> ?<span class="optional"><tt><em class="replaceable"><code>name</code></em></tt></span>?</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
- Name of the <span style="font-family:monospace"><span><strong class="command">web::command</strong></span></span> parameter in
- the URL. Default: "cmd".
+ Name of the command parameter in
+ the URL used to dispatch to <span style="font-family:monospace"><span class="command"><strong>web::command</strong></span></span> using <span style="font-family:monospace"><span class="command"><strong>web::dispatch</strong></span></span>. Default: "cmd".
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>timeparam</tt> ?<span class="optional"><tt><em class="replaceable"><code>name</code></em></tt></span>?</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
Name of the timestamp parameter in the URL. Default:
- "t".
+ "t".
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>cmdurltimestamp</tt> ?<span class="optional"><tt>0|1</tt></span>?</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
Defines whether the timestamp should be included in URLs
- generated by <span style="font-family:monospace"><span><strong class="command">web::cmdurl</strong></span></span>. Default: 1
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>logsubst</tt> ?<span class="optional"><tt>boolean</tt></span>?</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
- Turns substitution of log messages on or off. Default:
- off.
+ generated by <span style="font-family:monospace"><span class="command"><strong>web::cmdurl</strong></span></span>. Default: 1 (yes)
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>logsubst</tt> ?<span class="optional"><tt>0|1</tt></span>?</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
+ Turns substitution of log messages on (1) or off (0). Default:
+ 0 (off).
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>safelog</tt> ?<span class="optional"><tt>0|1</tt></span>?</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
+ Makes web::log "safe" if set to 1 (i.e. it never throws an error even if corresponding I/O to file, channel or command etc. fails). Default: 1 (on).
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>putxmarkup</tt>
?<span class="optional"><tt>brace|tag</tt></span>?</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
Sets the markup characters for sections to be eval'd in
- <span style="font-family:monospace"><span><strong class="command">web::putx</strong></span></span> and <span style="font-family:monospace"><span><strong class="command">web::putxfile</strong></span></span>
+ <span style="font-family:monospace"><span class="command"><strong>web::putx</strong></span></span> and <span style="font-family:monospace"><span class="command"><strong>web::putxfile</strong></span></span>
commands to either curly braces ({ ... }) or special tags (<?
- ... ?>). Default: brace.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>version</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
- Returns the version info string.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>copyright</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
- Returns a copyright message string.
+ ... ?>). Default: "brace".
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>encryptchain</tt> ?<span class="optional"><tt><em class="replaceable"><code>list</code></em></tt></span>?</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
Defines which commands should be tried, in sequence, to
- encrypt a message. Default: "web::encryptd".
+ encrypt a message. Default: "web::encryptd".
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>decryptchain</tt> ?<span class="optional"><tt><em class="replaceable"><code>list</code></em></tt></span>?</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
Defines which commands should be tried, in sequence, to
- decrypt a message. Default: "web::decryptd".
+ decrypt a message. Default: "web::decryptd".
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>filepermissions</tt> ?<span class="optional"><tt><em class="replaceable"><code>permissions</code></em></tt></span>?</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
Defines the file permissions of files that Websh creates.
This affects the creation of log files, filecounters, session files,
and temporary files created when files are uploaded in multipart forms (see
-<span style="font-family:monospace"><span><strong class="command">web::formvar</strong></span></span>). Default is 0644.
- </div></div></dd></dl></div><div class="example"><a name="id281226"></a><p class="title"><b>Example 1. web::config</b></p><pre style="background:#bbffbb ; width:75%" class="programlisting">
+<span style="font-family:monospace"><span class="command"><strong>web::formvar</strong></span></span>). Default is 0644.
+ </div></div></dd></dl></div><p style="width:90%">
+The following special subcommand is used to reset all configuration options to their default values:
+ </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><tt>reset</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
+ Resets all values to their defaults.
+ </div></div></dd></dl></div><p style="width:90%">
+The following two subcommands are read-only and just return their predefined values:
+ </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><tt>version</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
+ Returns the version info string.
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>copyright</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
+ Returns a copyright message string.
+ </div></div></dd></dl></div><p style="width:90%">
+The following subcommands are also read-only. They return the current request environment within mod_websh (and if applicable in CGI mode):
+ </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><tt>script</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
+ Returns the path to the currently requestes Websh script.
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>server_root</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
+ Returns the Apache ServerRoot configuration path.
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>document_root</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
+ Returns the Apache DocumentRoot configuration path.
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>interpclass</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
+ Returns the interpclass the current request was mapped to (see <span style="font-family:monospace"><span class="command"><strong>web::interpmap</strong></span></span> command).
+ </div></div></dd></dl></div><div class="example"><a name="id3044356"></a><p class="title"><b>Example 1. web::config</b></p><div class="example-contents"><pre style="background:#bbffbb ; width:75%" class="programlisting">
% web::config decryptchain
web::encryptd
+% web::config filepermissions 0666
+0644
+% web::config filepermissions
+0666
+% web::config putxmarkup tag
+brace
+% web::config reset
% web::config filepermissions
0644
-% </pre></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="command_dispatching_and_session_management.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Websh Reference 3.6.0b4 </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Command dispatching and session management</td></tr></table></div></body></html>
+% web::config putxmarkup
+brace
+% </pre></div></div><br class="example-break"></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="command_dispatching_and_session_management.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Websh Reference 3.6.0b5 </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Command dispatching and session management</td></tr></table></div></body></html>
---------------------------------------------------------------------
To unsubscribe, e-mail: site-cvs-unsubscribe@tcl.apache.org
For additional commands, e-mail: site-cvs-help@tcl.apache.org