WinSCP

Introduction

WinSCP is an FTP (File Transfer Protocol) client that allows users to transfer files to and from remote servers, as well as manage and edit those files from a
remote location. WinSCP has several customizable options that can be utilized by the experienced user, as well as the first time user. And it is designed to work in conjunction with several other programs, such as PuTTY and Exceed.

This documentation of the WinSCP program will help Purdue students to access and manage their career account files from their home computers. Within this documentation the reader will find "how to use" guide that spans every aspect from downloading and installing the software to logging on, managing files, and advanced settings.

The first part of this documentation will cover the downloading of the software. This aspect of the guide in painstakingly detailed in order to steer the user t 22322w226w hrough the sometimes tricky process of downloading the software. It is important to now that since this is open source software there are several versions out there; and constant updates are available. This guide will serve as a foundation that will allow readers to navigate any newer versions.

The user will be instructed on how to install the software and walked through the basic setup options that will ensure that the software run at optimal levels. It will also allow the user to customize the software to his or her needs. Within this section the user will be taught how to successfully log on, ensure proper connection, as well as safely log out of the system

The next part of the documentation will cover the use of the software in regards to the managing of files. This documentation will show how to move, copy, delete, paste, and modify the user's files. It will also show how to use programs such as PuTTY in conjunction with WinSCP.

Finally, for those users who have or would like to have a greater understanding of the components of functions WinSCP, there is an advanced setup section what will go through some of the customizable options available.
Audience Definition

The primary audience is by definition very generic; all Purdue students. All Purdue students are granted a network account, which can be used to store their personal information in as well as any work, school, and club files they may need. These students would be able to access their accounts, not just from a network computer, but also from a remote computer that has a reliable internet connection.

The secondary audience, which is encapsulated within our primary audience, will include students who are less knowledgeable about computers and computer systems. While a student is at home (either off-campus housing or original hometown), this program will allow them to access the Purdue servers and transfer files to and from their career accounts. For a student taking any computer science course, setting WinSCP up to work in conjunction with PuTTY will allow them to easily work on their projects and even compile them.

This documentation will be explaining how to download, install and use the program so that all students may access this program for the first time, or learn more about the advanced settings and how they work. Most of beginning users will not be concerned with advanced use of the program, but will simply be interested in using it for transferring files to and from their career accounts.

While this documentation will attempt to be very thorough in the explanation of the software, some problems may still occur. If the user deletes a file or moves a file to an unknown location, then that file may be lost or difficult to find. Additionally, if the internet connection is faulty, or the computer "gets booted", the transferring file may be corrupt or damaged which could result in work being lost.
Justification

Most students are not aware of the existence of WinSCP or they use it infrequently. This can be attributed to the limited knowledge that many have on how to utilize the software to its full potential. This documentation would be a way of shedding light on this situation by making the students more aware and at ease with this relatively new software. While some users will be able to use the basic features of this software effortlessness, there are many advanced options that might present a challenge to even these users. This documentation will create a sense of familiarity, in regards to those options, as well as make current and new users conscious of some of the advanced options that they may have overlooked.

Moreover, some of the advanced features are difficult to understand due to the inadequate amount of documentation on them. This documentation will provide new information about these features that will serve as a supplement to the existing documentation; essentially allowing this documentation to serve in a clarifying capacity to other documentation that might already exist.

Downloading WinSCP

Open internet browser of your choice.

Access WinSCP website: https://winscp.org/

Click on WinSCP link as pictured in Figure 1.

Figure 1 WinSCP Link

You will be directed to the first of several sites in order to begin the downloading process. When in the WinSCP window select the "Download" tab located on the top left hand side of your screen. [Figure 2]

Figure 2 Download Tab

In this next screen you will need to select the version that you would like to use. Select the WinSCP 3.7.4 version (the most recent version at the time of writing), it should be the second option, and select the link that says "download". [Figure 3]

Figure 3 WinSCP 3.7.4 Download Option

You can select the most recent version but it should be noted that any version that is accompanied by the word "beta" is an incomplete version that has not been properly troubleshooted. While this may be the most recent version it may act up at times and should be avoided.

The options in the next window will allow you to either download the software in its entirety without the installation process (.exe) or with the installation process (setup.exe). It is up to you what you would like to do. The program will run smoothly with either option. Under the 3.7.4 section (it will be in pink) select the first option; winscp374.exe, or the winscp374setup.exe which is the option right below winscp374. (denoted by the rectangular box) [Figure 4]

Figure 4 More Download Options

The next screen will ask you to pick the location closet to you; this is called your mirror. [Figure 5]

Figure 5 Mirror Selection

It is assumed that the closest mirror will be the one in North America. In Figure 5 the closest mirror was in Phoenix, AZ. This could change depending on when and where you will be downloading this software, so choose what is best for you in order to ensure a fast download.

When the download prompt appears select the option to save this program to your computer and choose an appropriate location. [Figure 6] This might take a few moments; if you do not receive this prompt on your screen there is a link that you can click on that should be at the very top of your screen.

Figure 6 Download Window

Installation

If you chose to download the winscp374setup.exe, after the initial downloading process you will be taken through an installation process where you will be asked to specify certain components of the WinSCP system. If this is true for you then you will find this section pertinent, however if you downloaded the winscp374.exe version skip to the next section entitled "Basic Setup". Even if you are not required to go through the installation process feel free to read this section as you might find some of the information covered here quite helpful and insightful.

The first window that you will be directed to is just a welcome window click "Next" to move on to the next window.

This is the license agreement window; read the license aggrement and accept the terms and hit "Next".

At the third window you will be asked to select the directory in which the program will be saved. By hitting "Enter" you can use the default directory setting. You may also specify another directory by clicking the "Browse" button and finding the directory of choice. [Figure 7]

Figure 7 Destination Determining Window

You will be given the opportunity to select certain components that will be incorporated in your WinSCP system (see Figure 8). The components offered are as follows:

The "drag & drop" option does as the name implies.

The "pageant authentication" option should always be selected.

Select the PuTTYgen option if you have or intend to use PuTTY along with WinSCP.

Figure 8 Component Selection Window

This next window deals with the folder that this program will be placed in. Just accept this setting by hitting "Next".

The next window presents the remaining additional tasks that can be selected. It is not necessary to select all the tasks listed within this window. If you will refer to Figure 9 the options that would prove helpful to any user have been selected. However these options can be adjusted based on personal preference.

Figure 9 Additional Tasks Window

The interface controls the way your screen will look after you establish a connection within the system (login). You have two options; the explore-like option has more user-friendly qualities, due to the fact that it largely resembles the windows screens that many are used to. [Figure 10]

Figure 10 Setup Interface Window

The next window will ask you to confirm that you indeed want to install this program, do so by hitting "install".

The last window is the completions screen. While this should bedefault setting make sure that the option to launch WinSCP upon installation has been selected. Finalize the process by hitting the "finish" button.

Basic Setup

Determining Your Server

You use servers each time you access your account at Purdue. These are basically where all your files and information from your career accounts are stored. Your classification as a student, in regards to your field of study, is what determines the servers that you allowed to access and use for storage purposes.

When you open the WinSCP file you will be taken to the login screen. In order to login you will need to know the appropriate server that you are authorized through Purdue to use. The next few steps will detail how to obtain that information; if you already know the servers for which you have permission move directly to the next sub-section within Basic Setup that deals with Logging In the WinSCP system.

To determine the server that you have permission to access, go to: https://www.itap.purdue.edu/tlt. On the left had side towards the bottom of the page under "Online Resources" you will see the "My Career Account" link. Select this option. [Figure 11]

Figure 11 Itap Website

You will be prompted to login to your career account. After doing so you will see a list of servers that you have permission to access, such as mentor.ics.purdue.edu. This is the "host name" that you will need to know in order to login in WinSCP. [Figure 12]

Figure 12 Itap Website (Permitted Servers)

Logging In

Opening the WinSCP program will automatically take you to the WinSCP login screen. This is the first step to connecting to the system.

To begin a connection, type in a host name (see previous sub-section, Determining Your Server). Your career account login will be entered in the "User Name" section as well as your career account password in the "Password" section. The port number should be automatically set at 22 and does not need to be adjusted. [Figure 13]

Figure 13 WinSCP login Window

When this has been entered you can select "Login" to connect to the system, or you may choose to save the login session. This option will save not only the server ("host name"), but yourlogin and password. So at any given time you or anyone else can load this session and automatically connect to that account.

You might want to load the session once before saving it; thus ensuring that you have the correct server name entered as well as password before saving the session.

You may erase a session just as easily as you saved it. Select "Stored session" from the left hand directory key (under "Session"), select the session and hit the delete button.

Be careful; anyone can use a stored session to access you career account.

TROUBLE SHOOTING

If after entering the host name and your user name and password you again prompted for your password. This means that you have either entered the wrong password or you do no have authorization to use that server. To determine which one is the case, verify that you have the correct user name and re-enter you password. If you are again prompted for your password you do not have the right server. You will need to hit cancel, reopen the WinSCP program and repeat the login steps.

If you receive a message stating that the host name does not exist then you have entered the wrong server and you will need to re-enter that in the initial login screen.

Proper Connection

To ensure a proper connection, make sure the settings as picture in Figure 14. To achieve this you will first need to check the advanced options box located in the lower left hand corner of the screen right above the "About." tab. Once this is selected the left hand side tree will expand and you will see a section entitled "Connection". Click on this and it will reveal the screen pictured in Figure 14. Change the "server timeout response" to 300secconds; the maximum. By changing this setting to 300 seconds you will be able to be idle for a longer period of time without being disconnected. However if you have confidential files it is safer to set the server response timeout to a shorter period of time.

Figure 14 Connections Options Window

Feel free to change any of these settings if you have an understanding of these functions.

Interface Options

The interface controls the way your screen will look after you establish a connection within the system (login).

If you click on the preferences option on the left hand side of the initial WinSCP screen (the directory tree), the right hand side of the screen will display your interface options. [Figure 15] You have two options; the explore-like option has more user-friendly qualities, due to the fact that it largely resembles the windows screens that many are used to.

Figure 15Preference Interface Window

Logging Off

When you are done with WinSCP, you can log off by clicking on the "Session" menu, and selecting "Disconnect", or you can simply exit with the button.

Figure16 Disconnect Window

Managing Files

This section will cover the basic operations that can be used within WinSCP to move, copy, delete, and modify files easily. These operations can be carried out in both the Norton-Commander and Explorer-like interfaces.

By right-clicking on a file and selecting "Edit" in the drop-down menu, you can use the internal editor of the system. [Figure 17]

If you select "Open", the file will be opened with your system default.

Figure 17 WinSCP Edit File Window

Internal Editor

There is an internal editor program that has been built into the WinSCP software. [Figure 18] It is relatively easy to use; somewhat similar to notepad-like complier program. This can be a handy tool for someone taking a computer science class.

- With the Unix format setting, a student can create a functional Makefile .

Figure 18 WinSCP Internal Editor

Commands

By selecting the "Commands" tab and clicking on "Open in PuTTY", you can open the same server connection in a console. [Figure 19]

- Note: you must have PuTTY installed to use this option.

The PuTTY console is a command-line interface. It is similar to, and based off of, the Unix environment. This would be an option to the internal editor that was spoken of in the former section.

Figure 19 Command Pull Down (PuTTY Initiation)

Also under the "Commands" menu is the option to keep your remote directory up-to-date with your local directory. [Figure 20]

Figure 20 Command Pull Down (Remote Directory)

You can choose to keep existing files up-to-date, or to even create files that exist on your local machine and are not yet in the remote directory.

If you decide to use the option to keep the remote directory up-to-date, it would be much safer to leave the "No confirmations" box unchecked. [Figure 21]

Figure 21 Remote Directory Update Options

File Properties

Right-click on any file and select "Properties" to choose specific properties for that file.

Permissions specify who can look at ("R"), use ("X"), and edit ("W") your files. [Figure 22]

Figure 22 File Properties

In Explorer-like panels, all the familiar views are available in the "Views" menu. [Figure 23]

Figure 23 View Selector (Explore-like Interface)

Advanced Setup

Environment

In Unix, a newline is defined by '\n', whereas in Windows, the newline also includes '\r'. Unless you have a full understanding of this concept and its uses, you should probably choose the Windows setting. Note: the server EOL setting will be used in the internal editor.

Having the Unix newline setting can be useful for someone taking a computer science class. If a student is creating a Makefile (described in detail in a later section), the compiler (most computer science students will use the gcc compiler) will read the Makefile incorrectly and throw an error .

Note: for all the following options, the "Advanced options" checkbox must be selected.

Figure24 Environment Window

Preferences

To get to the Preferences options window you will need to select the "Advanced Options" box located in the lower left hand corner of the screen right about the "About." button. Once this box has been checked the left hand side tree will expand and you will see a section entitled "Preferences" (refer to Figure 15). Click on this and it will reveal the screen pictured in Figure 25. Several options available here will be covered in the following pages: Environment; Editor; Transfer; Integration.

Environment

If the files you are managing are important and/or not easily reproduced, you may wish to display confirmations for most of these options (i.e. - deleting, overwriting, drag & drop, etc.) [Figure 25]

Figure 25 Preferences-Environment Window

Commander is a subsection of the "Preferences-Environment" option. Some of the different options available within this section are as listed. [Figure 26]

The explorer style selection allows a user to select and move files in a format consistent with a windows interface. For instance, it will allow you to drag a box over multiple files to highlight them, or hold Ctrl and click on different files to select specific ones. Without Explorer style selection multiple files can still be selected just not with the CTRL key like in the explorer interface.

Comparing directory criterions will take effect when overwriting a file. The system will know if the file has been changed based on when it was last modified and/or its size.

Figure 26 Preferences-Commander Window

Editor

You can choose what program to use when editing text files (such or Notepad, Wordpad, or Microsoft Word), or use the internal editor.

The internal editor is similar to Notepad, but will use the newline format chosen in the "Environment" section of setup.

You may choose to only have one file opened at a time, or if you need to go back and forth between files, and you do not want to keep opening and closing them, you will probably want to be able to have multiple remote files opened simultaneously.

Figure 27 Preferences-Editor Window

Transfer

If your files are not confidential, you may prefer to set read (R), write (W), and execute (X) permissions on uploaded files for ease of access.

Setting read, write, and execute permissions for all users can be especially useful if you are using WinSCP to edit your website.

Figure 28 Preferences-Transfer Window

Drag & Drop is the one of the two subsections from the Preference-Transfer option. The features within this subsection have been listed below as you read them refer to Figure 29.

If you allow moving from the remote directory, you must hold Ctrl when dragging a file from the server to keep a copy on the server.

The temporary folder may be useful until a user is comfortable with the program. Thus providing the user with a margin for error.

Figure 29 Preferences-Drag&Drop Window

Background is the second subsection from the Preferences-Transfer option. The features within this subsection have been listed below as you read them refer to Figure 30.

You can choose how many files can be transferred simultaneously. If you have a tendency to transfer many files at a time, you will probably want to set this number fairly high. If you have a slow or incapable computer, it may be better to select a low number for this option.

Files can be transferred in the background, or an extra status window can be displayed. The queue list is a small window that extends off the bottom of the main window. It gives information as to what files are being transferred and the progress of each transfer.

Figure 30 Preferences-Background Window

Integration

These options are simply for using in conjunction with Windows.

If you intend to use PuTTY, click on "." and find PuTTY on your system.

If you choose to add an upload shortcut to Explorer's 'Send to' context menu, this will allow you to right-click on a file in Windows, choose the 'Sent to' option, and send the file to a remote directory via WinSCP.

Figure 31 Preferences-Integration Window

Conclusion

This concludes the user's guide to WinSCP. It is our hope that this documentation has been not only helpful and insightful, but most importantly a guide that allows you, the user, to navigate the WinSCP program. Feel free to refer back to any section to refresh your memory or to clarify any questions that you might have about this software at any time.

Be aware that they are other forms of documentation out there that can serve in a supplementary capacity; in fact we strongly urge you to seek these documentations out if you have any linger questions that we did not address.

As always feel free to 'play around' with the software as it is our personal belief that one learns from experience; see what different functions do and how you can enhance your experience with WinSCP. Please do this carefully, so as to not damage or delete any files.