Previous | Index | Next

Chapter 5: ExtraPuTTY Files

This chapter describes all the configuration options in PuTTY.

PuTTY is configured using the control panel that comes up before you start a session. Some options can also be changed in the middle of a session, by selecting ‘Change Settings’ from the window menu.

5.1 XML command file


The XML commands file is used to perform the function "Automatic sequencing of commands".
This file can be create or update by two ways : ExtraPuTTY editor or manualy.
ExtraPutty manage the five "predefined entities" representing special characters (",<,>,;,').

5.1.1 XML file description

This file used 8 XML TAGS, which are describe below :

ExtraPuTTYTreeCmd

Main TAG

<ExtraPuTTYTreeCmd>
</ExtraPuTTYTreeCmd>

Position

TAG which contains ExtraPuTTY or PuTTY window position

<Position name="ExtraPuTTY or PuTTY" use="0 or 1">
<btlr name="bottom" value="Coordonate"/>
<btlr name="top" value="Coordonate"/>
<btlr name="left" value="Coordonate"/>
<btlr name="right" value="Coordonate"/>
</Position>

Options

TAG which allows or not the edition of file.

<Options Locked="0 : not locked, 1 : locked"/>

File

TAG which contains the path of an other XML commands file.

<File name="PATH of other XML commands file (c:\File1.xml)"/>

Help

TAG to defined help file.

<Help Type="type of help file (chm,html help)" name="Path of help file (c:\file.chm)"/>

To used help file you shall add the optional balise "help", described below.

root

TAG which contains a categorie name of commands

<root name="Categorie name" help="Used to display associate html help page of command"> 
</root>

The CRLF field is used to create dynamic command. (CRLF = 0,the "enter" key is not send to allow to ending the command manually else yes)

The TAG "root,childroot,childscenarii" are composed of POLICE balises which are not defined here in order to keep a simple and clearly document.
If there TAG are not set in the file the default value are used. You can modify the police and saved it from the ExtraPuTTY window.


You can used <PATH_EXPUTTY> shortcut for relative path of putty.exe in File,Help and childroot (Type 3 ,lua cript) TAGS.

Note

Note the following about parameters:

5.1.2 XML file sample

XML File

<?xml version="1.0"?>
<!--Registry file for ExtraPuTTY, ExtraPuTTY Copyright 2010-->
<ExtraPuTTYTreeCmd>
	<Position name="ExtraPuTTY" use="1">
<btlr name="bottom" value="639"/>
<btlr name="top" value="81"/>
<btlr name="left" value="105"/>
<btlr name="right" value="341"/>
</Position> <Position name="PuTTY" use="1">
<btlr name="bottom" value="501"/>
<btlr name="top" value="81"/>
<btlr name="left" value="341"/>
<btlr name="right" value="1008"/>
</Position> <Options Locked="0"> <Help Type="chm" name="<PATH_EXPUTTY>ExtraPutty.chm"/> <root name="Login" help="ExtraPuTTY_Start.html"> <childroot name="Clear Scrolback" type="1" cmd="EXT_SYS_CMD_CLEAR_SB" CRLF="1"/> <childroot name="Reset Termnial" help="ExtraPuTTY_Using.html" type="1" cmd="EXT_SYS_CMD_RESET_TERM" CRLF="1"/> <childroot name="Send ETX(0x03) + HELLO + BEL(0x07)" type="1" cmd="EXT_SPECHAR_ETX_HELLO_BEL" CRLF="1"/> <childroot name="Send only CRLF" type="1" cmd="EXT_SPECHAR_CR_LF" CRLF="0"/> <childroot name="Loop with modal dialogbox" type="2" loop="2" auto="1"> <childscenarii name="Display input box" cmd="EXT_MSGBOX_INPUTBOX_Enter your login" tempo="500" mode="execute" CRLF="1"/> <childscenarii name="start Extraputty trace" cmd="EXT_SYS_CMD_START_TRACE" tempo="500" mode="skip" CRLF="1"/> <childscenarii name="Send Telnet special command Are you there" cmd="EXT_SYS_CMD_TS_AYT" tempo="1000" mode="execute" CRLF="1"/> <childscenarii name="Display message box" cmd="EXT_MSGBOX_Tests MessageBox" tempo="1000" mode="execute" CRLF="1"/> </childroot> </root> <root name="LUA script" help="ExtraPuTTY_Using_Step_lua.html"> <childroot name="Wait command1" help="ExtraPuTTY_Using_Step_lua.html" type="3" path="<PATH_EXPUTTY>Examples\script.lua"/> </root> <File name="C:\File1.xml"> <File name="<PATH_EXPUTTY>Examples\ExtraPuTTYCmd.xml"> </ExtraPuTTYTreeCmd>

Result with ExtraPuTTY editor

XmlSample

5.1.3 Predefined commands

From ExtraPuTTY XML command file some predefined commands are available :

PuTTY system commands :

System Commands ExtraPutty predefined commands
Event log EXT_SYS_CMD_SHOWLOG
New Session ... EXT_SYS_CMD_NEWSESSION
Restart Session EXT_SYS_CMD_RESTART
Duplicate Session EXT_SYS_CMD_DUPSESSION
Saved Sessions EXT_SYS_CMD_SAVEDSESSION
Change Settings ... EXT_SYS_CMD_RECONF
Copy All to Clipboard EXT_SYS_CMD_COPYALL
Clear Scrollback EXT_SYS_CMD_CLEAR_SB
Reset Terminal EXT_SYS_CMD_RESET_TERM
Full Screen EXT_SYS_CMD_FULLSCREEN
Help EXT_SYS_CMD_HELP
About PuTTY EXT_SYS_CMD_ABOUT

ExtraPuTTY system commands :

System Commands ExtraPutty predefined commands
Start Trace EXT_SYS_CMD_START_TRACE
Stop Trace EXT_SYS_CMD_STOP_TRACE
Edit Command File EXT_SYS_CMD_EDIT_XML_FILE
About ExtraPuTTY EXT_SYS_CMD_ABOUT_EXT
Close ExtraPuTTY window EXT_SYS_CMD_CLOSE_WND

Extra commands :

Commands ExtraPutty predefined commands
Display message box EXT_MSGBOX_ + Text
( EXT_MSGBOX_HELLO World => display HELLO World, the title of the message box it's the name of command)
Display input box EXT_MSGBOX_INPUTBOX_ + Text
( EXT_MSGBOX_INPUTBOX_Enter your password => display Enter your password, the title of the message box it's the name of command)

Telnet special commands :

Commands ExtraPutty predefined commands
Are you there EXT_SYS_CMD_TS_AYT
Break EXT_SYS_CMD_TS_BRK
Synch EXT_SYS_CMD_TS_SYNCH
Erase Character EXT_SYS_CMD_TS_EC
Erase Line EXT_SYS_CMD_TS_EL
Go Ahead EXT_SYS_CMD_TS_GA
No Operation EXT_SYS_CMD_TS_NOP
Abort Process EXT_SYS_CMD_TS_ABORT
Abort Output EXT_SYS_CMD_TS_AO
Interrupt Process EXT_SYS_CMD_TS_IP
Suspend Process EXT_SYS_CMD_TS_SUSP
End Of Record EXT_SYS_CMD_TS_EOR
End Of File EXT_SYS_CMD_TS_EOF
End Of Line EXT_SYS_CMD_TS_EOL

Send unprintable characters

From XML commands file used syntaxe "EXT_SPECHAR_" + characters.
The unprintable charaters managed are NUL, SOH, STX, ETX, EOT, ENQ, ACK, BEL, BS, HT, LF, VT, FF, CR, SO, SI, DLE, DC1, DC2, DC3, DC4, NAK, SYN, ETB, CAN, EM, SUB, ESC, FS, GS, RS, US, Sp, DEL. (value 0x00 to 0x20 and 0x7F)

Sample

<?xml version="1.0"?>
<!--Registry file for ExtraPuTTY, Vrool Copyright 2007-->
<ExtraPuTTYTreeCmd>
	<Position name="ExtraPuTTY" use="1">
<btlr name="bottom" value="639"/>
<btlr name="top" value="81"/>
<btlr name="left" value="105"/>
<btlr name="right" value="341"/>
</Position> <Position name="PuTTY" use="1">
<btlr name="bottom" value="501"/>
<btlr name="top" value="81"/>
<btlr name="left" value="341"/>
<btlr name="right" value="1008"/>
</Position> <root name="Login"> <childroot name="Clear Scrolback" type="1" cmd="EXT_SYS_CMD_CLEAR_SB" CRLF="1"/> <childroot name="Reset Termnial" type="1" cmd="EXT_SYS_CMD_RESET_TERM" CRLF="1"/> <childroot name="Send ETX(0x03) + HELLO + BEL(0x07)" type="1" cmd="EXT_SPECHAR_ETX_HELLO_BEL" CRLF="1"/> <childroot name="Send only CRLF" type="1" cmd="EXT_SPECHAR_CR_LF" CRLF="0"/> <childroot name="Loop with modal dialogbox" type="2" loop="0" auto="1"> <childscenarii name="Display input box" cmd="EXT_MSGBOX_INPUTBOX_Enter your login" tempo="500" mode="execute" CRLF="1"/> <childscenarii name="start Extraputty trace" cmd="EXT_SYS_CMD_START_TRACE" tempo="500" mode="execute" CRLF="1"/> <childscenarii name="Send Telnet special command Are you there" cmd="EXT_SYS_CMD_TS_AYT" tempo="10000" mode="execute" CRLF="1"/> <childscenarii name="Display message box" cmd="EXT_MSGBOX_Tests MessageBox" tempo="10000" mode="execute" CRLF="1"/> </childroot> </root> </ExtraPuTTYTreeCmd>

5.2 Report files

The ExtraPuTTY report file can be activate from PuTTY panel or during session with system menu of ExtraPuTTY window or by changing the settings of connection.
This report can trace all exchanges (Command,Reply) with the distant target.This report is available for ExtraPuTTY and PuTTY.
For extreme detail and reference purposes, chapter 4 is likely to contain more information.

Note

Note the following report sample:

5.3 TestStand Report files

This report is generate by TestStand. Note : The Data received from distant target is added in the report by the ExtraPuTTY TestStand Step. For extreme detail and reference purposes, chapter 6.2.2 is likely to contain more information.

Note

Note the following report sample:


If you want to provide feedback on this manual or on the ExtraPuTTY tools themselves, see the Feedback page.

[ExtraPuTTY release 0.29 Compile with PuTTY release 0.64]