home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / pocketbk / comms / rfm110 / RFM.TXT < prev    next >
Text File  |  1993-12-13  |  9KB  |  302 lines
  1.                 RFM command summary
  2.                 ===================
  3.  
  4. RFM INSTALL [PORT=] [BAUD=] [USE J: A:]*4
  5.  
  6.     Installs the TSR. If PORT= or BAUD= is supplied then they must
  7.     occur before any USE commands. Up to 4 drive pairs can be
  8.     specified after the USE commands. The first drive letter
  9.     specifies an MSDOS drive and the second drive letter specifies
  10.     a drive letter on the remote machine.
  11.  
  12.     PORT= may be specified as:
  13.  
  14.           COM1,COM2,COM3 or COM4. Alternatively as:
  15.           1,2,3 or 4. Alternatively as TTY:nXyyy where:
  16.           n=Interrupt number in HEX (i.e. 3,4,A,B etc.)
  17.           yyy=I/O base address in HEX (i.e. 3F8)
  18.  
  19.           Default=COM1
  20.  
  21.     BAUD= maybe specifies as:
  22.  
  23.           300,600,1200,2400,4800,9600,19200.
  24.  
  25.           Default=19200 (For Series3 Classic or HC this should be 9600).
  26.  
  27.     Not available under windows.
  28.  
  29.     EXAMPLES
  30.  
  31.         RFM INSTALL USE I: M: L: A: R: B:
  32.  
  33.         This installs the RFM TSR using COM1 at 19200 baud and maps
  34.         MSDOS drive I: to the remote drive M: (internal), L: to A: and
  35.         R: to B:. (I,L and R are nmemonics for INTERNAL,LEFT and RIGHT).
  36.  
  37.         RFM INSTALL PORT=2 USE I: M: L: A: R: B:
  38.  
  39.         As above but uses port COM2.
  40.  
  41.         RFM INSTALL PORT=COM2 BAUD=9600 USE I: M: L: A: R: B:
  42.  
  43.         As above but uses a baud rate of 9600.
  44.  
  45.         RFM I P=2 B=9600 U I: M: L: A: R: B:
  46.  
  47.         As above but uses abbreviations for all the keywords.
  48.  
  49.         RFM I P=TTY:3x2F8 B=9600 U I: M: L: A: R: B:
  50.  
  51.         As above but specifies IRQ 3 and I/O address 2F8 which is the
  52.         same as COM2.
  53.  
  54. RFM SHELL [PORT=] [BAUD=] [USE J: A:]*4 [EXEC=command]
  55.  
  56.     Starts RFM and then executes the DOS command shell, optionally
  57.     passing it a command line. If a command line is specified then it
  58.     will be executed and RFM will exit. The command can be a .BAT file.
  59.  
  60.     The PORT,BAUD and USE commands are as described for INSTALL.
  61.  
  62.     If RFM is started without a command then it can be exited by typing
  63.     EXIT at the command line. Note that in this mode RFM REMOVE does
  64.     not have any effect.
  65.  
  66.     Not available under windows.
  67.  
  68. RFM REMOVE
  69.  
  70.     Removes the TSR after freeing all the USE drives. This command
  71.     reports an error if RFM was started with the SHELL command.
  72.  
  73.     Not available under windows.
  74.  
  75. RFM PAUSE
  76.  
  77.     Temporarily stops opeartion allowing the PORT to be used for
  78.     other purposes.
  79.  
  80.     Not available under windows.
  81.  
  82. RFM CONTINUE
  83.  
  84.     Resumes operation.
  85.  
  86.     Not available under windows.
  87.  
  88. RFM USE [J: A:]*4
  89.  
  90.     Assigns a DOS drive to the remote drive. Up to 4 pairs of drive
  91.     assignments can be specified.
  92.  
  93.     Not available under windows.
  94.  
  95. RFM FREE [A:]*4
  96.  
  97.     De-assigns the DOS drive. Up to 4 drives can be specified for
  98.     freeing.
  99.  
  100.     Not available under windows.
  101.  
  102. RFM FORMAT J:[\labelname]
  103. RFM NFORMAT J:[\labelname]
  104.  
  105.     Formats the remote assigned to MSDOS drive J: optionally specifying
  106.     the label as labelname. The program will request a Y/N answer before
  107.     proceeding to format the device. Any files open on the remote drive
  108.     will cause this command to return a LOCKED error. It may prove
  109.     useful to use RFM STOP drive: to make sure that no files remain open
  110.     on the remote drive.
  111.  
  112.     NFORMAT behaves in a similar fashion to FORMAT with the exeception
  113.     that no Y/N answer is requested. This is dangerous, so use it with
  114.     caution.
  115.  
  116. RFM STOP J:
  117.  
  118.     This command will stop any programs which have files open on the
  119.     remote drive assign to the MSDOS drive.
  120.  
  121.     This command is especially useful when backing up the whole of a
  122.     remote drive. By stopping all running programs on the remote drive
  123.     all files can be copied without ACCESS errors stopping the copy.
  124.  
  125. RFM [DISPLAY]
  126.  
  127.     Shows the current status of RFM.
  128.  
  129. RFM QUERY
  130.  
  131.     Sets the ERRORLEVEL variable in batch files to:
  132.  
  133.     0 - If RFM is running and connected.
  134.     1 - If RFM is not running.
  135.     2 - If RFM is running and not connected.
  136.  
  137. RFM EXEC programName [MODE=mode] [ALIAS=alias] [DIR=dir]
  138.                  [EXT=ext] [TEMPLATE=template]
  139.          [command/filename]
  140.  
  141.  
  142. N.B. This function isn't fully implemented yet in V1.10
  143. =======================================================
  144.  
  145.     This will cause the program programName to be started on
  146.     the remote computer and optionally pass it a command. For Series3
  147.     computers the filename to be opened is all that is normally needed
  148.     as RFM will work out the necessary details. If no drive letter is
  149.     specified then the internal drive will always be used.
  150.  
  151.     RFM EXEC SHEET BUDGET (Opens the file \SPR\BUDGET.SPR on internal)
  152.     RFM EXEC SHEET A:BUDGET (Opens the file \SPR\BUDGET.SPR on drive A:)
  153.     RFM EXEC SHEET A:BUDGET (Opens the file \SPR\BUDGET.SPR on drive A:)
  154.     RFM EXEC \TEST *.* (Run file TEST in the root directory passing it
  155.                 a command line of *.*)
  156.  
  157.     If program name is specified without an extension, i.e. RFM E AGENDA
  158.     then a search will be made for the program on all drives of the local
  159.     filing system and then the ROM filing system looking for files with
  160.     the extensions in the following order:
  161.  
  162.     1) .ALS in directory \APP\ (.ALS is an ALIAS file)
  163.     2) .OPO in directory \OPO\ (.OPO is an OPL program)
  164.     3) .OPA in directory \OPA\ (.OPA is an OPL application)
  165.     4) .APP in directory \APP\ (.APP is an application)
  166.     5) .IMG in directory \IMG\ (.IMG is a command line program)
  167.  
  168.     If an extension is specified then the search will be restricted to
  169.     files with that extension only on all drives and the ROM.
  170.  
  171.     If a path is specified then the serach will be in the specified path
  172.     only on all drives. As the ROM filing system does not support paths
  173.     it will not be searched in this case.
  174.  
  175.     If a drive is specified the search will be restricted to that drive
  176.     only.
  177.  
  178.     Series3 programs can also be passed their specialised command lines
  179.     using the MODE, ALIAS, DIR, EXT and TEMPLATE keywords. A command line
  180.     of this kind is signalled by the presence of any of the keywords. If
  181.     the target machine is not a Series3 then these extra parameters are
  182.     ignored and just the command is passed to the program.
  183.  
  184.     MODE=
  185.  
  186.          O - Opens a file which must already exist (default)
  187.          C - Creates a new file which must not exist
  188.  
  189.     ALIAS=
  190.  
  191.         Some programs such WORD.APP can be aliased to behave in
  192.         different ways. WORD.APP if passed ALIAS=OPLXR will behave
  193.         as PROGRAM, the OPL editor.
  194.  
  195.     DIR=
  196.  
  197.         This is the default directory the program should work from.
  198.         For WORD.APP this should be DIR=\WRD\. If no DIR is specified
  199.         then it is taken from the command line which must specify a
  200.         directory. If it does not then a default directory of \TMP\
  201.         will be supplied.
  202.  
  203.     EXT=
  204.  
  205.         This is the default extension for the program. e.g. For Agenda
  206.         it would be .AGN.
  207.  
  208.     TEMPLATE=
  209.  
  210.         Certain programs such as Word use a template file. This is
  211.         specified in the Shell Data File by yet another bit. It gets
  212.         added on the end of path name.
  213.  
  214.     EXAMPLE
  215.  
  216.         RFM E AGENDA.APP M=O DIR=\AGN\ A:\AGN\AGENDA.AGN
  217.  
  218. RFM HELP [INSTALL SHELL REMOVE PAUSE CONTINUE USE FREE
  219.           NFORMAT FORMAT STOP DISPLAY QUERY EXEC]
  220.  
  221.     Provides HELP.
  222.  
  223.  
  224. All RFM commands may be abbreviated. RFM I is equivalent to RFM INSTALL,
  225. as is RFM INST. Where commands start with the same letters enough
  226. letters must be specified to determine which command is required. i.e.
  227. RFM FR and RFM FO for RFM FREE and RFM FORMAT.
  228.  
  229. NOTE: The internal drive on Series3 can be specified as M: or I:.
  230.  
  231. ERRORLEVEL
  232. ----------
  233.  
  234. The RFM program always sets the ERRORLEVEL to 0 on successfully
  235. completing a command. Otherwise it set the level to 1. The RFM
  236. QUERY command is an exeception and can set the value to 0,1 or
  237. 2.
  238.  
  239.                     BACKUP
  240.                     ======
  241.  
  242. RFM can be used to automate the task of backing up a remote drive with
  243. a batch file RBACK.BAT. The batch file is invoked with the following
  244. command line to backup remote drive A.
  245.  
  246. RBACK A
  247.  
  248. This will cause the whole of the