home *** CD-ROM | disk | FTP | other *** search
/ Boston 2 / boston-2.iso / DOS / PROGRAM / C / CBASE / BLKIO112.ZIP / BLKIO.RME < prev    next >
Encoding:
Text File  |  1990-06-20  |  8.8 KB  |  261 lines
  1. ----------------------------------------------------------------------
  2. | Citadel                                                            |
  3. | 241 East Eleventh Street * Brookville, IN 47012 * 317-647-4720     |
  4. |                                               BBS 317-647-2403     |
  5. ----------------------------------------------------------------------
  6.  
  7. blkio is distributed in a single compressed file blkioRL.zip; R and L
  8. would be the release and level numbers, respectively.  The ZIP data
  9. compression utilities are needed to extract the individual files.
  10.  
  11. The following files are obtained by decompressing blkioRL.zip:
  12.  
  13.    blkio.rme  preliminary information
  14.  license.txt  license
  15. rlsnotes.txt  release notes
  16. makefile      UNIX makefile
  17.  install.bat  MS-DOS installation batch file
  18.    blkio.rsp  Response file for building Turbo C library.
  19.        *.h    blkio header source files
  20.        *.c    blkio C source files
  21.   manxRL.zip  manx utility
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.                                                      Citadel  90/06/20
  53. ----------------------------------------------------------------------
  54. | blkio - block buffered i/o library                                 |
  55. | Version 1.1.2                                                      |
  56. ----------------------------------------------------------------------
  57.  
  58. ======================================================================
  59. COPYRIGHT
  60.  
  61. Copyright (c) 1989 Citadel.
  62.  
  63. Citadel
  64. 241 East Eleventh Street
  65. Brookville, IN 47012
  66. 317-647-4720
  67. BBS 317-647-2403
  68.  
  69. See the file license.txt for copyright information and disclaimer.
  70.  
  71. ======================================================================
  72. BLKIO
  73.  
  74. The blkio library is a buffered input/output library for C similar to
  75. the stdio library but designed for use with structured files.  The LRU
  76. (least recently used) replacement algorithm is used for buffering.
  77. The reference manual is embedded in the source code (see INSTALLATION
  78. INSTRUCTIONS, below).  For additional information on using the
  79. library, see the article "A Buffered I/O Library for Structured Files"
  80. in the October 1989 issue of "The C Users Journal."
  81.  
  82. The blkio library is a component of cbase, a C database library
  83. developed by Citadel.
  84.  
  85. ======================================================================
  86. INSTALLATION INSTRUCTIONS
  87.  
  88. In the blkio header file blkio.h are a set of macros used to indicate
  89. what ANSI features are supported by the compiler being used.  For
  90. instance, the macro AC_PROTO is used to indicate function prototype
  91. support.  These macros should be carefully examined and set
  92. appropriately.
  93.  
  94. To select the host operating system, set the HOST macro in the private
  95. header file blkio_.h.  The modifications necessary to port blkio to a
  96. new operating system should not prove difficult, consisting mostly of
  97. direct translations of system calls such as open, close, and lseek.
  98. All operating system dependent code is located in the files buops.c
  99. and lockb.c.
  100.  
  101. If using MS-DOS, also set the MSDOSC macro in blkio_.h to the C
  102. compiler being used.  The modifications necessary to port to a new C
  103.  
  104.                                                      Citadel  90/06/20
  105. compiler should be minimal, consisting only of translations of header
  106. file names and macro names such as those used by open and lseek.
  107.  
  108. Because of the lack of uniformity among MS-DOS C compilers, exact
  109. installation procedures for this system vary widely.  The supplied
  110. batch file install.bat is written for Borland Turbo C.  install.bat
  111. takes two arguments.  The first specifies the memory model, legal
  112. values for which are s, m, c, l, and h; the library file is named
  113. blkiom.lib, where m would correspond to the memory model of the
  114. library.  The second, if present, causes the reference manual to be
  115. extracted from the source code into the file blkio.man.
  116.  
  117. Before installing blkio, the manx utility should be compiled and
  118. placed in a directory in the path.  manx is used to extract the
  119. reference manual.
  120.  
  121.                                  UNIX
  122.      1. Set the HOST macro in blkio_.h to UNIX.
  123.      2. Install the boolean header file.
  124.              $ su
  125.              # cp bool.h /usr/include
  126.              # ^d
  127.      3. Extract the reference manual.
  128.              $ make man
  129.      4. Build the blkio library.
  130.              $ make blkio
  131.      5. Install the blkio library.  This will copy the blkio header
  132.         file blkio.h to /usr/include and the blkio library archive
  133.         to /usr/lib.
  134.              $ su
  135.              # make install
  136.              # ^d
  137.  
  138.                                 MS-DOS
  139.      1. Set the HOST macro in blkio_.h to MS_DOS.
  140.      2. Set the MSDOSC macro in blkio_.h to the C compiler being used.
  141.      3. If necessary, modify install.bat for the C compiler being
  142.         used.
  143.      4. Extract the reference manual, then build and install the blkio
  144.         library.
  145.              > install h x
  146.         Install may be rerun (without the x argument) for each desired
  147.         memory model.
  148.  
  149. ======================================================================
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.                                                      Citadel  90/06/20
  157. ----------------------------------------------------------------------
  158. | cbase - The C Database Library                                     |
  159. | Version 1.0                                                        |
  160. ----------------------------------------------------------------------
  161.  
  162. cbase is a complete multiuser C database file management library,
  163. providing indexed and sequential access on multiple keys.  It features
  164. a modular design, comprising four individual libraries:
  165.  
  166.      cbase - C database library
  167.      lseq  - doubly linked sequential file management library
  168.      btree - B+-tree file management library
  169.      blkio - block buffered input/output library
  170.  
  171. cbase internally uses lseq for record storage and btree for inverted
  172. file index storage, which in turn use blkio for file access and
  173. buffering; blkio is analagous to stdio but based on a file model more
  174. appropriate for structured files such as used in database software.
  175. The figure below diagrams the hierarchical relationship of the cbase
  176. libraries.
  177.  
  178.                  -----------------------------------
  179.                  |              cbase              |
  180.                  -----------------------------------
  181.                          |                 |
  182.                  ----------------- -----------------
  183.                  |     lseq      | |     btree     |
  184.                  ----------------- -----------------
  185.                          |                 |
  186.                  -----------------------------------
  187.                  |              blkio              |
  188.                  -----------------------------------
  189.  
  190.                            cbase Libraries
  191.  
  192.  
  193. The lower level libraries can also be accessed directly for
  194. independent use.  For example, the btree library can be used to
  195. manipulate B+-trees for purposes other than inverted files, and the
  196. blkio library to develop new structured file management libraries.
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.                                                      Citadel  90/06/20
  209.  
  210.                             cbase Features
  211.                             --------------
  212. Portable:
  213.   - Written in strict adherence to ANSI C standard.
  214.   - K&R C compatibility maintained.
  215.   - All operating system dependent code is isolated to a small portion
  216.     of the blkio library to make porting to new systems easy.
  217.   - UNIX and MS-DOS currently supported.*
  218. Buffered:
  219.   - Both records and indexes are buffered using LRU (least recently
  220.     used) buffering.
  221. Fast and efficient random access:
  222.   - B+-trees are used for inverted file key storage.
  223.   - Multiple keys are supported.
  224.   - Both unique and duplicate keys are supported.
  225. Fast and efficient sequential access:
  226.   - B+-trees also allow keyed sequential access.
  227.   - Records are stored in doubly linked lists for non-keyed sequential
  228.     access.
  229.   - Both types of sequential access are bidirectional.
  230. Multiuser:
  231.   - Read-only locking.
  232. Other:
  233.   - Text file data import and export.
  234.   - Custom data types can be defined.
  235.   - Marker used to detect corrupt files when opened.
  236.   - Reference documentation is in standard UNIX manual entry format,
  237.     including errno values.
  238.  
  239.  
  240. $77 plus shipping                                      VISA/MasterCard
  241.  
  242. All source code included.
  243. Technical support included.
  244. No run-time fees or royalties.
  245.  
  246. Citadel
  247. 241 East Eleventh Street
  248. Brookville, IN 47012
  249. 317-647-4720
  250. BBS 317-647-2403
  251.  
  252. An evaluation copy of cbase can be obtained at no charge on the
  253. Citadel BBS 317-647-2403, or send $5 for diskette.
  254.  
  255.  
  256.  
  257. * UNIX is a trademark of AT&T.  Turbo C is a trademark of Borland
  258.   International, Inc.  MS-DOS is a trademark of Microsoft.
  259.  
  260.                                                      Citadel  90/06/20
  261.