Help file for BFREE

This is BFree, Copyright (c) Allegro Consultants, Inc.

BFree is used to save Extent B-Tree entries needlessly used by
TurboIMAGE.

In addition, BFree can report information about the Extent B-Tree
table.

BFree currently has two different strategies it employs to save
Extent B-Tree table entries.  These are referred to as BFree.1
and BFree.2.  BFree.1 saves one entry per opened jumbo dataset.
BFree.2 saves two entries per opened database.
By default, both kinds of savings are enabled/disabled together.

The most used commands are probably:

   INFO     ... what VSM tables are filling up?
   OFF      ... disable saving Extent B-Tree entries
   ON       ... enable saving Extent B-Tree entries
   STATUS   ... report status of BFree & Extent B-Tree table

The commands are:

CONTACT

   The CONTACT command displays contact information for Allegro
   Consultants, Inc.

EXIT or //

   Terminates this program immediately.

HELP or ? [prefix]

   Displays this help information.

   If you provide a prefix, only those sections with keywords that
   start with that prefix will be displayed.

INFO

   Reports the status of the various VSM tables.

OFF [BFREE.1 | BFREE.2]

   The OFF command turns off the BFree saving modes.

   By default, all BFree savings are turned off.  You may
   specify BFREE.1 or BFREE.2 to turn off that style of
   savings instead of all savings.

   Any entries saved prior to this point will still
   be saved.

ON  [BFREE.1 | BFREE.2]

   The ON command turns on the BFree saving modes.

   By default, all BFree savings are turned on.  You may
   specify BFREE.1 or BFREE.2 to turn on that style of
   savings instead of all savings.

   Any entries used prior to this point will still be
   in use (and not "saved").

SET [ <options> ]*
reSET [ <options> ]*

      options ::= 80 | 132 | 256 |
                 noHEX |
                 MAXERRors # |
                 noPAGING | RESET | SET |
                 noTRACE_PE | noVerbose | WIDTH #

   Allows you to SET (or RESET) various options:
      HEX         ... display KSOs as hex values
      MAXERRORS # ... specify the maximum number of erors
                      that the VSOD command may encounter
                      before it terminates.  (default: 10)
                      A value of 0 means "no limit".
      PAGING      ... for paginated output
      TRACE_PE    ... enabling tracing of pearm/pedisarm
      WIDTH       ... terminal width
      80          ... WIDTH 80 *and* the HP escape
                      sequence to set the terminal
                      to 80 columns is sent.

      132         ... WIDTH 132 *and* the HP escape
                      sequence to set the terminal
                      to 132 columns is sent.

   The number of lines per output page defaults to 24,
   and can be overridden by "SETJCW LINES #" prior to
   running BFree.

STATUS  [QUICK]  [SETVAR]

   The STATUS commands reports the number of in-use Extent B-Tree
   entries, and the status of BFree savings mode.

   The SETVAR (or "JCW") option causes STATUS to create some CI
   variables:

      BFREE_ENABLED  ... true/false if any BFree savings is
                         enabled

      BFREE_ENABLED_1 ... true/false if BFree.1 is enabled
      BFREE_ENABLED_2 ... true/false if BFree.2 is enabled

      BFREE_PERCENT_FULL ... how full is the Extent B-Tree table

      BFREE_ENTRIES_IN_USE ... # of Extent B-Tree entries in use

      BFREE_SAVED    ... # of entries saved by BFree, total
      BFREE_SAVED_1  ... # of entries saved by BFree.1
      BFREE_SAVED_2  ... # of entries saved by BFree.2

      BFREE_SAVABLE  ... # of entries savable if all BFree
                         savings had been enabled earlier.

      BFREE_SAVABLE_1 ... # of entries savable if BFree.1
                         had been enabled earlier.

      BFREE_SAVABLE_2 ... # of entries savable if BFree.2
                         had been enabled earlier.

   The QUICK option causes STATUS to just report the status
   of BFree savings mode.

CLEARREDO
DO xxx
LISTREDO
REDO [xxx]
---------------------------------------------------------------

The Extent B-Tree table entries are officially called "nodes",
and each node has up to 4 entries in it.

However, many people in the HP 3000 community refer to the
top-level items in the Extent B-Tree as "entries" instead of
"nodes".  BFree also refers to them as "entries" to avoid
confusion.

---------------------------------------------------------------

2008-02-28
Slight change to the names of CI variables created by
STATUS SETVAR.

2008-02-27
Second version of BFree is released, with additional
savings ("BFree.2").

2008-01-18
First version released.
---------------------------------------------------------------