Websh Reference 3.6.0b5

$Id: index.html 1096822 2011-04-26 17:50:13Z ronnie $


Table of Contents

Introduction
General remarks
About this document
Configuration
web::config
Command dispatching and session management
web::command
web::getcommand
web::cmdurl
web::cmdurlcfg
Management of static parameters
Configuration for web::cmdurl
web::dispatch
Session management
Request data handling
web::request
web::param
web::formvar
Response data handling
web::response
web::put
web::putx
web::putxfile
Logging
web::logdest
web::loglevel
web::log
Log plug-ins
Context handling
web::context
web::filecontext
web::cookiecontext
web::filecounter
File handling and file I/O
web::include
web::readfile
web::lockfile and web::unlockfile
web::truncatefile
Data encryption
web::encrypt
web::decrypt
Encryption plug-in D
web::encryptd
web::decryptd
web::cryptdkey
Encryption plug-in interface
Uri-/html- en-/decoding
web::htmlify
web::dehtmlify
web::uriencode
web::uridecode
Inter-process/-system communication
web::send
web::recv
web::msgflag
Apache module specific commands
web::initializer
web::finalizer
web::finalize
web::maineval
web::interpclasscfg
web::interpcfg
web::interpmap
Miscellaneous commands
web::match
web::tempfile

Introduction

General remarks

Websh 3.6 (pronounced "web shell") embeds a Tcl interpreter, (version 8.3 or higher) and all Tcl commands are available.

Typically, Websh commands have the following syntax:

web::acommand ?options? ?subcommands? ?arguments?

Options start with a dash ("-"). As usual, dash-dash ("--") indicates the "end-of-options". Thus,

web::acommand -o1 a1 -- -o2

takes "-o2" as the first argument.

Instead of the normal Tcl behaviour, Websh configuration commands normally return the previous value when a new value is set.

In addition to the examples given here, you might find http://tcl.apache.org/websh/examples/ a useful source of information.

About this document

The original version of this document can always be found at http://tcl.apache.org/websh/download/.

Note

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.