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 [2/3] - in /tcl/site/websh: ./ quickref/
Modified: tcl/site/websh/quickref/context_handling.html
URL: http://svn.apache.org/viewvc/tcl/site/websh/quickref/context_handling.html?rev=814735&r1=814734&r2=814735&view=diff
==============================================================================
--- tcl/site/websh/quickref/context_handling.html (original)
+++ tcl/site/websh/quickref/context_handling.html Mon Sep 14 17:04:52 2009
@@ -1,5 +1,4 @@
-<!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>Context handling</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="logging.html" title="Logging"><link rel="next" href="file_handling_and_file_IO.html" title="File handling and file I/O"></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">Context handling</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="logging.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="file_handling_and_file_IO.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h
r><h2 class="title" style="clear: both"><a name="context_handling"></a>Context handling</h2></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::context"></a>web::context</h3></div></div></div><p style="width:90%">
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Context handling</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="logging.html" title="Logging"><link rel="next" href="file_handling_and_file_IO.html" title="File handling and file I/O"></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">Context handling</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="logging.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="file_handling_and_file_IO.html">Next</a></td></tr></table><hr></div><div class="section" title="Context handling"><div class="titlepage
"><div><div><hr><h2 class="title" style="clear: both"><a name="context_handling"></a>Context handling</h2></div></div></div><div class="section" title="web::context"><div class="titlepage"><div><div><h3 class="title"><a name="web::context"></a>web::context</h3></div></div></div><p style="width:90%">
Creation
</p><div class="cmdsynopsis"><span style="background:#bbbbff"><span style="font-weight:bold"><code class="command">web::context</code></span> <em class="replaceable"><code>name</code></em></span></div><p style="width:90%">
Creates a namespace <tt>name</tt> with the following
@@ -17,22 +16,22 @@
Manages data of the context. The subcommands behave like the
Tcl commands with similar names.
- </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::cset</strong></span></span>
+ </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::cset</strong></span></span>
<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">
store <tt>value</tt>.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::cappend</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::cappend</strong></span></span>
<tt><em class="replaceable"><code>key</code></em></tt> <tt><em class="replaceable"><code>value</code></em></tt>
?<span class="optional"><tt><em class="replaceable"><code>value</code></em></tt></span>?
?<span class="optional"><tt><em class="replaceable"><code>...</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">
append <tt>value</tt> to existing value for
<tt>key</tt>.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::clappend</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::clappend</strong></span></span>
<tt><em class="replaceable"><code>key</code></em></tt> <tt><em class="replaceable"><code>value</code></em></tt>
?<span class="optional"><tt><em class="replaceable"><code>value</code></em></tt></span>?
?<span class="optional"><tt><em class="replaceable"><code>...</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">
append <tt>value</tt> to existing list of
values for <tt>key</tt>.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::cget</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::cget</strong></span></span>
<tt><em class="replaceable"><code>key</code></em></tt>
?<span class="optional"><tt><em class="replaceable"><code>default</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">
access the value for key <tt>key</tt>, or
@@ -40,37 +39,37 @@
<tt>key</tt> does not exist in the context. If
<tt>default</tt> is omitted, an empty string
is returned if <tt>key</tt> is unknown.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::cexists</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::cexists</strong></span></span>
<tt><em class="replaceable"><code>key</code></em></tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
returns true (1) if <tt>key</tt> exists in
context, false (0) otherwise.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::cunset</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::cunset</strong></span></span>
<tt><em class="replaceable"><code>key</code></em></tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
remove <tt>key</tt> from context.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::carray</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::carray</strong></span></span>
<tt><em class="replaceable"><code>option</code></em></tt> <tt><em class="replaceable"><code>key</code></em></tt>
<tt><em class="replaceable"><code>arg</code></em></tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
array manipulation as known from the Tcl command
<span class="emphasis"><em>array</em></span>.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::cnames</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::cnames</strong></span></span>
?<span class="optional"><tt><em class="replaceable"><code>pattern</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">
lists existing keys of context matching
<tt>pattern</tt>.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::delete</strong></span></span></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
- delete the context (same as <span style="font-family:monospace"><span><strong class="command">namespace delete <em class="replaceable"><code>name</code></em></strong></span></span>)
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::dump</strong></span></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"><span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::delete</strong></span></span></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
+ delete the context (same as <span style="font-family:monospace"><span class="command"><strong>namespace delete <em class="replaceable"><code>name</code></em></strong></span></span>)
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::dump</strong></span></span></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
serialize context.
</div></div></dd></dl></div><p style="width:90%">
- </p><div class="example"><a name="id357275"></a><p class="title"><b>Example 9. web::context</b></p><pre style="background:#bbffbb ; width:75%" class="programlisting">
+ </p><div class="example"><a name="id3106952"></a><p class="title"><b>Example 12. web::context</b></p><div class="example-contents"><pre style="background:#bbffbb ; width:75%" class="programlisting">
% web::context sc
% sc::cset lang FR
FR
% # ... some code ...
% set lang [sc::cget lang EN]
FR
-% </pre></div><p style="width:90%">
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::filecontext"></a>web::filecontext</h3></div></div></div><p style="width:90%">
+% </pre></div></div><p style="width:90%"><br class="example-break">
+ </p></div><div class="section" title="web::filecontext"><div class="titlepage"><div><div><h3 class="title"><a name="web::filecontext"></a>web::filecontext</h3></div></div></div><p style="width:90%">
Creation:
</p><div class="cmdsynopsis"><span style="background:#bbbbff"><span style="font-weight:bold"><code class="command">web::filecontext</code></span> <em class="replaceable"><code>name</code></em> ?<em class="replaceable"><code>options</code></em>?</span></div><p style="width:90%">
@@ -95,7 +94,7 @@
Manages file-based context data. The subcommands have their
familiar behaviour of the Tcl commands with similar
- names. Please refer to the section <a href="context_handling.html" title="Context handling">context management</a> for a
+ names. Please refer to the section <a class="link" href="context_handling.html" title="Context handling">context management</a> for a
description of the commands <tt>cset</tt>,
<tt>cappend</tt>, <tt>clappend</tt>,
<tt>cget</tt>, <tt>cexists</tt>,
@@ -103,7 +102,7 @@
<tt>cnames</tt>.
</p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term">
- <span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::init</strong></span></span>
+ <span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::init</strong></span></span>
?<span class="optional"><tt><em class="replaceable"><code>id</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">
load an existing session context with id
@@ -114,16 +113,16 @@
<tt>id</tt>, you must decide when to create a
new file and when to use the old one, if any, by
yourself.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::new</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::new</strong></span></span>
?<span class="optional"><tt><em class="replaceable"><code>id</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">
create a new session context. Automation depends on
the settings of the actual context manager settings,
see below.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::commit</strong></span></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"><span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::commit</strong></span></span></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
make session context persistent.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::id</strong></span></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"><span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::id</strong></span></span></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
return id of session.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::invalidate</strong></span></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"><span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::invalidate</strong></span></span></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
delete session in memory and on file system.
</div></div></dd></dl></div><p style="width:90%">
@@ -133,10 +132,10 @@
set the file permissions of the session context files
<tt>perm</tt> is an unix-like octal value like 0644.
If not specified, files are created with the permissions defined
- in <span style="font-family:monospace"><span><strong class="command">web::config filepermissions</strong></span></span>,
+ in <span style="font-family:monospace"><span class="command"><strong>web::config filepermissions</strong></span></span>,
which again defaults to 0644.
- </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::filecontext</strong></span></span>
+ </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::filecontext</strong></span></span>
<tt><em class="replaceable"><code>name</code></em></tt> <tt>-path</tt>
<tt><em class="replaceable"><code>path</code></em></tt>
</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
@@ -145,23 +144,23 @@
<span class="emphasis"><em>-path [file join .. data s%d.dat]</em></span>
would then cause filecontext to save the session
context as <code class="literal">../data/s99.dat</code>.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::filecontext</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::filecontext</strong></span></span>
<tt><em class="replaceable"><code>name</code></em></tt> <tt>-crypt</tt>
<tt>boolean</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
Flag to turn crypting of session context on and off.
Default is on.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::filecontext</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::filecontext</strong></span></span>
<tt><em class="replaceable"><code>name</code></em></tt> <tt>-idgen</tt>
<tt><em class="replaceable"><code>idgen</code></em></tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
Sets command <tt>idgen</tt> to find a new
session id. See doc of
- <span style="font-family:monospace"><span><strong class="command">web::filecounter</strong></span></span> below for an
+ <span style="font-family:monospace"><span class="command"><strong>web::filecounter</strong></span></span> below for an
implementation provided with Websh.
</div><div style="margin-bottom:6">
<tt>idgen</tt> is used in case that no
<tt>id</tt> argument has been passed to
<tt>init</tt> or <tt>new</tt>.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::filecontext</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::filecontext</strong></span></span>
<tt><em class="replaceable"><code>name</code></em></tt> <tt>-attachto</tt>
<tt><em class="replaceable"><code>idparam</code></em></tt>
</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
@@ -183,7 +182,7 @@
whatever information that you might have stored in the context
before you initialized it as a file-based session context.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::cookiecontext"></a>web::cookiecontext</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="web::cookiecontext"><div class="titlepage"><div><div><h3 class="title"><a name="web::cookiecontext"></a>web::cookiecontext</h3></div></div></div><p style="width:90%">
Creation:
@@ -197,7 +196,7 @@
Creates a namespace <tt>name</tt> to manage
cookie-based context data:
- </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::subcommand</strong></span></span>
+ </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::subcommand</strong></span></span>
<tt><em class="replaceable"><code>args</code></em></tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
Subcommands are: <tt>cset</tt>,
<tt>cappend</tt>, <tt>clappend</tt>,
@@ -208,24 +207,24 @@
<tt>invalidate</tt>, and <tt>id</tt>.
</div></div></dd></dl></div><p style="width:90%">
- </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::init</strong></span></span>
+ </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::init</strong></span></span>
?<span class="optional"><tt><em class="replaceable"><code>id</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">
load an existing session context (cookie must have
been sent by the client).
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::new</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::new</strong></span></span>
?<span class="optional"><tt><em class="replaceable"><code>id</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">
create a new session context.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::commit</strong></span></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"><span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::commit</strong></span></span></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
send a cookie.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::id</strong></span></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"><span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::id</strong></span></span></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
return id of session.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command"><em class="replaceable"><code>name</code></em>::invalidate</strong></span></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"><span style="font-family:monospace"><span class="command"><strong><em class="replaceable"><code>name</code></em>::invalidate</strong></span></span></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
delete session in memory and on client side.
</div></div></dd></dl></div><p style="width:90%">
Options:
- </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::cookiecontext</strong></span></span>
+ </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::cookiecontext</strong></span></span>
<tt><em class="replaceable"><code>name</code></em></tt> <tt>-expires</tt>
<tt><em class="replaceable"><code>time</code></em></tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
set the expiration date of the cookie. Possible values
@@ -240,48 +239,48 @@
(i.e. cookie expires in 24 hours. (Please note that the
behavior of some of these relative time specifiers changed
from Tcl8.4 to Tcl8.5.) Use
- <span class="emphasis"><em>-expires ""</em></span> to
+ <span class="emphasis"><em>-expires ""</em></span> to
send a cookie without an expires parameter.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::cookiecontext</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::cookiecontext</strong></span></span>
<tt><em class="replaceable"><code>name</code></em></tt> <tt>-path</tt>
<tt><em class="replaceable"><code>path</code></em></tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
set the <tt>path</tt> property of the cookie.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::cookiecontext</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::cookiecontext</strong></span></span>
<tt><em class="replaceable"><code>name</code></em></tt> <tt>-domain</tt>
<tt><em class="replaceable"><code>domain</code></em></tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
set the <tt>domain</tt> property of the cookie.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::cookiecontext</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::cookiecontext</strong></span></span>
<tt><em class="replaceable"><code>name</code></em></tt>
<tt>-secure</tt> <tt>boolean</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
set the <tt>secure</tt> property of the cookie.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::cookiecontext</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::cookiecontext</strong></span></span>
<tt><em class="replaceable"><code>name</code></em></tt> <tt>-crypt</tt>
<tt>boolean</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
Flag to turn crypting of cookie context on and off.
Default is on.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::cookiecontext</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::cookiecontext</strong></span></span>
<tt><em class="replaceable"><code>name</code></em></tt> <tt>-channel</tt>
<tt><em class="replaceable"><code>channelName</code></em></tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
The response object to send the cookie to (see also
- <span style="font-family:monospace"><span><strong class="command">web::response</strong></span></span>).
+ <span style="font-family:monospace"><span class="command"><strong>web::response</strong></span></span>).
</div></div></dd></dl></div><p style="width:90%">
Because cookies are client-based, in principle no id is
needed. Websh uses <tt>id</tt> to name the cookie,
- however, and the <span style="font-family:monospace"><span><strong class="command">new</strong></span></span>,
- <span style="font-family:monospace"><span><strong class="command">init</strong></span></span>, and <span style="font-family:monospace"><span><strong class="command">load</strong></span></span> commands
+ however, and the <span style="font-family:monospace"><span class="command"><strong>new</strong></span></span>,
+ <span style="font-family:monospace"><span class="command"><strong>init</strong></span></span>, and <span style="font-family:monospace"><span class="command"><strong>load</strong></span></span> commands
still require the <tt>id</tt> argument. (fixme: any
changes?) Please note that property settings of a cookie
context can only be changed <span class="emphasis"><em>before</em></span>
anything is output on the respective channel.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::filecounter"></a>web::filecounter</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="web::filecounter"><div class="titlepage"><div><div><h3 class="title"><a name="web::filecounter"></a>web::filecounter</h3></div></div></div><p style="width:90%">
This is a numeric sequence-number generator which stores its
state in a file. Basic usage:
</p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term">Creation:</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
- <span style="font-family:monospace"><span><strong class="command">web::filecounter</strong></span></span>
+ <span style="font-family:monospace"><span class="command"><strong>web::filecounter</strong></span></span>
<tt><em class="replaceable"><code>name</code></em></tt> <tt>-filename</tt>
<tt><em class="replaceable"><code>fname</code></em></tt>
?<span class="optional"><tt><em class="replaceable"><code>options</code></em></tt></span>?
@@ -308,7 +307,7 @@
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>-perms</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">
Sets the permissions on the newly created files.
- (Default is configured in <span style="font-family:monospace"><span><strong class="command">web::config filepermissions</strong></span></span>, which defaults to 0644.)
+ (Default is configured in <span style="font-family:monospace"><span class="command"><strong>web::config filepermissions</strong></span></span>, which defaults to 0644.)
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt>-wrap</tt>
<tt>boolean</tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
Indicates whether this counter should wrap around its
@@ -324,13 +323,13 @@
Return the next value.
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt><em class="replaceable"><code>name</code></em></tt> curval</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
Return the current value, that is, the value that the
- last call to "nextval" or "getval" reported (as opposed
+ last call to "nextval" or "getval" reported (as opposed
to the current value in the file).
</div></div></dd><dt><span style="background:#bbbbff"><span class="term"><tt><em class="replaceable"><code>name</code></em></tt> getval</span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
- Return the current value in the file. (Do not increment file as in "nextval".)
+ Return the current value in the file. (Do not increment file as in "nextval".)
</div></div></dd></dl></div><p style="width:90%">
- </p><div class="example"><a name="id359142"></a><p class="title"><b>Example 10. web::filecounter</b></p><pre style="background:#bbffbb ; width:75%" class="programlisting">
+ </p><div class="example"><a name="id3108465"></a><p class="title"><b>Example 13. web::filecounter</b></p><div class="example-contents"><pre style="background:#bbffbb ; width:75%" class="programlisting">
% web::filecounter fc1 -filename test.dat
fc1
% fc1 config
@@ -367,4 +366,4 @@
1
% fc3 nextval
3
-% </pre></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="logging.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="file_handling_and_file_IO.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Logging </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> File handling and file I/O</td></tr></table></div></body></html>
+% </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="logging.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="file_handling_and_file_IO.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Logging </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> File handling and file I/O</td></tr></table></div></body></html>
Modified: tcl/site/websh/quickref/data_encryption.html
URL: http://svn.apache.org/viewvc/tcl/site/websh/quickref/data_encryption.html?rev=814735&r1=814734&r2=814735&view=diff
==============================================================================
--- tcl/site/websh/quickref/data_encryption.html (original)
+++ tcl/site/websh/quickref/data_encryption.html Mon Sep 14 17:04:52 2009
@@ -1,40 +1,39 @@
-<!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>Data encryption</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="file_handling_and_file_IO.html" title="File handling and file I/O"><link rel="next" href="uri-html-_en-decoding.html" title="Uri-/html- en-/decoding"></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">Data encryption</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="file_handling_and_file_IO.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="uri-html-_en-decoding.html">Next</a></td></tr></table><hr></div><div class="section" lan
g="en"><div class="titlepage"><div><div><hr><h2 class="title" style="clear: both"><a name="data_encryption"></a>Data encryption</h2></div></div></div><p style="width:90%">
- Encrypt (<span style="font-family:monospace"><span><strong class="command">web::encrypt</strong></span></span>) and decrypt
- (<span style="font-family:monospace"><span><strong class="command">web::decrypt</strong></span></span>) data. By default, the
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Data encryption</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="file_handling_and_file_IO.html" title="File handling and file I/O"><link rel="next" href="uri-html-_en-decoding.html" title="Uri-/html- en-/decoding"></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">Data encryption</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="file_handling_and_file_IO.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="uri-html-_en-decoding.html">Next</a></td></tr></table><hr></div><div class="section" titl
e="Data encryption"><div class="titlepage"><div><div><hr><h2 class="title" style="clear: both"><a name="data_encryption"></a>Data encryption</h2></div></div></div><p style="width:90%">
+ Encrypt (<span style="font-family:monospace"><span class="command"><strong>web::encrypt</strong></span></span>) and decrypt
+ (<span style="font-family:monospace"><span class="command"><strong>web::decrypt</strong></span></span>) data. By default, the
built-in, weak encryption is used. encryption is extensible by
plug-Ins. The encryption module tries all plug-Ins from a list
until the first plug-In was able to en-/decrypt the input. See
- <span style="font-family:monospace"><span><strong class="command">web::config</strong></span></span> for the configuration of the
+ <span style="font-family:monospace"><span class="command"><strong>web::config</strong></span></span> for the configuration of the
plug-Ins to be used.
- </p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::encrypt"></a>web::encrypt</h3></div></div></div><p style="width:90%">
+ </p><div class="section" title="web::encrypt"><div class="titlepage"><div><div><h3 class="title"><a name="web::encrypt"></a>web::encrypt</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::encrypt</code></span> <em class="replaceable"><code>data</code></em></span></div><p style="width:90%">
Returns encrypted data.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::decrypt"></a>web::decrypt</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="web::decrypt"><div class="titlepage"><div><div><h3 class="title"><a name="web::decrypt"></a>web::decrypt</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::decrypt</code></span> <em class="replaceable"><code>data</code></em></span></div><p style="width:90%">
Returns decrypted data.
- </p><div class="example"><a name="id359617"></a><p class="title"><b>Example 12. web::encrypt</b></p><pre style="background:#bbffbb ; width:75%" class="programlisting">
-% web::encrypt "Hello, world!"
+ </p><div class="example"><a name="id3108846"></a><p class="title"><b>Example 15. web::encrypt</b></p><div class="example-contents"><pre style="background:#bbffbb ; width:75%" class="programlisting">
+% web::encrypt "Hello, world!"
XDIVAhkgkxRjcfA7UTwpD7
-% web::decrypt [web::encrypt "Hello, world!"]
+% web::decrypt [web::encrypt "Hello, world!"]
Hello, world!
-% </pre></div><p style="width:90%">
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="encryption_plug-in_D"></a>Encryption plug-in D</h3></div></div></div><p style="width:90%">
+% </pre></div></div><p style="width:90%"><br class="example-break">
+ </p></div><div class="section" title="Encryption plug-in D"><div class="titlepage"><div><div><h3 class="title"><a name="encryption_plug-in_D"></a>Encryption plug-in D</h3></div></div></div><p style="width:90%">
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::encryptd"></a>web::encryptd</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="web::encryptd"><div class="titlepage"><div><div><h3 class="title"><a name="web::encryptd"></a>web::encryptd</h3></div></div></div><p style="width:90%">
By default, Websh uses this plug-In for weak data
- encryption for encryption (<span style="font-family:monospace"><span><strong class="command">web::encryptd</strong></span></span>)
- and decryption (<span style="font-family:monospace"><span><strong class="command">web::decryptd</strong></span></span>). The
+ encryption for encryption (<span style="font-family:monospace"><span class="command"><strong>web::encryptd</strong></span></span>)
+ and decryption (<span style="font-family:monospace"><span class="command"><strong>web::decryptd</strong></span></span>). The
encryption key is managed with
- <span style="font-family:monospace"><span><strong class="command">web::crpytdkey</strong></span></span>.
+ <span style="font-family:monospace"><span class="command"><strong>web::crpytdkey</strong></span></span>.
</p><p style="width:90%">
@@ -42,14 +41,14 @@
Returns encrypted <tt><em class="replaceable"><code>data</code></em></tt>.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::decryptd"></a>web::decryptd</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="web::decryptd"><div class="titlepage"><div><div><h3 class="title"><a name="web::decryptd"></a>web::decryptd</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::decryptd</code></span> <em class="replaceable"><code>data</code></em></span></div><p style="width:90%">
Returns decrypted <tt><em class="replaceable"><code>data</code></em></tt>.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::cryptdkey"></a>web::cryptdkey</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="web::cryptdkey"><div class="titlepage"><div><div><h3 class="title"><a name="web::cryptdkey"></a>web::cryptdkey</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::cryptdkey</code></span> ?<em class="replaceable"><code>key</code></em>?</span></div><p style="width:90%">
@@ -58,23 +57,23 @@
currently active key, in difference to other configuration
commands of Websh.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="encryption_plug-in_interface_"></a>Encryption plug-in interface</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="Encryption plug-in interface"><div class="titlepage"><div><div><h3 class="title"><a name="encryption_plug-in_interface_"></a>Encryption plug-in interface</h3></div></div></div><p style="width:90%">
<span class="emphasis"><em>For plug-in developers only</em></span>
</p><p style="width:90%">
The encryption plug-in is required to implement the interface
- described below (note that to activate your plugin, use <span style="font-family:monospace"><span><strong class="command">web::config encryptchain</strong></span></span> and <span style="font-family:monospace"><span><strong class="command">web::config decryptchain</strong></span></span> respectively):
- </p><div class="itemizedlist"><ul type="disc"><li><div style="margin-bottom:6">
- <span style="font-family:monospace"><span><strong class="command">web::yourencrypt</strong></span></span> accepts one argument
+ described below (note that to activate your plugin, use <span style="font-family:monospace"><span class="command"><strong>web::config encryptchain</strong></span></span> and <span style="font-family:monospace"><span class="command"><strong>web::config decryptchain</strong></span></span> respectively):
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><div style="margin-bottom:6">
+ <span style="font-family:monospace"><span class="command"><strong>web::yourencrypt</strong></span></span> accepts one argument
web::yourencrypt takes a string as input and generates a
string which must be URI compliant.
- </div></li><li><div style="margin-bottom:6">
- <span style="font-family:monospace"><span><strong class="command">web::yourdecrypt</strong></span></span> accepts one argument
+ </div></li><li class="listitem"><div style="margin-bottom:6">
+ <span style="font-family:monospace"><span class="command"><strong>web::yourdecrypt</strong></span></span> accepts one argument
web::yourdecrypt takes a string as input and returns a
string.
- </div></li><li><div style="margin-bottom:6">symmetry: <span class="emphasis"><em><span style="font-family:monospace"><span><strong class="command">$in ==
+ </div></li><li class="listitem"><div style="margin-bottom:6">symmetry: <span class="emphasis"><em><span style="font-family:monospace"><span class="command"><strong>$in ==
[web::yourdecrypt [web::yourencrypt
$in]]</strong></span></span></em></span>
- </div></li><li><div style="margin-bottom:6">
+ </div></li><li class="listitem"><div style="margin-bottom:6">
error messaging: <span class="emphasis"><em>TCL_OK</em></span> for
success. <span class="emphasis"><em>TCL_ERROR</em></span> for any error
during en-/decryption. <span class="emphasis"><em>TCL_CONTINUE</em></span>
Modified: tcl/site/websh/quickref/file_handling_and_file_IO.html
URL: http://svn.apache.org/viewvc/tcl/site/websh/quickref/file_handling_and_file_IO.html?rev=814735&r1=814734&r2=814735&view=diff
==============================================================================
--- tcl/site/websh/quickref/file_handling_and_file_IO.html (original)
+++ tcl/site/websh/quickref/file_handling_and_file_IO.html Mon Sep 14 17:04:52 2009
@@ -1,14 +1,13 @@
-<!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>File handling and file I/O</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="context_handling.html" title="Context handling"><link rel="next" href="data_encryption.html" title="Data encryption"></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">File handling and file I/O</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="context_handling.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="data_encryption.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepa
ge"><div><div><hr><h2 class="title" style="clear: both"><a name="file_handling_and_file_IO"></a>File handling and file I/O</h2></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::include"></a>web::include</h3></div></div></div><p style="width:90%">
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>File handling and file I/O</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="context_handling.html" title="Context handling"><link rel="next" href="data_encryption.html" title="Data encryption"></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">File handling and file I/O</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="context_handling.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="data_encryption.html">Next</a></td></tr></table><hr></div><div class="section" title="File handling and file
I/O"><div class="titlepage"><div><div><hr><h2 class="title" style="clear: both"><a name="file_handling_and_file_IO"></a>File handling and file I/O</h2></div></div></div><div class="section" title="web::include"><div class="titlepage"><div><div><h3 class="title"><a name="web::include"></a>web::include</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_include</code></span> <em class="replaceable"><code>fileName</code></em> ?<em class="replaceable"><code>msg</code></em>?</span></div><p style="width:90%">
If the file <tt>fileName</tt> exists, it is sourced (must be a
- script). Otherwise if the library fileName+"shared lib extension"
+ script). Otherwise if the library fileName+"shared lib extension"
exists, it is loaded (must be a shared library). Returns 0 on success,
1 otherwise. If an error occurs, an error message is written to <tt>msg</tt>.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::readfile"></a>web::readfile</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="web::readfile"><div class="titlepage"><div><div><h3 class="title"><a name="web::readfile"></a>web::readfile</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::readfile</code></span> <em class="replaceable"><code>file</code></em> <em class="replaceable"><code>varName</code></em> <em class="replaceable"><code>msg</code></em></span></div><p style="width:90%">
@@ -18,7 +17,7 @@
otherwise. If an error occurs, an error message is written to
the variable <tt>msg</tt>.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::lockfile_and_web::unlockfile"></a>web::lockfile and web::unlockfile</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="web::lockfile and web::unlockfile"><div class="titlepage"><div><div><h3 class="title"><a name="web::lockfile_and_web::unlockfile"></a>web::lockfile and web::unlockfile</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::lockfile</code></span> <em class="replaceable"><code>fh</code></em></span></div><p style="width:90%">
</p><div class="cmdsynopsis"><span style="background:#bbbbff"><span style="font-weight:bold"><code class="command">web::unlockfile</code></span> <em class="replaceable"><code>fh</code></em></span></div><p style="width:90%">
@@ -31,7 +30,7 @@
<span class="emphasis"><em>Note</em></span> that the file needs to be open for
writing.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::truncatefile"></a>web::truncatefile</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="web::truncatefile"><div class="titlepage"><div><div><h3 class="title"><a name="web::truncatefile"></a>web::truncatefile</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::truncatefile</code></span> <em class="replaceable"><code>fh</code></em></span></div><p style="width:90%">
@@ -40,9 +39,9 @@
handle, while Tcl's file commands are based on file
names. This is used to truncate a file while holding the lock.
- </p><div class="example"><a name="id359457"></a><p class="title"><b>Example 11. web::lockfile</b></p><pre style="background:#bbffbb ; width:75%" class="programlisting">
+ </p><div class="example"><a name="id3108726"></a><p class="title"><b>Example 14. web::lockfile</b></p><div class="example-contents"><pre style="background:#bbffbb ; width:75%" class="programlisting">
set fh [open [web::tempfile] w]
web::lockfile $fh
puts $fh foo
web::unlockfile $fh
-close $fh </pre></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="context_handling.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="data_encryption.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Context handling </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Data encryption</td></tr></table></div></body></html>
+close $fh </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="context_handling.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="data_encryption.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Context handling </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Data encryption</td></tr></table></div></body></html>
Modified: tcl/site/websh/quickref/index.html
URL: http://svn.apache.org/viewvc/tcl/site/websh/quickref/index.html?rev=814735&r1=814734&r2=814735&view=diff
==============================================================================
--- tcl/site/websh/quickref/index.html (original)
+++ tcl/site/websh/quickref/index.html Mon Sep 14 17:04:52 2009
@@ -1,28 +1,27 @@
-<!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>Websh Reference 3.6.0b4</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="next" href="configuration.html" title="Configuration"></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">Websh Reference 3.6.0b4</th></tr><tr><td width="20%" align="left"> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="configuration.html">Next</a></td></tr></table><hr></div><div class="article" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id336409"></a>Websh Reference 3.6.0b4</h2></div><div><p class="releaseinfo">
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Websh Reference 3.6.0b5</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="next" href="configuration.html" title="Configuration"></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">Websh Reference 3.6.0b5</th></tr><tr><td width="20%" align="left"> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="configuration.html">Next</a></td></tr></table><hr></div><div lang="en" class="article" title="Websh Reference 3.6.0b5"><div class="titlepage"><div><div><h2 class="title"><a name="id2972033"></a>Websh Reference 3.6.0b5</h2></div><div><p class="releaseinfo">
$Id$
- </p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="index.html#intro">Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="index.html#general_remarks">General remarks</a></span></dt><dt><span class="section"><a href="index.html#about">About this document</a></span></dt></dl></dd><dt><span class="section"><a href="configuration.html">Configuration</a></span></dt><dd><dl><dt><span class="section"><a href="configuration.html#web::config">web::config</a></span></dt></dl></dd><dt><span class="section"><a href="command_dispatching_and_session_management.html">Command dispatching and session management</a></span></dt><dd><dl><dt><span class="section"><a href="command_dispatching_and_session_management.html#web::command">web::command</a></span></dt><dt><span class="section"><a href="command_dispatching_and_session_management.html#web::getcommand">web::getcommand</a></span></dt><dt><span class="section
"><a href="command_dispatching_and_session_management.html#web::cmdurl">web::cmdurl</a></span></dt><dt><span class="section"><a href="command_dispatching_and_session_management.html#web::cmdurlcfg">web::cmdurlcfg</a></span></dt><dt><span class="section"><a href="command_dispatching_and_session_management.html#management_of_static_parameters">Management of static parameters</a></span></dt><dt><span class="section"><a href="command_dispatching_and_session_management.html#configuration_for_web_cmdurl">Configuration for <span style="font-family:monospace"><span><strong class="command">web::cmdurl</strong></span></span></a></span></dt><dt><span class="section"><a href="command_dispatching_and_session_management.html#web::dispatch">web::dispatch</a></span></dt><dt><span class="section"><a href="command_dispatching_and_session_management.html#session_management">Session management</a></span></dt></dl></dd><dt><span class="section"><a href="request_data_handling.html">Request data h
andling</a></span></dt><dd><dl><dt><span class="section"><a href="request_data_handling.html#web::request">web::request</a></span></dt><dt><span class="section"><a href="request_data_handling.html#web::param">web::param</a></span></dt><dt><span class="section"><a href="request_data_handling.html#web::formvar">web::formvar</a></span></dt></dl></dd><dt><span class="section"><a href="response_data_handling.html">Response data handling</a></span></dt><dd><dl><dt><span class="section"><a href="response_data_handling.html#web::response">web::response</a></span></dt><dt><span class="section"><a href="response_data_handling.html#web::put">web::put</a></span></dt><dt><span class="section"><a href="response_data_handling.html#web::putx">web::putx</a></span></dt><dt><span class="section"><a href="response_data_handling.html#web::putxfile">web::putxfile</a></span></dt></dl></dd><dt><span class="section"><a href="logging.html">Logging</a></span></dt><dd><dl><dt><span class="section"><a h
ref="logging.html#web::logdest">web::logdest</a></span></dt><dt><span class="section"><a href="logging.html#web::loglevel">web::loglevel</a></span></dt><dt><span class="section"><a href="logging.html#web::log">web::log</a></span></dt><dt><span class="section"><a href="logging.html#log_plug-ins">Log plug-ins</a></span></dt></dl></dd><dt><span class="section"><a href="context_handling.html">Context handling</a></span></dt><dd><dl><dt><span class="section"><a href="context_handling.html#web::context">web::context</a></span></dt><dt><span class="section"><a href="context_handling.html#web::filecontext">web::filecontext</a></span></dt><dt><span class="section"><a href="context_handling.html#web::cookiecontext">web::cookiecontext</a></span></dt><dt><span class="section"><a href="context_handling.html#web::filecounter">web::filecounter</a></span></dt></dl></dd><dt><span class="section"><a href="file_handling_and_file_IO.html">File handling and file I/O</a></span></dt><dd><dl><dt><s
pan class="section"><a href="file_handling_and_file_IO.html#web::include">web::include</a></span></dt><dt><span class="section"><a href="file_handling_and_file_IO.html#web::readfile">web::readfile</a></span></dt><dt><span class="section"><a href="file_handling_and_file_IO.html#web::lockfile_and_web::unlockfile">web::lockfile and web::unlockfile</a></span></dt><dt><span class="section"><a href="file_handling_and_file_IO.html#web::truncatefile">web::truncatefile</a></span></dt></dl></dd><dt><span class="section"><a href="data_encryption.html">Data encryption</a></span></dt><dd><dl><dt><span class="section"><a href="data_encryption.html#web::encrypt">web::encrypt</a></span></dt><dt><span class="section"><a href="data_encryption.html#web::decrypt">web::decrypt</a></span></dt><dt><span class="section"><a href="data_encryption.html#encryption_plug-in_D">Encryption plug-in D</a></span></dt><dt><span class="section"><a href="data_encryption.html#web::encryptd">web::encryptd</a></spa
n></dt><dt><span class="section"><a href="data_encryption.html#web::decryptd">web::decryptd</a></span></dt><dt><span class="section"><a href="data_encryption.html#web::cryptdkey">web::cryptdkey</a></span></dt><dt><span class="section"><a href="data_encryption.html#encryption_plug-in_interface_">Encryption plug-in interface</a></span></dt></dl></dd><dt><span class="section"><a href="uri-html-_en-decoding.html">Uri-/html- en-/decoding</a></span></dt><dd><dl><dt><span class="section"><a href="uri-html-_en-decoding.html#web::htmlify">web::htmlify</a></span></dt><dt><span class="section"><a href="uri-html-_en-decoding.html#web::dehtmlify">web::dehtmlify</a></span></dt><dt><span class="section"><a href="uri-html-_en-decoding.html#web::uriencode">web::uriencode</a></span></dt><dt><span class="section"><a href="uri-html-_en-decoding.html#web::uridecode">web::uridecode</a></span></dt></dl></dd><dt><span class="section"><a href="inter-process_and_-system_communication.html">Inter-proc
ess/-system communication</a></span></dt><dd><dl><dt><span class="section"><a href="inter-process_and_-system_communication.html#web::send">web::send</a></span></dt><dt><span class="section"><a href="inter-process_and_-system_communication.html#web::recv">web::recv</a></span></dt><dt><span class="section"><a href="inter-process_and_-system_communication.html#web::msgflag">web::msgflag</a></span></dt></dl></dd><dt><span class="section"><a href="Apache_module_specific_commands.html">Apache module specific commands</a></span></dt><dd><dl><dt><span class="section"><a href="Apache_module_specific_commands.html#web::initializer">web::initializer</a></span></dt><dt><span class="section"><a href="Apache_module_specific_commands.html#web::finalizer">web::finalizer</a></span></dt><dt><span class="section"><a href="Apache_module_specific_commands.html#web::finalize">web::finalize</a></span></dt><dt><span class="section"><a href="Apache_module_specific_commands.html#web::maineval">web::
maineval</a></span></dt><dt><span class="section"><a href="Apache_module_specific_commands.html#web::interpclasscfg">web::interpclasscfg</a></span></dt><dt><span class="section"><a href="Apache_module_specific_commands.html#web::interpcfg">web::interpcfg</a></span></dt><dt><span class="section"><a href="Apache_module_specific_commands.html#web::interpmap">web::interpmap</a></span></dt></dl></dd><dt><span class="section"><a href="misc_commands.html">Miscellaneous commands</a></span></dt><dd><dl><dt><span class="section"><a href="misc_commands.html#web::match">web::match</a></span></dt><dt><span class="section"><a href="misc_commands.html#web::tempfile">web::tempfile</a></span></dt></dl></dd></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><hr><h2 class="title" style="clear: both"><a name="intro"></a>Introduction</h2></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="general_remarks"></a>Genera
l remarks</h3></div></div></div><p style="width:90%">
- Websh 3.6 (pronounced "web shell") embeds a Tcl interpreter,
+ </p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="index.html#intro">Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="index.html#general_remarks">General remarks</a></span></dt><dt><span class="section"><a href="index.html#about">About this document</a></span></dt></dl></dd><dt><span class="section"><a href="configuration.html">Configuration</a></span></dt><dd><dl><dt><span class="section"><a href="configuration.html#web::config">web::config</a></span></dt></dl></dd><dt><span class="section"><a href="command_dispatching_and_session_management.html">Command dispatching and session management</a></span></dt><dd><dl><dt><span class="section"><a href="command_dispatching_and_session_management.html#web::command">web::command</a></span></dt><dt><span class="section"><a href="command_dispatching_and_session_management.html#web::getcommand">web::getcommand</a></span></dt><dt><span class="section
"><a href="command_dispatching_and_session_management.html#web::cmdurl">web::cmdurl</a></span></dt><dt><span class="section"><a href="command_dispatching_and_session_management.html#web::cmdurlcfg">web::cmdurlcfg</a></span></dt><dt><span class="section"><a href="command_dispatching_and_session_management.html#management_of_static_parameters">Management of static parameters</a></span></dt><dt><span class="section"><a href="command_dispatching_and_session_management.html#configuration_for_web_cmdurl">Configuration for <span style="font-family:monospace"><span class="command"><strong>web::cmdurl</strong></span></span></a></span></dt><dt><span class="section"><a href="command_dispatching_and_session_management.html#web::dispatch">web::dispatch</a></span></dt><dt><span class="section"><a href="command_dispatching_and_session_management.html#session_management">Session management</a></span></dt></dl></dd><dt><span class="section"><a href="request_data_handling.html">Request data h
andling</a></span></dt><dd><dl><dt><span class="section"><a href="request_data_handling.html#web::request">web::request</a></span></dt><dt><span class="section"><a href="request_data_handling.html#web::param">web::param</a></span></dt><dt><span class="section"><a href="request_data_handling.html#web::formvar">web::formvar</a></span></dt></dl></dd><dt><span class="section"><a href="response_data_handling.html">Response data handling</a></span></dt><dd><dl><dt><span class="section"><a href="response_data_handling.html#web::response">web::response</a></span></dt><dt><span class="section"><a href="response_data_handling.html#web::put">web::put</a></span></dt><dt><span class="section"><a href="response_data_handling.html#web::putx">web::putx</a></span></dt><dt><span class="section"><a href="response_data_handling.html#web::putxfile">web::putxfile</a></span></dt></dl></dd><dt><span class="section"><a href="logging.html">Logging</a></span></dt><dd><dl><dt><span class="section"><a h
ref="logging.html#web::logdest">web::logdest</a></span></dt><dt><span class="section"><a href="logging.html#web::loglevel">web::loglevel</a></span></dt><dt><span class="section"><a href="logging.html#web::log">web::log</a></span></dt><dt><span class="section"><a href="logging.html#log_plug-ins">Log plug-ins</a></span></dt></dl></dd><dt><span class="section"><a href="context_handling.html">Context handling</a></span></dt><dd><dl><dt><span class="section"><a href="context_handling.html#web::context">web::context</a></span></dt><dt><span class="section"><a href="context_handling.html#web::filecontext">web::filecontext</a></span></dt><dt><span class="section"><a href="context_handling.html#web::cookiecontext">web::cookiecontext</a></span></dt><dt><span class="section"><a href="context_handling.html#web::filecounter">web::filecounter</a></span></dt></dl></dd><dt><span class="section"><a href="file_handling_and_file_IO.html">File handling and file I/O</a></span></dt><dd><dl><dt><s
pan class="section"><a href="file_handling_and_file_IO.html#web::include">web::include</a></span></dt><dt><span class="section"><a href="file_handling_and_file_IO.html#web::readfile">web::readfile</a></span></dt><dt><span class="section"><a href="file_handling_and_file_IO.html#web::lockfile_and_web::unlockfile">web::lockfile and web::unlockfile</a></span></dt><dt><span class="section"><a href="file_handling_and_file_IO.html#web::truncatefile">web::truncatefile</a></span></dt></dl></dd><dt><span class="section"><a href="data_encryption.html">Data encryption</a></span></dt><dd><dl><dt><span class="section"><a href="data_encryption.html#web::encrypt">web::encrypt</a></span></dt><dt><span class="section"><a href="data_encryption.html#web::decrypt">web::decrypt</a></span></dt><dt><span class="section"><a href="data_encryption.html#encryption_plug-in_D">Encryption plug-in D</a></span></dt><dt><span class="section"><a href="data_encryption.html#web::encryptd">web::encryptd</a></spa
n></dt><dt><span class="section"><a href="data_encryption.html#web::decryptd">web::decryptd</a></span></dt><dt><span class="section"><a href="data_encryption.html#web::cryptdkey">web::cryptdkey</a></span></dt><dt><span class="section"><a href="data_encryption.html#encryption_plug-in_interface_">Encryption plug-in interface</a></span></dt></dl></dd><dt><span class="section"><a href="uri-html-_en-decoding.html">Uri-/html- en-/decoding</a></span></dt><dd><dl><dt><span class="section"><a href="uri-html-_en-decoding.html#web::htmlify">web::htmlify</a></span></dt><dt><span class="section"><a href="uri-html-_en-decoding.html#web::dehtmlify">web::dehtmlify</a></span></dt><dt><span class="section"><a href="uri-html-_en-decoding.html#web::uriencode">web::uriencode</a></span></dt><dt><span class="section"><a href="uri-html-_en-decoding.html#web::uridecode">web::uridecode</a></span></dt></dl></dd><dt><span class="section"><a href="inter-process_and_-system_communication.html">Inter-proc
ess/-system communication</a></span></dt><dd><dl><dt><span class="section"><a href="inter-process_and_-system_communication.html#web::send">web::send</a></span></dt><dt><span class="section"><a href="inter-process_and_-system_communication.html#web::recv">web::recv</a></span></dt><dt><span class="section"><a href="inter-process_and_-system_communication.html#web::msgflag">web::msgflag</a></span></dt></dl></dd><dt><span class="section"><a href="Apache_module_specific_commands.html">Apache module specific commands</a></span></dt><dd><dl><dt><span class="section"><a href="Apache_module_specific_commands.html#web::initializer">web::initializer</a></span></dt><dt><span class="section"><a href="Apache_module_specific_commands.html#web::finalizer">web::finalizer</a></span></dt><dt><span class="section"><a href="Apache_module_specific_commands.html#web::finalize">web::finalize</a></span></dt><dt><span class="section"><a href="Apache_module_specific_commands.html#web::maineval">web::
maineval</a></span></dt><dt><span class="section"><a href="Apache_module_specific_commands.html#web::interpclasscfg">web::interpclasscfg</a></span></dt><dt><span class="section"><a href="Apache_module_specific_commands.html#web::interpcfg">web::interpcfg</a></span></dt><dt><span class="section"><a href="Apache_module_specific_commands.html#web::interpmap">web::interpmap</a></span></dt></dl></dd><dt><span class="section"><a href="misc_commands.html">Miscellaneous commands</a></span></dt><dd><dl><dt><span class="section"><a href="misc_commands.html#web::match">web::match</a></span></dt><dt><span class="section"><a href="misc_commands.html#web::tempfile">web::tempfile</a></span></dt></dl></dd></dl></div><div class="section" title="Introduction"><div class="titlepage"><div><div><hr><h2 class="title" style="clear: both"><a name="intro"></a>Introduction</h2></div></div></div><div class="section" title="General remarks"><div class="titlepage"><div><div><h3 class="title"><a name="ge
neral_remarks"></a>General remarks</h3></div></div></div><p style="width:90%">
+ Websh 3.6 (pronounced "web shell") embeds a Tcl interpreter,
(version 8.3 or higher) and all Tcl commands are available.
</p><p style="width:90%">
Typically, Websh commands have the following syntax:
</p><div class="cmdsynopsis"><span style="background:#bbbbff"><span style="font-weight:bold"><code class="command">web::acommand</code></span> ?options? ?subcommands? ?arguments?</span></div><p style="width:90%">
- Options start with a dash ("-"). As usual, dash-dash
- ("--") indicates the
- "end-of-options". Thus,
+ Options start with a dash ("-"). As usual, dash-dash
+ ("--") indicates the
+ "end-of-options". Thus,
</p><pre style="background:#bbffbb ; width:75%" class="programlisting">web::acommand -o1 a1 -- -o2</pre><p style="width:90%">
- takes "-o2" as the first argument.
+ takes "-o2" as the first argument.
</p><p style="width:90%">
Instead of the normal Tcl behaviour, Websh configuration
commands normally return the previous value when a new value
is set.
</p><p style="width:90%">
- In addition to the examples given here, you might find <a href="http://tcl.apache.org/websh/examples.ws3" target="_top">http://tcl.apache.org/websh/examples.ws3</a>
+ In addition to the examples given here, you might find <a class="ulink" href="http://tcl.apache.org/websh/examples.ws3" target="_top">http://tcl.apache.org/websh/examples.ws3</a>
a useful source of information.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="about"></a>About this document</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="About this document"><div class="titlepage"><div><div><h3 class="title"><a name="about"></a>About this document</h3></div></div></div><p style="width:90%">
The original version of this document can always be found at
- <a href="http://tcl.apache.org/websh/download/" target="_top">http://tcl.apache.org/websh/download/</a>.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p style="width:90%">
+ <a class="ulink" href="http://tcl.apache.org/websh/download/" target="_top">http://tcl.apache.org/websh/download/</a>.
+ </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p style="width:90%">
We try to keep this quick reference up-to-date and hope that
it will be useful. We do not guarantee that it is suitable for
any particular purpose whatsoever. The authors accept no
Modified: tcl/site/websh/quickref/inter-process_and_-system_communication.html
URL: http://svn.apache.org/viewvc/tcl/site/websh/quickref/inter-process_and_-system_communication.html?rev=814735&r1=814734&r2=814735&view=diff
==============================================================================
--- tcl/site/websh/quickref/inter-process_and_-system_communication.html (original)
+++ tcl/site/websh/quickref/inter-process_and_-system_communication.html Mon Sep 14 17:04:52 2009
@@ -1,7 +1,6 @@
-<!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>Inter-process/-system communication</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="uri-html-_en-decoding.html" title="Uri-/html- en-/decoding"><link rel="next" href="Apache_module_specific_commands.html" title="Apache module specific 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">Inter-process/-system communication</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="uri-html-_en-decoding.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="Apache_module_specific_commands.html">Nex
t</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="inter-process_and_-system_communication"></a>Inter-process/-system communication</h2></div></div></div><p style="width:90%">
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Inter-process/-system communication</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="uri-html-_en-decoding.html" title="Uri-/html- en-/decoding"><link rel="next" href="Apache_module_specific_commands.html" title="Apache module specific 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">Inter-process/-system communication</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="uri-html-_en-decoding.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="Apache_module_specific_commands.html">Next
</a></td></tr></table><hr></div><div class="section" title="Inter-process/-system communication"><div class="titlepage"><div><div><hr><h2 class="title" style="clear: both"><a name="inter-process_and_-system_communication"></a>Inter-process/-system communication</h2></div></div></div><p style="width:90%">
Send to and receive from sockets.
- </p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::send"></a>web::send</h3></div></div></div><p style="width:90%">
+ </p><div class="section" title="web::send"><div class="titlepage"><div><div><h3 class="title"><a name="web::send"></a>web::send</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::send</code></span> <em class="replaceable"><code>channel</code></em> <em class="replaceable"><code>cmdNr</code></em> <em class="replaceable"><code>message</code></em> ?<em class="replaceable"><code>flags</code></em>?</span></div><p style="width:90%">
@@ -22,7 +21,7 @@
<tt>multiple</tt> or <tt>noflush</tt> with the
same meaning, indicating that there is more to follow and no
automatic flush on the channel should be done.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::recv"></a>web::recv</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="web::recv"><div class="titlepage"><div><div><h3 class="title"><a name="web::recv"></a>web::recv</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::recv</code></span> <em class="replaceable"><code>channel</code></em> <em class="replaceable"><code>cmdVarName</code></em> <em class="replaceable"><code>msgVarName</code></em> <em class="replaceable"><code>flagVarName</code></em></span></div><p style="width:90%">
@@ -33,19 +32,19 @@
numeric. (To handle these flags, use the web::msgflag
function).
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="web::msgflag"></a>web::msgflag</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section" title="web::msgflag"><div class="titlepage"><div><div><h3 class="title"><a name="web::msgflag"></a>web::msgflag</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::msgflag</code></span> ?<em class="replaceable"><code>flags</code></em>? ?<em class="replaceable"><code>testflags</code></em>?</span></div><p style="width:90%">
Set or test flags.
- </p><div class="variablelist"><dl><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::msgflag</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::msgflag</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 a list of all known message flags.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::msgflag</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::msgflag</strong></span></span>
<tt><em class="replaceable"><code>flags</code></em></tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
returns the integer representation of the flags listed
in <tt>flags</tt>.
- </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span><strong class="command">web::msgflag</strong></span></span>
+ </div></div></dd><dt><span style="background:#bbbbff"><span class="term"><span style="font-family:monospace"><span class="command"><strong>web::msgflag</strong></span></span>
<tt><em class="replaceable"><code>flags</code></em></tt>
<tt><em class="replaceable"><code>testflags</code></em></tt></span></span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:6">
returns 1, if the flags in <tt>testflags</tt>
---------------------------------------------------------------------
To unsubscribe, e-mail: site-cvs-unsubscribe@tcl.apache.org
For additional commands, e-mail: site-cvs-help@tcl.apache.org