--- ray/doc/man/man1/rcalc.1	2003/03/11 19:20:21	1.1
+++ ray/doc/man/man1/rcalc.1	2017/10/10 16:10:14	1.13
@@ -1,4 +1,4 @@
-.\" RCSid "$Id"
+.\" RCSid "$Id: rcalc.1,v 1.13 2017/10/10 16:10:14 greg Exp $"
 .TH RCALC 1 4/6/99 RADIANCE
 .SH NAME
 rcalc - record calculator
@@ -9,6 +9,8 @@ rcalc - record calculator
 ][
 .B \-l
 ][
+.B \-p
+][
 .B \-n
 ][
 .B \-w
@@ -21,6 +23,10 @@ rcalc - record calculator
 ][
 .B "\-o format"
 ][
+.B "\-in M"
+][
+.B "\-on M"
+][
 .B "\-f source"
 ][
 .B "\-e expr"
@@ -38,6 +44,7 @@ numeric fields separated by tabs.
 The
 .I \-tS
 option is used to specify an alternate tab character.
+.PP
 A
 .I \-i format
 option specifies a template for an alternate
@@ -48,13 +55,66 @@ Otherwise, it is interpreted as the name of the file c
 the format specification.
 In either case, if the format does not end with a newline, one will be added
 automatically.
+A special form of the
+.I \-i
+option may be followed immediately by a 'd' or an 'f' and an optional
+count, which defaults to 1, indicating the number of double or float
+binary values to read per record on the input file.
+If the input is byte-swapped, the
+.I \-iD
+or
+.I \-iF
+options may be substituted.
+If binary input is specified, no format string or file is needed.
+.PP
 A
 .I \-o format
 option specifies an alternate output record format.
-It is interpreted the same as an input specification.
+It is interpreted the same as an input specification, except that
+the special
+.I \-od
+or
+.I \-of
+options do not require a count, as this will be determined by the
+number of output channels in the given expressions.
+If byte-swapped output is desired, the
+.I \-oD
+or
+.I \-oF
+options may be substituted.
+.PP
+The
+.I \-p
+option specifies "passive mode," where characters that do not
+match the input format are passed unaltered to the output.
+This option has no effect unless
+.I \-i
+is also specified, and does not make much sense unless
+.I \-o
+is also given.
+With both input and output formats, the passive mode can
+effectively substitute information in the middle of a file
+or stream without affecting the rest of the data.
+.PP
+If a
+.I \-in
+option is given with a positive integer argument,
+.I rcalc
+will stop processing input once it has loaded this number of records.
+Similarly, if a
+.I \-on
+option is present,
+.I rcalc
+will stop after producing this many records, which may be a smaller
+number if the
+.I cond
+variable is used.
+If multiple input files are given, these counts are continuous over
+the input and do not reset on each file.
+.PP
 The variable and function definitions in each
 .I \-f source
-file are read and compiled.
+file are read and compiled from the RADIANCE library where it is found.
 The
 .I \-e expr
 option can be used to define variables on the command line.
@@ -65,6 +125,7 @@ The
 option can be used to assign a string variable a string value.
 If this string variable appears in an input format, only records
 with the specified value will be processed.
+.PP
 The
 .I \-b
 option instructs the program to accept only exact matches.
@@ -79,6 +140,7 @@ a line, and the end of the format matches the end of a
 With the
 .I \-l
 option, the input format can match anywhere on a line.
+.PP
 The
 .I \-w
 option causes non-fatal error messages (such as division by zero) to
@@ -160,7 +222,8 @@ and the following operators:
 .PP
 	+  -  *  /  ^
 .PP
-Operators are evaluated left to right.
+Operators are evaluated left to right, except '^',
+which is right associative.
 Powers have the highest precedence; multiplication and
 division are evaluated before addition and subtraction.
 Expressions can be grouped with parentheses.
@@ -192,6 +255,21 @@ are evaluated.
 This provides a convenient method for avoiding inappropriate calculations.
 The following library of pre-defined functions and variables is provided:
 .TP 10n
+.BR $N
+Return the value for input column
+.I N.
+If an input format is given, using a channel number generates an error.
+.TP
+.BR "in(n)"
+Return the value for input column
+.I n,
+or the number of columns available in this record if
+.I n
+is 0.
+This is an alternate way to get a column value instead of using
+the $N notation, and is more flexible since it is programmable.
+This function is disabled if an input format is used.
+.TP
 .BR "if(cond, then, else)"
 if cond is greater than zero,
 then is evaluated, otherwise else is evaluated.
@@ -241,12 +319,14 @@ trigonometric functions.
 inverse trigonometric functions.
 .TP
 .BR "atan2(y, x)"
-inverse tangent of y/x (range -pi to pi).
+inverse tangent of y/x (range \-pi to pi).
 .SH EXAMPLE
 To print the square root of column two in column one,
 and column one times column three in column two:
 .IP "" .2i
-rcalc -e '$1=sqrt($2);$2=$1*$3' inputfile > outputfile
+rcalc \-e '$1=sqrt($2);$2=$1*$3' inputfile > outputfile
+.SH ENVIRONMENT
+RAYPATH		the directories to check for auxiliary files.
 .SH AUTHOR
 Greg Ward
 .SH BUGS
@@ -256,4 +336,4 @@ options, not in definitions.
 .PP
 Tabs count as single spaces inside fields.
 .SH "SEE ALSO"
-calc(1), cnt(1), ev(1), lam(1), tabfunc(1), total(1)
+cnt(1), ev(1), getinfo(1), icalc(1), rcollate(1), rlam(1), tabfunc(1), total(1)