═══ 1. Overview ═══ JumpKey/2 2.3.0 allows you to set up key combinations that will jump directly to a specific OS/2 Window. You can configure up to 32 JumpKey/2 sessions to jump to as well as up to 32 sessions that will be toggled in a ring. You can configure the keys that will initiate each jump, as well as the titles that are jumped-to. Almost every key can be defined to make a jump. There is only one default key assignment: shift-ctrl-0 = Make JumpKey Visible If this is the first time you have started JumpKey/2, Configure will be automatically selected from the Options menu to set up session titles and keys. JumpKey/2 can be hidden while it operates or you can leave it as an icon, or a displayed window. Any items that you configure can be saved for the next time you start JumpKey/2. Note: You CANNOT jump FROM a FULL-SCREEN session, such as a Full-Screen Command Prompt, or DOS. You ARE permitted to jump TO one of these sessions. ═══ 2. Installation ═══ There are two installation methods depending on whether you have received the program from a network as a ZIP file (such as Compuserve(tm)) or you have received an installation diskette. Use the procedure that applies to the media you have received.  From a ZIP file  From a Diskette or CDROM ═══ 2.1. Installation from a ZIP File ═══ To unpack the network file, Info-ZIP's UNZIP is required. This program is available for both DOS and for OS/2. Check with the network where you obtained JumpKey/2 for details on obtaining Info-ZIP's UNZIP. To install JumpKey/2: 1. Create a temporary subdirectory with the commands: c: cd c:\ md TEMP cd TEMP Note: The TEMP directory is a suggested name. Any directory name can be used, or you can unpack in an existing directory. 2. You will be sent JMP230.ZIP. Move this file to the C:\TEMP directory. 3. Unpack the files with the command: UNZIP JMP230.ZIP 4. Start the install program with the command: INSTALL 5. The INSTALL program will prompt you for the installation location for JumpKey/2. There is contextual help for all the installation choices. A folder for JumpKey will be created, with an entry for the JumpKey program, and to view the INF, README and LICENSE files. 6. Make sure that "Update CONFIG.SYS" is selected. 7. Select one and only one keyboard. 8. If you want to start JumpKey from a command line, and you did not select "Update CONFIG,SYS", you must make sure that the target directory is located in the PATH, LIBPATH and HELP environment variables. 9. You can modify the program object for JumpKey that is created with parameters from the command line options 10. Delete the files that were created in the TEMP directory. The easiest way will be to drop the TEMP directory into the OS/2 SHREDDER from a DRIVES object. ═══ 2.2. Installation from a Diskette or CDROM ═══ The JumpKey/2 diskette or CDROM will have all the required files in a ready-to-install form. Use the following steps to install them on your machine. 1. From diskette, start the install program with the command: A:\INSTALL where A is the diskette drive you are installing from. 2. From CDROM, start the install program with the command: D:\path\INSTALL where D is the CDROM drive letter, and path is the location on CDROM you are installing from. 3. The INSTALL program will display the README file for this version of JumpKey/2. There is contextual help for all the installation choices. A folder for JumpKey will be created, with an entry for the JumpKey program, and to view the INF, README and LICENSE files. 4. Make sure that "Update CONFIG.SYS" is selected. 5. Select one and only one keyboard. 6. If you want to start JumpKey from a command line, and you did not select "Update CONFIG,SYS", you must make sure that the target directory is located in the PATH, LIBPATH and HELP environment variables. 7. You can modify the program object for JumpKey that is created with parameters from the command line options ═══ 3. Command Line ═══ If you have installed JumpKey/2 in a directory in both the PATH and the LIBPATH, you can start JumpKey/2 with the command: start JUMPKEY [options] or you can place the command line options as parameters in the settings notebook for the program object. The options that can be specified are: Option Action /h Makes JumpKey/2 hide. It will still operate, but you will not be able to see it, and there will not be an entry in the Window List. If you want to see the window again, you can either:  Start JumpKey/2 again. This will not start another copy of the program. It will make the first copy visible again.  Use the shift-ctrl-0 key to make the JumpKey/2 program visible. Use the Configure menu item to change the default key for this function to another key sequence. set up another key combination to perform this action.  Double-click on the object in the folder where you started JumpKey/2. /n Starts JumpKey/2 as an icon. /d Uses all program defaults. This will cause JumpKey/2 to discard any options you have previously saved. Use this option only if you want to discard all your settings. The '/' is optional. For example, to specify ALL the options, use the command: start JUMPKEY /hnd The options can be in ANY order. Note: Make sure that the following DLLs hotdll32.dll jumpres.dll are located somewhere in the LIBPATH. If it is NOT, you will receive the message: The system cannot find the file HOTDLL32. from OS/2. Note: You can also add these options to the JumpKey/2 program object in the JumpKey/2 folder. ═══ 4. Main Menu ═══ The main menu can be selected by clicking on the menu items, or pressing the Alt key and an underlined letter on the menu.  Actions  Options  Help ═══ 4.1. Actions Menu ═══ The Actions menu contains a single item:  Hide ═══ 4.1.1. Hide ═══ This menu item will make the JumpKey/2 program invisible. It will continue to operate, but you will not see the program either on the Desktop, as an Icon, or in the Window List. To make the program visible again you can:  Start JumpKey/2 again. This will not start another copy of the program. It will make the first copy visible again.  Use the shift-ctrl-0 key to make the JumpKey/2 program visible. Use the Configure menu item to set up another key combination to perform this action.  Double-click on the object in the folder where you started JumpKey/2. ═══ 4.2. Options Menu ═══ This menu has two menu items:  Configure  View keys ═══ 4.2.1. Configure ═══ This menu item will initiate the JumpKey/2 configuration Panel. This dialog panel lets you set up the keys to be used for JumpKey/2 as well as the titles used for the session names. To define a key, follow these steps: 1. Select the key you want to define from the Key Names list, or select a shift key setting and then select a key from the displayed keyboard by pressing a key with the mouse. The current definition for this key will be displayed in the Definition list. 2. Select a new definition in the Definition list. 3. Move the cursor to the Session Title Edit box and type in a session title or select one from the session title pulldown list. The pulldown list has everything currently in the Window List. 4. Click on the Maximize Session check box if you would like this session to maximize when you jump to it. 5. Click on the Exact Match check box if you have sessions with similar names, and you want to jump only if there is an exact title match. 6. The list of sessions for the Toggle function will display all the active 3270 sessions. You can change this list by modifying the order of the items, or adding or deleting items from the list. When you have finished defining ALL your keys, press the OK button. If you want to discard your changes to the defined keys, press the Cancel button. ═══ 4.2.2. Key Names List ═══ This list is an alphabetical list of the keys available for redefinition. You can either select an entry on this list, or press a button in the displayed keyboard above this list. If the key is not present on an old PC keyboard, the name will have -enh appended to the end of the key name. For example, the home key on the center of a Model 70 keyboard is known as home-enh, while the home key on the numeric keypad is simply home. The keys may also have a prefix of: alt- indicates holding either ALT key and pressing the key. ctrl- indicates holding either CTRL key and pressing the key. shift- indicates holding either SHIFT key and pressing the key. shift-ctrl- indicates holding either SHIFT key AND holding either CTRL key while pressing the key. ═══ 4.2.3. Definition List ═══ The following definitions are available: Name Action No Action JumpKey/2 takes no action for the key. It is passed on to the Active OS/2 application. Make JumpKey/2 Visible will make JumpKey/2 visible again if it is hidden. If JumpKey/2 is already visible, this key will have no effect. Toggle Forward this will have one of two actions, depending on the Active OS/2 application. 1. If the Active OS/2 application is NOT one of the toggle sessions, JumpKey/2 will jump to the FIRST toggle session. 2. If the Active OS/2 application IS one of the toggle sessions, JumpKey/2 will jump to the NEXT toggle session. When this item is selected, you cannot select the Session Title Edit box. Toggle Backward this will have one of two actions, depending on the Active OS/2 application. 1. If the Active OS/2 application is NOT one of the toggle sessions, JumpKey/2 will jump to the FIRST toggle session. 2. If the Active OS/2 application IS one of the toggle sessions, JumpKey/2 will jump to the PREVIOUS toggle session. When this item is selected, you cannot select the Session Title Edit box. Toggle Minimize this will minimize all Toggle sessions that are configured in the Toggle Session Title List. When this item is selected, you cannot select the Maximize Session checkbox or the Session Title Edit box. Toggle Maximize this will maximize all Toggle sessions that are configured in the Toggle Session Title List. When this item is selected, you cannot select the Maximize Session checkbox or the Session Title Edit box. Toggle Restore this will restore all Toggle sessions that are configured in the Toggle Session Title List. When this item is selected, you cannot select the Maximize Session checkbox, or the Session Title Edit box. Minimize All this will minimize all running programs. Maximize All this will maximize all running programs. Restore All this will restore all running programs. Lockup System this will invoke the OS/2 desktop lockup Shutdown System this will initiate OS/2 shutdown. Note: You will NOT be asked to confirm this operation. Each of these will jump to the specified OS/2 session. When configured, the name of this session will be displayed in definition list and in the the Session Title Edit box above this list, where it can be changed. The term 'not defined xx' (where xx is a number from 1 to 32) will be displayed for each entry in the list until a session name has been entered for the item. ═══ 4.2.4. Session Title Edit Box ═══ This is a combination box where you can either type the name of the session to be jumped-to for the session number displayed in the Definition List, or you can pull down the list of sessions as displayed in the Window list. If you click on the arrow to the right of this box, a list of all the currently running sessions will be displayed. Select the session with the keyboard or mouse. The item can be any part of a title in the Window List. Remember that the first match for this title will be the session that is jumped-to. The search is NOT case-sensitive, but any blanks or punctuation must be included just as displayed in the Window List. Note: You cannot select or type into this field unless jump session is selected in the Definition List. ═══ 4.2.5. Maximize Session Checkbox ═══ This check box should be selected if you would like the session whose name is displayed in the Session Title Edit box to become maximized when JumpKey/2 switches to it. Some applications will fill the entire screen when maximized. Others will change shape, but still not fill the entire screen. This option will cause the application to enlarge itself to it's largest size. Note: You cannot select this check box unless Toggle Forward, Toggle Backward or a jump session title is selected in the Definition List. ═══ 4.2.6. Exact Match Checkbox ═══ This check box should be selected if you would like to jump to the session whose name is displayed in the Session Title Edit box only if it is an EXACT match for a Window List entry. You may have applications with similar names, or names that are extensions of a name, for example: Command Window Command Window:2 If you defined a Session Title called Command Window, and you want to make sure JumpKey/2 always jumps to the first of the two Window List entries above, you would need to select Exact Match. Note: You cannot select this check box unless Toggle Forward, Toggle Backward or a jump session title is selected in the Definition List. ═══ 4.2.7. Toggle Session Title List ═══ This is a list box that contains the names of your 3270 sessions. These applications will be accessed by the key defined as Toggle Minimize, Toggle Forward or Toggle Backward in the Definition List. The Toggle Forward and Toggle Backward keys will have one of three actions, depending on the Active OS/2 application. 1. If the Active OS/2 application is NOT one of the toggle sessions, JumpKey/2 will jump to the FIRST toggle session. 2. If the Active OS/2 application IS one of the toggle sessions, Toggle Forward will jump to the NEXT toggle session; Toggle Backward will jump to the PREVIOUS toggle session. 3. If Skip Minimized has been selected, JumpKey/2 will not switch to Minimized sessions. Instead, the next or previous restored or maximized session will be switched-to. If you have not started, or you do not have the Communications Manager, this list will be empty. To make this list correct, start the Communications Manager before configuring JumpKey/2. To change an item in the list, use the cursor or the mouse to select an item, then edit the item as displayed in the Toggle Session Title Edit box, located just above the list, or select one from the Toggle Session Title Edit pulldown list. The terms 'not defined xx' will be displayed in the Toggle Session Title List (where xx is a number from 1 to 32) until an entry has been made for this item. Note: You cannot select this list unless toggle Minimize, Toggle Forward or Toggle Backward is selected in the Definition List. ═══ 4.2.8. Toggle Session Title Edit Box ═══ This is a combination box where you can either type the name of the session to be jumped-to for the toggle function, or you can pull down the current list of Communications Manager sessions. If you click on the arrow to the right of this box, a list of all the currently running Communications Manager sessions will be displayed. Select the session with the keyboard or mouse. Simply type over any values displayed in this box, or select from the pull down list. Then Click on OK to accept the change. To delete an item from the Toggle list, simple blank-out or delete all the characters in the item, then select another item in the list. The list will be adjusted for the now empty entry. Note: You cannot select or type into this field unless toggle Minimize, Toggle Forward or Toggle Backward is selected in the Definition List. ═══ 4.2.9. Skip Minimized Checkbox ═══ This check box should be selected if you would like JumpKey/2 to bypass Toggle Sessions that are minimized. When this option is selected, the keys defined as the toggle Forward and Toggle Backward will jump to the next or previous restored or maximized session defined in the Toggle Session Title List. If NONE of the defined sessions are restored or maximized, JumpKey/2 will jump to the first session. Note: You cannot select this check box unless toggle Minimize, Toggle Forward or toggle Backward is selected in the Definition List. ═══ 4.2.10. Toggle Through Like-Named Sessions Checkbox ═══ This check box affects all sessions except the toggle sessions. If selected JumpKey/2 will loop through all sessions that match the session title. For example, let us assume that you used the LaunchPad to start several sessions that have a title of "OS/2 Window". Let us also assume that you have another session called "Command Window". Use the JumpKey/2 settings to configure the key ctrl-1 to jump to a session titled "WINDOW" and do not select exact match. If Toggle Through Like-Named Sessions is ON, each time you pressed ctrl-1, JumpKey/2 would in turn toggle to each of the sessions titled "OS/2 Window", and then also toggle to the session titled "Command Window". If Toggle Through Like-Named Sessions is OFF, each time you pressed ctrl-1, JumpKey/2 would jump only to the first session it found. This could be one of the "OS/2 Window" sessions or the session titled "Command Window". Use the JumpKey/2 settings to configure the key ctrl-1 to jump to a session titled "OS/2 WINDOW" and DO select exact match. If Toggle Through Like-Named Sessions is ON, each time you pressed ctrl-1, JumpKey/2 would in turn toggle to each of the sessions titled "OS/2 Window", but would not toggle to the session titled "Command Window". If Toggle Through Like-Named Sessions is OFF, each time you pressed ctrl-1, JumpKey/2 would jump only to the first session titled "OS/2 Window" that it found. ═══ 4.2.11. Do Not Jump To Hidden Windows Checkbox ═══ This check box affects all sessions except the toggle sessions. If selected JumpKey/2 will not jump to windows which are hidden from view in the Window List. If you have trouble jumping to a session, try turning this option OFF. ═══ 4.2.12. OK Button ═══ Pressing the button accepts any changes on this panel and removes the Configure panel. ═══ 4.2.13. Cancel Button ═══ Pressing the button discards any changes on this panel and removes the Configure panel. If changes have been made, you will be asked to confirm before discarding the changes. ═══ 4.2.14. Defined Keys Panel ═══ This dialog panel lets you view the keys that are currently defined. The list that is provided contains two columns:  The names of the defined keys.  The definition for the keys. If you double-click on a list item, JumpKey/2 will try to switch to that session. If you have chosen a toggle or system function, a warning tone will sound. At the bottom of this panel are buttons to select:  Close - removes this dialog panel.  Print - sends the displayed list to the printer defined as LPT1. You will hear a confirmation tone when the list has been sent to the printer. ═══ 4.3. Help Menu ═══ The Help menu lets you find out more information about the program. ═══ 4.3.1. Help Index ═══ This menu item displays the Help Index. ═══ 4.3.2. General Help ═══ This menu item will start the help system at the first JumpKey/2 help panel. ═══ 4.3.3. Keys Help ═══ Alt-F11 performs the JumpKey/2 hide function from the JumpKey/2 main window. See your OS/2 reference for more information on standard key usage. ═══ 4.3.4. Help for Help ═══ This menu item tells you how to use the OS/2 help system. ═══ 4.3.5. Product Information ═══ The Product Information Panel contains the Copyright and program version. ═══ 5. Command-Line INI Tool JumpINI ═══ JumpINI is used to modify a JUMPKEY .INI file from the OS/2 command line. JumpKey 2.2.1 or 2.3.0 must already be installed. Correct Usage: JUMPINI keyname|togglexx|@textfile session|function [/option...] ═══ 5.1. Setting A Single Key ═══ To set a single key, use the command in the form: JUMPINI keyname function|session [/option...] For example: JUMPINI ctrl-1 workframe Options can also be used: JUMPINI ctrl-1 workframe /max /partial See the section below on OPTIONS for details, If the session title has embedded blanks, enclose the title in double quotes: JUMPINI ctrl-1 "IBM workframe/2" If you want to assign a function to a key, use one of the function names: JUMPINI ctrl-1 hotview The functions available are: nothing No Action (this clears a key definition) hotview Make JumpKey/2 Visible togfor Toggle Forward togback Toggle Backward togmin Toggle Minimize togmax Toggle Maximize togres Toggle Restore minall Minimize All maxall Maximize All resall Restore All lockup Lockup System shutdown Shutdown System To see a list of all the available keynames, issue the command: JUMPINI /k The list of keynames is part of JumpKey, and may vary according to the language and keyboard selected. ═══ 5.2. Setting Toggle Session Names ═══ You can specify the session names for the toggle function by specifying each session name. For example: JUMPINI toggle01 "- A -" JUMPINI toggle02 "- B -" JUMPINI toggle03 "Dos Window" Note: Please do not leave empty names in the list. For example, if you only set names 01 02 and 04, the toggle function will never access toggle04. The ring ends at the first undefined entry. The names available are: toggle01 toggle09 toggle17 toggle25 toggle02 toggle10 toggle18 toggle26 toggle03 toggle11 toggle19 toggle27 toggle04 toggle12 toggle20 toggle28 toggle05 toggle13 toggle21 toggle29 toggle06 toggle14 toggle22 toggle30 toggle07 toggle15 toggle23 toggle31 toggle08 toggle16 toggle24 toggle32 All the toggle sessions share a single "exact match" flag and "maximize" flag. ═══ 5.3. Using An Input File ═══ Instead of calling JUMPINI several times to define keys, you can use a text file as input to JUMPINI. Precede the filename with an '@' sign. For example: JUMPINI @ini.jmp Do not place a blank between the '@' and the filename. Options /F /D /W /K and /Q must still be placed on the command line. Other options are not valid on the command line when using input from a file. Instead, put these options in the file itself (see example below). File ini.jmp could contain (as it does in the shipped example): ctrl-1 hotview ctrl-2 nothing @ini2.jmp ctrl-3 workframe /exact /max ctrl-8 "workframe of my life" /exact /max /skipmin toggle01 "- A" toggle02 "- B" toggle03 "- C" toggle04 HTERMPM In this example, there is an embedded file "ini2.jmp" that also contains: ctrl-4 hotview ctrl-5 nothing ctrl-6 workframe /exact /max If you embed a file in itself the program will fail (there is no checking for this) with a SYS3175. ═══ 5.4. Options ═══ Options are NOT case sensitive, and can be placed anywhere on the command line and many can be placed in an input file. Only the first letter of each option is required. /F Where is the ini file to modify. If omitted, /OS2/JUMPKEY.INI on your OS2 boot disk is the default. Do not leave a blank after the 'F'. i.e.: JUMPINI /Ftest.ini ctrl-1 JumpKey This option cannot be used in an input file. /Exact | /Partial Specifies how to match a session name. If "partial" is set (the default) a session name of "Window" would match: "Dos Window" "OS/2 Window" "Win-OS/2 Window" If exact is set, only a session titled "Window" would match. i.e.: JUMPINI /Partial ctrl-1 Window JUMPINI /exact ctrl-2 "Dos Window" Do not use this option on the command line if an input file is used. /Max | /Nomax Specifies to maximize or do not maximize on switch. i.e.: JUMPINI /Max ctrl-1 Window Do not use this option on the command line if an input file is used. This option can be turned off by using: JUMPINI /Nomax ctrl-1 Window or JUMPINI /Max- ctrl-1 Window /Skip | /All This is used to skip minimized or jump to all toggle sessions. This option can be placed either on the command line or in an input file. i.e.: JUMPINI /Skip This option can be turned off by using: JUMPINI /All or JUMPINI /Skip- /Loop | /One Specify this option to toggle through sessions with matching names, or only jump to the first session name found. This option can be placed either on the command line or in an input file. i.e.: JUMPINI /Loop This option can be turned off by using: JUMPINI /One or JUMPINI /Loop- /Hidden | /Jumpall Specify this option to skip hidden sessions, or jump to all, even if they are hidden. This option can be placed either on the command line or in an input file. i.e.: JUMPINI /Hidden This option can be turned off by using: JUMPINI /Jumpall or JUMPINI /Hidden- /Display Is used to display the current settings. i.e.: JUMPINI /D This option should only be used on the command line. The output format is compatible as input to JUMPINI, so you can redirect output to a file: JUMPINI /D >j.out You can then edit the file and use it as an input file: JUMPINI @j.out /Words to display the function and toggle keywords. This option should only be used on the command line. /Keys to display the key names. This option should only be used on the command line. /Quiet to suppress informational messages. This option should only be used on the command line. ═══ 6. Support ═══ JumpKey 2.3.0 is provided as Employee Written Software by IBM. Support is available on a best-effort basis by contacting the author, Thomas E. Link, at 70105.1071@compuserve.com. IBM Internal users can post questions to the JUMPKEY forum on OS2TOOLS. If you have a TCP/IP connection and you have the WebExplorer installed, you can send mail directly to 70105.1071@compuserve.com. ═══ ═══ Press Ctrl-Esc, or click both mouse buttons together on the Desktop Background. The displayed list contains all active OS/2 applications. ═══ ═══ This is the OS/2 application that has a highlighted border and is receiving all keyboard input. ═══ ═══ An entry in the JumpKey/2 Toggle Session Titles list.