Previous Page Next Page Contents

module::help -- displays module online documentation

Introduction

module::help(mname) displays plain text module online documentation.

Call(s)

module::help(mname)
module::help(mname,fname)

Parameters

mname - module name: character string
fname - function name: character string

Returns

the void object of type DOM_NULL.

Related Functions

module::new, module::stat

Details

Example 1

The first command displays the introduction page of the module stdmod. The seconds command displays the help page of the module function stdmod::doc.

>> module::help("stdmod")
      MODULE
        stdmod - Extended Module Management
      
      INTRODUCTION
        This module provides functions for an extended module
        management  and also includes a function ``help'' for
        reading online documentation files of dynamic modules.
      
      INTERFACE
        age, doc, help, max, stat, which
>> module::help("stdmod","doc")
      NAME
        stdmod::doc - Display online documentation
      
      SYNOPSIS
        stdmod::doc()
        stdmod::doc( func )
      
      PARAMETER
        func - string, function name without the prefix "stdmod::"
      
      DESCRIPTION
        Displays a description of the module 'stdmod' respectively
        the module function stdmod::'func'.
      
      EXAMPLES
        >> stdmod::doc( "doc" );
           NAME
             stdmod::doc - Display online documentation
           [...]
      
      SEE ALSO
        info, module::help

Example 2

The same information can be displayed more convenient using the module function stdmod::doc() respectively stdmod::doc("doc").

>> stdmod::doc()
      MODULE
        stdmod - Extended Module Management
      
      INTRODUCTION
        This module provides functions for an extended module
        management  and also includes a function ``help'' for
        reading online documentation files of dynamic modules.
      
      INTERFACE
        age, doc, help, max, stat, which

Background




Do you have questions or comments?


Copyright © SciFace Software GmbH & Co. KG 2000