PDA Software Library/pdasoftwarelib.iso/PSION/COMMS/SY/HELP.TXT

Text File | 1993-05-12 | 12.0 KB | 354 lines

HELP - SYLINK

SYLINK is a communications utility designed for communicating to Psion
computers. Invocation from the command line is very flexible:

    SYLINK [-<option>[ ...]] [@<cmdfile>[ ...]] [<command>[ : ...]]

Once invoked, SYLINK sets the options and then runs each of the
command files. Once the command files have been executed the user will
be left at the command level to give further commands unless the -q option
was given. Following execution of the command files the commands on the
command line are executed. Before the commands are executed the link to
the remote device will automatically be made. Several commands may be given
separated by a colon and spaces.

Communications is performed using Psion's own communications protocol which
incorporates error detection combined with a retry mechanism to correct
errors arising from noisy lines. If modems are to be used there is no
added value in using the modem's error detection. However, if data
compaction is available on the modem, this will speed up the transfer

The error return to DOS is provided so that ERRORLEVEL may be used.
The values returned are:
   0   No error
   1   Line failure
   2   Error during execution of a command
   3   File not found error (including directory listings)
   4   Device full
   5   No response from remote device during connection
   6   General error
   7   SYLINK internal error

The file sy$serv.img must be in the same directory as sylink and is
copied to rem::m:\ when required if not already on the remote device.

The handshaking that should be used is DSR/DTR if a direct link is to
be made. If a modem is to be used then use both DSR/DTR and DCD
handshaking. This can be done easily by setting handshaking to DIRECT
or MODEM, eg set -phdirect or set -phmodem.

HELP - COMMANDS

Runs the command given. If the -s option is set and the command run
from a command file then only informative messages are displayed.
If an error occurs in a command file, execution of the command files
is automatically halted and control passed back to the console, or
SYLINK is exited if the command file was invoked from the command line.
The command line editor has a memory of commands so that the up and down
arrow keys may be used. There is also a type-ahead facility to enable
you to type the next commands whilst still executing other commands.
Control C aborts the current command and, if a batch file is running,
that too is aborted.

If the command is preceded by a dollar sign ($) then the command is
passed to the remote device for execution and the completion returned
to the user.
If the line is preceded by the at symbol (@) then that command file
with default extension .SYL is invoked. Command files may be nested to
a depth of about 15 depending on the memory available. The prompt will
display the command file being executed and the depth of the nesting.

HELP - OPTIONS

Sets the options for the system. Invoked from the command line, e.g.

sylink -s -pb2400

or using the SET command

HELP - OPTIONS - SERIAL PORT

Sets the serial parameters (default in brackets):
-pa<addr> - sets the comms base address of the port for COM port
            or for the multiport card (0x3f8)
-pb<baud> - sets the baud rate. Supports 300,1200,2400,4800,9600,19200 (9600)
-pc<port no> - sets the port interrupt and address for COM1 to COM4 (COM1)
-pd<7|8> - sets the number of data bits to 7 or 8 (8)
-pf - use XON/XOFF flow control (not used)
-ph<(rts|cts)|(dsr|dtr)|dcd|direct|modem|none> - use the handshaking required
                                                 (DSR)
-pi<int no> - sets the comms interrupt number (4)
-pm<n><hostess|none> - use the driver for the Comtrol Hostess multiport card
                       treating it as port <n>(1 to n)      (1,none)
-pp<none|odd|even> - use the parity required (No parity)
-ps<1|2> - use 1 or 2 stop bits (1)
-pt<second> - timeout during connection (10)

All the option arguments may be given as decimal or, if preceded by
0x, as hexadecimal.

The handshaking that should be used is DSR/DTR if a direct link is to
be made. If a modem is to be used then use both DSR/DTR and DCD
handshaking.

HELP - OPTIONS - GENERAL

Sets parameters used by SYLINK:
-q - quit SYLINK after command files and commands executed.
-l<lines> - number of lines in the output window. Defaults to 25.
            It is used to control the break between giving pause
            messages which is set to 2 less than the number of lines.
            If set to 0 then pauses are suppressed.

HELP - COMMANDS - AT

Syntax: at <col>,<row>
Set the position for output.

HELP - COMMANDS - AUTOLINK

Syntax: autol[ink] [on|off]
If no parameter is given then the status is shown. If autolink is set
to ON the link will be made when the 2 computers are connected and the
hardware handshaking has been established. If the link fails or is
closed by the remote end then the autolink remains active. The autolink
is automatically switched off if the link is closed at the local end.
Alternatively, it may be switched off explicitly using this command.
If autoquit is switched on then the program will exit once the link is
broken or closed.

HELP - COMMANDS - AUTOQUIT

Syntax: autoq[uit] [on|off]
If no parameter is given then the status is shown. If autoquit is set
to ON the program will exit once the link has been closed by the remote
end or if SYLINK fails to connect. The DOS errorlevel may be used to
ascertain the exit reason. SYLINK does not quit if the CLOSE command
has been used.

HELP - COMMANDS - CLOSE

Syntax: close
Close the communications link

HELP - COMMANDS - CLS

Syntax: cls
Clear the screen

HELP - COMMANDS - COPY

Syntax: copy <from> [<to>] [/a]
Copy the files <from> to the location and name <to>. The relevant
filing system is used to parse the file name.
If the /a flag is given then the <to> file is appended to the
<from> file

HELP - COMMANDS - DELETE

Syntax: delete <fname>
Deletes the file <fname>. The relevant filing system is used to parse
the file name.

HELP - COMMANDS - DIR

Syntax: dir <fspec> [/w/h/s]
Perform a directory listing of <fspec>. The relevant filing system
is used to parse the file name. The flags are:
/w - give a wide listing containing only file names
/h - include hidden files
/s - include system files

HELP - COMMANDS - EXIT

Syntax: exit|quit
Exit from SYLINK closing the communications link as necessary.

HELP - COMMANDS - FORMAT

Syntax: format rem::<device>[\<name>[.<ext>]]
Format the SSD in the remote device. All the information will be
lost and all files deleted. The SSD will be given the name name.ext
and you will be shown the total amount of free space.
A percentage complete indicator is provided to inform you of the
progress of the format.

HELP - COMMANDS - FREE

Syntax: free [<dev>]
Displays the amount of free space on the device defaulting to
the current device on loc::.
Not implemented

HELP - COMMANDS - HELP

Syntax: help [<command>]
Gives help on the required command
Not implemented
Currently lists help for all commands.

HELP - COMMANDS - LDISP

Syntax: ldisp <text>
Display <text> on the local screen.

HELP - COMMANDS - LINK

Syntax: link
Links to the remote device with the timeout set using SET -t<seconds>.
It uses the port as defined by set and assumes that all modem commands
have been executed.

HELP - COMMANDS - LOGCLOSE

Syntax: logc[lose]
Closes the log file. This is automatically closed when the program
exits. If the log file has been opened on the remote device then it
must be closed before the link is closed.

HELP - COMMANDS - LOGOPEN

Syntax: logo[pen] <fname> [/a]
Open the log file with default extension .LOG.  The file will contain
the date and time of the entry followed by the text that would be
displayed to the screen. Any extra information may be written to the
file with the logwrite command. The file extension will be .LOG by
default. If the /a flag is supplied data will be appended to that file.

HELP - COMMANDS - LOGWRITE

Syntax: logw[rite] <text>
Write text to the log file. The information is preceded by the date
and time.

HELP - COMMANDS - MKDIR

Syntax: mkdir <path>   or   md <path>
Makes the directory <path> on either the local or the remote
device.

HELP - COMMANDS - MODEM

Syntax: modem <command>
Sends the command to the modem
Not implemented

HELP - COMMANDS - QUIT

Syntax: quit|exit
Exit from SYLINK closing the communications link as necessary.

HELP - COMMANDS - RDISP

Syntax: rdisp <message>
Displays a message on the remote device.
Not implemented

HELP - COMMANDS - RENAME

Syntax: ren[ame] <fname1> <fname2>
Renames <fname1> as <fname2>. The files must be on the same machine
and the same drive. Wild cards are supported.

HELP - COMMANDS - RMDIR

Syntax: rmdir <path>   or   rd <path>
Deletes the directory <path> on either the local or the remote
device. The directory must be empty and there must be no
subdirectories

HELP - COMMANDS - SET

Syntax: set [[-<option>],...]
Shows the setting of the options if no argument given.
Sets the options:
-l<lines> - Set number of lines in the screen.
-pa<addr> - sets the comms base address of the port for COM port
            or for the multiport card (0x3f8)
-pb<baud> - sets the baud rate. Supports 300,1200,2400,4800,9600,19200 (9600)
-pc<port no> - sets the port interrupt and address for COM1 to COM4 (COM1)
-pd<7|8> - sets the number of data bits to 7 or 8 (8)
-pf - use XON/XOFF flow control (not used)
-ph<(rts|cts)|(dsr|dtr)|dcd|direct|modem|none> - use the handshaking required
                                                 (DSR)
-pi<int no> - sets the comms interrupt number (4)
-pm<n><hostess|none> - use the driver for the Comtrol Hostess multiport card
                       treating it as port <n>(1 to n)      (1,none)
-pp<none|odd|even> - use the parity required (No parity)
-ps<1|2> - use 1 or 2 stop bits (1)
-pt<second> - timeout during connection (10)
-q - No effect
-s - Do not reflect commands from command files

The options may also be set from the command line.

HELP - COMMANDS - SETTIME

Syntax: settime
Sets the time on the remote computer to the current time on the
local computer

HELP - COMMANDS - SHDN

Syntax: shdn @[dd/mm/yy ]hh:mm | +[[dd:]hh:]mm
Shut the system down at a given date and time (@) or at a
relative time to now(+).
Not implemented

HELP - COMMANDS - STYPE

Syntax: stype [<dev>]
Show the type of the device, defaulting to the current device.
Not implemented

HELP - COMMANDS - TEL

Syntax: tel <telno>
Dial the telephone number <telno> via the modem. The telephone
number is preceded by the Hayes ATD command. There is no validation
of the telephone number so any character string may be used.
Not implemented

HELP - COMMANDS - TIME

Syntax: time
Display the system date and time

HELP - COMMANDS - TYPE

Syntax: ty[pe] <fname>
Displays a file to the screen

HELP - COMMANDS - VERSION

Syntax: ver[sion]
Display the version of SYLINK

HELP - COMMANDS - WAIT

Syntax: wait @[dd/mm/yy ]hh:mm | +[[dd:]hh:]mm | link | close
Wait until a given date and time (@) or at a relative time to now (+).
If link has been given in place of a date and time, then wait until a
link has been established before proceding. If close has been given
then wait until a link has been terminated or the link broken.
Not implemented

HELP - COMMANDS - WHERE

Syntax: wh[ere]
Display the current directory


SHAREWARE
=========
If you find SYLINK useful a registration fee of £20 would be
appreciated which gives you the latest copy and access to telephone
support. Corporate users must obtain a license and multiple licenses
are available. For further information see the order form or contact:
                   Synamic Ltd
                   244 Randolph Avenue
                   London     W9 1PF
                   England
                   T ([phone]   Fax [phone]