TABLE OF CONTENTS


help

NAME

::guib::moduleObj::help -- the help GUIB keyword

USAGE

help varIdent { ...options... } or help varIdent ...options...

DESCRIPTION

-- GUIB keyword !!!

    Keyword "help" is meant for specifying an extensible help about 
    some variable. A long help texts for each variable would make a
    GUIB script difficult to read, since they would be very long
    and one would have to search for the definitions among long
    help texts. Hence this keyword is meant as follows:
    at the top of the guib script one specifies the definition
    of the variables, ..., and when that is done then one can start 
    specifying the help texts for the variables. This way makes
    the guib scripts more readable.

RETURN VALUE

None.

EXAMPLE

help varIdent1 {

           -helpfmt  txt|html|txt2html
           -helptext {...here is the help of the variable...}

}