Differences
This shows you the differences between the selected revisions of the page.
| scriptcommand_put 2017-09-02 | scriptcommand_put 2024-10-26 (current) | ||
| Line 1: | Line 1: | ||
| - | ====== put ====== | + | ====== put command ====== |
| [[task_upload|Uploads]] one or more files from local directory to remote directory. | [[task_upload|Uploads]] one or more files from local directory to remote directory. | ||
| + | ===== Syntax ===== | ||
| + | put <file> [ [ <file2> ... ] <directory>/[ <newname> ] ] | ||
| + | ===== [[remarks]] Remarks ===== | ||
| + | If only one parameter is specified, uploads the file to remote working directory. If more parameters are specified, all except the last one specify set of files to upload. Filename can be replaced with Windows wildcard ((The Windows wildcard supports ''*'' and ''?'' only. If you want to use a full syntax of [[file_mask|file masks]], use a ''[[#filemask|-filemask]]'' switch.)) to select multiple files. To upload all files in a directory, use mask ''*''. | ||
| + | |||
| + | The last parameter specifies ==target== remote directory and optionally [[operation_mask|operation mask]] to store file(s) under different name. Target directory must end with slash. To upload more files to current working directory use ''./'' as the last parameter. | ||
| + | |||
| + | With the [[commandline#stdin|''/stdin'' command-line switch]], ''-'' can be used as a source to ==stream== the [[executables#redirection|standard input of ''winscp.com'']] to remote server. Streaming is supported with the [[sftp|SFTP]] and [[ftp|FTP]] protocols only. | ||
| + | |||
| + | When specific file name is used, command fails when the file does not exist. When wildcard is used, command succeeds, without doing anything, if the wildcard does not match any file, by default (you can change this using ''[[scriptcommand_option#failonnomatch|option failonnomatch on]]'' command). | ||
| + | |||
| + | You can have WinSCP [[guide_automation#generating|generate a code template]] for ''put'' for you. | ||
| + | |||
| + | See also ''[[scriptcommand_synchronize|synchronize]]'', if you need to transfer modified files only. | ||
| + | |||
| + | Switches: | ||
| + | ^ Switch ^ Description ^ | ||
| + | | ''-==delete=='' | Delete source local file(s) after a successful transfer. | | ||
| + | | ''-==latest=='' | Uploads the latest file from the files selected by the ''file'', ''file2'' ... parameters (typically [[file_mask|file masks]]) only. | | ||
| + | | ''-==resume=='' | Automatically resume transfer if possible.((Applies for individual files transfers only. It does not skip transfer of fully transferred files. For that, combine the switch with ''[[#neweronly|-neweronly]]''.)) \\ [[SFTP]] and [[FTP]] protocols only. Cannot be combined with ''[[#append|-append]]''. Has no effect when streaming (''-'' source). | | ||
| + | | ''-==append=='' | Append source file to the end of target file. \\ [[sftp|SFTP protocol]] only. Cannot be combined with ''[[#resume|-resume]]''. | | ||
| + | | ''-==preservetime=='' | Preserve timestamp. | | ||
| + | | ''-==nopreservetime=='' | Do not preserve timestamp. | | ||
| + | | ''-==permissions===<mode>'' | Set permissions ([[SFTP]] and [[SCP]] protocols only). \\ Has no effect when streaming (''-'' source). | | ||
| + | | ''-==nopermissions=='' | Keep default permissions. | | ||
| + | | ''-==speed===<kbps>'' | Limit transfer speed (in KB/s). | | ||
| + | | ''-==transfer===<mode>'' | ''%%binary|ascii|automatic%%'' \\ [[transfer_mode|Transfer mode]]: binary, ascii (text), automatic (by extension). | | ||
| + | | ''-==filemask===<mask>'' | ''%%<mask>[;<mask2>...]%%'' \\ Sets [[file_mask|file mask]]. | | ||
| + | | ''-==resumesupport===<state>'' | ''%%on|off|<threshold>%%'' \\ Configures [[resume#automatic|automatic resume/transfer to temporary filename]]. | | ||
| + | | ''-==neweronly=='' | Transfer new and updated files only. See also ''[[scriptcommand_synchronize|synchronize]]'' command. | | ||
| + | | ''-==rawtransfersettings== setting1=value1 setting2=value2 ...'' | Allows configuring any transfer settings using [[rawtransfersettings|raw format]] as in an INI file. E.g. to enable preserving of directory timestamps, use ''-rawtransfersettings PreserveTimeDirs=1''. The switch should come only after other parameters. | | ||
| + | |||
| + | Aliases: ''send'', ''mput'' | ||
| + | |||
| + | Effective [[scriptcommand_option|options]]: ''[[scriptcommand_option#confirm|confirm]]'', ''[[scriptcommand_option#reconnecttime|reconnecttime]]'', ''[[scriptcommand_option#failonnomatch|failonnomatch]]'' | ||
| + | |||
| + | XML log elements: ''[[logging_xml#upload|upload]]'', ''[[logging_xml#mkdir|mkdir]]'', ''[[logging_xml#chmod|chmod]]'' (with ''[[#permissions|-permissions]]''), ''[[logging_xml#touch|touch]]'' (with ''[[#preservetime|-preservetime]]'') | ||
| ===== Examples ===== | ===== Examples ===== | ||
| Line 34: | Line 71: | ||
| ^ Switch ^ Mapping ^ | ^ Switch ^ Mapping ^ | ||
| | ''-delete'' | Value ''true'' (''$True'' in PowerShell) for method parameter ''remove''. | | | ''-delete'' | Value ''true'' (''$True'' in PowerShell) for method parameter ''remove''. | | ||
| - | | ''-latest'' | See [[script_upload_most_recent_file|Uploading the most recent file]]. | | + | | ''-latest'' | See [[script_upload_most_recent_file|*]]. | |
| | ''-resume'' \\ ''-append'' \\ ''-preservetime'' \\ ''-nopreservetime'' \\ ''-permissions'' \\ ''-nopermissions'' \\ ''-transfer'' \\ ''-filemask'' \\ ''-resumesupport'' \\ ''-speed=<kbps>'' | [[library_from_script_transfer_settings|Converting transfer settings scripting switches]] to .NET assembly class ''TransferSettings''. | | | ''-resume'' \\ ''-append'' \\ ''-preservetime'' \\ ''-nopreservetime'' \\ ''-permissions'' \\ ''-nopermissions'' \\ ''-transfer'' \\ ''-filemask'' \\ ''-resumesupport'' \\ ''-speed=<kbps>'' | [[library_from_script_transfer_settings|Converting transfer settings scripting switches]] to .NET assembly class ''TransferSettings''. | | ||
| | ''-neweronly'' | Not supported. Use ''[[library_session_synchronizedirectories|Session.SynchronizeDirectories]]'' instead. | | | ''-neweronly'' | Not supported. Use ''[[library_session_synchronizedirectories|Session.SynchronizeDirectories]]'' instead. | | ||