help -- display a help page
Introductionhelp("word") or ?word
displays the online help page related to word.
Call(s)help("word")
?word
Parametersword |
- | any keyword |
Returnsthe void object null()
of type DOM_NULL.
Related
Functions
Detailshelp("word") displays a help page with
information about the keyword "word".?word is a short form of
help("word"). The ? command is
not a MuPAD function and cannot be used in expressions. It can
only be entered interactively and in a line of its own. Note that the
search word word must neither be put in quotation marks
nor followed by a terminating semicolon.? and
*. ? represents any single character,
and * represents an arbitrarily long, possibly empty,
sequence of characters. There are three exceptions: ?* and
?`*` lead directly to the help page for _mult, and ?`**` leads to
the help page for _power. Cf. example 1.anames(All) returns a set with the
names of all currently loaded system functions. The command
?** returns a list of all available help pages.help is a function of the system kernel.
Example
1help expands wildcards:
>> ?*type
Try: domtype hastype testtype type Type Type::AnyType
An exception: ?* leads directly to the help
page for _mult:
>> ?*
* -- multiply expressions
Introduction
a * b respectively _mult(a, b) computes the product a*b.
Call(s)
o a * b _mult( <a, b...>)
Parameters
a, b - arithmetical expressions
[...]
Example
2There is no information on the non-existent function
worm:
>> ?worm
Sorry, no help page available for 'worm' !
Try: norm
Example
3MuPAD supports C++ compiled kernel
extensions, called dynamic modules. The documentation of a dynamic
module is not integrated into the MuPAD hypertext help system,
but is provided as plain text online documentation, which can be
displayed via the "doc" method of the corresponding
module, e.g., util::doc:
>> module(util): util::doc()
MODULE
util - A collection of utility functions
INTRODUCTION
The module provides a collection of useful utility functions.
INTERFACE
util::busyWaiting, util::date, util::doc,
util::kernelPath, util::kernelPid, util::sleep,
util::time, util::userName
>> util::doc("kernelPath")
NAME
util::kernelPath - Returns the pathname of the MuPAD kernel
SYNOPSIS
util::kernelPath()
DESCRIPTION
This function returns the pathname of the MuPAD kernel.
EXAMPLES
>> util::kernelPath()
"C:\\PROGRA~1\\SCIFACE\\MUPADP~1.5\\BIN\\MUPKERN.EXE"
>> util::kernelPath()
"/usr/local/mupad/linux/bin/mupad"
SEE ALSO
util::kernelPid, util::userName
BackgroundPAGER. See Pref::ansi on how to control the format
of this output.?* no longer lists all available help pages, but
instead leads to the help page of _mult.