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 mx...@apache.org on 2021/11/13 16:25:34 UTC
[tcl-site] branch master updated: publishing pages for new release
This is an automated email from the ASF dual-hosted git repository.
mxmanghi pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tcl-site.git
The following commit(s) were added to refs/heads/master by this push:
new 8d23b0a publishing pages for new release
8d23b0a is described below
commit 8d23b0a8ad7976a535a1d3d0d7a76ae400f018d9
Author: Massimo Manghi <ma...@gmail.com>
AuthorDate: Sat Nov 13 17:25:12 2021 +0100
publishing pages for new release
---
rivet/doap_rivet.rdf | 73 +++++++++++++---------------
rivet/html/download.html | 4 +-
rivet/html/release-notes.html | 44 ++++++++++++-----
rivet/index.html | 4 +-
rivet/manual3.2/abort_code.html | 4 +-
rivet/manual3.2/abort_page.html | 4 +-
rivet/manual3.2/apache_log_error.html | 2 +-
rivet/manual3.2/apache_table.html | 2 +-
rivet/manual3.2/asciiglyphs.html | 4 +-
rivet/manual3.2/calendar.html | 4 +-
rivet/manual3.2/calendar_package.html | 2 +-
rivet/manual3.2/catch.html | 2 +-
rivet/manual3.2/clock_to_rfc.html | 2 +-
rivet/manual3.2/cmake.html | 2 +-
rivet/manual3.2/commands.html | 2 +-
rivet/manual3.2/cookie.html | 2 +-
rivet/manual3.2/debug.html | 20 ++++----
rivet/manual3.2/decode.html | 4 +-
rivet/manual3.2/dio.html | 2 +-
rivet/manual3.2/dio_package.html | 6 +--
rivet/manual3.2/diodisplay.html | 2 +-
rivet/manual3.2/diodisplay_package.html | 12 ++---
rivet/manual3.2/directives.html | 4 +-
rivet/manual3.2/encode.html | 4 +-
rivet/manual3.2/entities.html | 2 +-
rivet/manual3.2/env.html | 17 ++++---
rivet/manual3.2/escape_sgml_chars.html | 14 +++---
rivet/manual3.2/escape_shell_command.html | 2 +-
rivet/manual3.2/escape_string.html | 2 +-
rivet/manual3.2/examples.html | 4 +-
rivet/manual3.2/exit.html | 2 +-
rivet/manual3.2/fb.html | 8 +--
rivet/manual3.2/form.html | 2 +-
rivet/manual3.2/form_package.html | 74 ++++++++++++++--------------
rivet/manual3.2/formbroker.html | 2 +-
rivet/manual3.2/headers.html | 2 +-
rivet/manual3.2/help.html | 10 ++--
rivet/manual3.2/html.html | 2 +-
rivet/manual3.2/html_calendar.html | 4 +-
rivet/manual3.2/http_accept.html | 4 +-
rivet/manual3.2/import_keyvalue_pairs.html | 2 +-
rivet/manual3.2/include.html | 2 +-
rivet/manual3.2/index.html | 24 ++++-----
rivet/manual3.2/inspect.html | 2 +-
rivet/manual3.2/installation.html | 11 +++--
rivet/manual3.2/internals.html | 56 ++++++++++-----------
rivet/manual3.2/lassign_array.html | 2 +-
rivet/manual3.2/lazybridge.html | 78 ++++++++++++++++++------------
rivet/manual3.2/lempty.html | 4 +-
rivet/manual3.2/lmatch.html | 4 +-
rivet/manual3.2/load_cookies.html | 2 +-
rivet/manual3.2/load_env.html | 2 +-
rivet/manual3.2/load_headers.html | 2 +-
rivet/manual3.2/load_response.html | 2 +-
rivet/manual3.2/lremove.html | 2 +-
rivet/manual3.2/makeurl.html | 2 +-
rivet/manual3.2/no_body.html | 2 +-
rivet/manual3.2/parray.html | 2 +-
rivet/manual3.2/parse.html | 2 +-
rivet/manual3.2/processing.html | 8 +--
rivet/manual3.2/raw_post.html | 2 +-
rivet/manual3.2/read_file.html | 4 +-
rivet/manual3.2/redirect.html | 2 +-
rivet/manual3.2/request.html | 14 +++---
rivet/manual3.2/session_package.html | 14 +++---
rivet/manual3.2/shorthand.html | 4 +-
rivet/manual3.2/tcl_packages.html | 2 +-
rivet/manual3.2/thread_id.html | 14 +++---
rivet/manual3.2/toglyphs.html | 4 +-
rivet/manual3.2/try.html | 4 +-
rivet/manual3.2/unescape_string.html | 2 +-
rivet/manual3.2/upload.html | 2 +-
rivet/manual3.2/url_script.html | 2 +-
rivet/manual3.2/var.html | 2 +-
rivet/manual3.2/wrap.html | 4 +-
rivet/manual3.2/wrapline.html | 4 +-
rivet/manual3.2/xml.html | 4 +-
rivet/manual3.2/xml_calendar.html | 6 +--
78 files changed, 351 insertions(+), 312 deletions(-)
diff --git a/rivet/doap_rivet.rdf b/rivet/doap_rivet.rdf
index 8555268..c405ba5 100644
--- a/rivet/doap_rivet.rdf
+++ b/rivet/doap_rivet.rdf
@@ -6,59 +6,54 @@
xmlns:asfext="http://projects.apache.org/ns/asfext#"
xmlns:foaf="http://xmlns.com/foaf/0.1/">
<!--
- =======================================================================
-
- Copyright (c) 2006 The Apache Software Foundation.
- All rights reserved.
-
- =======================================================================
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
-->
- <Project rdf:about="http://tcl.apache.org/rivet/">
- <created>2010-11-03</created>
- <license rdf:resource="http://usefulinc.com/doap/licenses/asl20" />
- <name>Apache Rivet</name>
- <homepage rdf:resource="http://tcl.apache.org/rivet/" />
- <asfext:pmc rdf:resource="http://tcl.apache.org" />
+ <Project rdf:about="https://tcl.apache.org/rivet">
+ <created>2021-11-13</created>
+ <license rdf:resource="https://spdx.org/licenses/Apache-2.0" />
+ <name>Apache rivet</name>
+ <homepage rdf:resource="https://tcl.apache.org/rivet" />
+ <asfext:pmc rdf:resource="https://tcl.apache.org" />
<shortdesc>Server-side Tcl programming system combining ease of use and power</shortdesc>
- <description>Apache Rivet is a system for creating dynamic web content via the Tcl programming language integrated with Apache Web Server. It is designed to be fast, powerful and extensible, consume few system resources, be easy to learn, and to provide the user with a platform that can also be used for other programming tasks outside the web (GUI's, system administration tasks, text processing, database manipulation, XML, and so on). In order to meet these goals Tcl programming lang [...]
-</description>
+ <description>r</shortdesc>
+ <description>Apache Rivet is a system for creating dynamic web content via the Tcl programming language integrated with Apache Web Server. It is designed to be fast, powerful and extensible, consume few system resources, be easy to learn, and to provide the user with a platform that can also be used for other programming tasks outside the web (GUI's, system administration tasks, text processing, database manipulation, XML, and so on). In order to meet these goals Tcl programming lang [...]
<bug-database rdf:resource="https://issues.apache.org/bugzilla/buglist.cgi?quicksearch=Rivet" />
- <mailing-list rdf:resource="http://mail-archives.apache.org/mod_mbox/tcl-rivet-dev/" />
- <download-page rdf:resource="http://www.apache.org/dyn/closer.cgi/tcl/rivet" />
+ <mailing-list rdf:resource="https://mail-archives.apache.org/mod_mbox/tcl-rivet-dev/" />
+ <download-page rdf:resource="https://downloads.apache.org/tcl/rivet/" />
<programming-language>Tcl</programming-language>
- <category rdf:resource="http://projects.apache.org/category/web-framework" />
- <release>
- <Version>
- <name>rivet-2.4</name>
- <created>2018-11-28</created>
- <revision>2.4.0</revision>
- </Version>
- </release>
+ <category rdf:resource="https://projects.apache.org/category/content" />
<release>
<Version>
- <name>rivet-3.1</name>
- <created>2019-01-08</created>
- <revision>3.1.1</revision>
- </Version>
- </release>
- <release>
- <Version>
- <name>rivet-3.2</name>
- <created>2020-11-07</created>
- <revision>3.2.0</revision>
+ <name>rivet-3.2.1</name>
+ <created>2021-11-13</created>
+ <revision>3.2.1</revision>
</Version>
</release>
<repository>
- <SVNRepository>
- <location rdf:resource="http://svn.apache.org/repos/asf/tcl/rivet/" />
- <browse rdf:resource="http://svn.apache.org/repos/asf/tcl/rivet/" />
- </SVNRepository>
+ <GitRepository>
+ <location rdf:resource="https://gitbox.apache.org/repos/asf/tcl-rivet.git"/>
+ <browse rdf:resource="https://gitbox.apache.org/repos/asf?p=tcl-rivet.git"/>
+ </GitRepository>
</repository>
<maintainer>
<foaf:Person>
<foaf:name>Massimo Manghi</foaf:name>
- <foaf:mbox rdf:resource="mailto:mxmanghi@apache.org" />
+ <foaf:mbox rdf:resource="mailto:mxmanghi@apache.org"/>
</foaf:Person>
</maintainer>
</Project>
</rdf:RDF>
+
diff --git a/rivet/html/download.html b/rivet/html/download.html
index d956ac3..6238511 100644
--- a/rivet/html/download.html
+++ b/rivet/html/download.html
@@ -22,7 +22,7 @@
<p>
The latest stable <b>Rivet</b>
- version is 3.2.0 and it may be downloaded from one the links pointing to ASF mirror sites
+ version is 3.2.1 and it may be downloaded from one the links pointing to ASF mirror sites
<p>
<code>
<a href="http://www.apache.org/dyn/closer.lua/tcl/rivet">http://www.apache.org/dyn/closer.lua/tcl/rivet</a>
@@ -101,7 +101,7 @@
<div class="contentbottom">
- <div id="last_modified">Last Modified: 11-11-2020 00:19:28 UTC</div>
+ <div id="last_modified">Last Modified: 13-11-2021 15:45:21 UTC</div>
</div>
</div>
diff --git a/rivet/html/release-notes.html b/rivet/html/release-notes.html
index 43f6d3b..54fd248 100644
--- a/rivet/html/release-notes.html
+++ b/rivet/html/release-notes.html
@@ -16,33 +16,51 @@
<div id="body">
<div id="content">
<h2>Apache Rivet Release Notes</h2>
- <p>Apache Rivet current stable version is 3.2.0</p>
+ <p>Apache Rivet current stable version is 3.2.1</p>
<dl>
+ <dt>Rivet 3.2.1 release notes</dt>
+ <dd>
+ <p>
+ <h4>Rivet 3.2.1</h4>
+ <ul>
+ <li>The array built by command ::rivet::inspect server now shows also the current log level</li>
+ <li>Session package tables have larger columns for session data</li>
+ <li>Code for environment variables access extensively rewritten to make substantially
+ convenient to call ::rivet::env instead of ::rivet::load_env (the manual for long time claimed
+ that was the case but actually low level code execution was almost the same)</li>
+ <li>Introducing preprocessing macro RIVET_DEBUG_BUILD controlled by the --enable-rivet-debug-build
+ configure switch. This is meant to enable builds that include specific code for the module
+ development and debugging that can be excluded from common builds</li>
+ <li>Various manual improvements and correction</li>
+ <li>Fixed issues with the autotools build scripts</li>
+ </ul>
+ </p>
+ </dd>
<dt>Rivet 3.2.0 release notes</dt>
<dd>
<p>
<h4>Rivet 3.2.0</h4>
- This version fully embraces threads as the fundamental agents that run Tcl interpreters and
- respond to HTTP requests as content generators. As such threads now by default individually
- terminate and release their resources when the <b>exit</b>
+ This version fully embraces threads as the fundamental agents that run Tcl interpreters and
+ respond to HTTP requests as content generators. As such threads now by default individually
+ terminate and release their resources when the <b>exit</b>
is called.
- This policy change is relevant to the worker and lazy bridges which were
- developed to match the requirements imposed by the worker and event MPMs. The prefork bridge
- (which is bound to work with the prefork MPM) is unaffected. </p>
+ This policy change is relevant to the worker and lazy bridges which were
+ developed to match the requirements imposed by the worker and event MPMs. The prefork bridge
+ (which is bound to work with the prefork MPM) is unaffected. </p>
<p>The previous policy of forcing all threads to terminate before a child process calls Tcl_Exit
- can be reestablished setting the <b>SingleThreadExit</b>
+ can be reestablished setting the <b>SingleThreadExit</b>
boolean directive to <i>Off</i>
. This is
- demanded in cases where calling Tcl_DeleteInterp is not safe because,for instance, not properly
- designed third-party extensions fail to correctly release their resources and can cause process crashes.
- <!--Nonetheless this setting is discouraged because in case of high workload the <b>exit</b> command
- can cause 505 internal server errors. -->
+ demanded in cases where calling Tcl_DeleteInterp is not safe because,for instance, not properly
+ designed third-party extensions fail to correctly release their resources and can cause process crashes.
+ <!--Nonetheless this setting is discouraged because in case of high workload the <b>exit</b> command
+ can cause 505 internal server errors. -->
</p>
<p>
Even though Tcl's <b>exit</b>
@@ -329,7 +347,7 @@
<div class="contentbottom">
-
+ <div id="last_modified">Last Modified: 13-11-2021 15:44:27 UTC</div>
</div>
</div>
diff --git a/rivet/index.html b/rivet/index.html
index 7a472b6..0faed63 100644
--- a/rivet/index.html
+++ b/rivet/index.html
@@ -17,7 +17,7 @@
<div id="content">
<h2>Apache Rivet</h2>
<div>
- <h3>Rivet's current <a href="html/download.html">stable release is 3.2.0</a>
+ <h3>Rivet's current <a href="html/download.html">stable release is 3.2.1</a>
</h3>
</div>
@@ -94,7 +94,7 @@
<div class="contentbottom">
- <div id="last_modified">Last Modified: 11-11-2020 00:19:28 UTC</div>
+ <div id="last_modified">Last Modified: 13-11-2021 15:45:21 UTC</div>
</div>
</div>
diff --git a/rivet/manual3.2/abort_code.html b/rivet/manual3.2/abort_code.html
index f825122..08ea587 100644
--- a/rivet/manual3.2/abort_code.html
+++ b/rivet/manual3.2/abort_code.html
@@ -1,7 +1,7 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>abort_code</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="shorthand.html" title="<?= ... ?>"><link rel="next" href="abort_page.html" title="abort_page"></hea [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>abort_code</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="shorthand.html" title="<?= ... ?>"><link rel="next" href="abort_page.html" title="abort_page"></head> [...]
Returns the code passed to <span style="font-family:monospace"><span class="command"><strong>abort_page</strong></span></span>
earlier during the request processing
- </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::abort_code</span> </div></div></div><div class="refsect1"><a name="idm790"></a><h2>Description</h2><p style="width:90%">
+ </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::abort_code</span> </div></div></div><div class="refsect1"><a name="idm794"></a><h2>Description</h2><p style="width:90%">
Usage of this command is meaningful only in a script set as
AbortScript or AfterEveryScript.
<span style="font-family:monospace"><span class="command"><strong>abort_code</strong></span></span> returns the value of the optional
diff --git a/rivet/manual3.2/abort_page.html b/rivet/manual3.2/abort_page.html
index b2ecb77..ef3480f 100644
--- a/rivet/manual3.2/abort_page.html
+++ b/rivet/manual3.2/abort_page.html
@@ -1,7 +1,7 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>abort_page</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="abort_code.html" title="abort_code"><link rel="next" href="apache_log_error.html" title="apache_log_error [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>abort_page</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="abort_code.html" title="abort_code"><link rel="next" href="apache_log_error.html" title="apache_log_error"> [...]
Stops outputting data to web page, similar in
purpose to PHP's <span style="font-family:monospace"><span class="command"><strong>die</strong></span></span> command.
- </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::abort_page</span> (<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>abort code</code></em></span> | <span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code [...]
+ </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::abort_page</span> (<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>abort code</code></em></span> | <span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code [...]
This command flushes the output buffer and stops the Tcl
script from sending any more data to the client.
A normal Tcl script might use the
diff --git a/rivet/manual3.2/apache_log_error.html b/rivet/manual3.2/apache_log_error.html
index 39fb6af..ead456f 100644
--- a/rivet/manual3.2/apache_log_error.html
+++ b/rivet/manual3.2/apache_log_error.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>apache_log_error</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="abort_page.html" title="abort_page"><link rel="next" href="apache_table.html" title="apache_table"> [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>apache_log_error</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="abort_page.html" title="abort_page"><link rel="next" href="apache_table.html" title="apache_table"></ [...]
The apache_log_error command logs a message to the
Apache error log, whose name and location have been
set by the ErrorLog directive.
diff --git a/rivet/manual3.2/apache_table.html b/rivet/manual3.2/apache_table.html
index 6fe9ab4..b17e1b1 100644
--- a/rivet/manual3.2/apache_table.html
+++ b/rivet/manual3.2/apache_table.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>apache_table</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="apache_log_error.html" title="apache_log_error"><link rel="next" href="catch.html" title="catch"></head [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>apache_table</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="apache_log_error.html" title="apache_log_error"><link rel="next" href="catch.html" title="catch"></head>< [...]
The apache_table command is for accessing and manipulating
Apache tables in the request structure.
</p><p style="width:90%">
diff --git a/rivet/manual3.2/asciiglyphs.html b/rivet/manual3.2/asciiglyphs.html
index 0b3c13d..cf17eb6 100644
--- a/rivet/manual3.2/asciiglyphs.html
+++ b/rivet/manual3.2/asciiglyphs.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>AsciiGlyphs</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="decode.html" title="decode"><link rel="next" href="toglyphs.html" title="toGlyphs"></head><body bgcolor="white" text="black [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>AsciiGlyphs</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="decode.html" title="decode"><link rel="next" href="toglyphs.html" title="toGlyphs"></head><body bgcolor="white" text="black" [...]
The <span style="font-family:monospace"><span class="command"><strong>AsciiGlyphs</strong></span></span> package provides a command
to print large ASCII glyphs in an HTML fragment based on
a <pre>...</pre:> element. The shape of the glyphs was
@@ -7,7 +7,7 @@
support the whole English alphabet and some punctuation characters.
The string to be represented has to be made of pure 7-bit ASCII characters.
The package also runs standalone outside of mod_rivet
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4219"></a>Example</h3></div></div></div><pre class="programlisting">package require AsciiGlyphs
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4232"></a>Example</h3></div></div></div><pre class="programlisting">package require AsciiGlyphs
::AsciiGlyphs toGlyphs "Date: 07-12-2015"
_____ _____ ______ ___ ______ __ ___ ___ ___ __ _____
| __ \ /\ |_ _| | ____| _ / _ \ |____ | /_ ||__ \ |__ \ / _ \ /_ || ____|
diff --git a/rivet/manual3.2/calendar.html b/rivet/manual3.2/calendar.html
index 5191b58..08246ef 100644
--- a/rivet/manual3.2/calendar.html
+++ b/rivet/manual3.2/calendar.html
@@ -1,7 +1,7 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Calendar</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="calendar_package.html" title="Calendar Package"><link rel="prev" href="calendar_package.html" title="Calendar Package"><link rel="next" href="xml_calendar.html" title="XmlCalendar"></hea [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Calendar</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="calendar_package.html" title="Calendar Package"><link rel="prev" href="calendar_package.html" title="Calendar Package"><link rel="next" href="xml_calendar.html" title="XmlCalendar"></head> [...]
The main public command for a calendar object is
<span style="font-family:monospace"><span class="command"><strong>emit</strong></span></span> that returns a calendar table
- </p></div><div class="refsect1"><a name="idm3981"></a><div class="variablelist"><p style="width:90%">
+ </p></div><div class="refsect1"><a name="idm3994"></a><div class="variablelist"><p style="width:90%">
The method <span style="font-family:monospace"><span class="command"><strong>emit</strong></span></span> when invoked with a single argument
takes it as an year number and prints the whole calendar of
that year. When invoked with 2 arguments takes the first as a month, either
diff --git a/rivet/manual3.2/calendar_package.html b/rivet/manual3.2/calendar_package.html
index c26d28f..f32b384 100644
--- a/rivet/manual3.2/calendar_package.html
+++ b/rivet/manual3.2/calendar_package.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Calendar Package</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="form_package.html" title="form"><link rel="next" href="calendar.html" title="Calendar"></head><body bgcolor="white" te [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Calendar Package</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="form_package.html" title="form"><link rel="next" href="calendar.html" title="Calendar"></head><body bgcolor="white" text [...]
The package is based on the Calendar class, a class capable
of printing an ascii calendar table that closely resembles the output
of the typical Unix <span style="font-family:monospace"><span class="command"><strong>cal</strong></span></span> command. The internal
diff --git a/rivet/manual3.2/catch.html b/rivet/manual3.2/catch.html
index 400c87c..ea28579 100644
--- a/rivet/manual3.2/catch.html
+++ b/rivet/manual3.2/catch.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>catch</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="apache_table.html" title="apache_table"><link rel="next" href="clock_to_rfc.html" title="clock_to_rfc850_gmt"> [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>catch</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="apache_table.html" title="apache_table"><link rel="next" href="clock_to_rfc.html" title="clock_to_rfc850_gmt"></ [...]
<span style="font-family:monospace"><span class="command"><strong>::rivet::catch</strong></span></span> wraps the core language <span style="font-family:monospace"><span class="command"><strong>catch</strong></span></span>
command adding some extra error handling needed by mod_rivet design.
The rationale for Rivet to have its own <span style="font-family:monospace"><span class="command"><strong>::rivet::catch</strong></span></span> reads
diff --git a/rivet/manual3.2/clock_to_rfc.html b/rivet/manual3.2/clock_to_rfc.html
index 505e254..12e5d24 100644
--- a/rivet/manual3.2/clock_to_rfc.html
+++ b/rivet/manual3.2/clock_to_rfc.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>clock_to_rfc850_gmt</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="catch.html" title="catch"><link rel="next" href="cookie.html" title="cookie"></head><body bgcolo [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>clock_to_rfc850_gmt</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="catch.html" title="catch"><link rel="next" href="cookie.html" title="cookie"></head><body bgcolor= [...]
Convert an integer-seconds-since-1970 click value to
RFC850 format, with the additional requirement that it be
GMT only.
diff --git a/rivet/manual3.2/cmake.html b/rivet/manual3.2/cmake.html
index 8d5fc0e..23d183f 100644
--- a/rivet/manual3.2/cmake.html
+++ b/rivet/manual3.2/cmake.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Building Rivet 3.2 with CMake</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="installation.html" title="Apache Rivet 3.2 Installation"><link rel="next" href="directives.html" title="A [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Building Rivet 3.2 with CMake</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="installation.html" title="Apache Rivet 3.2 Installation"><link rel="next" href="directives.html" title="Apa [...]
Starting with 3.2 Rivet has adopted <a class="ulink" href="" target="_top">CMake</a>
as an alternate build system. The choice of introducing CMake was motivated by the
need of an easy to use and reliable build system for Windows installations. Nonetheless
diff --git a/rivet/manual3.2/commands.html b/rivet/manual3.2/commands.html
index 7cd88e2..a4098ed 100644
--- a/rivet/manual3.2/commands.html
+++ b/rivet/manual3.2/commands.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Rivet Tcl Commands and Variables</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="request.html" title="Apache Child Processes Lifecycle and Request Processing"><link rel="next" href="s [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Rivet Tcl Commands and Variables</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="request.html" title="Apache Child Processes Lifecycle and Request Processing"><link rel="next" href="sho [...]
Starting with version 2.1.0 the Rivet command set moved into the
<span style="font-family:monospace"><span class="command"><strong>::rivet</strong></span></span> namespace.
</p><p style="width:90%">
diff --git a/rivet/manual3.2/cookie.html b/rivet/manual3.2/cookie.html
index 272c410..1811e76 100644
--- a/rivet/manual3.2/cookie.html
+++ b/rivet/manual3.2/cookie.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>cookie</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="clock_to_rfc.html" title="clock_to_rfc850_gmt"><link rel="next" href="debug.html" title="debug"></head><body [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>cookie</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="clock_to_rfc.html" title="clock_to_rfc850_gmt"><link rel="next" href="debug.html" title="debug"></head><body bg [...]
<span style="font-family:monospace"><span class="command"><strong>cookie</strong></span></span> gets, sets, unsets or deletes a cookie. When you
get a cookie, the command returns the value of the cookie,
or an empty string if no cookie exists.
diff --git a/rivet/manual3.2/debug.html b/rivet/manual3.2/debug.html
index 497b635..3c56b09 100644
--- a/rivet/manual3.2/debug.html
+++ b/rivet/manual3.2/debug.html
@@ -1,10 +1,10 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>debug</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="cookie.html" title="cookie"><link rel="next" href="env.html" title="env"></head><body bgcolor="white" text="bl [...]
- A command to print strings, arrays
- and the values of variables as specified by the arguments.
- </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::debug</span> <span style="font-family:monospace; font-weight: bold;">-subst</span> ?<span style="font-family:monospace; font-weight: bold;"><on|off></span>? <span style="font-family:monospace; font-weight: bold;"> [...]
- A command to make debugging more convenient print strings, arrays
- and the values of variables as specified by the arguments.
- </p><p style="width:90%">
- Also allows the setting of an array called debug which will pick up
- options for all debug commands.
- </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="cookie.html"><img src="images/prev.png" alt="Prev"></a> </td><td width="20%" align="center"><a accesskey="u" href="commands.html"><img src="images/up.png" alt="Up"></a></td><td width="40%" align="right"> <a accesskey="n" href="env.html"><img src="images/next.png" alt="Next"></a></td></tr><tr><td width="40%" align="left" valign="top">cookie < [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>debug</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="cookie.html" title="cookie"><link rel="next" href="env.html" title="env"></head><body bgcolor="white" text="blac [...]
+ A command to print strings, arrays
+ and the values of variables as specified by the arguments.
+ </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::debug</span> <span style="font-family:monospace; font-weight: bold;">-subst</span> ?<span style="font-family:monospace; font-weight: bold;"><on|off></span>? <span style="font-family:monospace; font-weight: bold;" [...]
+ A command to make debugging more convenient print strings, arrays
+ and the values of variables as specified by the arguments.
+ </p><p style="width:90%">
+ Also allows the setting of an array called debug which will pick up
+ options for all debug commands.
+ </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="cookie.html"><img src="images/prev.png" alt="Prev"></a> </td><td width="20%" align="center"><a accesskey="u" href="commands.html"><img src="images/up.png" alt="Up"></a></td><td width="40%" align="right"> <a accesskey="n" href="env.html"><img src="images/next.png" alt="Next"></a></td></tr><tr><td width="40%" align="left" valign="top">cookie [...]
diff --git a/rivet/manual3.2/decode.html b/rivet/manual3.2/decode.html
index 62da022..2e7a75e 100644
--- a/rivet/manual3.2/decode.html
+++ b/rivet/manual3.2/decode.html
@@ -1,7 +1,7 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>decode</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="entities.html" title="RivetEntities"><link rel="prev" href="encode.html" title="encode"><link rel="next" href="asciiglyphs.html" title="AsciiGlyphs"></head><body bgcolor="white" text="blac [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>decode</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="entities.html" title="RivetEntities"><link rel="prev" href="encode.html" title="encode"><link rel="next" href="asciiglyphs.html" title="AsciiGlyphs"></head><body bgcolor="white" text="black" [...]
decode an SGML encoded string replacing every entity with the
corresponding character
- </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::decode</span> <span style="font-family:monospace; font-weight: bold;">string</span> ?<span style="font-family:monospace; font-weight: bold;">-encoding <em class="replaceable"><code><encoding></code></em>< [...]
+ </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::decode</span> <span style="font-family:monospace; font-weight: bold;">string</span> ?<span style="font-family:monospace; font-weight: bold;">-encoding <em class="replaceable"><code><encoding></code></em>< [...]
<span style="font-family:monospace"><span class="command"><strong>::rivet::decode</strong></span></span> implements the inverse function of
<span style="font-family:monospace"><span class="command"><strong>::rivet::encode</strong></span></span>. The input string is scanned searching
and replacing every SGML entity with its corresponding character.
diff --git a/rivet/manual3.2/dio.html b/rivet/manual3.2/dio.html
index 0063d3e..fde4af2 100644
--- a/rivet/manual3.2/dio.html
+++ b/rivet/manual3.2/dio.html
@@ -1 +1 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>DIO - Database Interface Objects</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="tcl_packages.html" title="Rivet Tcl Packages"><link rel="next" href="dio_package.html" title="DIO"></h [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>DIO - Database Interface Objects</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="tcl_packages.html" title="Rivet Tcl Packages"><link rel="next" href="dio_package.html" title="DIO"></hea [...]
diff --git a/rivet/manual3.2/dio_package.html b/rivet/manual3.2/dio_package.html
index a95a9ca..78ab261 100644
--- a/rivet/manual3.2/dio_package.html
+++ b/rivet/manual3.2/dio_package.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>DIO</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="dio.html" title="DIO - Database Interface Objects"><link rel="prev" href="dio.html" title="DIO - Database Interface Objects"><link rel="next" href="diodisplay.html" title="DIODisplay - Databa [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>DIO</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="dio.html" title="DIO - Database Interface Objects"><link rel="prev" href="dio.html" title="DIO - Database Interface Objects"><link rel="next" href="diodisplay.html" title="DIODisplay - Database [...]
<span style="font-family:monospace"><span class="command"><strong>DIO</strong></span></span> is designed to be a generic,
object-oriented interface to SQL databases. Its main goal
is to be as generic as possible, but since not all SQL
@@ -15,7 +15,7 @@
specified, DIO creates an object of that name. If there is
no <em class="replaceable"><code>objectName</code></em>
given, DIO will automatically generate a unique object ID
- </p></div><div class="refsect1"><a name="idm2106"></a><h2>Options</h2><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">-host</span> ?<span style="font-family:monospace; font-weight: bold;"><em class="re [...]
+ </p></div><div class="refsect1"><a name="idm2112"></a><h2>Options</h2><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">-host</span> ?<span style="font-family:monospace; font-weight: bold;"><em class="re [...]
The hostname of the computer to connect to. If none
is given, DIO assumes the local host.
</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">-port</span> ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>portNumber</code></em></span>?</div></div><div style="margin-bottom:1.5ex ; paddi [...]
@@ -35,7 +35,7 @@
field specified as AUTO.</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">-sequence</span> ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>sequenceName</code></em></span>?</div></div><div style=" [...]
If DIO is automatically generating keys, it will use
this sequence as a means to gain a unique number for
- the stored key.</div></div></dd></dl></div></div><div class="refsect1"><a name="idm2176"></a><h2>DIO Object Commands</h2><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code> [...]
+ the stored key.</div></div></dd></dl></div></div><div class="refsect1"><a name="idm2182"></a><h2>DIO Object Commands</h2><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code> [...]
Execute request as a SQL query and
create an array from the first record found. The
array is set with the fields of the table and the
diff --git a/rivet/manual3.2/diodisplay.html b/rivet/manual3.2/diodisplay.html
index 48e77ae..dc49007 100644
--- a/rivet/manual3.2/diodisplay.html
+++ b/rivet/manual3.2/diodisplay.html
@@ -1 +1 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>DIODisplay - Database Interface Objects Display Class</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="dio_package.html" title="DIO"><link rel="next" href="diodisplay_package.html" tit [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>DIODisplay - Database Interface Objects Display Class</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="dio_package.html" title="DIO"><link rel="next" href="diodisplay_package.html" title [...]
diff --git a/rivet/manual3.2/diodisplay_package.html b/rivet/manual3.2/diodisplay_package.html
index 5b87fc0..d2e848b 100644
--- a/rivet/manual3.2/diodisplay_package.html
+++ b/rivet/manual3.2/diodisplay_package.html
@@ -1,8 +1,8 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>DIODisplay</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="diodisplay.html" title="DIODisplay - Database Interface Objects Display Class"><link rel="prev" href="diodisplay.html" title="DIODisplay - Database Interface Objects Display Class"><li [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>DIODisplay</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="diodisplay.html" title="DIODisplay - Database Interface Objects Display Class"><link rel="prev" href="diodisplay.html" title="DIODisplay - Database Interface Objects Display Class"><link [...]
DIODisplay is an HTML display class that uses a DIO object
to do the database work and a form object to do the
displaying.
- </p></div><div class="refsect1"><a name="idm2716"></a><h2>Options</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">
+ </p></div><div class="refsect1"><a name="idm2722"></a><h2>Options</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">
<div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">-DIO</span> <span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>dioObject</code></em></span> </div></div>
</span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:1.5ex ; padding .5ex">
The DIO object to be used in conjunction with this
@@ -82,7 +82,7 @@
</span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:1.5ex ; padding .5ex">
The title of the display object. This will be output
as the title of the HTML document.
- </div></div></dd></dl></div><div class="refsect2"><a name="idm2819"></a><h3>DIO Display Object Commands</h3><div class="variablelist"><dl class="variablelist"><dt><span class="term">
+ </div></div></dd></dl></div><div class="refsect2"><a name="idm2825"></a><h3>DIO Display Object Commands</h3><div class="variablelist"><dl class="variablelist"><dt><span class="term">
<div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace"><em class="replaceable"><code>objectName</code></em></span> <span style="font-family:monospace; font-weight: bold;">cleanup</span> ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>value</code></em></span>?</div></div>
</span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:1.5ex ; padding .5ex">
Return the current cleanup value. If
@@ -288,7 +288,7 @@
Return the current value value. If
<em class="replaceable"><code>value</code></em> is
specified, it sets a new value for value.
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3132"></a><h3>DIO Display Functions</h3><p style="width:90%">
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3138"></a><h3>DIO Display Functions</h3><p style="width:90%">
These functions are called from the
<span style="font-family:monospace"><span class="command"><strong>show</strong></span></span> method when a form response
variable called <code class="varname">mode</code> is set. If no
@@ -369,7 +369,7 @@
<code class="varname">query</code>. Once any number of records
are found, <span style="font-family:monospace"><span class="command"><strong>Search</strong></span></span> displays the
results in rows.
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3213"></a><h3>DIO Display Fields</h3><p style="width:90%">
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3219"></a><h3>DIO Display Fields</h3><p style="width:90%">
Display fields are created with the
<span style="font-family:monospace"><span class="command"><strong>field</strong></span></span> command of the DIODisplay object.
Each field is created as a new DIODisplayField object or
@@ -422,7 +422,7 @@
Or, if type were textarea, you could define
-rows and -cols to
specify its row and column count.
- </p></div><div class="refsect2"><a name="idm3271"></a><h3>DIO Display Field Types</h3><p style="width:90%">
+ </p></div><div class="refsect2"><a name="idm3277"></a><h3>DIO Display Field Types</h3><p style="width:90%">
The following is a list of recognized field types by
DIODisplay. Some are standard HTML form fields, and
others are DIODisplay fields which execute special actions
diff --git a/rivet/manual3.2/directives.html b/rivet/manual3.2/directives.html
index 11bc27e..e45b292 100644
--- a/rivet/manual3.2/directives.html
+++ b/rivet/manual3.2/directives.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Apache Rivet 3.2 Configuration</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="cmake.html" title="Building Rivet 3.2 with CMake"><link rel="next" href="processing.html" title="Apache [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Apache Rivet 3.2 Configuration</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="cmake.html" title="Building Rivet 3.2 with CMake"><link rel="next" href="processing.html" title="Apache Ri [...]
Rivet directives are used within the Apache httpd server
configuration to set up the environment where Rivet script
will be run.
@@ -34,7 +34,7 @@
<Directory /var/www/myrivetapp>
RivetDirConf BeforeScript "source /var/www/myrivetapp/before_script.tcl"
-</Directory></pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm212"></a>Configuration Directives</h3></div></div></div><div class="table"><table align="center" title="Configuration Directives application scopes" class="directives"><thead><td>Configuration Directives</td><td>DirConf</td><td>UserConf</td><td>ServerConf</td><td>Virtual Host</td><td>Notes</td></thead><tbody><tr><td>AbortScript</td><td>X</td><td>X</td><td>X</td><td>X</td>
+</Directory></pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm216"></a>Configuration Directives</h3></div></div></div><div class="table"><table align="center" title="Configuration Directives application scopes" class="directives"><thead><td>Configuration Directives</td><td>DirConf</td><td>UserConf</td><td>ServerConf</td><td>Virtual Host</td><td>Notes</td></thead><tbody><tr><td>AbortScript</td><td>X</td><td>X</td><td>X</td><td>X</td>
<td>This directive is meaningful with the default request handler. In order
to have this triggered by calling ::rivet::abort_page or ::rivet::exit
any special request handler should explicitly read this script from the configuration
diff --git a/rivet/manual3.2/encode.html b/rivet/manual3.2/encode.html
index ec6264c..aa508ef 100644
--- a/rivet/manual3.2/encode.html
+++ b/rivet/manual3.2/encode.html
@@ -1,7 +1,7 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>encode</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="entities.html" title="RivetEntities"><link rel="prev" href="entities.html" title="RivetEntities"><link rel="next" href="decode.html" title="decode"></head><body bgcolor="white" text="black [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>encode</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="entities.html" title="RivetEntities"><link rel="prev" href="entities.html" title="RivetEntities"><link rel="next" href="decode.html" title="decode"></head><body bgcolor="white" text="black" [...]
encode a string replacing every occurrence of characters for
which an SGML entity exists
- </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::encode</span> <span style="font-family:monospace; font-weight: bold;">string</span> ?<span style="font-family:monospace; font-weight: bold;">-encoding <em class="replaceable"><code><encoding></code></em>< [...]
+ </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::encode</span> <span style="font-family:monospace; font-weight: bold;">string</span> ?<span style="font-family:monospace; font-weight: bold;">-encoding <em class="replaceable"><code><encoding></code></em>< [...]
<span style="font-family:monospace"><span class="command"><strong>::rivet::encode</strong></span></span> returns a copy of the input string
after replacing every occurence of characters for which an SGML entity
exists. By default the command assumes the string is encoded in UTF-8,
diff --git a/rivet/manual3.2/entities.html b/rivet/manual3.2/entities.html
index 27c82b7..45c438c 100644
--- a/rivet/manual3.2/entities.html
+++ b/rivet/manual3.2/entities.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>RivetEntities</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="html_calendar.html" title="HtmlCalendar"><link rel="next" href="encode.html" title="encode"></head><body bgcolor="white" [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>RivetEntities</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="html_calendar.html" title="HtmlCalendar"><link rel="next" href="encode.html" title="encode"></head><body bgcolor="white" te [...]
The <span style="font-family:monospace"><span class="command"><strong>RivetEntities</strong></span></span> package was kindly provided by Harald Oehlmann and
is largely taken from a simple yet clever encoder/decoder of HTML entities
starting from a utf-8 character string. The original code writted by Andy Goth is
diff --git a/rivet/manual3.2/env.html b/rivet/manual3.2/env.html
index 9b76004..c69ec78 100644
--- a/rivet/manual3.2/env.html
+++ b/rivet/manual3.2/env.html
@@ -1,7 +1,10 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>env</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="debug.html" title="debug"><link rel="next" href="escape_sgml_chars.html" title="escape_sgml_chars"></head><body [...]
- Loads a single "environmental variable" into a Tcl variable.
- </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::env</span> ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>varName</code></em></span>?</div></div></div><div class="refsect1"><a name="idm1096"></a><h2>Description</h2><p style="width:90%">
- If it is only necessary to load one environmental variable,
- this command may be used to avoid the overhead of loading
- and storing the entire array.
- </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="debug.html"><img src="images/prev.png" alt="Prev"></a> </td><td width="20%" align="center"><a accesskey="u" href="commands.html"><img src="images/up.png" alt="Up"></a></td><td width="40%" align="right"> <a accesskey="n" href="escape_sgml_chars.html"><img src="images/next.png" alt="Next"></a></td></tr><tr><td width="40%" align="left" valign=" [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>env</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="debug.html" title="debug"><link rel="next" href="escape_sgml_chars.html" title="escape_sgml_chars"></head><body bg [...]
+ Returns the value a single "environmental variable".
+ </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::env</span> ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>environment_variable_name</code></em></span>?</div></div></div><div class="refsect1"><a name="idm1100"></a><h2>Description< [...]
+ <span style="font-family:monospace"><span class="command"><strong>::rivet::env</strong></span></span> resolves a single environment
+ variable and returns its value or an empty string if the environment
+ variable name in the argument is not defined.
+ This command is the recommended way to resolve an environment
+ variable leaving <span style="font-family:monospace"><span class="command"><strong>::rivet::load_env</strong></span></span> to debugging
+ and development operations.
+ </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="debug.html"><img src="images/prev.png" alt="Prev"></a> </td><td width="20%" align="center"><a accesskey="u" href="commands.html"><img src="images/up.png" alt="Up"></a></td><td width="40%" align="right"> <a accesskey="n" href="escape_sgml_chars.html"><img src="images/next.png" alt="Next"></a></td></tr><tr><td width="40%" align="left" valign= [...]
diff --git a/rivet/manual3.2/escape_sgml_chars.html b/rivet/manual3.2/escape_sgml_chars.html
index 73a7e49..649d1e1 100644
--- a/rivet/manual3.2/escape_sgml_chars.html
+++ b/rivet/manual3.2/escape_sgml_chars.html
@@ -1,7 +1,7 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>escape_sgml_chars</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="env.html" title="env"><link rel="next" href="escape_shell_command.html" title="escape_shell_comman [...]
- Scans through each character in the specified string looking
- for any special (with respect to SGML, and hence HTML) characters
- from the specified string, and returns the result.
- For example, the right angle bracket is escaped to the corrected
- ampersand gt symbol.
- </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="env.html"><img src="images/prev.png" alt="Prev"></a> </td><td width="20%" align="center"><a accesskey="u" href="commands.html"><img src="images/up.png" alt="Up"></a></td><td width="40%" align="right"> <a accesskey="n" href="escape_shell_command.html"><img src="images/next.png" alt="Next"></a></td></tr><tr><td width="40%" align="left" valign= [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>escape_sgml_chars</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="env.html" title="env"><link rel="next" href="escape_shell_command.html" title="escape_shell_command" [...]
+ Scans through each character in the specified string looking
+ for any special (with respect to SGML, and hence HTML) characters
+ from the specified string, and returns the result.
+ For example, the right angle bracket is escaped to the corrected
+ ampersand gt symbol.
+ </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="env.html"><img src="images/prev.png" alt="Prev"></a> </td><td width="20%" align="center"><a accesskey="u" href="commands.html"><img src="images/up.png" alt="Up"></a></td><td width="40%" align="right"> <a accesskey="n" href="escape_shell_command.html"><img src="images/next.png" alt="Next"></a></td></tr><tr><td width="40%" align="left" valign [...]
diff --git a/rivet/manual3.2/escape_shell_command.html b/rivet/manual3.2/escape_shell_command.html
index 21f7611..4f6e78b 100644
--- a/rivet/manual3.2/escape_shell_command.html
+++ b/rivet/manual3.2/escape_shell_command.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>escape_shell_command</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="escape_sgml_chars.html" title="escape_sgml_chars"><link rel="next" href="escape_string.html" ti [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>escape_shell_command</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="escape_sgml_chars.html" title="escape_sgml_chars"><link rel="next" href="escape_string.html" titl [...]
Scans through each character in the specified string looking
for any shell metacharacters, such as asterisk, less than and
greater than, parens, square brackets, curly brackets, angle
diff --git a/rivet/manual3.2/escape_string.html b/rivet/manual3.2/escape_string.html
index db8de62..cc1f8cd 100644
--- a/rivet/manual3.2/escape_string.html
+++ b/rivet/manual3.2/escape_string.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>escape_string</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="escape_shell_command.html" title="escape_shell_command"><link rel="next" href="exit.html" title="exit" [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>escape_string</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="escape_shell_command.html" title="escape_shell_command"><link rel="next" href="exit.html" title="exit">< [...]
Scans through each character in the specified string looking
for special characters, escaping them as needed, mapping
special characters to a quoted hexadecimal equivalent,
diff --git a/rivet/manual3.2/examples.html b/rivet/manual3.2/examples.html
index a090871..bb7d68c 100644
--- a/rivet/manual3.2/examples.html
+++ b/rivet/manual3.2/examples.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Examples and Usage</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="xml.html" title="xml"><link rel="next" href="tcl_packages.html" title="Rivet Tcl Packages"></head><body bgcolor="whi [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Examples and Usage</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="xml.html" title="xml"><link rel="next" href="tcl_packages.html" title="Rivet Tcl Packages"></head><body bgcolor="white [...]
Some examples of Rivet usage follow. Some prior Tcl knowledge
is assumed. If you don't know much Tcl, don't worry, it's easy,
and there are some good resources available on the web that will
@@ -29,7 +29,7 @@ puts "Hello World"
</pre><p style="width:90%">
which is translated into
</p><pre class="programlisting">puts -nonewline "Hello World"</pre><p style="width:90%">
- </p></div></div><br class="example-break"><div class="example"><a name="idm1967"></a><p class="title"><b>Example 2. Generate a Colorful Table</b></p><div class="example-contents"><p style="width:90%">
+ </p></div></div><br class="example-break"><div class="example"><a name="idm1973"></a><p class="title"><b>Example 2. Generate a Colorful Table</b></p><div class="example-contents"><p style="width:90%">
In another simple example, we dynamically generate a table selecting
a different background color for each cell. The font color is determined
through a simple CSS rule embedded in a HTML <style> element. Create
diff --git a/rivet/manual3.2/exit.html b/rivet/manual3.2/exit.html
index e8ba7af..dfbbc55 100644
--- a/rivet/manual3.2/exit.html
+++ b/rivet/manual3.2/exit.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>exit</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="escape_string.html" title="escape_string"><link rel="next" href="headers.html" title="headers"></head><body bgc [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>exit</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="escape_string.html" title="escape_string"><link rel="next" href="headers.html" title="headers"></head><body bgcol [...]
Replaces Tcl's <span style="font-family:monospace"><span class="command"><strong>exit</strong></span></span> core command. <span style="font-family:monospace"><span class="command"><strong>::rivet::exit</strong></span></span>
interrupts execution of the current script and passes execution to AbortScript if
such script is set. After AbortScript has finished and request processing completed
diff --git a/rivet/manual3.2/fb.html b/rivet/manual3.2/fb.html
index 9c00edc..3570521 100644
--- a/rivet/manual3.2/fb.html
+++ b/rivet/manual3.2/fb.html
@@ -1,6 +1,6 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>FormBroker</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="formbroker.html" title="The Form Broker"><link rel="prev" href="formbroker.html" title="The Form Broker"><link rel="next" href="help.html" title="Resources - How to Get Help"></head><b [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>FormBroker</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="formbroker.html" title="The Form Broker"><link rel="prev" href="formbroker.html" title="The Form Broker"><link rel="next" href="help.html" title="Resources - How to Get Help"></head><bod [...]
Form broker object creator
- </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::FormBroker</span> <span style="font-family:monospace; font-weight: bold;">create</span> ?<span style="font-family:monospace; font-weight: bold;">-quoting quoting_procedure</span>? ?<span style="font-family:monospace; [...]
+ </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::FormBroker</span> <span style="font-family:monospace; font-weight: bold;">create</span> ?<span style="font-family:monospace; font-weight: bold;">-quoting quoting_procedure</span>? ?<span style="font-family:monospace; [...]
The command returns a reference to a form broker object by creating
a representation of the form data using the list of variable
descriptors passed to method <span style="font-family:monospace"><span class="command"><strong>create</strong></span></span>. Each descriptor
@@ -36,7 +36,7 @@
</li></ul></div><p style="width:90%">
An example of a form accepting four variable, one for each native type of a form broker object
</p><pre class="programlisting"> % set fbroker [::FormBroker create {var1 integer} {var2 unsigned} {var3 string} {var4 integer bounds {-10 100}}]
-::FormBroker::form0</pre></div><div class="refsect1"><a name="idm4276"></a><h2>Form broker object methods</h2><p style="width:90%">
+::FormBroker::form0</pre></div><div class="refsect1"><a name="idm4289"></a><h2>Form broker object methods</h2><p style="width:90%">
The central method of a form broker object is <span style="font-family:monospace"><span class="command"><strong>validate</strong></span></span>
</p><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>formBroker_object</code></em></span> <span style="font-family:monospace; font-weight: bold;">validate</span [...]
The method <span style="font-family:monospace"><span class="command"><strong>validate</strong></span></span> takes as argument the name of an array of variables
@@ -198,7 +198,7 @@ a(var1) = 0
a(var2) = 1
a(var4) = 0</pre></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>formBroker_object</code></em></span> <span style="font-family:monospace; font-weight: bold;">reset</span> </div></div><div style="margin-bottom:1. [...]
The method resets the object to its initial defaults
- </div></div></dd></dl></div></div><div class="refsect1"><a name="idm4341"></a><h2>Writing a custom variable validator</h2><p style="width:90%">
+ </div></div></dd></dl></div></div><div class="refsect1"><a name="idm4354"></a><h2>Writing a custom variable validator</h2><p style="width:90%">
The form broker is by no means restricted to work only with its native
data types: you may define your own form variable types and have
them validated with their own variable validator.
diff --git a/rivet/manual3.2/form.html b/rivet/manual3.2/form.html
index 146b7e1..487e7f6 100644
--- a/rivet/manual3.2/form.html
+++ b/rivet/manual3.2/form.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Form: An HTML Form Fields Generation Utility</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="session_package.html" title="Session Package"><link rel="next" href="form_package.html" ti [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Form: An HTML Form Fields Generation Utility</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="session_package.html" title="Session Package"><link rel="next" href="form_package.html" titl [...]
The <span style="font-family:monospace"><span class="command"><strong>form</strong></span></span> package is a utility for generating html forms. A <span style="font-family:monospace"><span class="command"><strong>form</strong></span></span>
object command saves the programmer from typing the cumbersome html code of input elements,
working out a solution for better standardization and readability of the code.
diff --git a/rivet/manual3.2/form_package.html b/rivet/manual3.2/form_package.html
index 7432b9d..7aa0d6b 100644
--- a/rivet/manual3.2/form_package.html
+++ b/rivet/manual3.2/form_package.html
@@ -1,6 +1,6 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>form</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="form.html" title="Form: An HTML Form Fields Generation Utility"><link rel="prev" href="form.html" title="Form: An HTML Form Fields Generation Utility"><link rel="next" href="calendar_package [...]
- creates and returns a new Tcl command named <em class="replaceable"><code>form_name</code></em>.
- </p><div class="refsect2"><a name="idm3521"></a><h3>Options</h3><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">-method</span> ?<span style="font-family:monospace; font-weight: bold;">post|get</span> [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>form</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="form.html" title="Form: An HTML Form Fields Generation Utility"><link rel="prev" href="form.html" title="Form: An HTML Form Fields Generation Utility"><link rel="next" href="calendar_package.h [...]
+ creates and returns a new Tcl command named <em class="replaceable"><code>form_name</code></em>.
+ </p><div class="refsect2"><a name="idm3527"></a><h3>Options</h3><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">-method</span> ?<span style="font-family:monospace; font-weight: bold;">post|get</span> [...]
The http method for sending the form data back to the server.
Possible values are get or post
</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">-name</span> ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>form_name</code></em></span>?</div></div><div style="margin-bottom:1.5ex ; pa [...]
@@ -14,10 +14,14 @@
This option works well in conjuction with the
<span style="font-family:monospace"><span class="command"><strong>load_response</strong></span></span> command of Rivet when default
values come from another form.
+ </div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">-emit</span> ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>true(default)|false</code></em></span>?</div></div><div style="margin-bottom:1.5e [...]
+ a Tcl accepted representation of a Boolean value. Change a form object
+ instance behavior so that methods generating HTML form entries return
+ to the caller their output as string instead of directly sending it to stdout
</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">-action</span> ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>URL</code></em></span>?</div></div><div style="margin-bottom:1.5ex ; padding .5ex">
The URL the data are being sent to. If no ?<span style="font-family:monospace; font-weight: bold;">-action</span>? switch is specified
the data are sent to the form's URL.
- </div></div></dd></dl></div></div></div><div class="refsect1"><a name="idm3553"></a><h2>Form Object Commands</h2><p style="width:90%">
+ </div></div></dd></dl></div></div></div><div class="refsect1"><a name="idm3566"></a><h2>Form Object Commands</h2><p style="width:90%">
Form object commands follow the usual syntax of Tcl commands with a ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>subcommand</code></em></span>? argument playing the
role of a switch among various functionalities of the command. Form objects also need the ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>name</code></em></span>? parameter
which is to become the value of the 'name' attribute in an input field. This argument is the key that has to be
@@ -32,7 +36,7 @@
<span style="font-family:monospace"><span class="command"><strong>field</strong></span></span> is an abstract input field creation method and requires an additional
parameter specifiyng the type of field to create. Every concrete input field generation command
uses this subcommand internally to print the final html.
- </p></div><div class="refsect1"><a name="idm3576"></a><h2>Subcommands</h2><div class="refsect2"><a name="idm3578"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">start</span> ?<span style="font-fam [...]
+ </p></div><div class="refsect1"><a name="idm3589"></a><h2>Subcommands</h2><div class="refsect2"><a name="idm3591"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">start</span> ?<span style="font-fam [...]
Print the <form> tag with all its attributes.
This command must be called as first in the form generation
process. The following is a sample of code creating a form named 'formname' whose data will
@@ -48,7 +52,7 @@ myform end</pre><div style="margin-bottom:1.5ex ; padding .5ex">
The code prints a form that sends a text entry content and the option value
associated with a radiobutton. The URL of the server script is the same that
created the form. Use the ?<span style="font-family:monospace; font-weight: bold;">-url</span>? option to specify a different url.
- </div></div></dd></dl></div><div class="refsect3"><a name="idm3599"></a><div style="padding:4 ; margin-top:3 ; margin-left: 5%;">Options</div><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-left: 5%; margin-bottom:3 ; width:70%;"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-we [...]
+ </div></div></dd></dl></div><div class="refsect3"><a name="idm3612"></a><div style="padding:4 ; margin-top:3 ; margin-left: 5%;">Options</div><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-left: 5%; margin-bottom:3 ; width:70%;"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-we [...]
The method to be used to encode the form data.
Possible values are get or post
</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-left: 5%; margin-bottom:3 ; width:70%;"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">-name</span> ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>form_name</code></em></span>?</div></div><div style=" [...]
@@ -65,22 +69,22 @@ myform end</pre><div style="margin-bottom:1.5ex ; padding .5ex">
</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-left: 5%; margin-bottom:3 ; width:70%;"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">-action</span> ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>URL</code></em></span>?</div></div><div style="margin-botto [...]
The URL the data will be sent to. If no ?<span style="font-family:monospace; font-weight: bold;">-action</span>? switch is specified
the data are sent to the form's URL.
- </div></div></dd></dl></div></div></div><div class="refsect2"><a name="idm3631"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">end</span> </div></div><div style="margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd></dl></div></div></div><div class="refsect2"><a name="idm3644"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">end</span> </div></div><div style="margin-bottom:1.5ex ; padding .5ex">
Print the </form> closing tag. This command must
be called last in the form generation process
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3638"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">field</span> ?<span style="font-family:monospace; font-weight: bold;">n [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3651"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">field</span> ?<span style="font-family:monospace; font-weight: bold;">n [...]
Print a field of the given ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>type</code></em></span>? and ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>name</code></em></span>?,
including any default key-value pairs defined for this field
type and optional key-value pairs included with the statement
- </div></div></dd></dl></div><div class="refsect3"><a name="idm3652"></a><div style="padding:4 ; margin-top:3 ; margin-left: 5%;">Options</div><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-left: 5%; margin-bottom:3 ; width:70%;"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-we [...]
+ </div></div></dd></dl></div><div class="refsect3"><a name="idm3665"></a><div style="padding:4 ; margin-top:3 ; margin-left: 5%;">Options</div><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-left: 5%; margin-bottom:3 ; width:70%;"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-we [...]
Option description
- </div></div></dd></dl></div></div></div><div class="refsect2"><a name="idm3661"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">radiobuttons</span> ?<span style="font-family:monospace; f [...]
+ </div></div></dd></dl></div></div></div><div class="refsect2"><a name="idm3674"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">radiobuttons</span> ?<span style="font-family:monospace; f [...]
the <span style="font-family:monospace"><span class="command"><strong>radiobutton</strong></span></span> creates a whole radiobutton group
with the values and labels specified in the argument list.
If no ?<span style="font-family:monospace; font-weight: bold;">-labels</span>? switch is
passed to the subcommand the values are printed as labels of
the radiobutton.
- </div><div class="refsect3"><a name="idm3676"></a><div style="padding:4 ; margin-top:3 ; margin-left: 5%;">Options</div><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-left: 5%; margin-bottom:3 ; width:70%;"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">-values</ [...]
+ </div><div class="refsect3"><a name="idm3689"></a><div style="padding:4 ; margin-top:3 ; margin-left: 5%;">Options</div><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-left: 5%; margin-bottom:3 ; width:70%;"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">-values</ [...]
List of values associated with the radiobuttons to be displayed
</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-left: 5%; margin-bottom:3 ; width:70%;"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">-labels</span> ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>labels_list</code></em></span>?</div></div><div style="m [...]
List of labels to be printed with every radiobutton. There must
@@ -106,7 +110,7 @@ myform end</pre><div style="margin-bottom:1.5ex ; padding .5ex">
radiobutton field is automatically checked. The options ?<span style="font-family:monospace; font-weight: bold;">values</span>? and ?<span style="font-family:monospace; font-weight: bold;">labels</span>?
are used internally and don't get into the tag attributes. If a ?<span style="font-family:monospace; font-weight: bold;">labels</span>?
option is not given, labels are assigned using the ?<span style="font-family:monospace; font-weight: bold;">values</span>? list.
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3703"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">checkbox</span> ?<span style="font-family:monospace; font-weight: bol [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3716"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">checkbox</span> ?<span style="font-family:monospace; font-weight: bol [...]
The <span style="font-family:monospace; font-weight: bold;">checkbox</span> subcommand emits a checkbox
type input field with the name, label and value attributes set
according to the parameters passed to the subcommand.
@@ -129,13 +133,13 @@ myform destroy</pre><div style="margin-bottom:1.5ex ; padding .5ex">
<input type="checkbox" name="options" id="autogen_3" label="Option 3" value="sopt3" /><label for="autogen_3">Option 3</label>
<input type="checkbox" name="options" id="autogen_4" label="Option 4" value="sopt4" /><label for="autogen_4">Option 4</label>
<input type="submit" name="submit" value="Send" />
-</form></pre></div></dd></dl></div></div><div class="refsect2"><a name="idm3721"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">checkboxes</span> ?<span style="font-family:monospace; font-wei [...]
+</form></pre></div></dd></dl></div></div><div class="refsect2"><a name="idm3734"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">checkboxes</span> ?<span style="font-family:monospace; font-wei [...]
The <span style="font-family:monospace; font-weight: bold;">checkboxes</span> is an extended form
of the <span style="font-family:monospace; font-weight: bold;">checkbox</span> subcommand.
<span style="font-family:monospace; font-weight: bold;">checkboxes</span>
prints as many checkboxes as the number of elements in the
?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>labels_list</code></em></span>? argument
- </div><div class="refsect3"><a name="idm3739"></a><div style="padding:4 ; margin-top:3 ; margin-left: 5%;">Options</div><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-left: 5%; margin-bottom:3 ; width:70%;"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">-values</ [...]
+ </div><div class="refsect3"><a name="idm3752"></a><div style="padding:4 ; margin-top:3 ; margin-left: 5%;">Options</div><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-left: 5%; margin-bottom:3 ; width:70%;"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">-values</ [...]
List of values associated with the checkboxes to be displayed
</div></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-left: 5%; margin-bottom:3 ; width:70%;"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">-labels</span> ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>labels_list</code></em></span>?</div></div><div style="m [...]
List of labels to be printed with every checkbox. There must
@@ -155,12 +159,12 @@ myform destroy</pre><div style="margin-bottom:1.5ex ; padding .5ex">
<input type="checkbox" name="options" id="autogen_3" label="Option 3" value="opt3" /><label for="autogen_3">Option 3</label>
<input type="checkbox" name="options" id="autogen_4" label="Option 4" value="opt4" /><label for="autogen_4">Option 4</label>
<input type="submit" name="save_tps" value="Send Options" />
-</form></pre></div></dd></dl></div></div><div class="refsect2"><a name="idm3760"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">password</span> ?<span style="font-family:monospace; font-weigh [...]
+</form></pre></div></dd></dl></div></div><div class="refsect2"><a name="idm3773"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">password</span> ?<span style="font-family:monospace; font-weigh [...]
Same as text, but the input is obfuscated so as not to reveal the text being typed
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3769"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">hidden</span> ?<span style="font-family:monospace; font-weight: bold; [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3782"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">hidden</span> ?<span style="font-family:monospace; font-weight: bold; [...]
hidden input element: typicall embedded in a form in order to
pass status variables.
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3778"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">submit</span> ?<span style="font-family:monospace; font-weight: bold; [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3791"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">submit</span> ?<span style="font-family:monospace; font-weight: bold; [...]
emits the code for a classical HTML submit button. Example: the following
code
</div><div style="margin-bottom:1.5ex ; padding .5ex">
@@ -173,41 +177,41 @@ myform destroy</pre><div style="margin-bottom:1.5ex ; padding .5ex">
</div><pre class="programlisting">
<form...>
<input type="submit" name="submit" value="Search" />
- </form></pre></div></dd></dl></div></div><div class="refsect2"><a name="idm3791"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">button</span> ?<span style="font-family:monospace; font-weight [...]
+ </form></pre></div></dd></dl></div></div><div class="refsect2"><a name="idm3804"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">button</span> ?<span style="font-family:monospace; font-weight [...]
emits the code for a button field having ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>name</code></em></span>? as name
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3802"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">reset</span> ?<span style="font-family:monospace; font-weight: bold;" [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3815"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">reset</span> ?<span style="font-family:monospace; font-weight: bold;" [...]
Classical HTML reset button that resets the input fields
back to their initial values
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3811"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">image</span> ?<span style="font-family:monospace; font-weight: bold;" [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3824"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">image</span> ?<span style="font-family:monospace; font-weight: bold;" [...]
Emits an image input field
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3820"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">radio</span> ?<span style="font-family:monospace; font-weight: bold;" [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3833"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">radio</span> ?<span style="font-family:monospace; font-weight: bold;" [...]
Emits a radiobutton input field
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3829"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">color</span> ?<span style="font-family:monospace; font-weight: bold;" [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3842"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">color</span> ?<span style="font-family:monospace; font-weight: bold;" [...]
Emits an HTML 5 "color" form field
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3838"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">date</span> ?<span style="font-family:monospace; font-weight: bold;"> [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3851"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">date</span> ?<span style="font-family:monospace; font-weight: bold;"> [...]
Emits an HTML 5 "date" form field
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3847"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">datetime</span> ?<span style="font-family:monospace; font-weight: bol [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3860"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">datetime</span> ?<span style="font-family:monospace; font-weight: bol [...]
Emits an HTML 5 "datetime" form field
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3856"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">datetime_local</span> ?<span style="font-family:monospace; font-weigh [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3869"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">datetime_local</span> ?<span style="font-family:monospace; font-weigh [...]
Emits an HTML 5 "datetime_local" form field
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3865"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">email</span> ?<span style="font-family:monospace; font-weight: bold;" [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3878"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">email</span> ?<span style="font-family:monospace; font-weight: bold;" [...]
Emits an HTML 5 "email" form field
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3874"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">file</span> ?<span style="font-family:monospace; font-weight: bold;"> [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3887"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">file</span> ?<span style="font-family:monospace; font-weight: bold;"> [...]
Emits an HTML 5 "file" form field
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3883"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">month</span> ?<span style="font-family:monospace; font-weight: bold;" [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3896"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">month</span> ?<span style="font-family:monospace; font-weight: bold;" [...]
Emits an HTML 5 "month" form field
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3892"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">number</span> ?<span style="font-family:monospace; font-weight: bold; [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3905"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">number</span> ?<span style="font-family:monospace; font-weight: bold; [...]
Emits an HTML 5 "number" form field
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3901"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">range</span> ?<span style="font-family:monospace; font-weight: bold;" [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3914"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">range</span> ?<span style="font-family:monospace; font-weight: bold;" [...]
Emits an HTML 5 "range" form field
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3910"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">search</span> ?<span style="font-family:monospace; font-weight: bold; [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3923"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">search</span> ?<span style="font-family:monospace; font-weight: bold; [...]
Emits an HTML 5 "search" form field
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3919"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">tel</span> ?<span style="font-family:monospace; font-weight: bold;">n [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3932"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">tel</span> ?<span style="font-family:monospace; font-weight: bold;">n [...]
Emits an HTML 5 "tel" form field
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3928"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">time</span> ?<span style="font-family:monospace; font-weight: bold;"> [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3941"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">time</span> ?<span style="font-family:monospace; font-weight: bold;"> [...]
Emits an HTML 5 "time" form field
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3937"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">url</span> ?<span style="font-family:monospace; font-weight: bold;">n [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3950"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">url</span> ?<span style="font-family:monospace; font-weight: bold;">n [...]
Emits an HTML 5 "url" form field
- </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3946"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">week</span> ?<span style="font-family:monospace; font-weight: bold;"> [...]
+ </div></div></dd></dl></div></div><div class="refsect2"><a name="idm3959"></a><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;">week</span> ?<span style="font-family:monospace; font-weight: bold;"> [...]
Emits an HTML 5 "week" form field
</div></div></dd></dl></div></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="form.html"><img src="images/prev.png" alt="Prev"></a> </td><td width="20%" align="center"><a accesskey="u" href="form.html"><img src="images/up.png" alt="Up"></a></td><td width="40%" align="right"> <a accesskey="n" href="calendar_package.html"><img src="images/next.png" alt="Next"></a></td></tr><tr><td widt [...]
diff --git a/rivet/manual3.2/formbroker.html b/rivet/manual3.2/formbroker.html
index 370bd86..4ffcea9 100644
--- a/rivet/manual3.2/formbroker.html
+++ b/rivet/manual3.2/formbroker.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>The Form Broker</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="toglyphs.html" title="toGlyphs"><link rel="next" href="fb.html" title="FormBroker"></head><body bgcolor="white" text="b [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>The Form Broker</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="toglyphs.html" title="toGlyphs"><link rel="next" href="fb.html" title="FormBroker"></head><body bgcolor="white" text="bla [...]
The <span style="font-family:monospace"><span class="command"><strong>FormBroker</strong></span></span> package creates instances of
form data description objects. These objects instances have
a simple set of methods to validate and control data
diff --git a/rivet/manual3.2/headers.html b/rivet/manual3.2/headers.html
index 748d8c6..37a8b8b 100644
--- a/rivet/manual3.2/headers.html
+++ b/rivet/manual3.2/headers.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>headers</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="exit.html" title="exit"><link rel="next" href="html.html" title="html"></head><body bgcolor="white" text="bl [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>headers</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="exit.html" title="exit"><link rel="next" href="html.html" title="html"></head><body bgcolor="white" text="blac [...]
The <span style="font-family:monospace"><span class="command"><strong>headers</strong></span></span> command is for setting and
parsing HTTP headers.
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
diff --git a/rivet/manual3.2/help.html b/rivet/manual3.2/help.html
index 70a739b..def3f20 100644
--- a/rivet/manual3.2/help.html
+++ b/rivet/manual3.2/help.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Resources - How to Get Help</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="fb.html" title="FormBroker"><link rel="next" href="internals.html" title="Rivet Internals"></head><body bgc [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Resources - How to Get Help</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="fb.html" title="FormBroker"><link rel="next" href="internals.html" title="Rivet Internals"></head><body bgcol [...]
The Rivet mailing list is the first place you should turn for
help. If you haven't found the solution to your problem in the documentation
or you have a question, idea, or comment about the Rivet code itself send email to
@@ -6,7 +6,7 @@
<code class="email"><<a class="email" href="mailto:rivet-dev-subscribe@tcl.apache.org">rivet-dev-subscribe@tcl.apache.org</a>></code>.
</p><p style="width:90%">
The mailing list archives are available at <a class="ulink" href="http://mail-archives.apache.org/mod_mbox/tcl-rivet-dev/" target="_top">http://mail-archives.apache.org/mod_mbox/tcl-rivet-dev/</a>
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4361"></a>Newsgroup</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4374"></a>Newsgroup</h3></div></div></div><p style="width:90%">
The <a class="ulink" href="news:comp.lang.tcl" target="_top">news:comp.lang.tcl</a> newsgroup is a good
place to ask about Tcl questions in general. Rivet developers
also follow the newsgroup, but it's best to ask Rivet-specific
@@ -28,14 +28,14 @@
</div></li><li class="listitem"><div style="margin-bottom:1.5ex ; padding .5ex">
<a class="ulink" href="http://wiki.tcl.tk" target="_top">http://wiki.tcl.tk</a> is the Tcl'ers Wiki, a
free-form place to search for answers and ask for help.
- </div></li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4381"></a>Bug Tracking System</h3></div></div></div><p style="width:90%">
+ </div></li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4394"></a>Bug Tracking System</h3></div></div></div><p style="width:90%">
Apache Rivet uses the Apache Bug Tracking system at <a class="ulink" href="http://issues.apache.org/bugzilla/" target="_top">http://issues.apache.org/bugzilla/</a>. Here,
you can report problems, or check and see if existing issues
are already known and being dealt with.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4385"></a>IRC</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4398"></a>IRC</h3></div></div></div><p style="width:90%">
Occasionally, someone from the Rivet team is on IRC at
irc.freenode.net, channel #tcl.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4388"></a>Editing Rivet Template Files</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4401"></a>Editing Rivet Template Files</h3></div></div></div><p style="width:90%">
Rivet makes available code for two popular editors,
<span class="application">emacs</span> and
<span class="application">vim</span> to facilitate the editing of
diff --git a/rivet/manual3.2/html.html b/rivet/manual3.2/html.html
index 06e417f..9000802 100644
--- a/rivet/manual3.2/html.html
+++ b/rivet/manual3.2/html.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>html</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="headers.html" title="headers"><link rel="next" href="http_accept.html" title="http_accept"></head><body bgcolor [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>html</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="headers.html" title="headers"><link rel="next" href="http_accept.html" title="http_accept"></head><body bgcolor=" [...]
Print text with the added ability to pass HTML tags
following the string. Example:
</p><pre class="programlisting">::rivet::html "Test" b i</pre><p style="width:90%">
diff --git a/rivet/manual3.2/html_calendar.html b/rivet/manual3.2/html_calendar.html
index e4117b5..02c64cb 100644
--- a/rivet/manual3.2/html_calendar.html
+++ b/rivet/manual3.2/html_calendar.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>HtmlCalendar</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="calendar_package.html" title="Calendar Package"><link rel="prev" href="xml_calendar.html" title="XmlCalendar"><link rel="next" href="entities.html" title="RivetEntities"></head><body [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>HtmlCalendar</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="calendar_package.html" title="Calendar Package"><link rel="prev" href="xml_calendar.html" title="XmlCalendar"><link rel="next" href="entities.html" title="RivetEntities"></head><body b [...]
Concrete XmlCalendar class for printing html calendar tables. The markup of the class
is xhtml compliant and prints a code fragment for inclusion in a webpage.
The following is the class definition.
@@ -18,7 +18,7 @@
-days_row tr \
-days_cell td
}
-}</pre></div><div class="refsect1"><a name="idm4157"></a><p style="width:90%">
+}</pre></div><div class="refsect1"><a name="idm4170"></a><p style="width:90%">
A sample output from HtmlCalendar (with some styling)
</p><p style="width:90%">
</p><div><img src="images/calendar.png"></div><p style="width:90%">
diff --git a/rivet/manual3.2/http_accept.html b/rivet/manual3.2/http_accept.html
index 1176ae9..93de7f6 100644
--- a/rivet/manual3.2/http_accept.html
+++ b/rivet/manual3.2/http_accept.html
@@ -1,8 +1,8 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>http_accept</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="html.html" title="html"><link rel="next" href="import_keyvalue_pairs.html" title="import_keyvalue_pairs" [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>http_accept</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="html.html" title="html"><link rel="next" href="import_keyvalue_pairs.html" title="import_keyvalue_pairs">< [...]
?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>-zeroweight</code></em></span>?
?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>-default</code></em></span>?
?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>-list</code></em></span>?
- http_accept_line</span> </div></div></div><div class="refsect1"><a name="idm1283"></a><h2>Description</h2><p style="width:90%">
+ http_accept_line</span> </div></div></div><div class="refsect1"><a name="idm1289"></a><h2>Description</h2><p style="width:90%">
Command for parsing HTTP Accept header lines that tell the
server about preferences and/or capabilities of the browser
(e.g. content language,media type, etc.). The following
diff --git a/rivet/manual3.2/import_keyvalue_pairs.html b/rivet/manual3.2/import_keyvalue_pairs.html
index 425f041..7ef5f3e 100644
--- a/rivet/manual3.2/import_keyvalue_pairs.html
+++ b/rivet/manual3.2/import_keyvalue_pairs.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>import_keyvalue_pairs</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="http_accept.html" title="http_accept"><link rel="next" href="include.html" title="include"></h [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>import_keyvalue_pairs</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="http_accept.html" title="http_accept"><link rel="next" href="include.html" title="include"></hea [...]
key-value pairs, like "-foo bar" are stored in the array ?<span style="font-family:monospace; font-weight: bold;">arrayName</span>?.
In that case, the value "bar" would be stored in the element "foo"
</p><p style="width:90%">
diff --git a/rivet/manual3.2/include.html b/rivet/manual3.2/include.html
index 5e51721..9ee55ad 100644
--- a/rivet/manual3.2/include.html
+++ b/rivet/manual3.2/include.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>include</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="import_keyvalue_pairs.html" title="import_keyvalue_pairs"><link rel="next" href="inspect.html" title="inspec [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>include</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="import_keyvalue_pairs.html" title="import_keyvalue_pairs"><link rel="next" href="inspect.html" title="inspect" [...]
Include a file without parsing it for processing tags <?
and ?>. This is the best way to include an HTML file or
any other static content.
diff --git a/rivet/manual3.2/index.html b/rivet/manual3.2/index.html
index 89a74d3..993ceed 100644
--- a/rivet/manual3.2/index.html
+++ b/rivet/manual3.2/index.html
@@ -1,6 +1,6 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Apache Rivet 3.2</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="next" href="installation.html" title="Apache Rivet 3.2 Installation"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Apache Rivet 3.2</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="next" href="installation.html" title="Apache Rivet 3.2 Installation"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table wi [...]
<code class="email"><<a class="email" href="mailto:rivet-dev@tcl.apache.org">rivet-dev@tcl.apache.org</a>></code><br>
- </p></div></div></div></div><div><p class="copyright">Copyright © 2002-2020 Apache Software Foundation</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="index.html#introduction">Introduction to Apache Rivet version 3.2</a></span></dt><dt><span class="section"><a href="installation.html">Apache Rivet 3.2 Installation</a></span></dt><dt><span class="section"><a href="cmake.html">Building Rivet 3.2 with CMake [...]
+ </p></div></div></div></div><div><p class="copyright">Copyright © 2002-2021 Apache Software Foundation</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="index.html#introduction">Introduction to Apache Rivet version 3.2</a></span></dt><dt><span class="section"><a href="installation.html">Apache Rivet 3.2 Installation</a></span></dt><dt><span class="section"><a href="cmake.html">Building Rivet 3.2 with CMake [...]
Shorthand construct for single strings output
</span></dt><dt><span class="refentrytitle"><a href="abort_code.html">abort_code</a></span><span class="refpurpose"> —
Returns the code passed to <span style="font-family:monospace"><span class="command"><strong>abort_page</strong></span></span>
@@ -9,11 +9,11 @@
Stops outputting data to web page, similar in
purpose to PHP's <span style="font-family:monospace"><span class="command"><strong>die</strong></span></span> command.
</span></dt><dt><span class="refentrytitle"><a href="apache_log_error.html">apache_log_error</a></span><span class="refpurpose"> — log messages to the Apache error log</span></dt><dt><span class="refentrytitle"><a href="apache_table.html">apache_table</a></span><span class="refpurpose"> — access and manipulate Apache tables in the request structure.</span></dt><dt><span class="refentrytitle"><a href="catch.html">catch</a></span><span class="refpurpose"> — wraps core command <span style [...]
- A command to print strings, arrays
- and the values of variables as specified by the arguments.
- </span></dt><dt><span class="refentrytitle"><a href="env.html">env</a></span><span class="refpurpose"> —
- Loads a single "environmental variable" into a Tcl variable.
- </span></dt><dt><span class="refentrytitle"><a href="escape_sgml_chars.html">escape_sgml_chars</a></span><span class="refpurpose"> — escape special SGML characters in a string.</span></dt><dt><span class="refentrytitle"><a href="escape_shell_command.html">escape_shell_command</a></span><span class="refpurpose"> — escape shell metacharacters in a string.</span></dt><dt><span class="refentrytitle"><a href="escape_string.html">escape_string</a></span><span class="refpurpose"> — convert a [...]
+ A command to print strings, arrays
+ and the values of variables as specified by the arguments.
+ </span></dt><dt><span class="refentrytitle"><a href="env.html">env</a></span><span class="refpurpose"> —
+ Returns the value a single "environmental variable".
+ </span></dt><dt><span class="refentrytitle"><a href="escape_sgml_chars.html">escape_sgml_chars</a></span><span class="refpurpose"> — escape special SGML characters in a string.</span></dt><dt><span class="refentrytitle"><a href="escape_shell_command.html">escape_shell_command</a></span><span class="refpurpose"> — escape shell metacharacters in a string.</span></dt><dt><span class="refentrytitle"><a href="escape_string.html">escape_string</a></span><span class="refpurpose"> — convert a [...]
Returns 1 if <list> is empty or 0 if it has any elements.
This command emulates the TclX lempty command.
</span></dt><dt><span class="refentrytitle"><a href="lmatch.html">lmatch</a></span><span class="refpurpose"> —
@@ -28,18 +28,18 @@
Split the line into multiple lines by splitting on space characters
</span></dt><dt><span class="refentrytitle"><a href="xml.html">xml</a></span><span class="refpurpose"> —
XML Fragments creation
- </span></dt></dl></dd><dt><span class="section"><a href="examples.html">Examples and Usage</a></span></dt><dt><span class="section"><a href="tcl_packages.html">Rivet Tcl Packages</a></span></dt><dt><span class="section"><a href="dio.html">DIO - Database Interface Objects</a></span></dt><dd><dl><dt><span class="refentrytitle"><a href="dio_package.html">DIO</a></span><span class="refpurpose"> — Database Interface Objects</span></dt></dl></dd><dt><span class="section"><a href="d [...]
+ </span></dt></dl></dd><dt><span class="section"><a href="examples.html">Examples and Usage</a></span></dt><dt><span class="section"><a href="tcl_packages.html">Rivet Tcl Packages</a></span></dt><dt><span class="section"><a href="dio.html">DIO - Database Interface Objects</a></span></dt><dd><dl><dt><span class="refentrytitle"><a href="dio_package.html">DIO</a></span><span class="refpurpose"> — Database Interface Objects</span></dt></dl></dd><dt><span class="section"><a href="d [...]
encode a string replacing every occurrence of characters for
which an SGML entity exists
</span></dt><dt><span class="refentrytitle"><a href="decode.html">decode</a></span><span class="refpurpose"> —
decode an SGML encoded string replacing every entity with the
corresponding character
- </span></dt></dl></dd><dt><span class="section"><a href="asciiglyphs.html">AsciiGlyphs</a></span></dt><dd><dl><dt><span class="section"><a href="asciiglyphs.html#idm4203">Introduction</a></span></dt><dt><span class="refentrytitle"><a href="toglyphs.html">toGlyphs</a></span><span class="refpurpose"> —
+ </span></dt></dl></dd><dt><span class="section"><a href="asciiglyphs.html">AsciiGlyphs</a></span></dt><dd><dl><dt><span class="section"><a href="asciiglyphs.html#idm4216">Introduction</a></span></dt><dt><span class="refentrytitle"><a href="toglyphs.html">toGlyphs</a></span><span class="refpurpose"> —
print large ASCII glyphs
- </span></dt><dt><span class="section"><a href="asciiglyphs.html#idm4219">Example</a></span></dt></dl></dd><dt><span class="section"><a href="formbroker.html">The Form Broker</a></span></dt><dd><dl><dt><span class="section"><a href="formbroker.html#idm4224">Introduction</a></span></dt><dt><span class="refentrytitle"><a href="fb.html">FormBroker</a></span><span class="refpurpose"> —
+ </span></dt><dt><span class="section"><a href="asciiglyphs.html#idm4232">Example</a></span></dt></dl></dd><dt><span class="section"><a href="formbroker.html">The Form Broker</a></span></dt><dd><dl><dt><span class="section"><a href="formbroker.html#idm4237">Introduction</a></span></dt><dt><span class="refentrytitle"><a href="fb.html">FormBroker</a></span><span class="refpurpose"> —
Form broker object creator
- </span></dt></dl></dd><dt><span class="section"><a href="help.html">Resources - How to Get Help</a></span></dt><dd><dl><dt><span class="section"><a href="help.html#idm4354">Mailing Lists</a></span></dt><dt><span class="section"><a href="help.html#idm4361">Newsgroup</a></span></dt><dt><span class="section"><a href="help.html#websites">Web Sites</a></span></dt><dt><span class="section"><a href="help.html#idm4381">Bug Tracking System</a></span></dt><dt><span class="section"><a h [...]
- This manual is released as part of Apache/Rivet 3.2.0 (Tuesday 2020-11-03 00:35:08+01:00).
+ </span></dt></dl></dd><dt><span class="section"><a href="help.html">Resources - How to Get Help</a></span></dt><dd><dl><dt><span class="section"><a href="help.html#idm4367">Mailing Lists</a></span></dt><dt><span class="section"><a href="help.html#idm4374">Newsgroup</a></span></dt><dt><span class="section"><a href="help.html#websites">Web Sites</a></span></dt><dt><span class="section"><a href="help.html#idm4394">Bug Tracking System</a></span></dt><dt><span class="section"><a h [...]
+ This manual is released as part of Apache/Rivet 3.2.1 (Monday 2021-11-08 09:52:51+01:00).
</p><div class="section"><div class="titlepage"><div><div><hr><h2 class="title" style="clear: both"><a name="introduction"></a>Introduction to Apache Rivet version 3.2</h2></div></div></div><p style="width:90%">
Apache Rivet is a system for creating dynamic web content by
integrating the
diff --git a/rivet/manual3.2/inspect.html b/rivet/manual3.2/inspect.html
index f3383f2..e1a2d2d 100644
--- a/rivet/manual3.2/inspect.html
+++ b/rivet/manual3.2/inspect.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>inspect</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="include.html" title="include"><link rel="next" href="lassign_array.html" title="lassign_array"></head><body [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>inspect</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="include.html" title="include"><link rel="next" href="lassign_array.html" title="lassign_array"></head><body bg [...]
<span style="font-family:monospace"><span class="command"><strong>::rivet::inspect</strong></span></span> provides introspection into the running
configuration of Rivet. Rivet's debug command uses it in order to gain insight
into the configuration, but it can be used in any script.
diff --git a/rivet/manual3.2/installation.html b/rivet/manual3.2/installation.html
index 2cc3053..a99b2ec 100644
--- a/rivet/manual3.2/installation.html
+++ b/rivet/manual3.2/installation.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Apache Rivet 3.2 Installation</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="index.html" title="Apache Rivet 3.2"><link rel="next" href="cmake.html" title="Building Rivet 3.2 with CM [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Apache Rivet 3.2 Installation</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="index.html" title="Apache Rivet 3.2"><link rel="next" href="cmake.html" title="Building Rivet 3.2 with CMak [...]
Rivet 3.2 runs with the Apache 2.4.x HTTP web server.
It is known to build and run on various Linux distributions
(Debian & Ubuntu, Redhat, SuSE and CentOS), FreeBSD and OpenBSD. For some
@@ -67,8 +67,8 @@
We will assume that you have Apache installed at this point.
You must uncompress the Rivet sources in the directory where you
wish to compile them.
- </p><pre class="programlisting">gunzip rivet-3.2.0.tar.gz
-tar -xvf rivet-3.2.0.tar.gz</pre><p style="width:90%">
+ </p><pre class="programlisting">gunzip rivet-3.2.1.tar.gz
+tar -xvf rivet-3.2.1.tar.gz</pre><p style="width:90%">
</p></li><li class="step"><p class="title"><b>Building Rivet</b></p><ol type="a" class="substeps"><li class="step"><p style="width:90%">
Rivet uses the standard <span style="font-family:monospace"><span class="command"><strong>./configure ; make ; make install</strong></span></span>
sequence which installs to their target directories the Apache module, the binary libraries and the
@@ -120,7 +120,10 @@ tar -xvf rivet-3.2.0.tar.gz</pre><p style="width:90%">
thus demanding the commands to be exported (otherwise it would generate errors at run-time).
This option is disabled by default and it can be changed in the configuration with
the ImportRivetNS directive
- </div></div></dd><dt><span class="term">--enable-virtual-interps-separation</span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:1.5ex ; padding .5ex">
+ </div></div></dd><dt><span class="term">--enable-rivet-debug-build</span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:1.5ex ; padding .5ex">
+ Enable definition of the preprocessor symbol RIVET_DEBUG_BUILD. This is used to
+ conditionally include code into the build for development and debugging purposes
+ </div></div></dd><dt><span class="term">--enable-virtual-interps-separation</span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:1.5ex ; padding .5ex">
This option changes the default for the SeparateVirtualInterps configuration
variable. Default: 0 (no separation among interpreters)
</div></div></dd></dl></div><p style="width:90%">
diff --git a/rivet/manual3.2/internals.html b/rivet/manual3.2/internals.html
index ed1c7e9..a17be9d 100644
--- a/rivet/manual3.2/internals.html
+++ b/rivet/manual3.2/internals.html
@@ -1,11 +1,11 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Rivet Internals</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="help.html" title="Resources - How to Get Help"><link rel="next" href="lazybridge.html" title="Example: the “Lazy” bridg [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Rivet Internals</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="help.html" title="Resources - How to Get Help"><link rel="next" href="lazybridge.html" title="Example: the “Lazy” bridge" [...]
This section easily falls out of date, as new code is added, old
code is removed, and changes are made. The best place to look
is the source code itself. If you are interested in the changes
themselves, the Subversion revision control system
(<span style="font-family:monospace"><span class="command"><strong>svn</strong></span></span>) can provide you with information about
what has been happening with the code.
- </p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4400"></a>Rivet approach to Apache Multiprocessing Models</h3></div></div></div><p style="width:90%">
+ </p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4413"></a>Rivet approach to Apache Multiprocessing Models</h3></div></div></div><p style="width:90%">
The Apache HTTP web server has an extremely modular architecture
that made it very popular among web developers. Most of the server
features can be implemented in external modules, including some of
@@ -22,33 +22,33 @@
mod_rivet to offer a design that could work together with more MPM and
hopefully pave the way to support different OS that have no 'fork'
call. At the same time we tried to preserve some of the basic
- features of mod_rivet when working with the prefork MPM, chiefly the feature of
- the Unix fork system call of 'cloning' a parent process
+ features of mod_rivet when working with the prefork MPM, chiefly
+ the feature of the Unix fork system call of 'cloning' a parent process
memory into its child, thus allowing fast initialization of interpreters.
</p><p style="width:90%">
The central design of mod_rivet now relies on the idea of <span class="quote">“<span class="quote">MPM bridges</span>”</span>,
loadable modules that are responsible to adapt the module procedural design to
a given class of Apache MPMs. This design is open to the development of more
MPM bridges coping with different multi-processing models but also to the development of
- different approaches to resource consumption and workload balance. Currently we have 3 bridges:
+ different approaches to resource consumption and workload balance. Currently we have 3 bridges:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">rivet_prefork_mpm.c: a bridge for the prefork MPM</li><li class="listitem">rivet_worker_mpm.c: a threaded bridge creating a pool of threads
- each running Tcl interpreters and communicating with the worker MPM threads
- through a thread safe queue. This bridge is needed by the worker MPM.</li><li class="listitem">rivet_lazy_mpm.c: a threaded bridge where Tcl threads are
- started <span class="quote">“<span class="quote">on demand</span>”</span>. The bridge creates no threads and Tcl interpreters
- at start up and only when requests come in Tcl execution threads are created.
- This bridge is explained in detail in the <a class="xref" href="lazybridge.html" title="Example: the “Lazy” bridge">the section called “Example: the <span class="quote">“<span class="quote">Lazy</span>”</span> bridge”</a>.
- Since the resource demand at startup is minimal this bridge should suit
- development machines that go through frequent web server restarts.</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4413"></a>mod_rivet MPM Bridge callbacks</h3></div></div></div><p style="width:90%">
- A bridge is a loadable library implementing different ways to handle
- specific features needed to mod_rivet. It was originally meant as a way
- to handle the prefork/worker/event MPM specificities, at the same time
- avoiding the need to stuff the
- code with conditional statements that would have implied useless complexity (an
- instance of the Apache web server can run only an MPM at a time),
- error prone programming and performance costs.
- New bridges could be imagined also to implement different models of workload
- and resource management (like the resources demanded by the Tcl interpreters).
- We designed an interface between the core of mod_rivet and its MPM bridges
+ each running Tcl interpreters and communicating with the worker MPM threads
+ through a thread safe queue. This bridge is needed by the worker MPM and by
+ any the winnt MPM on Windows.</li><li class="listitem">rivet_lazy_mpm.c: a threaded bridge where Tcl threads are
+ started <span class="quote">“<span class="quote">on demand</span>”</span>. The bridge creates no threads and Tcl interpreters
+ at start up, only when requests come in Tcl execution threads are created.
+ This bridge is explained in detail in the <a class="xref" href="lazybridge.html" title="Example: the “Lazy” bridge">the section called “Example: the <span class="quote">“<span class="quote">Lazy</span>”</span> bridge”</a>.
+ Since the resource demand at startup is minimal this bridge should suit
+ development machines that go through frequent web server restarts.</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4426"></a>mod_rivet MPM Bridge callbacks</h3></div></div></div><p style="width:90%">
+ A bridge is a loadable library implementing different ways to handle
+ specific features needed to mod_rivet. It was originally meant as a way
+ to handle the prefork/worker/event MPM specificities, at the same time
+ avoiding the need to stuff the code with conditional statements that would
+ have implied useless complexity (an instance of the Apache web server can
+ run only an MPM at a time), error prone programming and performance costs.
+ New bridges could be imagined also to implement different models of workload
+ and resource management (like the resources demanded by the Tcl interpreters).
+ We designed an interface between the core of mod_rivet and its MPM bridges
based on a set of functions defined in the rivet_bridge_table structure.
</p><pre class="programlisting">typedef struct _mpm_bridge_table {
RivetBridge_ServerInit *mpm_server_init;
@@ -119,8 +119,8 @@
status. So this macro (and associated function) should hide from the module core function
the specific approach followed in a particular bridge
</li></ul></div><p style="width:90%">
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4447"></a>Server Initialization and MPM Bridge</h3></div></div></div><p style="width:90%">
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4450"></a>RivetChan</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4460"></a>Server Initialization and MPM Bridge</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4463"></a>RivetChan</h3></div></div></div><p style="width:90%">
The <span class="structname">RivetChan</span> system was created in
order to have an actual Tcl channel that we could redirect
standard output to. This enables us use, for instance, the
@@ -130,7 +130,7 @@
Tcl's regular standard output is replaced with an instance of
this channel type, so that, by default, output will go to the
web page.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4455"></a>The <span style="font-family:monospace"><span class="command"><strong>global</strong></span></span> Command</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4468"></a>The <span style="font-family:monospace"><span class="command"><strong>global</strong></span></span> Command</h3></div></div></div><p style="width:90%">
Rivet aims to run standard Tcl code with as few surprises as
possible. At times this involves some compromises - in this
case regarding the <span style="font-family:monospace"><span class="command"><strong>global</strong></span></span> command. The
@@ -145,7 +145,7 @@
you really need a true global variable, use either
<span style="font-family:monospace"><span class="command"><strong>::global</strong></span></span> or add the :: namespace qualifier
to variables you wish to make global.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4463"></a>Page Parsing, Execution and Caching</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4476"></a>Page Parsing, Execution and Caching</h3></div></div></div><p style="width:90%">
When a Rivet page is requested, it is transformed into an
ordinary Tcl script by parsing the file for the <? ?>
processing instruction tags. Everything outside these tags
@@ -171,7 +171,7 @@
without having to reload it (and re-parse it) from the disk.
The number of scripts stored in memory is configurable. This
feature can significantly improve performance.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4471"></a>Extending Rivet by developing C code procedures</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4484"></a>Extending Rivet by developing C code procedures</h3></div></div></div><p style="width:90%">
Rivet endows the Tcl interpreter with new commands
serving as interface between the application layer and the
Apache web server. Many of these commands
@@ -246,7 +246,7 @@ check_fail my_cmd <arg1> <arg2>
mycmd->1</pre>
The value associated to the test must be 0 in case the
command doesn't need to test the <span style="font-family:monospace"><span class="command"><strong>private->r</strong></span></span> pointer.
- </li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4495"></a>Debugging Rivet and Apache</h3></div></div></div><p style="width:90%">
+ </li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4508"></a>Debugging Rivet and Apache</h3></div></div></div><p style="width:90%">
If you are interested in hacking on Rivet, you're welcome to
contribute! Invariably, when working with code, things go
wrong, and it's necessary to do some debugging. In a server
diff --git a/rivet/manual3.2/lassign_array.html b/rivet/manual3.2/lassign_array.html
index f6634f1..20f7f42 100644
--- a/rivet/manual3.2/lassign_array.html
+++ b/rivet/manual3.2/lassign_array.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>lassign_array</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="inspect.html" title="inspect"><link rel="next" href="lempty.html" title="lempty"></head><body bgcolor= [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>lassign_array</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="inspect.html" title="inspect"><link rel="next" href="lempty.html" title="lempty"></head><body bgcolor="w [...]
<span style="font-family:monospace"><span class="command"><strong>lassign_array</strong></span></span> is an utility command inspired by the same Tclx command and
with a close resemblance with Tcl's <span style="font-family:monospace"><span class="command"><strong>lassign</strong></span></span> for assigning list elements to variables.
<span style="font-family:monospace"><span class="command"><strong>lassign_array</strong></span></span> first argument is a list of values to be assigned to an array that must be
diff --git a/rivet/manual3.2/lazybridge.html b/rivet/manual3.2/lazybridge.html
index a32b79c..beab20d 100644
--- a/rivet/manual3.2/lazybridge.html
+++ b/rivet/manual3.2/lazybridge.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Example: the “Lazy” bridge</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="internals.html" title="Rivet Internals"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840 [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Example: the “Lazy” bridge</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="internals.html" title="Rivet Internals"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#84008 [...]
The 'bridge' concept was introduced to cope with the ability of
the Apache HTTP web server to adopt different multiprocessing
models by loading one of the available MPMs (Multi Processing Modules).
@@ -19,7 +19,7 @@
This demands a Tcl interpreters be run
on separated threads communicating with the HTTP web server
through suitable methods.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4529"></a>Lazy bridge data structures</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4542"></a>Lazy bridge data structures</h3></div></div></div><p style="width:90%">
The lazy bridge was initially developed to outline the basic tasks
carried out by each function making a rivet MPM bridge.
The lazy bridge attempts to be minimalist
@@ -33,12 +33,12 @@
This is the lazy bridge jump table, as such it defines the functions
implemented by the bridge.
</p><pre class="programlisting">RIVET_MPM_BRIDGE {
- NULL,
- Lazy_MPM_ChildInit,
- Lazy_MPM_Request,
- Lazy_MPM_Finalize,
- Lazy_MPM_ExitHandler,
- Lazy_MPM_Interp
+ LazyBridge_ServerInit,
+ LazyBridge_ChildInit,
+ LazyBridge_Request,
+ LazyBridge_Finalize,
+ LazyBridge_ExitHandler,
+ LazyBridge_Interp
};</pre><p style="width:90%">
After the server initialization stage, child processes read the configuration
and modules build their own configuration representation. MPM bridges hooks into
@@ -46,10 +46,9 @@
A fundamental information built during this stage is the database of virtual hosts.
The lazy bridge keeps an array of virtual host descriptor pointers
each of them referencing an instance of the following structure.
- </p><pre class="programlisting">/* virtual host descriptor */
+ </p><pre class="programlisting">/* virtual host thread queue descriptor */
typedef struct vhost_iface {
- int idle_threads_cnt; /* idle threads for the virtual hosts */
int threads_count; /* total number of running and idle threads */
apr_thread_mutex_t* mutex; /* mutex protecting 'array' */
apr_array_header_t* array; /* LIFO array of lazy_tcl_worker pointers */
@@ -65,6 +64,17 @@ typedef struct mpm_bridge_status {
int server_shutdown; /* the child process is shutting down */
vhost* vhosts; /* array of vhost descriptors */
} mpm_bridge_status;</pre><p style="width:90%">
+ The lazy bridge also extends the thread private data structure with the
+ data concerning the Tcl intepreter, its configuration and
+ </p><pre class="programlisting">/* lazy bridge thread private data extension */
+
+typedef struct mpm_bridge_specific {
+ rivet_thread_interp* interp; /* thread Tcl interpreter object */
+ int keep_going; /* thread loop controlling variable */
+ /* the request_rec and TclWebRequest *
+ * are copied here to be passed to a *
+ * channel */
+} mpm_bridge_specific;</pre><p style="width:90%">
By design the bridge must create exactly one instance of <span style="font-family:monospace"><span class="command"><strong>mpm_bridge_status</strong></span></span>
and store its pointer in <span style="font-family:monospace"><span class="command"><strong>module_globals->mpm</strong></span></span>.
This is usually done at the very beginning of the child init script function pointed by
@@ -72,14 +82,14 @@ typedef struct mpm_bridge_status {
For the lazy bridge this field in the jump table points to <span style="font-family:monospace"><span class="command"><strong>Lazy_MPM_ChildInit</strong></span></span>
function
</p><pre class="programlisting">/*
- * -- Lazy_MPM_ChildInit
+ * -- LazyBridge_ChildInit
*
* child process initialization. This function prepares the process
* data structures for virtual hosts and threads management
*
*/
-void Lazy_MPM_ChildInit (apr_pool_t* pool, server_rec* server)
+void LazyBridge_ChildInit (apr_pool_t* pool, server_rec* server)
{
apr_status_t rv;
server_rec* s;
@@ -117,22 +127,21 @@ void Lazy_MPM_ChildInit (apr_pool_t* pool, server_rec* server)
for (s = root_server; s != NULL; s = s->next)
{
- int vh;
+ int idx;
apr_array_header_t* array;
rivet_server_conf* rsc = RIVET_SERVER_CONF(s->module_config);
- vh = rsc->idx;
- rv = apr_thread_mutex_create(&module_globals->mpm->vhosts[vh].mutex,
+ idx = rsc->idx;
+ rv = apr_thread_mutex_create(&module_globals->mpm->vhosts[idx].mutex,
APR_THREAD_MUTEX_UNNESTED,pool);
ap_assert(rv == APR_SUCCESS);
array = apr_array_make(pool,0,sizeof(void*));
ap_assert(array != NULL);
- module_globals->mpm->vhosts[vh].array = array;
- module_globals->mpm->vhosts[vh].idle_threads_cnt = 0;
- module_globals->mpm->vhosts[vh].threads_count = 0;
+ module_globals->mpm->vhosts[idx].array = array;
+ module_globals->mpm->vhosts[idx].threads_count = 0;
}
module_globals->mpm->server_shutdown = 0;
-}</pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4545"></a>Handling Tcl's exit core command</h3></div></div></div><p style="width:90%">
+}</pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4560"></a>Handling Tcl's exit core command</h3></div></div></div><p style="width:90%">
Most of the fields in the <span style="font-family:monospace"><span class="command"><strong>mpm_bridge_status</strong></span></span> are meant to deal
with the child exit process. Rivet supersedes the Tcl core's exit function
with a <span style="font-family:monospace"><span class="command"><strong>::rivet::exit</strong></span></span> function and it does so in order to curb the effects
@@ -164,7 +173,7 @@ void Lazy_MPM_ChildInit (apr_pool_t* pool, server_rec* server)
when the web server shuts down.
See these functions' code for further details, they are very easy to
read and understand
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4564"></a>HTTP request processing with the lazy bridge</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4579"></a>HTTP request processing with the lazy bridge</h3></div></div></div><p style="width:90%">
Requests processing with the lazy bridge is done by determining for which
virtual host a request was created. The <span style="font-family:monospace"><span class="command"><strong>rivet_server_conf</strong></span></span>
structure keeps a numerical index for each virtual host. This index is used
@@ -186,8 +195,7 @@ typedef struct lazy_tcl_worker {
request_rec* r;
int ctype;
int ap_sts;
- int nreqs;
- rivet_server_conf* conf; /* rivet_server_conf* record */
+ rivet_server_conf* conf; /* rivet_server_conf* record */
} lazy_tcl_worker;</pre><p style="width:90%">
The server field is assigned with the virtual host server record. Whereas the <span style="font-family:monospace"><span class="command"><strong>conf</strong></span></span>
field keeps the pointer to a run time computed <span style="font-family:monospace"><span class="command"><strong>rivet_server_conf</strong></span></span>. This structure
@@ -308,11 +316,12 @@ static void* APR_THREAD_FUNC request_processor (apr_thread_t *thd, void *data)
private->ext = apr_pcalloc(private->pool,sizeof(mpm_bridge_specific));
private->ext->keep_going = 1;
- private->ext->interp = Rivet_NewVHostInterp(private->pool,w->server);
+ //private->ext->interp = Rivet_NewVHostInterp(private->pool,w->server);
+ RIVET_POKE_INTERP(private,rsc,Rivet_NewVHostInterp(private->pool,rsc->default_cache_size));
private->ext->interp->channel = private->channel;
/* The worker thread can respond to a single request at a time therefore
- * must handle and register its own Rivet channel */
+ must handle and register its own Rivet channel */
Tcl_RegisterChannel(private->ext->interp->interp,*private->channel);
@@ -327,7 +336,7 @@ static void* APR_THREAD_FUNC request_processor (apr_thread_t *thd, void *data)
Rivet_PerInterpInit(private->ext->interp,private,w->server,private->pool);
/* The child initialization is fired. Beware of the terminologic
- * trap: we inherited from prefork only modules the term 'child'
+ * trap: we inherited from fork capable systems the term 'child'
* meaning 'child process'. In this case the child init actually
* is a worker thread initialization, because in a threaded module
* this is the agent playing the same role a child process plays
@@ -335,14 +344,21 @@ static void* APR_THREAD_FUNC request_processor (apr_thread_t *thd, void *data)
Lazy_RunConfScript(private,w,child_init);
+ idx = w->conf->idx;
+
+ /* After the thread has run the configuration script we
+ increment the threads counter */
+
+ apr_thread_mutex_lock(module_globals->mpm->vhosts[idx].mutex);
+ (module_globals->mpm->vhosts[idx].threads_count)++;
+ apr_thread_mutex_unlock(module_globals->mpm->vhosts[idx].mutex);
+
/* The thread is now set up to serve request within the the
* do...while loop controlled by private->keep_going */
- idx = w->conf->idx;
apr_thread_mutex_lock(w->mutex);
do
{
- module_globals->mpm->vhosts[idx].idle_threads_cnt++;
while ((w->status != init) && (w->status != thread_exit)) {
apr_thread_cond_wait(w->condition,w->mutex);
}
@@ -352,16 +368,16 @@ static void* APR_THREAD_FUNC request_processor (apr_thread_t *thd, void *data)
}
w->status = processing;
- module_globals->mpm->vhosts[idx].idle_threads_cnt--;
/* Content generation */
private->req_cnt++;
private->ctype = w->ctype;
+ private->r = w->r;
- w->ap_sts = Rivet_SendContent(private,w->r);
+ w->ap_sts = Rivet_SendContent(private);
- if (module_globals->mpm->server_shutdown) continue;
+ // if (module_globals->mpm->server_shutdown) continue;
w->status = done;
apr_thread_cond_signal(w->condition);
@@ -378,8 +394,8 @@ static void* APR_THREAD_FUNC request_processor (apr_thread_t *thd, void *data)
} while (private->ext->keep_going);
apr_thread_mutex_unlock(w->mutex);
- ap_log_error(APLOG_MARK,APLOG_DEBUG,APR_SUCCESS,w->server,"processor thread orderly exit");
Lazy_RunConfScript(private,w,child_exit);
+ ap_log_error(APLOG_MARK,APLOG_DEBUG,APR_SUCCESS,w->server,"processor thread orderly exit");
apr_thread_mutex_lock(module_globals->mpm->vhosts[idx].mutex);
(module_globals->mpm->vhosts[idx].threads_count)--;
diff --git a/rivet/manual3.2/lempty.html b/rivet/manual3.2/lempty.html
index 44b2976..3440ee1 100644
--- a/rivet/manual3.2/lempty.html
+++ b/rivet/manual3.2/lempty.html
@@ -1,7 +1,7 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>lempty</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="lassign_array.html" title="lassign_array"><link rel="next" href="lmatch.html" title="lmatch"></head><body bgc [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>lempty</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="lassign_array.html" title="lassign_array"><link rel="next" href="lmatch.html" title="lmatch"></head><body bgcol [...]
Returns 1 if <list> is empty or 0 if it has any elements.
This command emulates the TclX lempty command.
- </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::lempty</span> <span style="font-family:monospace; font-weight: bold;">list</span> </div></div></div><div class="refsect1"><a name="idm1385"></a><h2>Description</h2><p style="width:90%">
+ </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::lempty</span> <span style="font-family:monospace; font-weight: bold;">list</span> </div></div></div><div class="refsect1"><a name="idm1391"></a><h2>Description</h2><p style="width:90%">
Returns 1 if <list> is empty or 0 if it has any elements.
This command emulates the TclX lempty command.
</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="lassign_array.html"><img src="images/prev.png" alt="Prev"></a> </td><td width="20%" align="center"><a accesskey="u" href="commands.html"><img src="images/up.png" alt="Up"></a></td><td width="40%" align="right"> <a accesskey="n" href="lmatch.html"><img src="images/next.png" alt="Next"></a></td></tr><tr><td width="40%" align="left" valign="top [...]
diff --git a/rivet/manual3.2/lmatch.html b/rivet/manual3.2/lmatch.html
index 0d5d9ce..e24ef3e 100644
--- a/rivet/manual3.2/lmatch.html
+++ b/rivet/manual3.2/lmatch.html
@@ -1,6 +1,6 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>lmatch</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="lempty.html" title="lempty"><link rel="next" href="load_cookies.html" title="load_cookies"></head><body bgcol [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>lmatch</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="lempty.html" title="lempty"><link rel="next" href="load_cookies.html" title="load_cookies"></head><body bgcolor [...]
Look for elements in <list> that match <pattern>
- </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::lmatch</span> (<span style="font-family:monospace; font-weight: bold;">-exact</span> | <span style="font-family:monospace; font-weight: bold;">-glob</span> | <span style="font-family:monospace; font-weight: bold;">-regexp< [...]
+ </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::lmatch</span> (<span style="font-family:monospace; font-weight: bold;">-exact</span> | <span style="font-family:monospace; font-weight: bold;">-glob</span> | <span style="font-family:monospace; font-weight: bold;">-regexp< [...]
Look for elements in <list> that match <pattern>.
This command is a decent replacement for TclX lmatch command when TclX is
not available
diff --git a/rivet/manual3.2/load_cookies.html b/rivet/manual3.2/load_cookies.html
index 51bace4..ae9239d 100644
--- a/rivet/manual3.2/load_cookies.html
+++ b/rivet/manual3.2/load_cookies.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>load_cookies</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="lmatch.html" title="lmatch"><link rel="next" href="load_env.html" title="load_env"></head><body bgcolor [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>load_cookies</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="lmatch.html" title="lmatch"><link rel="next" href="load_env.html" title="load_env"></head><body bgcolor=" [...]
Load the array of cookie variables into the specified
array name. Uses array cookies by
default.
diff --git a/rivet/manual3.2/load_env.html b/rivet/manual3.2/load_env.html
index ae11b39..6ba6403 100644
--- a/rivet/manual3.2/load_env.html
+++ b/rivet/manual3.2/load_env.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>load_env</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="load_cookies.html" title="load_cookies"><link rel="next" href="load_headers.html" title="load_headers"></he [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>load_env</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="load_cookies.html" title="load_cookies"><link rel="next" href="load_headers.html" title="load_headers"></head [...]
Load the array of environment variables into the specified
array name. Uses array ::request::env by
default.
diff --git a/rivet/manual3.2/load_headers.html b/rivet/manual3.2/load_headers.html
index d420406..ed0eaae 100644
--- a/rivet/manual3.2/load_headers.html
+++ b/rivet/manual3.2/load_headers.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>load_headers</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="load_env.html" title="load_env"><link rel="next" href="load_response.html" title="load_response"></head [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>load_headers</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="load_env.html" title="load_env"><link rel="next" href="load_response.html" title="load_response"></head>< [...]
Load the headers that come from a client request into the
provided array name, or use headers if no
name is provided.
diff --git a/rivet/manual3.2/load_response.html b/rivet/manual3.2/load_response.html
index 0664347..3d8eeb3 100644
--- a/rivet/manual3.2/load_response.html
+++ b/rivet/manual3.2/load_response.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>load_response</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="load_headers.html" title="load_headers"><link rel="next" href="lremove.html" title="lremove"></head><b [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>load_response</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="load_headers.html" title="load_headers"><link rel="next" href="lremove.html" title="lremove"></head><bod [...]
Load any form variables passed to this page into an
array. If <span style="font-family:monospace"><span class="command"><strong>load_response</strong></span></span> is called without
arguments the array response is created in
diff --git a/rivet/manual3.2/lremove.html b/rivet/manual3.2/lremove.html
index 1020e9f..ae01321 100644
--- a/rivet/manual3.2/lremove.html
+++ b/rivet/manual3.2/lremove.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>lremove</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="load_response.html" title="load_response"><link rel="next" href="makeurl.html" title="makeurl"></head><body [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>lremove</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="load_response.html" title="load_response"><link rel="next" href="makeurl.html" title="makeurl"></head><body bg [...]
<span style="font-family:monospace"><span class="command"><strong>lremove</strong></span></span> removes from list ?<span style="font-family:monospace; font-weight: bold;">list</span>? the first occurrence
of an element matching one of the patterns listed in the command line. By specifying the
-all option every occurrence of one the patterns is removed
diff --git a/rivet/manual3.2/makeurl.html b/rivet/manual3.2/makeurl.html
index 8d33d25..16c01dd 100644
--- a/rivet/manual3.2/makeurl.html
+++ b/rivet/manual3.2/makeurl.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>makeurl</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="lremove.html" title="lremove"><link rel="next" href="no_body.html" title="no_body"></head><body bgcolor="whi [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>makeurl</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="lremove.html" title="lremove"><link rel="next" href="no_body.html" title="no_body"></head><body bgcolor="white [...]
Create a self referencing URL from a filename. <span style="font-family:monospace"><span class="command"><strong>makeurl</strong></span></span>
can be used in three ways
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">With no arguments the current script URL is returned</li><li class="listitem">
diff --git a/rivet/manual3.2/no_body.html b/rivet/manual3.2/no_body.html
index e77f2c2..51cad84 100644
--- a/rivet/manual3.2/no_body.html
+++ b/rivet/manual3.2/no_body.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>no_body</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="makeurl.html" title="makeurl"><link rel="next" href="parray.html" title="parray"></head><body bgcolor="white [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>no_body</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="makeurl.html" title="makeurl"><link rel="next" href="parray.html" title="parray"></head><body bgcolor="white" [...]
This command is useful for situations where it is necessary
to only return HTTP headers and no actual content. For
instance, when returning a 304 redirect.
diff --git a/rivet/manual3.2/parray.html b/rivet/manual3.2/parray.html
index 5aa2fa1..3914cbe 100644
--- a/rivet/manual3.2/parray.html
+++ b/rivet/manual3.2/parray.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>parray</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="no_body.html" title="no_body"><link rel="next" href="parse.html" title="parse"></head><body bgcolor="white" t [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>parray</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="no_body.html" title="no_body"><link rel="next" href="parse.html" title="parse"></head><body bgcolor="white" tex [...]
An html version of the standard Tcl
<span style="font-family:monospace"><span class="command"><strong>parray</strong></span></span> command. Displays the entire
contents of an array in a sorted, nicely-formatted way.
diff --git a/rivet/manual3.2/parse.html b/rivet/manual3.2/parse.html
index ab085fe..4c4dd61 100644
--- a/rivet/manual3.2/parse.html
+++ b/rivet/manual3.2/parse.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>parse</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="parray.html" title="parray"><link rel="next" href="raw_post.html" title="raw_post"></head><body bgcolor="white [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>parse</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="parray.html" title="parray"><link rel="next" href="raw_post.html" title="raw_post"></head><body bgcolor="white" [...]
Like the Tcl <span style="font-family:monospace"><span class="command"><strong>source</strong></span></span> command, but also
parses for Rivet <? and ?> processing tags. Using
this command, you can use one .rvt file from another.
diff --git a/rivet/manual3.2/processing.html b/rivet/manual3.2/processing.html
index f903897..a700ba8 100644
--- a/rivet/manual3.2/processing.html
+++ b/rivet/manual3.2/processing.html
@@ -1,8 +1,8 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Apache Rivet HTTP Request Processing</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="directives.html" title="Apache Rivet 3.2 Configuration"><link rel="next" href="request.html" title [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Apache Rivet HTTP Request Processing</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="directives.html" title="Apache Rivet 3.2 Configuration"><link rel="next" href="request.html" title=" [...]
Until 2.x versions Rivet handled requests
following the vision that inspired the original design
- which was summarized in the definition <span style="color: red"><q>Web programming
- like in PHP, but with Tcl</q></span>. HTTP requests triggered the
+ which was summarized in the definition <span class="quote">“<span class="quote">Web programming
+ like in PHP, but with Tcl</span>”</span>. HTTP requests triggered the
execution of Tcl scripts or a Rivet (.rvt file) templates
whose path is encoded in the URI (an alias translation or
URL rewriting might occur to establish the real path).
@@ -95,7 +95,7 @@
<span style="font-family:monospace"><span class="command"><strong>::rivet::abort_page</strong></span></span>.
The current procedure might work as a template to be
reworked into your own request handler.
- </td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm612"></a>Example: basic OO Rivet Application</h3></div></div></div><p style="width:90%">
+ </td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm616"></a>Example: basic OO Rivet Application</h3></div></div></div><p style="width:90%">
An applications may have no interest in running
a script pointed by the URL as in the traditional approach
followed by rivet inspired to the PHP philosophy of <span class="quote">“<span class="quote">scripting
diff --git a/rivet/manual3.2/raw_post.html b/rivet/manual3.2/raw_post.html
index 410d588..54fa166 100644
--- a/rivet/manual3.2/raw_post.html
+++ b/rivet/manual3.2/raw_post.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>raw_post</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="parse.html" title="parse"><link rel="next" href="redirect.html" title="redirect"></head><body bgcolor="whit [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>raw_post</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="parse.html" title="parse"><link rel="next" href="redirect.html" title="redirect"></head><body bgcolor="white" [...]
Returns the raw POST data from the request. If the request was
not a POST or there is no data, then "" - an empty string - is returned.
</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="parse.html"><img src="images/prev.png" alt="Prev"></a> </td><td width="20%" align="center"><a accesskey="u" href="commands.html"><img src="images/up.png" alt="Up"></a></td><td width="40%" align="right"> <a accesskey="n" href="redirect.html"><img src="images/next.png" alt="Next"></a></td></tr><tr><td width="40%" align="left" valign="top">parse < [...]
diff --git a/rivet/manual3.2/read_file.html b/rivet/manual3.2/read_file.html
index 335b085..80ed42a 100644
--- a/rivet/manual3.2/read_file.html
+++ b/rivet/manual3.2/read_file.html
@@ -1,6 +1,6 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>read_file</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="redirect.html" title="redirect"><link rel="next" href="thread_id.html" title="thread_id"></head><body bgco [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>read_file</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="redirect.html" title="redirect"><link rel="next" href="thread_id.html" title="thread_id"></head><body bgcolo [...]
Read the entire contents of a file and return it as a string.
- </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::read_file</span> ?<span style="font-family:monospace; font-weight: bold;">file name</span>?</div></div></div><div class="refsect1"><a name="idm1606"></a><h2>Description</h2><p style="width:90%">
+ </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::read_file</span> ?<span style="font-family:monospace; font-weight: bold;">file name</span>?</div></div></div><div class="refsect1"><a name="idm1612"></a><h2>Description</h2><p style="width:90%">
This is a utility command which loads the entire content of
a file and returns it as a result.
</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="redirect.html"><img src="images/prev.png" alt="Prev"></a> </td><td width="20%" align="center"><a accesskey="u" href="commands.html"><img src="images/up.png" alt="Up"></a></td><td width="40%" align="right"> <a accesskey="n" href="thread_id.html"><img src="images/next.png" alt="Next"></a></td></tr><tr><td width="40%" align="left" valign="top" [...]
diff --git a/rivet/manual3.2/redirect.html b/rivet/manual3.2/redirect.html
index bc9a1b3..201b85d 100644
--- a/rivet/manual3.2/redirect.html
+++ b/rivet/manual3.2/redirect.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>redirect</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="raw_post.html" title="raw_post"><link rel="next" href="read_file.html" title="read_file"></head><body bgcol [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>redirect</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="raw_post.html" title="raw_post"><link rel="next" href="read_file.html" title="read_file"></head><body bgcolor [...]
<span style="font-family:monospace"><span class="command"><strong>::rivet::redirect</strong></span></span> diverts the browser to a new URL and marks
the redirection as either permanent in the browser local cache or
non permanent (default).
diff --git a/rivet/manual3.2/request.html b/rivet/manual3.2/request.html
index 8df747c..513fa4d 100644
--- a/rivet/manual3.2/request.html
+++ b/rivet/manual3.2/request.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Apache Child Processes Lifecycle and Request Processing</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="processing.html" title="Apache Rivet HTTP Request Processing"><link rel="next" [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Apache Child Processes Lifecycle and Request Processing</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="processing.html" title="Apache Rivet HTTP Request Processing"><link rel="next" hr [...]
Apache Rivet devolves to the <a class="ulink" href="" target="_top">Multi-Processing Module (MPM)</a>
the task of managing the agents responding to network requests.
An MPM is responsible for creating such agents during the start-up,
@@ -21,7 +21,7 @@
</p><p style="width:90%">
There are 4 stages in the lifetime of an Apache webserver that are relevant
to Rivet:
- </p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><h4><a name="idm649"></a>Server Initialization</h4><div style="margin-bottom:1.5ex ; padding .5ex">
+ </p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><h4><a name="idm653"></a>Server Initialization</h4><div style="margin-bottom:1.5ex ; padding .5ex">
Apaches starts up as a single process. During this stage Apache performs
various preliminary tasks including reading and parsing the configuration.
After the configuration has been read Rivet sets up some internal resources
@@ -42,7 +42,7 @@
in this context are IPC methods that must be initialized at this stage.
With the prefork MPM also importing from namespaces and loading packages
can be done here removing the burden from the child initialization stage.
- </div></li><li class="listitem"><h4><a name="idm655"></a>Child Process Initialization</h4><div style="margin-bottom:1.5ex ; padding .5ex">
+ </div></li><li class="listitem"><h4><a name="idm659"></a>Child Process Initialization</h4><div style="margin-bottom:1.5ex ; padding .5ex">
A child process calls the MPM bridge interface function to set up
the Tcl run time environment,either creating multiple threads each running its
Tcl interpreters or, in the case of the prefork MPM bridge, setting up
@@ -78,7 +78,7 @@
a single virtual host, therefore <span style="font-family:monospace"><span class="command"><strong>SeparateVirtualInterps</strong></span></span>
is ignored and you can't share the same interpreter among virtual host
</td></tr></table></div>
- </div></li><li class="listitem"><h4><a name="idm671"></a>Request Processing and Content Generation</h4><div style="margin-bottom:1.5ex ; padding .5ex">
+ </div></li><li class="listitem"><h4><a name="idm675"></a>Request Processing and Content Generation</h4><div style="margin-bottom:1.5ex ; padding .5ex">
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/note.png"></td><th align="left">Note</th></tr><tr><td align="left" valign="top">
This section explain the default request handling procedure which
was written to let Rivet 3.0 work as a drop in replacement
@@ -104,7 +104,7 @@
be running within the same "before" and "after" scripts to which
the programmer can devolve tasks common to every
page of an application.
- </div></li><li class="listitem"><h4><a name="idm681"></a>Child Process Exit</h4><div style="margin-bottom:1.5ex ; padding .5ex">
+ </div></li><li class="listitem"><h4><a name="idm685"></a>Child Process Exit</h4><div style="margin-bottom:1.5ex ; padding .5ex">
If no error condition forces the child process to a premature exit, his
life is determined by the Apache configuration parameters. To reduce
the effects of memory leaks in buggy applications the Apache webserver
@@ -122,7 +122,7 @@
to exit and be replaced by a new one when the workload demands it.
This operation implies the <span style="font-family:monospace"><span class="command"><strong>ChildExitScript</strong></span></span> be
run before the interpreter is actually deleted.
- </div></li></ol></div></div><div class="simplesect"><div class="titlepage"><div><div><h3 class="title"><a name="idm687"></a>Apache Rivet Error and Exception Scripts Directives</h3></div></div></div><p style="width:90%">
+ </div></li></ol></div></div><div class="simplesect"><div class="titlepage"><div><div><h3 class="title"><a name="idm691"></a>Apache Rivet Error and Exception Scripts Directives</h3></div></div></div><p style="width:90%">
Rivet is highly configurable and each of the webserver lifecycle stages
can be exploited to control a web application.
Not only the orderly sequence of stages
@@ -148,7 +148,7 @@
the abnormal condition. Starting with Rivet 2.1.0 <a class="xref" href="abort_page.html" title="abort_page">abort_page</a>
accepts a free form parameter that can be retrieved later with the command
<a class="xref" href="abort_code.html" title="abort_code">abort_code</a>
- </p></div><div class="simplesect"><div class="titlepage"><div><div><h3 class="title"><a name="idm697"></a>Tcl Namespaces in Rivet and the <span style="font-family:monospace"><span class="command"><strong>::request</strong></span></span> Namespace</h3></div></div></div><p style="width:90%">
+ </p></div><div class="simplesect"><div class="titlepage"><div><div><h3 class="title"><a name="idm701"></a>Tcl Namespaces in Rivet and the <span style="font-family:monospace"><span class="command"><strong>::request</strong></span></span> Namespace</h3></div></div></div><p style="width:90%">
</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/note.png"></td><th align="left">Note</th></tr><tr><td align="left" valign="top">
This section explain the default request handling procedure which
was written to let Rivet 3.0 work as a drop in replacement
diff --git a/rivet/manual3.2/session_package.html b/rivet/manual3.2/session_package.html
index cd3959d..2e937db 100644
--- a/rivet/manual3.2/session_package.html
+++ b/rivet/manual3.2/session_package.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Session Package</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="diodisplay_package.html" title="DIODisplay"><link rel="next" href="form.html" title="Form: An HTML Form Fields Generati [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Session Package</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="diodisplay_package.html" title="DIODisplay"><link rel="next" href="form.html" title="Form: An HTML Form Fields Generation [...]
This is session management code. It provides an interface
to allow you to generate and track a browser's visit as a
"session", giving you a unique session ID and an interface
@@ -25,13 +25,13 @@
All DB interfacing is done through DIO, though, so it
should be relatively easy to add support for other
databases.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm3285"></a>Preparing To Use It</h3></div></div></div><p style="width:90%">Create the tables in your SQL server. With Postgres,
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm3291"></a>Preparing To Use It</h3></div></div></div><p style="width:90%">Create the tables in your SQL server. With Postgres,
do a <span style="font-family:monospace"><span class="command"><strong>psql www</strong></span></span> or whatever DB you
connect as, then a backslash-i on
<code class="filename">session-create.sql</code></p><p style="width:90%">(If you need to delete the tables, use <code class="filename">session-drop.sql</code>)</p><p style="width:90%">The session code by default requires a DIO handle
called <code class="varname">DIO</code> (the name of which can be
overridden). We get it by doing a</p><pre class="programlisting">RivetServerConf ChildInitScript "package require DIO"
-RivetServerConf ChildInitScript "::DIO::handle Postgresql DIO -user www"</pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm3295"></a>Example Usage</h3></div></div></div><p style="width:90%">In your httpd.conf, add:</p><pre class="programlisting">RivetServerConf ChildInitScript "package require Session; Session SESSION"</pre><p style="width:90%">
+RivetServerConf ChildInitScript "::DIO::handle Postgresql DIO -user www"</pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm3301"></a>Example Usage</h3></div></div></div><p style="width:90%">In your httpd.conf, add:</p><pre class="programlisting">RivetServerConf ChildInitScript "package require Session; Session SESSION"</pre><p style="width:90%">
This tells Rivet you want to create a session object named
SESSION in every child process Apache creates.</p><p style="width:90%">
You can configure the session at this point using numerous
@@ -52,7 +52,7 @@ RivetServerConf ChildInitScript "::DIO::handle Postgresql DIO -user www"</pre></
additional requests are received during the session, all
under the control of the key-value pairs controlling the
session object.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm3307"></a>Using Sessions From Your Code</h3></div></div></div><p style="width:90%">The main methods your code will use are:</p><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spac [...]
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm3313"></a>Using Sessions From Your Code</h3></div></div></div><p style="width:90%">The main methods your code will use are:</p><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spac [...]
After doing a <span style="font-family:monospace"><span class="command"><strong>SESSION activate</strong></span></span>,
this will return a 32-byte ASCII-encoded random
hexadecimal string. Every time this browser comes
@@ -79,7 +79,7 @@ RivetServerConf ChildInitScript "::DIO::handle Postgresql DIO -user www"</pre></
none was set. (Status is set to the DIO error that
occurred, it can be fetched using the status
method.)
- </div></div></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm3353"></a>Session Configuration Options</h3></div></div></div><p style="width:90%">The following key-value pairs can be specified when a
+ </div></div></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm3359"></a>Session Configuration Options</h3></div></div></div><p style="width:90%">The following key-value pairs can be specified when a
session object (like SESSION above) is created:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">sessionLifetime</span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:1.5ex ; padding .5ex">how many seconds the session will live for.
7200 == 2 hours
</div></div></dd><dt><span class="term">sessionRefreshInterval</span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style="margin-bottom:1.5ex ; padding .5ex">
@@ -132,7 +132,7 @@ RivetServerConf ChildInitScript "::DIO::handle Postgresql DIO -user www"</pre></
file handle that debugging messages will be written
to (default
<code class="varname">stdout</code>)
- </div></div></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm3431"></a>Session Methods</h3></div></div></div><p style="width:90%">
+ </div></div></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm3437"></a>Session Methods</h3></div></div></div><p style="width:90%">
The following methods can be invoked to find out
information about the current session, store and fetch
server data identified with this session, etc:
@@ -171,7 +171,7 @@ RivetServerConf ChildInitScript "::DIO::handle Postgresql DIO -user www"</pre></
If they don't have one or it isn't valid (timed out,
etc), create a session and drop a cookie on
them.
- </div></div></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm3487"></a>Getting Additional Randomness From The Entropy File</h3></div></div></div><pre class="programlisting">RivetServerConf ChildInitScript "Session SESSION -entropyFile /dev/urandom \
+ </div></div></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm3493"></a>Getting Additional Randomness From The Entropy File</h3></div></div></div><pre class="programlisting">RivetServerConf ChildInitScript "Session SESSION -entropyFile /dev/urandom \
-entropyLength 10 -debugMode 1"</pre><p style="width:90%">
This options say we want to get randomness from an entropy
file (random data pseudo-device) of /dev/urandom, to get ten
diff --git a/rivet/manual3.2/shorthand.html b/rivet/manual3.2/shorthand.html
index 078ec19..3e786bb 100644
--- a/rivet/manual3.2/shorthand.html
+++ b/rivet/manual3.2/shorthand.html
@@ -1,6 +1,6 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title><?= ... ?></title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="next" href="abort_code.html" tit [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title><?= ... ?></title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="next" href="abort_code.html" title [...]
Shorthand construct for single strings output
- </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace"><?= <span style="font-family:monospace; font-weight: bold;">$string</span> ?></span> </div></div></div><div class="refsect1"><a name="idm772"></a><h2>Description</h2><p style="width:90%">
+ </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace"><?= <span style="font-family:monospace; font-weight: bold;">$string</span> ?></span> </div></div></div><div class="refsect1"><a name="idm776"></a><h2>Description</h2><p style="width:90%">
This construct is a simplified form to print a single string wherever
needed in a ?<span style="font-family:monospace; font-weight: bold;">.rvt</span>? template. The contruct is equivalent to
writing the following line of Tcl code
diff --git a/rivet/manual3.2/tcl_packages.html b/rivet/manual3.2/tcl_packages.html
index ea9a22a..c84a4c5 100644
--- a/rivet/manual3.2/tcl_packages.html
+++ b/rivet/manual3.2/tcl_packages.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Rivet Tcl Packages</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="examples.html" title="Examples and Usage"><link rel="next" href="dio.html" title="DIO - Database Interface Objects"> [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Rivet Tcl Packages</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="index.html" title="Apache Rivet 3.2"><link rel="prev" href="examples.html" title="Examples and Usage"><link rel="next" href="dio.html" title="DIO - Database Interface Objects"></ [...]
In addition to the core Apache module, Rivet provides a number
of Tcl packages that include potentially useful code.
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><div style="margin-bottom:1.5ex ; padding .5ex">dio is a database abstraction layer.</div></li><li class="listitem"><div style="margin-bottom:1.5ex ; padding .5ex">form - for creating forms.</div></li><li class="listitem"><div style="margin-bottom:1.5ex ; padding .5ex">calendar - a package providing a simple configurable calendar generator</div></li><li class="listitem"><div st [...]
diff --git a/rivet/manual3.2/thread_id.html b/rivet/manual3.2/thread_id.html
index a4ca216..b654065 100644
--- a/rivet/manual3.2/thread_id.html
+++ b/rivet/manual3.2/thread_id.html
@@ -1,8 +1,8 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>thread_id</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="read_file.html" title="read_file"><link rel="next" href="try.html" title="try"></head><body bgcolor="white [...]
- <span style="font-family:monospace"><span class="command"><strong>::rivet::threadid</strong></span></span> returns is either hexadecimal
- (default) or decimal representation the current thread id. This command
- is useful because allows for precise identification of an execution thread
- when Apache runs a threaded MPM. Calling the command with ?<span style="font-family:monospace; font-weight: bold;">-decimal</span>?
- prints the thread id in a form that makes it comparable with the <span style="font-family:monospace"><span class="command"><strong>tid</strong></span></span>
- information printed in the error log.
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>thread_id</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="read_file.html" title="read_file"><link rel="next" href="try.html" title="try"></head><body bgcolor="white" [...]
+ <span style="font-family:monospace"><span class="command"><strong>::rivet::threadid</strong></span></span> either returns the hexadecimal
+ (default) or the decimal representation of the current thread id. This command
+ is useful for precise identification of an execution thread
+ when Apache runs a threaded MPM. When called with the ?<span style="font-family:monospace; font-weight: bold;">-decimal</span>? switch the
+ command prints the thread id can be compared with the <span style="font-family:monospace"><span class="command"><strong>tid</strong></span></span>
+ information printed in the Apache error log.
</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="read_file.html"><img src="images/prev.png" alt="Prev"></a> </td><td width="20%" align="center"><a accesskey="u" href="commands.html"><img src="images/up.png" alt="Up"></a></td><td width="40%" align="right"> <a accesskey="n" href="try.html"><img src="images/next.png" alt="Next"></a></td></tr><tr><td width="40%" align="left" valign="top">read [...]
diff --git a/rivet/manual3.2/toglyphs.html b/rivet/manual3.2/toglyphs.html
index a6d194d..6994369 100644
--- a/rivet/manual3.2/toglyphs.html
+++ b/rivet/manual3.2/toglyphs.html
@@ -1,6 +1,6 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>toGlyphs</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="asciiglyphs.html" title="AsciiGlyphs"><link rel="prev" href="asciiglyphs.html" title="AsciiGlyphs"><link rel="next" href="formbroker.html" title="The Form Broker"></head><body bgcolor="w [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>toGlyphs</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="asciiglyphs.html" title="AsciiGlyphs"><link rel="prev" href="asciiglyphs.html" title="AsciiGlyphs"><link rel="next" href="formbroker.html" title="The Form Broker"></head><body bgcolor="whi [...]
print large ASCII glyphs
- </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::AsciiGlyphs toGlyphs</span> <span style="font-family:monospace; font-weight: bold;">string</span> </div></div></div><div class="refsect1"><a name="idm4215"></a><h2>Description</h2><p style="width:90%">
+ </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::AsciiGlyphs toGlyphs</span> <span style="font-family:monospace; font-weight: bold;">string</span> </div></div></div><div class="refsect1"><a name="idm4228"></a><h2>Description</h2><p style="width:90%">
prints the ASCII glyphs corresponding to the characters forming
the argument <span style="font-family:monospace; font-weight: bold;">string</span>
</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="asciiglyphs.html"><img src="images/prev.png" alt="Prev"></a> </td><td width="20%" align="center"><a accesskey="u" href="asciiglyphs.html"><img src="images/up.png" alt="Up"></a></td><td width="40%" align="right"> <a accesskey="n" href="formbroker.html"><img src="images/next.png" alt="Next"></a></td></tr><tr><td width="40%" align="le [...]
diff --git a/rivet/manual3.2/try.html b/rivet/manual3.2/try.html
index 3afc9cb..262bb97 100644
--- a/rivet/manual3.2/try.html
+++ b/rivet/manual3.2/try.html
@@ -1,6 +1,6 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>try</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="thread_id.html" title="thread_id"><link rel="next" href="unescape_string.html" title="unescape_string"></head><b [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>try</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="thread_id.html" title="thread_id"><link rel="next" href="unescape_string.html" title="unescape_string"></head><bod [...]
Catch error and exception conditions
- </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::try</span> ?<span style="font-family:monospace; font-weight: bold;">script</span>? ?<span style="font-family:monospace; font-weight: bold;">script</span>? ?<span style="font-family:monospace; font-weight: bold;"><em class [...]
+ </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::try</span> ?<span style="font-family:monospace; font-weight: bold;">script</span>? ?<span style="font-family:monospace; font-weight: bold;">script</span>? ?<span style="font-family:monospace; font-weight: bold;"><em class [...]
<span style="font-family:monospace"><span class="command"><strong>::rivet::try</strong></span></span> wraps the core language
command and simply traps exceptions that might have raised
by <span style="font-family:monospace"><span class="command"><strong>::rivet::abort_page</strong></span></span> and
diff --git a/rivet/manual3.2/unescape_string.html b/rivet/manual3.2/unescape_string.html
index 3f117ea..0e6ca3b 100644
--- a/rivet/manual3.2/unescape_string.html
+++ b/rivet/manual3.2/unescape_string.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>unescape_string</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="try.html" title="try"><link rel="next" href="upload.html" title="upload"></head><body bgcolor="white [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>unescape_string</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="try.html" title="try"><link rel="next" href="upload.html" title="upload"></head><body bgcolor="white" [...]
Scans through each character in the specified string looking
for escaped character sequences (characters containing a
percent sign and two hexadecimal characters), unescaping them
diff --git a/rivet/manual3.2/upload.html b/rivet/manual3.2/upload.html
index feb56a5..220f17f 100644
--- a/rivet/manual3.2/upload.html
+++ b/rivet/manual3.2/upload.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>upload</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="unescape_string.html" title="unescape_string"><link rel="next" href="url_script.html" title="url_script"></he [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>upload</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="unescape_string.html" title="unescape_string"><link rel="next" href="url_script.html" title="url_script"></head [...]
The upload command is for file upload manipulation.
See the relevant Apache Directives to further configure the
behavior of this Rivet feature.
diff --git a/rivet/manual3.2/url_script.html b/rivet/manual3.2/url_script.html
index 247773c..380bc01 100644
--- a/rivet/manual3.2/url_script.html
+++ b/rivet/manual3.2/url_script.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>url_script</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="upload.html" title="upload"><link rel="next" href="var.html" title="var"></head><body bgcolor="white" tex [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>url_script</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="upload.html" title="upload"><link rel="next" href="var.html" title="var"></head><body bgcolor="white" text= [...]
This command is used internally by the rivet central Tcl
procedure (::Rivet::request_handling) executed by
the default traditional code for HTTP requests processing.
diff --git a/rivet/manual3.2/var.html b/rivet/manual3.2/var.html
index b275932..d473b66 100644
--- a/rivet/manual3.2/var.html
+++ b/rivet/manual3.2/var.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>var</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="url_script.html" title="url_script"><link rel="next" href="wrap.html" title="wrap"></head><body bgcolor="white" [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>var</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="url_script.html" title="url_script"><link rel="next" href="wrap.html" title="wrap"></head><body bgcolor="white" te [...]
The <span style="font-family:monospace"><span class="command"><strong>var</strong></span></span> command retrieves information
about GET or POST variables sent to the script via client
request. It treats both GET and POST variables the same,
diff --git a/rivet/manual3.2/wrap.html b/rivet/manual3.2/wrap.html
index d134698..13d5a7e 100644
--- a/rivet/manual3.2/wrap.html
+++ b/rivet/manual3.2/wrap.html
@@ -1,6 +1,6 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>wrap</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="var.html" title="var"><link rel="next" href="wrapline.html" title="wrapline"></head><body bgcolor="white" text= [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>wrap</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="var.html" title="var"><link rel="next" href="wrapline.html" title="wrapline"></head><body bgcolor="white" text="b [...]
Split a string on newlines.
- </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::wrap</span> ?<span style="font-family:monospace; font-weight: bold;">string</span>? ?<span style="font-family:monospace; font-weight: bold;">maxlen</span>? <span style="font-family:monospace; font-weight: bold;">html</span [...]
+ </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::wrap</span> ?<span style="font-family:monospace; font-weight: bold;">string</span>? ?<span style="font-family:monospace; font-weight: bold;">maxlen</span>? <span style="font-family:monospace; font-weight: bold;">html</span [...]
For each line, wrap the line at a space character to be
equal to or shorter than the maximum length value passed.
</p><p style="width:90%">
diff --git a/rivet/manual3.2/wrapline.html b/rivet/manual3.2/wrapline.html
index 14b32b5..e9d7678 100644
--- a/rivet/manual3.2/wrapline.html
+++ b/rivet/manual3.2/wrapline.html
@@ -1,6 +1,6 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>wrapline</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="wrap.html" title="wrap"><link rel="next" href="xml.html" title="xml"></head><body bgcolor="white" text="bla [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>wrapline</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="wrap.html" title="wrap"><link rel="next" href="xml.html" title="xml"></head><body bgcolor="white" text="black [...]
Split the line into multiple lines by splitting on space characters
- </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::wrapline</span> ?<span style="font-family:monospace; font-weight: bold;">string</span>? ?<span style="font-family:monospace; font-weight: bold;">maxlen</span>? <span style="font-family:monospace; font-weight: bold;">html</ [...]
+ </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::wrapline</span> ?<span style="font-family:monospace; font-weight: bold;">string</span>? ?<span style="font-family:monospace; font-weight: bold;">maxlen</span>? <span style="font-family:monospace; font-weight: bold;">html</ [...]
Given a line and a maximum length and option "-html" argument, split the line
into multiple lines by splitting on space characters and making sure each line
is less than maximum length.
diff --git a/rivet/manual3.2/xml.html b/rivet/manual3.2/xml.html
index be94878..1c03b20 100644
--- a/rivet/manual3.2/xml.html
+++ b/rivet/manual3.2/xml.html
@@ -1,6 +1,6 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>xml</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="wrapline.html" title="wrapline"><link rel="next" href="examples.html" title="Examples and Usage"></head><body bg [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>xml</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="wrapline.html" title="wrapline"><link rel="next" href="examples.html" title="Examples and Usage"></head><body bgco [...]
XML Fragments creation
- </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::xml</span> ?<span style="font-family:monospace; font-weight: bold;">string</span>? ?<span style="font-family:monospace; font-weight: bold;">tag descriptor</span>? ?<span style="font-family:monospace; font-weight: [...]
+ </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::rivet::xml</span> ?<span style="font-family:monospace; font-weight: bold;">string</span>? ?<span style="font-family:monospace; font-weight: bold;">tag descriptor</span>? ?<span style="font-family:monospace; font-weight: [...]
Given a string and a variable number of tag descriptors return XML fragment made
by nesting the tags with the same hierarchical order they are listed on the command
line. The tag descriptors can be a one element list (the tag) or an odd-length list whose
diff --git a/rivet/manual3.2/xml_calendar.html b/rivet/manual3.2/xml_calendar.html
index 459d7e0..40d1b4f 100644
--- a/rivet/manual3.2/xml_calendar.html
+++ b/rivet/manual3.2/xml_calendar.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>XmlCalendar</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="calendar_package.html" title="Calendar Package"><link rel="prev" href="calendar.html" title="Calendar"><link rel="next" href="html_calendar.html" title="HtmlCalendar"></head><body bgc [...]
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>XmlCalendar</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.2"><link rel="up" href="calendar_package.html" title="Calendar Package"><link rel="prev" href="calendar.html" title="Calendar"><link rel="next" href="html_calendar.html" title="HtmlCalendar"></head><body bgcol [...]
An XmlCalendar object is created and returned. XmlCalendar objects
print XML formatted calendar tables. The markup can be customized
using the configuration options.
@@ -11,7 +11,7 @@
The first element of an option list is a tag name, the remaining terms are therefore
an even-length sublist which is interpreted as a sequence of attribute-value pairs that
will in turn become attributes of the tag.
- </p></div><div class="refsect1"><a name="idm4019"></a><h2>Methods</h2><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex ">
+ </p></div><div class="refsect1"><a name="idm4032"></a><h2>Methods</h2><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex ">
cal_obj <span style="font-weight:bold ; font-family:monospace">emit</span> -opt1 val1 -opt2 val2</div></div><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex ">
cal_obj <span style="font-weight:bold ; font-family:monospace">emit</span> ?<span style="font-family:monospace; font-weight: bold;">month</span>? ?<span style="font-family:monospace; font-weight: bold;">year</span>? -opt1 val1 -opt2 val2</div></div><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex ">
cal_obj <span style="font-weight:bold ; font-family:monospace">emit</span> ?<span style="font-family:monospace; font-weight: bold;">
@@ -19,7 +19,7 @@
-opt2 val2</div></div><div style="margin-bottom:1.5ex ; padding .5ex">
The method 'emit' if invoked without arguments returns an
XML calendar table of the current month
- </div></div></dd></dl></div></div><div class="refsect1"><a name="idm4038"></a><div class="refsect2"><a name="idm4039"></a><h3>Options</h3><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">-containe [...]
+ </div></div></dd></dl></div></div><div class="refsect1"><a name="idm4051"></a><div class="refsect2"><a name="idm4052"></a><h3>Options</h3><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">-containe [...]
attr11 val1 attr2 val2 ...)</span> </div></div><div style="margin-bottom:1.5ex ; padding .5ex">
Assigns an options list to the XML element that
will hold the whole table.
---------------------------------------------------------------------
To unsubscribe, e-mail: site-cvs-unsubscribe@tcl.apache.org
For additional commands, e-mail: site-cvs-help@tcl.apache.org