Index

• About WinSCP
  • Introduction
  • Project History
    • project_history_screenshots
  • Contributions
  • Awards
  • Screenshots
  • License
  • privacy
  • contributor_agreements

• Setting up WinSCP
  • Requirements
  • Installation
    • WinSCP Installer
      • License Agreement
      • Setup Type
      • Select Destination Location
      • Select Components
      • Select Additional Tasks
      • Initial User Settings
      • Ready to Install
      • Completing the Wizard
  • microsoft_store
  • custom_distribution
  • administration
  • dragext

• Getting Started
  • Quick Start Guide
  • Protocols
    • SFTP
      • sftp_codes
    • SCP
    • FTP
      • FTPS
      • ftp_codes
      • ftp_modes
    • WebDAV
    • s3
    • tls
      • tls_ciphersuites
    • SSH
      • ssh_verifying_the_host_key
      • ssh_keys
      • Using Public Keys for Authentication
        • ui_puttygen
        • ui_pageant
      • ssh_algorithms
  • Security
    • security_credentials

• Features
  • Command-line Options
  • executables
  • Scripting
    • Script Commands
      • scriptcommand_call
      • scriptcommand_cd
      • scriptcommand_checksum
      • scriptcommand_chmod
      • scriptcommand_close
      • scriptcommand_cp
      • scriptcommand_echo
      • scriptcommand_exit
      • scriptcommand_get
      • scriptcommand_help
      • scriptcommand_keepuptodate
      • scriptcommand_lcd
      • scriptcommand_lls
      • scriptcommand_ln
      • scriptcommand_lpwd
      • scriptcommand_ls
      • scriptcommand_mkdir
      • scriptcommand_mv
      • scriptcommand_open
      • scriptcommand_option
      • scriptcommand_put
      • scriptcommand_pwd
      • scriptcommand_rm
      • scriptcommand_rmdir
      • scriptcommand_session
      • scriptcommand_stat
      • scriptcommand_synchronize
    • Useful Scripts
      • Uploading a single file
      • Upload to multiple servers / Parametrized script
      • Downloading file to timestamped-filename
      • Downloading the most recent file
      • Uploading the most recent file
      • Checking file existence
      • Moving local files to different location after successful upload
      • Locking files while uploading / Upload to temporary file name
      • Shortcut to synchronize any local directory with remote directory
      • Automatically compress files before download
      • Running WinSCP from VB.NET
      • script_upload_file_list
      • Custom directory listing format (CSV)
      • script_retry
      • Formatting timestamp in batch file
      • script_downloading_when_done_file_exists
      • script_download_files_to_same_folder
      • script_email
    • Raw Site Settings
    • Raw Configuration
    • rawtransfersettings
  • User Interfaces
  • Configuration Storage
  • Portable Use
  • Connection Tunneling
  • Integration to Windows
    • integration_url
    • ui_jump_list
  • Master password
  • Transfer Resume
  • Directory Caching
  • Remote Commands
  • Custom Commands
    • Extensions
      • extension_generate_http_url
      • extension_compare_files
      • extension_archive_and_download
      • extension_synchronize_another_server
    • Useful Custom Commands
  • transfer_queue
  • Advanced Features:
  • shell_session
  • temp_folders
  • Transfer Modes
  • File Masks
  • Operation Mask
  • filenames
  • Integration
    • integration_putty
    • integration_keepass
    • integration_editor
  • updates
  • usagestatistics
  • transfer_settings
  • timestamp
  • Logging
    • logging_xml
  • once_done
  • custom_key_shortcuts
  • local_path
  • session_url
  • session_configuration
  • workspace
  • File Encryption
    • file_encryption_decrypt_script
  • clipboard

• Using WinSCP
  • Main Window (Commander Interface)
    • ui_commander_key
    • ui_commander_menu
  • Main Window (Explorer Interface)
    • ui_explorer_key
    • ui_explorer_menu
  • ui_file_panel
  • ui_queue
  • ui_context_menu
  • ui_toolbars
  • ui_tabs
  • Permissions
  • ui_copy
  • ui_copy_local
  • ui_console
  • ui_fsinfo
  • ui_select
  • ui_progress
  • ui_about
  • ui_transfer_custom
  • ui_authenticate
  • ui_master_password
  • ui_filter
  • ui_import
  • ui_cleanup
  • ui_login_save
  • ui_editmask
  • ui_overwrite
  • ui_save_workspace
  • ui_generateurl
  • ui_tips

• Using WinSCP
  • Basic Tasks
    • Navigating
      • ui_opendir
      • ui_locationprofile
    • Uploading files
    • Downloading files
    • Synchronization (general)
      • Compare Directories
      • Synchronization
        • Synchronize Dialog
        • ui_synchronize_checklist
      • Keep Remote Directory Up To Date
        • ui_keepuptodate
    • Managing sessions
    • Editing/Opening Files
      • Internal text editor
        • ui_editor_find
        • ui_editor_replace
    • Changing Properties
      • ui_properties
    • task_rename
    • Creating Links and Shortcuts
      • ui_symlink
    • Moving and Duplicating Remote Files
      • ui_duplicate
    • Deleting files
    • Creating directories
      • ui_create_directory
    • Finding files
      • ui_find
    • task_lock
    • task_change_password
    • task_file_management

• Guides
  • Set Up
    • guide_install
    • guide_connect
    • Connect to FTP/SFTP server which can be accessed via another server only
    • guide_public_key
  • Basic Tasks
    • guide_upload
    • guide_synchronize
    • guide_website
    • Exchange files over Internet
    • guide_secure
  • Scripting/Automation
    • guide_automation
    • guide_automation_advanced
    • guide_schedule
    • Conditional Processing in Automation
    • SFTP task for SSIS
    • SFTP file transfers in .NET
    • guide_interpreting_xml_log
    • Converting Windows FTP script to WinSCP SFTP script
    • Converting PuTTY PSFTP script to WinSCP script
    • Protecting credentials used for automation
    • guide_debugging_scheduler
    • guide_custom_commands_automation
    • guide_filezilla_automation
  • Cloud Computing
    • Amazon AWS
      • guide_amazon_ec2
      • Setting up an SFTP Access to Amazon S3
      • guide_amazon_s3
    • Google Cloud Platform
      • guide_google_compute_engine
      • guide_google_bucket
    • Microsoft Azure
      • Azure
      • guide_azure_ftps_server
      • guide_microsoft_azure_webjob_sftp
      • guide_microsoft_azure_function_sftp
    • guide_digitalocean
    • guide_injecting_sftp_ftp_url_to_page
    • guide_microsoft_onedrive
    • guide_backblaze
    • guide_cloudflare
  • Other
    • guide_winscp_as_putty_session_manager
    • guide_windows_ftps_server
    • guide_windows_openssh_server
    • guide_config_cloud
• How To
  • howto

• Configuration
  • Login Dialog
    • ui_login_raw
    • Advanced
      • Environment
        • Directories
        • Recycle Bin
        • Recycle Bin
        • SFTP
        • SCP/Shell
        • FTP
        • S3
        • WebDAV
      • Connection
        • Proxy
        • Tunnel
        • TLS/SSL
      • SSH
        • Key exchange
        • Authentication
        • Bugs
      • Note
  • Preferences Dialog
    • Environment
      • Interface
      • Window
      • Commander
      • Explorer
      • ui_pref_languages
    • Panels
      • File Colors
        • ui_file_color
      • Remote
      • Local
    • Editors
      • Internal Editor
      • ui_editor_preferences
    • Transfer
      • ui_transfer_preset
      • Drag&Drop
      • Background
      • Endurance
    • Network
    • Security
      • ui_master_password_change
      • ui_ssh_host_ca
    • Logging
    • Integration
      • Applications
    • Commands
      • Custom Command Editor Dialog
    • Storage
    • Updates
    • ui_pref_search

• .NET Assembly
  • library_com_wsh
  • library_vb
  • library_perl
  • library_ssis
  • library_install
  • library_powershell
  • Examples
    • library_example_delete_after_successful_download
    • library_example_listing_files_matching_wildcard
    • library_example_recursive_search_text
    • library_example_verify_file_checksum
    • library_example_recursive_download_custom_error_handling
    • library_example_find_duplicate_files
    • library_example_parallel_transfers
    • library_example_check_existence_timestamp
    • library_example_zip_and_upload
    • library_example_known_hosts
    • library_example_moves_files_keeping_directory_structure
    • library_example_download_clipboard
    • library_example_watch_for_changes
    • library_example_advanced_rename
    • library_example_keep_local_directory_up_to_date
    • library_example_remember_downloaded_files
    • library_example_winforms_progressbar
    • library_example_two_way_synchronize_delete
  • Converting Script to Code Based on .NET Assembly
    • library_from_script_transfer_settings
  • Session Class
    • library_session_listdirectory
    • library_session_open
    • library_session_putfile
    • library_session_putfiles
    • library_session_putfilestodirectory
    • library_session_putfiletodirectory
    • library_session_close
    • library_session_dispose
    • library_session_executecommand
    • library_session_fileexists
    • library_session_getfileinfo
    • library_session_trygetfileinfo
    • library_session_getfile
    • library_session_getfiles
    • library_session_getfilestodirectory
    • library_session_getfiletodirectory
    • library_session_removefile
    • library_session_removefiles
    • library_session_synchronizedirectories
    • library_session_filetransferred
    • library_session_failed
    • library_session_outputdatareceived
    • library_session_createdirectory
    • library_session_movefile
    • library_session_abort
    • library_session_escapefilemask
    • library_session_filetransferprogress
    • library_session_addrawconfiguration
    • library_session_calculatefilechecksum
    • library_session_translateremotepathtolocal
    • CombinePaths
    • library_session_enumerateremotefiles
    • library_session_scanfingerprint
    • library_session_translatelocalpathtoremote
    • library_session_duplicatefile
    • library_session_queryreceived
    • library_session_comparedirectories
  • RemoteFileInfo Class
  • SessionOptions Class
    • library_sessionoptions_addrawsettings
    • library_sessionoptions_parseurl
  • TransferOptions Class
    • library_transferoptions_addrawsettings
  • ChmodEventArgs Class
  • FailedEventArgs Class
  • OperationResultBase Class
  • FilePermissions Class
  • RemovalEventArgs Class
  • SessionException Class
  • SynchronizationResult Class
  • TouchEventArgs Class
  • TransferEventArgs Class
  • library_filetransferprogresseventargs
  • library_operationeventargs
  • library_fileoperationeventargs
  • library_sessionlocalexception
  • library_sessionremoteexception
  • library_commandexecutionresult
  • RemoteDirectoryInfo
  • library_removaloperationresult
  • library_transferoperationresult
  • library_transferresumesupport
  • library_doc_collections
  • library_wildcard
  • library_queryreceivedeventargs
  • RemotePath Class
    • library_remotepath_adddirectoryseparator
    • library_remotepath_getdirectoryname
    • library_remotepath_getfilename
    • library_remotepath_escapefilemask
    • library_remotepath_escapeoperationmask
    • library_remotepath_combinepaths
    • library_remotepath_combine
    • library_remotepath_translateremotepathtolocal
    • library_remotepath_translatelocalpathtoremote
  • library_comparisonfileinfo
  • ComparisonDifference
    • library_comparisondifference_resolve
    • library_comparisondifference_reverse

• Screenshots
• History
  • incompatible_changes
  • history_old
• languages

• Support
  • Troubleshooting
  • Common Error Messages
    • message
  • How to Report Bug or Ask for Support
  • Using Debug Release
  • Interoperability
  • internal_error

• FAQ (Frequently Asked Questions)
  • Using WinSCP
    • How do I change drive on the remote panel?
    • Why can’t I change the owner and the group of a file?
    • Why does WinSCP not work in a new environment (operating system, machine, user account, network), when it works for me in a different environment already?
  • Connecting to the Server
    • Where do I get a username and password?
    • faq_login
    • Why is WinSCP not able to connect to a server, when other clients are?
    • faq_new_session
    • Can I connect to an FTP server?
    • How do I know if the connection is secure?
    • I get the message “Received too large (??? B) SFTP packet” when I login. What is the problem?
    • Where should I type the IP address of my remote host?
    • How can I connect without entering private key passphrase each time?
    • Why does WinSCP keep on asking me for a session password?
    • Why is WinSCP rejecting my session password?
    • Can you reset my password?
    • faq_hostkey
    • faq_mainframe
    • faq_root_path
  • Transferring Files
    • Can I transfer files between two remote servers with WinSCP (FXP)?
    • File transfer speed is very low. WinSCP does not utilize all available bandwidth. How do I improve the transfer speed?
    • I need to overwrite a remote file that isn’t owned by me, but I’m member of its group. The file has write permission for group. After transfer I get a message like “Upload of file <filename> was successful, but error occurred while setting the permissions and/or timestamp”
    • Where can I change the file transfer mode (binary, ascii) or enable the auto-select transfer mode option?
    • Why is the timestamp of uploaded/downloaded file different from the timestamp of the source file?
    • Can I transfer file larger than 4 GB (or 2 GB)?
    • When I attempt to copy files, I get an Error 127. What does this mean?
    • Why does file size and/or content change during transfer?
    • faq_line_breaks
    • faq_uploaded_file_missing
    • faq_upload_empty
  • Configuring the Session
    • How can I configure the default local or remote directory for the session?
    • How do I save a session, so that I don’t need to fill in all the login information every time I start WinSCP?
  • Scripting/Automation
    • My script works fine when executed manually, but fails or hangs when run by Windows Scheduler, SSIS or other automation service. What am I doing wrong?
    • How do I configure session, transfer and/or any other settings for which there are no script commands?
    • How do I know that script completed successfully?
    • How do I transfer modified files only?
    • Why the switches do not work in my script?
    • Why I cannot connect/transfer using script, when I can using GUI (or vice versa)?
    • Why is WinSCP returning non zero exit code?
    • How do I create script that synchronizes files and deletes synchronized files from source afterwards?
    • How do I transfer (or synchronize) directory non-recursively?
    • faq_batch_file
    • faq_library_parameters

line?]]

• Synchronization
  • Synchronization or keep remote directory up to date functions are not working. Why?
  • What do direction options (local, remote, both) for Synchronization mean?
• Working with iPhone, iPod Touch or iPad
  • How do I connect to my iPhone, iPod Touch or iPad?
  • How do I do … on iPhone, iPod Touch or iPad?
• Miscellaneous
  • How do I change user after login (e.g. su root)?
  • Why WinSCP breaks permissions (jail, chroot)?
  • How do I make WinSCP show localized and/or UTF-8 encoded (Unicode) filenames correctly?
  • Why are the changes, I upload to webserver, not visible in the web browser?
  • Can I map a remote directory as a network drive in Windows?
  • What is error code 4?
  • How do I transfer my settings to another computer? How do I import/export my settings?
  • I cannot read the file panel font. How can I make the panel font bigger?
  • What command-line parameters can be used with WinSCP?
  • How to keep the user in a specified directory on the server? (chrooted session)
  • Can the internal editor be better (e.g. syntax highlighting)?
  • Is there some API that I can use to add file transfer functionality to my application?
  • Can you provide us with export control information/FIPS certification for WinSCP?
  • How many WinSCP licenses has our company bought?
  • Can I recover password stored in WinSCP site?
  • Can I undelete remote file removed with WinSCP?
  • Where is documentation for error codes?
  • faq_no_window
  • faq_local_folders

• WinSCP Plugins to File Managers
  • Plugin To Altap Salamander
    • About
    • History

• Wiki
  • syntax
  • dokuwiki

• Announcements
  • announcement_winscp55
  • announcement_winscp57
  • announcement_winscp59
  • announcement_winscp511