home *** CD-ROM | disk | FTP | other *** search
/ 8bitfiles.net/archives / archives.tar / archives / compuserve-file-archive / 11 Exotic Applications / SC072.ZIP / SC.DOC < prev    next >
Encoding:
Text File  |  1996-05-20  |  21.4 KB  |  500 lines
  1.  
  2.                     The Star Commander, Version 0.72 beta
  3.  
  4.                           written by Joe Forster/STA
  5.  
  6.  
  7.   This is still only a beta release of The Star Commander. Look out for further
  8. releases. Please, report bugs and ideas to me as I want to release Version  1.0
  9. as soon as possible. Sorry for all kinds of bugs that appear in  the  Commander
  10. but I'm in a hurry - as always.
  11.  
  12.  
  13.  
  14.   INTRODUCTION:
  15.  
  16.   This is a program similar to The Norton Commander  designed  to  copy  binary
  17. files and whole disks between the PC and a Commodore drive and  to  handle  the
  18. disk and tape images of the C64 Software Emulator (C64S, (C) by  Miha  Peternel
  19. and Seattle Lab, 1994-1995). If  you  know  The  Norton  Commander  well,  this
  20. program will surely be easy to use.  But  first  before  you  start  using  it,
  21. please, read this documentation and the online  help  carefully  for  features,
  22. differences from the other Commanders, the description of the  X1541  interface
  23. and other details.
  24.  
  25.  
  26.  
  27.   COPYRIGHT AND LEGAL ISSUES:
  28.  
  29.   The Commander is freeware which means you can copy and spread it as you  like
  30. provided that it is in the unmodified archive. You must not  distribute  single
  31. files only the whole package and no money can be charged above the  normal  fee
  32. of the distribution media. The Commander may not be included in any compilation
  33. or sold on disk or CD-ROM without my prior permission.
  34.  
  35.   The Commander is copyrighted software.  You  must  not  disassemble,  reverse
  36. engineer, hack the program and the related files or modify them in any way.
  37.  
  38.   The author is not liable for any damage or data loss caused by the  Commander
  39. (especially now, that the Commander is still under development).
  40.  
  41.  
  42.  
  43.   SYSTEM REQUIREMENTS:
  44.  
  45.   You must have an IBM or compatible PC with a 80286 processor or  higher  with
  46. MS-DOS 3.20 or above installed on it and about 500 KBytes of free  conventional
  47. memory. You may try running the Commander under the DOS emulator of OS/2  after
  48. enabling the HW_TIMER option in the DOS settings - it has been reported to work
  49. although I could not make it access an external Commodore drive.  I  have  also
  50. tried to run the Commander under the DOS  emulator  of  Linux  but  the  kernel
  51. steals too much time making the data transfer from and to the  Commodore  drive
  52. impossible. Remember that although the Commander may  run  under  multi-tasking
  53. systems it does not officially support them.
  54.  
  55.  
  56.  
  57.   INSTALLATION:
  58.  
  59.   You can install the  Commander  simply   by  uncompressing  the  distribution
  60. package into an empty directory using PKZIP 2.xx. You don't need all the  files
  61. to run the Commander - most of them are only for your comfort:
  62.  
  63. - for an absolute minimum installation you need SCMAIN.EXE (required)
  64.  
  65. - if you want to have much more memory in the DOS shell, keep SC.EXE and launch
  66.   that instead of main executable (recommended)
  67.  
  68. - you can find the online help in SC.HLP (recommended)
  69.  
  70. - SCSETUP.EXE to be able to set all the settings of the Commander (recommended)
  71.  
  72. - SCVIEW.EXE and SCEDIT.EXE allow you to view and edit DOS and Commodore  files
  73.   (recommended)
  74.  
  75. - there are some sample menu, submenu,  extension  and  palette  files:  *.MNU,
  76.   *.EXT (optional)
  77.  
  78. - the archive PALETTES.ZIP contains some predefined color palettes (optional)
  79.  
  80. - the archive SC_ARC.ZIP contains  the  following  external  archive  utilities
  81.   (optional):
  82.  
  83.   - Star List lists the contents of multiple disk and tape images into  a  text
  84.     file or onto the screen
  85.   - Star Lynx creates Lynx archives out of multiple DOS files or  the  contents
  86.     of a disk image, lists the contents Lynx archives and  extracts  them  into
  87.     multiple DOS files or into a disk image
  88.   - Star Tape collects multiple file images (files with the  extension  '.P00'/
  89.     '.S00'/'.U00' created and used by PC64) into tape images
  90.   - Star Zip creates  ZipCode  archives  out  of  disk  images,  tests  ZipCode
  91.     archives and extracts them into disk images
  92.  
  93.  
  94.  
  95.   ADVANTAGES OF THE COMMANDER:
  96.  
  97. - it is comfortable to use the well known environment of The Norton  Commander,
  98.   isn't it? You don't have to press a sequence of weird key combinations only a
  99.   familiar one and you can always clearly see what is happening on the screen
  100.  
  101. - I hope you  remember  Disk-Demon,  the  great  C64  disk  editor  written  by
  102.   G. Brandt and A. Wellie in 1986/87. A similar disk editor is built  into  the
  103.   Commander so that you can change the data of  disk  images  and  disks  in  a
  104.   connected Commodore drive directly
  105.  
  106. - many configuration options make the use of the Commander easy and comfortable
  107.  
  108. - the Commander can optionally display everything with the  C64  character  set
  109.   (only on EGA/VGA video cards)
  110.  
  111. - most of the image file handling routines are faster than those of  the  other
  112.   similar utilities
  113.  
  114. - here is a benchmark of the Commander using my original 1541C drive and a disk
  115.   containing a single 210 block file stored below track #18 with the normal  10
  116.   sector interleave (transfer modes equipped with  retry  on  disk  errors  are
  117.   marked with (*) ):
  118.  
  119.     ╔═════════════════════╤══════════════════════╤═══════════════════════╗
  120.     ║   Whole disk copy   │  Read from the 1541  │   Write to the 1541   ║
  121.     ╟─────────────────────┼──────────────────────┼───────────────────────╢
  122.     ║     Normal mode     │         7:50 (*)     │         9:55 (*)      ║
  123.     ╟─────────────────────┼──────────────────────┼───────────────────────╢
  124.     ║     Turbo mode      │         2:25 (*)     │         2:25 (*)      ║
  125.     ╟─────────────────────┼──────────────────────┼───────────────────────╢
  126.     ║     Warp mode       │         1:15 (*)     │         1:20 (*)      ║
  127.     ╠═════════════════════╪══════════════════════╪═══════════════════════╣
  128.     ║ 210 block file copy │  Read from the 1541  │   Write to the 1541   ║
  129.     ╟─────────────────────┼──────────────────────┼───────────────────────╢
  130.     ║     Normal mode     │         2:20         │         2:25          ║
  131.     ╟─────────────────────┼──────────────────────┼───────────────────────╢
  132.     ║     Turbo mode      │         1:00         │         1:00          ║
  133.     ╟─────────────────────┼──────────────────────┼───────────────────────╢
  134.     ║     Warp mode       │         0:25 (*)     │  not yet implemented  ║
  135.     ╚═════════════════════╧══════════════════════╧═══════════════════════╝
  136.  
  137.  
  138.  
  139.   CONNECTING A COMMODORE DRIVE TO YOUR PC:
  140.  
  141.   The connection is done using the well known X1541 interface. You can find the
  142. interface description in the online help.
  143.  
  144.   The Commander has a machine independent synchronization method that uses  the
  145. hardware system timers and therefore no automatic  calibration  is  inside  the
  146. Commander. If your PC has a 80386 or 80486 CPU, the default delay value  of  12
  147. will probably be fine and you will be able to  access  the  external  Commodore
  148. drive without adjusting it. However, a 80286 CPU might be too slow and you  may
  149. have to lower the delay value. Similarly, Pentium  users  should  raise  it.  I
  150. admit that it is a bit annoying but don't forget that you have  to  go  through
  151. this tiring procedure only once with every new release, if at all.
  152.  
  153.   The Commander is equipped with turbo transfer mode which means  it  transfers
  154. data from and to the connected Commodore drive about 2-3 times faster.  It  has
  155. turbo command routines, as well, which speed up deleting files  and  validating
  156. disks to 2-10 times the original speed (it depends on the number and length  of
  157. the files on the disk) and  disk  format  takes  only  about  12  seconds.  The
  158. Commander has another turbo, the warp transfer mode, which is about  5.5  times
  159. faster than the original speed.
  160.  
  161.   I had the opportunity to try the Commander with the 1571 drive of  a  friend.
  162. Although I haven't changed anything in the setup of  the  Commander,  it  could
  163. execute every 1541 function properly for the first try, even in  warp  transfer
  164. mode. However, native 1571 mode (double sided disks) is not supported. I looked
  165. into a 1581 ROM image, and it made clear to me that the  Commander  won't  work
  166. with it in turbo modes, if at all - it is not software compatible with the 1541
  167. drive. I would have to get a 1581 drive to implement the  appropriate  transfer
  168. routines.
  169.  
  170.  
  171.  
  172.   TROUBLESHOOTING:
  173.  
  174.   If you encounter problems in the part of the program that does not  access  a
  175. connected Commodore drive you  should  contact  me  at  once  with  a  detailed
  176. description of the bug. However, if you can't access  the  connected  Commodore
  177. drive properly here are some ideas for you to try first.
  178.  
  179.   First of all, bare boot your computer, disable  all  the  resident  programs,
  180. memory managers and device drivers  and  exit  multi-tasking  systems  such  as
  181. OS/2, Linux, Windows or Windows '95 since these circumstances  may  affect  the
  182. data transfer.
  183.  
  184.   You should also switch the Commander into normal transfer mode since this  is
  185. the most stable mode and it is not as sensible to the change of the delay value
  186. as the turbo modes are. Furthermore, don't plug anything other than  the  X1541
  187. interface into your PC and your Commodore drive. Connecting a printer  to  your
  188. PC or a C64/C128/other drives to your Commodore drive will probably mess up the
  189. data transfer or even lock up the connection. This means that  C128D  and  SX64
  190. owners can't use the Commander with the built-in drive of their computers.
  191.  
  192.   If the connection with the Commodore drive locks up then pull  the  interface
  193. out of the drive, wait for the "Device not present" error, plug  the  interface
  194. back, reset your drive and try the following:
  195.  
  196. - raise (or lower) the delay value
  197.  
  198. - make sure that the X1541 interface is  assembled  well  (try  it  with  other
  199.   machines and/or other transfer programs) and that it is not too long
  200.  
  201. - it is possible that your Commodore drive went dead in all those years  -  try
  202.   it with a C64 or C128 to see if it works at all or  borrow  a  working  drive
  203.   from your friends
  204.  
  205. - you might be the unlucky owner of an I/O card that  makes  fine  synchronized
  206.   bidirectional data transfer  via  the  LPT  printer  port  impossible  -  try
  207.   exchanging it with an I/O card of a friend or buy an older one
  208.  
  209. - as a last resort you can try switching the turbo button of your machine on or
  210.   off or disable/enable shadow RAM's - these changes might slow down  or  speed
  211.   up your machine so that data transfer then becomes possible on a too slow  or
  212.   a too fast computer
  213.  
  214.  
  215.  
  216.   BETA TESTING:
  217.  
  218.   As I do not have the possibility to test the program on many kinds of PC's  I
  219. ask you to be my beta tester and contact me if you
  220.  
  221. - found a bug in the program (you will possibly find some as it is still  under
  222.   development)
  223.  
  224. - have an idea what improvements I should make in the future
  225.  
  226. - saw a grammatical error, misspelling, wrong punctuation, wrong  justification
  227.   or something misunderstandable in the online help or this documentation
  228.  
  229. - know good FTP sites with C64 areas to which I should upload this program
  230.  
  231. - are just interested in this program or you simply like it and  want  to  have
  232.   the final version as soon as possible
  233.  
  234.   Please, E-Mail your detailed bug reports along with the version number of the
  235. Commander you use, the configuration of your PC (CPU type and  speed)  and  the
  236. configuration of the Commander when the  bug  occurred  (especially  the  delay
  237. value and the transfer mode if you used a connected Commodore  drive).  If  the
  238. bug occurred only with a certain file you can send it to me uuencoded, as well.
  239.  
  240.  
  241.  
  242.   BUGS FIXED SINCE VERSION 0.71 BETA:
  243.  
  244. - you were not prompted for overwrite  confirmation  when  copying  an  already
  245.   existing file from the PC to the connected Commodore drive
  246.  
  247. - empty files are now copied properly between panels of any mode
  248.  
  249. - saving the settings in the external setup while the Commander is resident  in
  250.   the memory does not create a corrupt setup file
  251.  
  252. - some mouse handling problems before and  after  executing  DOS  commands  and
  253.   calling standard viewers and editors have been fixed
  254.  
  255. - invalid track and sector numbers are not allowed in the disk editor
  256.  
  257. - if the functions ^[ and ^] would cause the command line to overflow  (locking
  258.   up the computer), you will not be allowed to use them
  259.  
  260.  
  261.  
  262.   OTHER CHANGES SINCE VERSION 0.71 BETA:
  263.  
  264. - introducing an internal viewer for DOS and Commodore files with  wrap/unwrap,
  265.   text/hex  display,  adjustable  end-of-line  mark,  text/hex  search,  ASCII/
  266.   PETSCII/screen  code  display  and  C64  character  set  -  this  program  is
  267.   physically external (SCVIEW.EXE) so that the memory required by the Commander
  268.   does not increase
  269.  
  270. - all the interactive external programs (currently the external setup  and  the
  271.   viewer) can be also shut down by pressing Control+Alt+Insert at any  time  in
  272.   case they lock up for some reason
  273.  
  274. - introducing a full color setup for all palettes (black & white, color, laptop
  275.   and monochrome) in the external setup  -  there  are  sample  palettes  files
  276.   included, too
  277.  
  278. - introducing a FAQ - frequently asked questions about  the  Commander  and  my
  279.   answers
  280.  
  281. - the Commander and all related programs abort with an error message if run  on
  282.   an XT
  283.  
  284. - on any error during finding a viewer or editor for the file you to be  viewed
  285.   or edited (extension file does not exist, there is no  appropriate  entry  in
  286.   the extension file or the standard viewer in that entry does not  exist)  the
  287.   Commander will try to load the standard viewer  SCVIEW.EXE  or  the  standard
  288.   editor SCEDIT.EXE - until the internal editor of the Commander  is  done  you
  289.   can rename your favorite editor to SCEDIT.EXE
  290.  
  291. - you can recursively delete non-empty directories
  292.  
  293. - the symbols '!', '!.!', '!:', '!\' and '!@' used in menu and extension  files
  294.   for the active panel have the equivalents of '%', '%.%', '%:', '%\' and  '%@'
  295.   for the inactive panel
  296.  
  297. - a new C64 character set was designed for and only for the 80x25 screen mode
  298.  
  299. - the Commander doesn't display "Invalid disk image" for disk images with error
  300.   info at their end, it just ignores the error info instead
  301.  
  302. - if a disk error occurs during warp file copy CBM->PC direction  then  instead
  303.   of aborting the copy the Commander will allow you to retry the bad block
  304.  
  305. - there is a new option called 'Copy full track 18' that allows you to BAM copy
  306.   disks that have unallocated but useful sectors in the  directory  -  in  this
  307.   case track #18 will be fully copied no matter what the BAM contains
  308.  
  309. - if you try to BAM copy a disk with an invalid BAM you are asked if  you  want
  310.   to copy the full disk
  311.  
  312. - the disk copy dialog box also contains the 'BAM disk  copy'  and  'Copy  full
  313.   track 18' options which default to the value set in the 'Advanced options...'
  314.   menu but you can override them temporarily for that particular disk  or  disk
  315.   image
  316.  
  317. - if a disk error is encountered during disk copy in either direction  you  can
  318.   skip the whole track, as well
  319.  
  320. - when finishing copying as disk form a connected Commodore drive to the PC  or
  321.   you abort the process, the Commander will only re-read the DOS panel
  322.  
  323. - pressing Escape will no more stop reading the directory in disk image panels,
  324.   only in external panels
  325.  
  326. - pressing F6 while the inactive panel is off or pressing  Control+F6  pops  up
  327.   the 'Rename or Move' dialog box in rename  mode  offering  you  the  original
  328.   filename instead of a destination path
  329.  
  330. - you can assign commands to F1 and F10 in the user menu - this  will  override
  331.   'Help' and 'Quit' on the function key bar
  332.  
  333. - there is a clipboard in the disk editor that allows you to copy  data  chunks
  334.   between sectors
  335.  
  336. - if you run the Commander through SC.EXE then you can enter a DOS command as a
  337.   parameter to be executed before the Commander starts
  338.  
  339. - you are not allowed to copy, rename or move deleted  files  (files  with  the
  340.   file type 'DEL') - you can only delete them
  341.  
  342. - the 'Mini status' option in the 'Options' menu changes the  mini  status  for
  343.   both panels
  344.  
  345. - the 'Clean' function deletes the garbage in the last block of files, as well
  346.  
  347. - the color attribute of characters in the shadow has been  changed  from  dark
  348.   gray on black to light gray on black
  349.  
  350.  
  351.  
  352.   KNOWN BUGS AND LIMITATIONS:
  353.  
  354. - you must not try to access a connected Commodore drive if the X1541 interface
  355.   is not plugged into the appropriate LPT port or all the  connected  Commodore
  356.   drives are switched off
  357.  
  358. - timeouts are not handled - as all PC interrupts are disabled while  accessing
  359.   the Commodore drive, errors during data transfer might lock up your PC
  360.  
  361. - you must not try to delete any file from a write protected  DOS  floppy  disk
  362.   otherwise you will get very strange results (possibly an internal BP7 bug)
  363.  
  364.  
  365.  
  366.   COMING SOON:
  367.  
  368.   I'm planning the following changes for the next version. Please, tell me if I
  369. should start working on the items marked with (?), as well.  However,  unmarked
  370. items are of higher priority than marked ones:
  371.  
  372. - bug fixes, of course...
  373.  
  374. - warp file copy in PC->CBM direction with error handling
  375.  
  376. - image handler in the viewer so that you can view files inside images
  377.  
  378. - an editor for DOS and Commodore files that (most of the program will be based
  379.   on the viewer so the viewer must be finished first)
  380.  
  381. - read and write support for file images  (files  with  the  extension  '.P00'/
  382.   '.S00'/'.U00' created and used by PC64)
  383.  
  384. - optional display of starting track and sector of files  in  disk  images  and
  385.   start address of files in tape images
  386.  
  387. - a much faster validate routine for external disks that does not track through
  388.   files one by one but first reads all sector chains on the disk and only  then
  389.   starts working on the BAM
  390.  
  391. - an external directory editor for disk images - for renaming, moving, deleting
  392.   and killing files, inserting phantom  files  and  separators,  built-in  disk
  393.   editor etc.
  394.  
  395. - support for 40 track disks and disk images (?)
  396.  
  397. - retry on disk errors during turbo file transfer CBM->PC direction (?)
  398.  
  399. - text and hexa search in the disk editor for files and disks (?)
  400.  
  401. - an external disk image checker program (?)
  402.  
  403.   There are many ideas that I will not put inside the Commander since  I  don't
  404. think that they are closely related to such a shell and copy program  like  the
  405. Commander but to a multi purpose utility instead. If you still insist on  these
  406. ideas, I may implement them, but only in external programs.
  407.  
  408.  
  409.  
  410.   THANKS TO:
  411.  
  412.   I would like to thank my alpha testers for their valuable help:
  413.  
  414.   Bacchus/FAIRLIGHT
  415.   Clarence/CHORUS
  416.   Darrin Smith
  417.   Edhellon/RESOURCE
  418.   Gustavo Ayala
  419.   Halász Csaba
  420.   Jürgen Bullinger
  421.   Lion/RESOURCE
  422.   Mathias Beilstein
  423.   Matthias Hartung
  424.   Michael J. Darschewski
  425.   Sorex/WOW
  426.   Suba Péter
  427.   Sven Goldt
  428.   Tamási György
  429.   Todd A. Aiken
  430.   Vic/COMA
  431.   Wojtek Wasilewski
  432.  
  433.   Special thanks go to:
  434.  
  435.   Bernhard Schwall              the author of Trans64
  436.   Borland International         for Turbo Pascal and Borland Pascal
  437.   Marko Mäkelä                  the author of ZipCode and unLynx for DOS
  438.   Miha Peternel                 for the C64 Software Emulator
  439.   Peter Norton                  for The Norton Commander
  440.   Peter Schepers                the author of 64COPY
  441.   Vsevolod V. Volkov            for The Volkov Commander
  442.   Wolfgang Lorenz               the author of PC64
  443.  
  444.  
  445.  
  446.   WHERE TO FIND THE COMMANDER:
  447.  
  448.   I always send the newest releases of the Commander to:
  449.  
  450.   arch.kiae.su                  /msdos/emulator/c64
  451.   bbs.cc.uniud.it               /pub/c64/tools/other_machines/pc
  452.   caramba.cs.tu-berlin.de       /pub/c64/tools/transfer/pc
  453.   ccnga.uwaterloo.ca            /pub/cbm/emulation
  454.   eris.giga.or.at               /pub/c64/transfer/1541-pc
  455.   frodo.hiof.no                 /pub/c64/utils
  456.   ftp.inf.bme.hu                /pub/cbm/c64/Tools/MSDOS
  457.   ftp.seattlelab.com            /UTILS
  458.   nic.funet.fi                  /pub/cbm/c64/emulation/c64s
  459.   utopia.hacktic.nl             /pub/c64/Tools/Convert
  460.  
  461.   Usenet NEWS                   comp.emulators.cbm
  462.  
  463.   Wildfire BBS, Hungary         (36)-1-156-3770 (22:30-07:00), SysOp: Dino
  464.   (FidoNet: 2:371/41)           USR Sportster 14.4, FREQ Magic Name: SC
  465.  
  466.   You can also E-Mail me at any time to ask for a uuencoded copy. Finger me  at
  467. the address "sta@ludens.elte.hu" to find out the version number of  the  newest
  468. release.
  469.  
  470.   I'm also maintaining a World Wide Web home page for the Commander at the  URL
  471. "http://ludens.elte.hu/~sta/sc.html" from which you  can  always  download  the
  472. latest public release and see some facts (bug  fixes,  new  options  and  other
  473. enhancements) about the internal alpha versions being developed and tested.
  474.  
  475.   If you want to have the newest versions of the Commander in the  future,  you
  476. can subscribe to a mailing list by sending an E-Mail to me. When a new  version
  477. is out, you will get it on the release day in a uuencoded E-Mail. If  you  have
  478. troubles with large  E-Mails  (about  300-400  KBytes),  please,  indicate  the
  479. maximum mail size your mail program can handle.
  480.  
  481.  
  482.  
  483.   THE AUTHOR:
  484.  
  485.   Please, do not hesitate and send an E-Mail  to  "sta@ludens.elte.hu"  if  you
  486. have any question, problem, idea or wish  concerning  the  Commander.  Use  the
  487. address "sta@dtalk.inf.elte.hu" for and only for sending E-Mails  that  contain
  488. large files. If you are living in Hungary you can call the number 285-3881  (in
  489. Budapest), too. You can also send snail mails to me at this address:
  490.  
  491.   Kovács Balázs
  492.  
  493.   Budapest, XX.,
  494.   Orsolya utca 5. IV/12.
  495.   1204, Hungary
  496.  
  497.  
  498.  
  499.   20th May, 1996                                Joe Forster/STA
  500.