Differences
This shows you the differences between the selected revisions of the page.
| ui_pref_integration_app 2008-04-08 | ui_pref_integration_app 2024-02-15 (current) | ||
| Line 1: | Line 1: | ||
| - | ====== Integration Tab ====== | + | ====== The Applications Integration Page (Preferences Dialog) ====== |
| - | //Applications Integration tab// allows user to configure how WinSCP integrates with other applications, particularly with [[integration_app#opening_current_session_in_putty|PuTTY]]. | + | The //Applications Integration page// on the [[ui_preferences|Preferences dialog]] allows user to configure how WinSCP integrates with other applications, particularly with [[integration_putty#open_putty|PuTTY]] or other terminal clients. |
| &screenshotpict(pref_integration_app) | &screenshotpict(pref_integration_app) | ||
| + | |||
| + | &toc_title_page_sections | ||
| ===== External Applications ===== | ===== External Applications ===== | ||
| - | Using //PuTTY path// box you can specify path to PuTTY application that is used in //[[integration_app#opening_current_session_in_putty|Open in PuTTY]]// function. You can use environment variables in the path, with syntax ''%NAME%''. | ||
| - | Check //Remember session password and pass it to PuTTY// checkbox to make WinSCP keep session password in memory and pass it to PuTTY when using //Open in PuTTY// function (using command-line parameter ''-pw''). However better approach would be to use [[public_key|public key authentication]] together with [[integration_app#pageant|Pageant]]. | + | ==== [[client_path]] PuTTY/Terminal Client Path ==== |
| + | Using //PuTTY/Terminal client path// box you can specify [[local_path|local path]] to PuTTY or [[integration_putty|other terminal client application]] that is used with //[[integration_putty#open_putty|Open in PuTTY]]// function. You can also use Microsoft Store app aliases here, for example [[integration_putty#wt|the ''wt.exe'' for Windows Terminal]]. | ||
| - | By default WinSCP instructs PuTTY to open Telnet session if you are using [[protocols#ftp|FTP]]. Uncheck the //Open Telnet sessions in PuTTY for FTP sessions// to use [[SSH]] instead·((However note that if the server supports SSH protocol, it most probably supports [[protocols#sftp|SFTP]] also. You should always use SFTP, instead of FTP, if possible.)). | + | Optionally, you can use following patterns in the path: |
| + | ^ Pattern ^ Description ^ | ||
| + | | ''!!'' | Is replaced with exclamation mark (''!''). | | ||
| + | | ''!/'' | Current remote path. | | ||
| + | | ''!@'' | Current session hostname. | | ||
| + | | ''!U'' | Current session username. | | ||
| + | | ''!P'' | Current session password (if [[security_credentials|stored or remembered]]). | | ||
| + | | ''!#'' | Current session port number. | | ||
| + | | ''!K'' | Current session private key. | | ||
| + | | ''!N'' | Current session name. | | ||
| + | | ''!?prompt[\]?default!'' | When used, user is prompted to enter value that replaces the pattern. ''prompt'' can define a message of the prompt and ''default'' a default value, both can be empty. Special characters entered by user are automatically delimited. You can prohibit this using optional backslash (''\'') before second question mark (''?''). | | ||
| + | | ''!`command`'' | Replaced with output of given local console command. | | ||
| + | |||
| + | If pattern ''!@'' is not used, parameter ''-load <site>'' is automatically added to the command. | ||
| + | |||
| + | If pattern ''!P'' is not used, a ==password== is known, and you are using an up-to-date version of PuTTY,((The executable name is ''putty.exe'' and its version is 0.77 or higher.)) the password is passed using named pipe and [[&url(puttydoc)/Chapter3.html#using-cmdline-pw|''-pwfile'' switch]]. Otherwise insecure [[&url(puttydoc)/Chapter3.html#using-cmdline-pw|''-pw <password>'']] parameter is used.((It is passed as the first argument of the executable, before any custom arguments.)) | ||
| + | |||
| + | See also [[&url(puttydoc)/Chapter3.html#using-cmdline|PuTTY command-line documentation]]. | ||
| + | |||
| + | ==== [[other_options]] Other Options ==== | ||
| + | Check //Remember session password and pass it to PuTTY// checkbox to make WinSCP [[security_credentials#password_memory|keep session password in memory]] and [[#password|pass it to PuTTY]] when using //[[integration_putty#open_putty|Open in PuTTY]]// function. However better approach would be to use [[public_key|public key authentication]] together with [[ui_pageant|Pageant]]. The option is disabled, when the ''!P'' pattern is used in the [[#client_path|terminal client path]] box, as it implies that the password is remembered. | ||
| + | |||
| + | By default WinSCP instructs PuTTY to open Telnet session if you are using [[FTP]]. Uncheck the //Open Telnet sessions in PuTTY for %%FTP%% sessions// to use [[SSH]] instead.((However note that if the server supports SSH protocol, it most probably supports [[SFTP]] also. You should always use SFTP, instead of FTP, if possible.)) | ||
| Check //Automatically open new sessions in PuTTY// to automatically send all sessions opened in WinSCP also to PuTTY. | Check //Automatically open new sessions in PuTTY// to automatically send all sessions opened in WinSCP also to PuTTY. | ||
| + | |||
| + | Use //PuTTY ==registry== key// selection lets you choose registry key, where WinSCP exports its session settings, to be used by terminal client. WinSCP exports settings in PuTTY format, which is also used by many of its clones, such as [[integration_putty#kitty|KiTTY]]. If your terminal client does not support this format, you need to use respective patterns (i.e. ''!@'' and ''!U'') in [[#client_path|terminal client path]] box as an alternative way to pass the settings. The registry key path is also used by WinSCP when [[ui_import|importing sites]]. The option is not available in [[microsoft_store|Microsoft Store installation]], where WinSCP uses only command-line switches to pass a limited set of session settings to PuTTY. | ||
| + | |||
| + | |||
| + | ===== Further Reading ===== | ||
| + | * Using [[integration_putty#kitty|KiTTY]] or [[integration_putty#openssh|OpenSSH]] instead of PuTTY; | ||
| + | * [[integration_putty#putty_startup_directory|Opening PuTTY in the same directory]]; | ||
| + | * Read more about [[ui_preferences|Preferences dialog]] and its other [[ui_preferences#pages|pages]]. | ||
| + | |||