home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / jumpkey.zip / readme.ini < prev    next >
Text File  |  1996-06-15  |  6KB  |  200 lines
  1. (c) Copyright International Business Machines Corporation 1996.
  2.  
  3.  
  4.                 VERSION 2.3.0    15 June     1996
  5.  
  6.  
  7. JUMPINI
  8. ========
  9.  
  10. This program is used to modify a JUMPKEY .INI file from the
  11. OS/2 command line. JumpKey 2.2.1 or 2.3.0 must already be installed.
  12.  
  13. Correct Usage:
  14.   JUMPINI keyname|togglexx|@textfile session|function [/option ...]
  15.  
  16.  
  17. SETTING A SINGLE KEY
  18. ========================
  19. To set a single key, use the command in the form:
  20.   JUMPINI keyname function|session
  21.  
  22. For example:
  23.   JUMPINI ctrl-1 workframe
  24.  
  25. Options can also be used:
  26.   JUMPINI ctrl-1 workframe /max /partial
  27. See the section below on OPTIONS for details,
  28.  
  29. If the session title has embedded blanks, enclose the title in
  30. double quotes:
  31.   JUMPINI ctrl-1 "IBM workframe/2"
  32.  
  33. If you want to assign a function to a key, use one of the
  34. function names:
  35.   JUMPINI ctrl-1 HOTVIEW
  36. The functions available are:
  37.   NOTHING       -  No Action (this clears a key definition)
  38.   HOTVIEW       -  Make JumpKey/2 Visible
  39.   TOGFOR        -  Toggle Forward
  40.   TOGBACK       -  Toggle Backward
  41.   TOGMIN        -  Toggle Minimize
  42.   TOGMAX        -  Toggle Maximize
  43.   TOGRES        -  Toggle Restore
  44.   MINALL        -  Minimize All
  45.   MAXALL        -  Maximize All
  46.   RESALL        -  Restore All
  47.   LOCKUP        -  Lockup System
  48.   SHUTDOWN      -  Shutdown System
  49.  
  50. To see a list of all the available keynames, issue the command:
  51.   JUMPINI /k
  52. This list is part of JumpKey, and may vary according to the
  53. language and keyboard selected.
  54.  
  55.  
  56. SETTING TOGGLE SESSION NAMES
  57. ============================
  58. You can specify the session names for the toggle function
  59. by specifying each session name. For example:
  60.   JUMPINI toggle01 "- A -"
  61.   JUMPINI toggle02 "- B -"
  62.   JUMPINI toggle03 "Dos Window"
  63. Note: Please do not leave empty names in the list. For example,
  64. if you set names 01 02 and 04, the toggle function will never
  65. access toggle04. The ring ends at the first undefined entry.
  66.  
  67. The names available are:
  68.   toggle01  toggle09 toggle17  toggle25
  69.   toggle02  toggle10 toggle18  toggle26
  70.   toggle03  toggle11 toggle19  toggle27
  71.   toggle04  toggle12 toggle20  toggle28
  72.   toggle05  toggle13 toggle21  toggle29
  73.   toggle06  toggle14 toggle22  toggle30
  74.   toggle07  toggle15 toggle23  toggle31
  75.   toggle08  toggle16 toggle24  toggle32
  76.  
  77. All the toggle sessions share a single "exact match" flag and "maximize"
  78. flag.
  79.  
  80. USING AN INPUT FILE
  81. ===================
  82. Instead of calling JUMPINI several times to define keys, you
  83. can use a text file as input to JUMPINI. Precede the filename
  84. with an '@' sign. For example:
  85.   JUMPINI @ini.jmp
  86. Do not place a blank between the '@' and the filename. Options
  87.   /F /D /W /K and /Q
  88. must still be placed on the command line. Other options are not
  89. valid on the command line when using input from a file.
  90. Instead, put these options in the file itself (see example below).
  91.  
  92. File ini.jmp could contain (as it does in the shipped example):
  93. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  94. ctrl-1 hotview
  95. ctrl-2 nothing
  96. @ini2.jmp
  97. ctrl-3 workframe /exact /max
  98. ctrl-8 "workframe of my life" /exact /max
  99. /skipmin
  100. toggle01 "- A"
  101. toggle02 "- B"
  102. toggle03 "- C"
  103. toggle04 HTERMPM
  104. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  105.  
  106. In this example, there is an embedded file "ini2.jmp" that contains:
  107. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  108. ctrl-4 hotview
  109. ctrl-5 nothing
  110. ctrl-6 workframe /exact /max
  111. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  112.  
  113. If you embed a file in itself the program will fail (there is no
  114. checking for this) with a SYS3175.
  115.  
  116.  
  117. OPTIONS
  118. ========================
  119. Options are NOT case sensitive, and can be placed anywhere
  120. on the command line or in an input file.
  121. Only the first letter of each option is required.
  122.  
  123. --------------
  124.   /F<inifile>
  125.     Where <inifile> is the ini file to modify.
  126.     If omitted, /OS2/JUMPKEY.INI on your OS2 boot disk is the default.
  127.     Don't leave a blank after the 'F'.
  128.   i.e.
  129.     JUMPINI /Ftest.ini ctrl-1 JumpKey
  130.   This option cannot be used in an input file.
  131.  
  132. --------------
  133.   /Exact | /Partial
  134.     Specifies how to match a session name. If "partial" is set (the default)
  135.     a session name of "Window" would match:
  136.       "Dos Window"
  137.       "OS/2 Window"
  138.       "Win-OS/2 Window"
  139.     If exact is set, only a session titled "Window" would match.
  140.   i.e.
  141.     JUMPINI /Partial ctrl-1 Window
  142.     JUMPINI /exact   ctrl-2 "Dos Window"
  143.   Do not use this option on the command line if an input file is used.
  144.  
  145. --------------
  146.   /Max | /Nomax
  147.     Specifies to maximize or do not maximize on switch.
  148.   i.e.
  149.     JUMPINI /Max ctrl-1 Window
  150.   Do not use this option on the command line if an input file is used.
  151.  
  152. --------------
  153.   /Skip | /All
  154.     This is used to skip minimized or jump to all toggle sessions.
  155.   This option can be placed either on the command line or in an
  156.   input file.
  157.   i.e.
  158.     JUMPINI /Skip
  159.  
  160. --------------
  161.   /Loop | /One
  162.     Specify this option to toggle through sessions with matching
  163.     names, or only jump to the first session name found.
  164.   This option can be placed either on the command line or in an
  165.   input file.
  166.   i.e.
  167.     JUMPINI /Loop
  168.  
  169. --------------
  170.   /Hidden | /Jumpall
  171.     Specify this option to skip hidden sessions, or jump to
  172.     all, even if they are hidden.
  173.   This option can be placed either on the command line or in an
  174.   input file.
  175.   i.e.
  176.     JUMPINI /Hidden
  177.  
  178. --------------
  179.   /Display
  180.     Is used to display the current settings.
  181.   i.e.
  182.     JUMPINI /D
  183.   This option should only be used on the command line.
  184.  
  185. --------------
  186.   /Words
  187.     to display the function and toggle keywords.
  188.   This option should only be used on the command line.
  189.  
  190. --------------
  191.   /Keys
  192.     to display the key names.
  193.   This option should only be used on the command line.
  194.  
  195. --------------
  196.   /Quiet
  197.     to suppress informational messages.
  198.   This option should only be used on the command line.
  199.  
  200.