home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / editor / blkbeard / readme.too < prev    next >
Text File  |  1994-01-30  |  3KB  |  93 lines
  1. Table of Contents
  2.  
  3.    Blackbeard/2 (BB2) is a self-contained program.  The documentation is
  4. built into the program itself.  The help and menu system provide complete
  5. information on all of Blackbeard/2's functions.
  6.  
  7. Alt-H calls up Blackbeard/2's help system.  Blackbeard/2's help
  8. system is context sensitive and available for status line prompts and menu
  9. selections.  The help system is hypertext style, allowing you to move quickly
  10. from topic to topic.  The message line at the bottom lists the help function
  11. keys.
  12.  
  13. Introductory help information topics are:
  14.    Running Blackbeard/2
  15.    System Configuration
  16.    Installation
  17.    Menus
  18.  
  19. The key to using Blackbeard/2 is the menu system.  All of Blackbeard/2's
  20. functions are available through the menu system.  The Esc key will pop up the
  21. menus.  The menu consists of grouped commands.  Each menu contains a list of
  22. functions and corresponding key bindings.  Help is available directly on the
  23. menu for each topic.
  24.  
  25. Please note that Blackbeard/2's Manual generator (BB2MAN) is uses this
  26. help information and does not produce any additional information.
  27.  
  28. Other topics of general interest are:
  29.    Registration
  30.    History
  31.    Copyright & Redistribution Limitations
  32.    Questions about Blackbeard
  33.  
  34. Installation
  35.  
  36.                  Blackbeard/2 Installation Instructions
  37.  
  38. Blackbeard/2 is (sometimes) distributed in an self-executing archived format.
  39. To unarchive Blackbeard/2, run the BB2103 executable and specify the directory
  40. (for example \BB2) where you want Blackbeard/2 installed.  The directory must
  41. exist for proper unarchiving.
  42.  
  43. For example,
  44.  
  45.    BB212 \BB2
  46.  
  47. After, BB2103 has unarchived itself, you will probably want to include the
  48. Blackbeard/2 directory in your path command.  This allows BB2 to run from
  49. any directory.  Do this by modifying your AUTOEXEC.BAT file with the following
  50. type of commands:
  51.  
  52. cd \cb
  53. BB2 \autoexec.bat
  54.          ... Add C:\BB2 to the PATH command, then ...
  55.             ^Z                -- BB2 Saves File
  56. ctrl-alt-del         -- Reboot system
  57.  
  58. In addition, Blackbeard/2 uses the BB2DIR symbol, to locate many of its
  59. configuration and help files.  Place the following command in your
  60. AUTOEXEC.BAT file.
  61.  
  62.    SET BB2DIR=<directory> for example:  SET BB2DIR=C:\BB2
  63.  
  64.    Blackbeard/2 will look in the BB2DIR directory for the help file,
  65. configuration file, paste file, etc.  Additional system configuration is
  66. also available.
  67. Running Blackbeard/2
  68.  
  69.    To run Blackbeard/2 use:
  70.       BB2 <filename>
  71. Blackbeard/2 will display the startup screen and ask you for a file to
  72. edit (if one is not present).  For a list of files press just the enter.
  73.  
  74. NOTE: BB2 with no filename and the save/restore option on will load the
  75. previously edited files.
  76.  
  77. Alt-H will pop up help. Esc will pop up the main menu.
  78. Esc gets you out of both help and menus.
  79.  
  80. To use more than 25 rows or 80 columns, specify the number of rows and columns
  81. on the command line.  Otherwise, Blackbeard/2 will not access the screen
  82. properly.  Use the following command:
  83.  
  84.    BB2/r#/c# <filename>
  85.  
  86. for example BB2/r50/c80 will run Blackbeard/2 with 50 rows and
  87. 80 columns.
  88.  
  89. ATTN:  CGA / VGA monochrome users, (why I'll never know) The current
  90. versions of BB will come up using colors that translate to very odd
  91. levels of grey. No problem just use <ALT-F9> to change to black and white
  92. this will be saved away when you learn how to save the configuration.
  93.