summaryrefslogtreecommitdiff
path: root/tcp-env.1
diff options
context:
space:
mode:
authorJohn Denker <jsd@av8n.com>2012-06-01 18:58:45 -0700
committerJohn Denker <jsd@av8n.com>2012-06-01 18:58:45 -0700
commitb732a73bc773789894466b0e5320b2f1fe42c7e9 (patch)
tree385358983f064a1f10a5080b33a3ba13010886db /tcp-env.1
parent634d365a03cb0581a062cd3cf4db9ae69f1cde26 (diff)
original, as downloaded from http://www.qmail.org/netqmail-1.06.tar.gz
Diffstat (limited to 'tcp-env.1')
-rw-r--r--tcp-env.167
1 files changed, 67 insertions, 0 deletions
diff --git a/tcp-env.1 b/tcp-env.1
new file mode 100644
index 0000000..edd46f2
--- /dev/null
+++ b/tcp-env.1
@@ -0,0 +1,67 @@
+.TH tcp-env 1
+.SH NAME
+tcp-env \- set up TCP-related environment variables
+.SH SYNOPSIS
+.B tcp-env
+[
+.B \-rR
+]
+[
+.B \-t\fItimeout
+]
+.I program
+[
+.I arg ...
+]
+.SH DESCRIPTION
+The input for
+.B tcp-env
+must be a TCP connection.
+.B tcp-env
+finds out information about that connection,
+puts the information into several environment variables
+as described in
+.B tcp-environ(5),
+and runs
+.I program
+with the given arguments.
+
+Usually
+.B tcp-env
+is run from
+.BR inetd .
+It might instead be run from another server
+that already sets up the right environment variables;
+if
+.B PROTO
+is set to
+.B TCP
+when
+.B tcp-env
+is invoked,
+.B tcp-env
+assumes that all the other variables are set up properly,
+and it does not check whether the input is a TCP connection.
+.SH OPTIONS
+.TP
+.B \-r
+(Default.)
+Attempt to obtain
+.B TCPREMOTEINFO
+from the remote host.
+.TP
+.B \-R
+Do not attempt to obtain
+.B TCPREMOTEINFO
+from the remote host.
+.TP
+.B \-t\fItimeout
+Give up on the
+.B TCPREMOTEINFO
+connection attempt after
+.I timeout
+seconds.
+Default: 30.
+.SH "SEE ALSO"
+tcp-environ(5),
+inetd(8)