~ubuntu-branches/ubuntu/saucy/globus-gass-copy/saucy

« back to all changes in this revision

Viewing changes to debian/globus-url-copy.1

  • Committer: Package Import Robot
  • Author(s): Mattias Ellert
  • Date: 2011-10-02 12:17:14 UTC
  • Revision ID: package-import@ubuntu.com-20111002121714-px332b49clk67433
Tags: 5.14-3
Add contributed man page (Closes: #630456)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
'\" t
 
2
.\"     Title: globus-url-copy
 
3
.\"    Author: 
 
4
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
 
5
.\"      Date: 08/11/2011
 
6
.\"    Manual: Globus Tookit
 
7
.\"    Source: The Globus Alliance
 
8
.\"  Language: English
 
9
.\"
 
10
.TH "GLOBUS\-URL\-COPY" "1" "08/11/2011" "The Globus Alliance" "Globus Tookit"
 
11
.\" -----------------------------------------------------------------
 
12
.\" * Define some portability stuff
 
13
.\" -----------------------------------------------------------------
 
14
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
15
.\" http://bugs.debian.org/507673
 
16
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
 
17
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
18
.ie \n(.g .ds Aq \(aq
 
19
.el       .ds Aq '
 
20
.\" -----------------------------------------------------------------
 
21
.\" * set default formatting
 
22
.\" -----------------------------------------------------------------
 
23
.\" disable hyphenation
 
24
.nh
 
25
.\" disable justification (adjust text to left margin only)
 
26
.ad l
 
27
.\" -----------------------------------------------------------------
 
28
.\" * MAIN CONTENT STARTS HERE *
 
29
.\" -----------------------------------------------------------------
 
30
.SH "NAME"
 
31
globus-url-copy \- globus\-url\-copy
 
32
.SH "SYNOPSIS"
 
33
.HP \w'\fB/usr/bin/globus\-url\-copy\fR\ 'u
 
34
\fB/usr/bin/globus\-url\-copy\fR [\fBoptions\fR]
 
35
.SH "DESCRIPTION"
 
36
.PP
 
37
globus\-url\-copy is a scriptable command line tool that can do multi\-protocol data movement\&. It supports gsiftp:// (GridFTP), ftp://, http://, https://, and file:/// protocol specifiers in the URL\&. For GridFTP, globus\-url\-copy supports all implemented functionality\&. Versions from GT 3\&.2 and later support file globbing and directory moves\&.
 
38
.SH "OPTIONS"
 
39
.PP
 
40
\fB\-help | \-usage\fR
 
41
.RS 4
 
42
Print help\&.
 
43
.RE
 
44
.PP
 
45
\fB\-versions\fR
 
46
.RS 4
 
47
Print the versions of all modules that this program uses
 
48
.RE
 
49
.PP
 
50
\fB\-c | \-continue\-on\-error\fR
 
51
.RS 4
 
52
Do not die after any errors\&. By default, program will exit after most errors\&.
 
53
.RE
 
54
.PP
 
55
\fB\-a | \-ascii\fR
 
56
.RS 4
 
57
Convert the file to/from ASCII format to/from local file format
 
58
.RE
 
59
.PP
 
60
\fB\-b | \-binary\fR
 
61
.RS 4
 
62
Do not apply any conversion to the files\&. *default*
 
63
.RE
 
64
.PP
 
65
\fB\-f filename\fR
 
66
.RS 4
 
67
Read a list of url pairs from filename\&. Each line should contain sourceURL destURL\&. Enclose URLs with spaces in double qoutes (")\&. Blank lines and lines beginning with # will be ignored\&.
 
68
.RE
 
69
.PP
 
70
\fB\-cd | \-create\-dest\fR
 
71
.RS 4
 
72
Create destination directory if needed\&.
 
73
.RE
 
74
.PP
 
75
\fB\-r\fR
 
76
.RS 4
 
77
Copy files in subdirectories
 
78
.RE
 
79
.PP
 
80
\fB\-fast\fR
 
81
.RS 4
 
82
Recommended when using GridFTP servers\&. Use MODE E for all data transfers, including reusing data channels between list and transfer operations\&.
 
83
.RE
 
84
.PP
 
85
\fB\-t transfer time in seconds\fR
 
86
.RS 4
 
87
Run the transfer for this number of seconds and then end\&. Useful for performance testing or forced restart loops\&.
 
88
.RE
 
89
.PP
 
90
\fB\-q | \-quiet\fR
 
91
.RS 4
 
92
Suppress all output for successful operation
 
93
.RE
 
94
.PP
 
95
\fB\-v | \-verbose\fR
 
96
.RS 4
 
97
Display urls being transferred
 
98
.RE
 
99
.PP
 
100
\fB\-vb | \-verbose\-perf\fR
 
101
.RS 4
 
102
During the transfer, display the number of bytes transferred and the transfer rate per second\&. Show urls being transferred
 
103
.RE
 
104
.PP
 
105
\fB\-dbg | \-debugftp\fR
 
106
.RS 4
 
107
Debug ftp connections\&. Prints control channel communication to stderr
 
108
.RE
 
109
.PP
 
110
\fB\-rst | \-restart\fR
 
111
.RS 4
 
112
Restart failed ftp operations\&.
 
113
.RE
 
114
.PP
 
115
\fB\-rst\-retries retries\fR
 
116
.RS 4
 
117
The maximum number of times to retry the operation before giving up on the transfer\&. Use 0 for infinite\&. Default is 5\&.
 
118
.RE
 
119
.PP
 
120
\fB\-rst\-interval seconds\fR
 
121
.RS 4
 
122
The interval in seconds to wait after a failure before retrying the transfer\&. Use 0 for an exponential backoff\&. Default is 0\&.
 
123
.RE
 
124
.PP
 
125
\fB\-rst\-timeout seconds\fR
 
126
.RS 4
 
127
Maximum time after a failure to keep retrying\&. Use 0 for no timeout\&. Default is 0\&.
 
128
.RE
 
129
.PP
 
130
\fB\-stall\-timeout | \-st seconds\fR
 
131
.RS 4
 
132
How long before cancelling/restarting a transfer with no data movement\&. Set to 0 to disable\&. Default is 600 seconds\&.
 
133
.RE
 
134
.PP
 
135
\fB\-df filename | \-dumpfile filename\fR
 
136
.RS 4
 
137
Path to file where untransferred urls will be saved for later restarting\&. Resulting file is the same format as the \-f input file\&. If file exists, it will be read and all other url input will be ignored\&.
 
138
.RE
 
139
.PP
 
140
\fB\-do filename | \-dump\-only filename\fR
 
141
.RS 4
 
142
Perform no write operations on the destination\&. Instead, all files that would be transferred are enumerated and dumped to the specified file\&. Resulting file is the same format as the \-f input file\&. Note: if you intend to use this file as input for a future transfer, the \-create\-dest option will be required if any destination directories do not already exist\&.
 
143
.RE
 
144
.PP
 
145
\fB\-rp | \-relative\-paths\fR
 
146
.RS 4
 
147
The path portion of ftp urls will be interpereted as relative to the user\*(Aqs starting directory on the server\&. By default, all paths are root\-relative\&. When this flag is set, the path portion of the ftp url must start with %2F if it designates a root\-relative path\&.
 
148
.RE
 
149
.PP
 
150
\fB\-s subject | \-subject subject\fR
 
151
.RS 4
 
152
Use this subject to match with both the source and dest servers
 
153
.RE
 
154
.PP
 
155
\fB\-ss subject | \-source\-subject subject\fR
 
156
.RS 4
 
157
Use this subject to match with the source server
 
158
.RE
 
159
.PP
 
160
\fB\-ds subject | \-dest\-subject subject\fR
 
161
.RS 4
 
162
Use this subject to match with the destionation server
 
163
.RE
 
164
.PP
 
165
\fB\-tcp\-bs size | \-tcp\-buffer\-size size\fR
 
166
.RS 4
 
167
Specify the size (in bytes) of the buffer to be used by the underlying ftp data channels\&.
 
168
.RE
 
169
.PP
 
170
\fB\-bs block size | \-block\-size block size\fR
 
171
.RS 4
 
172
Specify the size (in bytes) of the buffer to be used by the underlying transfer methods
 
173
.RE
 
174
.PP
 
175
\fB\-p parallelism | \-parallel parallelism\fR
 
176
.RS 4
 
177
Specify the number of parallel data connections should be used\&.
 
178
.RE
 
179
.PP
 
180
\fB\-notpt | \-no\-third\-party\-transfers\fR
 
181
.RS 4
 
182
Turn third\-party transfers off (on by default)\&.
 
183
.RE
 
184
.PP
 
185
\fB\-nodcau | \-no\-data\-channel\-authentication\fR
 
186
.RS 4
 
187
Turn off data channel authentication for ftp transfers\&.
 
188
.RE
 
189
.PP
 
190
\fB\-dcsafe | \-data\-channel\-safe\fR
 
191
.RS 4
 
192
Set data channel protection mode to SAFE
 
193
.RE
 
194
.PP
 
195
\fB\-dcpriv | \-data\-channel\-private\fR
 
196
.RS 4
 
197
Set data channel protection mode to PRIVATE
 
198
.RE
 
199
.PP
 
200
\fB\-off | \-partial\-offset\fR
 
201
.RS 4
 
202
Offset for partial ftp file transfers, defaults to 0
 
203
.RE
 
204
.PP
 
205
\fB\-len | \-partial\-length\fR
 
206
.RS 4
 
207
Length for partial ftp file transfers, used only for the source url, defaults the full file\&.
 
208
.RE
 
209
.PP
 
210
\fB\-\-list url to list\fR
 
211
.RS 4
 
212
.RE
 
213
.PP
 
214
\fB\-stripe\fR
 
215
.RS 4
 
216
Enable striped transfers on supported servers
 
217
.RE
 
218
.PP
 
219
\fB\-striped\-block\-size | \-sbs\fR
 
220
.RS 4
 
221
Set layout mode and blocksize for striped transfers\&. If not set, server defaults will be used\&. If set to 0, Partitioned mode will be used\&. If set to >0, Blocked mode will be used, with this as the blocksize\&.
 
222
.RE
 
223
.PP
 
224
\fB\-ipv6\fR
 
225
.RS 4
 
226
Use ipv6 when available (EXPERIMENTAL)
 
227
.RE
 
228
.PP
 
229
\fB\-udt\fR
 
230
.RS 4
 
231
Use UDT, a reliable udp based transport protocol, for data transfers
 
232
.RE
 
233
.PP
 
234
\fB\-g2 | \-gridftp2\fR
 
235
.RS 4
 
236
Use GridFTP v2 protocol enhancements when possible
 
237
.RE
 
238
.PP
 
239
\fB\-dp | \-delayed\-pasv\fR
 
240
.RS 4
 
241
Enable delayed passive
 
242
.RE
 
243
.PP
 
244
\fB\-mn | \-module\-name gridftp storage module name\fR
 
245
.RS 4
 
246
Set the backend storage module to use for both the source and destination in a GridFTP transfer
 
247
.RE
 
248
.PP
 
249
\fB\-mp | \-module\-parameters gridftp storage module parameters\fR
 
250
.RS 4
 
251
Set the backend storage module arguments to use for both the source and destination in a GridFTP transfer
 
252
.RE
 
253
.PP
 
254
\fB\-smn | \-src\-module\-name gridftp storage module name\fR
 
255
.RS 4
 
256
Set the backend storage module to use for the source in a GridFTP transfer
 
257
.RE
 
258
.PP
 
259
\fB\-smp | \-src\-module\-parameters gridftp storage module parameters\fR
 
260
.RS 4
 
261
Set the backend storage module arguments to use for the source in a GridFTP transfer
 
262
.RE
 
263
.PP
 
264
\fB\-dmn | \-dst\-module\-name gridftp storage module name\fR
 
265
.RS 4
 
266
Set the backend storage module to use for the destination in a GridFTP transfer
 
267
.RE
 
268
.PP
 
269
\fB\-dmp | \-dst\-module\-parameters gridftp storage module parameters\fR
 
270
.RS 4
 
271
Set the backend storage module arguments to use for the destination in a GridFTP transfer
 
272
.RE
 
273
.PP
 
274
\fB\-aa | \-authz\-assert authorization assertion file\fR
 
275
.RS 4
 
276
Use the assertions in this file to authorize the access with both source and dest servers
 
277
.RE
 
278
.PP
 
279
\fB\-saa | \-src\-authz\-assert authorization assertion file\fR
 
280
.RS 4
 
281
Use the assertions in this file to authorize the access with source server
 
282
.RE
 
283
.PP
 
284
\fB\-daa | \-dst\-authz\-assert authorization assertion file\fR
 
285
.RS 4
 
286
Use the assertions in this file to authorize the access with dest server
 
287
.RE
 
288
.PP
 
289
\fB\-cache\-aa | \-cache\-authz\-assert\fR
 
290
.RS 4
 
291
Cache the authz assertion for subsequent transfers
 
292
.RE
 
293
.PP
 
294
\fB\-cache\-saa | \-cache\-src\-authz\-assert\fR
 
295
.RS 4
 
296
Cache the src authz assertion for subsequent transfers
 
297
.RE
 
298
.PP
 
299
\fB\-cache\-daa | \-cache\-dst\-authz\-assert\fR
 
300
.RS 4
 
301
Cache the dst authz assertion for subsequent transfers
 
302
.RE
 
303
.PP
 
304
\fB\-pipeline | \-pp\fR
 
305
.RS 4
 
306
Enable pipelining support for multi\-file ftp transfers\&. Currently third\-party transfers benefit from this\&. *EXPERIMENTAL*
 
307
.RE
 
308
.PP
 
309
\fB\-concurrency | \-cc\fR
 
310
.RS 4
 
311
Number of concurrent ftp connections to use for multiple transfers\&.
 
312
.RE
 
313
.PP
 
314
\fB\-nl\-bottleneck | \-nlb\fR
 
315
.RS 4
 
316
Use NetLogger to estimate speeds of disk and network read/write system calls, and attempt to determine the bottleneck component
 
317
.RE
 
318
.PP
 
319
\fB\-src\-pipe | \-SP command line\fR
 
320
.RS 4
 
321
Set the source end of a remote transfer to use piped in input with the given command line\&. Do not use with \-fsstack
 
322
.RE
 
323
.PP
 
324
\fB\-dst\-pipe | \-DP command line\fR
 
325
.RS 4
 
326
Set the destination end of a remote transfer to write data to then standard input of the program run via the given command line\&. Do not use with \-fsstack
 
327
.RE
 
328
.PP
 
329
\fB\-pipe command line\fR
 
330
.RS 4
 
331
Sets both \-src\-pipe and \-dst\-pipe to the same thing\&.
 
332
.RE
 
333
.PP
 
334
\fB\-dcstack | \-data\-channel\-stack\fR
 
335
.RS 4
 
336
Set the XIO driver stack for the network on both the source and the destination\&. Both must be GridFTP servers\&.
 
337
.RE
 
338
.PP
 
339
\fB\-fsstack | \-file\-system\-stack\fR
 
340
.RS 4
 
341
Set the XIO driver stack for the disk on both the source and the destination\&. Both must be GridFTP servers\&.
 
342
.RE
 
343
.PP
 
344
\fB\-src\-dcstack | \-source\-data\-channel\-stack\fR
 
345
.RS 4
 
346
Set the XIO driver stack for the network on the source GridFTP server\&.
 
347
.RE
 
348
.PP
 
349
\fB\-src\-fsstack | \-source\-file\-system\-stack\&.\fR
 
350
.RS 4
 
351
Set the XIO driver stack for the disk on the source GridFTP server\&.
 
352
.RE
 
353
.PP
 
354
\fB\-dst\-dcstack | \-dest\-data\-channel\-stack\fR
 
355
.RS 4
 
356
Set the XIO driver stack for the network on the destination GridFTP server\&.
 
357
.RE
 
358
.PP
 
359
\fB\-dst\-fsstack | \-dest\-file\-system\-stack\fR
 
360
.RS 4
 
361
Set the XIO driver stack for the disk on the destination GridFTP server\&.
 
362
.RE
 
363
.PP
 
364
\fB\-cred path to credentials or proxy file\fR
 
365
.RS 4
 
366
Set the credentials to use for both ftp connections\&.
 
367
.RE
 
368
.PP
 
369
\fB\-src\-cred | \-sc path to credentials or proxy file\fR
 
370
.RS 4
 
371
Set the credentials to use for source ftp connections\&.
 
372
.RE
 
373
.PP
 
374
\fB\-dst\-cred | \-dc path to credentials or proxy file\fR
 
375
.RS 4
 
376
Set the credentials to use for destination ftp connections\&.
 
377
.RE
 
378
.PP
 
379
\fB\-af filename | \-alias\-file filename\fR
 
380
.RS 4
 
381
File with mapping of logical host aliases to lists of physical hosts\&. When used with multiple conncurrent connections, each connection uses the next host in the list\&. Each line should either be an alias, noted with the @ symbol, or a hostname[:port]\&. Currently, only the aliases @source and @destination are valid, and they are used for every source or destination url\&.
 
382
.RE
 
383
.PP
 
384
\fB\-sync\fR
 
385
.RS 4
 
386
Only transfer files where the destination does not exist or differs from the source\&. \-sync\-level controls how to determine if files differ\&.
 
387
.RE
 
388
.PP
 
389
\fB\-sync\-level number\fR
 
390
.RS 4
 
391
Choose critera for determining if files differ when performing a sync transfer\&. Level 0 will only transfer if the destination does not exist\&. Level 1 will transfer if the size of the destination does not match the size of the source\&. Level 2 will transfer if the timestamp of the destination is older than the timestamp of the source\&. Level 3 will perform a checksum of the source and destination and transfer if the checksums do not match\&. The default sync level is 2\&.
 
392
.RE
 
393
.SH "AUTHOR"
 
394
.br
 
395
.br
 
396
The Globus Alliance, http://www\&.globus\&.org/
 
397
.RS 4
 
398
Author.
 
399
.RE
 
400
.SH "COPYRIGHT"
 
401
.br
 
402
Copyright \(co 1999-2010 University of Chicago
 
403
.br