|NAntContrib Help Task Reference <scp>||v0.92-rc1|
[This is preliminary documentation and subject to change.]
Copies a file to a remote server using scp.
Copies a file using scp to a remote server.
The Username Environment variable is used.
|file||string||The file to transfer.||True|
|server||string||The server to send the file to.||True|
|basedir||directory||The directory in which the command will be executed.||False|
|options||string||The command line arguments.||False|
|path||string||The path on the remote server. The default is "~".||False|
|program||string||The program to execute. The default is "scp".||False|
|program-path-sep||string||The path separator used by the program. The default is "/".||False|
|user||string|| The username to connect as. The default is the value of the
|failonerror||bool||Determines if task failure stops the build, or is just reported. The default is true.||False|
|if||bool||If true then the task will be executed; otherwise, skipped. The default is true.||False|
|timeout||int||The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out.||False|
|unless||bool|| Opposite of
|verbose||bool||Determines whether the task should report detailed build log messages. The default is false.||False|
|exename||string||The name of the executable that should be used to launch the external program.||False|
|managed||ManagedExecution||Specifies whether the external program should be treated as a managed application, possibly forcing it to be executed under the currently targeted version of the CLR.||False|
|useruntimeengine||bool||Deprecated. Specifies whether the external program is a managed application which should be executed using a runtime engine, if configured. The default is false.||False|
Represents a command-line argument.
When passed to an external application, the argument will be quoted when appropriate. This does not apply to the
line parameter, which is always passed as is.
|dir||directory||The value for a directory-based command-line argument; will be replaced with the absolute path of the directory.||False|
|file||file||The name of a file as a single command-line argument; will be replaced with the absolute filename of the file.||False|
|if||bool||Indicates if the argument should be passed to the external program. If true then the argument will be passed; otherwise, skipped. The default is true.||False|
|line||string||List of command-line arguments; will be passed to the executable as is.||False|
|path||<path>|| The value for a PATH-like command-line argument; you can use ||False|
|unless||bool||Indicates if the argument should not be passed to the external program. If false then the argument will be passed; otherwise, skipped. The default is false.||False|
|value||string||A single command-line argument; can contain space characters.||False|
A single command-line argument containing a space character.
<arg value="-l -a" />
Two separate command-line arguments.
<arg line="-l -a" />
A single command-line argument with the value
\dir;\dir2;\dir3 on DOS-based systems and
/dir:/dir2:/dir3 on Unix-like systems.
<arg path="/dir;/dir2:\dir3" />
Copy a single file to a remote server and path.
<scp file="myfile.zip" server="myServer" path="~" />