Customizing the
User Interface
SecureCRT allows you to customize some parts of its user interface in two different ways: either by using the Customize dialog, or by editing the menu configuration file (described below). Using either of these methods, you can modify or remove existing menus, rearrange the main toolbar buttons, and much more, however, you must choose one or the other method, as they cannot be used together.
Customizing the Menu Configuration File
WARNING: Customizing the SecureCRT interface by editing the menu configuration file can be a complex undertaking. Some programming knowledge will be helpful.
The customizable interface features are listed below:
· Menu titles on the main window
· Menu options on the main window menus, the System menu, and right-click menus
· Accelerators
· Toolbar buttons
· ToolTips
· Status bar messages
To make changes to the items mentioned above, you will need to edit the SecureCRT menu configuration file found in the SecureCRT data folder. The default configuration file is Default.mnu, but other files can be used by changing the file specified in the Custom menu and toolbar file option in the Terminal category of the Global Options dialog.
Tip: To return SecureCRT to its default configuration, either delete any existing configuration files or clear the entry in the Custom menu and toolbar file entry box, and restart SecureCRT. This will force SecureCRT to return to default values.
Configuration File Format
This section covers the format and syntax of the menu and toolbar configuration file. The precedence for accelerator keys is F-Keys, Keymap, MenuItem, built in.
File format rules
The fields in a definition will be separated by a comma. Command arguments will be separated by a vertical bar or pipe (|).
Accelerator definitions will start with a unique string identifier. They will not contain a field for the command ID string, as that already exists in the associated menu or toolbar item definition.
String table definitions will start with a unique string identifier. They will not contain a field for the command ID string as that already exists in the associated menu or toolbar item definition.
Accelerator and string table definitions must appear in the file before any menu or toolbar definitions.
Command strings
The SecureCRT menu configuration file supports command strings for most of the application commands. See the Menu Configuration Command Strings topic for a comprehensive list.
In addition to standard menu and toolbar commands, three user-defined commands are also available:
· OPEN_SESSION -- This command connects you to the specified session A session is a set of options that are assigned to a connection to a remote machine. These settings and options are saved under a session name and allow the user to have different preferences for different hosts. .
· OPEN_SESSION_TAB -- This command connects you to the specified session in a tab.
· RUN -- This command runs the specified script. This command does not support arguments.
· SEND -- This command sends the specified string.
The above command strings can be used as in the following examples extracted from the example file at the end of this topic:
TOOLBARITEM "server.bmp", "OPEN_SESSION", "server", "server", "server"
TOOLBARITEM "run.bmp", "RUN", "C:\vss\test.vbs", "script"
TOOLBARITEM "send.bmp", "SEND", "Hello World\n", "hello"
Keywords and syntax
Items enclosed in angle brackets (<>) are required. Items enclosed in square brackets ([]) are optional.
END ( ends a definition of a menu, toolbar, popup menu, accelerator keys, or string table)
MENU ( for main menu definitions )
MENU <“label”>
<definition of menu items or submenus>
END
TOOLBAR ( for toolbar definitions )
TOOLBAR <“label”>
<definition of buttons in the toolbar>
END
POPUPMENU ( for context and system menu as well as sub-menus )
POPUPMENU <”label”>
<definition of menu items or submenus>
END
ACCELERATOR ( for the definition of accelerator keys)
ACCELERATOR
<definition of accelerator keys>
END
An accelerator key definition is of the form:
<”unique_identifier”>,<”key”>,<”key modifiers separated by ‘|’ ”>
STRINGTABLE ( for the definition of status bar and ToolTip strings)
STRINGTABLE
<definition of status bar and tooltip strings>
END
A string table definition is of the form:
<”unique_identifier”>,<”status bar message\ntooltip”>
SEPARATOR ( indicates that a separator should be placed in the menu or toolbar )
MENUITEM ( designates that the following text defines a menu item )
MENUITEM <”label”>,<”command str”>[,” command argument(s)”][,”string table identifier”][,”accelerator identifier”]
TOOLBARITEM ( designates that the following text defines a toolbar button)
TOOLBARITEM <”icon”>,<”command str”>[,”command argument(s)”][,”string table identifier”][,”accelerator identifier”]
// (designates a comment)
// [comment string]
Any line that has // as the first two characters will be considered as a comment. Comments must be on a line by themselves.
For MENUITEM, the “label” and “command str” are required. The remaining arguments are optional. However, order is important. If an optional argument is not provided and it is followed by an argument that is provided, the argument separator (,) must be included. For example:
MENUITEM &MyItem,MY_MENU_COMMAND,, ”This is my menu item”
The above arguments are: <”label”>,<”command str”>, ,<”stringtable identifier”>
For TOOLBARITEM, one of “icon” and “command str” is required. Again order is important and skipped arguments must have the argument separator included.
Errors and warnings
When an error condition occurs, you will be informed about the nature of the error and that the default menu or toolbar will be loaded and displayed.
When a warning condition occurs, you will be informed about what caused the warning condition and that the particular menu or toolbar item, accelerator, or hint will not be used. However, those parts of the menu or toolbar that are correct will be loaded and displayed.
Example file
The following example file is the default menu and toolbar configuration
file Default.mnu.
//*** This file will be overwritten when SecureCRT is upgraded. ***
//*** If you wish to modify the file, please make your changes in a copy. ***
// accelerator table
ACCELERATOR
"Connect", "C", "VIRTKEY | ALT"
"Connect in Tab", "B", "VIRTKEY | ALT"
"New SFTP Tab", "P", "VIRTKEY | ALT"
"Quick", "Q", "VIRTKEY | ALT"
"Go to Chat Window", "G", "VIRTKEY | ALT"
END
// stringtable for status bar and tooltips
STRINGTABLE
"Connect", "Connect to a remote host in a new window\nConnect"
"Connect in Tab", "Connect to a remote host in a new tab\nNew Tab"
"Clone Session", "Clone current session\nClone Session"
"New SFTP Tab", "Connect new SFTP tab using current session\nSFTP"
"Lock Session", "Lock/Unlock current session\nLock/Unlock Session"
"Quick", "Quick connect\nQuick Connect"
"Go to Chat Window", "Go to the chat window or session window\nGo to Chat Window"
END
// main menu
MENU "[main]"
POPUPMENU "&File"
MENUITEM "&Connect...", "MENU_CONNECT", ,"Connect" , "Connect"
MENUITEM "&Quick Connect...", "MENU_QUICK_CONNECT", ,"Quick", "Quick"
MENUITEM "Connect in Ta&b...", "MENU_TAB_NEW", ,"Connect in Tab" , "Connect in Tab"
SEPARATOR
MENUITEM "&Reconnect", "MENU_RECONNECT"
MENUITEM "Reconnect &All", "MENU_RECONNECT_ALL"
MENUITEM "&Disconnect", "MENU_DISCONNECT"
MENUITEM "Disc&onnect All", "MENU_DISCONNECT_ALL"
SEPARATOR
MENUITEM "Clo&ne Session", "MENU_TAB_CLONE", ,"Clone Session" ,
MENUITEM "Connect &SFTP Tab", "MENU_TAB_NEW_SFTP", ,"New SFTP Tab" , "New SFTP Tab"
SEPARATOR
MENUITEM "Loc&k Session...", "MENU_TAB_LOCK", ,"Lock Session" ,
SEPARATOR
POPUPMENU "&Print"
MENUITEM "&Auto Print", "MENU_PRINT_AUTO"
MENUITEM "&Screen", "MENU_PRINT_SCREEN"
MENUITEM "Se&lection", "MENU_PRINT_SELECTION"
MENUITEM "&Eject page", "MENU_PRINT_EJECT_PAGE"
MENUITEM "&Cancel", "MENU_PRINT_CANCEL"
END
MENUITEM "Print Set&up...", "MENU_PRINT_SETUP"
SEPARATOR
MENUITEM "&Log Session", "MENU_LOG_SESSION"
MENUITEM "Ra&w Log Session", "MENU_DEBUG_LOG"
MENUITEM "&Trace Options", "MENU_TRACE_OPTIONS"
SEPARATOR
MENUITEM "Recent Session", "MENU_MRU_FILE1"
SEPARATOR
MENUITEM "E&xit", "MENU_EXIT"
END
POPUPMENU "&Edit"
MENUITEM "&Copy", "MENU_COPY"
MENUITEM "&Paste", "MENU_PASTE"
MENUITEM "C&opy && Paste", "MENU_COPY_PASTE"
MENUITEM "Paste as &Quotation", "MENU_EDIT_PASTE_AS_QUOTATION"
MENUITEM "Select &All", "MENU_SELECT_ALL"
MENUITEM "&Find...", "MENU_FIND"
SEPARATOR
MENUITEM "Print Se&lection", "MENU_PRINT_SELECTION"
SEPARATOR
MENUITEM "&Go to Chat Window", "MENU_GOTO_CHAT_SESSION_WINDOW"
SEPARATOR
MENUITEM "Clear Scroll&back", "MENU_CLEAR_SCROLLBACK"
MENUITEM "Clear &Screen", "MENU_CLEAR_SCREEN"
MENUITEM "Clear Screen && Scrollbac&k", "MENU_CLEAR_SCREEN_AND_SCROLLBACK"
SEPARATOR
MENUITEM "&Reset", "MENU_RESET"
END
POPUPMENU "&View"
MENUITEM "&Menu Bar", "MENU_TOGGLE_MENU_BAR"
MENUITEM "&Toolbar", "MENU_TOGGLE_TOOLBAR"
MENUITEM "Session Ta&bs", "MENU_TOGGLE_SESSION_TABS"
MENUITEM "&Chat Window", "MENU_TOGGLE_CHAT_WINDOW"
MENUITEM "Connect Ba&r", "MENU_TOGGLE_CONNECT_BAR"
MENUITEM "&Status Bar", "MENU_TOGGLE_STATUS_BAR"
MENUITEM "&Button Bar", "MENU_TOGGLE_BUTTON_BAR"
POPUPMENU "Th&emes"
MENUITEM "&Shaded", "MENU_THEMES_SHADED"
MENUITEM "Office 200&0", "MENU_THEMES_OFFICE2000"
MENUITEM "Office 200&3", "MENU_THEMES_OFFICE2003"
MENUITEM "&Blue", "MENU_THEMES_BLUE"
MENUITEM "Blac&k", "MENU_THEMES_BLACK"
MENUITEM "&Aqua", "MENU_THEMES_AQUA"
MENUITEM "S&ilver", "MENU_THEMES_SILVER"
END
SEPARATOR
MENUITEM "&Window Transparency", "MENU_TOGGLE_ALPHA_TRANSPARENCY"
SEPARATOR
MENUITEM "&Horizontal Scroll Bar", "MENU_TOGGLE_HORZ_SCROLLBAR"
MENUITEM "&Vertical Scroll Bar", "MENU_TOGGLE_VERT_SCROLLBAR"
SEPARATOR
MENUITEM "&Always on Top", "MENU_ALWAYS_ON_TOP"
MENUITEM "&Full Screen", "MENU_TOGGLE_FULL_SCREEN"
END
POPUPMENU "&Options"
MENUITEM "&Session Options...", "MENU_SESSION_OPTIONS"
MENUITEM "&Global Options...", "MENU_GLOBAL_OPTIONS"
SEPARATOR
MENUITEM "&Auto Save Options", "MENU_AUTO_SAVE"
MENUITEM "Save Settings &Now", "MENU_SAVE_NOW"
END
POPUPMENU "&Transfer"
MENUITEM "&Send ASCII...", "MENU_SEND_ASCII"
MENUITEM "&Receive ASCII...", "MENU_RECEIVE_ASCII"
SEPARATOR
MENUITEM "Send &Binary...", "MENU_SEND_BINARY"
SEPARATOR
MENUITEM "Se&nd Xmodem...", "MENU_SEND_XMODEM"
MENUITEM "Re&ceive Xmodem...", "MENU_RECEIVE_XMODEM"
SEPARATOR
MENUITEM "Sen&d Ymodem...", "MENU_SEND_YMODEM"
MENUITEM "Recei&ve Ymodem...", "MENU_RECEIVE_YMODEM"
SEPARATOR
MENUITEM "&Zmodem Upload List...", "MENU_ZMODEM_ADD_FILE"
MENUITEM "Start Zmodem &Upload", "MENU_SEND_ZMODEM"
END
POPUPMENU "&Script"
MENUITEM "&Run...", "MENU_SCRIPT_RUN"
MENUITEM "&Cancel", "MENU_SCRIPT_CANCEL"
SEPARATOR
MENUITEM "&Start Recording Script", "MENU_SCRIPT_START_RECORDING"
MENUITEM "S&top Recording Script...", "MENU_SCRIPT_STOP_RECORDING"
MENUITEM "C&ancel Recording Script", "MENU_SCRIPT_CANCEL_RECORDING"
SEPARATOR
MENUITEM "Recent Script", "MENU_SCRIPT_MRU_FILE1"
END
POPUPMENU "Too&ls"
MENUITEM "&Keymap Editor...", "TOOLS_MENU_KEYMAP_EDITOR"
SEPARATOR
MENUITEM "&Create Public Key...", "TOOLS_CREATE_PUBLIC_KEY"
MENUITEM "Convert Private Key to &OpenSSH Format...", "TOOLS_CONVERT_PRIVATE_KEY"
MENUITEM "&Export Public Key from Certificate...", "TOOLS_EXPORT_PUBLICKEY_FROM_CERTIFICATE"
MENUITEM "&Public-Key Assistant...", "TOOLS_PUBLIC_KEY_ASSISTANT"
SEPARATOR
MENUITEM "Ma&nage Agent Keys...", "TOOLS_MANAGE_AGENT_KEYS"
END
POPUPMENU "&Help"
MENUITEM "&Help Topics", "MENU_HELP_FINDER"
SEPARATOR
MENUITEM "SecureCRT &Web Page...", "MENU_HELP_WEBPAGE"
MENUITEM "&Order SecureCRT...", "MENU_HELP_ORDER"
MENUITEM "Check for &Updates...", "MENU_HELP_UPDATE"
MENUITEM "VanDyke Software &Forum...", "MENU_FORUMS_WEBPAGE"
SEPARATOR
MENUITEM "&Enter License Data...", "MENU_ENTER_LICENSE_DATA"
SEPARATOR
MENUITEM "&About SecureCRT...", "MENU_APP_ABOUT"
END
END
POPUPMENU "[context]"
MENUITEM "&Copy", "MENU_COPY"
MENUITEM "&Paste", "MENU_PASTE"
MENUITEM "Copy && Paste", "MENU_COPY_PASTE"
MENUITEM "Paste as &Quotation", "MENU_EDIT_PASTE_AS_QUOTATION"
SEPARATOR
MENUITEM "&Open URL", "MENU_OPEN_URL"
SEPARATOR
MENUITEM "&Find...", "MENU_FIND"
MENUITEM "Select &All", "MENU_SELECT_ALL"
MENUITEM "Print Se&lection", "MENU_PRINT_SELECTION"
SEPARATOR
MENUITEM "Clear Scroll&back", "MENU_CLEAR_SCROLLBACK"
MENUITEM "Clear &Screen", "MENU_CLEAR_SCREEN"
MENUITEM "Clear Screen && Scrollbac&k", "MENU_CLEAR_SCREEN_AND_SCROLLBACK"
END
POPUPMENU "[system]"
MENUITEM "&Restore", "SYS_MENU_RESTORE"
MENUITEM "&Move", "SYS_MENU_MOVE"
MENUITEM "&Size", "SYS_MENU_SIZE"
MENUITEM "Mi&nimize", "SYS_MENU_MINIMIZE"
MENUITEM "Ma&ximize", "SYS_MENU_MAXIMIZE"
SEPARATOR
MENUITEM "&Always on Top", "MENU_ALWAYS_ON_TOP"
MENUITEM "Save Settings No&w", "MENU_SAVE_NOW"
MENUITEM "&Toggle Menu Bar", "MENU_TOGGLE_MENU_BAR"
SEPARATOR
MENUITEM "&Close", "SYS_MENU_CLOSE"
END
// the toolbar
TOOLBAR "[toolbar]"
TOOLBARITEM "MENU_CONNECT", "MENU_CONNECT", , "Connect", "Connect"
TOOLBARITEM "MENU_QUICK_CONNECT", "MENU_QUICK_CONNECT", , "Quick", "Quick"
TOOLBARITEM "MENU_TAB_NEW", "MENU_TAB_NEW", , "Connect in Tab", "Connect in Tab"
TOOLBARITEM "MENU_RECONNECT", "MENU_RECONNECT"
TOOLBARITEM "MENU_DISCONNECT", "MENU_DISCONNECT"
TOOLBARITEM "CONNECT_BAR", "CONNECT_BAR"
SEPARATOR
TOOLBARITEM "MENU_COPY", "MENU_COPY"
TOOLBARITEM "MENU_PASTE", "MENU_PASTE"
TOOLBARITEM "MENU_FIND", "MENU_FIND"
SEPARATOR
TOOLBARITEM "MENU_PRINT_SCREEN", "MENU_PRINT_SCREEN"
TOOLBARITEM "MENU_PRINT_SELECTION", "MENU_PRINT_SELECTION"
TOOLBARITEM "MENU_PRINT_AUTO", "MENU_PRINT_AUTO"
SEPARATOR
TOOLBARITEM "MENU_SESSION_OPTIONS", "MENU_SESSION_OPTIONS"
TOOLBARITEM "TOOLS_MENU_KEYMAP_EDITOR", "TOOLS_MENU_KEYMAP_EDITOR"
TOOLBARITEM "TOOLS_PUBLIC_KEY_ASSISTANT", "TOOLS_PUBLIC_KEY_ASSISTANT"
SEPARATOR
TOOLBARITEM "MENU_HELP_FINDER", "MENU_HELP_FINDER"
SEPARATOR
TOOLBARITEM "TOOLBAR_LAUNCH_SECUREFX", "TOOLBAR_LAUNCH_SECUREFX"
END