Previous Page Next Page Contents

help -- display a help page

Introduction

help("word") or ?word displays the online help page related to word.

Call(s)

help("word")

?word

Parameters

word - any keyword

Returns

the void object null() of type DOM_NULL.

Related Functions

info, Pref::ansi

Details

Example 1

help 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 2

There is no information on the non-existent function worm:

>> ?worm
      Sorry, no help page available for 'worm' !
      
      Try:  norm

Example 3

MuPAD 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

Background

Changes




Do you have questions or comments?


Copyright © SciFace Software GmbH & Co. KG 2000