Differences

This shows you the differences between the selected revisions of the page.

2013-11-15 2013-11-15
moving integration#url to integration_url (martin) 5.2.6 Improved registration for URL protocols + complete rewrite (martin)
Line 1: Line 1:
====== Protocol URL Addresses ====== ====== Protocol URL Addresses ======
-WinSCP can be registered to handle SFTP and SCP protocol URL addresses. See supported [[session_url|URL format]]. +WinSCP can be registered to handle file transfer protocol URL addresses. See supported [[session_url|URL format]].
- +
-If the path part of the URL does end with slash (''/'') WinSCP starts with the path as initial remote directory. If the path does not end with slash, the file (or directory) specified by it is downloaded. +
- +
-To make WinSCP [[session_configuration#site|save session settings]] provided by URL to a site instead of opening a session, add '';save'' after trailing slash (''/'') of the URL. &beta_feature For SFTP/SCP URL this should be combined with including [[session_url#hostkey|SSH host key fingerprint in the URL]]. Example: ''[[sftp://martin:mypassword;fingerprint=ssh-rsa-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx@example.com/;save]]''+
 +===== Registering to Handle URL Addresses =====
To register WinSCP to handle the URL addresses use [[installation|installer]] or go to [[ui_pref_integration|Preferences dialog]]. To register WinSCP to handle the URL addresses use [[installation|installer]] or go to [[ui_pref_integration|Preferences dialog]].
If current user's permissions allow, WinSCP register itself for all users. Otherwise it registers for current user only. If current user's permissions allow, WinSCP register itself for all users. Otherwise it registers for current user only.
 +
 +==== Windows Vista and Newer ====
 +On Windows Vista, 7 and 8, WinSCP registers to list of applications that handle ''%%sftp://%%'', ''%%ftp://%%'', ''%%ftps://%%'' and ''%%scp://%%'' protocol URL addresses. &winvista &win7 &win8 If WinSCP is the first application to support some of these protocols (most often ''%%sftp://%%'' and ''%%scp://%%'', usually also ''%%ftps://%%''), it becomes a default application for these.
 +
 +&beta_feature //In previous releases WinSCP behaves as described in [[integration_url#winxp|Windows XP section]]//.
 +
 +If you want to change the registration (for instance to make WinSCP default application even for ''%%ftp://%%'' URL addresses):
 +  * On //[[ui_pref_integration|Integration page]]// of Preferences dialog go to //%%Register to handle URL addresses > Make WinSCP default handler%%//((Alternatively go to //Control Panel > Programs > Default Programs > Set your default programs//; &wincp Locate WinSCP in the list; Click //Choose defaults for this program// command link.));
 +  * //Set Program Associations// Control Panel applet for WinSCP opens;
 +  * Check protocols you want WinSCP to be the default application for;
 +  * and confirm with //Save// button.
 +
 +Note that most mainstream web browsers ignore system registration for ''%%ftp://%%'' URL addresses and handle these on web pages on their own. To override this, you may use [[integration_url#winscp|WinSCP-specific URL addresses]].
 +
 +==== [[winxp]] Windows XP ====
 +On Windows XP, WinSCP registers to handle ''%%sftp://%%'' and ''%%scp://%%'' protocol URL addresses, overriding previous registration, if any. &winxp
 +
 +To change the registration:
 +  * Go to //Control Panel > Folder Options > File Types//; &wincp
 +  * Search a list for //File types// "%%URL: SFTP Protocol%%" or "%%URL: SCP Protocol%%";
 +  * Click //Advanced// button;
 +  * Select "open" action;
 +  * Click //Edit// button.
 +
 +==== [[winscp]] WinSCP-specific URL protocols ====
 +In addition to registering to generic URL protocols, WinSCP registers for application-specific URL protocols with ''winscp-'' prefix, i.e. ''%%winscp-sftp://%%'', ''%%winscp-ftp://%%'', etc. This is particularly useful for FTP protocol, for which WinSCP competes with your default web browser. Also for links on web pages, web browsers typically ignore system registration for ''%%ftp://%%'' addresses and handle these on their own anyway.
 +
 +&beta_feature
 +
 +Using WinSCP-specific URL protocols is reasonable also, when using WinSCP-specific extension for URL syntax, particularly the [[integration_url#save|save extension]].
 +
 +===== Handling URL Addresses =====
 +
 +If a handled URL does not include path part, WinSCP simply opens [[session_url|a session specified by the URL]].
 +
 +If path part is included and it ends with slash (''/''), WinSCP starts with the path as initial remote directory. If the path part does not end with slash, the file (or directory) specified by it is downloaded.
 +
 +==== [[save]] Save Extension ====
 +
 +To make WinSCP [[session_configuration#site|save session settings]] provided by URL to a site instead of opening a session, add '';save'' after a path part of the URL (it there is no path part, terminate the URL with ''/'' before adding the '';save'' extension).
 +
 +&beta_feature
 +
 +For SFTP/SCP URL this should be combined with including [[session_url#hostkey|SSH host key fingerprint in the URL]]. As this is WinSCP-specific extension, and also to avoid conflicts with other applications, like web browsers, consider using [[integration_url#winscp|WinSCP-specific URL protocols]].
 +
 +Example: ''[[winscp-sftp://martin:mypassword;fingerprint=ssh-rsa-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx@example.com/;save]]''
 +
 +===== Generating URL for File =====
Learn how to [[filenames#file_url|copy URL of file]] selected in file panel to clipboard. Learn how to [[filenames#file_url|copy URL of file]] selected in file panel to clipboard.

Last modified: by martin