home *** CD-ROM | disk | FTP | other *** search
/ Shareware 1 2 the Maxx / sw_1.zip / sw_1 / DBASE / DBX112.ZIP / README.DOC < prev    next >
Text File  |  1992-04-07  |  10KB  |  213 lines
  1. dbMAX(tm) Version 1.12
  2. Copyright (c) 1991-1992 David A. Kennedy.
  3. All rights reserved.
  4.  
  5.  
  6. INTRODUCTION
  7. ============
  8.  
  9. dbMAX is an xBASE utility that will allow complete multi-user access to xBASE
  10. databases and Clipper(tm) indexes.  The program uses a CUA-type menu system
  11. with Brief(tm)-style hot keys and can browse databases in up to 250 moveable,
  12. sizable windows.  Almost every Clipper/dBASE(tm) command is available,
  13. allowing dbMAX to replace the dBASE Assist/Control Center or Nantucket's DBU
  14. utility.  dbMAX also has a partially open architecture, allowing programmers
  15. to create their own menus and operate on dbMAX internal data structures.
  16.  
  17.  
  18. COMPILE and LINK
  19. ================
  20.  
  21. This version of dbMAX does not include the source code.  If enough people
  22. are interested, I will upload the source at a later date.
  23.  
  24. To link dbMAX you will need Clipper 5.01.  A batch file, MAKEDBX.BAT, is
  25. provided to you to automate this task.  Linking can be performed with
  26. .RTLink, Blinker, or any other dynamic overlay linker.  .RTLink and Blinker
  27. link files are provided.  The MAKEDBX.BAT file and the .LNK files are set
  28. up assuming you have no third-party linker or libraries, so you may want to
  29. edit these files (add/remove comments).
  30.  
  31.  
  32. THIRD-PARTY LIBRARIES
  33. =====================
  34.  
  35. A few third-party libraries are used by dbMAX.  The third-party functions
  36. called by dbMAX are NOT critical to the operation of the program and can be
  37. removed and/or worked around.  The following functions are used:
  38.  
  39. IDL 2.11:    kbd_alt()   - detects if <Alt> key was pressed
  40.  
  41. ProClip 4.0: alldrives() - returns a string of all valid drive letters
  42.              dosargs()   - returns command line arguments (i.e., true name)
  43.              clock()     - ticking clock
  44.              curpath()   - gets the current drive/path on the specified drive
  45.              flipcolor() - reverses colors
  46.              getcolor()  - gets the screen color at a location
  47.              isptr()     - is printer port ready
  48.              newcolor()  - changes background color (for shadows/lowlighting)
  49.  
  50. Overlay 3.5: overlay()   - swaps out memory for shelling to DOS
  51.  
  52. If you do not have one or more of the above libraries, I have included
  53. FIXUP.PRG which contains all the third-party functions re-written using
  54. Clipper 5.0 and/or NANFOR.LIB, so that none of the original source code needs
  55. to be modified.  This .PRG can also be used if you don't like one or more of
  56. the above libraries and want to use your preferred libraries.
  57.  
  58.  
  59. RUNNING dbMAX
  60. =============
  61.  
  62. The only file you need to run the program is DBX.EXE.  All other files are
  63. optional.  A missing DBX.INI file will cause a warning message to appear.
  64.  
  65. To run dbMAX, type DBX at the DOS prompt.  DBX /? will list all the command
  66. line parameters that can be used.
  67.  
  68.      Syntax:    DBX [database] [index] [switches]
  69.  
  70.      where:     database = name of database, extension not required
  71.                 index    = name of index, extension not required
  72.  
  73.      Switches:  /C<n>    = columns to display      (default=80)
  74.                 /R<n>    = rows to display         (default=25)
  75.                 /S       = single-user             (default=multi-user)
  76.                 /T       = temporary files drive   (default=current)
  77.                 /U<file> = use specified .INI file (default=DBX.INI)
  78.                 /V<file> = use specified .ENV file (default=DBX.ENV)
  79.                 /?       = help screen
  80.  
  81. The parameters can appear in any order, except that the database name must
  82. appear before the index name.  Please note that the following additional
  83. parameters can be specified as long at they appear BEFORE any others:
  84.  
  85.      //E:<nExpanded>     = amount of EMS to use (in KB, default=ALL)
  86.      //F:<nHandles>      = number of file handles to use (default=50)
  87.      //X:<nKbytes>       = amount of conventional RAM to exclude
  88.      //CGACURS           = fixes possible cursor problems (default=ON)
  89.      //SWAPK:<nBytes>    = maximum swap file size
  90.      //SWAPPATH:'<path>' = path where VMM swap files are placed
  91.      //TEMPPATH:'<path>' = path where temp index/sort files are placed.
  92.  
  93.  
  94. NETWORKS
  95. ========
  96.  
  97. When running dbMAX in a network environment, BE SURE to set the temporary
  98. files drive to a LOCAL DRIVE or your personal drive/directory!  The temporary
  99. files drive is not the same as the one specified by //SWAPPATH and //TEMPPATH
  100. above.  Having these three parameters point to a RAM disk will provide the
  101. best performance.
  102.  
  103. Installing dbMAX on a network is not recommended since other users can
  104. overwrite your initialization and environment files.  This can be worked
  105. around by running dbMAX from a batch file as follows:
  106.  
  107.      DBX /U<userdrive:\DBX.INI> /V<userdrive:\DBX.ENV> /TC:\ %1 %2 %3 %4
  108.  
  109.  
  110. TIPS & TRICKS
  111. =============
  112.  
  113. - Since dbMAX does not use report form (.FRM) files, users who want to print
  114.   a "canned" report can use the Heading (F3), Window Column, and environment
  115.   functions to set up a dbMAX session and then save it to an environment
  116.   file (.ENV).  The file can be reloaded (Ctrl-F10) and the database
  117.   printed when required.  Grouping/subtotalling is not possible.
  118.  
  119. - Opening database files in exclusive mode will have a noticeable improvement
  120.   on performance when browsing, indexing, filtering, etc.  F11 toggles the
  121.   open mode.
  122.  
  123. - The About option (on the Help menu) will indicate the amount of RAM
  124.   available to dbMAX.
  125.  
  126.  
  127. KNOWN PROBLEMS
  128. ==============
  129.  
  130. The software is intended to be used by knowledgable xBASE users/programmers
  131. and as a result error handling has been minimized to reduce the size of the
  132. .EXE file and speed up the program.
  133.  
  134. 1)  Entering an illegal filename or pathname will cause a run-time error.
  135.     Opening a corrupted database or index will cause a run-time error.
  136.  
  137. 2)  Browsing the same database in two windows can lead to problems if you
  138.     do something like ZAP the database in one window and then try to browse
  139.     the other (can only happen on local drives).
  140.  
  141. 3)  Changing files in a network environment may cause other users to
  142.     experience problems.  For example, revising a database with an index
  143.     active while someone else is revising it without the index will cause
  144.     the index file to become corrupted.
  145.  
  146. 4)  Entering invalid color settings may cause menu items to be invisible.
  147.     Quitting dbMAX and re-running the program may restore the original colors
  148.     if they were not saved; otherwise, you will have to delete the DBX.INI
  149.     file to restore the default settings.
  150.  
  151. 5)  Using DOS versions earlier than 3.30 may cause multi-user problems on
  152.     networks due to lack of support for COMMIT.  Use of versions earlier than
  153.     3.00 will cause other, more minor, problems due to the DOSARGS() (or 
  154.     FT_ORIGIN()) function.
  155.  
  156. 6)  Some users have reported that their PCs lock-up occasionally during
  157.     swapping (swaps occur when shelling to DOS and calling hyperhelp).  This
  158.     appears to be due to an EMS conflict between Blinker and Overlay().  DOS
  159.     5.0/HIMEM users seem to encounter the problem more often than QEMM users.
  160.     Using the BADEMS switch, setting the BLINKER PAGEFRAME OFF, using the
  161.     new Blinker 2.0 swap function, and/or eliminating the use of the
  162.     Overlay() library will usually fix the problem.
  163.  
  164.  
  165. MODIFICATIONS & FUTURE STUFF
  166. ============================
  167.  
  168. The next minor release of dbMAX may allow printing of memo fields and use
  169. of dBASE report forms.  Concurrent use of the DBFNDX driver may also be
  170. added, though users so far have not asked for it.  For the next major release
  171. of dbMAX I hope to utilize the ProVision:Windows library and/or the new
  172. release of Clipper, such that the program is mouse-able and runs in graphics
  173. or pseudo-graphics mode (like Norton Utils 6.x and PC Tools 7.x).  Also, no
  174. users have needed context-sensitive hyperhelp, so unless there's a big
  175. demand, hyperhelp will remain as is.
  176.  
  177. If you have any comments/suggestions/fixes for dbMAX or want to submit your
  178. user-defined routines for inclusion into later versions of the program, send
  179. them to Dave Kennedy (or Tim Fritz) at CIS #: 76300,2164 and I'll gladly
  180. consider them.  Please keep in mind that the main goal for dbMAX is maximum
  181. performance with minimum bells/whistles/crap (I hope I've done this).
  182.  
  183.  
  184. "FREEWARE" LICENSE AGREEMENT
  185. ============================
  186.  
  187. This software is an original work by David A. Kennedy and is released into
  188. the public domain with restrictions.  The software can be USED, COPIED, and
  189. DISTRIBUTED on an UNLIMITED BASIS, as long as no fee is charged for its use,
  190. copying, or distribution.  All rights to the program worldwide are reserved
  191. by David A. Kennedy.  Unauthorized duplication, distribution, modification,
  192. or decompilation of this software is expressly prohibited.
  193.  
  194. THE SOFTWARE AND ACCOMPANYING DOCUMENTATION ARE PROVIDED "AS IS" WITHOUT
  195. WARRANTY OF ANY KIND.  THE ENTIRE RISK TO THE RESULTS AND PERFORMANCE OF THE
  196. SOFTWARE IS ASSUMED BY YOU.
  197.  
  198. David A. Kennedy will not be liable for any special, incidental,
  199. consequential, indirect or similar damages due to the loss of data, loss of
  200. business profits, business interruption or any other reason, even if David
  201. A. Kennedy has been advised of the possibility of such damages.
  202.  
  203. This is a legal agreement between you, the end user, and David A. Kennedy.
  204. By using or distributing this package, you are agreeing to be bound by the
  205. terms of this Agreement.  If you do not agree to the terms of this agreement
  206. promptly destroy (erase) all copies of the software.
  207.  
  208. The Help! Engine (HELP.EXE) is property of Flambeaux Software, Inc. and
  209. specifically IS NOT placed into the public domain.  All rights worldwide are
  210. reserved by Flambeaux Software, Inc.  Modifications to the Help! Engine are
  211. prohibited.
  212.  
  213.