BaudBandit 2.0 ARexx docs

ARexx port/Public screen name is "BAUD"


Coomand summary...

Command 	Short	Argument(s)			Returns
--------------------------------------------------------------------------
AddPairs	AD	'{?=!}<?=!}....'
Ansi		ANSI	ON | OFF
Answer		ANSW	ON | OFF
ASend		AS	path+filename
Auto		AU	ON | OFF
BaudRate	BA	[baud]				RESULT = baud
Beep		BE	[tone]
BufferSize	BU	[size in bytes] 		RESULT = size
CaptName	CAPTN	path+name
CaptWrap	CAPTW	ON | OFF
Capture 	CA	[ON | OFF | path+filename] 	RC = open
ChatMode	CH	ON | OFF | lines		RC = open
Count		CO
Cursor		CU	[row col]			RESULT=current row & col
DataPath 	DA	path
DCD		DCD					RC = Carrier
DCDHi		DCDH	string
DCDLow		DCDL	string
Delay		DEL	OFF | 0-15
Depth		DEP	1-3				RC = depth
Device		DEV	['device/unit/priority']	RC = error/shared
Dial		DIAL	pattern 			RC = found name
DialClear	DIALC
DialSelect	DIALS	pattern
Display 	DIS	ON | OFF
Download	DO	filename			RC = aborted
FKey		FK	'F# string'
Font		FO	'font/size'
GetFile 	GETF	'Title,path+name/pattern'	RESULT = path+name
GetLine 	GETL	[lines back] 			RESULT = line
Handshake	HA	X/N/C/B
Hilite		HI	string				RC = count
History 	HIST	string
Lace		LA	ON | OFF | HALF
LoadConfig	LOADC	path+name
LoadKeys	LOADK	path+name
LoadPhone	LOADP	path+name
Log		LOG	[ON | OFF | text] 		RC=open
Map		MAP	map array
Mask		MAS	ON | OFF
Menu		ME	'Menu,Item,string' | RESET
Msg		MS	string
MsgRAW		MSGR	string
OutPre		OU	string
Pairs		PA	'{?=!}{?=!}{?=!}...'
PopUp		PO	ON | OFF
Priority	PR	value
QueueDial	QUE
Quickrend	QUIC	ON | OFF
Quiet		QUIE	ON | OFF
Quit		QUIT	[UNDO]
Remote		REM	ON | OFF | Welcome | Pass | Super | ULPath | DLPath
Review		REV	Open | Close | Refresh		RC=open
SaveConfig	SAVEC	[path+name]
SaveKeys	SAVEK	[path+name]
SavePhone	SAVEP	[path+name]
Screen		SC	[ON | OFF]			RC=open
Send		SEN	string
Set		SET	options
SetMark 	SETM	[pattern] 			RC=success
Suspend		SU	ON | OFF
Status		ST	option				RESULT=string
Timeout 	TI	OFF | seconds
TrueLF		TR	ON | OFF
Undo		UN	string
UpLoad		UP	file,[file]...			RC=aborted
Wait		WA	string,[string]...		RC=timeout, RESULT=which
Wrap		WR	ON | OFF | columns

Commands, and examples
--------------------------------------------------------------------------
AddPairs	Add script pairs without disturbing any current pairs

AddPairs '<continue=\r}{??:=\r}'

See also: Pairs
--------------------------------------------------------------------------
Ansi		turn IBM ANSI (alternate configuration) on/off

Ansi ON 	on
Ansi OFF	off

--------------------------------------------------------------------------
Answer		turn on/off sending of 'Answer' configuration macro.
		(Default is execution of remote BBS program)

Answ ON		on
Answ OFF 	off

--------------------------------------------------------------------------
AsciiSend	Start an ASCII file send.

ASend 'RAM:file' Start sending RAM:file
ASend		stop send

See also: Delay
--------------------------------------------------------------------------
Auto		Turn Auto-PhoneBook on/off

Auto ON		PhoneBook will pop up on BUSY, NO CARRIER, or NO DIALTONE
Auto OFF	Disable this feature

--------------------------------------------------------------------------
BaudRate	Change baud rate

Baud 2400	Set BPS to 2400.  Odd rates are not restricted.
Baud		Returns baud rate in the RESULT variable.

--------------------------------------------------------------------------
Beep

Beep		Beep with normal tone (900)
Beep 250	Beep with a different tone
Beep 10000+200	Beep with new chirp (10000+n)

--------------------------------------------------------------------------
Buffer		Change review/capture buffer size

Buf 32768	Change buffer size to 32K bytes.
Buf		Returns buffer size in RESULT

--------------------------------------------------------------------------
CaptName	Set the capture filename without opening

CaptN 'RAM:Capt'

See also: Status C, Capture
--------------------------------------------------------------------------
Capture 	Change capture filename, and turn on/off

Capt		returns status of capture in RC
Capt ON 	On using default capture file
Capt OFF	Turns capture off
Capt 'RAM:Capt' on with a new filename. Closes current capture.
		Appends if the file exists.
Capt 'T:Capt.1' Incremental capture.  Number extension will increase
		if file exists.

See also: Status C, Suspend, CaptName
--------------------------------------------------------------------------
CaptWrap	Turn on/off review buffer/capture word wrapping

CaptWrap ON	Turn on review buffer and capture word wrap
CaptWrap OFF	Turn this feature off

--------------------------------------------------------------------------
ChatMode	Turn chat mode on/off

Chat ON		on
Chat OFF	off
Chat 10 	on with 10 line chat window
Chat		Returns open state in RC

See also: Undo
--------------------------------------------------------------------------
Count		Returns count of pending ARexx child programs launched
		from BB in the RC variable.
Count

--------------------------------------------------------------------------
Cursor		Get cursor postion or set MSG position.

Cursor		Returns current row/column position of cursor in RESULT.
Cursor 0 0	Remove cursor reposition settings.
Cursor 10 10	Set position for MSG command.

See also: Msg
--------------------------------------------------------------------------
DataPath	Change data path for uploads and downloads

Data 'RAM:'

--------------------------------------------------------------------------
DCD		Data Carrier Detect

DCD		returns status of carrier in RC

--------------------------------------------------------------------------
DCDHi		Set DCDHi macro

DCDH '\mTest.baud' Puts this string in the DCDHi config macro

--------------------------------------------------------------------------
DCDLow		Set DCDLow macro

DCDL '\mDCDLow.baud' Puts this string in the DCDLow config macro

--------------------------------------------------------------------------
Delay		Text send delay (0-15)

Del 0		Fast - line at a time
Del 1		Fast - char at a time

See also: ASend
-----------------------------------------------------------------------------

Depth		Change screen depth

Dep 1		2 colors
Dep 2		4 colors
Dep 3		8 colors
Dep		Returns current depth in RC.

See also: Lace
--------------------------------------------------------------------------
Device		Change the serial device

Dev		Status returned in RC
Dev 'serial'	For "serial.device", unit 0
Dev 'serial/1'	For "serial.device", unit 1
Dev 'serial/0/8' For "serial.device", unit 0, priority 8
Dev 'foo'	Will close the serial device, and stop all serial I/O

Return codes:	0 = Opened OK.
		1 = Failed to open.
		2 = Opened but sharing with something else.

See also: Status S, Quiet
--------------------------------------------------------------------------
Dial		Dial a name in current phone book

Dial 'portal'	dials the first entry with 'portal' anywhere.
Dial 'p??tal'	would find the same

--------------------------------------------------------------------------
DialClear	Clears all names in current phone book

DialClr

--------------------------------------------------------------------------
DialSelect	Select multiple names in current phone book without dialing

DialSel '2400'	Selects all 2400 baud entries.
		Send '\an'  to dial thru list
		Send '\ar'  to dial/redial
		QueueDial   to auto-dial

--------------------------------------------------------------------------
Display 	Suppress display of text from serial device

Display on	Suppress text display.  Text will still be captured.
Display off	Resume text display

--------------------------------------------------------------------------
Download	Start download

Down 'file.arc' Download to the current datapath as 'file.arc'
		using the current transfer protocol.

See also: DataPath, UpLoad, Set
--------------------------------------------------------------------------
FKey		Change contents of a function key, same format as .Keys file

FKey 'S10 Hi\r' Shift F10 will be changed.

--------------------------------------------------------------------------
Font		Change font

Font 'Clean/8'	Clean.font, 8 point

See also: Status F
--------------------------------------------------------------------------
GetFile 	Use the BB file requestor from ARexx.

GetF 'File to delete'		The title will be 'File to delete'
				The path will be the the current data path.

GetF 'Enter Name,RAM:Capture'	Path is RAM:, Capture will be in the file
				string.

GetF 'Enter Name,RAM:Cap#?'	Path is RAM:, only matched files displayed.

'OPTIONS RESULTS' must be set.
Results:
	The full path will be returned in RESULT
	If 'Cancel' is selected, then result will be blank.

See also: Status N, Status X
--------------------------------------------------------------------------
GetLine 	get a line from the review buffer

GetLine 	Returns a line from the review buffer, incrementing an
		internal marker by one line.

GetLine 1	Will get the last line returned
GetLine 2	Will decrement by one line each time

'OPTIONS RESULTS' must be set.
Results:
	The current line, starting at the line when SetMark was called,
	will be in RESULT.
	if '+EOB+' is returned, the mark has reached the end or start of
	the buffer.

See also: SetMark, Review
--------------------------------------------------------------------------
Handshake	Change handshake mode

Hand N		None
Hand X		xON/xOFF
Hand C		CTS/RTS
Hand B		Both

--------------------------------------------------------------------------
Hilite		Highlight a string on occurrence/Check count

Hi 'Amiga'	Any occurrence of 'Amiga' will be highlighted.
		If the string exists, a count is returned (in rc) and this
		hilite is removed.

Hi		Clear all hilites.

-----------------------------------------------------------------------------
History 	Load History buffer (4K limit)

Hist string	Load buffer with lines separated by linefeeds.
Hist		clear history

See also: Status H
--------------------------------------------------------------------------
Lace		Turn interlace on/off

Lace ON 	on
Lace OFF	off
Lace HALF	interlace, half height

--------------------------------------------------------------------------
Log		Turn log on/off or write a string

Log ON		on
Log OFF 	off
Log 'Hello!'	Write a string to log file (time stamped)

--------------------------------------------------------------------------
LoadConfig	Load new configuration

LoadC		Load the default file (last file loaded or saved)
LoadC 'S:BB.Config' Load the named file

See also: SaveConfig
--------------------------------------------------------------------------
LoadKeys	Load a key macro file

LoadK		Load the default file (last file loaded or saved)
LoadK 'S:keys'	Load the named file

See also: Status M, SaveKeys
--------------------------------------------------------------------------
LoadPhone	Load a phonebook file

LoadP		Load the default file
LoadP 'S:Phone' Load the named file

See also: Status P, SavePhone
--------------------------------------------------------------------------
Map		Change the ANSI remapping table (current IBM/AMIGA config)

Map '0123456711'

--------------------------------------------------------------------------
Mask		Turn 7 bit character mask on/off

Mask ON 	on
Mask OFF	off

--------------------------------------------------------------------------
Menu		Add a menu item

Menu RESET	Removes all user menus

Menu 'User, Send Name, Greg Cunningham\r'

		Adds a menu strip named "User" with a menu item named
		"Send Name" which will send "Greg Cunningham" with a
		carriage return.

--------------------------------------------------------------------------
Msg		Display a message on screen

Msg 'Hello'
MsgRaw str	Display without carriage return.

--------------------------------------------------------------------------
OutPre		Set pre-insert output string for ASCII Send and Buffer Send

Out '> '	Each line will begin with '> '
Out '\mFoo'	Foo.baud will be executed before sending each line.

See also: Status O
--------------------------------------------------------------------------
Pairs		Set/reset script pairs

Pairs '{name=\r}{??:=\r}' Clear any old pairs.  Initiate new pairs.
Pairs			  Reset pairs to those in last dialed phonebook entry.
Pairs ' '		  Clear all pairs.

See also: AddPairs
--------------------------------------------------------------------------
PopUp		Turn on/off screen pop-up after transfers

Popup ON	turn this feature on
Popup OFF	turn it off

--------------------------------------------------------------------------
Priority	Change the task priority of BaudBandit ( -20 to 20 )

Pri 1		Set the priority to 1
Pri (-7)	Negatives must be in quotes, parens, or use 0-n

--------------------------------------------------------------------------
Quiet		Suppress communication between BaudBandit and serial device

Quiet ON 	Suppress serial I/O
Quiet OFF	Resume serial I/O

--------------------------------------------------------------------------
QuickRend	Turn quickrend option on/off

QuickRend ON
QuickRend OFF

--------------------------------------------------------------------------
Quit		Terminate BaudBandit

Quit		""
Quit UNDO	Abort a quit.

--------------------------------------------------------------------------
QueueDial	Start dial queue of all selected phonebook entries

QueueDial	Start the queue

See also: DialSelect
--------------------------------------------------------------------------
Remote		All character from the serial device and keyboard are
		displayed on the screen and sent to the serial device.

Remote ON	Turn remote echo on.
Remote OFF	Turn remote echo off.

--------------------------------------------------------------------------
Review		Review window control

Rev Open	Open the review window at the current SetMark position
Rev Close	Close the review window
Rev Refresh	Refresh the review window at the current SetMark position
Rev		If RC=1 then the review window is open

See also: SetMark, GetLine
--------------------------------------------------------------------------
SaveConfig	Save current configuration

SaveC		saves to default file
SaveC filename

--------------------------------------------------------------------------
SaveKeys	Save key macros to a file

SaveK		Save as default file (or last name used)
SaveK 'S:keys'	Save keys as the named file

See also: Status M, LoadKeys
--------------------------------------------------------------------------
SavePhone	Save the phonebook to a file

SaveP		Save as default file (or last name used)
SaveP 'S:Phone' Save as named file

See also: Status P, LoadPhone
--------------------------------------------------------------------------
Screen		Open/Close the BaudBandit screen (Iconify)

Screen		returns open status in RC
Screen on	open the screen if closed
Screen off	close the screen if open

--------------------------------------------------------------------------
Send		Send a text string (formatted)

Send 'Hello\r'	sends the string out serial port with carriage return.
Send '\Ac-'	turn capture on with default filename.
Send '\az\ai\at' zero buffer, copy clip to buffer, and transmit

--------------------------------------------------------------------------
Settings	Change settings (characters may be in any order)

Set 8N1 	8 bit, no parity, 1 stop bit
Set A		ZModem auto receive
Set H		Half duplex

Name		Options		Description
---------	----------	-----------
Data bits	7/8
Parity		N/O/E/M/S	None/Odd/Even/Mark/Space
Stop bits	1/2
CharMask	C/c		on/off
Duplex		H/F		Half/Full
IBM mode	I/i		on/off
Protocol	W/x/X/Y/K/	WXModem/XModem/XModem-CRC/YModem/XModem-1K/
		G/Z/A/R/B 	YModem-GZModem/ZModem-Auto/Kermit/CIS-B Plus

--------------------------------------------------------------------------
SetMark 	set the GetLine / Review window mark

SetMark 	Set the mark to current capture position (end of buffer)
SetMark 'He?lo' if RC=1 then GetLine will return the last line with 'Hello'
		in it.

See also: GetLine, Review
--------------------------------------------------------------------------
Suspend 	Turn capture suspend on/off

Sus ON		Turn suspend on
Sus OFF 	Turn suspend off

See also: Capture
--------------------------------------------------------------------------
Status		Get status

Stat A		Prefix 'ATDT'
Stat Capt	Current capture filename
Stat Data	Current data path
Stat Exit	Exit string
Stat Font	Font name/size
Stat History	History buffer
Stat Init	Init string
Stat Line	Current input line
Stat Macro	Key macro filename
Stat Name	Last file uploaded or downloaded.  Can also be used to
		get file in requester while up or after closing.
Stat OutPre	Output pre-insert string.
Stat Phone	Current phonebook filename.
Stat Q		Current phonebook line.
Stat Serial	Current serial device.
Stat Trans	Current transfer protocol.
Stat U		CHAT user string or last line selected in review window.
Stat Version	Program name and version.
Stat Word	Current word in outgoing buffer.
Stat X		Last file transfered with full path.  Can also be used to
		get path/file in requester while up or after closing.
Stat Y		Online timer (format ' h:mm:ss')
Stat Z		Transfer status line
Stat %N 	(N = A thru Z)  Hot keys A thru Z

'OPTIONS RESULTS' must be set.

Returns:
	String is returned in RESULT

--------------------------------------------------------------------------
Timeout 	Set WAIT timeouts in seconds.

Timeout 3	All WAITS will return non-zero in RC if no serial activity
		for 3 seconds.
		PULL will signal break_c

Timeout OFF	Disable timeouts

See also: Wait
--------------------------------------------------------------------------
TrueLF		Set true CR/LF mode.

True ON
True OFF

--------------------------------------------------------------------------
Upload		Upload one or more files separated by commas.

Up 'file.arc'	Upload this filename in the current datapath
		using the current transfer protocol.
Up 'one,two'	Upload the files named "one" and "two" (zmodem & ymodem)

See also: DataPath, DownLoad
--------------------------------------------------------------------------
Undo		Insert string into CHAT window

Undo 'string'

See also: Status U, Chat
--------------------------------------------------------------------------
Wait		Stop an ARexx process until a string or one of the
		multiple strings separated by commas are found or
		timeout occurs.

Wait password	Wait until anything with 'password' in it is found.

Wait 'pa??'	Will find pass, part, page, PAGE, ect.

Wait '0A'x' '	Will find a linefeed with a space after it.

Wait 'xx,yy,zz' Will find xx, yy, or zz.

Wait '?'	Wait for next character

Returns:
	RC is non-zero if timeout occurred.
	If OPTIONS RESULTS is set, the string found is returned.
	?'s are replaced with characters.

See also: Timeout
--------------------------------------------------------------------------
Wrap		Set word wrap length

Wrap ON		on with default columns
Wrap OFF	off
Wrap 80 	on with 80 columns

--------------------------------------------------------------------------



Standard ARexx commands inherited by BaudBandit
--------------------------------------------------------------------------
Say		Print text on the screen.
		If remote echo is on, it is sent to the modem also.

--------------------------------------------------------------------------
Pull		Get user input string.
		Normally gets input from the modem.
		If duplex is half, input is from modem and keyboard.
		If quiet is also enabled, input is from keyboard only.

--------------------------------------------------------------------------
Push		Insert (add) lines onto the end of the chat history buffer

--------------------------------------------------------------------------
Queue		Sends text in KeyMap format to BaudBandit as if typed by
		the user.  (For cursors, Fkeys, ect. see the RKM)

--------------------------------------------------------------------------
