home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 301.lha / hyperhelp / help / environment < prev    next >
Encoding:
Text File  |  1980-12-03  |  3.4 KB  |  117 lines
  1. (@title Environment variables@)This file describes the environment
  2. variables used by HyperHelp
  3. program.  You can set the values for these variables through
  4. the AmigaDOS (@ref help:dos/setenv.help@)SETENV(@unref@) command. All of
  5. these variables are of the form "HELPxxxxx" where xxxxx is the
  6. specific variable.
  7.  
  8.  
  9.  
  10. NOTE: For variables that require a numeric value, there are three formats
  11. supported, as in the 'C' language. A number begining with the
  12. digits 1-9 is decimal. A number begining with the digit '0' is octal, and
  13. a number begining with '0x' is hexadecimal.
  14.  
  15.  
  16.  
  17. (@indent 2@)(@bold@)HotKeyCode(@bold@) - Sets the
  18. (@ref help:keycodes@)(@color 3@)keycode(@color 1@)(@unref@) to use as a
  19. (@ref help:hotkeys@)(@color 3@)hotkey(@color 1@)(@unref@). This defaults
  20. to 0x5f, the Help key.
  21.  
  22.  
  23.  
  24. (@bold@)HotKeyQual(@bold@) - Sets the qualifier(s) to use in
  25. combination with the HotKeyCode to set up the hotkey. This defaults to
  26. 0x0040, the Left Amiga key.
  27.  
  28.  
  29.  
  30. (@bold@)NoHotKey(@bold@) - Disables the HotKey feature.
  31.  
  32.  
  33.  
  34. (@label font@)(@bold@)Font(@bold@) - Sets the default font for help
  35. windows. Example: SETFONT HelpFont string "topaz.font 11"
  36.  
  37.  
  38.  
  39. (@bold@)NoSetFont(@bold@) - Disables font settings imbeded in help
  40. files. If you set this variable, and the above variable, you can make all
  41. help windows to have the font of your choice.
  42.  
  43.  
  44.  
  45. (@bold@)NumClicks(@bold@) - Sets the number of click needed to activate
  46. a link. Can be a value from 1 to 4.
  47.  
  48.  
  49.  
  50. (@bold@)AskFirst(@bold@) - If this variable exists, then HyperHelp will
  51. ask for confirmation from the user before allowing a link to activate
  52. and execute. An antiviral measure.
  53.  
  54.  
  55.  
  56. (@bold@)LSpace(@bold@) - Sets the default line spacing for all help windows.
  57.  
  58.  
  59.  
  60. (@bold@)PenColor(@bold@) - Sets the default color for displaying
  61. text in help windows.  It can be 1, 2, or 3.  Color 0 is the 'papercolor' or
  62. background color.  (@color 1@)This is color 1, (@color 2@)this is color 2,
  63. and (@color 3@)this is color 3(@color 1@).
  64.  
  65.  
  66.  
  67. (@bold@)Top(@bold@) - The distance, in pixels, from the top of
  68. the screen to the top of the first (toplevel) window.
  69.  
  70.  
  71.  
  72. (@bold@)Left(@bold@) - The distance, in pixels, from the left
  73. side of the screen to the left side of the first (toplevel) window.
  74.  
  75.  
  76.  
  77. (@bold@)Height(@bold@) - The default height, in pixels, of
  78. help windows.
  79.  
  80.  
  81.  
  82. (@bold@)Width(@bold@) - The default width, in pixels, of
  83. help windows.
  84.  
  85.  
  86.  
  87. (@bold@)YInc(@bold@) and (@bold@)XInc(@bold@) - The number of pixels to
  88. offset each new window from its predecessor.  (@bold@)YInc(@bold@)
  89. offsets vertically, and (@bold@)XInc(@bold@) offsets horizontally.  This
  90. prevents new windows from completely hiding previously opened windows.
  91.  
  92.  
  93.  
  94. (@bold@)Refresh(@bold@) - If set to SMART_REFRESH, then HyperHelp
  95. will use Smart_REFRESH windows instead of SIMPLE_REFRESH. (@ref help:amiga/windowrefresh@)
  96. Click here for more info about refresh modes.(@unref@)
  97.  
  98.  
  99.  
  100. (@bold@)HelpScreen(@bold@) - If the value of this variable is
  101. "CUSTOM" or "CUSTOMSCREEN," then HyperHelp uses a custom screen to display
  102. help windows.  This screen automatically opens when HyperHelp
  103. opens the first window, and it closes when you close the last window. You
  104. can also specify "INTERLACE" in this variable to make the custom screen
  105. be interlaced.
  106.  
  107.  
  108.  
  109. (@label files@)(@Bold@)RootFile(@bold@) - Specify that the Rootfile should
  110. be something instead of "help:toplevel".
  111.  
  112.  
  113.  
  114. (@bold@)IndexFile(@bold@) - Specify that the master index file should
  115. be something other than "help:index".
  116.  
  117.