home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / forut062.zip / ForUtil-0.62 / lib / README < prev    next >
Text File  |  1996-08-21  |  3KB  |  80 lines
  1. Routines in this library.
  2.  
  3. (Under MSDOS, the name of the files will differ a little, since msdos 
  4.  chops of characters to fit in a 8+3 filename.)
  5.  
  6. Source Files
  7. ------------
  8.  
  9. filelist.c
  10.    Routines for building a list of files from a directory.
  11.    The files found can be matched against a table with extensions.
  12.  
  13. environment.c
  14.    Routines for resolving references to environment variables and
  15.    user names.
  16.  
  17. msdospwd.c
  18.    a couple of routines that fake unix passwd routines. Needed by
  19.    environment.c. Intended to be used under msdos ONLY. 
  20.    If you want to see a username in the database generated with scan_commons,
  21.    your environment must contain any of the following variables:
  22.    USER, LOGNAME or LOGIN.
  23.  
  24. SplitPath.c
  25.    routines to get a fully qualified path name, nomatter how they
  26.    are given on the command line, i.e, resolves relative paths.
  27.  
  28. stringutil.c
  29.    a number of string routines, including a routine to see if a string
  30.    is at the end of another string.
  31.  
  32. alloca.c
  33.    If your compiler does not support an alloca, you can try to use alloca.c.
  34.    Use at your own risk.
  35.  
  36. Header Files
  37. ------------
  38. forutil.h
  39.    The public header file for this library.
  40.    Contains function prototypes for every public routine in this library.
  41.  
  42. sysdeps.h
  43.    A header file containing UNIX/MSDOS dependent params.
  44.    MSDOS users, if you do get a stack overflow error when running any of
  45.    the programs in ForUtil, you might want to increase the _stklen number
  46.    to a larger value. _stklen indicates the size of the stack you want.
  47.    The default value of 32kb will probably be pretty okay.
  48.  
  49. memmacros.h
  50.    memory allocation macros used throughout the entire source.
  51.    Under MSDOS, all memory allocation is done using far pointers, so be
  52.    sure to compile everything with a LARGE memory model.
  53.    If an allocation fails, these macros exit saying what type of allocation
  54.    failed, how many bytes were requested an at what point in the source
  55.    this happened. Exiting is done by raising a SIGUSR1. For the programs in
  56.    ForUtil that do not have a signal catcher installed, they exit with
  57.    an errorcode of 7.
  58.  
  59. msdospwd.h
  60.    a fake unixlike pwd.h with function prototypes from msdospwd.c
  61.  
  62. How to compile this lib under msdos
  63. -----------------------------------
  64. I've compiled this lib using Borland C/C++ 4.51.
  65.  
  66. You can best create a project for this library and include the source
  67. files mentioned above. You do not need alloca.c
  68.  
  69. This library should be compiled using a large memory model.
  70.  
  71. When compiling, be sure that MSDOS is defined and that stack tracing is on.
  72.  
  73. Koen D'Hondt.
  74. Ripley Software Development.
  75. -------------------------------------------------------------------------------
  76. Reach Out At:     email: ripley@xs4all.nl
  77. Surf The Web:    http://www.xs4all.nl/~ripley
  78. -------------------------------------------------------------------------------
  79.  
  80.