Xshell4 Manual

Xshell 4 User Guide
Secure Terminal Emualtor

NetSarang Computer, Inc.
Copyright 2011 NetSarang Computer, Inc. All rights reserved. Xshell User Manual
This product or document is protected by copyright and distributed under licenses restricting its use, copying, distribution, and decompilation. No part of this product or document may be reproduced in any form by any means without prior written authorization of NetSarang Computer, Inc. and its licensors, if any. This product or document can be changed for upgrading purpose without prior notice. Xlpd, and Xftp are trademarks of NetSarang Computer, Inc. Xmanager and Xshell are registered trademarks of NetSarang Computer, Inc. Microsoft Windows is a trademark of Microsoft. Unix is a tradeamk of AT&T Bell Laboratories. SSH is a trademark of SSH Communications Security. Secure Shell is a trademark of SSH Communications Security. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (http://www.openssl.org/)
NetSarang Computer, Inc. Republic of Korea: 16F, Prime Center, 97, Technomart-gil, Gwangjin-gu, Seoul, 143-200 United States of America: 3003 N. 1st Street, San Jose, CA, U.S.A., 95134 http://www.netsarang.com/
Table of Contents
Introduction ...........................................................................................................................................................1 Features ......................................................................................................................... 1 System requirements....................................................................................................... 3 Installation and uninstallation ........................................................................................... 3 Technical support ............................................................................................................ 4 Xshell License Agreement................................................................................................. 5 Getting Started .....................................................................................................................................................7 Creating a session ........................................................................................................... 7 Connecting to a remote host ............................................................................................ 8 Exiting Xshell .................................................................................................................. 9 Managing Sessions ............................................................................................................................................ 11 Managing sessions......................................................................................................... 11 Export sessions ............................................................................................................. 12 Import sessions ............................................................................................................ 13 Establishing Connections ...............................................................................................................................15 Connecting without a session.......................................................................................... 15 Connecting with a session .............................................................................................. 16 SERIAL connection ........................................................................................................ 16 Public Key User Authentication ...................................................................................................................19 Tunneling Service ..............................................................................................................................................21 TCP/IP port forwarding................................................................................................... 21 X11 Forwarding ............................................................................................................. 22 SOCKS4/5 Dynamic port forwarding ................................................................................ 23 Instant Tunneling .......................................................................................................... 23 Port forwarding channels ................................................................................................ 24 Working with Terminal Window ..................................................................................................................25 Copying and pasting ...................................................................................................... 25 Searching text .............................................................................................................. 27 Changing fonts.............................................................................................................. 27 Configuring text and background colors ........................................................................... 28 Configuring cursor ......................................................................................................... 29 Manipulating Xshell windows .......................................................................................... 29 Managing Multi-session .................................................................................................. 30 Managing the quick command sets .................................................................................. 31 Changing output encoding .............................................................................................. 33 Setting advanced terminal options .................................................................................. 33 Transferring Files ...............................................................................................................................................35
Table of Contents|
File transfer using SFTP.................................................................................................. 35 File transfer using ZMODEM............................................................................................ 35 Using Xftp from Xshell to transfer files ............................................................................. 36 Logging and Tracing .........................................................................................................................................37 Logging Session ............................................................................................................ 37 Tracing Session ............................................................................................................. 37 Printing Text ........................................................................................................................................................39 Using Xagent ........................................................................................................................................................41 Login with Xagent.......................................................................................................... 41 Using Xagents user keys in the remote host .................................................................... 41 Using Script ..........................................................................................................................................................43 Starting a script ............................................................................................................ 43 Stopping a script ........................................................................................................... 43 Available Script APIs ...................................................................................................... 43 xsh.Session ............................................................................................................ 43 xsh.Screen.............................................................................................................. 44 Script example ........................................................................................................ 46 Reference ..............................................................................................................................................................48 Xshell main window ....................................................................................................... 48 File menu ............................................................................................................... 49 Edit menu ............................................................................................................... 53 View menu.............................................................................................................. 55 Tools menu ............................................................................................................. 57 Window menu ......................................................................................................... 59 Help menu .............................................................................................................. 60 Toolbar buttons ....................................................................................................... 61 Address bar ............................................................................................................ 62 Links bar ................................................................................................................ 63 Session Tab............................................................................................................. 63 Terminal workspace ................................................................................................. 65 Tunneling bar .......................................................................................................... 65 Quick Commands bar ............................................................................................... 66 Compose bar........................................................................................................... 67 Session bar ............................................................................................................. 67 Status bar............................................................................................................... 67 Dialog boxes ................................................................................................................. 68 Sessions dialog box ................................................................................................. 68 New Session Properties dialog box ............................................................................ 71 Properties dialog box ............................................................................................... 72 Proxy List dialog box ................................................................................................ 99 Proxy Settings dialog box ....................................................................................... 101
Table of Contents|
ii
Expect & Send Rule dialog box ................................................................................ 102 Find dialog box ...................................................................................................... 102 Manage Layout dialog box ...................................................................................... 104 Host Keys dialog box.............................................................................................. 104 User Keys dialog box.............................................................................................. 105 User Key Properties dialog box ................................................................................ 107 User Key Generation Wizard ................................................................................... 108 SSH Security Warning dialog box ............................................................................ 113 SSH User Authentication dialog box ......................................................................... 114 Color Schemes dialog box....................................................................................... 115 Edit Color Scheme dialog box.................................................................................. 116 Forwarding Rule dialog box ..................................................................................... 117 Options dialog box ................................................................................................. 118 Clear History dialog box ......................................................................................... 125 History Settings dialog box ..................................................................................... 126 Custom Keymap dialog box .................................................................................... 127 Custom Keymap: Edit dialog box ............................................................................. 128 Quick Command Sets dialog box ............................................................................. 129 Edit Quick Command Set dialog box ........................................................................ 131 Edit Quick Command dialog box .............................................................................. 132 Session Import Wizard ........................................................................................... 133 Session Export Wizard............................................................................................ 134 Xagent ................................................................................................................. 136 Xagent Setup dialog box......................................................................................... 138 Xagent tray icon .................................................................................................... 138 Xactivator ............................................................................................................. 140 Xshell local commands ................................................................................................. 142 SFTP commands.......................................................................................................... 144 Regular expressions..................................................................................................... 144 Pattern Matches .................................................................................................... 144 The shorthand of character classes .......................................................................... 145 POSIX character classes ......................................................................................... 145 Examples .............................................................................................................. 146 Predefined shortcut keys .............................................................................................. 147 Error messages ........................................................................................................... 148 Index .....................................................................................................................................................................149
Table of Contents|
iii
Introduction
Xshell is a powerful SSH, TELNET, and RLOGIN terminal emulator for Windows platforms. It allows users to gain access to Unix/Linux hosts easily and securely on a Windows workstation. SSH (Secure Shell) protocol supports encryption and user authentication for secure connections over Internet, and it replaces legacy protocols such as TELNET and RLOGIN. Xshell has been designed to satisfy both beginners and advanced users. It adopts the standard Windows style guide for easy and convenient user interface, and it works seamlessly with other Windows applications. It also provides advanced users with powerful features such as local commands, searching with regular expressions, dynamic port forwarding, international languages and so forth. For a full list of features in Xshell, see the Features section.
Features
This section describes key features in Xshell. General
Supports SSH1, SSH2, SFTP, TELNET, RLOGIN and SERIAL protocols Runs on Windows 2000 SP4 and above Supports OpenSSH and ssh.com servers Multi-user configuration Keep alive option SOCKS4/5, HTTP proxy connection Supports Multi-session (Session tab, Session bar) Key mapping support VB Scripting support Improved Links bar Auto reconnect lost connections
Session management
Creates and manages session files for different servers Provides Sessions dialog, address bar, local prompt, and shortcut to open sessions Provides a default session for quick connections Supports connecting to multiple sessions simultaneously Address bar supports URL commands and allows you to connect to a remote host with or without a saved session Opens sessions with Xactivator Supports automatic logon and logon scripts Folder and tree view support in the Sessions dialog box
Security
RSA/DSA public key, Password, and Keyboard Interactive authentication methods Introduction |
RSA/DSA key generation wizard and import/export features SSH authentication agent forwarding using Xagent utility AES128/192/256, 3DES, BLOWFISH, CAST128, ARCFOUR, RIJNDAEL encryption methods SHA1, SHA1-96, MD5, MD5-96, and RIPEMD160 MAC algorithms zlib compression Host key management dialog box User key management dialog box
Terminal
Unicode based terminal buffer Supports VT100, VT220, VT320, XTERM, LINUX, SCOANSI, and ANSI terminals International output encoding (UTF-8) Compose bar lets you send a string of text to multiple servers simultaneously Scroll buffer up to 32,767 lines Text searching with regular expressions Scrolled copy Column mode text selection Multi-byte support in copy & paste Delimiter is used when the terminal window is double clicked Triple click selects the whole line Bold font and ANSI color escape sequences Mouse support in xterm terminal 256 color mode in xterm 256 Linux Meta key emulation Supports terminal (network) printing Configurable line spacing and margin of the terminal window
Tunneling
TCP/IP and X11 forwarding Dynamic port forwarding using SOCKS4/5 Instant Tunneling Tunneling bar allows you to monitor active forwarding channels and add new rules for the current session
Appearance
Simple and powerful user interface Adjustable toolbar Customizable Standard Buttons on toolbar Color scheme edit/import/export feature Configurable cursor color and blinking speed Font bar allows you to select a preferred font on the fly Assign frequently used strings to Quick Command buttons Introduction |
Status bar displays security-lock, session selection, network traffic information (up/down) Full Screen view Customizable transparency level
Local commands
Local Xshell prompt for advanced users Local commands such as open, ssh, sftp, telnet, and rlogin Local Windows commands such as ping, ipconfig, netstat, and nslookup Escaping to the local prompt while connecting to a remote host
Interoperability
Interoperable with Xmanager program for X11 forwarding Interoperable with Xagent program for agent authentication and forwarding Interoperable with Xftp program for file transfer Editing scroll buffer text with Notepad Menu commands to cycle through Xshell windows
File management
File send and receive via SFTP File send and receive via ZMODEM ASCII file upload Automatic session logging (including terminal code) Printing selected text, screen, or scroll buffer
System requirements

Operating System: Microsoft Windows 2000 SP4 or above Hard disk: Over 50M bytes free space Network: TCP/IP Winsock 1.1 compatible Required software: Internet Explorer 6.0 or later
Installation and uninstallation

Xshell installation program is available for download at http://www.netsarang.com/. It is packaged with the widely used InstallShield installation program, and to begin the installation process, simply run the executable file after downloading it. The Xshell installation process includes several steps that you can modify the installation options. However, in most cases, just clicking the Next button will be enough for the installation. To uninstall the Xshell program, follow the standard Add/Remove feature of Windows. In the Control Panel, double-click Add/Remove Programs, click Xshell in the program list, and then click the Change/Remove button. The uninstallation process will not remove the registry information and data files generated by users. It can be used again when you need to re-install Xshell later. If you want to remove all the files and registry information completely, you need to remove the followings explicitly:
Introduction |
Registry key:
\HKEY_CURRENT_USER\Software\NetSarang\Xshell \HKEY_CURRENT_USER\Software\NetSarang\Xmanager Enterprise
Files and folders: %APPDATA%\NetSarang\Xshell %APPDATA%\NetSarang\Xmanager Enterprise
Technical support
The overall guide and reference information are in this Help manual in detail. If you cannot find a solution in this manual, please visit our web site at: http://www.netsarang.com/support/main.html You can either post your questions on Xftp Q&A Forum or use our request support form in our online customer support page. Support request form is available at: http://www.netsarang.com/support/request_form.html We will be able to support you better if you describe your problem as detailed as possible.
Introduction |
Xshell License Agreement

This license agreement applies to the registered version of Xshell. License Agreement Carefully read the following terms and conditions before using this software. Your use of this software indicates your acceptance of this license agreement. No component part of any version of Xshell may be distributed individually, disassembled, copied, reverse engineered, or altered in any form. Software Distribution No component part of any version of Xshell may be distributed individually, disassembled, copied, reverse engineered, or altered in any form. Registered Version One registered copy of Xshell may either be used by a single person who uses the software personally on one or more computers, or installed on a single workstation used non-simultaneously by multiple people, but not both. You may access the registered version of Xshell through a network, provided that you have obtained individual licenses for the software covering all workstations that will access the software through the network. For instance, if five different workstations will access Xshell on the network, each workstation must have its own Xshell license, regardless of whether they use Xshell at different times or concurrently. Title and Copyright The software (including any images, applets, photographs, animations, video, audio, music and text incorporated into the software) is owned by NetSarang Computer, Inc., or its suppliers and is protected by Korean copyright laws and international treaty provisions. Part of this software may have been developed by a third party software supplier, which holds copyright and other proprietary rights to the software. This software is licensed to you. You are not obtaining title to the software or any copyrights. You may not sublicense, rent, or lease the software for any purpose. The license may be transferred (not resold) to another individual only if you keep no copies of the software. Disclaimer of Warranty THIS SOFTWARE AND THE ACCOMPANYING FILES ARE SOLD "AS IS" AND WITHOUT WARRANTIES AS TO PERFORMANCE OR MERCHANTABILITY OR ANY OTHER WARRANTIES WHETHER EXPRESSED OR IMPLIED. Because of the various hardware and software environments into which Xshell may be put, NO WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE IS OFFERED. Xshell is a registered trademark of NetSarang Computer, Inc.
Introduction |
Getting Started
This section explains how to create a TELNET/RLOGIN or SSH session and how to connect to remote Linux/Unix hosts. A telnet session is very easy to create, but an SSH session might require you to register a user key to the SSH server before any connection occurs. If you need user key registration for SSH sessions, see Public Key User Authentication first.
Creating a session
You can create a TELNET, RLOGIN, SSH, SFTP or SERIAL session. 1. On the File menu, click New. RESULT: The New Session Properties dialog box appears, as shown in the figure below.
Figure 1: New Session 2. In the Name box, enter a session name. Getting Started |
3. 4. 5. 6.
In the Protocol list, select an appropriate protocol. In the Host box, enter the hostname or IP address of the server. In the Port box, type or select the port number used by the remote server. Click OK. RESULT: A new session has been created and you are ready to connect to the remote host now. To connect to the remote host, see the Connecting to a remote host section.
Connecting to a remote host

Once you have created a TELNET, RLOGIN, SSH, SFTP or SERIAL session, now you can connect to the remote host. If there are no sessions created, see Creating a session first. 1. 2. On the File menu, click Open. In the session list, select the session which you want to connect to.
Figure 2: SSH User Authentication 3. 4. For the Password authentication, just enter your password in the Password box, and click OK. For the Public Key authentication, select a user key in the list and type a passphrase in the Passphrase box and click OK. Notes If there are no user keys available, see the Public Key User Authentication section.
Getting Started |
5.
For the Keyboard Interactive (Generic Message Exchange) authentication, just click OK and then generic authentication steps will follow.
You have tried to connect to the remote host using Xshell so far. If you have any problems in using Xshell, see Error messages.
Exiting Xshell
To disconnect a session, enter exit at the prompt of the terminal session, and then click Exit from the File menu. To exit Xshell, select Exit on the File menu.
Getting Started |
Managing Sessions
A session contains properties of a connection to a remote computer. By creating a session, you can specify different options for each remote computer and connect to the remote computer easily with one click. The Sessions dialog box lists all the sessions you created and allows you to create and edit sessions. You can also connect to a remote computer without creating a session. For this purpose Xshell provides a default session that is ready tRESULTo use after installation.
Managing sessions
To create a new session: 1. 2. 3. Click the File menu, and then click New. RESULT: New Session Properties dialog box opens up. Enter connection information. Click OK. Notes The created session is entered to the Sessions dialog box. You can edit the session later. To edit a session: 1. 2. 3. 4. Open the Sessions dialog box. Select the session you want to edit. On the toolbar, click Properties. Edit the session and click OK.
To change the name of a session: 1. 2. 3. Open the Sessions dialog box. Right-click on the session name you want to change. Click Rename on the menu. Notes The session name should have valid characters for a filename. To copy a session to another name: 1. 2. 3. Open the Sessions dialog box Select the session you want to save as another name. On the toolbar, click Save As.
Managing Sessions |
11
To delete a session: 1. 2. 3. Open the Sessions dialog box. Select the session you want to delete. On the toolbar, click Delete.
To create a shortcut for a session: 1. 2. 3. 4. 5. Open the Sessions dialog box. Select the session of which you want to create a shortcut. On the toolbar, click Shortcut. Browse the folder tree and select a folder to put the shortcut. Click OK.
To edit the properties of the default session: To open the Default Session Properties dialog box, do one of the following instruction:
From local shell, click the File menu, and then Properties. In the main windows toolbar, click on an arrow next to the Properties button, and then select Default Session from the list. Notes Default session is used when connecting via SSH, TELNET, RLOGIN, SFTP from local prompt and the Address bar. To use connection commands from the local prompt, see Xshell local commands. To use Address bar, see Address bar section.
To create a new session folder: 1. 2. 3. Open Sessions dialog box. Click on an arrow next to the New button, and then select Folder from the list. Type a name for the new folder, and then press ENTER.
To copy a session file to a different computer: 1. 2. 3. 4. Open Sessions dialog box. Click on the Open Session Folder button. RESULT: Folder, where sessions are saved, opens up. Find a session file (*.xsh) and copy or email it to a different computer. In the different computer, save the session file in the following folder. %APPDATA%\NetSarang\Xshell\Sessions
Export sessions
Xmanager supports exporting sessions. Sessions are exported to single file for easy import. You can import the exported session file from a different PC where Xmanager is installed and use it without extra configuration. To export sessions: 1. 2. Run Xbrowser. Click on the File menu, select the Export menu. RESULT: The Import/Export wizard dialog box opens. Managing Sessions |
12
3. 4. 5.
Select the products to export its sessions, and then click the Next button. Select the folder where the exported session file will be saved and then click the Next button. RESULT: Sessions are exported to a single file. Click the OK button to close the Import wizard.
Import sessions
Xmanager supports importing sessions. You can import sessions from the lower Xmanager versions from the same PC or the exported session file that is exported from a different PC. To import sessions: 1. 2. Run Xbrowser. Click on the File menu, select the Import menu. RESULT: The Import/Export wizard dialog box opens. 3. To import sessions from the previously installed products on the same PC: Select the From the previously installed products on this computer option, and the click the Next button. RESULT: Products and its sessions are listed. 4. 5. 3. 4. 5. 6. 7. Select the products to import sessions from and then click the Next button. RESULT: Sessions are imported and the result is displayed. Click the OK button to close the Export wizard. To import sessions from the an exported session file: Select the From the following location option. Enter the path of the exported session file or click the button to select the exported session file. Click the Next button to continue. RESULT: Products and its sessions are listed. Select the name of the products to import sessions from, and then click the Next button. RESULT: Sessions are imported and the result is displayed. Click the OK button to close the Export wizard.
Managing Sessions |
13
Establishing Connections
Xshell provides several connection methods, including local commands, Address bar, and shortcuts. You can connect to a remote computer with or without a session. If you have already created a session for a remote computer, you can just open the session to connect to the remote computer. Also, you can connect to the remote computer quickly with the default session provided by Xshell. Xshell provides telnet, ssh, sftp, rlogin and serial connection protocols and the remote computer should support one of those protocols for a successful connection. For more information on sessions, see Managing Sessions. For more information on local prompt, see Xshell local commands. For more information on Address bar, see Address bar.
Connecting without a session

You can connect to a remote computer quickly by entering a command at the Address bar or at the local prompt without creating a session. You can get the local prompt by closing the Sessions dialog box at startup. To connect to a remote computer at the local prompt: 1. Enter one of the following commands at the local prompt:
Xshell> telnet hostname Xshell> ssh hostname Xshell> rlogin hostname Notes
If the remote computer doesnt use the default port, you need to provide a port number at the end of the command. For more information on the commands, see Xshell local commands. To connect to a remote computer at the Address bar: 1. Enter one of the following commands into the Address bar:

2.
telnet://hostname ssh://hostname rlogin://hostname
Press the Enter key or click Connect. Notes You can also enter a user name and a port number at the commands. For more information on the command usage, see Address bar. If you are already connected to a remote computer, the Address bar commands will open a new Xshell session.
Establishing Connections |
15
Connecting with a session

When you connect to a remote computer repeatedly, you may find it helpful to create a session for the connection. A session allows you to connect easily to the remote computer with a single click or a command. If a session is already created, you can open it at the Sessions dialog box to connect to the remote computer. To connect to a remote computer at the Sessions dialog box: 1. 2. 3. Open the Sessions dialog box. Select the session you want to open. Click Connect. Notes If you are already connected to a remote computer, a new Xshell session will appear for the new connection. To connect to a remote computer at the local prompt: 1. Enter the following command at the Xshell local prompt. Xshell> open session
To connect to a remote computer with a shortcut: 1. Double-click the shortcut icon of a session. Notes For more information on creating a shortcut of a session, see Managing Sessions.
SERIAL connection
RS232C SERAL connection lets you use your PC to connect to UNIX machines that has no graphic card support or where direct access to console is not available. To use the SERIAL connection with Xshell, the host system must have SERIAL interface installed. To connect to a remote host using SERIAL connection: 1. 2. 3. 4. 5. Click the File menu, and then click New. RESULT: New Session Properties dialog box opens up. In Name, assign a name. From the Protocol list, select SERIAL. From Category, select SERIAL. In Port, select a RS232C parrallel port number that Xshell installed PC is connected. Generally, IBM compatible PCs use COM1 and COM2 by default. If a SERIAL port is not available as for few notebook computers users, you can use the USB-to-SERIAL devices to emulate the RS232C port. In Baud Rate, select communication speed. This value must match the value of the server. Generally, 9600 is used. Establishing Connections |
6.
16
7. 8. 9.
In Data Bits, select the size of transmitting data unit in bit. This value must match the value set in the server. In Stop Bits, select number of bits to indicate the end of data unit. Parity is used for checking the error in transmitted data unit. Select appropriate parity value depending on your server setting.
10. From the New Session Properties dialog box, click OK to create a new session. 11. You can connect with the newly created session as described in Connecting with a session
Establishing Connections |
17
Public Key User Authentication

Xshell supports a public key user authentication method that is an alternative way of identifying a user to a remote server, instead of typing a password. To use the public key user authentication method, a user generates a user key pair, consisting of a public key (which everybody is allowed to know) and a private key (which the user keeps secret and does not give to anybody). When the public key authentication is in progress, the private key is used by Xshell to generate a signature and the public key is used by the SSH server to verify the signature. That is, the possession of the private key works as an identity of the user. Also, to get authenticated by server, the user should register his or her public key to the server. For more information on user keys, see User Keys dialog box. A user key can be created in the SSH server or Xshell. If it is created in the server, import the private key to the database of Xshell. If it is created in Xshell, register the public key to the server. To create a user key pair: 1. 2. On the Tools menu, click User Key Generation Wizard. The User Key Generation Wizard will guide you through the generation process. Notes At the final step of the generation process, you can also register the public key on the server. To register a public key on the server: 1. 2. 3. 4. 5. 6. Open User Keys dialog box. Select the user key you want to register. Click Properties. RESULT: The User Key Properties dialog box appears. Click the Public key tab. In the View Public Key Format As list, select an appropriate format. Click Save As a File. Notes After the public key is saved as a file, you should copy it to the remote server. How to copy is different for each server and you may find it helpful to read Step 4: Public Key Registration. To import a private key to the database: 1. Open the User Keys dialog box.
Public Key User Authentication |
19
2. 3. 4.
Click Import. The Open dialog box appears. Select the private key file you want to import and click OK. Click OK.
To export a user key to a file: 1. 2. 3. 4. Open the User Keys dialog box. Select the user key you want to export. Click Export. The Save As dialog box appears. Enter a file name and click OK. Notes The exported file has the NetSarang User Key format and it cannot be used in the applications provided by other vendors. You may find it useful to export user keys when you uninstall Xshell or try to use the same private key in Xshell installed in another computer. To change the name of a user key: 1. 2. 3. Open the User Keys dialog box. Select the user key name you want to change. Click Rename. Notes Be sure that the key name is used as file name. Enter valid characters for a file name. To change the passphrase of a user key: 1. 2. 3. 4. 5. Open the User Keys dialog box. Select the user key you want to change the passphrase of. Click Properties. The User Key Properties dialog box appears. Click the General tab. Click Change Passphrase.
To delete a user key from the database: 1. 2. 3. Open the User Keys dialog box. Select the user key you want to delete. Click Delete.
Public Key User Authentication |
20
Tunneling Service
Xshell supports TCP/IP and X11 forwarding feature which creates a secure tunnel between your PC and another machine across an untrustworthy network. For example, you are at home and want to retrieve your e-mail from the server at work with a POP3 client program. If you connect to the server directly, your e-mail client sends your login and password information as plain text. This means that your important account information could be tapped and stolen by malicious users. To prevent this, you can use the SSH tunneling feature provided by Xshell. Xshell establishes a secure tunnel between your PC at home and the mail server at work. Then the POP3 client connects to Xshell at your local PC, rather than connecting to the remote mail server directly. Xshell forwards all traffics to the mail server over the secure tunnel and transfers all traffics received from the mail server to the POP3 client. This is called a port forwarding mechanism.
TCP/IP port forwarding

To use port-forwarding service through a secure tunnel, you should define port-forwarding rules for each TCP/IP application. Moreover, make sure that the connection is established from the client application to the server application. For example, a POP3 client in your local machine connects to the mail server in the remote host, and an X11 client in the remote host connects to the PC X server in your local machine. It is helpful to identify the direction of the connection before configuring forwarding rules. To add a new port forwarding rule to a session: 1. 2. 3. Open the Forwarding Rule dialog box. In the Type list, select a type of connection. In the Listen Port box, enter or select a port to listen. Notes The client application should connect to the listen port entered here. 4. 5. 6. 7. In the Destination Host box, enter the hostname or the IP address of the destination host in which the server application is running. In the Destination Port box, enter or select the port listened by the server application. In Description, enter the description for this tunneling rule. Click OK. Notes A newly created forwarding rule is not applied to the currently open session. To apply it dynamically, see the Instant Tunneling section. For more detailed information on each value, see Forwarding Rule dialog box.
Tunneling Service |
21
To edit a port forwarding rule: 1. 2. 3. 4. 5. 6. 7. 8. Open the Sessions dialog box. Select a session to edit its port forwarding rule. From the toolbar, click Properties. From Category, select Connection. For Protocol, select SSH. From Category, select SSH, and then Tunneling. Select a tunneling rule to edit. Click Edit.
To remove a port forwarding rule: 1. 2. 3. 4. 5. 6. 7. 8. Open the Sessions dialog box. Select a session to remove its port forwarding rule. From the toolbar, click Properties. From Category, select Connection. For Protocol, select SSH. From Category, select SSH, and then Tunneling. Select a tunneling rule to remove. Click Remove.
X11 Forwarding
X11 Forwarding is a special case of TCP/IP port forwarding. X11 protocol is used by PC X server software and connection is established from the remote host to the local PC; the opposite of other client programs such as email or telnet. By using the X11 forwarding option, you do not have to configure complex port forwarding rules required to run X11 applications over a secure tunnel. To use X11 forwarding service, you should configure both Xshell and the remote ssh server. To enable X11 forwarding service in Xshell: 1. 2. 3. 4. 5. 6. 7. 8. 9. Open Sessions dialog box. Select a session to enable its X11 forwarding service. From the toolbar, click Properties. From Category, select Connection. For Protocol, select SSH. From Category, Select SSH, and then Tunneling. Select Forward X11 connection to. If Xmanager is installed, select Xmanager. If you are using a different PC X server, select X DISPLAY, and then enter the appropriate X DISPLAY information. Click OK. Notes The X display location is the display name of the PC X server. For Xmanager, Xshell is able to
Tunneling Service |
22
find it automatically. For other PC X server programs, you need to configure it manually. In most cases, localhost:0.0 will be fine. For more information on X11 forwarding feature, see Connection: SSH: Tunneling. To enable X11 forwarding service in the OpenSSH server: 1. 2. 3. Open the /etc/ssh/sshd_config file. Set the X11Forwarding option as following: X11Forwarding yes Restart the SSH server.
To enable X11 forwarding service in the SSH server of SSH.COM: 1. 2. 3. Open the /etc/ssh2/sshd2_config file. Set the AllowX11Forwarding option as following: AllowX11Forwarding yes Restart the SSH server.
SOCKS4/5 Dynamic port forwarding

Dynamic port fowarding is one of methods for passing local network connections to SSH server. It automatically determines the host of delivery destination and port according to the SOCKS protocol. When dinymic port fowarding is used, Xshell can operate as a SOCKS proxy server. To add a new dynamic port forwarding rule: 1. 2. 3. Open the Forwarding Rule dialog box. From the Type (Direction), select Dynamic (SOCKS4/5). In Listen Port, type an port number or the name of the service. Notes Default port number of SOCKS proxy server is 1080. 4. Click OK.
Instant Tunneling
New forwarding rules are requested when the session starts, and not applied until you restart the session. Instant Tunneling feature lets you add/remove/pause/resume port forwarding for the currently open session. You can add/remove/pause/resume instant tunnels in the Tunenling bar. For more information on Instant Tunneling, refer to the "Tunenling bar" section. To add a port forwarding rule from the Tunneling bar: 1. 2. 3. 4. On the View menu, select Tunneling Bar. RESULT: Tunneling bar is displayed on the bottom of Xshell. Click the Fowarding Rules tab. Right click on the Forwarding Rules box. Select Add from the menu. Tunneling Service |
23
RESULT: Forwarding Rule dialog box opens. To remove a port forwarding rule dynamically: 1. 2. 3. 4. In the View menu, click Tunneling Bar. The Tunneling bar appears on the bottom of the Xshell window. Click the Forwarding Rules tab. In the Forwarding Rules list, right-click on the rule you want to remove. In the menu, click Remove.
To suspend a port forwarding rule: 1. 2. 3. 4. In the View menu, click Tunneling Bar. The Tunneling bar appears on the bottom of the Xshell window. Click the Forwarding Rules tab. In the Forwarding Rules list, right-click on the rule you want to suspend. In the menu, click Suspend.
To resume a port forwarding rule: 1. 2. 3. 4. In the View menu, click Tunneling Bar. RESULT: The Tunneling bar appears on the bottom of the Xshell window. Click the Forwarding Rules tab. In the Forwarding Rules list, right-click on the rule you want to resume. In the menu, click Resume. Notes You can resume only the rules you have suspended previously.
Port forwarding channels

When a channel is created with a port forwarding rule, it is displayed in the Channels list of the Tunneling bar. You are able to view all channels created and terminate unnecessary channels for the currently open session in the Tunneling bar. To terminate a forwarding channel: 1. 2. 3. 4. In the View menu, click Tunneling Bar. RESULT: The Tunneling bar appears on the bottom of the Xshell window. Click the Channels tab. In the Channels list, right-click on the channel you want to terminate. In the menu, click Terminate. Notes The channels are terminated automatically when the connection is closed. You need to terminate a channel explicitly only when it is blocked or doesnt work properly.
Tunneling Service |
24
Working with Terminal Window

Xshell provides a compact and powerful terminal window that can be used for both a command line interface to a remote computer and a local prompt interface. It also offers many convenient features including copying and pasting, searching text, changing fonts and colors, and advanced terminal options.
Copying and pasting

You can copy selected text, screen, and scroll buffer into the Windows clipboard and paste the clipboard contents to the terminal window. You can also copy the text to Notepad bypassing the clipboard. To select text area: 1. Do one of the followings:
Left-click at the beginning of the text you want to select, and drag your mouse; then release it at the end of the text. RESULT: The selected text will be changed to a reverse color. Left-click and release your mouse at the beginning of the text you want to select, then move your cursor to the end of the text to select; left-click while pressing the Shift key. Double-click on the word you want to select. RESULT: This will select the word on which the mouse cursor is located. Quickly left-click three times on the line you want to select. RESULT: This will select the whole line. Notes
Xshell supports scrolled selection that is available in most Windows applications. You can do it by dragging the mouse cursor to the top or bottom of the terminal. To select text area in column mode: 1. 2. Press the Alt key. Left-click at the start of the text you want to select, while pressing the button, drag the mouse cursor, and then release it at the end position of the text.
To copy selected text to the Windows clipboard: 1. 2. Select the text you want to copy. Do one of the following:
Click on the Smart Selection button and then select Copy. In the Edit menu, click Copy. Working with Terminal Window |
25
In the Toolbar, click Copy. Press the Ctrl+Ins key. Notes
You can paste the copied text to the terminal window as well as any Windows applications. To copy selected text to Notepad: 1. 2. Select the text you want to copy. Do one of the following: Click on the Smart Selection button and then select To Notepad. In the Edit menu, point to To Notepad and then click Selected Area.
Notes You can also copy the text in screen or scroll buffer. A Notepad window will automatically show up with the copied text. This feature does not copy the text into the clipboard. To paste the clipboard contents to the terminal: 1. Do one of the following:
In the Edit menu, click Paste. In the Toolbar, click Paste. Press the Shift+Ins key. Right-click on the terminal window. This works when you have selected the Paste the clipboard contents option of Right-button in the General tab of Options dialog box. Notes
The paste on right-click works the same way as the xterm programs paste function. To configure xterm-like copy and paste: 1. 2. 3. 4. 5. 6. Open the Options dialog box. Click the Keyboard and Mouse tab. From the Mouse Right-button, select Paste the clipboard contents. Click the Edit tab. Select Copy selected text to the clipboard automatically. Click OK. Notes The xterm program copies text to the clipboard automatically when the user selects text, and it pastes the clipboard contents to the terminal on mid-click.
Working with Terminal Window |
26
Searching text
You can search the scroll buffer for a keyword or regular expression. Using regular expressions you can search for complicated patterns. To search text with a keyword: 1. 2. 3. In the Edit menu, click Find. In the Find what box, enter a keyword to search. Click Find Next.
To search text with a regular expression: 1. 2. 3. 4. In the Edit menu, click Find. In the Find what box, enter a regular expression to search. Select the Use Regular Expression check box. Click Find Next. Notes Regular expressions are supported for advanced users. For more information on regular expression, see Regular expressions.
Changing fonts
Xshell offers easy ways to specify font face and size for the terminal text. It also provides a number of options to display bold text. Xshell allows you to select only fixed width fonts, because terminal applications should display all characters in a specified rows and columns of the terminal. Thus, available fonts depend on the version and language of your Windows. To change terminal font and size: 1. Do one of the following:
In the Standard Buttons bar, click on the Font icon and select the font and size of the font you want to use. Open the Properties dialog box, click the Appearance in the Category, and then select the name and the size of the font you want to use.
To change bold text display options: 1. 2. 3. Open the Properties dialog box. Click the Appearance in the Category. In the Bold Text area, select the option you want to use. Notes Xshell allows you to display bold text with bold colors, bold font, or both. For more information on bold text, see
27
Appearance.
Configuring text and background colors

Xshell provides a color scheme feature that allows you to set text and background colors on your preference. You can save all the colors for text, background, and ANSI color escape sequence in the color scheme database. Xshell allows you to choose a color scheme and applies it to the terminal at any time while using Xshell. You can also export and import the color schemes you created to share with other users. For more information on color scheme, see Color Schemes dialog box. To change terminal colors: 1. Do one of the following:
In the Tool bar, click Color Schemes. RESULT: The Color Schemes dialog box appears. In the dialog box, select the color scheme you want to use, and then click OK.
Open the Properties dialog box, click the Appearance in the Category, select a color scheme in the Color Scheme list, and then click OK. Notes
Xshell provides a number of default color schemes. You can modify the existing color schemes or copy and create a new one. To create a new color scheme: 1. 2. 3. 4. Open the Color Schemes dialog box. Click New. RESULT: A new color scheme is added in the list. Select the new color scheme you created. Click Edit to change the colors. RESULT: The Edit Color Scheme dialog box appears. To edit color schemes: 1. 2. 3. Open the Color Schemes dialog box. Select the color scheme you want to edit. Click Edit. RESULT: The Edit Color Scheme dialog box appears. To export color schemes: 1. 2. 3. 4. Open the Color Schemes dialog box. Select the color schemes you want to export. Click Export. RESULT: The Save As dialog box appears. Browse folders and enter the filename you want to use.
28
5.
Click Save. Notes The exported file has .xcs extension and can only be used with Xshell. You can save several color schemes in one file. The names of the color schemes are also saved in the file.
To import color schemes: 1. 2. 3. 4. Open the Color Schemes dialog box. Click Import. The Open dialog box appears. Browse folders and select the color scheme file (.xcs) you want to import. Click Open.
Configuring cursor
Xshell provides a configurable cursor. You can change the colors and blinking speed of the cursor in terminal window. To change the colors of cursor: 1. 2. 3. 4. 5. Open the Properties dialog box. Click the Appearance in the Category. In the Cursor Color list, select a cursor color. In the Text Color list, select a color for background text. Click OK.
To make cursor blink: 1. 2. 3. 4. Open the Properties dialog box. Click the Appearance in the Category. Check the Use blinking cursor option. Click OK.
To adjust the blinking speed of cursor: 1. 2. 3. 4. 5. Open the Properties dialog box. Select the Appearance in the Category. Check the Use blinking cursor option. In the Speed box, enter a blinking speed in milli-seconds. Click OK.
Manipulating Xshell windows

Xshell offers a variety of functionality to manipulate Xshell windows. You can change the startup and exit mode of Xshell window. You can also create a new Xshell window from the current one and cycle through multiple Xshell windows easily with shortcut keys.
29
To minimize to the system tray: 1. 2. 3. 4. Open the Options dialog box. Click the Advanced tab. Select the Minimize to system tray check box. Click OK to implement the change.
To exit Xshell when all connections are closed: 1. 5. 2. 3. Open the Options dialog box. Select the Advanced tab. Select the Quit application when all connections are closed check box. Click OK.
To Exit to the local prompt on connection close: 1. 2. 3. 4. Open the Options dialog box. Click the Advanced tab. Select the Exit to local shell on connection close check box. Click OK.
To create another Xshell window from the current Xshell: 1. In the Window menu, click New Window.
To switch to another Xshell window: 1. In the Window menu, click Next or Previous. Notes You can do the same job with the Alt+Right and the Alt+Left key sequences. To close all Xshell windows: 1. In the Window menu, click Close All.
To close all Xshell windows except for the current one: 1. In the Window menu, click Close All Others.
To start Xshell in the notification area: 1. 2. 3. In the Tools menu, click Options. RESULT: Options dialog box opens up. Click the Advanced tab. Select the Minimize to system tray on Xshell startup option.
Managing Multi-session
Multi-session feature keeps multiple connections within a single Xshell window and lets you switch between sessions by using either Session tab or Session bar. A new Session tab is
30
added when a new connection is made and Session tab is removed when the connection is closed. To open multi-session from a single Xshell window: 1. 2. 3. 4. Open the Options dialog box. Click the Advanced tab. Select Open multiple sessions in a single Xshell window. Click OK to save your changes. Notes You can also follow the instruction of Connecting without a session or Connecting with a session to create a new connection. To create a new connection from Session tab: 1. 2. Click Add tab button on the Session tab. Select a session from the list. RESULT: The selected session opens up in a new tab. To create a new connection from Session bar: 1. 2. Click the first icon on the Session bar. Select a session from the list. RESULT: Sessions dialog box opens up. To create a new connection using command in local shell: 1. To open a local shell tab, on the Session tab, double click on empty space or click the Session bar icon, and then select Local Shell.
On the command prompt, use ssh, telnet or sftp commands to connect to the remote hosts. To view the command line user guide, type ?. To switch between sessions in Multi-session mode: 1. To switch between sessions, do one of the followings.
Click Session Tab. Click the name of a session in the Session bar. Use Ctrl+Tab or Ctrl+Shift+Tab. Alt+Session number
To create a new connection in a new Xshell window:
1.
On the Standard Buttons toolbar, click the New Terminal button. RESULT: A new Xshell window opens up and tries making connection with the session information used in the parent session.
Managing the quick command sets

You can assign frequently used text strings to quick commands to avoid repeated keyboard inputs and use simple mouse clicks to execute the commands. To display the Quick Commands bar, on the View menu, point Toolbars, and then click Quick Commands. Working with Terminal Window |
31
To create a new quick command set: 1. 2. 3. On the Tools menu, select Quick Command Sets. RESULT: Quick Command Sets dialog box opens up. Click New. Enter a name for the new Quick Command Set. Notes To open the Quick Command Set dialog box, click on the Quick Command Set icon on the Quick Command toolbar, and then select Browse. To add a quick command to a quick command set: You can have up to 12 Quick Commands for each Quick Command set. There is no limit to the number of Quick Command set. 1. 2. 3. 4. 5. 6. 7. 8. On the Tools menu, click Quick Command Sets. RESULT: Quick Command Sets dialog box opens up. Select a quick command set in which you want to add a button. Click Edit. RESULT: Edit Quick Command Set dialog box opens up. Choose a Quick Command button and click Edit. RESULT: Edit Quick Command dialog box opens up. Specify a name in Label, and frequently used text string in Text. Click OK. To add more commands, repeat steps 4-6. In Edit Quick Command Set dialog box, click OK. Notes To edit the quick command set that is currently in use, on the Quick Commands toolbar, click the Quick Command Sets icon, and then click Edit to open the Edit Quick Command Set dialog box. In the Edit Quick Command Set dialog box, you can add, remove, and edit the quick commands. Also, you can change the order it is displayed on the Quick Commands toolbar. To add a Quick Command on the Quick Commands toolbar: 1. On the Quick Commands toolbar, click on an empty Quick Command button. NOTE: You can also enter the key combination for the empty button. RESULT: Edit Quick Command dialog box opens up. 2. 3. 4. Enter the Label for the Quick Command button. Choose an action for the button and set its options. Click OK to save.
To list different quick command set on the Quick Commands toolbar: 1. On the Quick Commands toolbar, click on the Quick Command set icon, and then from the list of quick command sets, select the one you want to use. Working with Terminal Window |
32
RESULT: Quick commands of the selected quick command set are displayed next to the Quick Command Sets Button on the Quick Commands toolbar. To select a quick command set that is displayed when a session starts: 1. 2. 3. 4. 5. Open the Properties dialog box of a session. From the Category menu, click Advanced. Select a quick command set for the session. To add or edit the quick commands, click Edit. Click OK.
Changing output encoding

Xshell supports international languages including 2-byte encodings used by Asian languages. By default it uses the default language set in the Windows system. You can change the output encoding when the encoding of the remote host is different from your Windows system. To change the output encoding of a session: 1. Do one of the following:

2.
In the Toolbar, click Output Encoding, and then click the encoding you want to use. In the Properties dialog box, in Category, select Terminal. In the Encoding list, select the display encoding. If the remote host supports unicode (UTF-8) and it is set to use UTF-8, then the encoding setting must be Unicode (UTF-8). With UTF-8 encoding, Xshell can display multiple languages simultaneously. Notes
UTF-8 encoding display:
To properly display the selected encoding, corresponding language package must be installed on Windows.
Setting advanced terminal options

Xshell offers a variety of terminal specific options for advanced users. You can change the scroll buffer size, terminal type, keypad mode and so on. To change scroll buffer size: 1. 2. 3. 4. Open the Properties dialog box. Click the Terminal in the Category. In the Scroll buffer size box, enter the number of lines you want to use. Click OK. Notes The Scroll buffer size should be in the range of 0 ~ 2,147,483,647. Setting this value to 0 will not allocate scroll buffer.
33
To change the terminal type: 1. 2. 3. 4. Open the Properties dialog box. Click the Terminal in the Category. In the Terminal Type box, select a terminal type. Click OK.
To change the startup size of the terminal: 1. 2. 3. 4. 5. 6. Open the Properties dialog box. Click the Terminal in the Category. In the Emulation area, select the Use the following terminal size when this session is established check box. In the Columns box, enter the number of columns. In the Rows box, enter the number of rows. Click OK.
To change the keypad mode: 1. 2. 3. 4. Open the Properties dialog box. From Category, select Terminal: VT Modes In the Advanced Options list, select Normal or Application Keypad from Initial Keypad Mode. Click OK.
34
Transferring Files
Xshell allows you to download or upload files with SFTP and ZMODEM protocols.
File transfer using SFTP

SFTP is a file transfer protocol based on SSH, and it provides more secure and faster file transfer compared with ZMODEM protocol. To download files with SFTP: 1. 2. Connect to a host using the sftp command: Xshell> sftp hostname In the sftp prompt, receive files using the get command: sftp:/home/user21> get filename
To upload files with SFTP: 1. 2. Connect to a host using the sftp command: Xshell> sftp hostname In the sftp prompt, send files using the put command: sftp:/home/user21> put filename
File transfer using ZMODEM

The downloaded files using ZMODEM are stored in the folder you specified or you can get a prompt dialog box to specify the folder for each download. For more information on ZMODEM, refer to the ZMODEM section. To download files with ZMODEM: 1. 2. 3. Enter the following command at the remote prompt: $ sz file1 file2 In the File menu, point to Transfer. Click Receive ZMODEM. Notes If the sz command is not available in the remote host, you may need to install it. In most cases, a similar command is available. To download files with ZMODEM from terminal: 1. 2. 3. On Xshell terminal, highlight the filename with mouse. RESULT: Smart Selection button shows near the highlighted filename. Click on the Smart Selection button. Select the Download with ZMODEM menu.
Transferring Files |
35
To upload files with ZMODEM: 1. 2. 3. 4. 5. 6. Enter the following command at the remote prompt: $ rz In the File menu, point to Transfer. Click Send ZMODEM. RESULT: The Open dialog box appears. Select the files you want to upload. Select the Send File As ASCII check box if you want to upload the files as ASCII format. Click Open.
To upload files with ZMODEM using drag and drop: 1. 2. On Windows, select a file you want to upload. Drag the file with mouse and drop it on to the Xshell terminal. RESULT: Transfer starts automatically. To change the default download folder: 1. 2. 3. 4. 5. Open the Properties dialog box. From Category, select ZMODEM. In the Receive Folder area, click Change. Select a folder in which you want to save downloaded files. Click OK.
To browse the download folder: 1. 2. 3. Open the Properties dialog box. From Category, select ZMODEM. In the Receive Folder area, click Browse.
Using Xftp from Xshell to transfer files

Xshell is interoperable with Xftp that is a secure file transfer client program. With this feature, you can easily and quickly create FTP/SFTP connections to the host that is currently connected with Xshell. For more information on Xftp, visit our website at http://www.netsarang.com. To create a new Xftp connection from Xshell: 1. 2. From Xshell, connect to the host from which you want to transfer files. In the Window menu, click New File Transfer (or click New File Transfer from the Toolbar). Notes Xftp tries using SFTP protocol when Xshell is connected with SSH protocol. It tries FTP when Xshell is connected with other types of protocol such as TELNET or RLOGIN.
Transferring Files |
36
Logging and Tracing

Xshell allows you to log the entire transcript of a session to a file. Also, a protocol tracing feature is available for debugging purposes.
Logging Session
You can log the entire terminal session as a file with or without escape sequences. With this feature, you can view and edit important data displayed on the terminal. To log a terminal session as text: 1. 2. 3. 4. 5. In the File menu, point to Log. Click Start. RESULT: The Save As dialog box appears. Enter the filename in which the log data will be saved. Clear the Receive Terminal Codes As Well As Texts check box. Click Save. Notes The logging continues until the session closes. If you want to stop the logging without closing the session, point to Log in the File menu, and then click Stop. To log a terminal session with escape sequences: 1. 2. 3. 4. 5. In the File menu, point to Log. Click Start. RESULT: The Save As dialog box appears. Enter the filename in which the log data will be saved. Select the Receive Terminal Codes As Well As Texts check box. Click Save.
To start logging when the session is connected: 1. 2. 3. 4. 5. Open the Properties dialog box for the sesion. From Category, select Logging. Select Start logging upon connection. You can define the path where the log will be saved and the filename. Click OK.
Tracing Session
With tracing options, you can trace control data transferred to or from the remote host. For the SSH protocol, algorithm exchanges and user authentication details can be displayed on the Logging and Tracing |
37
terminal window. For the TELNET protocol, a variety of option negotiation can be traced. It may be useful when something is wrong in connecting to the remote host. To turn the tracing options on or off: 1. 2. 3. 4. Open the Properties dialog box. From Category, select Trace. Select the options you want to view. Click OK.
Logging and Tracing |
38
Printing Text
Xshell allows you to print the text of the terminal window with the printer attached to your local machine. You can print the selected text, the current screen, or the entire scroll buffer. Xshell uses the same font face, size, and colors as the terminal window displays. You can also setup the margin of the printed page with the Page Setup dialog box. To setup page size and orientation: 1. 2. 3. 4. In the File menu, click Page Setup. Select the appropriate size and orientation of the page. Enter the margin of the page. Click OK to implement the changes.
To print text: 1. 2. 3. 4. In the File menu, click Print. In the Name list, select a printer. Under Print Range, select one of All, Current Screen, and Selected Area. Click OK.
Printing Text |
39
Using Xagent
Xagent is an SSH authentication agent. Xagent keeps a record of every user key in Xshell user key database, and asks for the passphrase of a user key when it is required. When the passphrase of a user key is provided, Xagent decodes the user key and holds it in memory. Thus, using Xagent, you can use the same user key several times without entering the same passphrase repeatedly. Also, using agent forwarding feature of Xshell, other SSH clients on the remote machine can get access to the user keys held in Xagent.
Login with Xagent

To configure Xshell to use Xagent: 1. 2. 3. 4. Open the Properties dialog box. From Category, select SSH. Select Use Xagent (SSH agent) for passphrase handling. Click OK.
To log on to an SSH server using Xagent: 1. 2. 3. Configure Xshell to use Xagent. Run Xagent if it is not running. Connect to an SSH server with Xshell. Notes The SSH server must support public key authentication and your public key must be registered. 4. A Passphrase dialog box appears. Type the passphrase of the selected user key. Notes You can skip the 2nd step by selecting the Launch Xagent Automatically option in the Properties dialog box, Connection: SSH. The Passphrase dialog box appears only if the status of the user key is Close. You can confirm the status of user keys in the Key List box of Xagent.
Using Xagents user keys in the remote host

When using Xagent, remote SSH clients can use the private keys in Xshell. In other words, the remote host can use the keys that Xagent has. To use the user keys held in Xagent on the remote machine, the remote SSH server should support the agent forwarding feature. To enable agent forwarding feature of ssh.com server: 1. Open the /etc/ssh2/sshd2_config file.
Using Xagent |
41
2. 3.
Set the AllowAgentForwarding option as following: AllowAgentForwarding yes Restart the SSH server. Notes OpenSSH servers automatically enable the agent forwarding feature unless user specifies the no-agent-forwarding option when they are started.
To use Xagents user keys from remote machine: 1. 2. 3. Configure Xshell to use Xagent. Run Xagent if it is not running. Log on to an SSH server with Xshell. Notes If the SSH server supports the agent forwarding feature, the environment variable for agent forwarding (SSH_AUTH_SOCK or SSH2_AUTH_SOCK) is set to a proper value. 4. Connect to another server with the SSH client program on the first server. Notes Another server must support public key user authentication, and the public key part of the user key must be stored in the server. 5. A Passphrase dialog box appears. Type the passphrase of the selected user key. Notes Passphrase dialog box opens if the status of select key is closed. You can check the status of private keys from the User Keys list in Xagent.
Using Xagent |
42
Using Script
This section covers the script feature. Script is a file that contains a set of actions you want to perform on Xshell. Script file saves you time by doing repetitive works automatically. It can be written in Visual Basic.
Starting a script
To start a script file: 1. 2. 3. From the Tools menu, point to Script and then Run. RESULT: Open dialog box opens. Select the script file. Click OK.
Stopping a script
To stop the script file from running: From the Tools menu, point to Script and then Stop.
Available Script APIs

Xshell supports the following scripting APIs. You can use them to automate Xshell to automatically perform many of the repteitive tasks.
xsh.Session
These set of functions and variables can be used to manage Xshell sessions. To use thesse functions and variables, start with xsh.Session followed by the name of the function or variable. For example, to use the Sleep function, use xsh.Sesssion.Sleep(1000). Functions Return void Function OpenSession(LPCTSTR lpszSession) Parameters lpszSession
Text value for Xshell session path or Xshell URL format.
Description
Opens a new session or URL. To open a session, use /s option in front. For example, to open a A.xsh session, use /s $PATH/A.xsh Disconnects from the current session.
void void
CloseSession() Sleep(long timeout) Timeout

Time value to make Xshell wait in millisecond.
Makes Xshell to wait for specified time.
Using Script |
43
void
LogFilePath(LPCTSTR lpszNewFilePath)
lpszNewFilePath
The file name that user want to modify including path.
Sets the log file name as new.
void
StartLog()
Starts logging for the session. Log is saved in the path specified in the LogFilePath() function. If the log file path is not specified, the default path is used.
void
StopLog()
bAppend
1: Appends to the existing log file 0: Create a new log file.
Stops from writing log.
bRaw
1: Saves the terminal codes 0: Do not save the terminal codes
Variables Name Connected LocalAddress Path RemoteAddress RemotePort Logging Type BOOL BSTR BSTR BSTR long BOOL Description
Checks whether current session is connected. Retrieves the local address. Retrieves the current session file path. Retrieves the remote address. Retrieves the remote port. Checks whether current session is writing the log file.
xsh.Screen
These set of functions and variables can be used to manage and manipulate terminal screen on Xshell. To use thesse functions and variables, start with xsh.Screen followed by the name of the function or variable. For example, to use the Clear() function, use xsh.Screen.Clear(). Functions Return void Function Clear() Parameters Description
Clears terminal display.
Using Script |
44
void
Send(LPCTSTR lpszStrToSend)
lpszStrToSend
The message that user want to send.
Sends message to terminal.
BSTR
Get(long nBegRow, long nBegCol, long nEndRow, long nEndCol)
nBegRow
The number of terminalrow as starting point.
Reads from terminal out and returns specficied section.
nBegCol
The number of terminalcolumn as starting point.
nEndRow
The number of terminalrow as ending point.
nEndCol
The number of terminalcolumn as ending point.
void
WaitForString(LPCTSTR lpszString)
lpszString
The message that will appears in terminal.
Waits for the message.
Long
WaitForStrings(VARIANT FAR* strArray, long nTimeout)
strArray
The message that will appears in terminal.
Waits for the message until timeout is reached.
nTimeout
The number user want to wait for, has the unit as ms. Return Value The number of found strings.
void
Synchronous(BOOL bSync)
bSync
1 if set synchronous screen, 0 else.
Sets synchronous screen. This function could receive the parameter referred value. For example,
xsh.Screen.Synchronous = true Variables Name CurrentColumn CurrentRow Type long long Description
Retrieves the current column. Retrieves the current row.
Using Script |
45
Columns Rows
long long
Retrieves the total columns same as terminal width. Retrieves the total row same as terminal lines
Script example
Script file Sub Main ' *** Connect the session *** xsh.Session.Open "ssh://192.168.1.17" ' "/s C:\Users\Administor\AppData\Roaming\NetSarang\Xshell\Sessions\example.xsh" xsh.Screen.Synchronous = true xsh.Screen.WaitForString "login: " xsh.Screen.Send "username" xsh.Screen.Send VbCr xsh.Session.Sleep 100 xsh.Screen.WaitForString "Password: " xsh.Screen.Send "password" xsh.Screen.Send VbCr xsh.Session.Sleep 100 ' *** Wait for Prompt Message *** xsh.Screen.WaitForString "username@password" ' *** Set File Format *** Dim app, wb, ws Set app = CreateObject("Excel.Application") Set wb = app.Workbooks.Add set ws = wb.Worksheets(1) xsh.Session.LogFilePath = "c:\example.log" xsh.Session.StartLog Dim waitStrs waitStrs = Array(Chr(10), "username@password") Dim row, screenrow, readline, itmes row = 1 ' *** Send Command *** xsh.Screen.Send "cat /etc/passwd" Using Script |
' make wait message as array
46
xsh.Screen.Send VbCr xsh.Session.Sleep 100 Dim result ' *** Read Data and Save it as an EXCEL File *** Do While true result = xsh.Screen.WaitForStrings(waitStrs, 1000) If result = 2 Then Exit Do End If screenrow = xsh.Screen.CurrentRow - 1 readline = xsh.Screen.Get2(screenrow, 1, screenrow, 40) items = Split(readline, ":", -1) ws.Cells(row,1).Value = items(0) ws.Cells(row,2).Value = items(2) row = row + 1 Wend Loop wb.SaveAs("C:\chart.xls") wb.Close app.Quit Set ws = nothing Set wb = nothing Set app = nothing xsh.Screen.Synchronous = false xsh.Session.StopLog End Sub ' save file path
Using Script |
47
Reference
This section covers complete reference information about using Xshell.
Xshell main window

Xshell main window consists of a number of controls including the title bar, menu bar, standard toolbar, session tab, terminal screen, compose bar, tunneling bar, session bar, and status bar. You can hide or show all controls from the View menu except the Title bar and the terminal workspace.
Figure 3: Xshell Main Window Reference |
48
Menu bar and Toolbar When the menu bar is hidden, you can run menu commands from the system menu on the title bar. Toolbar buttons are provided for frequently used commands. The Address bar is used for a quick connection to a remote host without creating a session. Also Xshell provides a Font bar to allow you to customize terminal fonts more conveniently. Also, users can place freqently used session in the Links bar for faster access. Terminal workspace The terminal workspace provides a command line interface to a remote computer. It also offers a local command line interface when a connection is not established. The local command line interface is a unique feature which is not provided by other competitive products. The workspace can be resized at any time and the terminal size is automatically adjusted appropriately. Also, by using Alt + Enter key, you can change to Full Screen view. When you right-click your mouse on the terminal workspace, a Shortcut menu appears. The Shortcut menu provides all the commands from the Edit menu at any place in the workspace. The scrollbar at the right side allows you to browse scroll buffer easily. Bottom area The bottom area contains a Compose bar, Tunneling bar, Quick Command and Status bar. In the Compose bar, you can complete a command line or a message before sending it to the remote computer. The Tunneling bar allows you to monitor TCP/IP forwarding channels and to add or remove forwarding rules instantly. With Quick Commands, users can save freqeuntly used commands and easily use them when needed. The Status bar shows you a handful of terminal statistics such as terminal type and size, encryption algorithms, and so on.
File menu
From the File menu, you can create and open sessions, print the terminal screen, transfer files using ZMODEM, and generate log files.
Reference |
49
Figure 4: File Menu New Opens the New Session Properties dialog box. The keyboard shortcut for New is Alt+N. Open Opens the Sessions dialog box. You can list and manage all sessions you have created from this dialog box. The keyboard shortcut for Open is Alt+O. Disconnect Disconnects an established connection. The keyboard shortcut for Close is Alt+C. Save As Opens the Save As dialog box. It saves all properties of the current session into a new session. Print Opens the Print dialog box. You can print the text in current screen, scroll buffer or selected area. Print Preview Preview the appearance of a printed page. Page Setup Opens the Page Setup dialog box. It allows you to customize the layout of a page.
Reference |
50
Import Opens Import Sessions dialog box. You can import the session file that is exported from other PC. Export Opens Export Sessions dialog box. You can export sessions to a single file so that it can be imported from other PCs. Transfer Opens the Transfer submenu.
Figure 5: Transfer Submenu Send ASCII Opens an ASCII file and send it to the remote computer. Send ZMODEM Opens the Open dialog box and send the file using ZMODEM protocol to the remote computer. You can select the transfer mode as binary or ASCII from the Open dialog box. In most cases, you should run an rz or another similar command in the terminal before choosing this command such as: # rz This command is automatically activated when the Activate ZMODEM automatically option is selected in the ZMODEM pageof the Properties dialog box. Receive ZMODEM Receives remote files into a local folder. It can receive several files at once and saves them to the download folder defined in the ZMODEM page of the Session Properties dialog box. Before choosing this command, you need to run an sz or similar command in the terminal such as: # sz file1 file2 This command is automatically activated when the Activate download automatically option is selected in the ZMODEM page of the Session Properties dialog box. Log Points to the Log submenu.
Reference |
51
Figure 6: Log Submenu Start Opens the Save As dialog box. All received data after choosing this command are logged in the selected file. Stop Stops logging and closes file. Pause Pauses temporarily. You can enable logging by clicking Resume. Resume Resumes paused logging. Open the log file Opens the log file in default text editor. Properties Opens the Properties dialog box for the current session. Exit Quits the Xshell program.
Reference |
52
Edit menu
Figure 7: Edit Menu Copy Copies selected text into the Windows clipboard. The keyboard shortcut for Copy is Ctrl+Ins. Paste Pastes the Clipboard contents into the terminal. The keyboard shortcut for Paste is Shift+Ins. Paste Selection Pastes the selected text into the terminal. This command doesnt copy the text into the clipboard. Select All Selects all the text in the screen and the scroll buffer. Select Screen Selects the text only in the current screen, not including the scroll buffer. Find Opens the Find dialog box. Xshell supports regular expressions for keywords to search for. For more information about regular expressions, refer to Regular expressions. To Notepad Opens a Notepad window and copies text to it. You can choose a text area to copy from the submenu.
Reference |
53
Figure 8: To Notepad Submenu Selected Area Copies selected area to Notepad. All Copies all the text in the current screen and the scroll buffer to Notepad. Screen Copies the text in the current screen to Notepad. Reset Cursor Restores the text cursor when it is hidden or located in an incorrect position. A problem may occur when the remote computer sends incorrect cursor operations. Reset Terminal Resets the terminal to initial state. This command will clear all text in the screen and the scroll buffer. The terminal may be garbled when binary data are dumped into the terminal.
Reference |
54
View menu
Figure 9: View Menu Toolbars - Menu Bar Shows or hides the Menu bar. You may find it useful to hide the Menu bar when you want to reduce the Xshell window as small as possible. When the Menu bar is hidden, you can find all the menu items at the system menu on the title bar. Toolbars Menu Bar Shows or hides the Menu bar. Toolbars - Standard Buttons Shows or hides the Standard Buttons bar. Toolbars - Address Bar Shows or hides the Address bar. Toolbars - Links Shows or hides the Links bar. Toolbars Lock the toolbars Locks or unlocks toolbars from changing position.
Reference |
55
Scroll Bar Shows or hides the Scroll bar. Even the Scroll bar is hidden, you can use the mouse wheel or the keyboard shortcut keys to scroll up and down. Status Bar Shows or hides the Status bar. Session Tab Shows or hides the Session tab. Session Bar Shows or hides the Session bar. Compose Bar Shows or hides the Compose bar. Quick Commands Bar Shows or hides the Quick Commands bar. Tunneling Pane Shows or hides the Tunneling pane. Layout Changes or adds/removes layouts in Xshell
Figure 10: Layout Submenu Layout - Default Switches to the default layout. Layout - Layout List Shows all available layouts stored in a system. When a layout is selected, apperance of Xshell is switched as it is defined in the selected layout. Layout - Save As Saves the current layout under a new name.
Reference |
56
Layout - Manage Opens the Manage Layout dialog box. Transparency Apply transparency effect to Xshell. Always on Top Keeps the Xshell window on top of other windows on the screen. Full Screen Changes to Full Screen view. Lock Screen Locks terminal and ignores user input untill correct password is enterred. Go to System Tray Moves Xshell to the system tray.
Tools menu
Figure 11: Tools Menu Host Key Manager Opens the Host Keys dialog box. User Key Manager Opens the User Keys dialog box.
Reference |
57
User Key Generation Wizard Opens the User Key Generation Wizard. Launch Xagent Launches Xagent, an authentication agent for Xshell. Launch Xactivator Launches Xactivator which opens and manages multiple Xshell windows. Color Schemes Opens the Color Schemes dialog box. Quick Command Sets Opens the Quick Command Sets dialog box. Scripts Starts or stops the VB script. Scripts - Run Opens the Open dialog box. You can select a script to run. Scripts - Cancel Cancels the currently running script. Options Opens the Options dialog box. The dialog box allows you to customize global options that are applied to all sessions you created.
Reference |
58
Window menu
Currently open Xshell window list
Figure 12: Window Menu New Window Opens a new Xshell window. This command allows you to run another Xshell window easily while using Xshell. Close All Closes all Xshell windows on the desktop. Close All Others Closes all other Xshell windows except the current one. Next Brings the next window to the top. You can find the next window on the Currently Open Window List. The keyboard shortcut for Next is Alt+Right. Previous Brings the previous window to the top. You can find the previous window on the Currently Open Window List. The keyboard shortcut for Previous is Alt+Left. Cascade Arranges all of the open windows so that they overlap. Tile Horizontally Arranges all of the open windows from top to bottom.
Reference |
59
Tile Vertically Arranges all of the open windows from left to right. New Terminal Opens a new Xshell window. If this menu is selected while a session is connected, Xshell attemps to make a connection with the corresponding session information. New File Transfer If Xftp is installed, it opens a new Xftp window. If this menu is selected while a session is connected, a new Xftp session is created with the corresponding session information. If Xftp is not installed, Xshell starts its own file transfer session. Currently Open Window List At the bottom of the Window menu, there is a list of currently open Xshell windows. The list is arranged in the order of creation time. In other words, the most recently created window is placed on the bottom of the list. The name on the list indicates the title of the corresponding window. Click on the listed names to jump from one session to another.
Help menu
Figure 13: Help Menu Xshell Help Opens the Xshell Help system. Visit Xshell Web Site Opens a web browser and goes to the official web site of Xshell. In the web site, you can find the latest release, updates, purchasing, and technical support information. Visit Xshell Online Forum Opens online forum where you can ask/answer Xshell related questions in the default web browser. Check for Updates Checks online for the latest updates.
Reference |
60
Register Xshell Opens the Xshell registration dialog box in which you can enter your license key. About Xshell Opens the About Xshell dialog box that contains information about Xshell and license. Also in this dialog box you can enter product key.
Toolbar buttons
Xshell provides a number of toolbar buttons for commonly used tasks and commands.
Figure 14: Toolbar The list below describes the toolbar buttons. Button New Open Disconnect Reconnect Properties Copy Paste Find Print Color Scheme Encoding Font New Terminal Name Description Opens the New Session Properties dialog box. Opens the Sessions dialog box. Disconnects the selected session. Reconnects the selected session. Opens the Properties dialog box for the currently open session or the default session when a session is not opened. Copies selected text to the Windows clipboard. Pastes the Clipboard contents to the terminal. Opens the Find dialog box. Opens the Print dialog box. Opens the Color Schemes dialog box. Lists all available encodings for output language. Displays the font name and size for terminal. You can change the font and its size. Opens a new Xshell window. If this button is clicked while a session is connected, Xshell starts a new terminal session with the corresponding session information.
Reference |
61
Button
Name New File Transfer
Description If Xftp is installed, it opens a new Xftp window. If this button is clicked while a session is connected, a new Xftp session is created with the corresponding session information. If Xftp is not installed, Xshell starts its own file transfer session. Changes Xshell to Full Screen mode. Press Alt + Enter to change back to normal window mode. Locks terminal and ignores user input until the correct password is entered. Opens the Key Map dialog box. Runs Xshell script files. Starts logging Stops logging Opens the Xshell Options dialog box. Opens the User Keys dialog box. Opens the Host Keys dialog box. Starts Xagent. Starts Xactivator. Opens the Xshell Help system.
Full Screen Lock Screen Key Map Script Start Logging Stop Logging Options User Key Manager Host Key Manager Xagent Xactivator Help
Address bar
Figure 15: Address Bar The syntax of the Address bar is: [protocol://][user@]hostname[:port][/] Available protocols are ssh, sftp, telnet, rlogin and serial. The default protocol is the one that is specified in the default session. The default ports used by the protocols are defined as following:
ssh: sftp: telnet: rlogin:
22 22 23 513
Reference |
62
Some examples are listed below.
Usage foobar.com ssh://BobSmith@foobar.com/
Description Connects to foobar.com with the protocol and port specified in the default session. Connects to foobar.com with the ssh protocol. User account is BobSmith and the default port 22 will be used. Connects to the port 12345 of foobar.com with the ssh protocol. The user account is kay. Connects to foobar.com with the telnet protocol. A user is not defined and the default port 23 is used. Connects to foobar.com with the rlogin protocol. The user account is kay and the default port 513 is used. Connects to foobar.com with the sftp protocol. The user account is kay and the default port number is used.
ssh://kay@foobar.com:12345/ telnet://foobar.com/ rlogin://kay@foobar.com/
sftp://kay@foobar.com/
Links bar
Links bar lets you easily access the sessions that are frequently used.
Figure 16: Links bar Links bar lists the sessions that are stored in the Links folder of the Session dialog box. You can save frequently used sessions in the Links folder to quickly and esaily start these sessions.
Session Tab
Session tab displays the currently open sessions and lets you select a session to work with.
Reference |
63
Figure 17: Session Tab Duplicate Creates a new session tab that is a duplication of the current session. Duplicate SSH Channel Duplicates the SSH channel without creating a new connection. Current tab and the duplicated tab shares the same SSH Channel. Rename Changes the name of selected session. Close All But This Closes all tabs excluding the selected session. Close Closes the selected session. Show Numbers Assigns numbers to sessions. You can switch between sessions using Alt + Session number. Show Terminal Title Most of the latest shell environments are capable of displaying their titles on the terminal emulators. When this option is selected, the Session tab displays the title of corresponding terminal. Show Status Icon Shows the status icon on the Session tab. Icon shows three states; Offline, Disconnected and Terminal Changed. Hide Session Tab Hides the Session tab. Reference |
64
New Tab Creates a new blank tab. This menu appears when you right click on the empty space on the Session tab. You can also create a new blank tab by double clicking the empty space on the Session tab.
Terminal workspace
The terminal workspace provides a command line interface to a remote computer. It also offers a local command line interface when a connection is not established. The local command line interface is a unique feature which is not provided by other competitive products. The workspace can be resized at any time, and the terminal size is automatically adjusted appropriately. Also, by using Alt + Enter key, you can change to Full Screen view. When you right-click on the terminal workspace, a shortcut menu appears. The shortcut menu allows you to choose all commands on Edit menu at any place in the workspace. The scrollbar at the right side allows you to browse buffered texts easily and it can also be hidden on your preference.
Tunneling bar
The Tunneling bar allows you to monitor open TCP/IP forwarding channels and add or remove forwarding rules instantly. It is meaningful only when the connection protocol is SSH. It has two tabs, Channels and Forwarding rules.
Figure 18: Tunneling Bar Channels The Channels tab contains currently open channels. You can force to terminate open channels by clicking the right button on the channels you want to close. The ID column shows a sequence number of the open channels. The number is allocated uniquely for each session in the order of creation. The Type column shows the type of each channel. The supported types are session, X11, direct-tcpip, and forwarded-tcpip. A session channel is created when a terminal is allocated. An X11 channel is created when a remote X application connects to a local X server. A direct-tcpip and forwarded-tcpip channels are created when a connection that is defined in the forwarding rules is established. The From column shows the host and port from which the connection is originating. The To column shows the host and port to which the connection is established. The Created column shows the creation time of the channels.
Reference |
65
Forwarding Rules This tab shows TCP/IP forwarding rules used on the current session. When an SSH connection is established, all the forwarding rules defined in the Tunneling page of Properties dialog box are created and listed here. The Source column shows the host and port that is forwarded to a destination port. The Destination column shows the host and port to which a source port is forwarded. The Status column shows the status of a rule. The status has four states: Waiting, Open, Failed, and Suspended. Waiting is displayed when a rule is not ready to create channels yet. If everything works well, it will be changed to Open. Open is displayed when a rule is ready to accept channel requests. Failed is displayed when a rule is incorrect, the ssh server refuses the rule, or the port is already allocated by another program. Suspended is displayed when you click Suspend from the shortcut menu. You can resume the suspended rule by clicking the right button on the rule, and then clicking Resume. Xshell allows you to add or remove forwarding rules instantly. To add a new rule or remove the existing one, just right-click the list, and then choose a command on the menu.
Quick Commands bar

Quick Commands toolbar lets you save the frequently used commands or text strings and easily reuse them when needed. Quick Commands bar displays the buttons that are saved in the quick command set for the current session. Users can create multiple quick command sets to use them when needed. To edit, click the Quick Command Sets icon on the Quick Commands bar.
Figure 19: Quick Commands Toolbar Edit Opens the Quick Command Sets dialog box. Browse Opens the Quick Command Sets dialog box. You can view all the quick command sets that are available and select a quick command set to display on the Quick Commands toolbar. Delete Deletes the selected button from the Quick Command set.
Reference |
66
Compose bar
The Compose bar allows you to complete a command or a message before sending it to the remote computer. It can be useful when you are in a chat room or enter the same command repeatedly. The Compose bar remembers all messages entered while Xshell is running and you can select one in the list. Also, by using the Compose bar, you can send a same message to all active sessions simultaneously or to all tabs within the selected Xshell or to the current tab only. When Xshell exits, all the messages are discarded permanently.
Figure 20: Compose Bar
Session bar
Session bar shows the currently open sessions and lets you choose a session to work with. Also, it lets you open and close the local shells and new sessions.
Figure 21: Session Bar
Status bar
The status bar shows the status messages of the Xshell window. As well, it contains information about the connection protocol, encription type, the terminal type, the terminal size, session in use, status of the network data transfer, the state of the CapsLock key, and the state of the NumLock key.
Figure 22: Status Bar
Reference |
67
Dialog boxes
Sessions dialog box
The Sessions dialog box allows you to create and manage sessions. By default the dialog box opens automatically when Xshell starts. You can also open it by clicking Open on the File menu.
Figure 23: Sessions A session contains properties information of a connection to a remote computer. By creating sessions, you can save your efforts to enter the remote hostname and other required information when connecting to a known computer. The toolbar contains a number of buttons to manage sessions. Button Name New Save As Cut Copy Paste Description Opens the New Session Properties dialog box. Copies the selected session as a new name. Cuts the selected session and copy it to the clipboard. Copies the selected session to the clipboard. Saves the session copied to the clipboard in the current folder. If you cut the session, the original session is saved unchanged. If you copied the session, a copy of the original session is saved. Deletes the selected session.
Delete
Reference |
68
Properties Open Session Folder Shortcut Views
Opens the Properties dialog box of the selected session. Opens the folder where sessions are saved. Creates a shortcut icon of a selected session. Shows sessions as large icons, small icons, list, or list with additional columns.
Show this dialog box at startup If this check box is selected, Xshell opens the Sessions dialog box automatically when it starts. You can clear the check box to make this feature unavailable. Connect Connects to a remote computer using the selected session and closes the dialog box. Close Closes the dialog box. Notes Xshell also supports a Default Session that can be used when you connect to a remote computer without a saved session. You cannot open and edit the default session in this dialog box. To change the default session, you can click Properties_Properties_dialog_box on the File menu while Xshell is not connected to a remote computer or from the Standard Buttons toolbar of the Xshell main window, click the arrow button next to Properties, and then select Default session.
Session menu
From the Session dialog box, right click on the session list to display the Session menu. Selecting a menu item or clicking a button from the toolbar has same effect. For description on each menu item, please refer to the toolbar table above.
Reference |
69
Figure 24: Session Menu Open Closes the current dialog box and attempts to make a connection to the selected session. Connect button has the same function. Cut Cuts the selected session and copy it to the clipboard. Copy Copies the selected session to the clipboard. Paste Saves the session copied to the clipboard in the current folder. If you cut the session, the original session is saved unchanged. If you copied the session, a copy of the original session is saved. Create Shortcut Creates a shortcut icon of a selected session. Delete Deletes the selected session. Rename Lets you change the name of the selected session. Save As Copies and saves the selected session as a new name. Reference |
70
New - Session Creates a new session. New - Folder Creates a new folder. View Shows sessions as large icons, small icons, list, or list with additional columns. Properties Opens the Properties dialog box of the selected session.
New Session Properties dialog box

The New Session Properties dialog box allows you to create a new session. You can open the dialog box by clicking New on the File menu or New button on the Sessions dialog box.
Reference |
71
Figure 25: New Session Properties It is the same as the Properties dialog box. Initial value for each field is predefined with the values in the default session. To edit the default session, click Properties on the File menu when a connection is not established. For detailed information about configuring this dialog box, see the Properties dialog box section.
Properties dialog box

The Properties dialog box allows you to customize the settings of a session. You can open it by clicking Properties on the File menu or Properties button on the toolbar. The values set in this dialog box are saved as a file, and you can open it later to connect to a remote computer.
Connection
In Connection page, you can set connection related values for a session. In most cases, you need to configure only this tab to connect to a remote computer.
Reference |
72
Figure 26: Connection Name Enter a unique name for this session. Notes The name is used when creating a file and you should enter valid characters as a filename. Protocol Select the connection protocol you want to use. Supported protocols are SSH, SFTP, TELNET, RLOGIN and SERIAL. Host Enter the hostname or IP address of a remote computer. Port Number Enter the port number of the protocol selected above. When you select a protocol from the Protocol list, the default port of the selected protocol is automatically entered into the box. If the remote computer uses another port for the protocol, you should enter a correct one. The default port of SSH and SFTP is 22, TELNET is 23, and RLOGIN is 513. Send keep alive messages while this session is connected Sends keep alive messages to the remote computer. It is useful when the connection is terminated unexpectedly on idle time. In some network environments, a gateway or a firewall system may terminate connections without notice when the connections are idle for the specified time period. Reconnect automatically if connection is terminated abruptly Xshell reconnects to the host if the connection is terminated abruptly. This option is not applied if the user disconnects the connection manually. Proxy Server Select a proxy server setting for the session. Proxy server functions as an intermediary that bridges the network you are in and the outside network. Some users are maybe required to use proxy server due to security policies such as firewall and gateway.
Connection: Authentication
In the Authentication page, you can set authentication method, user name, password and private key. Password and passphrase for the private key are stored encrypted.
Reference |
73
Figure 27: Authentication Method Select an authentication method for SSH protocol. If remote host does not support selected method, the Authentication SSH User Authentication dialog box opens during login for user authentication. User Name Enter a user name you want to log on. The user name is an account name on the remote computer. If you leave it blank, a prompt dialog box for a user name will appear on connection. Password Enter the password of the user account on the remote computer. It is used when a Password authentication is selected. If this box is blank, a prompt dialog box will appear during logon process. The password is encrypted and saved in your PC. For better security, just leave it blank. User Key Select a user key that will be used when a Public Key authentication is selected. If this box is blank, Reference |
74
a prompt dialog box will appear when required. If there is no user key in the list, create a new key and register it into the remote SSH server. Passphrase Enter the passphrase of the user key you selected. It is encrypted and saved in your PC. For better security, just leave it blank.
Connection: Authentication: Logon Prompts

To automate the login process for TELNET and RLOGIN protocol, Xshell must recognize the user name/password prompt of the remote server. Generally, you can leave these fields to their default values.
Figure 28: Logon Prompts TELNET Enter both User Name Prompt and Password Prompt to automate the TELNET logon process. Note that a space is a valid character.
Reference |
75
RLOGIN Enter Password Prompt for RLOGIN protocol. Depending on the configuration of the rlogin server, the password prompt may not be required. Note that a space is a valid character.
Connection: Logon Script

The Logon Script allows you to define the commands that will be entered to the terminal automatically. After a successful logon to the remote server, the commands you defined are executed in order of appearance in the list. This feature is very useful when you log on to another server after the first logon.
Figure 29: Logon Scripts Execute the following Expect & Send pairs. To use the automatic input feature, select this option. Add Opens the Expect & Send Rule dialog box. Once you edit a rule in the dialog box, it is added to the list. Reference |
76
Edit Opens the Expect & Send Rule dialog box and allows you to modify the current rule Remove Removes the selected rule from the list. Move Up Moves up the selected rule. Move Down Moves down the selected rule.
Connection: SSH
In the SSH page, you can set the general settings of SSH protocol.
Figure 30: SSH Page
Reference |
77
Protocol Versions Select an SSH protocol you want to use. SSH2 provides better security and more functionalities than SSH1. Use Xagent (SSH agent) for Passphrase handling Select this option to use Xagent. Xagent saves you effort of entering passphrases during the public key user authentication process.
Launch Xagent automatically Select this check box when you want to launch Xagent automatically. With this option selected, Xshell starts Xagent when required. Use zlib compression Select this check box to compress all data traffic over an SSH connection. A compression method will provide better performance in a slow network environment. Dont allocate a terminal Select this check box when you dont want to open a terminal. Use this option if you want to use tunneling only without terminal access.
Connection: SSH: Security

In Security page, you can set encryption method and MAC (Message Authentication Code).
Reference |
78
Figure 31: Security Settings Encryption Encryption algorithms are used to encrypt and decrypt network traffics. You can select a preferred encryption algorithm in the list. When you select the <Cipher List>, multiple algorithms are tried in the order appeared in the list. To edit the <Cipher List>, click Edit. MAC (Message Authentication Code) A MAC ensures data integrity and it provides increased security of SSH2 protocol over SSH1. You can select a preferred MAC algorithm in the list. When you select the <MAC List>, multiple algorithms are tried in the order appeared in the list. To edit the <MAC List>, click Edit.
Connection: SSH: Tunneling

In Tunneling page, you can set TCP/IP, Dynamic forwarding and X11 Forwarding rules. For these options to take effect, connection protocol must be set to SSH in Connection.
Reference |
79
Figure 32: Tunneling Add Opens the Forwarding Rule dialog box. It allows you to add a new TCP/IP forwarding rule for this session. Currently open sessions are not affected by the new forwarding rule. To apply it, close and open the session again. To apply the changes dynamically, refer to Tunneling bar. Edit Opens the Forwarding Rule dialog box and allows you to change the values of the rule selected in the list. The modified values are not applied to the currently open session. To apply it, close and open the session again. To apply the changes dynamically, refer to Tunneling bar. Remove Removes the forwarding rule selected in the list. The changes are not applied to the currently open session. To apply it, close and open the session again. To apply the changes dynamically, refer to Tunneling bar.
Reference |
80
Forward X11 connections to Select this check box to use the X11 Forwarding feature. It requires that the SSH server also supports this feature. And a PC X server program such as Xmanager should be installed in your PC. Xmanager Select Xmanager if it is installed in your PC. The Xshell will run Xmanager automatically when an X11 connection arrives. It also detects the display number of Xmanager automatically and you dont have to configure it manually. X display location Select this option if the PC X server installed in your PC is not Xmanager. You need to enter the DISPLAY variable used by the PC X server into the text box. If the PC X server uses a TCP port 6000, just enter localhost:0.0 as the value, and it will work in most cases.
Connection: SSH: SFTP

In SFTP page, you can set options for SFTP.
Reference |
81
Figure 33: SFTP Initial Directory Select local and remote folders to start working in after you successfully log in to a server via SFTP.
Connection: TELNET
In Telnet page, you can set options for TELNET protocol.
Figure 34: TELNET Use XDISPLOC telnet option Uses XDISPLOC Telnet option to pass display (PC X server) information to server. If you are using a PC X server such as Xmanager, use this option to execute remote X11 applications from a local PC. Display Enter the DISPLAY value to pass upon login. $PCADDR value is translated automatically to IP address of a local PC right before it is passed to server.
Reference |
82
Connection: RLOGIN
In RLOGIN page, you can set options for RLOGIN protocol.
Figure 35: RLOGIN Terminal Speed Sets the terminal speed. This value is passed to the RLOGIN server.
Connection: SERIAL
In Serial page, you can set options for SERIAL connection. Instead of using the traditional terminal environment, RS232C SERAL connection lets you use your PC to connect to UNIX machines that has no graphic card support or where direct access to console is not available. To use the SERIAL connection with Xshell, the host system must have SERIAL interface installed.
Reference |
83
Figure 36: SERIAL Port Select a RS232C parrallel port number that Xshell installed PC is connected. Generally, IBM compatible PCs use COM1 and COM2 by default. If a SERIAL port is not available as for few notebook computers users, you can use the USB-to-SERIAL devices to emulate the RS232C port. Baud Rate Select communication speed with the server. This value must match the value of the server. Generally, 9600 is used. Data Bits Select the size of transmitting data unit in bit. You can choose between 5, 6, 7, or 8 bits and this value must match the value set in the server. Generally, 8 bits are used to represent binary data. Stop Bits Select number of bits to indicate the end of data unit. Depending on the server setting, select 1, 1.5 or 2 Stop Bits.
Reference |
84
Parity You can select a way to check the error in transmitted data unit. You can choose between None, Odd, Even, Mark, or Space and this value must match the value set in the server.
Terminal
In Terminal page, you can set terminal types and other terminal related options.
Figure 37: Terminal Terminal Type Select the terminal type you want to emulate. Xshell supports VT100, VT220, VT320, ANSI, SCOANSI, LINUX, and XTERM terminal emulations. Use the following terminal size initially Select this check box if you want to define the terminal size of this session. When it is selected, the values in the Columns and Rows box are used to initialize the terminal size when this session is established. If this option is not selected, terminal size does not take effect even when the session Reference |
85
starts. Rows Enter the number of rows of the terminal. The terminal size will be adjusted to this value when the session is established. Columns Enter the number of columns of the terminal. The terminal size will be adjusted to this value when the session is established. Scrollback size Specifies the size of scroll buffer in lines. It should be an integer value between 0 (zero) and 32767. Push erased screen into scrollback When user uses command such as clear to erase screen, scroll buffer keeps the erased lines and it can be viewed by scrolling up the terminal with mouse wheel. Encoding Select the output encoding in the list. It should be the language used by the remote server. When the Default Language is selected, Xshell will use the default encoding of your Windows. This option doesnt change the keyboard input language and you need to select an appropriate IME (Input Method Editor) provided by Windows when required. Treat CJK ambiguous characters as wide Treats Chinese, Japanese, and Korean characters as wide character.
Terminal: Keyboard
In the Keyboard page, you can define strings the keyboard on users PC sends to the remote server.
Reference |
86
Figure 38: Keyboard Function Key Emulation Select a type of function keys appropriate for your terminal type. If <Default> is selected, function key is automatically assigned according to terminal type specified in the Terminal page. Specify an alternative keyboard mapping file Select a user defined keyboard file. With this option, you can manually assign a string to each function key (F1~F20) and it will be sent to server when pressed. Delete key sequence & Backspace key sequence Select a string to send when the Delete key or the Backspace key is pressed. Meta Key Emulation Setup meta key emulation for programs that use Meta keys such as Emacs.
Reference |
87
Terminal: VT Modes
In VT Modes page, you can setup the initial values for each terminal mode.
Figure 39: VT Modes Auto Wrap Mode (DECAWM) Enables the auto wrap feature when session starts. Origin Mode (DECOM) Enables Origin Mode. When this option is selected, cursor moves according to the location defined in the remote server. Reverse Video Mode (DECSCNM) Enables Reverse Video Mode when the session starts. When this option is selected, background and foreground colors are displayed reversed.
Reference |
88
New Line Mode (NLM) Enables New Line Mode when session starts. When this option is selected, the Enter key sends CR and LF together when pressed. If this option is not selected, the Enter key sends the CR only. Insert Mode (IRM) Enables Insert Mode. When this option is selected, characters received from the remote server are inserted into where cursor is located and existing characters are not erased. Echo Mode (SRM) Enables Insert Mode when session starts. When this option is selected, string is displayed on the terminal screen before it is sent to the remote server. Initial Cursor Keys Mode (DECCKM) Sets the default setting for Cursor Keys Mode. You can choose from Normal and Application. Initial Numeric Keypad Mode (DECNKM) Sets default setting for Keypad Mode. You can choose from Normal and Application.
Terminal: Advanced
In the Advanced page, you can setup the advanced options related to terminal.
Reference |
89
Figure 40: Advanced Shift key overrides the mouse usage on terminal Some applications such as VI and mc can use mouse click and drag to make selection or change directory. Even in these applications, when this option is selected, press Shift key while using mouse and Xshell uses the mouse input to perform actions such as making selection on the screen. Erase screen using the background color When erasing the screen use the background color of the current terminal instead of the color defined in the color scheme. Receive LF as CR + LF Prints both CR and LF characters to the terminal window when an LF character is received from the remote computer. Scroll to bottom on key press Scrolls down to the bottom of the screen on users keyboard input. Reference |
90
Scroll to bottom on terminal output Scrolls down to the bottom when characters are being printed on the terminal screen. Disable blinking text When this option is selected, blinking texts do not blink and are displayed with solid color. Disable terminal title change Does not allow the Xshell title to be changed. In most cases, the title is changed on the request of the remote computer to display hostname and working directory. Disable terminal printing capability When terminal printing requests are arrived from the remote server, Xshell displays the data on the terminal window without printing. Disable switching to alternate terminal screen Xshell does not use Alternate Terminal Screen which is prepared for some applications such as vi. If Alternate Terminal Screen feature is on, when the application is terminated, the terminal area goes back to the screen before the application is started. Destructive backspace Erase the character left of the cursor, and simultaneously moves the cursor to the position previously occupied by that character.
Appearance
In Appearance page, you can customize the colors and fonts used by the terminal window. It provides a Preview window for your convenience.
Reference |
91
Figure 41: Appearance Color Scheme Select the color scheme you want to use in this session. Xshell supports four default color schemes and you can change them or add a new color scheme in the Color Scheme Editor dialog box. Edit Opens the Edit Color Scheme dialog box for the selected scheme. Font Name Select the font you want to use in this session. Only fixed width fonts are listed. Font Size Select or enter the size of the font you selected. Some fonts have a fixed size and the value you entered may not work for those fonts.
Reference |
92
Bold Text Select the method you want to display bold text. Use bold color Uses the bold colors defined in the color scheme for the ANSI bold escape sequences. Use bold font Uses the bold font of the selected font for the ANSI bold escape sequences. Use bold color and font Uses both bold color and font for the ANSI bold escape sequences. Cursor Color Select a color for the text cursor. Text Color Select a text color for the text cursor. Use blinking cursor Select this check box to blink the text cursor of the terminal window. Speed Enter the blinking speed of the text cursor. Appearance Select how the cursor should look on terminal.
Appearance: Margins
In the Margins page, you can edit margins and spaces of the Xshell terminal window.
Reference |
93
Figure 42: Margins & Spacings Margins Specifies margins of the terminal window. Spacing Specifies spaces between lines and characters of the terminal window.
Advanced
In the Advanced page, you can assign a Quick Command set for the session, set trace, and logging options.
Reference |
94
Figure 43: Advanced Quick Command Sets Select the default Quick Command set for the session. Selected Quick Command set appears on the Quick Command bar when the session starts.
Advanced: Trace
In Trace page, you can setup the protocol trace option. This feature will be helpful when you want to trace detailed protocol messages to solve a specific problem. Trace messages are displayed on the terminal screen.
Reference |
95
Figure 44: Trace SSH version, algorithm exchange and user authentication Prints version exchange, encryption/decryption algorithms, compression methods, and server/user authentication details. SSH TCP/IP and X11 tunneling Prints port forwarding information on the terminal window. TELNET option negotiation Prints the detailed process of TELNET option negotiation between Xshell and the telnet server.
Advanced: Logging
In Logging page, you can configure options related to connection logging.
Reference |
96
Figure 45: Logging Start logging upon connection Starts logging automatically when session is connected to the remote host. You can choose one of the following options: Log printable text only Log terminal codes as well as printable text
Automatically create a new file in the log folder Creates a new file in the folder listed below and saves the log message. File name is automatically created. Use the following file (%n: session name, %d: date, %t: time) Save the log files in the user defined directory using the format user defines. File Path Sets the path for a log file. %n, %d, and %t are translated into name, date, and time accordingly.
Reference |
97
Browse ([]) Opens the Save As dialog box and selects a file where log data can be recorded. Overwrite when the specified file already exists If a file assigned above already exists, log data is overwritten to the file. If this option is not selected, ordered numbers are attached to the end of file names to create unique file names. Ask when the session logging starts Opens the Save As dialog box when logging starts. User can choose a file to save log.
ZMODEM
In ZMODEM page, you can setup options related to ZMODEM file transfer.
Figure 46: ZMODEM Activate ZMODEM Automatically Receives/Sends files automatically when the remote ZMODEM program starts to send/receive data.
Reference |
98
When this check box is cleared, point to Transfer on the File menu, and then click Receive/Send ZMODEM to receive/send data. Always ask before download Opens the Browse For Folder dialog box before receiving files. It allows you to specify a different folder for each download. Use the following download path Stores the downloaded files into the specified folder without asking every time. Rename automatically The downloaded files will be saved as the same name with the remote files. If the same filename is already used by another file in the folder, a unique number will be attached to the filename. Ex) before: abc.txt, after: abc (2).txt Overwrite The downloaded files will be saved as the same name with the remote files. If the same filename is already used by another file in the folder, the downloaded files will overwrite the existing files.
Proxy List dialog box

In the Proxy List dialog box, you can add, edit and remove the proxy servers. To open this dialog box, in the Connection page, click Browse in the Proxy Server section.
Figure 47: Proxy List Add Add a new proxy server
Reference |
99
Edit Edit the selected proxy server settings. Remove Remove the selected proxy server from the list.
Reference |
100
Proxy Settings dialog box

In the Proxy Settings dialog box, you can add or edit the proxy serer information. To open this dialog box, click Add or Edit in the Proxy List dialog box.
Figure 48: Proxy Settings Name Enter the name of the proxy server. This name is showed on the Proxy Server list of the Session Properties dialog box. Type Select a protocol that the proxy server uses. Host Enter the host name or IP address of the proxy server. Port Enter a port number on which the proxy server is running. User Name Enter the user name if the proxy server requires user authentication. Password Enter the password if the proxy server requires user authentication.
Reference |
101
Expect & Send Rule dialog box

The Expect & Send dialog box, you can enter a expect & send pair. You can open it by clicking Add in the Connection: Logon Script page.
Figure 49: Expect & Send Rule Expect Enter an Expect string that will be used as a prompt for the response string. Note that space is a valid character. Send Enter a Send string that will be sent to the terminal immediately after the Expect string is received. Note that blank characters are significant here. If the string is used as a password, it may be useful to select the Hide this text check box. Hide this text Displays the * marks for characters in the Send field. Select this option to hide passwod.
Find dialog box

The Find dialog box allows you to search scroll buffer for a text. You can open it by clicking Find on the Edit menu.
Reference |
102
Figure 50: Find Find what Enter the text you want to search. Up Searches the scroll buffer in the direction of bottom-to-top. Down Searches the scroll buffer in the direction of top-to-bottom. Match case Upper and lower cases are treated as different characters in the Find what box. Regular expression Select this option when you want to enter a regular expression into the Find what box. For more detailed information about regular expression, refer to Regular expressions.
Reference |
103
Manage Layout dialog box

Layout Manager allows users to rename/delete the Xshell window layouts users manually defines based on their preference. Later, users can switch between layouts by pressing Shift, Alt, and L keys together. To open this dialog box, in the View menu, point to Layout, and click Manage.
Figure 51: Manage Layout Delete Delete the selected layout. Rename Rename the selected layout.
Host Keys dialog box

The Host Keys dialog box allows you to manage the host keys of the remote hosts. You can open it by clicking Host Key Manager on the Tools menu.
Reference |
104
Figure 52: Host Keys A host key is the public key of a remote host, and you can check the fingerprint of the key to verify the validity of the host. The remote host sends its public key to Xshell when a connection is established. When the host key is valid and you trust it, you can save the host key to the database in Xshell. If a host key is not saved in the database, the SSH Security Warning dialog box will appear when you try to connect to the host. Be sure that the fingerprint of the host key is exactly the same as that of the host you want to connect to. Import Opens the Open dialog box to import a host key. An imported key will be saved into the database and listed in the Host Keys dialog box. Xshell can import SECSH Public Key format. Export Opens the Save dialog box to export the selected host key. An exported key is saved as a file and you can use it with other programs. The exported file is formatted as SECSH Public Key Format. Remove Removes the selected host key from the database. View Opens a Notepad window with the contents of the selected host key.
User Keys dialog box

The User Keys dialog box allows you to create and manage user keys. You can open it by clicking User Key Manager on the Tools menu. Reference |
105
Figure 53: User Keys A user key is comprised of two keys, a public key and a private key. The public key is registered to the remote server and the private key is saved locally for Xshell. When the public key authentication is in progress, the public key is sent to the server; if it is found on the server, the connection is allowed. You can create a user key with the User Key Generation Wizard provided by Xshell or the key generation tool on the remote server. When the user key is created on the server, obtain the private key from the server and import it on this dialog box. When the user key is created on Xshell, register the public key to the remote server. Transferring a private key over the network is not recommended and it is more secure to create it on Xshell and register a public key to the server. Import Opens the Open dialog box and saves the selected user key file in the user key database. Currently Xshell can import SSH1-RSA, OpenSSH2-RSA, OpenSSH2-DSA, SSH.COM key, and NetSarang User Key formats. Export Opens the Save dialog box and saves the selected user key as a file. The exported private keys are saved as NetSarang User Key format or OpenSSH SSH2 format. NetSarang User Key format can be imported by applications of NetSarang Computer, Inc. but cannot be used by other applications. Delete Deletes the selected user key from the database. Rename Changes the name of the selected user key.
Reference |
106
Properties Shows the properties information of the selected user key. You can see the type, length, fingerprint, and public key of the selected key. Also you can change the passphrase of the key. Generate Opens the User Key Generation Wizard.
User Key Properties dialog box

The User Key Properties dialog box shows you the properties information of the selected user key. It also allows you to change the passphrase of the key and save the public key as a file. You can open the dialog box by opening the User Keys dialog box, selecting a user key, and then clicking Properties.
General tab
The General tab shows the type, length, and fingerprint of the user key. You can change the name and passphrase of the key.
Figure 54: User Key Properties, General Tab Key Name Displays the name of the user key. You can change the name when necessary. The name should have valid characters for a filename.
Reference |
107
Change Passphrase Click this button to change the passphrase of the user key.
Public Key tab

The Public Key tab shows the public key part of the user key. You can save the public key as a file with the format you selected.
Figure 55: User Key Properties, Public Key Tab View public key format as Select a public key format in the list. Currently supported formats are SSH2OpenSSH, SSH2IETF SECSH, and SSH1. Save as a file Opens the Save As dialog box. You can save the public key in a file and register it to the SSH server later.
User Key Generation Wizard

The User Key Generation Wizard dialog box allows you to create DSA or RSA user keys step by step. You can open it by clicking User Key Generation Wizard on the Tools menu.
Reference |
108
Step 1: Key Generation Parameters

This step allows you to select the type and length of the user key.
Figure 56: User Key Generation Wizard, Step 1 Key Type Select DSA or RSA in the list. SSH1 protocol supports only RSA keys and SSH2 protocol supports both RSA and DSA. Select the one that is supported by the remote server. Key Length Select a key length in the list. Longer keys provide better security while shorter keys provide better performance. The optimal key length for most applications is 1024 bits.
Step 2: User Key Generation

This step generates a user key with the parameters selected in the previous step.
Reference |
109
Figure 57: User Key Generation Wizard, Step 2 After the key has been generated successfully you can click the Next button.
Step 3: User Key Information

This step allows you to enter the name and passphrase of the User key.
Reference |
110
Figure 58: User Key Generation Wizard, Step 3 Key Name Enter the name of the user key generated. The user key is saved as the name entered here and the name must have valid characters for a filename. Passphrase Enter the passphrase of the user key. It is used every time when you open it. IMPORTANT: You must remember it. Confirmation Enter the same passphrase again to confirm it.
Step 4: Public Key Registration

This step allows you to register the public key part of the user key to a remote server. You can also register it later on the User Keys dialog box. The private key is stored in the User Keys database of Xshell.
Reference |
111
Figure 59: User Key Generation Wizard, Step 4 Public Key Format From the list, select one of the formats: SSH1, SSH2OpenSSH, and SSH2IETF SECSH. The text box below shows you the public key in the selected format. You can copy the text and store it as a file on the remote server. Depending on the server, how to register the public key is different. In most cases, the following guideline will work for each format. SSH1: Copy the text and save it to $HOME/.ssh/authorized_keys file. Run the following commands to turn off the write permission of the files and directories: $ cd $ chmod go-w . .ssh .ssh/authorized_keys SSH2-OpenSSH: OpenSSH servers use this format. Copy the text and save it to $HOME/.ssh/authorized_keys2 file. Run the following commands to turn off the write permission of the files and directories: $ cd $ chmod go-w . .ssh .ssh/authorized_keys2 SSH2-IETF SECSH: Some commercial ssh servers such as ssh.coms use this format. Copy the text and save it to a unique name such as mypublickey.pub in the $HOME/.ssh2 directory. And then add a line into the $HOME/.ssh2/authorization file such as: Key mypublickey.pub Run the following commands to turn off the write permission of the files and directories: $ cd
Reference |
112
$ chmod go-w . .ssh2 $ chmod go-w .ssh2/authorization .ssh2/mypublickey.pub Save as a file Opens the Save As dialog box. You can save the public key file to be stored in SSH server.
SSH Security Warning dialog box

The SSH Security Warning dialog box appears automatically when you try to connect to the host that its host key is not saved in the Host Keys database.
Figure 60: SSH Security Warning It shows the fingerprint of the host key and you can follow one of three actions, Accept Once, Accept & Save, and Cancel. Accept Once Accepts the host key and connects to the host only for this connection. The host key is not saved in the database and you will see the same dialog box at the next connection. It is helpful if host key of the server is frequently changed, or the user rarely connects to the server. Accept & Save Saves the host key in the database and connects to the host. The SSH Security Warning dialog box will not show up next time. You can choose this command when the fingerprint is a correct one and you connect to the host frequently. Be sure to remove the key from the database when the remote host has changed its host key. Cancel Does not accept the host key and cancels the connection.
Reference |
113
SSH User Authentication dialog box

The SSH User Authentication dialog box allows you to choose an appropriate authentication method. It is displayed automatically when user information is required to proceed further.
Figure 61: SSH User Authentication If a user authentication method appears dimmed, it is not allowed in the remote host. To use the unavailable method, configure the SSH server in the remote host. Password The Password authentication allows you to log on using the password of your account on the remote host. For a security reason, some hosts do not allow this authentication method. Public Key The Public Key authentication requires that a public key be registered on the remote SSH server. To log on with this method, select the corresponding private key in the User Key list. Keyboard Interactive The Keyboard Interactive (Generic Message Exchange) authentication is a relatively new method that prompts instructions to enter messages for further steps.
Reference |
114
Color Schemes dialog box

The Color Schemes dialog box allows you to create and manage color schemes used by the terminal window. You can open it by clicking Color Schemes on the Tools menu.
Figure 62: Color Schemes New Creates a new color scheme and add it to the list. The colors of the new scheme are defined as the colors of the ANSI Colors on Black. Save As Copies and saves the selected color scheme as a new name. Delete Deletes the selected color scheme from the list. Edit Opens the Edit Color Scheme dialog box. You can define text and background colors as well as the ANSI colors on the dialog box. Import Opens the Open dialog box and imports color schemes from the selected file.
Reference |
115
Export Opens the Save dialog box and exports the selected color schemes to a file. The exported color schemes can be imported later.
Edit Color Scheme dialog box

The Edit Color Scheme dialog box allows you to define text, background, and ANSI colors of a color scheme. You can open it by clicking Edit on the Color Schemes dialog box.
Figure 63: Edit Color Scheme Normal Text Select the color that is used for normal text. Bold Text Select the color that is used for bold text. Usually bold text means that it is highlighted compared with normal text. Background Select the color that is used for the background area. ANSI Colors Select the colors that will be used when ANSI color escape sequences are received. The upper colors define normal colors for black, red, green, yellow, blue, magenta, cyan, and white. The lower colors define bold colors for the eight ANSI colors.
Reference |
116
Set to Default Defines the ANSI Colors as the default values.
Forwarding Rule dialog box

The Forwarding Rule dialog box allows you to add a new TCP/IP port-forwarding rule to a session. To open this dialog box, in the session Properties dialog box, select SSH for the connection method, and then click Add in the Connection:SSH:Tunneling page.
Figure 64: Forwarding Rule Type (Direction) Select Local(Outgoing), Remote(Incoming), or Dynamic(SOCKS4/5) depending on the type of the connection. Most client programs such as POP3, telnet, and ftp are running on your local machine and try to connect to the remote server. So you need to select Local(Outgoing) for those client programs. For some server programs such as PC X server, and ftp server, the connection comes from the remote server (in which ssh server is running) to your local machine (in which Xshell is running). You need to select Remote(Incoming) for this kind of connections. If you are using Xshell as a SOCKS4/5 server, select Dynamic. For an application to use SOCKS4/5 server on Xshell, you must point the PC running Xshell with Dynamic rules setup as its SOCKS server in each application.
Reference |
117
Source Host When the host is assigned to multiple IP addresses, and you want to only allow a specific IP address to forward network traffic, you can use this option to specify the IP address to forward network packets here. NOTE: Usually the PC has multiple IP addresses when it is connected via VPN. Listen Port Enter or select the port to which the client program will try to connect. For Local(Outgoing) connections, the listen port is allocated by Xshell in your local machine. When a client program in your local machine connects to the listen port, Xshell forwards the connection to the ssh server over a secure tunnel and the ssh server again redirects the connection to the destination port of the destination host. For Remote(Incoming) connections, the listen port is allocated by the SSH server in the remote host. When a client program in the remote host connects to the listen port, the SSH server forwards the connection to Xshell over a secure tunnel and Xshell again redirects the connection to the destination port of the destination host. Dynamic(SOCK4/5) forwarding works the same as Local forwarding. It uses the SOCKS protocol and its default port number is 1080. Accept local connections only Local, and Dynamic forwarding only accept connections from a PC where this session is currently running. Remote forwarding only accepts connections originated from the server where the session is connected to. Destination Host Enter the hostname or IP address of the host to which you want to forward connections. If you want to forward a POP3 connection, the destination host will be the host in which the mail server is running. For Incoming connections, it will be localhost in most cases. Destination Port Enter the port number of the destination host to which you want to forward connections. If you want to forward a POP3 connection, the destination port will be the port the mail server is listening (the default POP3 port is 110). Destination port is not needed for Dynamic port forwarding. Description Enter the description for the selected forwarding rule.
Options dialog box

The Options dialog box allows you to customize the global options that will be applied to all sessions. You can open it by clicking Options on the Tools menu.
Reference |
118
The Options dialog box contains a number of tabs to subdivide options into related groups.
General tab
The General tab has a number of options for general behavior of the Xshell window.
Figure 65: Options, General Tab Session: Session Folder Path Select where to save Xshell sessions. If you select a network folder, you can share the sessions with other users. Session: Sessions to open on startup Select the sessions you want to start automatically when Xshell starts. Address Bar Select the default protocol for the Address bar to use when no protocol is specified.
Reference |
119
Keyboard and Mouse tab

In the Keyboard & Mouse tab, you can define the customized menu and choose to use shortcut keys.
Figure 66: Options, Keyboard and Mouse tab Key Mapping Sets the user defined keys combinations. Mouse Middle-button Perfrom one of the following actions when the middle mouse button is clicked in the terminal window.
Do nothing Open the popup menu Paste the clipboard contents (Default)
Reference |
120
Mouse Right-button Perform one of the following actions when the right mouse button is clicked in the terminal window.
Do nothing Open the popup menu (Default) Paste the clipboard contents
Delimiters Sets the delimiter words that are used when selecting text with double-click. Copy selected text to the clipboard automatically Copies selected text into the clipboard automatically. You dont have to click Copy on the Edit menu when this option is selected
View tab
In the Window tab, you can set a number of options related to Xshell behavior.
Reference |
121
Figure 67: Options, Window tab Opacity Configure the transparency level of Xshell. As this value gets smaller, Xshell becomes more transparent. This option takes effect when Transparency is selected in the View menu. Make window opaque on mouse over When this option is selected, the Xshell window is displayed opaque when mouse is over the Xshell window regardless of the trancparency setting. Always on top when transparent Places Xshell on top of all windows while it is transparent Display Session Tab in Full Screen Mode Displays the Session tab while Xshell is in full screen mode. Display Scroll Bar in Full Screen Mode Displays the scroll bar while Xshell is in full screen mode. Use customized menu Use customized Xshell menu. With this feature, you can customize the menu apperance the way you prefer and also define new shortcut keys.
Reference |
122
Advanced tab
Reference |
123
Figure 68: Options, Advanced Tab English on ESC Switches to English input mode when the ESC key is entered. Only works if you are using nonEnglish input method. Disable bell sound Disable the bell sound. Use the Smart Selection button for easy copy and file download When enabled, Xshell shows the Smart Selection button near the highlighted text on terminal. You can easily copy, paste selection to prompt and download the hightlight file. Minimize to system tray If you click minimize button with this option selected, Xshell is minimized to the system tray area.
Reference |
124
Display the Session tab in Full Screen mode Displays the Session tab in full screen mode. When Xshell is in Full Screen mode, the Session tab appears on the top of the screen. Display the scroll bar in Full Screen mode Displays the scroll bar in the full screen mode. When Xshell is in Full Screen mode, the scroll bar appears. Cascade Windows with the size of the current window Uses the current window size to cascade Xshell windows. When this option is not selected, Xshell windows are cascaded in default size. Run Xshell on Windows startup Start Xshell automatically when Windows starts. Minimize to the System tray on Xshell startup Puts Xshell in the System Notification area when Xshell starts. Open multiple sessions in a single Xshell window Opens multiple sessions in a single Xshell window. You can use the Session tab and Session bar to switch between open sessions. Confirm connection close when Xshell exits If you try to exit the program with this option selected, Xshell asks for your confirmation to disconnect all sessions before exiting. If this option is not selected, Xshell will exit without your confirmation even if sessions are still connected. Quit application when all connections are closed. Closes Xshell when all connections are closed. Exit to local shell on connection close If a connection is closed and this option is cleared, Session tab remains open with local shell state. Local shell session displays the Xshell prompt in the terminal window and you can use commands such as open, telnet, ssh, ping and etc. Type help to view the list of available commands. Quit Xshell when all connections are closed Exits from Xshell when the last connection is closed.
Clear History dialog box

In the Clear History dialog box, you can erase history for the Address bar, Compose bar, Local Shell, and connection log.
Reference |
125
Figure 69: Clear History Dialog Box Address Bar History Erases the history for the Address bar. Compose Bar History Erases the history for the Compose bar. Local Shell History Erases the history for the Local Shell. Connection Log Deletes the connection log file.
History Settings dialog box

In the History Settings dialog box, you can set to save the information of connected server, connection protocol, time of connection, disconnection, and connection duration to a user defined file.
Reference |
126
Figure 70: History Settings Dialog Box Connection Log Enables the connection logging. Select a file to save the log file. Clear All History on Exit When enabled, Xshell deletes the connection log file before exiting.
Custom Keymap dialog box

In the Custom Keymap dialog box, you can define the custome key combinations.
Reference |
127
Figure 71: Custom Keymap Dialog Box Category Enter the key combination in the category field. Current Key Settings Shows the list of current key settings.
Custom Keymap: Edit dialog box

In the Edit dialog box, you can define the function, action and parameters for the custom key.
Reference |
128
Figure 72: Custom Keymap Edit Dialog Box Function Select which function the cutom key will perform. You can choose between Menu, Send String, Run Script, Launch Application, TELNET, SSH, and VT. Action Each function requires different action. For instance, for the Menu function, you are required to choose an menu item. And, for the Send String function, you need to enter the text string to send. For TELNET, SSH and VT, there are no action required. Parameter For the Launch Application function, the Paramter field is enabled. You can enter the extra parameters to pass them to the application.
Quick Command Sets dialog box

Quick Command Sets dialog box lets you add/edit/delete and also import/export the quick command sets. To open this dialog box, in the Tools menu, click Quick Command Sets.
Reference |
129
Figure 73: Quick Command Sets New Creates a new quick command set. Save As Saves the selected command set as a new one. Edit Opens the Edit Quick Command Set dialog box and edits the selected quick command set. Rename Changes the name of the selected quick command set. Delete Removes the selected quick command set. Import Opens the Open dialog box to import the quick command set from a file. Export Opens the Browse for Folder dialog box to save the selected quick command set to a file.
Reference |
130
Edit Quick Command Set dialog box

Edit Quick Command Set dialog box allows you to add, edit or remove quick commands from the existing quick command set. Also, you can change the sequence of the quick commands displayed on the Quick Commands toolbar.
Figure 74: Edit Quick Command Set Add Opens the Edit Quick Command dialog box and adds a new quick command. Duplicate Duplicates the selected quick command. Remove Removes the selected quick command. Edit Opens the Edit Quick Command dialog box to edit the selected quick command. Move Up Moves up the selected quick command by one. On the Quick Commands toolbar, it moves to the left by one space.
Reference |
131
Move Down Moves down the selected quick command by one. On the Quick Commands toolbar, it moves to the right by one space.
Edit Quick Command dialog box

Edit Quick Command dialog box allows you to set the label and the text to send. You can open it by clicking Edit on the Edit Quick Command Set dialog box.
Figure 75: Edit Quick Command Label Specifies label for the quick command that will be displayed. Text Specifies text that will be sent when a user clicks the quick command. Append CR (Carriage Return) Appends CR before sending text when a user clicks the quick command.
Reference |
132
Paste the content of the following text file Point to a text file that will be sent to the server when the Quick button is clicked. Command Enter the command to execute when the Quick button is clicked. Parameter Enter parameter to pass when executing the command.
Session Import Wizard

The Session Import Wizard allows you to import sessions that are created from other computers. You can start the wizard by clicking Import from the File menu.
Step 1: Select import mode

In this step, choose how you want to import sessions.
Figure 76: Session Import Wizard, Step 1 From the following location Select this option to import the sessions with an exported session file from another computer.
Reference |
133
Step 2: Importing sessions

You can view the progress and status of the current import process.
Figure 77: Session Import Wizard, Step 2 Progress You can view the progress of import process. As each session is copied, its result is displayed on the screen. Also, number of files imported is summarized at the end of the process.
Session Export Wizard

The Session Export Wizard allows you to export sessions. You can start the wizard by clicking Export from the File menu.
Step 1: Select where to save the exported file

In this step, you can select the name and folder in which the exported file will be saved.
Reference |
134
Figure 78: Session Import Wizard, Step 1 Path Enter the filename and path in which the exported session file will be saved.
Step 2: Exporting sessions

You can view the progress and status of the current export process.
Reference |
135
Figure 79: Session Export Wizard, Step 2 Progress You can view the progress of export process. As each session is copied, its result is displayed on the screen. Also, number of files imported is summarized at the end of the process.
Xagent
Xagent is an SSH authentication agent program for both SSH.COM and OpenSSH servers. It holds private user keys and interacts with Xmanager, Xshell and Xftp programs to support SSH authentication forwarding service. You can open it by clicking Tools on the menubar, clicking Launch Xagent, and then double-clicking Xagent icon in the system tray. When Xshell opens a session with a Public Key User Authentication, it requests a private user key from Xagent. Once you enter a passphrase for the requested user key, Xagent remember the passphrase and offers the key to multiple Xshell sessions. Using Xagent you need to enter the passphrase just once for multiple sessions. Xagent also works as an SSH authentication server for SSH agent forwarding feature. You must use the SSH agent forwarding feature when connecting to a different remote host from the first remote host. Basically your private key is only held in your local PC and an SSH client program on the first server can not connect to a second machine. Using SSH agent forwarding feature the SSH client program on the first server requests a private key from Xagent to enter into the second server.
Reference |
136
Figure 80: Xagent Start/Stop Starts or stops the authentication agent server. Setup Configures the options of Xagent. User Keys All user keys are listed in this list. The Status column indicates that the key is Open or Close. Open means that the user have entered the passphrase of the key and for subsequent requests the user does not have to enter the passphrase again. Manage Keys Opens the User Keys dialog box so that users can perform various user key-related tasks such as create, delete, import and so on. Show Log/Hide Log Expands(or collapses) the Xagent dialog box to show (or hide) the Log Messages box.
Reference |
137
Xagent Setup dialog box
Figure 81: Xagent Setup Port Number Select a port number that the authentication agent server will use. Use Default Assigns the default value(5435) into the Port Number box. Start up the server when Xagent starts Starts the authentication agent server when Xagent starts. Automatically run Xagent when I log on to Windows Runs Xagent when Windows starts.
Xagent tray icon

When you launch Xagent, an icon is created in the system tray area as the following Figure. Xagent keeps running after closing the Xagent dialog box. To exit from Xagent or to open Xagent dialog box, use the menu of the tray icon. Right click on the tray icon to display the menu.
Figure 82: Xagent Tray Icon and Menu
Reference |
138
Open Xagent Opens the Xagent program. Exit Exits from Xagent.
Reference |
139
Xactivator
Xactivator starts as a tray icon in the system tray area. With Xactivator, you can easily open up a new Xshell window or start a new session. You can also use Xactivator to open/close Xshell windows that are open. Start Xactivator by selecting Launch Xactivator from the Tools menu.
Figure 83: Xactivator Tray Icon and Menu New Xshell Opens a new Xshell window. Use this to easily open up a new Xshell window. Window Lists the currently open Xshell windows in submenu. When a session is selected from the list, it is displayed on the top. Minimize All Minimizes all Xshell windows Restore All Restores all Xshell windows to its original size. Close All Exits from all Xshell. Sessions Lists all sessions created in Sessions dialog box in submenu. When a session is selected from the list, Xactivator attempts to make a connection with selected session information. Open Opens the Sessions dialog box. Reference |
140
Auto Start Xactivator automatically starts when the user logs onto Windows. Exit Exits from Xactivator.
Reference |
141
Xshell local commands

Xshell provides a number of local commands for professional users who are accustomed to terminal environments.
Figure 84: Xshell Local Commands By default an Xshell prompt appears on the terminal window when a connection to a remote host is not established. When a connection is already established, you can escape to the local prompt by pressing Ctrl+Alt+] key sequence. To return to the remote mode, you can just run exit or press Ctrl+D key sequence. The complete command list is available below. Command Description
Reference |
142
Command help ? new open [session]
Description Displays the command list on the terminal window. Opens the New Session Properties dialog box. Establishes a connection with the session specified or opens the Sessions dialog box when a session is not specified. If session is specified, Xshell opens the Properties dialog box of the session. Otherwise, Xshell opens the Default Properties dialog box. Lists all sessions and their information that are available for the current working directory. Changes the working directory Erases screen, history of the Address bar, history of the Compose bar. Quits the Xshell program or returns to the remote mode. Establishes an ssh connection to the specified host. The default port is 22 when it is not specified. Establishes an sftp connection to the specified host. The default port is 22 when it is not specified. Establishes a telnet connection to the specified host. The default port is 23 when it is not specified. Establishes an rlogin connection to the specified host. The default port is 513 when it is not specified. Runs the ipconfig command of Windows. Runs the ping command of Windows. Displays the route of a packet until it reaches the host. Runs the netstat command of Windows. Runs the nslookup command of Windows.
edit [session]
list
cd clear exit quit ssh [user@]host [port]
sftp [user@]host [port] telnet host [port] rlogin [user@]host [port] ipconfig ping host tracert host netstat nslookup
Reference |
143
SFTP commands
Xshell provides a UNIX/LINUX-like secure FTP connection method for advanced users. After an SFTP connection is established, enter help to list all commands you can run at the SFTP prompt. Commands get file1 [file2] [file3] put file1 [file2] [file3] mv path1 path2 rename path1 path2 mkdir directory rmdir directory rm file pwd lpwd cd directory lcd directory ls [directory] lls [directory] explore [directory] help [command] Makes a directory on the remote host. Removes a directory on the remote host. Removes a file on the remote host. Prints the working directory of the remote host. Print the working directory of the local host. Changes the remote working directory. Changes the local working directory. Lists files on the remote host. Lists files on the local host. Browse a local directory using Windows Explorer. Lists the list of commands or shows help of the specified command. Quits the SFTP connection. Descriptions Downloads files from the remote host. Uploads files to the remote host. Moves/renames a file or directory on the remote host.
bye exit quit
Regular expressions
This section describes the regular expression syntax that can be used in the Find dialog box.
Pattern Matches
Pattern . [abc] [a-z] a, b or c. Any character a to z inclusive. Description Any one character except newline character.
Reference |
144
Pattern [^ac] (x) X* X+ X{n,m} X{n} X{n,} X|y xy ^ \A $ \z \Z \< \b \> \B Any character except a and c.
Description x, where x might be any regular expression. Zero or more occurrences of x, where x may be any regular expression. One or more occurrences of x, where x may be any regular expression. Between n and m occurrences of x, where x may be any regular expression. n occurrences of x, where x may be any regular expression. n or more occurrences of x, where x may be any regular expression. x or y, where x and y may be any regular expression. xy, where x and y may be any regular expression. Beginning of a line. Beginning of a line. End of a line. End of a line. End of a line. Beginning of a word. Beginning of a word. End of a word. End of a word.
The shorthand of character classes

Class \w \W \s \S \d \D Word [a-zA-Z0-9_] Not word [^a-zA-Z0-9_] Whitespace Not whitespace Digit [0-9] Not digit [^0-9] Description
POSIX character classes

Class [:alnum:] [:alpha:] [:blank:] [:cntrl:] [:digit:] Alphabetic. Same to the [a-zA-Z]. Spaces or tabs. Any control characters. Numeric digits. same to the [0-9]. Reference | Description Alphanumeric. same to the [a-zA-Z0-9].
145
Class [:graph:] [:lower:] [:print:] [:punct:] [:space:] [:upper:] [:xdigit:]
Description Any visible characters. (no whitespace) Lower-case alphabetic. same to the [a-z]. Non-control characters. Punctuation characters. Whitespace. Upper-case alphabetic. same to the [A-Z]. Hex digits. same to the [0-9a-fA-F].
Examples
Expression [0-9]+ (foo)|(bar) \.html$ ^\. One or more numeric characters. Either "foo" or "bar". Any string ending in ".html". Any string starting with a period. Description
Reference |
146
Predefined shortcut keys

The list below describes the keyboard shortcut keys defined in Xshell. Shortcut key Alt + N Alt + O Alt + C Alt + Enter Alt + D Alt + L Alt + 1~9 Alt + Right Alt + Left Ctrl + D Ctrl + Alt + ] Ctrl + Alt + T Ctrl + Alt + F Ctrl + Tab Shift + Home Shift + End Shift + PgUp Shift + PgDn Shift + Up Arrow Shift + Down Arrow Description Same as New on the File menu. Same as Open on the File menu. Same as Close on the File menu. Changes to Full Screen view. Moves the keyboard focus to the Address bar. Switchs layout. Moves between the session tab. Same as Next on the Window menu. Same as Previous on the Window menu. Exit the Xshell on the local prompt. Escape to the local prompt while connecting to a remote computer. Same as New Terminal on the Window menu. Same as New File Transfer on the Window menu. Switches to the next session within the same Xshell window. Scroll to Top. Scroll to Bottom. Scroll Page Up. Scroll Page Down. Scroll Up. Scroll Down.
Reference |
147
Error messages
Could not connect to 'hostname': Unknown host. Make sure that the hostname is a valid host name. You may try to enter the IP address instead of hostname. Could not connect to 'hostname' (port #): Connection failed. Make sure that the remote host is ready. Also check if the port number is the one that is used by the remote server. Unable to initialize WinSock DLL. Make sure that your WinSock is compatible with version 1.1. This error might happen when your computer has no LAN interface, the network driver or TCP/IP module have not been installed. Check if the Internet connection is working properly before running Xshell. Failed to create user data folder 'xxx'. You may not have the permission to create a file in the folder or the disk space may not be enough. Remote server does not support SSH2 protocol. Continue with SSH1 protocol? The remote server may support only SSH1 protocol. You need to configure your session to use SSH1. Failed to compress or decompress outgoing packets. This message is displayed when a network error occurs or a hostile attacker modifies network data. Try to turn off the zlib compression option in the session properties. The server sent an unexpected packet. (expected XXX, got YYY) This error occurs when the packet received is not valid or not supported in the current version of Xshell. For further support, send the error message to our support team. The server sent an invalid host key. The host key of the remote server is invalid or has been corrupted. Make sure that the host key is installed correctly in the SSH server. The MAC (Message Authentication Code) of a packet is incorrect. This message is displayed when a hostile attacker tries to modify network data. Try using a different encryption algorithm. The padding size of a packet is incorrect. The packet has been corrupted during transmission. If the problem persists, there may be an internal error in the SSH client or server. No matching Cipher, MAC, or Compression algorithm found. The SSH server doesnt support the algorithms you selected in the session property. Try using other algorithms. Reference |
148
The server rejected the session key. This may be due to a protocol error in the SSH client or server. Contact the vendor of each program. The server sent a bad RSA challenge. This may be due to a protocol error in the SSH client or server. Contact the vendor of each program. The server sent a disconnect packet. Reason of the problem. (Code: XXX) This may be caused by many reasons. There may be too many connections to the SSH server, or you may have entered an illegal user name. The exact reason follows the message. The server rejected a request for user authentication service. The SSH server does not support user authentication. Xshell cannot connect to this type of server.
Index
Address bar, 62 Appearance configuration, 91 Authentication, 73 Bold text, 93 Channel, 65 Colors Color Schemes dialog box, 115 Creating color schemes, 28 Edit Color Scheme dialog box, 116 Editing color schemes, 28 Exporting color schemes, 28 Importing color schemes, 29 Compose bar, 67 Compression, 78 Connecting with sessions at the local prompt, 16 at the Sessions dialog box, 16 with a shortcut, 16 Connecting without a session at the Address bar, 15 at the local prompt, 15 Connection configuration, 72 Copying and pasting Column mode selection, 25 Copying to Clipboard, 25 Copying to Notepad, 26 Pasting to the terminal, 26 Selecting text, 25 Cursor Adjusting cursor blinking speed, 29 Changing cursor blinking, 29 Changing cursor color, 29 Configuring cursor, 29 Dialog Color Schemes, 115 Edit Color Scheme, 116 Edit Quick Command, 132 Edit Quick Command Set, 131 Forwarding Rule, 117 Host Keys, 104 New Session, 71 Options, 118 Properties, 72 Quick Command Sets, 129 Sessions, 68 SSH Security Warning, 113
149
SSH User Authentication, 114 User Key Generation Wizard, 108 User Key Properties, 107 User Keys, 105 Xagent, 136 Xagent Setup, 138 Dialog Boxes Find, 102 Manage Layout, 104 Proxy List, 99 Encryption, 79 File transfer Browsing download folder, 36 Default download folder, 36 Download with SFTP, 35 Download with ZMODEM, 35 Upload with SFTP, 35 Upload with ZMODEM, 36 Find Find dialog box, 102 Fonts Changing bold text display, 27 Changing terminal font and size, 27 Forwarding rule, 66 Host key Host Keys dialog box, 104 SSH Security Warning dialog box, 113 Installation and uninstallation, 3 Keep alive, 73 Keyboard configuration, 86 Links bar, 63 Local prompt, 142 Local Shell commands, 142 Logging session, 37 Automatic Logging, 37 MAC (Message Authentication Code), 79 Main window, 48 Manage Layout dialog box, 104 Margins
configuration, 93 Menus Edit, 53 File, 49 Help, 60 Tools, 57 View, 55 Window, 59 Multi-session New connection from Session bar, 31 Open multi-session, 31 Switch between sessions, 31 Output encoding Changing output encoding, 33 Printing, 39 Product key, 61 Proxy List dialog box, 99 Public Key User Authentication, 19 Creating user key, 19 exporting user key, 20 importing private key, 19 Pubilc key format, 112 Registering public key, 19 User Authentication dialog box, 114 User Key Generation Wizard dialog box, 108 User Key Properties dialog box, 107 User Keys dialog box, 105 Quick commands Add quick command, 32 change quick commands toolbar, 32 New quick command set, 32 Quick Commands Edit Quick Command dialog box, 132 Edit Quick Command Set dialog box, 131 Quick Command Sets dialog box, 129 Quick Commands toolbar, 66 Regular expressions, 144 RLOGIN configuration, 83 Searching text Regular expressions, 144
Index |
150
Searching with a keyword, 27 Searching with a regular expression, 27 SERIAL configuration, 83 SERIAL connection, 16 Session copying session file, 12 creating a session, 11 creating a shortcut, 12 creating folder, 12 deleting a session, 12 editing a session, 11 editing default dession, 12 managing sessions, 11 Session bar, 67 Session properities Connection
SFTP commands, 43, 144 configuration, 81 file transfer, 35 Shortcut keys, 147 SSH configuration, 77 Security, 78 Tunneling, 79 Status bar, 67 TELNET configuration, 82 Terminal Advanced, 89 Terminal options Initial size, 34 Keypad mode, 34 Scroll buffer, 33 Terminal type, 34 Terminal Window, 25 Terminal workspace, 65 Toolbar, 61 Tracing session, 37 Tunneling, 21 Channel, 24 Dynamic port forwarding, 23 Forwarding Rule dialog box, 117 Listen port, 118 TCP/IP port forwarding, 21 Tunneling bar, 65 X11 Forwarding, 22, 81 Tunneling bar, 65 VT Modes configuration, 88 X11 Forwarding X display location, 81 Xmanager, 81 Xactivator, 140 Xagent, 41 dialog box, 136 Tray icon, 138
SSH SFTP, 81
Session properties Connection, 72
Authentication, 73
Session Properties Appearance, 91
Margins, 93
Connection
RLOGIN, 83 SERIAL, 83 SSH, 77 Security, 78 Tunneling, 79 TELNET, 82

Terminal
Advanced, 89 Keyboard, 86
VT Modes, 88 ZMODEM, 98 Session Tab, 63 Sessions menu, 69 Sessions dialog box, 68
Index |
151
Xagent Setup dialog box, 138 zlib compression, 78
ZMODEM configuration, 98
Index |
152

Xshell4 Manual

Hochgeladen von

Dokumentinformationen

Originalbeschreibung:

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

Xshell4 Manual

Hochgeladen von

Copyright:

Verfügbare Formate

Xshell 4 User Guide

Secure Terminal Emualtor

Installation and uninstallation

\HKEY_CURRENT_USER\Software\NetSarang\Xshell \HKEY_CURRENT_USER\Software\NetSarang\Xmanager Enterprise

Files and folders: %APPDATA%\NetSarang\Xshell %APPDATA%\NetSarang\Xmanager Enterprise

Xshell License Agreement

Connecting to a remote host

Connecting without a session

telnet://hostname ssh://hostname rlogin://hostname

Connecting with a session

Public Key User Authentication

Public Key User Authentication |

Public Key User Authentication |

TCP/IP port forwarding

SOCKS4/5 Dynamic port forwarding

Port forwarding channels

Working with Terminal Window

Copying and pasting

In the Toolbar, click Copy. Press the Ctrl+Ins key. Notes

Working with Terminal Window |

Working with Terminal Window |

Configuring text and background colors

Working with Terminal Window |

Manipulating Xshell windows

Working with Terminal Window |

Working with Terminal Window |

To create a new connection in a new Xshell window:

Managing the quick command sets

Changing output encoding

UTF-8 encoding display:

Setting advanced terminal options

Working with Terminal Window |

File transfer using SFTP

File transfer using ZMODEM

Using Xftp from Xshell to transfer files

Logging and Tracing

Logging and Tracing |

Login with Xagent

Using Xagents user keys in the remote host

Available Script APIs

CloseSession() Sleep(long timeout) Timeout

Makes Xshell to wait for specified time.

Sets the log file name as new.

Stops from writing log.

Sends message to terminal.

Get(long nBegRow, long nBegCol, long nEndRow, long nEndCol)

Reads from terminal out and returns specficied section.

Waits for the message.

WaitForStrings(VARIANT FAR* strArray, long nTimeout)

Waits for the message until timeout is reached.

' make wait message as array

Xshell main window

Figure 3: Xshell Main Window Reference |

Currently open Xshell window list

Name New File Transfer

ssh: sftp: telnet: rlogin:

Some examples are listed below.

Usage foobar.com ssh://BobSmith@foobar.com/

ssh://kay@foobar.com:12345/ telnet://foobar.com/ rlogin://kay@foobar.com/

Quick Commands bar

Figure 20: Compose Bar

Figure 21: Session Bar

Figure 22: Status Bar