mdw@git.distorted.org.uk Git - qmail/blob - tcp-environ.5

   1 .TH tcp-environ 5
   2 .SH NAME
   3 tcp-environ \- TCP-related environment variables
   4 .SH DESCRIPTION
   5 The following environment variables
   6 describe a TCP connection.
   7 They are set up by
   8 .BR tcp-env ,
   9 .BR tcpclient ,
  10 and
  11 .BR tcpserver .
  12 Note that
  13 .BR TCPLOCALHOST ,
  14 .BR TCPREMOTEHOST ,
  15 and
  16 .B TCPREMOTEINFO
  17 can contain arbitrary characters.
  18 .TP 5
  19 PROTO
  20 The string
  21 .BR TCP .
  22 .TP 5
  23 TCPLOCALHOST
  24 The domain name of the local host,
  25 with uppercase letters converted to lowercase.
  26 If there is no currently available domain name
  27 for the local IP address,
  28 .B TCPLOCALHOST
  29 is not set.
  30 .TP 5
  31 TCPLOCALIP
  32 The IP address of the local host, in dotted-decimal form.
  33 .TP 5
  34 TCPLOCALPORT
  35 The local TCP port number, in decimal.
  36 .TP 5
  37 TCPREMOTEHOST
  38 The domain name of the remote host,
  39 with uppercase letters converted to lowercase.
  40 If there is no currently available domain name
  41 for the remote IP address,
  42 .B TCPREMOTEHOST
  43 is not set.
  44 .TP 5
  45 TCPREMOTEINFO
  46 A connection-specific string, perhaps a username,
  47 supplied by the remote host
  48 via 931/1413/IDENT/TAP.
  49 If the remote host did not supply connection information,
  50 .B TCPREMOTEINFO
  51 is not set.
  52 .TP 5
  53 TCPREMOTEIP
  54 The IP address of the remote host.
  55 .TP 5
  56 TCPREMOTEPORT
  57 The remote TCP port number.
  58 .SH "SEE ALSO"
  59 tcpclient(1),
  60 tcpserver(1),
  61 tcp-env(1),
  62 tcp(4)