Files
calc/help/help
2017-05-21 15:38:33 -07:00

101 lines
3.1 KiB
Plaintext

For more information while running calc, type help followed by one of the
following topics:
topic description
----- -----------
intro introduction to calc
overview overview of calc
help this file
assoc using associations
builtin builtin functions
command top level commands
config configuration parameters
custom information about the custom builtin interface
define how to define functions
environment how environment variables effect calc
errorcodes calc generated error codes
expression expression sequences
file using files
history command history
interrupt how interrupts are handled
list using lists
mat using matrices
obj user defined data types
operator math, relational, logic and variable access operators
statement flow control and declaration statements
stdlib description of some lib files shipped with calc
types builtin data types
unexpected unexpected syntax/usage surprises for C programmers
usage how to invoke the calc command
variable variables and variable declarations
altbind alternative input & history character bindings
bindings input & history character bindings
custom_cal information about custom calc library files
libcalc using the arbitrary precision routines in a C program
new_custom information about how to add new custom functions
stdlib standard calc library files and standards
archive where to get the latest versions of calc
bugs known bugs and mis-features
changes recent changes to calc
contrib how to contribute scripts, code or custom functions
credit who wrote calc and who helped
todo list of priority action items for calc
wishlist wish list of future enhancements of calc
full all of the above (in the above order)
You can also ask for help on a particular function name. For example,
help asinh
help round
or on a particular symbol such as:
help =
For example:
help usage
will print the calc command usage information. One can obtain calc help
without invoking any startup code by running calc as follows:
calc -q help topic
where 'topic' is one of the topics listed above.
If the -m mode disallows opening files for reading or execution of programs,
then the help facility will be disabled. See:
help usage
for details of the -m mode.
The help command is able to display installed help files for custom builtin
functions. However, if the custom name is the same as a standard help
file, the standard help file will be displayed instead. The custom help
builtin should be used to directly access the custom help file.
For example, the custom help builtin has the same name as the standard
help file. That is:
help help
will print this file only. However the custom help builtin will print
only the custom builtin help file:
custom("help", "help");
will by-pass a standard help file and look for the custom version directly.
As a hack, the following:
help custhelp/anything
as the same effect as:
custom("help", "anything");