|
||||||
|
|
Note: The same information can also be obtained by typing "help" or "<command> help" at a framework or module prompt. However, it is useful to have it here for reference, so that you do not have to run a Framework session every time you want to see what commands are available.
Command(s) available in the "AppFrame" module:
echo Send text argument to stdout (useful in scripts).
exit Leave the current menu, module, or process
help Bring up help text for the current context.
show Display the value of any parameters or statistics.
sourceFoundFile Source file in $BFDEFAULTSEARCHPATH or $BFSEARCHPATH.
verbose bool parameter: set or list.
production bool parameter: set or list.
enableFrames bool parameter: set or list.
events Command used to control the looping over events
module Command used to control and specify modules
path Command used to create, modify and control paths
sequence Command used to create, modify and control sequences
config Dump and restore configuration.
action Command used to control module actions
strictModuleDisable bool parameter: set or list.
For more information on a particular command type '<command> help'.
A minimal set to select an input file and run 5 events is:
module talk FileInput
input file <your_file>
exit
ev begin -nev 5
exit
A script can also be specified as the first argument when running the program.
In addition the following command aliases can also be used.
Alias: Command Equivalent:
mod module
cont events continue
talk module talk
seq sequence
begin events begin
up exit
clone module clone
logout exit
ev events
quit exit
Full command is "events" plus the command, eg: "events begin".
The following commands are available:
beg(in) [-nev <n>] Begin processing
cont(inue) [-nev <n>] Continue processing
dumpOnBegin <filename> Writes config. to <filename> on begin.
Also write the begin and exit commands.
help Show available commands
Where "begin" resets the current input module to start a new
event processing run, whereas "continue" continues the current
sequence (presumably because it was terminated prematurely by
the optional qualifier "-nev" which specifies a number of events).
The "continue" command acts identically to the "begin" command
if no prior "begin" command had been issued.
Full command is "module" plus the command, eg: "module talk".
The following commands are available: clone <mod> <new-mod> Clones <mod> to <new-mod> disable <mod1> [<mod2> ..] Disable module(s)* enable <mod1> [<mod2> ..] Enable module(s)* enable path <path1> [<path2> ..] Enable modules along the path(s) help Show available commands in(put) <mod> Specify the input module list [-b(rief)] List the modules out(put) <mod> Specify the output module talk(To) <mod> Talk to module * = 'all' may be used in place of <mod1>
Full command is "sequence" plus the command, eg: "sequence create".
The following commands are available:
append <seq> [-a(fter) <mod/seq>] <mod1/seq1> [<mod2/seq2> ..]
Append module(s)/sequence(s)
create <seq> [<mod1/seq1> ..] Create a new sequence
delete <seq1> [<seq2> ..] Delete sequence(s)
disable <seq1> [<seq2> ..] Disable sequence(s)*
enable <seq1> [<seq2> ..] Enable sequence(s)*
help Show available commands
insert <seq> [-b(efore) <mod/seq>] <mod1/seq1> [<mod2/seq2> ..]
Insert module(s)/sequence(s)
list [-b(rief)] -e(xpand) -l(evel) <level> ]
List sequence(s)
listMembers <seq> [-b(rief)] -e(xpand) -l(evel) <level> ]
List members of a sequence
remove <seq> <mod1/seq1> [<mod2/seq2> ..]
Remove module(s)/sequence(s)
* = 'all' can be used in place of <seq1>.
Full command is "path" plus the command, eg: "path list".
The following commands are available:
append <path> [-a(fter) <mod/seq>] <mod1/ seq1> [<mod2/seq2> ..]
Append module(s)/sequence(s)
create <path> [<mod1/seq1> ..] Create a new path
delete <path1> [<path2> ..] Delete path(s)
disable <path1> [<path2> ..] Disable path(s)*
enable <path1> [<path2> ..] Enable path(s)*
help Show available commands
insert <path> [-b(efore) <mod/seq>] <mod1/seq1> [<mod2/seq2> ..]
Insert module(s)/sequence(s)
list [-b(rief)] -e(xpand) -l(evel) <level> ]
List paths
listMembers <path> [-b(rief)] -e(xpand) -l(evel) <level> ]
List members of a path
remove <path> <mod1/seq1> [<mod2/seq2> ..]
Remove module(s)/sequence(s)
* = 'all' can be used in place of <path1>.
Full command is "action" plus the command, eg: "action list".
The following commands are available: disable <act1> [<act2> ..] Disable action(s)* enable <act1> [<act2> ..] Enable action(s)* help Show available commands list List all defined actions * = 'all' may be used in place of <act1>.
Full command is "config" plus the command, eg: "config restore".
The following commands are available:
dump(tcl) <filename> [-cmd <commands>]Dump out the configuration as a tcl file
optional <commands> appended in tcl file.
dumpraw <filename> Dump out the configuration in raw format
help Show available commands
restore <filename> Restore the configuration
echo Send text argument to stdout (useful in scripts). exit Leave the current menu, module, or process help Bring up help text for the current context. show Display the value of any parameters or statistics. sourceFoundFile Source file in $BFDEFAULTSEARCHPATH or $BFSEARCHPATH. verbose bool parameter: set or list. production bool parameter: set or list. enableFrames bool parameter: set or list.... plus "parameter set" or "parameter list" for any of the module's personal run-time parameters.
input add <collection1> [<collection2> ...]
Add collection(s) to list
input list Lists the current collection list
input nosilent Sets verbosity level
input remove <collection1> [<collection2> ...]
Remove collection(s) from list
input silent Sets verbosity level
input wipe[-out] Empty the list
input addcomponent >comp1> [<comp2> ...] Adds a component to the input stream
output clear Empty the list of streams
output create <stream> [<dest>] Create stream
output delete <stream1> [<str2> ..] Remove stream(s) from list
output destination <stream> [<dest>] Bind stream to destination
output disable <stream1> [<str2> ..] Disable stream(s)
output enable <stream1> [<str2> ..] Enable stream(s)
output help Display help information
output list List current streams/files
output paths <stream> <path1>... Bind <path1> etc. to stream
output reset Synonym for clear
output statistics List statistics for each stream
output stream <stream> [<dest>] Synonym for create
output wipe-out Synonym for clear
output addcomponents|addComponents|ADDCOMPONENTS <stream> <comp1> [<comp2> ...]
Add components to the output stream.
output borrow|Borrow|BORROW <stream> yes|true|t|no|false|f <comp1> [<comp2> ...]
Borrow a component from input (not written deeep copy).
output cluster|Cluster|CLUSTER <stream> <comp1> [<comp2> ...]
Cluster components in a stream.