home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / misc / volume29 / parseargs / part01 / doc / parseargs1.inc < prev    next >
Encoding:
Text File  |  1992-05-19  |  1.6 KB  |  38 lines

  1. .\"----------------------------------------------------------------------------
  2. .\"-- This text was extracted using the following command:
  3. .\"--   xdoc -man -n -p '[ \t]*' -I DESCRIPTION ../parseargs.c
  4. .\"----------------------------------------------------------------------------
  5. .SH DESCRIPTION
  6. Given a command name, a vector of string-valued arguments
  7. such as that passed to a shell script,
  8. and a specification string describing the possible arguments,
  9. .B parseargs
  10. matches actual arguments to possible arguments,
  11. converts values to the desired type,
  12. and diagnoses problems such as
  13. missing arguments,
  14. extra arguments,
  15. and argument values that are syntactically incorrect.
  16. Other behavior such as prompting the user for missing arguments and
  17. ignoring bad command-line syntax may be specified on the command-line
  18. through the use of various options, or through the use of the
  19. ``\s-1PARSECNTL\s+1'' environment variable.
  20. .PP
  21. Given the command name and the argument specification string,
  22. .B parseargs \-U
  23. prints a reasonably friendly version of the usage of the
  24. calling program on standard diagnostic output. The ``verbosity''
  25. of the usage message may be controlled through the use of the
  26. ``\s-1USAGECNTL\s+1'' environment variable.
  27. .PP
  28. Given the command name and the argument specification string,
  29. .B parseargs \-M
  30. prints a template of the command-syntax on standard output that is
  31. suitable for input to \fInroff\fP or \fItroff\fP using the \fI\-man\fP
  32. macro package.
  33. .PP
  34. Given no other arguments
  35. \fBparseargs \-#\fP prints on standard output, the current version and
  36. patchlevel of the running version of \fBparseargs\fP.
  37.  
  38.