.\" Copyright (c) 2003-2012
.\" Distributed Systems Software.  All rights reserved.
.\" See the file LICENSE for redistribution information.
.\" $Id: copyright-nr 2564 2012-03-02 00:17:08Z brachman $
'\" t
.\"     Title: dacs_prenv
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 08/23/2020
.\"    Manual: DACS Web Services Manual
.\"    Source: DACS 1.4.40
.\"  Language: English
.\"
.TH "DACS_PRENV" "8" "08/23/2020" "DACS 1.4.40" "DACS Web Services Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
dacs_prenv \- CGI program that displays its environment
.SH "SYNOPSIS"
.HP \w'\fBdacs_prenv\fR\ 'u
\fBdacs_prenv\fR [\fB\-html\fR]
.SH "DESCRIPTION"
.PP
This program is part of the
\fBDACS\fR
suite\&. It is a stand\-alone program that neither accepts the usual
\fBDACS\fR
command line options (\fIdacsoptions\fR) nor accesses any
\fBDACS\fR
configuration files\&.
.PP
This CGI utility simply prints its command line arguments, all environment variables, information about the system on which it is running, and CGI parameters and their values\&. It can be a useful tool when debugging web services\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBTip\fR
.ps -1
.br
.PP
This program can be a useful tool for debugging web services\&. Replace a call to your web service with an identical call to
\fBdacs_prenv\fR
to see what arguments your web service is being passed and (to some extent) other context\&.
.sp .5v
.RE
.SH "OPTIONS"
.PP
\fBdacs_prenv\fR
recognizes these command line flags:
.PP
\fB\-html\fR
.RS 4
Selects HTML output (text/html) instead of the default
Content\-Type
of
text/plain, by default, using the style sheet
\m[blue]\fBdacs_prenv\&.css\fR\m[]\&\s-2\u[1]\d\s+2\&.
.RE
.SS "Web Service Arguments"
.PP
When used as a web service, the following parameters are recognized:
.PP
\fIFORMAT\fR
.RS 4
At present, the only recognized value for this argument is
HTML\&.
.RE
.PP
\fIjust_dump_stdin\fR
.RS 4
If the value of
\fBQUERY_STRING\fR
is exactly
jump_dump_stdin, then the program will simply copy its standard input to the standard output as
text/plain\&.
.RE
.SH "FILES"
.PP
\m[blue]\fBdacs_prenv\&.css\fR\m[]\&\s-2\u[1]\d\s+2
.SH "DIAGNOSTICS"
.PP
The program exits
0
if everything was fine,
1
if an error occurred\&.
.SH "BUGS"
.PP
It should be possible to request XML output\&.
.SH "SEE ALSO"
.PP
\m[blue]\fBcgiparse(8)\fR\m[]\&\s-2\u[2]\d\s+2,
\m[blue]\fBenv(1)\fR\m[]\&\s-2\u[3]\d\s+2,
\m[blue]\fBprintenv(1)\fR\m[]\&\s-2\u[4]\d\s+2,
\m[blue]\fBenviron(7)\fR\m[]\&\s-2\u[5]\d\s+2
.SH "AUTHOR"
.PP
Distributed Systems Software (\m[blue]\fBwww\&.dss\&.ca\fR\m[]\&\s-2\u[6]\d\s+2)
.SH "COPYING"
.PP
Copyright \(co 2003\-2018 Distributed Systems Software\&. See the
\m[blue]\fBLICENSE\fR\m[]\&\s-2\u[7]\d\s+2
file that accompanies the distribution for licensing information\&.
.SH "NOTES"
.IP " 1." 4
dacs_prenv.css
.RS 4
\%http://dacs.dss.ca/man//css/dacs_prenv.css
.RE
.IP " 2." 4
cgiparse(8)
.RS 4
\%http://dacs.dss.ca/man/cgiparse.8.html
.RE
.IP " 3." 4
env(1)
.RS 4
\%https://www.freebsd.org/cgi/man.cgi?query=env&apropos=0&sektion=1&manpath=FreeBSD+10.3-RELEASE&format=html
.RE
.IP " 4." 4
printenv(1)
.RS 4
\%https://www.freebsd.org/cgi/man.cgi?query=printenv&apropos=0&sektion=1&manpath=FreeBSD+10.3-RELEASE&format=html
.RE
.IP " 5." 4
environ(7)
.RS 4
\%https://www.freebsd.org/cgi/man.cgi?query=environ&apropos=0&sektion=7&manpath=FreeBSD+10.3-RELEASE&format=html
.RE
.IP " 6." 4
www.dss.ca
.RS 4
\%http://www.dss.ca
.RE
.IP " 7." 4
LICENSE
.RS 4
\%http://dacs.dss.ca/man/../misc/LICENSE
.RE