Merge pull request #135 from lexis-project/environmentVariables

Document environment variables in globus-url-copy manpage fixes #112
gridcf · Sep 10, 2020 · 7a3088f · 7a3088f
2 parents 7947b8f + b89e90c
commit 7a3088f
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 2 deletions.
diff --git a/gass/copy/source/globus-url-copy.1 b/gass/copy/source/globus-url-copy.1
@@ -2,12 +2,12 @@
 .\"     Title: globus-url-copy
 .\"    Author: [see the "AUTHOR" section]
 .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\"      Date: 07/25/2019
+.\"      Date: 09/08/2020
 .\"    Manual: Grid Community Toolkit Manual
 .\"    Source: Grid Community Toolkit 6
 .\"  Language: English
 .\"
-.TH "GLOBUS\-URL\-COPY" "1" "07/25/2019" "Grid Community Toolkit 6" "Grid Community Toolkit Manual"
+.TH "GLOBUS\-URL\-COPY" "1" "09/08/2020" "Grid Community Toolkit 6" "Grid Community Toolkit Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -467,6 +467,29 @@ Perform a checksum on the source and destination after each file transfer and co
 \fB\-checksum\-alg\fR
 parameter\&.
 .RE
+.SH "ENVIRONMENT"
+.sp
+The following environment variables are recognized:
+.PP
+\fBGLOBUS_HOSTNAME\fR
+.RS 4
+Overrides client hostname communicated to the server
+.RE
+.PP
+\fBGLOBUS_DOMAIN_NAME\fR
+.RS 4
+Overrides client domainname communicated to the server
+.RE
+.PP
+\fBGLOBUS_FTP_CLIENT_DATA_IP\fR
+.RS 4
+Overwrites client IP address communicated to the server for the data connection\&. Used when the receiver is behind a NAT and should be configured to the external address of its gateway\&.
+.RE
+.PP
+\fBGLOBUS_FTP_CLIENT_SOURCE_PASV\fR
+.RS 4
+Configures sender side (source) instead of receiver side (destination) to open a data port and establishes the data connection from the receiver to the sender\&. By default the data connection is established from sender to receiver, but if the receiver is behind a NAT this doesn\(cqt work, because the receiver will communicate its own address instead of the external address of its gateway to the sender and its own address can\(cqt be reached directly from the sender\&.
+.RE
 .SH "AUTHOR"
 .sp
 Copyright \(co 1999\-2016 University of Chicago
diff --git a/gass/copy/source/globus-url-copy.txt b/gass/copy/source/globus-url-copy.txt
@@ -322,6 +322,30 @@ to a server that does not support data channel encryption (e.g. dCache)!
     transfer.  The default algorithm used for this checksum is MD5, but 
     other algorithms can be specified with the *-checksum-alg* parameter.
 
+[[globus-url-copy-ENVIRONMENT]]
+ENVIRONMENT
+-----------
+The following environment variables are recognized:
+
+*GLOBUS_HOSTNAME*::
+    Overrides client hostname communicated to the server
+
+*GLOBUS_DOMAIN_NAME*::
+    Overrides client domainname communicated to the server
+
+*GLOBUS_FTP_CLIENT_DATA_IP*::
+    Overwrites client IP address communicated to the server for the data
+    connection. Used when the receiver is behind a NAT and should be configured
+    to the external address of its gateway.
+
+*GLOBUS_FTP_CLIENT_SOURCE_PASV*::
+    Configures sender side (source) instead of receiver side (destination) to
+    open a data port and establishes the data connection from the receiver to
+    the sender. By default the data connection is established from sender to
+    receiver, but if the receiver is behind a NAT this doesn't work, because
+    the receiver will communicate its own address instead of the external
+    address of its gateway to the sender and its own address can't be reached
+    directly from the sender.
 
 [[globus-url-copy-AUTHOR]]
 AUTHOR