home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / windows / libra101.zip / LIBRA.MAN < prev    next >
Text File  |  1989-01-21  |  18KB  |  429 lines

  1.  
  2.  
  3.       
  4.       
  5.       
  6.       
  7.       
  8.       
  9.       
  10.       
  11.       
  12.       
  13.       
  14.       
  15.       
  16.       
  17.       
  18.       
  19.       
  20.       
  21.       
  22.       
  23.                                  L I B R A
  24.       
  25.                          Microsoft Librarian Shell
  26.       
  27.       
  28.                                  USER GUIDE
  29.       
  30.                               ────────────────
  31.       
  32.                                 Version 1.01
  33.                               1 December 1988
  34.       
  35.       
  36.       
  37.       
  38.       
  39.       
  40.       
  41.       
  42.       
  43.       
  44.       
  45.                       Copyright 1988 by  Herb Rose
  46.                           All Rights Reserved
  47.  
  48.  
  49.       
  50.       
  51.                        Disclaimer and Warranty Statement
  52.       
  53.           This software is provided  "as is" without  any warranty of  any
  54.           kind, either expressed  or implied, including,  but not  limited
  55.           to, the implied warranties of merchantability and fitness for  a
  56.           particular purpose.   The  entire  risk as  to the  quality  and
  57.           performance of the software  is with you.   Should the  software
  58.           prove defective, you (NOT ADEPT SOFTWARE) assume the entire cost
  59.           of all necessary servicing, repair, or correction.
  60.       
  61.           In no  event shall  Adept  Software be  liable  to you  for  any
  62.           damages,  including  lost   profits,  lost   savings  or   other
  63.           incidental or consequential  damages arising out  of the use  or
  64.           inability to use this  software even if  Adept Software or  it's
  65.           authorized representative has been advised of the possibility of
  66.           such damages, or for any claim by any other party.
  67.       
  68.       
  69.           Several trademarks and  trade names  appear in  this manual,  as
  70.           well as copyrighted names of programs.  These include Microsoft,
  71.           Intel,              LIB,               and               MS-DOS.
  72.  
  73.  
  74.           
  75.       
  76.                               Table of Contents
  77.       
  78.           i.  Ordering Information . . . . . . . . . . . . . . . . 1
  79.       
  80.           1.  Introduction . . . . . . . . . . . . . . . . . . . . 2
  81.       
  82.           2.  Assumptions  . . . . . . . . . . . . . . . . . . . . 2
  83.       
  84.           3.  Running LIBRA. . . . . . . . . . . . . . . . . . . . 2
  85.       
  86.           4.  The LIBRA Display Screen . . . . . . . . . . . . . . 2
  87.       
  88.           5.  Module Names . . . . . . . . . . . . . . . . . . . . 3
  89.       
  90.           6.  PUBLIC Symbols . . . . . . . . . . . . . . . . . . . 3
  91.       
  92.           7.  EXTERNAL Symbols . . . . . . . . . . . . . . . . . . 3
  93.       
  94.           8.  Selecting Modules. . . . . . . . . . . . . . . . . . 3
  95.       
  96.           9.  Extract Modules. . . . . . . . . . . . . . . . . . . 4
  97.       
  98.           10. Delete Modules . . . . . . . . . . . . . . . . . . . 4
  99.       
  100.           11. Add Modules. . . . . . . . . . . . . . . . . . . . . 4
  101.       
  102.           12. Replace Modules. . . . . . . . . . . . . . . . . . . 4
  103.       
  104.           13. Extract and Delete Modules . . . . . . . . . . . . . 4
  105.       
  106.           14. Quitting . . . . . . . . . . . . . . . . . . . . . . 4
  107.       
  108.           15. Help Screen. . . . . . . . . . . . . . . . . . . . . 4
  109.       
  110.           16. Searching For Symbol References. . . . . . . . . . . 4
  111.       
  112.           17. Other Display Fields . . . . . . . . . . . . . . . . 5
  113.       
  114.  
  115.  
  116.       LIBRA User Guide                                          Page 1
  117.       ──────────────────────────────────────────────────────────────────
  118.       
  119.       
  120.       
  121.       i. Ordering Information.
  122.       
  123.           This  program  is   distributed  as  SHAREWARE.     Under   this
  124.           distribution system, you  are licensed to  use this program  for
  125.           the purpose of evaluating  it.  You may  legally make copies  of
  126.           the program  to  distribute to  your  friends or  place  on  BBS
  127.           systems, etc.,  provided  the program  and  text files  are  not
  128.           modified in any way.
  129.       
  130.           This program is not, and has  never been, in the Public  Domain.
  131.           The copyright is held by Herb Rose, owner of Adept Software.  If
  132.           you wish to  continue using LIBRA  after evaluating the  program
  133.           and becoming familiar with it,  you must purchase it from  Adept
  134.           Software.
  135.       
  136.           Registrationprovides you with one year of technical support from
  137.           Adept Software, and reduced prices on future upgrades.
  138.       
  139.           Send to:   Adept Software
  140.                      P.O. Box 2181
  141.                      Woodbridge, Va. 22193
  142.       
  143.           Name               ______________________________________
  144.       
  145.           Company Name       ______________________________________
  146.       
  147.           Address            ______________________________________
  148.       
  149.           City, State, Zip   ______________________________________
  150.       
  151.       
  152.           (  )LIBRA Registration . . . . . . . . . . . $20.00  ________
  153.       
  154.           (  )LIBRA Program Disk - Current Version*  . $ 4.00  ________
  155.               W/Registration Only
  156.       
  157.           (  )AUTOPARK . . . . . . . . . . . . . . . . $12.00  ________
  158.       
  159.       
  160.                                                     Sub-Total  ________
  161.       
  162.               Virginia Residents add 4.5% sales tax            ________
  163.       
  164.       
  165.                                                         Total  ________
  166.       
  167.           * - Be sure to specify the version you are registering.  If there
  168.               is a newer version available, it will be sent immediatley.
  169.               Otherwise, you will receive the next available release.
  170.  
  171.  
  172.       LIBRA User Guide                                          Page 2
  173.       ──────────────────────────────────────────────────────────────────
  174.       
  175.       
  176.                               LIBRA User Guide
  177.       
  178.       1. Introduction
  179.       
  180.           LIBRA is a user interface for the Microsoft LIB program.  Object
  181.           libraries are an  important programming tool,  and this  program
  182.           will make the task of managing your object libraries easier  and
  183.           more enjoyable.   LIBRA  will  not take  the  place of  the  LIB
  184.           program provided with MS-DOS or  your programming language.   It
  185.           is designed to work with LIB to make library management easier.
  186.       
  187.           LIBRA  will  read  object   modules  and  object  libraries   in
  188.           Intel/Microsoft format.  All Microsoft  compilers and  utilities
  189.           produce object modules in this format.  The LIB utility combines
  190.           these object  modules into  libraries.   LIBRA provides  a  user
  191.           interface to  the  LIB  program that  is  both  informative  and
  192.           intuitive.
  193.       
  194.       2. Assumptions
  195.       
  196.           This utility is  a programmer's tool.   It is  assumed that  the
  197.           concept of object modules, libraries, compilers, assemblers, and
  198.           linkers is familiar  to you.    That  being the  case, you  will
  199.           undoubtedly appreciate the greater  control over your  libraries
  200.           that LIBRA will provide.
  201.       
  202.           It is assumed  that the LIB  program is present  in the  current
  203.           directory, or in a directory listed in the current PATH.   LIBRA
  204.           does not replace LIB, it  simply enhances the user interface  to
  205.           it.    LIB   is  called   by  LIBRA  to   perform  all   library
  206.           modifications.
  207.       
  208.       3. Running LIBRA
  209.       
  210.           From the  DOS command  prompt,  type 'LIBRA  [filename]',  where
  211.           [filename] is the name of  an object library in  INTEL/Microsoft
  212.           format.  LIBRA will read the library file, and display important
  213.           information about each  object module  in the library.   If  the
  214.           library file cannot be read, or  the file is not in the  correct
  215.           format (i.e.  not an  Intel/Microsoft  library file),  an  error
  216.           message will be displayed, and LIBRA will not run.
  217.       
  218.           LIBRA builds tables for each module which hold the names of  the
  219.           PUBLIC and EXTERNAL symbols defined or  used by the module.   If
  220.           there is not enough memory available to hold these tables, LIBRA
  221.           will display the message 'Not enough memory', and will not  run.
  222.           This should not be a problem, as I have run LIBRA against a 300K
  223.           library file with a 512K PC.
  224.       
  225.       4. The LIBRA Display Screen
  226.       
  227.           On the top line  of the display you  will see the LIBRA  version
  228.           number, followed by the  file name being viewed.   On the  right
  229.  
  230.  
  231.       LIBRA User Guide                                          Page 3
  232.       ──────────────────────────────────────────────────────────────────
  233.       
  234.           side of the screen you will see the size of the input file.
  235.       
  236.           The main portion of the display  is composed of 4 text  windows.
  237.           The largest window, on  the left side of  the screen, shows  the
  238.           module names  of all  the  object modules  in  the library.    A
  239.           reverse video bar is the LIBRA 'cursor'.  The module name  under
  240.           the cursor is the 'current' module.
  241.       
  242.           In the center of the screen  is a narrow window which shows  the
  243.           size of the object modules.
  244.       
  245.           On the right  side of  the screen  are 2  windows which  display
  246.           symbols defined or used by the 'current' module.
  247.       
  248.       5. Module Names
  249.       
  250.           The large window on  the left of the  screen shows the names  of
  251.           all the modules present in the  library.  The Up Arrow and  Down
  252.           Arrow are used to scroll  this window one line  at a time.   The
  253.           PageUp and PageDown keys are used to scroll the window 10  lines
  254.           at a time.  The HOME key is used to set the cursor on the  first
  255.           module name,  and the  END key  places the  cursor on  the  last
  256.           module name in the library.
  257.       
  258.       6. PUBLIC Symbols
  259.       
  260.           The upper window on the right  of the scrren displays a list  of
  261.           PUBLIC symbols  defined in  the current  module.   These  PUBLIC
  262.           symbols are made known to other object modules when the  library
  263.           is linked into an application.  The  F7 and F8 keys are used  to
  264.           scroll this window up and down if more than 8 PUBLIC symbols are
  265.           defined by the module.
  266.       
  267.       7. EXTERNAL Symbols
  268.       
  269.           The lower window on the right  of the screen displays a list  of
  270.           EXTERNAL symbols referenced by the current module.  The EXTERNAL
  271.           references must be resolved by the linker, using PUBLIC  symbols
  272.           defined by other modules.   F9 and F10  are used to scroll  this
  273.           window up  and  down,  if  more  than  8  EXTERNAL  symbols  are
  274.           referenced by the current module.
  275.       
  276.       8. Selecting Modules
  277.       
  278.           LIBRA works  on a  'selected'  module scheme.   You  select  the
  279.           module or modules to be acted on, then choose an action for  the
  280.           selected modules.  To  select a module,  position the cursor  on
  281.           the module to be selected, and press ENTER.  The selected module
  282.           will be highlighted, and a marker will be shown in front of  the
  283.           module name.  The cursor  will automaticlly advance to the  next
  284.           module name.  You may select as many modules as you wish in this
  285.           manner.
  286.       
  287.           To un-select a module, position the cursor on the module name to
  288.  
  289.  
  290.       LIBRA User Guide                                          Page 4
  291.       ──────────────────────────────────────────────────────────────────
  292.       
  293.           be un-selected, and press ENTER.  You may un-select all selected
  294.           modules by pressing the F3 key.
  295.       
  296.       9. Extract Modules
  297.       
  298.           Once you have selected one or more modules, you may extract  the
  299.           modules by pressing the 'E' key.   Object files will be  created
  300.           for each selected module.  The contents of the library file  are
  301.           unaffected.
  302.       
  303.       10. Delete Modules
  304.       
  305.           Pressing the  'D' key  will  cause all  selected modules  to  be
  306.           deleted from the library.  No object files are created.
  307.       
  308.       11. Add Modules
  309.       
  310.           It is not  necessary to  select any  modules to  perform an  Add
  311.           operation.  Press the 'A' key, and you will be prompted for  the
  312.           file name of an object  file to Add to  the library.  After  the
  313.           object file has been  added to the library,  the library is  re-
  314.           loaded into LIBRA's memory.
  315.       
  316.       12. Replace Modules
  317.       
  318.           When you press the 'R' key, all selected modules in the  library
  319.           are replaced.   Replacement means that  they are first  Deleted,
  320.           then Added back into the  library.  The object files  associated
  321.           with the  modules  must reside  in  the current  directory.  The
  322.           library file is re-loaded when the Replace function completes.
  323.       
  324.       13. Extract and Delete Modules
  325.       
  326.           Pressing the  'X' key  will  cause all  selected modules  to  be
  327.           Extracted, then Deleted from the  library.  The library file  is
  328.           re-loaded when the the Extract and Delete function completes.
  329.       
  330.       14. Quitting
  331.       
  332.           Pressing the 'Q'  key or  the ESCape key  will terminate  LIBRA.
  333.           You will be asked if you really wish to quit the program.
  334.       
  335.       15. Help Screen
  336.       
  337.           Pressing the 'H'  key will  cause the  LIBRA Help  Screen to  be
  338.           displayed.  This is a reminder screen, and does not contain full
  339.           operating instructions.
  340.       
  341.       16. Searching For Symbol Refernces
  342.       
  343.           You may search through the  modules for references, both  PUBLIC
  344.           and EXTERNAL to specific symbols.  To do this, simply press  the
  345.           F1 key.  You must supply the  name of the symbol to search  for,
  346.           and press ENTER to  accept the symbol and  begin the search.  If
  347.  
  348.  
  349.       LIBRA User Guide                                          Page 5
  350.       ──────────────────────────────────────────────────────────────────
  351.       
  352.           you make an error  entering the symbol  name, use the  BACKSPACE
  353.           key to correct it, just as you would on the DOS command line.
  354.       
  355.           To abort  the  search  operation,  press  ESCAPE.    The  search
  356.           function will terminate,  and return  you to  the LIBRA  display
  357.           screen.
  358.       
  359.           The search  starts at  the current  module.   If the  symbol  is
  360.           found, the  module containing  the symbol  is made  the  current
  361.           module, and it is displayed on the screen.
  362.       
  363.           To continue  searching for  a previously  defined symbol,  press
  364.           the F2 key.   The search  will begin at  the module  immediately
  365.           after the current module.
  366.       
  367.       17. Other Display Fields
  368.       
  369.           Below the  windows  you  will  find  several  peices  of  useful
  370.           information.  They are :
  371.       
  372.           Publics :  The number of PUBLIC symbols defined by the current
  373.                      module.
  374.       
  375.           Externs :  The number of EXTERNAL symbols referenced by the
  376.                      current module.
  377.       
  378.           Module 2 of 12 : Shows how many modules are defined in the
  379.                      library, and the number of the current module.
  380.       
  381.           n Modules Marked : Shows how many modules are currently
  382.                      selected.  See section 8 above.
  383.       
  384.  
  385.  
  386.       LIBRA User Guide                                          Page 6
  387.       ──────────────────────────────────────────────────────────────────
  388.       
  389.       
  390.       
  391.       
  392.       The following is an advertisement for AUTOPARK.
  393.       
  394.       
  395.           I have gotten into the habit of leaving my computer on for hours
  396.           at a time, while I work on several projects.  I have developed a
  397.           program called AUTOPARK, which will AUTOMATICALLY park the heads
  398.           on my fixed disks during periods of  no disk activity.  It is  a
  399.           memory resident  program,  and  does not  interfere  with  other
  400.           programs the computer might be running.
  401.       
  402.           With AUTOPARK, you can be assured that your data is protected as
  403.           much as possible when  you lose power, or  when a less  diligent
  404.           person just turns the computer off without parking the heads.
  405.       
  406.           The program is  great for BBS  systems and office  environments,
  407.           where your computers may be left running for hours or days  with
  408.           BBS programs or  spreadsheets being  recalculated.   As long  as
  409.           there is no disk  activity, the heads are  safely parked.   When
  410.           the disk is accessed, a timer  starts.  When the timer  expires,
  411.           the heads are parked again. Each disk access restarts the timer.
  412.           The duration of the timer is set when you first run the program,
  413.           and is variable up to an hour.  The program only takes 640 bytes
  414.           of RAM,  and  does  not interfere  with  other  memory  resident
  415.           programs.
  416.       
  417.           To order AUTOPARK,  send $12 (price includes S&H) to :
  418.       
  419.               Adept Software
  420.               P.O. Box 2181
  421.               Woodbridge, Va.  22193
  422.       
  423.           Specify      that      you      are      ordering      AUTOPARK.
  424.           Va. residents please add sales tax.
  425.       
  426.                                               Herb Rose
  427.       
  428.       
  429.