This is an old revision of the document!

Documentation » Using WinSCP » Basic Tasks »

Editing/Opening Files

WinSCP allows you to edit/open remote file using editor or associated application on local machine. To do so it needs to download the remote file to temporary directory first. Then it opens the file in your preferred editor or associated application. Once you change the file, WinSCP uploads it back. With Norton Commander interface you can even edit/open local files, but most of this chapter covers editing remote files only.

To edit file selected in panel go to File(s) > Edit. The command by default opens the file in an internal editor. You can make the command open the file in any external editor in preferences. From submenu File(s) > Edit (alternative) you can open the file in any of configured editors.

Advertisement

You can create new empty file using command File(s) > New > File. The command asks for name of the new file and then opens your default editor.

To open file in an associated application use File(s) > Open. By default the file is also opened when double-clicked1 (this can be changed in preferences).

Editing and opening of files can be restricted by system administrator.

Editing Modes

WinSCP has two modes to manage the edited/opened remote files. The mode can be selected in preferences.

Multiple Files Mode

With Multiple files mode (the default), WinSCP can handle several edited/opened remote files at once.

Especially when the files are opened in an external editor, user can easily change two files at once. For this reason WinSCP must upload the files back using background transfer/queue to allow several uploads at once.

Advertisement

One File Mode

With One file mode, WinSCP can handle only one edited/opened remote file at once.

With this mode the WinSCP window is locked as long as the file (or rather the editor/associated application) is opened. Modified files are uploaded back using the main connection. Only once the upload is finished can you continue using the main window for other tasks.

External Editors

For basic editing WinSCP offers a simple integrated text editor. For advanced editing you will probably want to configure your favourite editor.

Problems with Some External Editors

Some external editors can open multiple files in one process. Usually such editors have some kind of tabbed interface, but it is also case of new versions of Microsoft Word (2000 and later).

If such editor is already running and the WinSCP runs second instance to open new file, the second instance just notifies the first to open the new file and exits immediately. Hence WinSCP expects that the file was closed as well and tries to delete the temporary file.

To allow WinSCP use this kind of editors, you need to select Multiple files mode and enable preference option External editor opens multiple files in one window (process). Then WinSCP will not treat the file as closed when the editor launched to open it is closed. Drawback is that all the files ever edited by current instance of WinSCP will be kept in temporary directory (until WinSCP is closed) and WinSCP will need to watch for changes of them all.

Note that setting only affects the “edit” operation. If a warning message still appears when you double click the file, then you can configure WinSCP to default the double click to “edit” in preferences.

If you choose to edit the same file again during the same session, WinSCP will download it to the same temporary directory as before, allowing the external editor to reload the file content in case it has it still opened (if the editor can detect the change).

Note that WinSCP can heuristically detect that you need to enable the option External editor opens multiple files in one window (process) and offers you to do so.

If you want to both keep the standard WinSCP behaviour and use your preferred editor, you may check if your editor offers you option to open separate instance for each edited file. Some editors have such option:

  • UltraEdit: Advanced > Configuration > General > General Application Items > Allow multiple instances
  • PSPad: Settings > Program Settings > System Integration > Only One Program Instance
  • Crimson Editor: Tools > Preferences > General > Allow Multiple Instances
  • TextPad: Configure > Preferences > Allow Multiple Instances to Run

Editing Binary Files

The internal editor supports only Windows-format text files. Thus the text transfer mode is forced when transferring remote file to/from the internal editor.

Advertisement

If you want to edit binary files you need to use external editor that supports binary files and uncheck preference option Force text transfer mode for files edited in external editor. The configured transfer mode will then be used even for transfers to/from external editor. Note that if you have configured binary transfer mode, your external editor must support server-side format of text files (Unix format usually), if you still want to edit them.

Transfer Settings when Editing Files

When remote file is downloaded to editor or uploaded from editor, default transfer settings or settings of active preset are used, with some exceptions:

  • Filename modification option is forced to “No change”.
  • Preserve-read only is turned off.
  • Replacement of characters not valid on Windows is enabled (original filename is restored on upload).
  • Exclude and include masks are ignored.
  • Text transfer mode may be forced (see Editing Binary Files).
  • Transfer resume support is disabled.
  1. If resolving of symbolic links is disabled or not possible, double-clicking file is always interpreted as attempt to open it, just in case it is unresolved symbolic linkBack

Last modified: by martin