| <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Websh Reference 3.6.0b5</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"><link rel="home" href="index.html" title="Websh Reference 3.6.0b5"><link rel="next" href="configuration.html" title="Configuration"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Websh Reference 3.6.0b5</th></tr><tr><td width="20%" align="left"> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="configuration.html">Next</a></td></tr></table><hr></div><div lang="en" class="article" title="Websh Reference 3.6.0b5"><div class="titlepage"><div><div><h2 class="title"><a name="id2612088"></a>Websh Reference 3.6.0b5</h2></div><div><p class="releaseinfo"> | |
| $Id$ | |
| </p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="index.html#intro">Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="index.html#general_remarks">General remarks</a></span></dt><dt><span class="section"><a href="index.html#about">About this document</a></span></dt></dl></dd><dt><span class="section"><a href="configuration.html">Configuration</a></span></dt><dd><dl><dt><span class="section"><a href="configuration.html#web::config"><span style="font-family:monospace"><span class="command"><strong>web::config</strong></span></span></a></span></dt></dl></dd><dt><span class="section"><a href="command_dispatching_and_session_management.html">Command dispatching and session management</a></span></dt><dd><dl><dt><span class="section"><a href="command_dispatching_and_session_management.html#web::command"><span style="font-family:monospace"><span class="command"><strong>web::command</strong></span></span></a></span></dt><dt><span class="section"><a href="command_dispatching_and_session_management.html#web::getcommand"><span style="font-family:monospace"><span class="command"><strong>web::getcommand</strong></span></span></a></span></dt><dt><span class="section"><a href="command_dispatching_and_session_management.html#web::cmdurl"><span style="font-family:monospace"><span class="command"><strong>web::cmdurl</strong></span></span></a></span></dt><dt><span class="section"><a href="command_dispatching_and_session_management.html#web::cmdurlcfg"><span style="font-family:monospace"><span class="command"><strong>web::cmdurlcfg</strong></span></span></a></span></dt><dt><span class="section"><a href="command_dispatching_and_session_management.html#management_of_static_parameters">Management of static parameters</a></span></dt><dt><span class="section"><a href="command_dispatching_and_session_management.html#configuration_for_web_cmdurl">Configuration for <span style="font-family:monospace"><span class="command"><strong>web::cmdurl</strong></span></span></a></span></dt><dt><span class="section"><a href="command_dispatching_and_session_management.html#web::dispatch"><span style="font-family:monospace"><span class="command"><strong>web::dispatch</strong></span></span></a></span></dt><dt><span class="section"><a href="command_dispatching_and_session_management.html#session_management">Session management</a></span></dt></dl></dd><dt><span class="section"><a href="request_data_handling.html">Request data handling</a></span></dt><dd><dl><dt><span class="section"><a href="request_data_handling.html#web::request"><span style="font-family:monospace"><span class="command"><strong>web::request</strong></span></span></a></span></dt><dt><span class="section"><a href="request_data_handling.html#web::param"><span style="font-family:monospace"><span class="command"><strong>web::param</strong></span></span></a></span></dt><dt><span class="section"><a href="request_data_handling.html#web::formvar"><span style="font-family:monospace"><span class="command"><strong>web::formvar</strong></span></span></a></span></dt></dl></dd><dt><span class="section"><a href="response_data_handling.html">Response data handling</a></span></dt><dd><dl><dt><span class="section"><a href="response_data_handling.html#web::response"><span style="font-family:monospace"><span class="command"><strong>web::response</strong></span></span></a></span></dt><dt><span class="section"><a href="response_data_handling.html#web::put"><span style="font-family:monospace"><span class="command"><strong>web::put</strong></span></span></a></span></dt><dt><span class="section"><a href="response_data_handling.html#web::putx"><span style="font-family:monospace"><span class="command"><strong>web::putx</strong></span></span></a></span></dt><dt><span class="section"><a href="response_data_handling.html#web::putxfile"><span style="font-family:monospace"><span class="command"><strong>web::putxfile</strong></span></span></a></span></dt></dl></dd><dt><span class="section"><a href="logging.html">Logging</a></span></dt><dd><dl><dt><span class="section"><a href="logging.html#web::logdest"><span style="font-family:monospace"><span class="command"><strong>web::logdest</strong></span></span></a></span></dt><dt><span class="section"><a href="logging.html#web::loglevel"><span style="font-family:monospace"><span class="command"><strong>web::loglevel</strong></span></span></a></span></dt><dt><span class="section"><a href="logging.html#web::log"><span style="font-family:monospace"><span class="command"><strong>web::log</strong></span></span></a></span></dt><dt><span class="section"><a href="logging.html#log_plug-ins">Log plug-ins</a></span></dt></dl></dd><dt><span class="section"><a href="context_handling.html">Context handling</a></span></dt><dd><dl><dt><span class="section"><a href="context_handling.html#web::context"><span style="font-family:monospace"><span class="command"><strong>web::context</strong></span></span></a></span></dt><dt><span class="section"><a href="context_handling.html#web::filecontext"><span style="font-family:monospace"><span class="command"><strong>web::filecontext</strong></span></span></a></span></dt><dt><span class="section"><a href="context_handling.html#web::cookiecontext"><span style="font-family:monospace"><span class="command"><strong>web::cookiecontext</strong></span></span></a></span></dt><dt><span class="section"><a href="context_handling.html#web::filecounter"><span style="font-family:monospace"><span class="command"><strong>web::filecounter</strong></span></span></a></span></dt></dl></dd><dt><span class="section"><a href="file_handling_and_file_IO.html">File handling and file I/O</a></span></dt><dd><dl><dt><span class="section"><a href="file_handling_and_file_IO.html#web::include"><span style="font-family:monospace"><span class="command"><strong>web::include</strong></span></span></a></span></dt><dt><span class="section"><a href="file_handling_and_file_IO.html#web::readfile"><span style="font-family:monospace"><span class="command"><strong>web::readfile</strong></span></span></a></span></dt><dt><span class="section"><a href="file_handling_and_file_IO.html#web::lockfile_and_web::unlockfile"><span style="font-family:monospace"><span class="command"><strong>web::lockfile</strong></span></span> and <span style="font-family:monospace"><span class="command"><strong>web::unlockfile</strong></span></span></a></span></dt><dt><span class="section"><a href="file_handling_and_file_IO.html#web::truncatefile"><span style="font-family:monospace"><span class="command"><strong>web::truncatefile</strong></span></span></a></span></dt></dl></dd><dt><span class="section"><a href="data_encryption.html">Data encryption</a></span></dt><dd><dl><dt><span class="section"><a href="data_encryption.html#web::encrypt"><span style="font-family:monospace"><span class="command"><strong>web::encrypt</strong></span></span></a></span></dt><dt><span class="section"><a href="data_encryption.html#web::decrypt"><span style="font-family:monospace"><span class="command"><strong>web::decrypt</strong></span></span></a></span></dt><dt><span class="section"><a href="data_encryption.html#encryption_plug-in_D">Encryption plug-in D</a></span></dt><dt><span class="section"><a href="data_encryption.html#web::encryptd"><span style="font-family:monospace"><span class="command"><strong>web::encryptd</strong></span></span></a></span></dt><dt><span class="section"><a href="data_encryption.html#web::decryptd"><span style="font-family:monospace"><span class="command"><strong>web::decryptd</strong></span></span></a></span></dt><dt><span class="section"><a href="data_encryption.html#web::cryptdkey"><span style="font-family:monospace"><span class="command"><strong>web::cryptdkey</strong></span></span></a></span></dt><dt><span class="section"><a href="data_encryption.html#encryption_plug-in_interface_">Encryption plug-in interface</a></span></dt></dl></dd><dt><span class="section"><a href="uri-html-_en-decoding.html">Uri-/html- en-/decoding</a></span></dt><dd><dl><dt><span class="section"><a href="uri-html-_en-decoding.html#web::htmlify"><span style="font-family:monospace"><span class="command"><strong>web::htmlify</strong></span></span></a></span></dt><dt><span class="section"><a href="uri-html-_en-decoding.html#web::dehtmlify"><span style="font-family:monospace"><span class="command"><strong>web::dehtmlify</strong></span></span></a></span></dt><dt><span class="section"><a href="uri-html-_en-decoding.html#web::uriencode"><span style="font-family:monospace"><span class="command"><strong>web::uriencode</strong></span></span></a></span></dt><dt><span class="section"><a href="uri-html-_en-decoding.html#web::uridecode"><span style="font-family:monospace"><span class="command"><strong>web::uridecode</strong></span></span></a></span></dt></dl></dd><dt><span class="section"><a href="inter-process_and_-system_communication.html">Inter-process/-system communication</a></span></dt><dd><dl><dt><span class="section"><a href="inter-process_and_-system_communication.html#web::send"><span style="font-family:monospace"><span class="command"><strong>web::send</strong></span></span></a></span></dt><dt><span class="section"><a href="inter-process_and_-system_communication.html#web::recv"><span style="font-family:monospace"><span class="command"><strong>web::recv</strong></span></span></a></span></dt><dt><span class="section"><a href="inter-process_and_-system_communication.html#web::msgflag"><span style="font-family:monospace"><span class="command"><strong>web::msgflag</strong></span></span></a></span></dt></dl></dd><dt><span class="section"><a href="apache_module_specific_commands.html">Apache module specific commands</a></span></dt><dd><dl><dt><span class="section"><a href="apache_module_specific_commands.html#web::initializer"><span style="font-family:monospace"><span class="command"><strong>web::initializer</strong></span></span></a></span></dt><dt><span class="section"><a href="apache_module_specific_commands.html#web::finalizer"><span style="font-family:monospace"><span class="command"><strong>web::finalizer</strong></span></span></a></span></dt><dt><span class="section"><a href="apache_module_specific_commands.html#web::finalize"><span style="font-family:monospace"><span class="command"><strong>web::finalize</strong></span></span></a></span></dt><dt><span class="section"><a href="apache_module_specific_commands.html#web::maineval"><span style="font-family:monospace"><span class="command"><strong>web::maineval</strong></span></span></a></span></dt><dt><span class="section"><a href="apache_module_specific_commands.html#web::interpclasscfg"><span style="font-family:monospace"><span class="command"><strong>web::interpclasscfg</strong></span></span></a></span></dt><dt><span class="section"><a href="apache_module_specific_commands.html#web::interpcfg"><span style="font-family:monospace"><span class="command"><strong>web::interpcfg</strong></span></span></a></span></dt><dt><span class="section"><a href="apache_module_specific_commands.html#web::interpmap"><span style="font-family:monospace"><span class="command"><strong>web::interpmap</strong></span></span></a></span></dt></dl></dd><dt><span class="section"><a href="misc_commands.html">Miscellaneous commands</a></span></dt><dd><dl><dt><span class="section"><a href="misc_commands.html#web::match"><span style="font-family:monospace"><span class="command"><strong>web::match</strong></span></span></a></span></dt><dt><span class="section"><a href="misc_commands.html#web::tempfile"><span style="font-family:monospace"><span class="command"><strong>web::tempfile</strong></span></span></a></span></dt></dl></dd></dl></div><div class="section" title="Introduction"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="intro"></a>Introduction</h2></div></div></div><div class="section" title="General remarks"><div class="titlepage"><div><div><h3 class="title"><a name="general_remarks"></a>General remarks</h3></div></div></div><p style="width:90%"> | |
| Websh 3.6 (pronounced "web shell") embeds a Tcl interpreter, | |
| (version 8.3 or higher) and all Tcl commands are available. | |
| </p><p style="width:90%"> | |
| Typically, Websh commands have the following syntax: | |
| </p><div class="cmdsynopsis"><span style="background:#bbbbff"><span style="font-weight:bold"><code class="command">web::acommand</code></span> ?options? ?subcommands? ?arguments?</span></div><p style="width:90%"> | |
| Options start with a dash ("-"). As usual, dash-dash | |
| ("--") indicates the | |
| "end-of-options". Thus, | |
| </p><pre style="background:#bbffbb ; width:75%" class="programlisting">web::acommand -o1 a1 -- -o2</pre><p style="width:90%"> | |
| takes "-o2" as the first argument. | |
| </p><p style="width:90%"> | |
| Instead of the normal Tcl behaviour, Websh configuration | |
| commands normally return the previous value when a new value | |
| is set. | |
| </p><p style="width:90%"> | |
| In addition to the examples given here, you might find <a class="ulink" href="http://tcl.apache.org/websh/examples/" target="_top">http://tcl.apache.org/websh/examples/</a> | |
| a useful source of information. | |
| </p></div><div class="section" title="About this document"><div class="titlepage"><div><div><h3 class="title"><a name="about"></a>About this document</h3></div></div></div><p style="width:90%"> | |
| The original version of this document can always be found at | |
| <a class="ulink" href="http://tcl.apache.org/websh/download/" target="_top">http://tcl.apache.org/websh/download/</a>. | |
| </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p style="width:90%"> | |
| We try to keep this quick reference up-to-date and hope that | |
| it will be useful. We do not guarantee that it is suitable for | |
| any particular purpose whatsoever. The authors accept no | |
| liability with regards to this information or its use. | |
| </p></div></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="configuration.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"> </td><td width="40%" align="right" valign="top"> Configuration</td></tr></table></div></body></html> |