froth-dictionary {froth}

List/Export Installed froth Words

Description

Functions to inspect and save installed froth words.

Usage

froth.dictionary()
writeFrothDictionary(file="", ...)

Arguments

file

file to write to, or "" for the console

...

additional arguments passed to cat

Details

froth.dictionary will list all installed words, grouped by their type (built-in, alias, user-defined).

writeFrothDictionary allows users to export their function definitions. The default argument will print out user-defined definitions to the console. This output can be redirected to a file by changing the file argument.

Value

None. froth.dictionary lists all installed words using message, and writeFrothDictionary either prints to the console or to a file.

Author(s)

Aidan Lakshman [e-mail]

See Also

saveFrothSession loadFrothSession

Examples

## Show all words
froth.dictionary()

## Define a few new words
froth.parse(": MAKE_THREE 1 2 + . ;")
froth.parse(": MAKE_FIVE 2 3 + . ;")

## print out definition
writeFrothDictionary()