home *** CD-ROM | disk | FTP | other *** search
/ Boot Disc 8 / boot-disc-1997-04.iso / PDA_Soft / Psion / comms / sy / HELP.TXT next >
Text File  |  1993-05-12  |  12KB  |  354 lines
  1. HELP - SYLINK
  2.  
  3. SYLINK is a communications utility designed for communicating to Psion
  4. computers. Invocation from the command line is very flexible:
  5.  
  6.     SYLINK [-<option>[ ...]] [@<cmdfile>[ ...]] [<command>[ : ...]]
  7.  
  8. Once invoked, SYLINK sets the options and then runs each of the
  9. command files. Once the command files have been executed the user will
  10. be left at the command level to give further commands unless the -q option
  11. was given. Following execution of the command files the commands on the
  12. command line are executed. Before the commands are executed the link to
  13. the remote device will automatically be made. Several commands may be given
  14. separated by a colon and spaces.
  15.  
  16. Communications is performed using Psion's own communications protocol which
  17. incorporates error detection combined with a retry mechanism to correct
  18. errors arising from noisy lines. If modems are to be used there is no
  19. added value in using the modem's error detection. However, if data
  20. compaction is available on the modem, this will speed up the transfer
  21.  
  22. The error return to DOS is provided so that ERRORLEVEL may be used.
  23. The values returned are:
  24.    0   No error
  25.    1   Line failure
  26.    2   Error during execution of a command
  27.    3   File not found error (including directory listings)
  28.    4   Device full
  29.    5   No response from remote device during connection
  30.    6   General error
  31.    7   SYLINK internal error
  32.  
  33. The file sy$serv.img must be in the same directory as sylink and is
  34. copied to rem::m:\ when required if not already on the remote device.
  35.  
  36. The handshaking that should be used is DSR/DTR if a direct link is to
  37. be made. If a modem is to be used then use both DSR/DTR and DCD
  38. handshaking. This can be done easily by setting handshaking to DIRECT
  39. or MODEM, eg set -phdirect or set -phmodem.
  40.  
  41. HELP - COMMANDS
  42.  
  43. Runs the command given. If the -s option is set and the command run
  44. from a command file then only informative messages are displayed.
  45. If an error occurs in a command file, execution of the command files
  46. is automatically halted and control passed back to the console, or
  47. SYLINK is exited if the command file was invoked from the command line.
  48. The command line editor has a memory of commands so that the up and down
  49. arrow keys may be used. There is also a type-ahead facility to enable
  50. you to type the next commands whilst still executing other commands.
  51. Control C aborts the current command and, if a batch file is running,
  52. that too is aborted.
  53.  
  54. If the command is preceded by a dollar sign ($) then the command is
  55. passed to the remote device for execution and the completion returned
  56. to the user.
  57. If the line is preceded by the at symbol (@) then that command file
  58. with default extension .SYL is invoked. Command files may be nested to
  59. a depth of about 15 depending on the memory available. The prompt will
  60. display the command file being executed and the depth of the nesting.
  61.  
  62. HELP - OPTIONS
  63.  
  64. Sets the options for the system. Invoked from the command line, e.g.
  65.  
  66. sylink -s -pb2400
  67.  
  68. or using the SET command
  69.  
  70. HELP - OPTIONS - SERIAL PORT
  71.  
  72. Sets the serial parameters (default in brackets):
  73. -pa<addr> - sets the comms base address of the port for COM port
  74.             or for the multiport card (0x3f8)
  75. -pb<baud> - sets the baud rate. Supports 300,1200,2400,4800,9600,19200 (9600)
  76. -pc<port no> - sets the port interrupt and address for COM1 to COM4 (COM1)
  77. -pd<7|8> - sets the number of data bits to 7 or 8 (8)
  78. -pf - use XON/XOFF flow control (not used)
  79. -ph<(rts|cts)|(dsr|dtr)|dcd|direct|modem|none> - use the handshaking required
  80.                                                  (DSR)
  81. -pi<int no> - sets the comms interrupt number (4)
  82. -pm<n><hostess|none> - use the driver for the Comtrol Hostess multiport card
  83.                        treating it as port <n>(1 to n)      (1,none)
  84. -pp<none|odd|even> - use the parity required (No parity)
  85. -ps<1|2> - use 1 or 2 stop bits (1)
  86. -pt<second> - timeout during connection (10)
  87.  
  88. All the option arguments may be given as decimal or, if preceded by
  89. 0x, as hexadecimal.
  90.  
  91. The handshaking that should be used is DSR/DTR if a direct link is to
  92. be made. If a modem is to be used then use both DSR/DTR and DCD
  93. handshaking.
  94.  
  95. HELP - OPTIONS - GENERAL
  96.  
  97. Sets parameters used by SYLINK:
  98. -q - quit SYLINK after command files and commands executed.
  99. -l<lines> - number of lines in the output window. Defaults to 25.
  100.             It is used to control the break between giving pause
  101.             messages which is set to 2 less than the number of lines.
  102.             If set to 0 then pauses are suppressed.
  103.  
  104. HELP - COMMANDS - AT
  105.  
  106. Syntax: at <col>,<row>
  107. Set the position for output.
  108.  
  109. HELP - COMMANDS - AUTOLINK
  110.  
  111. Syntax: autol[ink] [on|off]
  112. If no parameter is given then the status is shown. If autolink is set
  113. to ON the link will be made when the 2 computers are connected and the
  114. hardware handshaking has been established. If the link fails or is
  115. closed by the remote end then the autolink remains active. The autolink
  116. is automatically switched off if the link is closed at the local end.
  117. Alternatively, it may be switched off explicitly using this command.
  118. If autoquit is switched on then the program will exit once the link is
  119. broken or closed.
  120.  
  121. HELP - COMMANDS - AUTOQUIT
  122.  
  123. Syntax: autoq[uit] [on|off]
  124. If no parameter is given then the status is shown. If autoquit is set
  125. to ON the program will exit once the link has been closed by the remote
  126. end or if SYLINK fails to connect. The DOS errorlevel may be used to
  127. ascertain the exit reason. SYLINK does not quit if the CLOSE command
  128. has been used.
  129.  
  130. HELP - COMMANDS - CLOSE
  131.  
  132. Syntax: close
  133. Close the communications link
  134.  
  135. HELP - COMMANDS - CLS
  136.  
  137. Syntax: cls
  138. Clear the screen
  139.  
  140. HELP - COMMANDS - COPY
  141.  
  142. Syntax: copy <from> [<to>] [/a]
  143. Copy the files <from> to the location and name <to>. The relevant
  144. filing system is used to parse the file name.
  145. If the /a flag is given then the <to> file is appended to the
  146. <from> file
  147.  
  148. HELP - COMMANDS - DELETE
  149.  
  150. Syntax: delete <fname>
  151. Deletes the file <fname>. The relevant filing system is used to parse
  152. the file name.
  153.  
  154. HELP - COMMANDS - DIR
  155.  
  156. Syntax: dir <fspec> [/w/h/s]
  157. Perform a directory listing of <fspec>. The relevant filing system
  158. is used to parse the file name. The flags are:
  159. /w - give a wide listing containing only file names
  160. /h - include hidden files
  161. /s - include system files
  162.  
  163. HELP - COMMANDS - EXIT
  164.  
  165. Syntax: exit|quit
  166. Exit from SYLINK closing the communications link as necessary.
  167.  
  168. HELP - COMMANDS - FORMAT
  169.  
  170. Syntax: format rem::<device>[\<name>[.<ext>]]
  171. Format the SSD in the remote device. All the information will be
  172. lost and all files deleted. The SSD will be given the name name.ext
  173. and you will be shown the total amount of free space.
  174. A percentage complete indicator is provided to inform you of the
  175. progress of the format.
  176.  
  177. HELP - COMMANDS - FREE
  178.  
  179. Syntax: free [<dev>]
  180. Displays the amount of free space on the device defaulting to
  181. the current device on loc::.
  182. Not implemented
  183.  
  184. HELP - COMMANDS - HELP
  185.  
  186. Syntax: help [<command>]
  187. Gives help on the required command
  188. Not implemented
  189. Currently lists help for all commands.
  190.  
  191. HELP - COMMANDS - LDISP
  192.  
  193. Syntax: ldisp <text>
  194. Display <text> on the local screen.
  195.  
  196. HELP - COMMANDS - LINK
  197.  
  198. Syntax: link
  199. Links to the remote device with the timeout set using SET -t<seconds>.
  200. It uses the port as defined by set and assumes that all modem commands
  201. have been executed.
  202.  
  203. HELP - COMMANDS - LOGCLOSE
  204.  
  205. Syntax: logc[lose]
  206. Closes the log file. This is automatically closed when the program
  207. exits. If the log file has been opened on the remote device then it
  208. must be closed before the link is closed.
  209.  
  210. HELP - COMMANDS - LOGOPEN
  211.  
  212. Syntax: logo[pen] <fname> [/a]
  213. Open the log file with default extension .LOG.  The file will contain
  214. the date and time of the entry followed by the text that would be
  215. displayed to the screen. Any extra information may be written to the
  216. file with the logwrite command. The file extension will be .LOG by
  217. default. If the /a flag is supplied data will be appended to that file.
  218.  
  219. HELP - COMMANDS - LOGWRITE
  220.  
  221. Syntax: logw[rite] <text>
  222. Write text to the log file. The information is preceded by the date
  223. and time.
  224.  
  225. HELP - COMMANDS - MKDIR
  226.  
  227. Syntax: mkdir <path>   or   md <path>
  228. Makes the directory <path> on either the local or the remote
  229. device.
  230.  
  231. HELP - COMMANDS - MODEM
  232.  
  233. Syntax: modem <command>
  234. Sends the command to the modem
  235. Not implemented
  236.  
  237. HELP - COMMANDS - QUIT
  238.  
  239. Syntax: quit|exit
  240. Exit from SYLINK closing the communications link as necessary.
  241.  
  242. HELP - COMMANDS - RDISP
  243.  
  244. Syntax: rdisp <message>
  245. Displays a message on the remote device.
  246. Not implemented
  247.  
  248. HELP - COMMANDS - RENAME
  249.  
  250. Syntax: ren[ame] <fname1> <fname2>
  251. Renames <fname1> as <fname2>. The files must be on the same machine
  252. and the same drive. Wild cards are supported.
  253.  
  254. HELP - COMMANDS - RMDIR
  255.  
  256. Syntax: rmdir <path>   or   rd <path>
  257. Deletes the directory <path> on either the local or the remote
  258. device. The directory must be empty and there must be no
  259. subdirectories
  260.  
  261. HELP - COMMANDS - SET
  262.  
  263. Syntax: set [[-<option>],...]
  264. Shows the setting of the options if no argument given.
  265. Sets the options:
  266. -l<lines> - Set number of lines in the screen.
  267. -pa<addr> - sets the comms base address of the port for COM port
  268.             or for the multiport card (0x3f8)
  269. -pb<baud> - sets the baud rate. Supports 300,1200,2400,4800,9600,19200 (9600)
  270. -pc<port no> - sets the port interrupt and address for COM1 to COM4 (COM1)
  271. -pd<7|8> - sets the number of data bits to 7 or 8 (8)
  272. -pf - use XON/XOFF flow control (not used)
  273. -ph<(rts|cts)|(dsr|dtr)|dcd|direct|modem|none> - use the handshaking required
  274.                                                  (DSR)
  275. -pi<int no> - sets the comms interrupt number (4)
  276. -pm<n><hostess|none> - use the driver for the Comtrol Hostess multiport card
  277.                        treating it as port <n>(1 to n)      (1,none)
  278. -pp<none|odd|even> - use the parity required (No parity)
  279. -ps<1|2> - use 1 or 2 stop bits (1)
  280. -pt<second> - timeout during connection (10)
  281. -q - No effect
  282. -s - Do not reflect commands from command files
  283.  
  284. The options may also be set from the command line.
  285.  
  286. HELP - COMMANDS - SETTIME
  287.  
  288. Syntax: settime
  289. Sets the time on the remote computer to the current time on the
  290. local computer
  291.  
  292. HELP - COMMANDS - SHDN
  293.  
  294. Syntax: shdn @[dd/mm/yy ]hh:mm | +[[dd:]hh:]mm
  295. Shut the system down at a given date and time (@) or at a
  296. relative time to now(+).
  297. Not implemented
  298.  
  299. HELP - COMMANDS - STYPE
  300.  
  301. Syntax: stype [<dev>]
  302. Show the type of the device, defaulting to the current device.
  303. Not implemented
  304.  
  305. HELP - COMMANDS - TEL
  306.  
  307. Syntax: tel <telno>
  308. Dial the telephone number <telno> via the modem. The telephone
  309. number is preceded by the Hayes ATD command. There is no validation
  310. of the telephone number so any character string may be used.
  311. Not implemented
  312.  
  313. HELP - COMMANDS - TIME
  314.  
  315. Syntax: time
  316. Display the system date and time
  317.  
  318. HELP - COMMANDS - TYPE
  319.  
  320. Syntax: ty[pe] <fname>
  321. Displays a file to the screen
  322.  
  323. HELP - COMMANDS - VERSION
  324.  
  325. Syntax: ver[sion]
  326. Display the version of SYLINK
  327.  
  328. HELP - COMMANDS - WAIT
  329.  
  330. Syntax: wait @[dd/mm/yy ]hh:mm | +[[dd:]hh:]mm | link | close
  331. Wait until a given date and time (@) or at a relative time to now (+).
  332. If link has been given in place of a date and time, then wait until a
  333. link has been established before proceding. If close has been given
  334. then wait until a link has been terminated or the link broken.
  335. Not implemented
  336.  
  337. HELP - COMMANDS - WHERE
  338.  
  339. Syntax: wh[ere]
  340. Display the current directory
  341.  
  342.  
  343. SHAREWARE
  344. =========
  345. If you find SYLINK useful a registration fee of £20 would be
  346. appreciated which gives you the latest copy and access to telephone
  347. support. Corporate users must obtain a license and multiple licenses
  348. are available. For further information see the order form or contact:
  349.                    Synamic Ltd
  350.                    244 Randolph Avenue
  351.                    London     W9 1PF
  352.                    England
  353.                    T (+44) 0 71 328 4964   Fax (+44) 0 71 624 3369
  354.