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 2011/04/22 22:46:39 UTC
svn commit: r1096031 [1/3] - /tcl/site/websh/quickref/
Author: ronnie
Date: Fri Apr 22 20:46:38 2011
New Revision: 1096031
URL: http://svn.apache.org/viewvc?rev=1096031&view=rev
Log:
- latest version
Modified:
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/quickref/Apache_module_specific_commands.html
URL: http://svn.apache.org/viewvc/tcl/site/websh/quickref/Apache_module_specific_commands.html?rev=1096031&r1=1096030&r2=1096031&view=diff
==============================================================================
--- tcl/site/websh/quickref/Apache_module_specific_commands.html (original)
+++ tcl/site/websh/quickref/Apache_module_specific_commands.html Fri Apr 22 20:46:38 2011
@@ -1,9 +1,10 @@
-<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%">
+<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><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
+ <span style="font-family:monospace"><span class="command"><strong>web::initializer</strong></span></span> and
+ <span style="font-family:monospace"><span class="command"><strong>web::finalizer</strong></span></span>, which just evaluate the
code provided in the argument.
- </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="section" title="web::initializer"><div class="titlepage"><div><div><h3 class="title"><a name="web::initializer"></a><span style="font-family:monospace"><span class="command"><strong>web::initializer</strong></span></span></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%">
@@ -13,11 +14,18 @@
<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.
+ 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 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="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">
+ 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="id2759558"></a><p class="title"><b>Example 17. logging in <span style="font-family:monospace"><span class="command">web::initializer</span></span></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
@@ -45,29 +53,29 @@ web::dispatch
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" 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><div class="section" title="web::finalizer"><div class="titlepage"><div><div><h3 class="title"><a name="web::finalizer"></a><span style="font-family:monospace"><span class="command"><strong>web::finalizer</strong></span></span></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
+ Registers code to be exectuted when the interpreter for this
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" 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><div class="section" title="web::finalize"><div class="titlepage"><div><div><h3 class="title"><a name="web::finalize"></a><span style="font-family:monospace"><span class="command"><strong>web::finalize</strong></span></span></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
+ Executes finalizer code that has been registered using
<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="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">
+ </p><div class="example"><a name="id2759695"></a><p class="title"><b>Example 18. <span style="font-family:monospace"><span class="command">web::finalize</span></span> 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
@@ -75,19 +83,19 @@ proc web::myFinalize {} {
# code to eval after finalize.orig
} </pre></div></div><p style="width:90%"><br class="example-break">
- </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><div class="section" title="web::maineval"><div class="titlepage"><div><div><h3 class="title"><a name="web::maineval"></a><span style="font-family:monospace"><span class="command"><strong>web::maineval</strong></span></span></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
+ Executes 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" 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><div class="section" title="web::interpclasscfg"><div class="titlepage"><div><div><h3 class="title"><a name="web::interpclasscfg"></a><span style="font-family:monospace"><span class="command"><strong>web::interpclasscfg</strong></span></span></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%">
@@ -95,7 +103,7 @@ proc web::myFinalize {} {
Properties are: <tt>maxrequests</tt>,
<tt>maxttl</tt>, <tt>maxidletime</tt>
- Set or accesses properties of the interpreter class
+ Sets or accesses properties of the interpreter class
<tt>classid</tt>.
</p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term">
@@ -104,7 +112,7 @@ proc web::myFinalize {} {
<tt>maxrequests</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">
- gets or sets the maximum number of requests
+ Sets or gets the maximum number of requests
interpreters of this class should handle. If
<tt>value</tt> is 0, handle an unlimited
number of requests. Default: 1.
@@ -112,7 +120,7 @@ proc web::myFinalize {} {
<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">
- gets or sets the maximum number of seconds
+ Sets or gets the maximum number of seconds
interpreters of this class should live. If
<tt>value</tt> is 0, it lives
forever. Default: 0.
@@ -120,13 +128,13 @@ proc web::myFinalize {} {
<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">
- gets or sets the maximum number of seconds
+ Sets or gets the maximum number of seconds
interpreters of this class should live beeing idle. If
<tt>value</tt> is 0, no idle timeout is
assumed. Default: 0.
</div></div></dd></dl></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><div class="section" title="web::interpcfg"><div class="titlepage"><div><div><h3 class="title"><a name="web::interpcfg"></a><span style="font-family:monospace"><span class="command"><strong>web::interpcfg</strong></span></span></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%">
@@ -138,29 +146,29 @@ proc web::myFinalize {} {
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 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
+ Returns <tt>classid</tt> of current
interpreter.
</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
+ Returns 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 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
+ Sets or gets 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 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
+ 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 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
+ 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" 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><div class="section" title="web::interpmap"><div class="titlepage"><div><div><h3 class="title"><a name="web::interpmap"></a><span style="font-family:monospace"><span class="command"><strong>web::interpmap</strong></span></span></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%">
@@ -176,7 +184,7 @@ proc web::myFinalize {} {
and at the same time the filename of the script for this interpreter
class.
- </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">
+ </p><div class="example"><a name="id2760186"></a><p class="title"><b>Example 19. <span style="font-family:monospace"><span class="command">web::interpmap</span></span></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]} {
# this is my special app
@@ -190,8 +198,8 @@ proc web::interpmap {filename} {
return /my/special/template/handler
} </pre></div></div><p style="width:90%"><br class="example-break">
- The default implementation of web::interpmap is
+ The default implementation of <span style="font-family:monospace"><span class="command"><strong>web::interpmap</strong></span></span> 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
+ This sets up a separate interpreter class for every requested URL
and takes the file itself as script.
</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=1096031&r1=1096030&r2=1096031&view=diff
==============================================================================
--- tcl/site/websh/quickref/command_dispatching_and_session_management.html (original)
+++ tcl/site/websh/quickref/command_dispatching_and_session_management.html Fri Apr 22 20:46:38 2011
@@ -1,4 +1,4 @@
-<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%">
+<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><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",
which is most likely one file on the file system. The name of
@@ -7,14 +7,14 @@
how to produce such querystrings). Command dispatching is
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="section" title="web::command"><div class="titlepage"><div><div><h3 class="title"><a name="web::command"></a><span style="font-family:monospace"><span class="command"><strong>web::command</strong></span></span></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.
- </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">
+ </p><div class="example"><a name="id2696602"></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>"
@@ -44,7 +44,7 @@ web::command page2 {
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><div class="section" title="web::getcommand"><div class="titlepage"><div><div><h3 class="title"><a name="web::getcommand"></a><span style="font-family:monospace"><span class="command"><strong>web::getcommand</strong></span></span></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%">
@@ -53,7 +53,7 @@ web::dispatch</pre></div></div><p style=
or of the command "default" if
<tt>cmdName</tt> is omitted.
- </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><div class="section" title="web::cmdurl"><div class="titlepage"><div><div><h3 class="title"><a name="web::cmdurl"></a><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="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%">
@@ -72,10 +72,10 @@ web::dispatch</pre></div></div><p style=
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.
+ Tells Websh not to add a timestamp to URLs.
</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 class="command"><strong>{scriptname pathinfo
+ Specifies which items will be used to format just this
+ URL. Default: <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 class="command"><strong>web::cmdurlcfg</strong></span></span> to define the
@@ -83,36 +83,38 @@ web::dispatch</pre></div></div><p style=
<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"
+ Includes 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,
+ Includes the host name,
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,
+ Includes the port,
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,
+ Includes scriptname,
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,
+ Includes pathinfo,
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,
+ Includes the querystring,
e.g. "select=download".
</div></div></dd></dl></div>
- <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 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="id3102392"></a><p class="title"><b>Example 3. web::cmdurl</b></p><div class="example-contents"><pre style="background:#bbffbb ; width:75%" class="programlisting">
+ </p><p style="width:90%">
+ </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3>
+ Note that there are two more commands that control
+ 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>.
+ </div><p style="width:90%">
+ </p><div class="example"><a name="id2751741"></a><p class="title"><b>Example 3. <span style="font-family:monospace"><span class="command">web::cmdurl</span></span></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><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%">
+% </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><span style="font-family:monospace"><span class="command"><strong>web::cmdurlcfg</strong></span></span></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
@@ -129,8 +131,10 @@ http://websh.com/bin/returnmail/member?X
<tt>value</tt> is omitted, the current value is
returned. Otherwise, the <tt>value</tt> is stored.
- Configuration for web::cmdurl. This command serves two purposes:
- </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%">
+ Configuration for <span style="font-family:monospace"><span class="command"><strong>web::cmdurl</strong></span></span>.
+ This command serves two purposes:
+ </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" 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%">
@@ -144,9 +148,9 @@ http://websh.com/bin/returnmail/member?X
</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>.
+ Adds the static parameter <tt>key</tt>.
</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.
+ Returns a list of all known static parameters.
</div></div></dd></dl></div><p style="width:90%">
</p><p style="width:90%">
@@ -158,51 +162,56 @@ http://websh.com/bin/returnmail/member?X
</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>-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
+ Sets or gets protocol to be used. Defaults to the scheme used
+ to access the page, which is overridden if the user
sets a value.
</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.
+ Sets or gets 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: taken from request, 80 if
- not available.
+ Sets or gets 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">
- path info (path after scriptname). Default: taken from
+ Sets or gets 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">
+ Sets or gets path info (path after scriptname). Default:
+ taken from 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
+ Sets or gets the urlformat permanently. See
<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 these cases, "web::cmdurlcfg -option
- <tt>value</tt>" sets the value of the given
+ In all these cases, "<span style="font-family:monospace"><span class="command"><strong>web::cmdurlcfg -option
+ <tt>value</tt></strong></span></span>" sets the value of the given
option and returns the value that was used before the change,
- while "web::cmdurlcfg -option" returns the current
- value. If no value has been set using web::cmdurlcfg, but is
+ while "<span style="font-family:monospace"><span class="command"><strong>web::cmdurlcfg -option</strong></span></span>" returns
+ the current value. If no value has been set using
+ <span style="font-family:monospace"><span class="command"><strong>web::cmdurlcfg</strong></span></span>, 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.
+ <span style="font-family:monospace"><span class="command"><strong>web::cmdurlcfg</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.
+ Resets 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%">
</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>.
+ <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
+ <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="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">
+ </p><div class="example"><a name="id2752263"></a><p class="title"><b>Example 4. <span style="font-family:monospace"><span class="command">web::cmdurl</span></span> and <span style="font-family:monospace"><span class="command">web::cmdurlcfg</span></span></b></p><div class="example-contents"><pre style="background:#bbffbb ; width:75%" class="programlisting">
% web::cmdurl ""
?XDqPtk34XvyPh41gUBo
% web::cmdurlcfg -scriptname bin/test_script
@@ -230,7 +239,7 @@ http://tcl.apache.org:80?foo=bar&cmd
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%">
+% </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><span style="font-family:monospace"><span class="command"><strong>web::dispatch</strong></span></span></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%">
@@ -242,36 +251,40 @@ cmd
Parse information and call a command.
</p><p style="width:90%">
</p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><tt>-cmd</tt> <tt><em class="replaceable"><code>cmdName</code></em></tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
- switch into command <tt>cmdName</tt>. If
+ Switches to command <tt>cmdName</tt>. If
<tt>cmdName</tt> is an empty string, no
command is called. By default,
<tt>cmdName</tt> is taken from the
querystring.
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>-querystring</tt>
<tt><em class="replaceable"><code>string</code></em></tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
- parse <tt>string</tt> as the querystring. If
+ Parses <tt>string</tt> as the querystring. If
<tt>string</tt> is an empty string,
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">
- do not parse any post data.
+ 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>
<tt><em class="replaceable"><code>?<span class="optional">content_length</span>?</code></em></tt>
<tt><em class="replaceable"><code>?<span class="optional">content_type</span>?</code></em></tt>
</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
- parse channel <tt>channelName</tt> (or variable named <tt>channelName</tt> if <tt>#</tt> is given) as POST data input with
- length <tt>content_length</tt> and type <tt>content_type</tt>.
- <tt>content_type</tt> can be <code class="literal">application/x-www-form-urlencoded</code>
+ Parse channel <tt>channelName</tt> (or variable
+ named <tt>channelName</tt> if <tt>#</tt> is
+ given) as POST data input with length
+ <tt>content_length</tt> and type
+ <tt>content_type</tt>. <tt>content_type</tt>
+ can be <code class="literal">application/x-www-form-urlencoded</code>
or <code class="literal">multipart/form-data;
boundary=xxx</code>.
-In the case of multipat form data,
+ In the case of multipat form data,
<tt>content-type</tt> must specify the
boundary as well. By default, POST data is taken from
the request data.</div><div style="margin-bottom:6"> Default for
<tt>content_type</tt> is <code class="literal">application/x-www-form-urlencoded</code>.
- Default for <tt>content_length</tt> is to read a channel up to EOF or the full content of the variable.
+ Default for <tt>content_length</tt> is to read a
+ channel up to EOF or the full content of the variable.
</div><div style="margin-bottom:6">
Use the keyword <code class="literal">end</code> for
<tt>content_length</tt> to indicate that
@@ -280,27 +293,30 @@ In the case of multipat form data,
<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"
- for the generation of URLs with web::cmdurl. Thus,
+ for the generation of URLs with
+ <span style="font-family:monospace"><span class="command"><strong>web::cmdurl</strong></span></span>. 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 class="command"><strong>web::cmdurl</strong></span></span> for
+ every URL generated with <span style="font-family:monospace"><span class="command"><strong>web::cmdurl</strong></span></span>.
+ See the 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>
+ Causes <span style="font-family:monospace"><span class="command"><strong>web::dispatch</strong></span></span> to eval
+ <tt>code</tt>
just before the command (from any source) is
evaluated. When <tt>code</tt> is evaluated,
the full request information has been parsed. That
- is, web::param, web::formvar etc. will have up-to-date
+ is, <span style="font-family:monospace"><span class="command"><strong>web::param</strong></span></span>,
+ <span style="font-family:monospace"><span class="command"><strong>web::formvar</strong></span></span> etc. will have up-to-date
information when <tt>code</tt> is evaluated.
</div></div></dd></dl></div><p style="width:90%">
<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".
+ <span style="font-family:monospace"><span class="command"><strong>web::dispatch</strong></span></span> either in the querystring or with the
+ <tt>-cmd</tt> option, <span style="font-family:monospace"><span class="command"><strong>web::dispatch</strong></span></span> will
+ call the command "default".
- </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">
+ </p><div class="example"><a name="id2752714"></a><p class="title"><b>Example 5. <span style="font-family:monospace"><span class="command">web::command</span></span> and <span style="font-family:monospace"><span class="command">web::dispatch</span></span></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"}
@@ -318,7 +334,7 @@ b
d
% </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 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><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 class="command"><strong>web::filecontext</strong></span></span>,
@@ -352,7 +368,7 @@ d
the corresponding session context without generating a
new session id.
</div></li></ul></div><p style="width:90%">
- </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%">
+ </p><div class="example"><a name="id2752899"></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/" target="_top">http://tcl.apache.org/websh/examples/</a>
for several sample application demonstrating Websh's
session management facilities.
Modified: tcl/site/websh/quickref/configuration.html
URL: http://svn.apache.org/viewvc/tcl/site/websh/quickref/configuration.html?rev=1096031&r1=1096030&r2=1096031&view=diff
==============================================================================
--- tcl/site/websh/quickref/configuration.html (original)
+++ tcl/site/websh/quickref/configuration.html Fri Apr 22 20:46:38 2011
@@ -1,20 +1,21 @@
-<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%">
+<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><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><span style="font-family:monospace"><span class="command"><strong>web::config</strong></span></span></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 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.
+ 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.
+ Sets or gets 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 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".
+ Sets or gets 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:
+ Sets or gets name of the timestamp parameter in the URL. Default:
"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
@@ -23,36 +24,45 @@
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).
+ Makes <span style="font-family:monospace"><span class="command"><strong>web::log</strong></span></span> "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
+ Sets or gets the markup characters for sections to be eval'd in
<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>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".
+ Sets or gets the list of commands that should be tried, in
+ sequence, to 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".
+ Sets or gets the list of commands that should be tried, in
+ sequence, to 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 class="command"><strong>web::formvar</strong></span></span>). Default is 0644.
+ Sets or gets 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 class="command"><strong>web::formvar</strong></span></span>). Default:
+ 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:
+ 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:
+ 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):
+ 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">
@@ -60,8 +70,9 @@ The following subcommands are also read-
</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">
+ 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="id2696486"></a><p class="title"><b>Example 1. <span style="font-family:monospace"><span class="command">web::config</span></span></b></p><div class="example-contents"><pre style="background:#bbffbb ; width:75%" class="programlisting">
% web::config decryptchain
web::encryptd
% web::config filepermissions 0666
---------------------------------------------------------------------
To unsubscribe, e-mail: site-cvs-unsubscribe@tcl.apache.org
For additional commands, e-mail: site-cvs-help@tcl.apache.org