Академический Документы
Профессиональный Документы
Культура Документы
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™, Xshell™ and Xftp™ are trademarks of NetSarang Computer, Inc. Xmanager® is a registered trademarks of
NetSarang Computer, Inc. Microsoft Windows® is a trademark of Microsoft®. Unix® is a trademark 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/)
http://www.netsarang.com/
Table of Contents
Xshell Introduction ...................................................................................................................................... 1
Overview ................................................................................................................ 1
Features ................................................................................................................. 1
System requirements ............................................................................................... 3
Installation and uninstallation ................................................................................... 3
Technical support..................................................................................................... 4
License Agreements ................................................................................................. 5
Xshell License Agreement ................................................................................... 5
Xshell Evaluation License Agreement .................................................................... 5
Xshell Free License Agreement ............................................................................ 6
Getting Started .............................................................................................................................................. 9
Creating a session ................................................................................................... 9
Connecting to a remote host .................................................................................... 10
Exiting Xshell ......................................................................................................... 10
Managing Sessions ..................................................................................................................................... 11
Establishing Connections ........................................................................................................................ 13
Connecting without a session ................................................................................... 13
Connecting with a session ........................................................................................ 13
SERIAL connection.................................................................................................. 14
Public Key User Authentication ............................................................................................................ 15
Tunneling Service ....................................................................................................................................... 17
TCP/IP port forwarding ............................................................................................ 17
X11 Forwarding ...................................................................................................... 18
SOCKS4/5 Dynamic port forwarding.......................................................................... 19
Instant Tunneling.................................................................................................... 19
Port forwarding channels ......................................................................................... 20
Working with Terminal Window ........................................................................................................... 21
Copying and pasting ............................................................................................... 21
Searching text........................................................................................................ 22
Changing fonts ....................................................................................................... 23
Configuring text and background colors ..................................................................... 23
Configuring cursor .................................................................................................. 24
Manipulating Xshell windows .................................................................................... 25
Managing Multi-session ........................................................................................... 26
Managing the quick command sets ........................................................................... 27
Changing output encoding ....................................................................................... 28
Setting advanced terminal options ............................................................................ 28
Table of Contents | i
Transferring Files........................................................................................................................................ 31
File transfer using SFTP .......................................................................................... 31
File transfer using ZMODEM..................................................................................... 31
Using Xftp from Xshell to transfer files ...................................................................... 32
Logging and Tracing .................................................................................................................................. 33
Logging Session ..................................................................................................... 33
Tracing Session ...................................................................................................... 33
Printing Text ................................................................................................................................................. 35
Using Xagent................................................................................................................................................. 37
Login with Xagent .................................................................................................. 37
Using Xagent’s user keys in the remote host.............................................................. 37
Reference ....................................................................................................................................................... 39
Xshell main window ................................................................................................ 39
File menu ........................................................................................................ 40
Edit menu........................................................................................................ 43
View menu ...................................................................................................... 44
Tools menu ...................................................................................................... 47
Window menu .................................................................................................. 48
Help menu....................................................................................................... 49
Toolbar buttons ................................................................................................ 50
Address bar ..................................................................................................... 51
Links bar ......................................................................................................... 52
Font bar .......................................................................................................... 52
Quick Commands toolbar................................................................................... 52
Session Tab ..................................................................................................... 53
Terminal workspace .......................................................................................... 54
Compose bar ................................................................................................... 54
Tunneling bar ................................................................................................... 55
Session bar...................................................................................................... 55
Status bar ....................................................................................................... 56
Dialog boxes ......................................................................................................... 57
Sessions dialog box .......................................................................................... 57
Session menu ............................................................................................. 58
New Session Properties dialog box ...................................................................... 59
Properties dialog box ........................................................................................ 60
Connection ................................................................................................. 60
Connection: Authentication .......................................................................... 62
Connection: Authentication: Logon Prompts ................................................... 63
Connection: Logon Scripts............................................................................ 63
Connection: SSH......................................................................................... 64
Connection: SSH: Security ........................................................................... 65
Connection: SSH: Tunneling ......................................................................... 66
ii | Table of Contents
Connection: SSH: SFTP ................................................................................ 68
Connection: TELNET .................................................................................... 68
Connection: RLOGIN .................................................................................... 69
Connection: SERIAL ..................................................................................... 70
Terminal ..................................................................................................... 71
Terminal: Keyboard ..................................................................................... 73
Terminal: VT Modes ..................................................................................... 74
Terminal: Advanced ..................................................................................... 75
Appearance ................................................................................................ 76
Appearance: Margins ................................................................................... 77
Trace Appearance: Margins ........................................................................... 78
Logging Appearance: Margins ....................................................................... 79
ZMODEM .................................................................................................... 81
Proxy List dialog box ......................................................................................... 82
Proxy Settings dialog box ................................................................................... 82
Expect & Send Rule dialog box............................................................................ 83
Find dialog box ................................................................................................. 84
Manage Layout dialog box .................................................................................. 85
Host Keys dialog box ......................................................................................... 85
User Keys dialog box ......................................................................................... 86
User Key Properties dialog box............................................................................ 87
General tab ................................................................................................ 87
Public Key tab ............................................................................................. 88
User Key Generation Wizard dialog box ................................................................ 89
Step 1: Key Generation Parameters ............................................................... 89
Step 2: User Key Generation ......................................................................... 89
Step 3: User Key Information........................................................................ 90
Step 4: Public Key Registration ...................................................................... 91
SSH Security Warning dialog box ........................................................................ 92
SSH User Authentication dialog box ..................................................................... 93
Color Schemes dialog box .................................................................................. 93
Edit Color Scheme dialog box ............................................................................. 94
Forwarding Rule dialog box ................................................................................ 95
Options dialog box ............................................................................................ 97
General tab ................................................................................................ 97
Menu & Shortcut Keys tab ............................................................................ 98
Window tab ................................................................................................ 99
Advanced tab ............................................................................................ 101
Quick Command Sets dialog box ....................................................................... 102
Edit Quick Command Set dialog box .................................................................. 102
Edit Quick Command dialog box ........................................................................ 103
iv | Table of Contents
Xshell Introduction
Overview
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 98/ME/2000/XP/Vista
• Supports OpenSSH and ssh.com servers
• Multi-user configuration
• Keep alive option
• SOCKS4/5, HTTP proxy connection
• Supports Multi-session (Session tab, Session bar)
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
• RSA/DSA key generation wizard and import/export features
• SSH authentication agent forwarding using Xagent utility
Xshell Introduction | 1
• 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
• Status bar displays security-lock, session selection, network traffic information
(up/down)
2 | Xshell Introduction
• 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
• Processor: Intel® compatible CPU
• Operating System: Microsoft Windows® 98 or later
• Hard disk: Over 10M bytes free space
• Network: TCP/IP Winsock 1.1 compatible
• Required software: Internet Explorer® 5.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
Xshell Introduction | 3
the files and registry information completely, you need to remove the followings explicitly:
Registry key:
• \HKEY_CURRENT_USER\Software\NetSarang\Xshell3
• \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 find FAQ, submit a support request form, and post questions on the Xshell forum. We
are able to support you better when you describe your problem as detailed as possible.
4 | Xshell Introduction
License Agreements
Xshell License Agreement
This license agreement applies to the registered version of Xshell. If you are using Xshell for
evaluation, see “Xshell Evaluation License Agreement” on page 5. If you are using the free
version of Xshell, see “Xshell Free License Agreement” on page 6.
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.
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.
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 Evaluation License Agreement
This license agreement applies to the evaluation version of Xshell. If you are a registered user,
see “Xshell License Agreement” on page 5. If you are using the free version of Xshell, see
Xshell Introduction | 5
“Xshell Free License Agreement” on page 6.
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 and warranty.
You are specifically prohibited from charging, or requesting donations, for any such copies,
however made; and from distributing the software and/or documentation with other products
(commercial or otherwise) without prior written permission from NetSarang Computer, Inc.,
with no exceptions.
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 Free License Agreement
This license agreement applies to the free version of Xshell. If you are using the registered
version of Xshell, see “Xshell License Agreement” on page 5. If you are using Xshell for
evaluation, see “Xshell Evaluation License Agreement” on page 5.
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.
6 | Xshell Introduction
You are specifically prohibited from charging, or requesting donations, for any such copies,
however made; and from distributing the software and/or documentation with other products
(commercial or otherwise) without prior written permission from NetSarang Computer, Inc.,
with no exceptions.
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.
Use Restrictions
This license is provided personally to you and for that reason it does not allow you to make any
duplicate (copy) to be sold, borrowed, assigned, leased or transferred in any manner
whatsoever to another person. Any transfer executed in violation of this provision shall be
deemed invalid and constitute a reason for termination of your license validity.
You must not use the program in any manner somehow jeopardizing or violating the
manufacturers' copyrights. In addition, you must not change the program, modify it, decompile
it, transfer it from a mechanical code, reanalyze it or create any deduced works therefore by
processing. All explicitly non-granted rights are reserved.
License grant
Free license grants the use of the product without paying fees and this does not refer to the
ownership of the product in any way or form. Free license is available for personal and non-
commercial use only. “Personal and non-commercial use” refers to usage within home and not
for the purpose of generating profits. This does not include the personal usage within a
company, organization, or institution.
If you are using the program for commercial purpose, you have to purchase a commercial
license.
Disclaimer of Warranty
THIS SOFTWARE AND THE ACCOMPANYING FILES ARE PROVIDED "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 Introduction | 7
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 on page 15 first.
Creating a session
You can create a TELNET, RLOGIN, SSH, SFTP or SERIAL session.
Getting Started | 9
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. On the File menu, click Open.
2. In the session list, select the session which you want to connect to.
Exiting Xshell
To exit Xshell, enter “exit” at the prompt of the terminal session and then click Exit on the
File menu.
10 | 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 to use after installation.
To edit a session:
1. Open the Sessions dialog box.
2. Select the session you want to edit.
3. On the toolbar, click Properties.
4. Edit the session and click OK.
To delete a session:
1. Open the Sessions dialog box.
2. Select the session you want to delete.
3. On the toolbar, click Delete.
Managing Sessions | 11
4. Browse the folder tree and select a folder to put the shortcut.
5. Click OK.
To use connection commands from the local prompt, see Xshell local commands on page 110.
To use Address bar, see Address bar section on page 51.
12 | Managing Sessions
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 on page 11. For more information on
local prompt, see Xshell local commands on page 110. For more information on Address bar,
see Address bar on page 51.
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.
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
Establishing Connections | 13
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.
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.
14 | Establishing Connections
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 on page 86.
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.
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.
Tunneling Service | 17
4. From Category, select Connection.
5. For Protocol, select SSH.
6. From Category, select SSH, and then Tunneling.
7. Select a tunneling rule to edit.
8. Click Edit.
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.
18 | Tunneling Service
X11Forwarding yes
3. 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 dynamic port fowarding is used, Xshell can operate as a SOCKS
proxy server.
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 Tunneling bar. For more information on Instant Tunneling, refer to the "Tunneling
bar" section on page 55.
Tunneling Service | 19
To suspend a port forwarding rule:
1. In the View menu, click Tunneling Bar. The Tunneling bar appears on the bottom of the
Xshell window.
2. Click the Forwarding Rules tab.
3. In the Forwarding Rules list, right-click on the rule you want to suspend.
4. In the menu, click Suspend.
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.
20 | Tunneling Service
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.
Searching text
You can search the scroll buffer for a keyword or regular expression. Using regular expressions
you can search for complicated patterns.
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.
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 on page 93.
Configuring cursor
Xshell provides a configurable cursor. You can change the colors and blinking speed of the
cursor in terminal window.
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.
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
added when a new connection is made and Session tab is removed when the connection is
closed.
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
toolbar, on the View menu, point Toolbars, and then click Quick Commands.
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.
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.
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.
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 on page 105.
Transferring Files | 31
6. Click Open.
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.
32 | Transferring Files
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. For more information
on logging sessions, see File menu on page 40.
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 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.
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 print text:
1. In the File menu, click Print.
2. In the Name list, select a printer.
3. Under Print Range, select one of All, Pages, and Selected Area.
4. Click OK.
Printing Text | 35
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. Open the Properties dialog box.
2. From Category, select SSH.
3. Select Use Xagent (SSH agent) for passphrase handling.
4. Click OK.
Using Xagent’s 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.
Using Xagent | 37
To use Xagent’s user keys from remote machine:
1. Configure Xshell to use Xagent.
2. Run Xagent if it is not running.
3. Log on to an SSH server with Xshell.
Note: 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.
Note: ‘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.
Note: 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.
38 | Using Xagent
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.
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
Reference | 39
bar to allow you to customize terminal fonts more conveniently. With Quick Commands, users
can save frequently used commands and easily use them when needed. 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, 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. 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.
New
Opens the New Session Properties dialog box. The keyboard shortcut for New is Alt+N.
40 | Reference
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.
Close
Save As
Opens the Save As dialog box. It saves all properties of the current session into a new session.
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.
Transfer
Send ASCII
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
Reference | 41
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
Log
Start
Opens the Save As dialog box. All received data after choosing this command are logged
in the selected file.
Stop
Pause
Resume
Properties
Exit
42 | Reference
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 doesn’t 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 on page 113.
To Notepad
Opens a Notepad window and copies text to it. You can choose a text area to copy from the
submenu.
Reference | 43
Figure 8: To Notepad Submenu
Selected Area
All
Copies all the text in the current screen and the scroll buffer to Notepad.
Screen
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.
View menu
44 | Reference
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 - Links
Shows or hides the Links bar.
Toolbars - Customize
Customize the Standard Buttons toolbar.
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
Tunneling Bar
Reference | 45
Layout
Changes or adds/removes layouts in Xshell
Default
Switches to the default layout.
Layout List
Shows all available layouts stored in a system. When a layout is selected, appearance of
Xshell is switched as it is defined in the selected layout.
Save As
Saves the current layout under a new name.
Manage
Opens the Manage Layout dialog box.
Transparent
Apply transparent effect to Xshell.
Always on Top
Full Screen
Go to System Tray
Moves Xshell to the system tray.
46 | Reference
Tools menu
Opens the Sun Short-cut Keys dialog box to send special key codes for Sun Solaris system.
Launch Xagent
Launches Xagent, an authentication agent for Xshell.
Launch Xactivator
Launches Xactivator which opens and manages multiple Xshell windows.
Color Schemes
Options
Opens the Options dialog box. The dialog box allows you to customize global options that are
Reference | 47
applied to all sessions you created.
Window menu
New Window
Opens a new Xshell window. This command allows you to run another Xshell window easily
while using Xshell.
Close All
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.
48 | Reference
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
attempts to make a connection with the corresponding session information.
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
Xshell Help
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.
Reference | 49
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.
New Terminal 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.
New File If Xftp™ is installed, it opens a new Xftp window. If this
Transfer 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.
Help Opens the Xshell Help system.
50 | Reference
Button Name Description
About Opens the About Xshell dialog box that contains
information about Xshell and license. Also in this dialog
box you can enter product key.
User Key Opens the User Keys dialog box.
Manager
Host Key Opens the Host Keys dialog box.
Manager
Xagent Starts Xagent.
Address bar
[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: 22
• sftp: 22
• telnet: 23
• rlogin: 513
Usage Description
foobar.com Connects to foobar.com with the protocol and port
specified in the default session.
ssh://BobSmith@foobar.com/ Connects to foobar.com with the ssh protocol.
User account is BobSmith and the default port 22
will be used.
ssh://kay@foobar.com:12345/ Connects to the port 12345 of foobar.com with
the ssh protocol. The user account is kay.
telnet://foobar.com/ Connects to foobar.com with the telnet protocol. A
user is not defined and the default port 23 is
used.
Reference | 51
Usage Description
rlogin://kay@foobar.com/ Connects to foobar.com with the rlogin protocol.
The user account is kay and the default port 513
is used.
sftp://kay@foobar.com/ Connects to foobar.com with the sftp protocol. The
user account is kay and the default port number is
used.
Links bar
Links bar lets you easily access the sessions that are frequently used.
Font bar
Xshell offers a Font bar that can be used in changing the terminal font of currently open
session. You can also select a font from the Appearance in the Category of the Properties
dialog box for each session.
Quick Commands toolbar
Quick Commands toolbar lets you save the frequently used commands or text strings and
easily reuse them when needed. Quick Commands toolbar 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 toolbar.
52 | Reference
Figure 18: Quick Commands Toolbar
Edit
Opens the Edit Quick Command Set dialog box. You can use this to edit the buttons listed in
the current Quick Commands toolbar.
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.
Session Tab
Session tab displays the currently open sessions and lets you select a session to work with.
Duplicate
Creates a new session tab that is a duplication of the current session.
Rename
Changes the name of selected session.
Close
Closes the selected session.
Reference | 53
Move Left
Moves the selected session to the left.
Move Right
Moves the selected session to the right.
Show Numbers
Assigns numbers to sessions. You can switch between sessions using Alt + Session number.
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.
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. When Xshell exits, all the messages are discarded
permanently.
54 | Reference
Figure 20: Compose Bar
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.
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.
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.
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.
Reference | 55
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, encryption 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.
56 | Reference
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.
Reference | 57
View Type Shows sessions as large icons, small icons, list, or list with
additional columns.
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
Note: 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 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.
58 | Reference
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.
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 | 59
Figure 25: New Session
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.
60 | Reference
Figure 26: Connection
Name
Note: 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
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.
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.
Reference | 61
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.
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.
62 | Reference
User Key
Select a user key that will be used when a Public Key authentication is selected. If this box is
blank, 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.
TELNET
Enter both User Name Prompt and Password Prompt to automate the TELNET logon process.
Note that a space is a valid character.
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 Scripts
The Logon Scripts allows you to define the commands that will be entered to the terminal
Reference | 63
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.
Add
Opens the Expect & Send Rule dialog box. Once you edit a rule in the dialog box, it is added to
the list.
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.
64 | Reference
Figure 30: SSH
Protocol Versions
Select an SSH protocol you want to use. SSH2 provides better security and more functionalities
than SSH1.
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.
Connection: SSH: Security
In Security page, you can set encryption method and MAC (Message Authentication Code).
Reference | 65
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.
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.
66 | Reference
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 on
page 55.
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 on
page 55.
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 on page 55.
Xmanager
Select Xmanager if it is installed in your PC. The Xshell will run Xmanager automatically
Reference | 67
when an X11 connection arrives. It also detects the display number of Xmanager
automatically and you don’t have to configure it manually.
X DISPLAY
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.
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.
68 | Reference
Figure 34: TELNET
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.
Option Negotiation
Select option negotiation mode between Xshell and a TELNET server.
Passive
Xshell stays in the passive mode until the TELNET server starts negotiating options
Active
Connection: RLOGIN
In RLOGIN page, you can set options for RLOGIN protocol.
Reference | 69
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.
70 | Reference
Figure 36: SERIAL
Port
Select a RS232C parallel 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.
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.
Reference | 71
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.
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 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.
72 | Reference
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 doesn’t change the keyboard input language and you need to select an appropriate
IME (Input Method Editor) provided by Windows when required.
Terminal: Keyboard
In the Keyboard page, you can define strings the keyboard on user’s PC sends to the remote
server.
Reference | 73
Terminal: VT Modes
In VT Modes page, you can setup the initial values for each terminal mode.
74 | Reference
the terminal screen before it is sent to the remote server.
Terminal: Advanced
In the Advanced page, you can setup the advanced options related to terminal.
Receive LF as CR + LF
Prints both CR and LF characters to the terminal window when an LF character is received from
Reference | 75
the remote computer.
Appearance
In Appearance page, you can customize the colors and fonts used by the terminal window. It
provides a Preview window for your convenience.
76 | Reference
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. You can also
select a font from the Font bar.
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.
Bold Text
Select the method you want to display bold text.
Uses the bold colors defined in the color scheme for the ANSI bold escape sequences.
Uses the bold font of the selected font for the ANSI bold escape sequences.
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.
Speed
Enter the blinking speed of the text cursor.
Appearance: Margins
In the Margins page, you can edit margins and spaces of the Xshell terminal window.
Reference | 77
Figure 42: Margins & Spacings
Margins
Specifies margins of the terminal window.
Spacings
Specifies spaces between lines and characters of the terminal window.
Trace Appearance: Margins
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.
78 | Reference
Figure 43: Trace
Prints the detailed process of TELNET option negotiation between Xshell and the telnet server.
Logging Appearance: Margins
In Logging page, you can configure options related to connection logging.
Reference | 79
Figure 44: Logging
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.
Browse ([…])
Opens the Save As dialog box and selects a file where log data can be recorded.
80 | Reference
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.
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
Reference | 81
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.
Add
Add a new proxy server
Edit
Edit the selected proxy server settings.
Remove
Remove the selected proxy server from the list.
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.
82 | Reference
Figure 47: 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.
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 Scripts page.
Reference | 83
Figure 48: 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.
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.
Find what
Enter the text you want to search.
Up
Down
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 on page 113.
84 | Reference
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.
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 | 85
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
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.
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
86 | Reference
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
Rename
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
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.
Reference | 87
Figure 53: 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.
Change Passphrase
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.
88 | Reference
View public key format as
Select a public key format in the list. Currently supported formats are SSH2–OpenSSH, SSH2–
IETF 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 dialog box
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.
Step 1: Key Generation Parameters
This step allows you to select the type and length of the user key.
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 | 89
Figure 56: 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.
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.
90 | Reference
Passphrase
Enter the passphrase of the user key. It is used every time when you open it. IMPORTANT: You
must remember it.
Confirmation
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.
From the list, select one of the formats: SSH1, SSH2–OpenSSH, and SSH2–IETF 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.
z 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
z 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
Reference | 91
z SSH2-IETF SECSH: Some commercial ssh servers such as ssh.com’s 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
$ 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.
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.
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.
92 | Reference
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.
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
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.
Reference | 93
Figure 61: 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
Delete
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.
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.
94 | Reference
Figure 62: Edit Color Scheme
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
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.
Set to Default
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.
Reference | 95
Figure 63: Forwarding Rule
Type (Direction)
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.
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.
Remote forwarding only accepts connections originated from the server where the session is
96 | Reference
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.
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.
Reference | 97
Delimiters
Sets the delimiter words that are used when selecting text with double-click.
Mouse – Middle-button
Perform 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)
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
Address Bar
• Opens the Address Bar Settings dialog box for Address bar options.
Menu & Shortcut Keys tab
In the Menu & Shortcut Keys tab, you can define the customized menu and choose to use
shortcut keys.
98 | Reference
Figure 65: Options, Menu & Shortcut Keys tab
Window tab
In the Window tab, you can set a number of options related to Xshell behavior.
Reference | 99
Figure 66: 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.
100 | Reference
Advanced tab
Reference | 101
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.
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.
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.
102 | Reference
Figure 69: 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.
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.
Reference | 103
Figure 70: 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.
Command
Enter the command to execute when the Quick button is clicked.
Parameter
Enter parameter to pass when executing the command.
Customize Toolbar dialog box
In the Customize Toolbar dialog box, you can customize the Standard toolbar buttons in
the Xshell main window. You can also rearrange these buttons. To open this dialog box, point to
Toolbars in the View menu, and then click Customize.
104 | Reference
Figure 71: Customize Toolbar
Add
Moves the selected button from Available buttons to Current buttons. Only the buttons listed in
Current buttons will be displayed after closing the Customize toolbar.
Remove
Moves the selected button from Current buttons to Available buttons. Only the buttons listed in
Current buttons will be displayed after closing the Customize toolbar.
Move Up
Moves up the selected button by one. On the Standard Buttons toolbar, it moves left by one
space.
Move Down
Moves down the selected button by one. On the Standard Buttons toolbar, it moves right by
one space.
Reset
Resets to its default button setting.
Xagent dialog box
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.
Reference | 105
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.
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.
106 | Reference
Xagent Setup dialog box
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.
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.
Open Xagent
Opens the Xagent dialog box.
Exit
Exits from Xagent
Reference | 107
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.
New Xshell
Opens a new Xshell window. Use this to easily open up a new Xshell window.
Windows
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.
108 | Reference
Auto Start
Xactivator automatically starts when the user logs onto Windows.
Exit
Exits from Xactivator.
Reference | 109
Xshell local commands
Xshell provides a number of local commands for professional users who are accustomed to
terminal environments.
Command Description
help Displays the command list on the terminal window.
?
new Opens the New Session Properties dialog box.
open [session] Establishes a connection with the “session” specified
or opens the Sessions dialog box when a session is not
specified.
110 | Reference
Command Description
edit [session] If “session” is specified, Xshell opens the Properties
dialog box of the session. Otherwise, Xshell opens the
Default Properties dialog box.
Reference | 111
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 Descriptions
get file1 [file2] [file3] … Downloads files from the remote host.
help [command] Lists the list of commands or shows help of the specified
command.
112 | Reference
Regular expressions
This section describes the regular expression syntax that can be used in the Find dialog box.
Pattern Matches
Pattern Description
. Any one character except newline character.
[abc] a, b or c.
[a-z] Any character a to z inclusive.
[^ac] Any character except a and c.
(x) x, where x might be any regular expression.
X* Zero or more occurrences of x, where x may be any regular expression.
X+ One or more occurrences of x, where x may be any regular expression.
X{n,m} Between n and m occurrences of x, where x may be any regular expression.
X{n} n occurrences of x, where x may be any regular expression.
X{n,} n or more occurrences of x, where x may be any regular expression.
X|y x or y, where x and y may be any regular expression.
xy xy, where x and y may be any regular expression.
^ Beginning of a line.
\A Beginning of a line.
$ End of a line.
\z End of a line.
\Z End of a line.
\< Beginning of a word.
\b Beginning of a word.
\> End of a word.
\B End of a word.
The shorthand of character classes
Class Description
\w Word [a-zA-Z0-9_]
\W Not word [^a-zA-Z0-9_]
\s Whitespace
\S Not whitespace
\d Digit [0-9]
\D Not digit [^0-9]
Reference | 113
POSIX character classes
Class Description
[:alnum:] Alphanumeric. same to the [a-zA-Z0-9].
[:alpha:] Alphabetic. Same to the [a-zA-Z].
[:blank:] Spaces or tabs.
[:cntrl:] Any control characters.
[:digit:] Numeric digits. same to the [0-9].
[:graph:] Any visible characters. (no whitespace)
[:lower:] Lower-case alphabetic. same to the [a-z].
[:print:] Non-control characters.
[:punct:] Punctuation characters.
[:space:] Whitespace.
[:upper:] Upper-case alphabetic. same to the [A-Z].
[:xdigit:] Hex digits. same to the [0-9a-fA-F].
Examples
Expression Description
[0-9]+ One or more numeric characters.
(foo)|(bar) Either "foo" or "bar".
\.html$ Any string ending in ".html".
^\. Any string starting with a period.
114 | Reference
Predefined shortcut keys
The list below describes the keyboard shortcut keys defined in Xshell.
Reference | 115
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.
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.
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.
116 | Reference
other algorithms.
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.
Reference | 117
Index
Active, 69 Configuring cursor, 24
Address bar, 51 Dialog
Appearance Color Schemes, 93
configuration, 76 Edit Color Scheme, 94
Authentication, 62 Edit Quick Command, 103
Bold text, 77 Edit Quick Command Set, 102
Channel, 55 Forwarding Rule, 95
Colors Host Keys, 85
Color Schemes dialog box, 93 New Session, 59
Creating color schemes, 23 Options, 97
Edit Color Scheme dialog box, 94 Properties, 60
Editing color schemes, 24 Quick Command Sets, 102
Exporting color schemes, 24 Sessions, 57
Importing color schemes, 24 SSH Security Warning, 92
Compose bar, 54 SSH User Authentication, 93
Compression, 65 User Key Generation Wizard, 89
Connecting with sessions User Key Properties, 87
at the local prompt, 14 User Keys, 86
at the Sessions dialog box, 14 Xagent, 105
with a shortcut, 14 Xagent Setup, 107
Connecting without a session Dialog Boxes
at the Address bar, 13 Find, 84
at the local prompt, 13 Manage Layout, 85
Connection Proxy List, 82
Authentication, 63 Encryption, 66
configuration, 60 File transfer
Logon Scripts, 63 Browsing download folder, 32
Copying and pasting Default download folder, 32
Column mode selection, 21 Download with SFTP, 31
Copying to Clipboard, 21 Download with ZMODEM, 31
Copying to Notepad, 22 Upload with SFTP, 31
Pasting to the terminal, 22 Upload with ZMODEM, 31
Selecting text, 21 Find
Cursor Find dialog box, 84
Adjusting cursor blinking speed, 25 Font bar, 52
Changing cursor blinking, 24 Fonts
Changing cursor color, 24 Changing bold text display, 23
Index | 119
Changing terminal font and size, 23 Creating user key, 15
Forwarding rule, 55 exporting user key, 16
Host key importing private key, 15
Host Keys dialog box, 85 Pubilc key format, 91
SSH Security Warning dialog box, 92 Registering public key, 15
Installation and uninstallation, 3 User Authentication dialog box, 93
Keep alive, 61 User Key Generation Wizard dialog box, 89
Keyboard User Key Properties dialog box, 87
configuration, 73 User Keys dialog box, 86
Links bar, 52 Quick commands
Local prompt, 110 Add quick command, 27
Local Shell change quick commands toolbar, 27
commands, 110 New quick command set, 27
Logging session, 33 Quick Commands
Automatic Logging, 33 Edit Quick Command dialog box, 103
Logon Prompts, 63 Edit Quick Command Set dialog box, 102
MAC (Message Authentication Code), 66 Quick Command Sets dialog box, 102
Main window, 39 Quick Commands toolbar, 52
Manage Layout dialog box, 85 Regular expressions, 113
Margins RLOGIN
configuration, 77 configuration, 69
Menus Searching text
Edit, 43 Regular expressions, 113
File, 40 Searching with a keyword, 22
Help, 49 Searching with a regular expression, 22
Tools, 47 SERIAL
View, 44 configuration, 70
Window, 48 SERIAL connection, 14
Multi-session Session
New connection from Session bar, 26 copying session file, 12
Open multi-session, 26 creating a session, 11
Switch between sessions, 26 creating a shortcut, 11
Option Negotiation, 69 creating folder, 12
Active, 69 deleting a session, 11
Passive, 69 editing a session, 11
Output encoding editing default session, 12
Changing output encoding, 28 managing sessions, 11
Passive, 69 Session bar, 55
Printing, 35 Session Properties
Product key, 50 Appearance, 76
Proxy List dialog box, 82 Margins, 77
Public Key User Authentication, 15 Connection, 60, 63
120 | Index
Authentication, 62 Advanced, 75
RLOGIN, 69 Terminal options
SERIAL, 70 Initial size, 28
SSH, 64 Keypad mode, 29
Security, 65 Local echo, 29
SFTP, 68 Scroll buffer, 28
Tunneling, 66 Terminal type, 28
TELNET, 68 Terminal Window, 21
Logging Terminal workspace, 54
configuration, 79 Toolbar, 50
Terminal, 71 Tracing session, 33
Advanced, 75 Tunneling, 17
Keyboard, 73 Channel, 20
Trace Dynamic port forwarding, 19
configuration, 78 Forwarding Rule dialog box, 95
VT Modes, 74 Listen port, 96
ZMODEM, 81 TCP/IP port forwarding, 17
Session Tab, 53 Tunneling bar, 55
Sessions X11 Forwarding, 18, 67
menu, 58 Tunneling bar, 55
Sessions dialog box, 57 VT Modes
SFTP configuration, 74
commands, 112 X11 Forwarding
configuration, 68 X display location, 68
file transfer, 31 Xmanager, 67
Shortcut keys, 115 Xactivator, 108
SSH Xagent, 37
configuration, 64 dialog box, 105
Security, 65 Tray icon, 107
Tunneling, 66 Xagent Setup dialog box, 107
Status bar, 56 zlib compression, 65
TELNET ZMODEM
configuration, 68 configuration, 81
Terminal, 71
Index | 121