'\"
'\" The contents of this file are subject to the AOLserver Public License
'\" Version 1.1 (the "License"); you may not use this file except in
'\" compliance with the License. You may obtain a copy of the License at
'\" http://aolserver.com/.
'\"
'\" Software distributed under the License is distributed on an "AS IS"
'\" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
'\" the License for the specific language governing rights and limitations
'\" under the License.
'\"
'\" The Original Code is AOLserver Code and related documentation
'\" distributed by AOL.
'\" 
'\" The Initial Developer of the Original Code is America Online,
'\" Inc. Portions created by AOL are Copyright (C) 1999 America Online,
'\" Inc. All Rights Reserved.
'\"
'\" Alternatively, the contents of this file may be used under the terms
'\" of the GNU General Public License (the "GPL"), in which case the
'\" provisions of GPL are applicable instead of those above.  If you wish
'\" to allow use of your version of this file only under the terms of the
'\" GPL and not to allow others to use your version of this file under the
'\" License, indicate your decision by deleting the provisions above and
'\" replace them with the notice and other provisions required by the GPL.
'\" If you do not delete the provisions above, a recipient may use your
'\" version of this file under either the License or the GPL.
'\" 
'\"
'\" $Header: /cvsroot/aolserver/aolserver/doc/ns_adp_ctl.n,v 1.1 2006/04/13 19:07:12 jgdavidson Exp $
'\"
'\" 
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",
'\"	or "in/out" to describe whether procedure reads or modifies arg,
'\"	and indent is equivalent to second arg of .IP (shouldn't ever be
'\"	needed;  use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\"	Give maximum sizes of arguments for setting tab stops.  Type and
'\"	name are examples of largest possible arguments that will be passed
'\"	to .AP later.  If args are omitted, default tab stops are used.
'\"
'\" .BS
'\"	Start box enclosure.  From here until next .BE, everything will be
'\"	enclosed in one large box.
'\"
'\" .BE
'\"	End of box enclosure.
'\"
'\" .CS
'\"	Begin code excerpt.
'\"
'\" .CE
'\"	End code excerpt.
'\"
'\" .VS ?version? ?br?
'\"	Begin vertical sidebar, for use in marking newly-changed parts
'\"	of man pages.  The first argument is ignored and used for recording
'\"	the version when the .VS was added, so that the sidebars can be
'\"	found and removed when they reach a certain age.  If another argument
'\"	is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\"	End of vertical sidebar.
'\"
'\" .DS
'\"	Begin an indented unfilled display.
'\"
'\" .DE
'\"	End of indented unfilled display.
'\"
'\" .SO
'\"	Start of list of standard options for a Tk widget.  The
'\"	options follow on successive lines, in four columns separated
'\"	by tabs.
'\"
'\" .SE
'\"	End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\"	Start of description of a specific option.  cmdName gives the
'\"	option's name as specified in the class command, dbName gives
'\"	the option's name in the option database, and dbClass gives
'\"	the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\"	Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: man.macros,v 1.1 2006/06/26 00:29:11 jgdavidson Exp $
'\"
'\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
'\"	# Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1	\\fI\\$2\\fP	(\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1	\\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
'\"	# define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
'\"	# BS - start boxed text
'\"	# ^y = starting y location
'\"	# ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
'\"	# BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"	Draw four-sided box normally, but don't draw top of
.\"	box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
'\"	# VS - start vertical sidebar
'\"	# ^Y = starting y location
'\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
'\"	# VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
'\"	# Special macro to handle page bottom:  finish off current
'\"	# box/sidebar if in box/sidebar mode, then invoked standard
'\"	# page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"	Draw three-sided box if this is the box's first page,
.\"	draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
'\"	# DS - begin display
.de DS
.RS
.nf
.sp
..
'\"	# DE - end display
.de DE
.fi
.RE
.sp
..
'\"	# SO - start of list of standard options
.de SO
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 5.5c 11c
.ft B
..
'\"	# SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\fBoptions\\fR manual entry for details on the standard options.
..
'\"	# OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name:	\\fB\\$1\\fR
Database Name:	\\fB\\$2\\fR
Database Class:	\\fB\\$3\\fR
.fi
.IP
..
'\"	# CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
'\"	# CE - end code excerpt
.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH ns_adp_ctl 3aolserver 4.5 AOLserver "AOLserver Built-In Commands"
.BS
'\" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
ns_adp_ctl \- ADP control command
.SH SYNOPSIS
.nf
\fBns_adp_ctl bufsize\fR \fI?size?\fR
\fBns_adp_ctl chan\fR \fIchannel\fR
\fBns_adp_ctl autoabort\fR \fI?bool?\fR
\fBns_adp_ctl detailerror\fR \fI?bool?\fR
\fBns_adp_ctl displayerror\fR \fI?bool?\fR
\fBns_adp_ctl expire\fR \fI?bool?\fR
\fBns_adp_ctl gzip\fR \fI?bool?\fR
\fBns_adp_ctl nocache\fR \fI?bool?\fR
\fBns_adp_ctl safe\fR \fI?bool?\fR
\fBns_adp_ctl singlescript\fR \fI?bool?\fR
\fBns_adp_ctl stricterror\fR \fI?bool?\fR
\fBns_adp_ctl trace\fR \fI?bool?\fR
\fBns_adp_ctl trimspace\fR \fI?bool?\fR
.fi
.BE

.SH DESCRIPTION
This command enables control of the current ADP execution environment.
Aside from the \fIbufsize\fR and \fIchan\fR subcommands, they all
return a boolean value for a given ADP option.  If the \fIbool\fR
argument is given, the option is set to the given value and the
previous value is returned.

.TP
\fBns_adp_ctl bufsize\fR \fI?size?\fR
This command returns the currently ADP output buffer size, setting
it to a new value if the optionial \fIsize\fR argument is specified.

.TP
\fBns_adp_ctl chan\fR \fIchannel\fR
This command is used to specify an open file channel to receive
output when the buffer is flushed. If \fIchannel\fR is the null
string, the output channel is cleared.  This capability can be
useful for specialized uses of ADP outside the context of an HTTP
connection, e.g., for debugging or testing.

.TP
\fBns_adp_ctl autoabort\fR \fI?bool?\fR
Query or set the \fIautoabort\fR option.  When enabled, failure to
flush a buffer (normally the result of a closed HTTP connection)
generates an ADP exception, unwinding the ADP call stack.

.TP
\fBns_adp_ctl detailerror\fR \fI?bool?\fR
Query or set the \fIdetailerror\fR option.  When enabled, errors
in ADP pages are formatted with information about the context of
the HTTP request.  This can be very helpful in debugging ADP errors
but potentially a security risk if the HTTP context (e.g., cookie
headers) contains personal or sensitive data.  Errors are logged
to the server log and, if \fIdisplayerror\fR is enabled, appened
to the output buffer.

.TP
\fBns_adp_ctl displayerror\fR \fI?bool?\fR
Query or set the \fIdisplayerror\fR option.  When enabled, errors
in ADP pages are formatted and appended to the output stream,
normally visiable to a user's browser.  This option should generally
be enabled in development and disabled in production.

.TP
\fBns_adp_ctl expire\fR \fI?bool?\fR
Query or set the \fIexpire\fR option.  When enabled, the ADP request
processing code adds an "Expires: now" header in the response buffer
to disable any caching.  In practice, more thoughtful cache control
mechanisms should be used based on the HTTP/1.1 spec.

.TP
\fBns_adp_ctl gzip\fR \fI?bool?\fR
Query or set the \fIgzip\fR option.  When enabled, the output buffer
is compressed before being returned in the response.  As ADP's are
generally used to generate text data such as HTML or XML, compression
is normally quite successful at reducing the response size.

.TP
\fBns_adp_ctl nocache\fR \fI?bool?\fR
Query or set the \fInocache\fR option.  When enabled, all requests
to cache executed ADP blocks via the \fBns_adp_include -cache\fR
directive are ignored, resulting in normal execution of all code.

.TP
\fBns_adp_ctl safe\fR \fI?bool?\fR
Query or set the \fIsafe\fR option. When enabled, all code is
executed in "safe" mode, disabling and ignoring any code within <%
... %> tags and only allowing execution of previously defined
registered tags.

.TP
\fBns_adp_ctl singlescript\fR \fI?bool?\fR
Query or set the \fIsinglescript\fR option.  When enabled, ADP pages
are converted from independent text-script blocks into a single
script, which text blocks replaced with a call to \fBns_adp_append\fR
with the given text.  Functionally the output is the same however
an error anywhere on the page will result in the entire ADP page
returning instead of skipping to the next block which is the normal
behavior. In practice, \fIsinglescript\fR is useful in development
while in production leaving it disabled provides a more defensive
execution environment where minor errors in one ADP do not inhibit
execution of the overall page.

.TP
\fBns_adp_ctl stricterror\fR \fI?bool?\fR
Query or set the \fIstricterror\fR option.  When enabled, the result
is similar to that of \fIsinglescript\fR in that an error in a
particular block will return the entire page instead of continuing
to the next text or script block.

.TP
\fBns_adp_ctl trace\fR \fI?bool?\fR
Query or set the \fItrace\fR option which currently does nothing.

.TP
\fBns_adp_ctl trimspace\fR \fI?bool?\fR
Query or set the \fItrimspace\fR option.  When enabled, any white
space at the start of the output buffer is eliminated.  White space
can show up in the output as a result of ADP pages which do nothing
but include other ADP's in a way to reuse code with the unfortunate
side effect of the training newline at the end of a "<% ns_adp_include
myfile.adp %>" ending up in the output stream.

.SH "SEE ALSO"
ns_adp(n), ns_adp_flush(n), ns_adp_close(n), ns_adp_mimetype(n)

.SH KEYWORDS
ADP, dynamic pages, buffer