@database Link It! ARexx Commands


Copyright (C) 1995 Legendary Design Technologies Inc.
All rights reserved

$VER: Link It! ARexx Commands (29-Oct-95)


@node main "Table of Contents"

	Link It! ARexx Commands

	@{" Overview - Link It! & ARexx  " link Overview}
	@{" The PC and Rexx              " link PCRexx}

	@{" ABOUT           " link about}
	@{" ALL             " link all}
	@{" CD              " link cd}
	@{" COLORS          " link colors}
	@{" COMMANDNAMES    " link commandnames}
	@{" CONFIGURE       " link configure}
	@{" CONVERSION      " link conversion}
	@{" COPY            " link copy}
	@{" DELITE          " link delite}
	@{" DISPLAYDATE     " link displaydate}
	@{" DISPLAYLOG      " link displaylog}
	@{" DRIVES          " link drives}
	@{" ESTIMATE        " link estimate}
	@{" FILETYPE        " link filetype}
	@{" GET             " link get}
	@{" HILITE          " link hilite}
	@{" INTERLACE       " link interlace}
	@{" LOADCONFIGURE   " link loadconfigure}
	@{" LINKIT_TO_BACK  " link linkit_to_back}
	@{" LINKIT_TO_FRONT " link linkit_to_front}
	@{" MESSAGE         " link message}
	@{" NONE            " link none}
	@{" PATTERN         " link pattern}
	@{" QUIT            " link quit}
	@{" REMOTEINFO      " link remoteinfo}
	@{" REMOTEREXX      " link remoterexx}
	@{" RESETLOG        " link resetlog}
	@{" REXXCOMMAND     " link rexxcommand}
	@{" REXXOTHER       " link rexxother}
	@{" SAVECONFIGURE   " link saveconfigure}
	@{" SHELLEXECUTE    " link shellexecute}
	@{" SORT            " link sort}

	@{" Acknowledgements             " link Ack}
@endnode


@node Overview "Link It! & ARexx"

Link It! has an ARexx interface, located at address 'LINKIT'. At the
present time, only the first running copy of Link It! can have an
ARexx port.  This may be changed in a future revision.

An ARexx interface has been included for several reasons:

1) It's just a smart thing to do
2) It makes it possible for you to automate things you do on a
   repeated basis, for example copy a certain set of files from
   your Amiga to your PC.
3) Makes it possible to add functionality to the program that
   isn't included directly.

As a general overview, all ARexx commands must start with a comment.
The following is a simple example of a Link It! ARexx script.

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

/* this is an example Link It! ARexx script */

ADDRESS LINKIT
CONFIGURE
EXIT

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

This example would simply bring up the "Configure" requester on the
screen.

More examples are included on the disk in the "ARexx" drawer.

@endnode
	
	
@node PCRexx "The PC and Rexx"

Although the PC has a version of "Rexx" that runs primarily under
OS/2, its implementation is not as nice as the Amigas.  At this
time, Link It! supports Rexx only on the Amiga.  However, the
good news is that Link It! on the PC DOES understand commands
sent from the Amiga.  So, provided you are sending Link It!
commands and not general Rexx commands, you essentially have
what you need on the PC.

You have the power to do neat things like run applications
remotely from the Amiga using ARexx.  The following example
runs Microsoft Word on the PC from your Amiga:

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

/* this example launches Word from the Amiga */

ADDRESS LINKIT
REMOTEREXX SHELLEXECUTE "C:\WINWORD\WINWORD.EXE"
EXIT

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

The documentation for each ARexx command notes what features
are not available on the PC.

@endnode

@node about
Command: ABOUT

Parameters: None

Comments:

This command brings up the ABOUT requester.
@endnode

@node all
Command: ALL

Parameters: None

Comments:

This command selects ALL of the files in the local directory.
If you wanted to select all of the files in the remote
directory, use "REMOTEREXX ALL" instead.
@endnode

@node cd
Command: CD dir

Parameters: dir - the directory which you wish to change to.

Comments:

This command allows you to change the local directory. It
is recommended that you enclose the directory in quotes.
To change the remote directory, use "REMOTEREXX CD dir".

Example:

CD "Work:LinkIt!"

@endnode

@node colors
Command: COLORS

Parameters: None

Comments:

This command brings up the color requester for the user
to make changes.
@endnode

@node commandnames
Command: COMMANDNAMES

Parameters: None

Comments:

This command brings up the "Command Names" requester
and allows the user to make changes.

Note: THIS COMMAND IS IGNORED ON THE PC.
@endnode

@node configure
Command: CONFIGURE

Parameters: None

Comments:

This commands brings up the "Configure..." requester
and allows the user to make changes.
@endnode

@node conversion
Command: CONVERSION

Parameters: None

Comments:

This command brings up the "Conversion" requester and
allows the user to make changes.
@endnode

@node copy
Command: COPY

Parameters: None

Comments:

This command is the same as clicking on the "COPY"
bottom at the bottom of the screen.  It will copy and
remote or local files that are presently selected.
@endnode

@node delite
Command: DELITE pattern

Parameters: pattern - a file pattern

Comments:

This command turns OFF the files that match the pattern.
For example, let's say you wanted to copy every file
EXCEPT "IFF" files. The following would do that:

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

/* this example shows how to DELITE */

ADDRESS LINKIT
ALL
DELITE "#?.IFF"
EXIT

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

The command can also be used for a particular file.  For example,
"DELITE MYFILE.TXT".
@endnode

@node displaydate
Command: DISPLAYDATE [YES/NO/0/1]

Parameters: Boolean

Comments:

This command tells Link It! whether or not it should display the
filedate on the screen.  "DISPLAYDATE YES" and "DISPLAYDATE 1" are
synonyms, as are "DISPLAYDATE NO" and "DISPLAYDATE 0".
@endnode

@node displaylog
Command: DISPLAYLOG

Parameters: None

Comments:

This command displays the current log on the screen.
@endnode

@node drives
Command: DRIVES

Parameters: None

Comments:

This command causes a local list of available devices and/or
disk drives to be displayed in the local window.  To display
the remote side, use "REMOTEREXX DRIVES".
@endnode

@node estimate
Command: ESTIMATE

Parameters: None

Comments:

This command displays the "Time & Size Estimates" requester.
If you actually wish to receive the values for time and
size as variables, see the @{"GET" link get} command.
@endnode

@node filetype
Command: FILETYPE

Parameters: None

Comments:

This command brings up the "File Type" requester.

Note: THIS COMMAND IS IGNORED ON THE PC.
@endnode

@node get
Command: GET [value]

Parameters: Value of what variable you wish to receive.

Comments:

This is a very powerful command.  It allows you to get important
information about the system (or the remote system, by using
"REMOTEREXX GET [value]").

The result from each command is returned in the 'RESULT' variable.
Note that you must put an "OPTIONS RESULTS" command at the
beginning of your script.

  Presently, the following values are supported:

	@{"  COMPUTER          " link computer}
	@{"  CONNECTED         " link connected}
	@{"  CONNECTION_MODE   " link connection_mode}
	@{"  CONNECTION_SPEED  " link connection_speed}
	@{"  FREESTORE         " link freestore}
	@{"  FREERAM           " link freeram}
	@{"  OS_VERSION        " link os_version}
	@{"  TRANSFER_SIZE     " link transfer_size}
	@{"  TRANSFER_FILES    " link transfer_files}
	@{"  TRANSFER_DIRS     " link transfer_dirs}
	@{"  TRANSFER_TIME     " link transfer_time}
	@{"  VERSION           " link version}

@endnode

@node computer
Command: GET COMPUTER

Result: Returns a string with the following values:

        AMIGA
        PC
        MAC
@endnode

@node connected
Command: GET CONNECTED

Result: Returns a value of 0 if not connected, 1 if connected
        (to another computer).
@endnode

@node connection_mode
Command: GET CONNECTION_MODE

Result: Returns a value of 0 if a serial connection is made,
	and 1 if a parallel one is made.
@endnode

@node connection_speed
Command: GET CONNECTION_SPEED

Result: Returns a value of 0 if a parallel connection is made,
	otherwise the present baud rate is returned.
@endnode

@node freestore
Command: GET FREESTORE

Result: Returns how many bytes are available on the current drive.
@endnode

@node freeram
Command: GET FREERAM

Result: Returns how many bytes (total) of available RAM.
@endnode

@node os_version
Command: GET OS_VERSION

Result: Returns what operating system is running, as a string. You
        may have to experiment with the return values to get what
        you are looking for.
@endnode

@node transfer_size
Command: GET TRANSFER_SIZE

Result: Returns how many bytes in total have been selected for
        copying.
@endnode

@node transfer_files
Command: GET TRANSFER_FILES

Result: Returns how many files in total have been selected for
        copying.
@endnode

@node transfer_dirs
Command: GET TRANSFER_DIRS

Result: Returns how many directories in total have been selected for
        copying.
@endnode

@node transfer_time
Command: GET TRANSFER_TIME

Result: Returns a string in HH:MM:SS format that estimates how long
        it will take to copy the currently selected files.
@endnode

@node version
Command: GET VERSION

Result: Returns the Link It! revision number as a value.  Presently
        it is 1.
@endnode

@node hilite
Command: HILITE pattern

Parameters: pattern - a file pattern

Comments:

This command turns ON the files that match the pattern.
For example, let's say you wanted to copy every "IFF" file
The following would do that:

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

/* this example shows how to HILITE */

ADDRESS LINKIT
HILITE "#?.IFF"
EXIT

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

The command can also be used for a particular file.  For example,
"HILITE MYFILE.TXT".
@endnode

@node loadconfigure
Command: LOADCONFIGURE <name>

Parameters: Configuration filename.

Comments:

This command can be used in two ways:

1) It will load the specified configuration file.
2) It will display the "Load Configuration" file requester if
   no filename is supplied.
@endnode

@node linkit_to_back
Command: LINKIT_TO_BACK

Parameters: None

Comments:

This command causes the Link It! screen (or Window on the PC) to be
sent to the back of the display.
@endnode

@node linkit_to_front
Command: LINKIT_TO_FRONT

Parameters: None

Comments:

This command causes the Link It! screen (or Window on the PC) to be
sent to the front of the display.
@endnode

@node message
Command: MESSAGE [Text]

Parameters: A Text message, enclosed in quotes.

Comments:

This command allows you to display a message to the user, to
a maximum of 28 characters.

Example:

MESSAGE "Hello world"
@endnode

@node none
Command: NONE

Parameters: None

Comments:

This command causes all of the local files to be de-selected.
You can do the same with the remote side by using "REMOTEREXX NONE".
@endnode

@node pattern
Command: PATTERN

Parameters: None

Comments:

This command causes the PATTERN requester to be displayed.
@endnode

@node quit
Command: QUIT

Parameters: None

Comments:

This command causes the local side to quit.  To cause the remote
side to quit, use "REMOTEREXX QUIT".
@endnode

@node remoteinfo
Command: REMOTEINFO

Parameters: None

Comments:

This command causes the "Remote Information" requester to be
displayed.
@endnode

@node remoterexx
Command: REMOTEREXX [command]

Parameters: command - a Link It! ARexx command

Comments:

This command sends whatever "command" you have specified to the
other computer for processing.  It is very powerful and allows you
to mimick all functions that you can do locally on the remote side.

This text has many examples of various commands that can be used
with the REMOTEREXX command.  The only invalid command is another
REMOTEREXX command (ie: REMOTEREXX REMOTEREXX command is not valid).
@endnode

@node resetlog
Command: RESETLOG

Parameters: None

Comments:

Causes the local log to be reset.  You can reset the remote log with
"REMOTEREXX RESETLOG".
@endnode

@node rexxcommand
Command: REXXCOMMAND [num]

Parameters: num - a number from 1-10.

Comments:

Causes whatever command that has been assigned to the appropriate
function key to run (ie: command number 1 was assigned to F1).

NOTE: THIS COMMAND IS NOT SUPPORTED ON THE PC.
@endnode

@node rexxother
Command: REXXOTHER

Parameters: None

Comments:

This command causes the "Other Rexx Command" requester to
appear, so the user may select a script.
@endnode

@node saveconfigure
Command: SAVECONFIGURE <name>

Parameters: name - a configuration filename, ending in ".CFG"

Comments:

This command can be used in two ways to save the current
configuration:

1) Immediately save to the supplied filename or
2) If no filename is supplied, the "Save Configure" file requester
   is displayed.
@endnode

@node shellexecute
Command: SHELLEXECUTE [command]

Parameters: command - a command line

Comments:

This command causes the specified command to be executed (launched).
Note you must supply a valid command name.  The following examples
should demonstrate:

SHELLEXECUTE "ED Work:ReadMe"     (causes the ED command to run and
                                   load the file "Work:ReadMe").

REMOTEREXX SHELLEXECUTE "C:\WINWORD\WINWORD.EXE"
				  (causes the remote PC to run a
				   copy of Microsoft Word)
@endnode

@node sort
Command: SORT [by]

Parameters: by - which method of sorting you wish

Comments:

The following are examples show how to change the current local
sortation method.

SORT FILENAME
SORT SIZE
SORT DATE
@endnode

@node Ack "Acknowledgements"

ARexx Copyright (C) 1987 by William S. Hawes

AmigaGuide and Workbench Copyright (C) Commodore-Amiga

Link It! Copyright 1994-1995 Legendary Design Technologies Inc.

Thank you:

	Adam White, Ken Dobson, Jim Appleby, Lorie Stanley,
	Dale Larson, Paul Safr, Ken Shipman, Matthew Sloan,
	John Florek, Trish Kooger, David Sopuch, Rick South,
	Beth White, Alex White, and all of those patient users.

All products and names mentioned are property of their respective
owners.  No infringement intended.
@endnode


@node dummy
	!!!
@endnode