home *** CD-ROM | disk | FTP | other *** search
/ PC Press 1997 July / Sezamfile97_1.iso / msdos / c / cbase11.a03 / CBASE11.ZIP / MANX / README.TXT < prev    next >
Text File  |  1993-01-01  |  8KB  |  260 lines
  1. ----------------------------------------------------------------------
  2. | Citadel Software, Inc.                                             |
  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.     ansi.h    ANSI compatibility header
  16.     port.h    portability header
  17.      dos.mak  DOS makefile (requires cbase support files in ..\dos)
  18.     unix.mak  UNIX makefile (requires cbase support files in ..\dos)
  19.     manx.c    manx source code
  20. manxform.c    sample manual entry form for C
  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  93/01/01
  53. ----------------------------------------------------------------------
  54. | manx - manual entry extractor                                      |
  55. | Version 1.1.3                                                      |
  56. ----------------------------------------------------------------------
  57.  
  58. ======================================================================
  59. COPYRIGHT
  60.  
  61. Copyright (c) 1989-1993 Citadel Software, Inc.
  62. All Rights Reserved
  63.  
  64. Citadel Software, Inc.
  65. 241 East Eleventh Street
  66. Brookville, IN 47012
  67. 317-647-4720
  68. BBS 317-647-2403
  69.  
  70. See the file license.txt for copyright information and disclaimer.
  71.  
  72. ======================================================================
  73. MANX
  74.  
  75. The manx utility extracts manual entries from source files.  The files
  76. are read from stdin and the manual entries are written to stdout.
  77. Each individual manual entry is broken into pages separated by form
  78. feeds and terminated with a form feed.  The manx manual entry located
  79. in manx.c contains a more detailed description.
  80.  
  81. The manx utility was originally developed for cbase, a complete
  82. multiuser C database file management library developed by Citadel.  A
  83. trial copy of cbase may be obtained on the Citadel BBS.
  84.  
  85. ======================================================================
  86. INSTALLATION INSTRUCTIONS
  87.  
  88. Since C compilers are currently at various stages of ANSI compliance,
  89. the user must specify to manx what ANSI features are supported by
  90. his compiler.  This is done by setting a set of ANSI compatibility
  91. macros that have been isolated in the file ansi.h.  For instance, the
  92. macro AC_PROTO should be defined if function prototypes are supported.
  93. As distributed, ansi.h is set up for a fully ANSI compliant compiler.
  94. After ansi.h is set up, it should be copied to the include directory.
  95. Isolating these definitions in a separate header outside of manx
  96. allows ansi.h to be readily available to other applications.
  97.  
  98. Exact installation procedures for DOS vary.  The instructions below
  99. are for Borland Turbo C.
  100.  
  101.  
  102.  
  103.  
  104.                                                      Citadel  93/01/01
  105.                                  UNIX
  106.      1. Compile manx.
  107.              $ make manx
  108.      2. Install manx.  This will copy manx to /usr/bin.
  109.              $ su
  110.              # make install
  111.              # ^d
  112.      3. Extract and print manx manual entry.
  113.              $ make man
  114.              $ lp manx.man
  115.  
  116.  
  117.                                  DOS
  118.      1. Compile manx.
  119.              > bcc -Ox -A -ms manx.c
  120.      2. Install manx by copying it to a directory in the path.
  121.              > copy manx.exe c:\usr\bin
  122.              > del manx.exe
  123.      3. Extract and print manx manual entry.
  124.              > type manx.c | manx > manx.man
  125.              > print manx.man
  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  93/01/01
  157. ----------------------------------------------------------------------
  158. | cbase - The C Database Library                                     |
  159. | Version 1.1                                                        |
  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 layered architecture and comprises four individual libraries.
  165.  
  166.                  -----------------------------------
  167.                  |              ISAM*              |
  168.                  -----------------------------------
  169.                  |         File Structure          |
  170.                  -----------------------------------
  171.                  |          Buffered I/O           |
  172.                  -----------------------------------
  173.                  |           file system           |
  174.                  -----------------------------------
  175.                          cbase Architecture
  176.  
  177.                  -----------------------------------
  178.                  |              cbase              |
  179.                  -----------------------------------
  180.                  |     lseq       |      btree     |
  181.                  -----------------------------------
  182.                  |              blkio              |
  183.                  -----------------------------------
  184.                  |        operating system         |
  185.                  -----------------------------------
  186.                            cbase Libraries
  187.  
  188. The four libraries are:
  189.  
  190.      cbase - C database library for indexed and sequential access
  191.      lseq  - doubly linked sequential file management library
  192.      btree - B+-tree file management library
  193.      blkio - block buffered input/output library
  194.  
  195. cbase internally uses lseq for record storage and btree for inverted
  196. file index storage, which in turn use blkio for file access and
  197. buffering.  blkio is analagous to stdio but based on a file model more
  198. appropriate for structured files such as used in database software.
  199.  
  200. The lower level libraries can also be accessed directly for use
  201. independent of cbase.  For example, the btree library can be used to
  202. manipulate B+-trees for purposes other than inverted files, and the
  203. blkio library to develop new structured file management libraries.
  204.  
  205.  
  206. * ISAM stands for Indexed Sequential Access Method.
  207.  
  208.                                                      Citadel  93/01/01
  209.                             cbase Features
  210.                             --------------
  211. Portable:
  212.   - Written in strict adherence to ANSI C standard.
  213.   - K&R C compatibility maintained.
  214.   - All operating system dependent code is isolated to a small portion
  215.     of the blkio library to make porting to new systems easy.
  216.   - UNIX and DOS currently supported.
  217. Buffered:
  218.   - Both records and indexes are buffered using LRU (least recently
  219.     used) buffering.
  220. Fast and efficient random access:
  221.   - B+-trees are used for inverted file key storage.
  222.   - Multiple keys are supported.
  223.   - Both unique and duplicate keys are supported.
  224. Fast and efficient sequential access:
  225.   - B+-trees also allow keyed sequential access.
  226.   - Records are stored in doubly linked lists for non-keyed sequential
  227.     access.
  228.   - Both types of sequential access are bidirectional.
  229. Multiuser:
  230.   - Read-only locking.
  231. Other Features:
  232.   - Text file data import and export.
  233.   - Custom data types can be defined.
  234.   - Marker used to detect corrupt files.
  235.   - Reference documentation is in standard UNIX manual entry format,
  236.     including errno values.
  237. Utilities:
  238.   - cbddlp, a data definition language processor, is provided to
  239.     automatically generate the C code defining a database.
  240.  
  241.  
  242. $77 plus shipping                                      VISA/MasterCard
  243.  
  244. All source code included.
  245. No run-time fees or royalties.
  246.  
  247. Citadel Software, Inc.
  248. 241 East Eleventh Street
  249. Brookville, IN 47012
  250. 317-647-4720
  251. BBS 317-647-2403
  252.  
  253. An evaluation copy of cbase can be obtained at no charge on the
  254. Citadel BBS, or send $5 for diskette.
  255.  
  256.  
  257.  
  258.  
  259.  
  260.                                                      Citadel  93/01/01