home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 October / usenetsourcesnewsgroupsinfomagicoctober1994disk2.iso / misc / volume10 / parseargs / README < prev    next >
Text File  |  1990-02-16  |  4KB  |  96 lines
  1.  
  2.               NIFTY UTILITY LIBRARY
  3.  
  4.                  Eric P. Allman
  5.             University of California
  6.               Berkeley, California
  7.                 eric@Berkeley.EDU
  8.  
  9.  
  10. SUMMARY
  11.     This directory contains a subset of a utility library that I have
  12.     used (in various forms) for several years now.  This particular
  13.     version is rather sparse, being a relatively recent reimplementation.
  14.  
  15.     I am making this available as a result of the rather surprising
  16.     response to my C Advisor column in UNIX Review Vol. 7 No. 11 on
  17.     argument parsing, in which I described an alternative to getopt.
  18.     Several dozen people have asked for the source code -- an amazing
  19.     number, considering that in the four years prior to this column,
  20.     I have gotten perhaps six letters in toto.
  21.  
  22.     Rather than limiting this distribution to the single argument
  23.     parsing module, I have added several other routines, many of which
  24.     my more faithful readers will recognize.
  25.  
  26. COPY/REUSE POLICY
  27.     Permission is hereby granted to freely copy and redistribute this
  28.     software, provided that the author is clearly credited in all
  29.     copies and derivations.  Neither the name of the author nor that
  30.     of the University may be used to endorse or promote products
  31.     derived from this software without specific written permission.
  32.     This software is provided ``As Is'' and without any express or
  33.     implied warranties.
  34.  
  35. CONTENTS
  36.     This directory contains:
  37.         README -- this file.
  38.         Makefile -- a makefile for the library.
  39.         useful.h -- a general header file, used by most everything.
  40.         ckalloc.c -- an interface to malloc(3) which diagnoses
  41.             out of memory conditions.  This topic was discussed
  42.             in the C Advisor column in UNIX Review Vol. 7 No 7.
  43.         ckalloc.3 -- documentation for ckalloc.
  44.         funclist.h -- a header file specific to the function list
  45.             routines in funclist.c.
  46.         funclist.c -- routines that provide lists of ``callout''
  47.             functions, used by several of the other routines
  48.             to handle errors.
  49.         funclist.3 -- documentation for the funclist routines.
  50.         lwp_dump.c -- a routine to dump the state of the LightWeight
  51.             Process system in SunOS 4.0 -- this isn't used, but
  52.             may be useful to some of you.
  53.         openpath.c -- a routine to open a file, searching through
  54.             a path of directories to find it.
  55.         openpath.3 -- documentation for openpath.
  56.         parseargs.h -- headers for the argument parser.
  57.         parseargs.c -- a command line argument parser.  Popular
  58.             response to my C Advisor column about this routine
  59.             in UNIX Review Vol. 7 No. 11 prompted me to make
  60.             this distribution available.
  61.         parseargs.3 -- documentation for parseargs.
  62.         fp_args.c -- argument value parsers for floating point values;
  63.             used by parseargs.  This is only included if you need
  64.             FP values.  I had to break this out because RISC/os
  65.             4.01 from Mips doesn't seem to support strtod in the
  66.             BSD environment.  You may find you need to include
  67.             -lm for this to work.
  68.         syserr.c -- error message printing routines.  A version of
  69.             this was discussed in the C Advisor column in UNIX
  70.             Review, Vol. 7 No. 7.
  71.         syserr.3 -- documentation for syserr.
  72.         traceset.c -- routines to set trace flags.  The flags are
  73.             tested by macros contained in useful.h.
  74.         trace.3 -- documentation for the trace routines and macros.
  75.         stest.c -- a small test program for the argument parser.
  76.  
  77.     The parseargs routine really ought to have a way of matching a
  78.     list (e.g., return the rest of argv).  This isn't especially
  79.     hard to do, but I haven't gotten around to it yet.
  80.  
  81. DISCLAIMERS
  82.     I hacked this code up to (hopefully) work on ANSI C compilers,
  83.     since several readers seem to be interested in this sort of thing.
  84.     I can't claim to have really tested this.
  85.  
  86.     The original version was tested under SunOS 4.0 on SPARC architectures.
  87.     The version you see has been loosely tested on a Mips M/2000 running
  88.     RISC/os 4.01; I have only tried it in the BSD environment, and that
  89.     only loosely.
  90.  
  91. ACKNOWLEDGEMENTS
  92.     I wrote the first version of this code while working at the
  93.     International Computer Science Institute in Berkeley, CA.
  94.  
  95. $Header: README,v 2.1 89/12/30 20:59:14 eric Exp $
  96.