home *** CD-ROM | disk | FTP | other *** search
/ Boston 2 / boston-2.iso / DOS / PROGRAM / C / CBASE / BLKIO112.ZIP / MANX111.ZIP / MANX.RME < prev   
Encoding:
Text File  |  1990-04-18  |  6.7 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. manx is distributed in a single compressed file manxRL.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 manxRL.zip:
  12.  
  13.     manx.rme  preliminary information
  14.  license.txt  license
  15.     manx.c    manx source code
  16.     manx.frm  sample manual entry form
  17.  
  18.  
  19.  
  20.  
  21.  
  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/04/18
  53. ----------------------------------------------------------------------
  54. | manx - manual entry extractor                                      |
  55. | Version 1.1.1                                                      |
  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. MANX
  73.  
  74. The manx utility extracts manual entries from source files.  The files
  75. are read from stdin and the manual entries are written to stdout.
  76. Each individual manual entry is broken into pages separated by form
  77. feeds and terminated with a form feed.  The manx manual entry located
  78. in manx.c contains a more detailed description.
  79.  
  80. The manx utility was written for cbase, a C database library developed
  81. by Citadel.
  82.  
  83. ======================================================================
  84. INSTALLATION INSTRUCTIONS
  85.  
  86. Exact installation procedures for MS-DOS vary.  The exact instructions
  87. below are for Borland Turbo C.
  88.  
  89.                                  UNIX
  90.      1. Compile manx.
  91.              $ cc -O manx.c -o manx
  92.      2. Place manx in a directory in the path.
  93.              $ su
  94.              # mv manx /usr/bin
  95.              # ^d
  96.      3. Extract and print manx manual entry.
  97.              $ cat manx.c | manx > manx.man
  98.              $ lp manx.man
  99.  
  100.                                 MS-DOS
  101.      1. Compile manx.
  102.              > tcc -O -A -ms manx.c
  103.  
  104.                                                      Citadel  90/04/18
  105.      2. Place manx in a directory in the path.
  106.              > copy manx.exe \bin
  107.              > del manx.exe
  108.      3. Extract and print manx manual entry.
  109.              > type manx.c | manx > manx.man
  110.              > print manx.man
  111.  
  112. ======================================================================
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.                                                      Citadel  90/04/18
  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/04/18
  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.  
  258. * UNIX is a trademark of AT&T.  MS-DOS is a trademark of Microsoft.
  259.  
  260.                                                      Citadel  90/04/18
  261.