xrdcopy(1) - Linux man page
Name
xrdcopy - copy files
Synopsis
xrdcopy [options] source destination options: [--cksum args] [--debug lvl] [--coerce] [--force] [--help] [--license] [--nopbar] [--posc] [--proxy ipaddr:port] [--recursive] [--retry time] [--server] [--silent] [--sources num] [--streams num] [--tpc] [--verbose] [--version] [--xrate rate] legacy options: [-adler] [-DSparm string] [-DIparm number] [-md5] [-np] [-ODcgi] [-OScgi] [-x]
Description
The xrdcopy utility copies one or more files from one location to another. The data source and destination may be a local or remote file or directory. Additionally, the data source may also reside on multiple servers.
Options
{-C | --cksum} type[:{value|print}]
- obtains the checksum of type (i.e. adler32, crc32, or md5) from the source, computes the checksum at the destination, and verifies that they are the same. If a value is specified, it is used as the source checksum. When print is specified, the checksum at the destination is printed but is not verified.
- {-d | --debug} lvl
- debug level: 1 (low), 2 (medium), 3 (high)
- {-F | --coerce}
- ignores locking semantics on the destination file. This option may lead to file corruption if not properly used.
- {-f | --force}
- re-creates a file if it is already present.
- {-h | --help}
- displays usage information.
- {-H | --license}
- displays license terms and conditions.
- {-N | --nopbar}
- does not display the progress bar.
- {-P | --posc}
- requests POSC (persist-on-successful-close) processing to create a new file. Files are automatically deleted should they not be successfully closed.
- {-D | --proxy} proxyaddr:proxyport
- use proxyaddr:proxyport as a SOCKS4 proxy. Only numerical addresses are supported.
- {-r | --recursive}
- recursively copy all files starting at the given source directory. This option is only supported for local files.
- --server
- runs as if in a server environment. Used only for server-side third party copy support.
- {-s | --silent}
- neither produces summary information nor displays the progress bar.
- {-y | --sources} num
- uses up to num sources to copy the file.
- {-S | --streams} num
- uses num additional parallel streams to do the transfer. The maximum value is 15. The default is 0 (i.e., use only the main stream).
- --tpc
- copies the file from remote server to remote server using third-party-copy protocol (i.e., data flows from server to server). The source and destination servers must support third party copies. Additional security restrictions may apply and may cause the copy to fail if they cannot be satisfied.
- {-v | --verbose}
- displays summary output.
- {-V | -version}
- displays version information and immediately exits.
- {-X | --xrate} rate
- limits the copy speed to the specified rate. The rate may be qualified with the letter k, m, or g to indicate kilo, mega, or giga bytes, respectively. The option only applies when the source or destination is local.
Legacy Options
Legacy options are provided for backward compatability. These are now deprecated and should be avoided.
--adler
- equivalent to "--cksum adler32:print".
- -DIpname numberval
- set the internal parameter pname with the numeric value numberval.
- -DSpname stringval
- set the internal parameter pname with the string value stringval.
- -md5
- equivalent to "--cksum md5:print".
- -np
- equivalent to "--nopbar".
- -ODcgi
- add cgi information cgi to any destination xrootd URL. You should specify the opaque information directly on the destination URL.
- -OScgi
- add cgi information cgi to any source xrootd URL.
- -x
- equivalent to "--sources 12".
Operands
source
- a local file, a local directory name suffixed by /, or an xrootd URL in the form of
xroot://[user@]host[:port]/absolutepath
The absolutepath can be a directory.
- destination
- a dash (i.e. -) indicating stanard out, a local file, a local directory name suffixed by /, or an xrootd URL in the form
xroot://[user@]host[:port]/absolutepath
The absolutepath can be a directory.
Environment
The following environment variables are supported.
XRD_LOGLEVEL
- Detemines the amout of diagnostics that should be printed. Valid values are: Dump, Debug, Info, Warning, and Error.
- XRD_LOGFILE
- If set, the diagnostics will be printed to the specified file instead of stderr.
- XRD_LOGMASK
- Determines which diagnostics topics should be printed at all levels. It's a "|" separated list of topics. The first element may be "All" in which case all
the topics are enabled and the subsequent elements may turn them off, or "None" in which case all the topics are disabled and the subsequent flags may turn
them on. If the topic name is prefixed with "^", then it means that the topic should be disabled. If the topic name is not prefixed, then it means that the
topic should be enabled.
The log mask may as well be handled for each diagnostic level separately by setting one or more of the following variables: XRD_LOGMASK_ERROR, XRD_LOGMASK_WARNING, XRD_LOGMASK_INFO, XRD_LOGMASK_DEBUG, and XRD_LOGMASK_DUMP. The default for each level is "All", except for the Dump level, where the default is "All|^PollerMsg". This means that, at the Dump level, all the topics but "PollerMsg" are enabled.
Available topics: AppMsg, UtilityMsg, FileMsg, PollerMsg, PostMasterMsg, XRootDTransportMsg, TaskMgrMsg, XRootDMsg, FileSystemMsg, AsyncSockMsg
- XRD_CONNECTIONWINDOW
- A time window for the connection establishment. A connection failure is declared if the connection is not established within the time window. If a connection failure happens earlier then another connection attempt will only be made at the beginning of the next window.
- XRD_CONNECTIONRETRY
- Number of connection attempts that should be made (number of available connection windows) before declaring a permanent failure.
- XRD_REQUESTTIMEOUT
- Default value for the time after which an error is declared if it was impossible to get a response to a request.
- XRD_SUBSTREAMSPERCHANNEL
- Number of streams per session.
- XRD_TIMEOUTRESOLUTION
- Resolution for the timeout events. Ie. timeout events will be processed only every XRD_TIMEOUTRESOLUTION seconds.
- XRD_STREAMERRORWINDOW
- Time after which the permanent failure flags are cleared out and a new connection may be attempted if needed.
- XRD_RUNFORKHANDLER
- Determines whether the fork handlers should be enabled, making the API fork safe.
- XRD_REDIRECTLIMIT
- Maximum number of allowed redirections.
- XRD_POLLERPREFERENCE
- A comma separated list of poller implementations in order of preference. The default is: libevent,built-in.
- XRD_CLIENTMONITOR
- Path to the client monitor library.
- XRD_CLIENTMONITORPARAM
- Additional optional parameters that will be passed to the monitoring object on initialization.
Notes
Documentation for all components associated with xrdcopy can be found at http://xrootd.org/docs.html
Diagnostics
Errors yield an error message and a non-zero exit status.
License
LGPL
Support Level
The xrdcopy command is supported by the xrootd collaboration. Contact information can be found at:
http://xrootd.org/contact.html