[Commit] nickle ChangeLog,1.131,1.132 nickle.1.in,1.19,1.20
Bart Massey
commit at keithp.com
Tue Aug 2 21:42:56 PDT 2005
Committed by: bart
Update of /local/src/CVS/nickle
In directory home.keithp.com:/tmp/cvs-serv2341
Modified Files:
ChangeLog nickle.1.in
Log Message:
2005-08-02 Bart Massey <bart at cs.pdx.edu>
* doc/tutorial/basics/invoke.sgml, nickle.1.in:
Fix documentation to reflect new argument parsing.
Index: ChangeLog
===================================================================
RCS file: /local/src/CVS/nickle/ChangeLog,v
retrieving revision 1.131
retrieving revision 1.132
diff -u -d -r1.131 -r1.132
--- ChangeLog 1 Aug 2005 09:35:59 -0000 1.131
+++ ChangeLog 3 Aug 2005 04:42:52 -0000 1.132
@@ -1,3 +1,8 @@
+2005-08-02 Bart Massey <bart at cs.pdx.edu>
+
+ * doc/tutorial/basics/invoke.sgml, nickle.1.in:
+ Fix documentation to reflect new argument parsing.
+
2005-07-31 Bart Massey <bart at cs.pdx.edu>
version 2.49
Index: nickle.1.in
===================================================================
RCS file: /local/src/CVS/nickle/nickle.1.in,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -d -r1.19 -r1.20
--- nickle.1.in 28 May 2004 06:41:34 -0000 1.19
+++ nickle.1.in 3 Aug 2005 04:42:52 -0000 1.20
@@ -3,7 +3,7 @@
.SH NAME
nickle \- a desk calculator language
.SH SYNOPSIS
-nickle [-f file] [-l library] [-e expr] [ script ... ]
+nickle [--help|--usage] [-f file] [-l library] [-e expr] [ script ] [--] [arg ...]
.SH DESCRIPTION
.PP
\fINickle\fP is a
@@ -19,30 +19,39 @@
and a very few features are simply missing.
.SH USAGE
.PP
-When invoked without arguments, Nickle reads from
-standard input, and writes to standard output.
An un-flagged argument is treated as a Nickle script,
and replaces standard input. Any remaining arguments
following the script are placed in the Nickle string array
-argv for programmatic inspection.
+argv for programmatic inspection. When invoked without an
+expression or script argument, Nickle reads from
+standard input, and writes to standard output.
.PP
Options are as follows:
.TP
-.BI "-f " file
+.B "--help,--usage"
+Print a help/usage message and exit. This is a built-in
+feature of Nickle's ParseArgs module, and thus will also be
+true of Nickle scripts that use this library.
+.TP
+.BI "-f,--file " file
Load
.I file
into Nickle before beginning execution.
.TP
-.BI "-l " library
+.BI "-l,--library " library
Load
.I library
into Nickle before beginning execution.
See below for a description of the library facility.
.TP
-.BI "-e " expr
-Instead of looking for input on stdin, evaluate
-.IR expr .
-This must be the last argument to Nickle.
+.BI "-e,--expr " expr
+Evaluate
+.I expr
+before beginning execution.
+.TP
+.B "--"
+Quit parsing arguments and pass the remainder, unevaluated, to
+.IR argv .
.SH SYNTAX
.PP
To make the input language more
More information about the Commit
mailing list