home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 446.lha / parseargs / README < prev    next >
Text File  |  1990-12-05  |  4KB  |  96 lines
  1.  
  2.                    PARSEARGS
  3.  
  4.                extracted from Eric Allman's
  5.  
  6.               NIFTY UTILITY LIBRARY
  7.  
  8.                  Eric P. Allman
  9.             University of California
  10.               Berkeley, California
  11.                 eric@Berkeley.EDU
  12.  
  13.                 modifications by
  14.  
  15.                  Peter da Silva
  16.            Ferranti International Controls Corporation
  17.                    Sugar Land, Texas
  18.                peter@ficc.uu.net
  19.  
  20.  
  21. SUMMARY
  22.     This directory contains a subset of a utility library that I have
  23.     used (in various forms) for several years now.  This particular
  24.     version is rather sparse, being a relatively recent reimplementation.
  25.  
  26.     [ The rest of the utility library has been left out, to reduce
  27.       the size of Parseargs. The complete set of utilities was pubbed
  28.       in the first comp.sources.misc distribution. -- PDS ]
  29.  
  30.     I am making this available as a result of the rather surprising
  31.     response to my C Advisor column in UNIX Review Vol. 7 No. 11 on
  32.     argument parsing, in which I described an alternative to getopt.
  33.     Several dozen people have asked for the source code -- an amazing
  34.     number, considering that in the four years prior to this column,
  35.     I have gotten perhaps six letters in toto.
  36.  
  37. COPY/REUSE POLICY
  38.     Permission is hereby granted to freely copy and redistribute this
  39.     software, provided that the author is clearly credited in all
  40.     copies and derivations.  Neither the name of the author nor that
  41.     of the University may be used to endorse or promote products
  42.     derived from this software without specific written permission.
  43.     This software is provided ``As Is'' and without any express or
  44.     implied warranties.
  45.  
  46. CONTENTS
  47.     This directory contains:
  48.         README -- this file.
  49.         Makefile -- a makefile for the library.
  50.         useful.h -- a general header file, used by most everything.
  51.         parseargs.h -- headers for the argument parser.
  52.           [ parseargs.c is now broken down into the following files -- PDS ]
  53.         unix_args.c -- a command line argument parser.  Popular
  54.             response to my C Advisor column about this routine
  55.             in UNIX Review Vol. 7 No. 11 prompted me to make
  56.             this distribution available.
  57.         amiga_args.c -- Amiga version of unix_args.c
  58.         arglist.c -- routines for ARGLIST options.
  59.         argtype.c -- routines for other options.
  60.           [ end of parseargs.c -- PDS ]
  61.         parseargs.3 -- documentation for parseargs.
  62.         fp_argtype.c -- argument value parsers for floating point
  63.             values; used by parseargs.  This is only included if
  64.             you need FP values.  I had to break this out becaus
  65.             RISC/os 4.01 from Mips doesn't seem to support strtod
  66.             in the BSD environment.  You may find you need to
  67.             include -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.         stest.c -- a small test program for the argument parser.
  73.           [ strtol.c -- for systems that don't implement strtol. ]
  74.  
  75.     The parseargs routine really ought to have a way of matching a
  76.     list (e.g., return the rest of argv).  This isn't especially
  77.     hard to do, but I haven't gotten around to it yet.
  78.  
  79.     [ Added, with ARGLIST flag. -- PDS ]
  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.