GEOS SDK TechDocs

handsum ...

hwalk ...

help

help [<command>]

This is the user-level access to the on-line help facilities for Swat. If given a topic (e.g. "brk") as its argument, it will print all help strings defined for the given topic (there could be more than one if the same name is used for both a variable and a procedure, for instance). If invoked without arguments, it will enter a browsing mode, allowing the user to work his/her way up and down the documentation tree.

help-fetch

help-fetch <topic-path>

Examples: "help-fetch top.patient"

Fetches the help string for a given topic path in the help tree.

If there is more than one node with the given path in the help tree, only the string for the first node will be returned.

help-fetch-level

help-fetch-level

Examples:

"help-fetch-level top.prog.obscure"

Returns the topics within the "top.prog.obscure" level of the help tree.

Returns a list of the topics available at a given level in the help tree.

The result is a list of node names without leading path components.

See Also: help-fetch.

help-help

help-help

Provides help about using the help command (q.v.)

See Also: help.

help-is-leaf

help-is-leaf <topic-path>

Examples:

"help-is-leaf top.prog"

See if top.prog is a leaf node in the help tree (i.e. if it has no children).

Determines whether a given path refers to a help topic or a help category.

Returns one if the given path refers to a leaf node, zero if it is not.

See Also: help-fetch, help-fetch-level.

help-minAspect

var help-minAspect [<ratio-times-ten>]

If non-zero, contains the minimum aspect ratio to be maintained when displaying tables in the help browser. The ratio is expressed as the fraction

entries_per_column*10/number_of_columns

E.g. a minimum ratio of 1.5 would be 15. (We multiply by ten because Swat doesn't support floating point numbers.)

help-scan

help-scan <pattern>

Examples:

"help-scan break"

Looks for all nodes at any level of the help tree whose documentation includes the pattern "break".

Scans all nodes in the help tree for those whose documentation matches a given pattern.

• The result is a list of topic-paths.

See Also: help-fetch.

help-verbose

var help-verbose [0|1)]

If non-zero, performs verbose prompting.

hex

hex <number>

Examples:

"hex 034"

print hex equivalent of octal 34.

"hex 12"

print hex equivalent of decimal 12.

Print hexadecimal equivalent of a number.

hgwalk

hgwalk

Examples:

"hgwalk"

print statistics on all geodes

Print out all geodes and their memory usage.

history

history [<args>]

Examples:

"history 10"

Prints the last 10 commands entered via the "history subst" command.

"history subst $line"

Performs history substitution on the string in $line, enters the result in the history queue and returns the result.

"var n [history cur]"

Stores the number of the next string to be entered via "history subst" in the variable n.

"history set 50"

Limit the number of entries in the queue to 50.

"history fetch 36"

Returns the string entered as command number 36 in the history queue.

This command manipulates the history list. Options are:

<number>

Prints the most-recent <number> commands

set <queue-size>

Sets the number of commands saved

subst <str>

Performs history substitution on <str> and enters it into the history queue.

cur

Returns the current history number. If no argument is given, all saved commands are printed.

fetch <n>

Returns the string entered as command number <n> in the history queue.

GEOS SDK TechDocs

handsum ...

hwalk ...