home *** CD-ROM | disk | FTP | other *** search
/ ftp.update.uu.se / ftp.update.uu.se.2014.03.zip / ftp.update.uu.se / pub / rainbow / cpm / misc2 / dosflx41.doc < prev    next >
Text File  |  1994-09-07  |  16KB  |  621 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                       DATE:  18 Jan 84  17:07:21
  13.  
  14.                            Revision 2.0 of
  15.  
  16.                    Functional Specification for the
  17.             Rainbow MS-DOS File Exchange Utility (DOSFLX)
  18.  
  19.  
  20.  
  21.  
  22.  
  23.                        Issued By: Rich Muratori
  24.  
  25.  
  26.  
  27.  
  28.  
  29. Revision History:
  30.  
  31. Rev  1.0    12-Dec-83   by   Rich Muratori      Preliminary release
  32. Rev  2.0    18 Jan 84   by   Rich Muratori      Added TYPE command
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43. MS-DOS File Exchange Utility (DOSFLX)                          Page ii
  44. Table of Contents                                            18 Jan 84
  45.  
  46.  
  47.                           Table of Contents
  48.                                                                   Page
  49.                                                                   ----
  50.         1.0     Product Overview . . . . . . . . . . . . . . . . . . 1
  51.         2.0     Product Goals  . . . . . . . . . . . . . . . . . . . 1
  52.         2.1       Performance  . . . . . . . . . . . . . . . . . . . 1
  53.         2.2       Environments . . . . . . . . . . . . . . . . . . . 1
  54.         3.0     Functional Specification . . . . . . . . . . . . . . 2
  55.         3.1       User Interface . . . . . . . . . . . . . . . . . . 2
  56.         3.2       Miscellaneous Features . . . . . . . . . . . . . . 3
  57.         3.3       READ Command . . . . . . . . . . . . . . . . . . . 3
  58.         3.4       Write Command  . . . . . . . . . . . . . . . . . . 4
  59.         3.5       READ and WRITE Features  . . . . . . . . . . . . . 5
  60.         3.6       DIR Command  . . . . . . . . . . . . . . . . . . . 6
  61.         3.7       DIR/W Command  . . . . . . . . . . . . . . . . . . 7
  62.         3.8       DEL command  . . . . . . . . . . . . . . . . . . . 7
  63.         3.9       TYPE command . . . . . . . . . . . . . . . . . . . 7
  64.         3.10      EXIT Command . . . . . . . . . . . . . . . . . . . 8
  65.         3.11      HELP Command . . . . . . . . . . . . . . . . . . . 8
  66.         3.12      ? Command  . . . . . . . . . . . . . . . . . . . . 8
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91. MS-DOS File Exchange Utility (DOSFLX)                           Page 1
  92. Product Overview                                             18 Jan 84
  93.  
  94.  
  95. 1.0  Product Overview
  96.  
  97. The  DOSFLX  (MS-DOS  File  Exchange)  Utility  Program  provides  the
  98. capability  to  access  MS-DOS  files while running the CP/M operating
  99. system.  Specifically, it provides the capability to:
  100.  
  101.      1.  Take a directory of an MS-DOS disk.
  102.  
  103.      2.  Delete a file on an MS-DOS disk.
  104.  
  105.      3.  Copy a file from an MS-DOS disk to a CP/M disk.
  106.  
  107.      4.  Copy a file from a CP/M disk to an MS-DOS disk.
  108.  
  109. An 'MS-DOS disk' can be any one of the following:
  110.  
  111.      1.  A Rainbow MS-DOS diskette
  112.  
  113.      2.  An IBM 8 sectors-per-track PC-DOS diskette
  114.  
  115.      3.  An IBM 9 sectors-per-track PC-DOS diskette
  116.  
  117.      4.  A Rainbow internal hard disk MS-DOS partition
  118.  
  119.  
  120.  
  121.  
  122. 2.0  Product Goals
  123.  
  124. 2.1  Performance
  125.  
  126.  
  127.      1.  Easy to learn - to eliminate the need for the user to read  a
  128.          manual.   Detailed help information is available at all times
  129.          to explain the command options available.
  130.  
  131.      2.  Easy to use.  The program will enable the sophisticated  user
  132.          to  perform  the  desired  functions with a minimum number of
  133.          keystrokes.
  134.  
  135.  
  136.  
  137.  
  138. 2.2  Environments
  139.  
  140. DOSFLX runs under both CP/M-86/80 Version 2.0 and  Concurrent  CP/M-86
  141. (CCP/M-86).
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163. MS-DOS File Exchange Utility (DOSFLX)                           Page 2
  164. Functional Specification                                     18 Jan 84
  165.  
  166.  
  167. 3.0  Functional Specification
  168.  
  169. 3.1  User Interface
  170.  
  171. DOSFLX is a command-driven program.  The command  keywords  and  their
  172. functions are:
  173.  
  174.      1.  DIR - gives a verbose directory listing of  specified  MS-DOS
  175.          files.
  176.  
  177.      2.  DIR/W - gives a terse directory listing of  specified  MS-DOS
  178.          files.
  179.  
  180.      3.  READ - copies specified MS-DOS files to specified CP/M files.
  181.  
  182.      4.  WRITE - copies  specified  CP/M  files  to  specified  MS-DOS
  183.          files.
  184.  
  185.      5.  DEL - deletes specified MS-DOS files.
  186.  
  187.      6.  HELP - gives general help and specific help on each command.
  188.  
  189.      7.  ?  - gives a brief list of valid commands.
  190.  
  191.      8.  EXIT - stops the program and returns to the operating system.
  192.  
  193.  
  194. The user may enter a command and its arguments in several ways:
  195.  
  196.      1.  Enter the program name, the command, and command arguments on
  197.          the CP/M command line.  For example,
  198.  
  199.                      A>DOSFLX DIR A:
  200.  
  201.      2.  Enter only the program name on the CP/M command  line.   This
  202.          places  you  into DOSFLX command mode.  Enter the command and
  203.          its arguments on the DOSFLX command line.  For example,
  204.  
  205.                A>DOSFLX
  206.                DOSFLX>DIR A:
  207.  
  208.      3.  Enter only the program name on the CP/M command line.   Enter
  209.          only  the  command  on  the DOSFLX command line.  DOSFLX will
  210.          prompt you for the command arguments.  For example,
  211.  
  212.                A>DOSFLX
  213.                DOSFLX>DIR
  214.                MS-DOS directory:
  215.  
  216. For mode 1, after the specified command is executed, DOSFLX returns to
  217. the  operating  system.   For modes 2 and 3, DOSFLX returns to its own
  218. command level after command execution.
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235. MS-DOS File Exchange Utility (DOSFLX)                           Page 3
  236. Functional Specification                                     18 Jan 84
  237.  
  238.  
  239. 3.2  Miscellaneous Features
  240.  
  241. MS-DOS  conventions  and  functionality   are   implemented   wherever
  242. possible.   This  means that directory typeouts are identical to those
  243. given by MS-DOS.  Interpretation of directory and file  specifications
  244. is identical to MS-DOS.
  245.  
  246. Drive names A-D are interpreted to be floppy disk drives.  Drive names
  247. E-L are interpreted to be hard disk partitions.  All other drive names
  248. are invalid.
  249.  
  250. Both upper and lower case input is accepted.
  251.  
  252. In order to implement Control-C aborting during  the  read  and  write
  253. operations,  typeahead  had  to  be  disallowed.   The input buffer is
  254. flushed before the DOSFLX command mode is entered.
  255.  
  256.  
  257.  
  258. 3.3  READ Command
  259.  
  260. The READ command copies specified files from an MS-DOS formatted  disk
  261. to  specified files on a CP/M formatted disk.  The command line format
  262. is:
  263.  
  264.             READ source-spec destination-spec
  265.  
  266. The source-spec specifies the MS-DOS file(s) to be copied.  Its format
  267. is:
  268.  
  269.             sdrv:[path]sfilnam.typ
  270.  
  271. where 'sdrv' is the MS-DOS drive,
  272.       'path' is an optional MS-DOS directory specification,
  273.       'sfilnam.typ' is the MS-DOS file specification.
  274.  
  275. The user must specify a source drive and file specification.   A  path
  276. is optional depending on the location of the file(s) to be read.
  277.  
  278. The destination-spec specifies the CP/M file(s) into which the  MS-DOS
  279. file(s) are to be copied.  Its format is:
  280.  
  281.             [ddrv:][dfilnam.typ]
  282.  
  283. where 'ddrv:' is an optional CP/M drive,
  284.       'dfilnam.typ' is an optional CP/M file specification,
  285.  
  286. Both the destination drive and file specification are  optional.   The
  287. destination  drive  defaults  to  the  currently logged in drive.  The
  288. destination  file  specification   defaults   to   the   source   file
  289. specification.  If the user types READ A:FOO.BAR followed by a return,
  290. the program does not  prompt  for  a  destination  specification.   It
  291. assumes the default specification.  The default is also assumed if the
  292. user types only a return in response to the prompt for  a  destination
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307. MS-DOS File Exchange Utility (DOSFLX)                           Page 4
  308. Functional Specification                                     18 Jan 84
  309.  
  310.  
  311. specification.
  312.  
  313. If the MS-DOS source file is marked hidden or system, it will  not  be
  314. read.   A  file-not-found  message  will  be  displayed.   However, no
  315. message is displayed if a hidden or system file is among  a  group  of
  316. files being read as part of a wildcarded source specification.
  317.  
  318.  
  319.  
  320. 3.4  Write Command
  321.  
  322. The WRITE command copies specified files from a CP/M formatted disk to
  323. specified  files on an MS-DOS formatted disk.  The command line format
  324. is:
  325.  
  326.             WRITE sourcespec destination-spec
  327.  
  328. The source-spec specifies the CP/M file(s) to be copied.   Its  format
  329. is:
  330.  
  331.             sdrv:]sfilnam.typ
  332.  
  333. where 'sdrv:' is an optional CP/M drive,
  334.       'sfilnam.typ' is a CP/M file specification,
  335.  
  336. If no CP/M source drive is  specified,  it  defaults  to  the  current
  337. logged-in drive.
  338.  
  339. The destination-spec specifies the MS-DOS file(s) into which the  CP/M
  340. source file(s) are to be copied.  Its format is:
  341.  
  342.             ddrv:[path][dfilnam.typ]
  343.  
  344. where 'ddrv' is the MS-DOS drive,
  345.       'path' is an optional MS-DOS directory specification,
  346.       'dfilnam.typ' is an optional MS-DOS file specification.
  347.  
  348. The  destination  drive  is  required,   but   the   path   and   file
  349. specifications  are  optional.  The file specification defaults to the
  350. CP/M source file specification.
  351.  
  352. If the destination file  specification  points  to  a  file  whicl  is
  353. read-only,  hidden,  or  system,  that  file is not copied.  Instead a
  354. message is displayed to notify the user of the situation.
  355.  
  356. After copying the file, DOSFLX sets the MS-DOS file's Archive bit  and
  357. clears all other attributes.
  358.  
  359. If the CP/M system time is  not  set  or  contains  a  date  prior  to
  360. 1-Jan-83,  the time and date in the MS-DOS file are set to 12:00 am on
  361. 1-Nov-83.  Otherwise, the CP/M system time is used.
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379. MS-DOS File Exchange Utility (DOSFLX)                           Page 5
  380. Functional Specification                                     18 Jan 84
  381.  
  382.  
  383. If the MS-DOS file already exists, a pre-delete of that file is  done.
  384. This is the same as is done by the COPY command.
  385.  
  386.  
  387.  
  388. 3.5  READ and WRITE Features
  389.  
  390. The READ and WRITE commands share the following features:
  391.  
  392.      1.  As the files are copied,  the  source  and  destination  file
  393.          specifications  are  displayed.  When all files are copied, a
  394.          summary of the number of files copied is displayed.
  395.  
  396.      2.  The read or write operation can aborted by  typing  Control-C
  397.          twice  (once  under  Concurrent CP/M).  The operation will be
  398.          aborted between files being copied.
  399.  
  400.      3.  Wildcards are allowed in both the source and destination file
  401.          specifications.   However,  they  must  appear  in  the  same
  402.          character position in both.  For example,
  403.  
  404.                      READ A:F?O*.* C:B?R*.*
  405.  
  406.          is valid, but
  407.  
  408.                      READ A:FO*.* C:BAR*.*
  409.  
  410.          is invalid.  The exception to this rule is the case where the
  411.          destination  file  name  or  extension is all wildcards.  For
  412.          example,
  413.  
  414.                      WRITE A:FO*.C B:*.C
  415.  
  416.          is valid.  Wildcards are  not  allowed  in  MS-DOS  directory
  417.          specifications.  For example,
  418.  
  419.                      READ A:sUB1*fOO.TXT E:MEMO.MEM
  420.  
  421.          is invalid.
  422.  
  423.      4.  MS-DOS file specifications which contain a file name  but  no
  424.          file  extension  (such  as FOO.  and FOO) are defaulted to an
  425.          all blank extension.  This is the convention used  by  MS-DOS
  426.          in the COPY command.
  427.  
  428.      5.  A 16KBytes buffer is used to transfer the data.
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451. MS-DOS File Exchange Utility (DOSFLX)                           Page 6
  452. Functional Specification                                     18 Jan 84
  453.  
  454.  
  455. 3.6  DIR Command
  456.  
  457. The DIR command gives a verbose directory listing of specified  MS-DOS
  458. files.   For  each  file, the file name, extension, size in bytes, and
  459. time and date of creation or last  modification  are  displayed.   The
  460. files are listed one per line.  The command line format is:
  461.  
  462.             DIR drv:[path][filnam.typ]
  463.  
  464. where 'drv' is the MS-DOS drive
  465.       'path' is an optional MS-DOS directory specification
  466.       'filnam.typ' is an optional MS-DOS file specification
  467.  
  468. Wildcards (* and ?) are allowed in the file specification but  not  in
  469. the  directory  specification.  If no file specification is given, all
  470. files in the specified directory are listed.
  471.  
  472. The path/file specification is interpreted as follows:
  473.  
  474.      1.  For a file specification with a null file name,  DOSFLX  uses
  475.          an  all  wildcard file name.  For example, DIR A:.EXT becomes
  476.          DIR A:*.EXT.
  477.  
  478.      2.  For a file specification with a '.' but no extension, such as
  479.          FOO., DOSFLX will
  480.  
  481.          1.  give a listing of the file FOO.  if such a  file  exists,
  482.              or
  483.          2.  give a listing of files in subdirectory FOO if it exists,
  484.              or
  485.          3.  if no file or subdirectory named FOO  exists,  will  give
  486.              file-not-found.
  487.  
  488.  
  489.      3.  For a file specification with no '.' and extension,  such  as
  490.          FOO, DOSFLX will
  491.  
  492.          1.  give a listing of files in subdirectory FOO if it exists,
  493.              or
  494.          2.  if no subdirectory named FOO exists, give  a  listing  of
  495.              files FOO.*.
  496.  
  497.  
  498. Hidden and system files are not listed.  A summary of  the  number  of
  499. files  listed  and  the  number of free bytes remaining on the disk is
  500. displayed.
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523. MS-DOS File Exchange Utility (DOSFLX)                           Page 7
  524. Functional Specification                                     18 Jan 84
  525.  
  526.  
  527. 3.7  DIR/W Command
  528.  
  529. The DIR/W command gives a terse directory listing of specified  MS-DOS
  530. files.   The  functionality  is  identical  to that of the DIR command
  531. except for the display.   For  each  file,  only  the  file  name  and
  532. extension are displayed.  The files are listed five per line.
  533.  
  534.  
  535.  
  536. 3.8  DEL command
  537.  
  538. The DEL command deletes specified files on an MS-DOS  formatted  disk.
  539. The command line format is:
  540.  
  541.             DEL drv:[path]filnam.typ
  542.  
  543. where 'drv' is the MS-DOS drive,
  544.       'path' is an optional MS-DOS directory specification,
  545.       'filnam.typ' is the MS-DOS file specification.
  546.  
  547. Wildcards (* and ?) are allowed in the file specification but  not  in
  548. the  directory  specification.   No implied wildcarding is done.  That
  549. is, deleting a file 'FOO' or 'FOO.' will delete the file  FOO  with  a
  550. blank extension.  Also, a null file name is invalid, such as '.EXT'.
  551.  
  552. Hidden, system, and read-only files cannot be deleted.
  553.  
  554. DOSFLX displays the file specification of each deleted  file  followed
  555. by a summary of the number of files deleted.
  556.  
  557.  
  558.  
  559. 3.9  TYPE command
  560.  
  561. The TYPE command types a specified file from an MS-DOS formatted disk.
  562. The command line format is:
  563.  
  564.             DEL drv:[path]filnam.typ
  565.  
  566. where 'drv' is the MS-DOS drive,
  567.       'path' is an optional MS-DOS directory specification,
  568.       'filnam.typ' is the MS-DOS file specification.
  569.  
  570. Wildcards (* and ?) are NOT allowed in the file  specification  or  in
  571. the directory specification.  Only one file at a time may be typed.
  572.  
  573. Hidden and system files cannot be typed.
  574.  
  575. The typeout can be aborted by pressing Ctrl-C twice.
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595. MS-DOS File Exchange Utility (DOSFLX)                           Page 8
  596. Functional Specification                                     18 Jan 84
  597.  
  598.  
  599. 3.10  EXIT Command
  600.  
  601. The EXIT command stops  the  program  and  returns  to  the  operating
  602. system.
  603.  
  604.  
  605.  
  606. 3.11  HELP Command
  607.  
  608. The HELP command allows the user to
  609.  
  610.      1.  Get general help about DOSLFX by typing HELP only, or
  611.  
  612.      2.  Get specific help about a command by typing HELP followed  by
  613.          the command keyword.
  614.  
  615.  
  616.  
  617.  
  618. 3.12  ?  Command
  619.  
  620. The ?  command allows the user to get a list of the command keywords.
  621. $