Differences
This shows you the differences between the selected revisions of the page.
| ui_login_environment 2008-04-11 | ui_login_environment 2021-02-02 (current) | ||
| Line 1: | Line 1: | ||
| - | ====== Environment Tab ====== | + | ====== The Environment Page (Advanced Site Settings dialog) ====== |
| - | //Environment tab// allows user to configure WinSCP adaptation for particular server/environment. | + | The //Environment page// on the [[ui_login_advanced|Advanced Site Settings dialog]] allows user to configure WinSCP adaptation for particular server/environment. |
| &screenshotpict(login_environment) | &screenshotpict(login_environment) | ||
| - | More environmental options are available on subtabs: | + | More environmental options are available on subpages: |
| * [[ui_login_directories|Directories]] (initial directories, directory cache) | * [[ui_login_directories|Directories]] (initial directories, directory cache) | ||
| + | * [[ui_login_recycle_bin|Recycle Bin]] | ||
| + | * [[ui_login_encryption|Encryption]] (seamless file encryption) | ||
| * [[ui_login_sftp|SFTP]] (SFTP protocol specific/compatibility options) | * [[ui_login_sftp|SFTP]] (SFTP protocol specific/compatibility options) | ||
| * [[ui_login_scp|SCP/Shell]] (shell and SCP protocol specific/compatibility options) | * [[ui_login_scp|SCP/Shell]] (shell and SCP protocol specific/compatibility options) | ||
| * [[ui_login_ftp|FTP]] (FTP protocol specific options) | * [[ui_login_ftp|FTP]] (FTP protocol specific options) | ||
| + | * [[ui_login_s3|S3]] (S3 protocol specific options) | ||
| + | * [[ui_login_webdav|WebDAV]] (WebDAV protocol specific options) | ||
| + | |||
| + | &toc_title_page_sections | ||
| ===== Server Environment ===== | ===== Server Environment ===== | ||
| - | ==== End-of-line Characters ==== | + | ==== [[eol]] End-of-line Characters ==== |
| - | Use //End-of-line characters// to specify text file format used by the server. To allow [[transfer_mode|text mode transfers]], WinSCP needs to know the format of text files. Generally there is plenty of text file formats, almost every platform has it own format. WinSCP supports two most used formats, Unix and Windows. As most SSH servers are run on Unix system, generally you may leave the default Unix format. If your server runs on Windows, select the Windows format. If you do not use text mode transfers, the option is not important for you. | + | Use //End-of-line characters// to specify text file format used by the server. To allow [[transfer_mode|text mode transfers]], WinSCP needs to know the format of text files. Generally there is plenty of text file formats, almost every platform has it own format. WinSCP supports two most used formats, Unix and Windows. As most servers are run on Unix system, generally you may leave the default Unix format. If your server runs on Windows, select the Windows format. If you do not use text mode transfers, the option is not important for you. |
| - | With [[protocols#sftp|SFTP-4 and newer]], the server tells itself what format it uses, so the configured option is not used. | + | With [[sftp|SFTP-4 and newer]], the server tells itself what format it uses, so the configured option is not used. |
| - | With [[protocols#ftp|FTP]], the option is disabled, as protocol specification defines the text file format. | + | With [[FTP]], the option is disabled, as protocol specification defines the text file format. With [[WebDAV]] and [[S3]], the option is disabled as the protocols do not support text mode transfers. |
| ==== [[utf]] UTF-8 Encoding for Filenames ==== | ==== [[utf]] UTF-8 Encoding for Filenames ==== | ||
| - | Use //UTF-8 encoding for filenames// to configure if WinSCP should use UTF-8 (Unicode) encoding for filenames in communication with the server. | + | Use //%%UTF-8%% encoding for filenames// to configure if WinSCP should use UTF-8 (Unicode) encoding for filenames in communication with the server. |
| - | With default //Auto// value, WinSCP will try to autodetect if the server supports UTF-8. With [[protocols#sftp|SFTP protocol]] this means that UTF-8 will be used for protocol version 4 and newer, unless the server is known not to support UTF-8·((Foxit software WAC Server)). With [[protocols#ftp|FTP protocol]] this means that UTF-8 will be used when the server announces support for it. | + | With default //Auto// value, WinSCP will try to autodetect if the server supports %%UTF-8%%. With [[sftp|SFTP protocol]] this means that %%UTF-8%% is used for protocol version 4 and newer; for older versions, %%UTF-8%% is used unless the server is known not to support %%UTF-8%%((Foxit software WAC Server.)) or it sends strings not encoded with %%UTF-8%%. With [[ftp|FTP protocol]] this means that %%UTF-8%% will be used when the server announces support for it. With [[scp|SCP protocol]] this means that %%UTF-8%% will be used when a ''LANG'' environment variable is set to "%%UTF-8%%" encoding. |
| - | Set the option to //On// to force usage of UTF-8 (useful for servers using UTF-8 natively). Set the option to //Off// to unconditionally disable usage of UTF-8. | + | Set the option to //On// to force usage of %%UTF-8%% (useful for servers using %%UTF-8%% natively). Set the option to //Off// to unconditionally disable usage of %%UTF-8%% (for servers that does not use %%UTF-8%%). |
| - | UTF-8 is not supported with [[protocols#scp|SCP protocol]]. | + | With [[WebDAV]] and [[S3]], the option is disabled as %%UTF-8%% is always used with the protocols. |
| + | When not using UTF-8 encoding, WinSCP assumes the server is using the same legacy ANSI encoding as configured for local machine in //Control Panel > Clock and Region > Region > Administrative > Language for non-Unicode programs//. &wincp | ||
| - | ==== Timezone Offset ==== | + | ==== [[timezone]] Time zone Offset ==== |
| - | The //Timezone offset// allows user to configure timezone difference of the server. | + | The //Time zone offset// allows user to configure time zone difference of the server. |
| - | With [[protocols#scp|SCP protocol]] the option is used to counterweight time difference between [[timestamp|timestamp]] of remote file shown in directory listing and timestamp set on downloaded file, and vice versa. The difference is caused by fact that during transfer ''scp'' command usually uses UTC time format, while ''ls'' command may display time in local (for server) time format. The time difference can be negative. For example if the timestamps of remote files are two hours ahead of local files, set the option to -2 hours. Read about other issues with [[timestamp|timestamps]]. | + | With [[scp|SCP protocol]] the option is used to counterweight time difference between [[timestamp|timestamp]] of remote file shown in directory listing and timestamp set on downloaded file, and vice versa. The difference is caused by fact that during transfer ''scp'' command usually uses UTC time format, while ''ls'' command may display time in local (for server) time format. The time difference can be negative. For example if the timestamps of remote files are two hours ahead of local files, set the option to -2 hours. Read about other issues with [[timestamp|timestamps]]. |
| - | With [[protocols#ftp|FTP protocol]] the option is used to actually set the difference between local and remote timezone. | + | With [[ftp|FTP protocol]] the option is used to actually set the difference between local and remote time zone. Though it is used, when deprecated ''LIST'' command is used for directory listing, only. When using ''MLSD'', the server must report all timestamps in UTC. To enable the option with FTP protocol, you need to opt to use ''LIST'' command explicitly by setting //[[ui_login_ftp|Use MLSD command for directory listing]]// to //Off//. Though, you should use this only when the server does not support ''MLSD'' command or its implementation is buggy. With the ''LIST'' command, the difference is automatically detected by default.((If the server supports ''MDTM'' command.)) If the detections fails, uncheck //Detect automatically// and set the difference manually. |
| - | The option is not available with [[protocols#sftp|SFTP protocol]], as with it, the server must report all timestamps in UTC. | + | The option is not available with [[SFTP]], [[WebDAV]] and [[S3]] protocols, as with them, the server must report all timestamps in UTC. |
| - | ===== Daylight Saving Time ===== | + | ==== [[vms]] Trim VMS Version Numbers ==== |
| - | Some servers (mostly on Windows) adjust [[timestamp|file timestamp]] with start of DST and some not (Unix). The option selects between the two approaches. ((Until version 3.7.6, Windows-style approach (server does adjustment) was selected by default.)) | + | Enable //Trim VMS Version Numbers// to remove VMS version numbers from filenames when transferring. |
| - | Change the option if timestamps of some files, either in directory listing or after transfer, are shifted by one hour. Note that the option must be set correctly before transferring the files. It does not make sense to try to use it to adjust the incorrect timestamp of already transferred file.· | + | This ensures that on upload a new version of the file is created on the VMS system. |
| - | Use the third option //Preserve remote timestamp//, if you want to see exact non-adjusted remote timestamp in remote [[ui_file_panel|panel]]. Drawback is that with the option selected, the [[task_synchronize|synchronization]] functions will not work. | + | ===== [[dst]] Daylight Saving Time ===== |
| + | Some servers (mostly servers running on the older versions of Windows) incorrectly adjust [[timestamp|file timestamp]] with start of DST. The //Daylight saving time// option allows you to counterweight the incorrect behavior. | ||
| + | |||
| + | The option is not supported with [[ftp|FTP protocol]]. The option is also not available with [[webdav|WebDAV]] and [[S3]] protocols, as with them, no issues are known that would require it. | ||
| + | |||
| + | Select //Adjust remote timestamp to local conventions//, if the server behaves correctly and does not adjust file timestamp (typically Unix-based servers and Windows 7 and newer). | ||
| + | |||
| + | Select //Adjust remote timestamp with DST//, if the server does not behave correctly and adjusts file timestamp (Windows Vista/2008 and older). | ||
| + | |||
| + | Change the option, if timestamps of some files in the remote [[ui_file_panel|panel]] are shifted by one hour. This can happen either for already existing remote files, or for newly transferred files. For the latter case, please note that the option must be set correctly before transferring the files. It does not make sense to try to use it to adjust the incorrect timestamps of already transferred files. | ||
| + | |||
| + | Use the third option //Preserve remote timestamp//, if you want to see exact non-adjusted remote timestamp in remote [[ui_file_panel|panel]]. Drawback is that with the option selected, the [[task_synchronize|synchronization]] functions will not work. This option is not available on Windows 7/2008 R2 and newer. | ||
| Read about other issues with [[timestamp|timestamps]]. | Read about other issues with [[timestamp|timestamps]]. | ||
| - | ===== Recycle Bin ===== | + | ===== [[putty]] PuTTY ===== |
| - | WinSCP can emulate Windows Recycle bin functionality on the server-side. | + | |
| + | In //PuTTY terminal settings// box, you can specify additional PuTTY settings that WinSCP should use, when [[integration_putty#open_putty|opening session in PuTTY]]. Typically you will use it to set PuTTY terminal settings (like colors). | ||
| - | When //Preserve deleted remote files to recycle bin// is checked it moves deleted files to specified remote directory (recycle bin) instead of actually deleting them. This applies even for directory synchronization. | + | Click the //Edit in PuTTY// button to open PuTTY Configuration window. There, locate a stored session with a name like //(Terminal settings for ...)//. Click the //Load// button. Then edit PuTTY settings as you like (though do not modify the settings that can be controlled in WinSCP, like hostname, username, some SSH protocol settings, etc.). When done, click //Save// button and close PuTTY Configuration window. WinSCP will pick up the settings and load them to the //PuTTY terminal settings// box. |
| - | When //Preserve overwritten remote files to recycle bin// is checked, the remote file is moved to specified remote directory (recycle bin) before being overwritten by [[task_upload|uploaded]] file. The option is supported only with [[protocols|SFTP protocol]]. | + | You can also specify the settings manually. Use PuTTY registry value names for the settings you want to set. For each settings use a format ''name=value''. Separate multiple settings by a space. Textual values should be surrounded by double-quotes. For example, to double the size of PuTTY window and use gray for a default background color, use: |
| - | The file, when it is moved to remote recycle bin, is renamed to include deletion timestamp in the filename. For example ''test.txt'' deleted on New Year Eve 2005 is renamed to ''test-20050101-000000.txt''. | + | <code> |
| + | TermWidth=160 TermHeight=48 Colour2="105,105,105" | ||
| + | </code> | ||
| - | Deleting the file from remote recycle bin deletes it permanently. The same is true for overwritting it. | + | The box is not available, when there exists a PuTTY stored session with the same name as the WinSCP site. In that case, [[integration_putty#session_configuration|WinSCP uses the PuTTY stored session]] and no WinSCP settings. |
| - | You need to check //Advanced options// to reveal the //Recycle bin// box. | + | ===== Further Reading ===== |
| + | Read more about [[ui_login|Login dialog]] and [[ui_login_advanced|Advanced Site Settings dialog]]. | ||