home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 166.lha / ClickDos / Dos.doc < prev    next >
Encoding:
Text File  |  1988-04-28  |  23.4 KB  |  586 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~        
  10.                   ClickDOS V2.04  -   by Gary Scott Yates
  11.  
  12.           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  13.  
  14.           This Manual is for version 2.04 of ClickDOS.  It  is suggested to
  15.           all users  of V2.04,  even those who have used previous versions,
  16.           to reread the manual entirely,  to  be  fully  aware  of  all the
  17.           enhancements and changes in ClickDOS v2.04. 
  18.  
  19.           ClickDOS is  my entry into the ever growing numbers of "directory
  20.           utility" programs.  I  wrote  ClickDOS  primarily  because  of my
  21.           frustrations  with  other  directory  utility programs.  Here are
  22.           some of the things which I think make ClickDOS better:
  23.  
  24.           - ClickDOS is reasonably small  (for what  it does):  32K on disk
  25.           40K in memory.
  26.  
  27.           - It uses  a single  window on  the Workbench screen which can be
  28.           iconified.  So it doesn't gobble up your chip memory
  29.  
  30.           - It does not rely on  other  programs  for  it's  Type  and Show
  31.           functions.  These function are built in.
  32.  
  33.           - ClickDOS's  data  structures  are  dynamically allocated and it
  34.           uses Fast  memory for  everything it  can.   Therefore, it's very
  35.           memory efficient.
  36.  
  37.           - ClickDOS's gadget controls are very logical and easy to use.
  38.  
  39.           FIRST A FEW FORMALITIES:
  40.  
  41.           ClickDOS IS  NOT PUBLIC DOMAIN!  However, it may be redistributed
  42.           freely provided:
  43.  
  44.           - the entire  contents of  the original  distribution disk always
  45.           accompany it
  46.  
  47.           - the  program  and  all  files on the original distribution disk
  48.           remain unaltered in any way
  49.  
  50.           - No  part  of  this  disk  may  be  included  on  a commercially
  51.           distributed  disk  (including  disk  magazines)  without  written
  52.           permission of the author: Gary S. Yates.
  53.  
  54.           ClickDOS and associated files  MAY be  distributed on  any public
  55.           domain  compilation  series  disk  in which a REASONABLE (no nore
  56.           than $10) distribution fee is charged.
  57.  
  58.           DONATIONS:
  59.  
  60.                If you find ClickDOS useful, the  author would  appriciate a
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.           donation of  $15.  Your donation will place you on a mailing list
  73.           to receive updates to  ClickDOS  FREE!    You  will  also receive
  74.           notification of other useful programs as they become available!
  75.  
  76.           SEND DONATIONS TO:
  77.  
  78.                Gary Yates
  79.                422 Nth 6th Apt9
  80.                Lafayette, IN.  47901
  81.  
  82.  
  83.           USING ClickDOS:
  84.  
  85.           ClickDOS can be started from either WorkBench or CLI.
  86.  
  87.             Form CLI type:
  88.  
  89.                dos [dir1] [dir2] [-i]
  90.  
  91.                where dir1  and dir2  are directories you want DOS to put in
  92.           the directory areas as soon as it starts.  These are optional and
  93.           are simply a convenience. The -i option will be explained below.
  94.  
  95.             Form WorkBench:
  96.  
  97.               simply double click on the ClickDOS icon.
  98.  
  99.           THE CLICK DOS WINDOW:
  100.  
  101.           At this  point, it  would help  a great  deal if you can view the
  102.           picture called ClickFigure  which  should  have  accompanied your
  103.           copy of  ClickDOS.   This picture shows a shrunken version of the
  104.           DOS window, with labels pointing out the different areas.    
  105.  
  106.               The main parts  of  the  ClickDOS  window  are  the directory
  107.           areas.    This  is  where  ClickDOS  shows  you  the files in the
  108.           currently selected directory and where  you  pick  the  files you
  109.           want to  effect with an action gadget, much like other dir utils.
  110.           You  can  scroll  the  file  names  in  these   areas  using  the
  111.           proportional gagets to the sides of the directory areas.
  112.               Near the  bottom of  the ClickDOS window is a space where DOS
  113.           will print all of it's messages to you.  WATCH THIS AREA!
  114.               At the very bottom of the  window DOS  will continuously show
  115.           you how much memory is available in the system, as CHIP and FAST.
  116.           This display is also a gadget.  If you click on this  gadget, DOS
  117.           will display  how much free space is on the DISKS associated with
  118.           each of the directory areas.
  119.  
  120.           SELECTING FILES:
  121.  
  122.                To select  files to  be affected  by actions  you can simply
  123.           click on  the file name.  You can click on the file name again to
  124.           deselect that file,  or  click  on  the  Unselect  All  gadget to
  125.           deselect  all  of  the  files  in  a directory area.  There is an
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.           Unselect All gadget for each directory area.
  138.                As you  select files,  DOS keeps  a running  total of "bytes
  139.           selected" for  each directory  area.   It will display this every
  140.           time you select a file.    This  is  handy  for  determining, for
  141.           example, if  all the  files you selected will fit on the disk you
  142.           want to copy them to.   Unfortunately,  AmigaDOS  has  no  way of
  143.           determining how  large a  directory of files is, short of reading
  144.           the entire directory, which, as everyone knows is SLOW!   So, the
  145.           size  of  selected  directories  are not taken into account, only
  146.           files.
  147.                You can select a group of filenames by  clicking and holding
  148.           the  left  mouse  button  then  dragging the pointer over several
  149.           names.  Then, when you release  the button  all of  the names you
  150.           dragged  over  will  be  selected  (or  unselected, if previously
  151.           selected).  At this time, the directory area  WILL NOT  scroll if
  152.           you drag  past the  last visible name. So the most you can select
  153.           in this way is the visible area of  names (14),  but it  is still
  154.           better than click, click, click, click....
  155.                After DOS  has compeleted  an action  you requested with any
  156.           action gadget, it will automatically deselect  all files  in BOTH
  157.           directory areas.  If you want to do a second action on these same
  158.           files you can click the Select  All gadget  and it  will reselect
  159.           them  for  you!    PROVIDED  the action did not cause ClickDOS to
  160.           reread the  directory in  that area.  Clicking on  the Select All
  161.           gadget  a  second  time  will  select  ALL  of  the  files in the
  162.           appropriate directory area.
  163.  
  164.           INPORTANT NOTE: You will not be able to see selected  files which
  165.           are scrolled  out of  the directory area.  BEWARE OF THIS!  It is
  166.           easy to forget about  these files  and inadvertantly  affect them
  167.           with an  action.   ClickDOS helps out with this by deselected all
  168.           files after each action is complete.
  169.  
  170.           WAYS OF GETTING INTO A DIRECTORY:
  171.  
  172.                There are several  ways  you  can  get  ClickDOS  to  read a
  173.           directory into  one of  its directory areas.  The most comman way
  174.           is to simply click on one of the volume gadgets.  This will cause
  175.           DOS to  read the  root directory of that device.  Note that there
  176.           is a set of volume  gadgets  for  each  dir  area.  The following
  177.           devices are currently the defaults:
  178.  
  179.           RAM:  VD0:  DF0:  DF1:  DF2:  DH0:
  180.  
  181.                When ever  ClickDOS reads a directory, it sorts the contents
  182.           of the dir alphabetically, files seperate  from directories.   It
  183.           places all directory names at the top of the list, then the files
  184.           names.  Directory names are shown in the hilight color (orange in
  185.           the default  Workbench colors)  and file  names in the text color
  186.           (white in the default Workbench colors).  However, all the colors
  187.           ClickDOS uses depend on your current preferences settings.
  188.  
  189.                Once  you  have  read  the  contents of a dir, you can enter
  190.           other directories by clicking on  the  name  of  a  directory and
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.           either, clicking on the Child gadget, or clicking the RIGHT mouse
  203.           button (menu button) anywhere over the same directory  area.  The
  204.           DoubleClick was avoided here because of conflict with clicking on
  205.           a file name a second time to deselect it.
  206.                The final way of getting a  directory is  to type  any legal
  207.           path name  into the Current Directory Display string gadget which
  208.           is over each directory area.  ClickDOS will always show  the name
  209.           of the  current directory in this gadget.  You can force ClickDOS
  210.           to reread  the current  directory from  disk by  clicking in this
  211.           gadget, then  pressing return  without typing  anything.  You may
  212.           want to do this for example if you do something at the  CLI which
  213.           changes the  contents of  the directory.  ClickDOS can not detect
  214.           such a thing and  you  would  have  to  force  it  to  reread the
  215.           directory to see the changes.
  216.                To get  out of a directory, back to its parent, click on the
  217.           Parent gadget.
  218.  
  219.           WHAT CLICK DOS CAN DO FOR YOU:
  220.  
  221.           Here are the  actions  which  DOS  supports.  (left  to  right by
  222.           gadget)
  223.  
  224.           MAKEDIR - 
  225.           This is  used to  create a  new directory in one of the directory
  226.           areas.  When you  click on  this gadget  ClickDOS will  present a
  227.           requester asking  you for the name of the new directory.  Type in
  228.           the name and press return.  After you  have entered  the name you
  229.           need to click on one of the three other gadgets in the requester.
  230.           Click on the LEFT gadget if you want DOS to  create the directory
  231.           in the left directory area (i.e. in the directory associated with
  232.           that area).  Click on the RIGHT gadget if you want DOS  to create
  233.           the  directory  in  the  right  directory area.  Or, click on the
  234.           CANCEL gadget if you changed your mind.
  235.  
  236.           RENAME -
  237.           Rename will let you change the name of one or more files. To
  238.           use this option, select the files  to rename  then click  on this
  239.           gadget.   ClickDOS will  ask you  for a  new name for each of the
  240.           files you  selected.   Type a  new name  or select  CANCEL if you
  241.           changed your mind.
  242.                So that  you will know which file you are renaming, DOS will
  243.           fill the requester gadget with the  old name  of the  file.  This
  244.           also allows  you to  edit the  old name, making renaming quicker.
  245.           If you are completely  changing the  name, a  quick Right Amiga-X
  246.           will zap the old name out of the requester.
  247.                Rename will  let you  rename across  directories on the same
  248.           disk.
  249.  
  250.           COPY-
  251.           ClickDOS always copies the  files you  have selected  in the left
  252.           directory area  to the  right directory  area.  And the files you
  253.           have selected in the right directory  area to  the left directory
  254.           area.  Thus you don't have to worry about which is the source and
  255.           which is the destination.  In fact DOS will do  both of  these at
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.           the same  time.   So you  can swap  files in one operation if you
  268.           select files in both  dir areas  at the  same time  then click on
  269.           copy.   Although, at first you may find this somewhat confussing,
  270.           after you use ClickDOS a couple of times,  I think  you will find
  271.           it to be quite logical.
  272.                As a note, ClickDOS copies the files in the left area to the
  273.           right first,  and then  the files  in the  right dir  area to the
  274.           left.
  275.                A very  powerful feature  of the  copy option is that it can
  276.           copy an entire directory!  If you click  on a  directory and then
  277.           click  COPY,  DOS  will  create this directory on the destination
  278.           disk and then copy ever file  AND  DIRECTORY  and  every  file in
  279.           every   nested   directory   in   the  source  directory  to  the
  280.           destination(phew!).
  281.                For example: you could copy  an  entire  directory  of fonts
  282.           with only  two clicks.  A click on the directory name and a click
  283.           on copy!  Try it, I think you will like it!
  284.  
  285.           NOTE: if an error  occurs while  DOS is  copying a  file DOS WILL
  286.           remove the damaged destination file.  However, if you are copying
  287.           a directory, the files which had  already been  copied before the
  288.           error occured  will not  be removed from the destination.  So you
  289.           will need to look  at the  destination disk  and see  which files
  290.           made it and which ones didn't.
  291.  
  292.                If you are trying to copy a file to the same directory it is
  293.           already in (by having the same directory in both directory areas)
  294.           ClickDOS will ask you for a new name for the copy of the file.  
  295.  
  296.           MOVE-
  297.           The Move option works almost identical to Copy with one important
  298.           difference: Move DELETES the SOURCE files or directory when it is
  299.           finished copying them.
  300.                When Move is used  to transfer  files from  one directory to
  301.           another on  the same disk it does so by Renaming the files rather
  302.           than  actually  making  new  copies.  This  is  faster  and  more
  303.           efficient on disk space.
  304.  
  305.           DELETE-
  306.           Delete  will  permenantly  erase  every file you have selected in
  307.           BOTH dir areas.  Watch for those files which are  scrolled out of
  308.           the dir area which you forgot you selected!!
  309.                Delete  will  also  delete  and  ENTIRE  directory and every
  310.           single thing which is in it!!  BE WARNED! This is a very powerful
  311.           but potentially  VERY DANGEROUS  feature.  You should be sure you
  312.           truely  want  to  delete   EVERYTHING   in   the   directory  you
  313.           selected!!!!  ClickDOS will NOT ask for confirmation!!
  314.  
  315.           NEWCLI-
  316.           This gadget  will bring  up a NewCLI window for you to use.  This
  317.           is a  true CLI  window and  will hang  around until  you give the
  318.           EndCLI command.
  319.  
  320.           SHOW-
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.           This option  will show  any IFF ILBM picture or brush.  To show a
  333.           picture select the picture's  file  name  and  then  this option.
  334.           Show will display the picture for about 5 secs then return to the
  335.           ClickDOS window.  You can do  a slide  show viewing  by selecting
  336.           several pictures.   They  will be  shown one  at a time.  Between
  337.           each picture you will see ClickDOS flip back to its window.  This
  338.           occurs for two reasons.  One, so ClickDOS  can tell  you the name
  339.           of the  next picture  in the message bar.  Two, this way only one
  340.           screen has to be allocated in  memory at  any given  time, so the
  341.           show is  more memory  efficient.  Please keep in mind this option
  342.           was intended to give you a way to review your files for deletion,
  343.           copying, etc. not as a true slide show program.
  344.                If you  wish to  view a picture for longer than 5 secs press
  345.           the ESC key or the Right Mouse Button.   This  will turn  off the
  346.           timing.   To turn  the timing  back on  press ESC  or Right Mouse
  347.           Button again. Timing is also turned back on each time  you select
  348.           the SHOW option.
  349.                To jump  to the  next picture before the 5 secs has eplapsed
  350.           press the LEFT Mouse  Button.  To  jump  out  of  the  slide show
  351.           completely (i.e. return to DOS) press q (for Quit).
  352.                As mentioned  above Show  can display  brushes.  It can also
  353.           display overly large bit maps BUT only as much of  the upper left
  354.           hand corner as will fit on the screen.
  355.                Finally, Show is a very simply IFF reader.  It will NOT find
  356.           ILBM hunks which are inside  of  other  hunks,  for  example ANIM
  357.           hunks. Show DOES support HAM.
  358.  
  359.           TYPE -
  360.           This  option  lets  you  view  any  text  or binary file in ascci
  361.           format.  It does no formatting of its own (i.e. no word  wrap)  I
  362.           did not empliment this because so many README files and DOS files
  363.           (the most common use of type) are preformatted  these days.   And
  364.           DOS trying  to reformat  the already formatted files just makes a
  365.           mess!
  366.                Type will show you several files one after the other  if you
  367.           select multiple files.
  368.                You can scroll both forward and backward in a file using the
  369.           Type option.
  370.                Type opens a seperate window to show you  the file.   In the
  371.           title bar  of this window are the commands for scrolling thru the
  372.           text.  In addition to the commands listed in the  scroll bar, you
  373.           can use the LEFT mouse button to scroll forward a page (note this
  374.           has change since version 2.00)  and  the  RIGHT  mouse  button to
  375.           scroll back  approx. one  screen.  I say approx. because ClickDOS
  376.           does not actually scan the file to back  up one  page exactly, it
  377.           does a  logical guess.   ClickDOS will tell you how many bytes it
  378.           went backward in the file.
  379.                Type also allows you to  send  the  output  to  the printer.
  380.           When you  select Type  ClickDOS will  ask you  where you want the
  381.           output to go, printer or screen.
  382.                When you select printer ClickDOS will look in  the directory
  383.           specified in its .dosrc file (more on .dosrc below) for a program
  384.           called spool.  Spool is a  printer spooling  program which should
  385.           have accompanied  ClickDOS.  If ClickDOS finds spool then it will
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.           start the program and turn the printing over to it.   If ClickDOS
  398.           does not  find Spool, it will print the file by copying it to the
  399.           PRT: device.  Using the spool program is much better  than having
  400.           ClickDOS do  the printing  itself, because  if ClickDOS has to do
  401.           the printing it locks up  until  it  is  done,  Spool  runs  as a
  402.           background  process.    See  the documentation for Spool for more
  403.           information.
  404.                As the default, ClickDOS will look for Spool  in C:.   C: is
  405.           usually assigned to the C directory of the Workbench disk.
  406.  
  407.           WARNING:   Spool and ClickDOS communicate directly using Messages
  408.           and Message Ports, DO NOT try  to substitute  a different spooler
  409.           program by renaming it Spool!
  410.  
  411.           THE ICONIFY GADGET:
  412.  
  413.                You  will  notice  (perhaps  with some reservation) that the
  414.           ClickDOS window does not have a size gadget.   This  is true, you
  415.           can not size the window.  There is however a NEW system gadget in
  416.           the title bar of  the window,  beside the  front back  gadget (it
  417.           looks like  a backward  size gadget).   This gadget, when clicked
  418.           on, will shrink the DOS window down to a tiny  size and  place it
  419.           in the  title bar  of the Workbench screen, much like many of the
  420.           clock  programs available.   Clicking  on this  gadget again will
  421.           return the window to its normal size.  This is called iconifying.
  422.           Note  that  if  you  do  not  like the iconified window where DOS
  423.           places it, you can move it to a new location and from then on DOS
  424.           will  place  it  there.    Also,  you can specify absolute screen
  425.           coordinates for  the  iconified  window,  in  DOS's  startup file
  426.           (.dosrc), see below.
  427.                Finally, if  you would  like DOS to start out iconified, you
  428.           can place the -i option in  its argument  list when  you start it
  429.           from cli.
  430.  
  431.           Example:  dos -i
  432.  
  433.           This is handy if you use ClickDOS a great deal, and would like to
  434.           have it activated by your startup-sequence.  FYI,  ClickDOS takes
  435.           up about  40K when  it is sitting iconified.  It only takes 1K of
  436.           chip memory when it is iconified if you have expansion memory.
  437.                The iconified window  continuously  shows  the  current free
  438.           chip and fast memory.
  439.  
  440.           THE .DOSRC FILE
  441.  
  442.           When ClickDOS  begins it  will try  to read a file called .dosrc.
  443.           It will look for this file  in the  S directory  of the Workbench
  444.           disk that  booted the  machine, by looking for: S:.dosrc.  (Note:
  445.           versions earlier than 2.04 looked for .dosrc in the T directory)
  446.                This startup file contains three things.  First, it lets you
  447.           tell  ClickDOS  which  volumes  you  want  in the volume gadgets.
  448.           Second,  it  lets  you  position  the  iconified  ClickDOS window
  449.           anywhere on  the Workbench  screen you  like.  And Third, it lets
  450.           you specify in which directory ClickDOS  will look  for the Spool
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.           program.
  463.  
  464.           The format of this file is:
  465.  
  466.           volumes string
  467.           x position of iconified window
  468.           y position of iconified window
  469.           directory to search for Spool
  470.  
  471.           Example:
  472.  
  473.           RAM:VD0:DF0:DF1:DF2:DH0:
  474.           200
  475.           50
  476.           C:
  477.  
  478.           The volume  string MUST  be exactly 24 characters long!  And, the
  479.           volume names MUST be exactly 4 characters with the last one being
  480.           a colon!   If  you have a volume with less than 4 characters then
  481.           pad the name on the LEFT with spaces.
  482.  
  483.           Example:
  484.  
  485.           RAM:VD0:DF0:DF1: DH:DF3:
  486.  
  487.           The position of the iconified  window  is  in  screen coordinates
  488.           which specify where to place the upper left corner of the window.
  489.           Legal values are:
  490.  
  491.           x position: 0-300
  492.           y position: 0-190
  493.  
  494.           The default values are: 250 0 (in the title bar beside the front-
  495.           back gadget)
  496.  
  497.           Included with  ClickDOS should be a sample .dosrc file.  The best
  498.           way to make a new one is to edit this file.
  499.  
  500.           The search directory for  Spool can  be any  legal AmigaDOS path.
  501.           HOWEVER!!! ClickDOS only allocates 29 bytes for the entire path!!
  502.           Therefore the directory specified must be 29 characters or less!!
  503.           ClickDOS allocates  such a  small space because I greatly suspect
  504.           that most people will put Spool in their  C directory  so all you
  505.           have to put is: C:.
  506.  
  507.           ClickDOS IS A BIT DETACHED:
  508.  
  509.           Whether ClickDOS  is started  from CLI or from WorkBench, it will
  510.           always run as a completely seperate task.  If you  start ClickDOS
  511.           from a  CLI, ClickDOS  will immediately  detach itself (thanks to
  512.           the wonders of Aztec 3.6a).  So ClickDOS  will never  take over a
  513.           CLI as  most programs  do.   And you will NEVER have to start DOS
  514.           using the RUN command.
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.           MISC
  528.  
  529.           -- Helpful Hint #1: For people without expansion RAM.  Reading in
  530.           a  directory  with  a  large  number  of files can take up a fair
  531.           amount of memory.   Use  the  Parent  Gadget  to  empty  out both
  532.           directory areas  before iconifing  ClickDOS for  a long period of
  533.           time.  Otherwise, this  is  perfectly  good  memory  just sitting
  534.           there.     Remember,  ClickDOS   allocates  its  data  structures
  535.           dynamically.
  536.  
  537.           -- Helpful Hint #2: FaccII by  ASDG  makes  ClickDOS  run  like a
  538.           dream!  I highly recommend it! 
  539.  
  540.  
  541.           OK FINE, BUT HOW DO I GET OUT OF THIS THING:
  542.  
  543.           Click the close gadget!
  544.  
  545.  
  546.           KNOW BUGS
  547.  
  548.           None known at this time!
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.