home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 2: PC / frozenfish_august_1995.bin / bbs / d08xx / d0807.lha / XTrash / English / XTrash.doc < prev    next >
Text File  |  1993-01-24  |  12KB  |  295 lines
  1.  
  2.  
  3.  
  4.         X   S E R I E S / P E E K E R B I T S
  5.         -------------------------------------
  6.         XTrash 1.01
  7.  
  8.         ⌐/Program 1992 SP/PeekerBits
  9.  
  10.         Author:
  11.         Stefan Pl÷chinger
  12.         Kleiststra▀e 27
  13.     DW- 8012 Ottobrunn
  14.  
  15.         programmed in KICKPascal (MAXON GmbH)
  16.         requiring AMIGA OS2.0
  17.         minimum of stack size: 10000
  18.  
  19.       ╖╖╖╖╖╖╖╖╖╖╖
  20.  
  21.         XTrash 1.01 is FreeWare. All rights prohibited. The program
  22.         may only be distributed for non-commercial purposes.
  23.  
  24.       ╖╖╖╖╖╖╖╖╖╖╖
  25.  
  26.  
  27.  
  28.   1 .   T H E   P U R P O S E   O F   X T R A S H
  29.  
  30.         Who doesn't know the NeXT's "Recycler" or the MacIntosh "Trashcan"?
  31.         You drag an icon over them - and you can say bye bye to that icon...
  32.         Well, on the AMIGA, there is also a trashcan. But, in contrast
  33.         to the other two examples, it's nothing else than a dir in which
  34.         all files dragged over are moved in. You may empty that trashcan,
  35.         but that's all.
  36.  
  37.         But that was not the trashcan I wanted. I wanted a trashcan to
  38.         really delete files and not only to move. And, why couldn't I drag
  39.         volume icons over the trashcan, which would start a formatting
  40.         program? Well, OK, you know what I want to say: XTrash was born.
  41.  
  42.  
  43.   2 .   C O N C E P T I O N
  44.  
  45.         Having started XTrash, an icon will appear on your workbench screen
  46.         or window. You may drag icons over it, which start the trashing
  47.         process, or you may double-click the icon.
  48.  
  49.         In the last case, a window appears. Here, you see the ⌐ informations
  50.         and the version and revision number of XTrash (can only be 1.01).
  51.         Besides, you may quit the program here or switch to the preferences
  52.         window. The window also has a menu which only offers the same possi-
  53.         bilities.
  54.  
  55.         Well, let's see what happens if dragging icons over the XTrash work-
  56.         bench icon. Then, the status window appears (see below). If the
  57.         trashing process is confirmed here, another window, the processing
  58.         window will be opened (but I have to say that this is only optional
  59.         and may be switched off in the preferences). Then, the things selec-
  60.         ted to trash will be trashed. "A propos": You may also drag an old
  61.         workbench trashcan icon over the XTrash icon. Then, you may delete
  62.         the trashcan :-) or empty it.
  63.  
  64.  
  65.   3 .   P A R A M E T E R S   T O   X T R A S H
  66.  
  67.         The parameters are read like this: When started from the CLI, XTrash
  68.         first checks the CLI arguments. Then, it tests whether there are
  69.         tool types in the XTrash program icon. When started from the work-
  70.         bench, only the last thing is done.
  71.  
  72.     3.1 CLI ARGUMENTS
  73.  
  74.         Template: "CONFIG"
  75.  
  76.         This is a standard Commodore template. The option means:
  77.  
  78.         "CONFIG": The path to the configuration file (may be "STD" for
  79.             "ENVARC:XTrash.Config").
  80.  
  81.     3.2 WORKBENCH ARGUMENTS
  82.  
  83.         There is only one possible tool type for XTrash:
  84.  
  85.         "CONFIG=": The following string is the path to the config file
  86.             (may be "STD" here, too).
  87.  
  88.  
  89.   4 .   T H E   S T A T U S   W I N D O W
  90.  
  91.         This window appears if you drag an icon over the XTrash Icon.
  92.  
  93.         In the field at the top, you see what is specified to trash. All
  94.         files, directories, trashes and volumes are listed numerically.
  95.         Under this field, you see certain buttons. They are discussed
  96.         later. At the bottom, you are able to cancel the operation. The
  97.         window is closed then, and no operation is specified. You may
  98.         also set the buttons above to standard values. These values may
  99.         be specified in the preferences window. Besides, the left gadget
  100.         "Trash..." starts the deleting or formatting process.
  101.  
  102.         Now let's discuss the buttons appearing under the field (oh yea!):
  103.         There may be the radio buttons "Delete Files" or "Move Files in
  104.         Trashcan" (only appearing if you dragged at least one file or dir).
  105.         If you select "Move files in Trashcan", all files are copied in
  106.         a dir specified in the prefs window before being deleted.
  107.  
  108.         "Empty Trashcan" and "Delete Trashcan" are two other radio buttons.
  109.         They only appear if at least one trashcan has been dragged over the
  110.         XTrash icon. You may specify if a trash is to be deleted or to be
  111.         emptied.
  112.  
  113.         "Fmt. Name" and "Options" refer on volumes. So, they only appear
  114.         if at least one volume icon has been dragged. In these text gadgets
  115.         you enter a name for the formatted volume or any formatting options.
  116.         See later for these gadgets.
  117.  
  118.  
  119.   5 .   P R O C E S S I N G   P A N E L
  120.  
  121.         This panel appears if a. the preferences are set right and b. if
  122.         trashing has been started. At the top, you see what XTrash currently
  123.         is doing. Below, the current trashing path is displayed. If the
  124.         directory "DH0:System" is deleted (better don't test...), it looks
  125.         like this:
  126.  
  127.           DH0:
  128.           System
  129.  
  130.         If XTrash has to delete a subdir of the dir to delete, for example
  131.         "DH0:System/Icons", the path list looks like this:
  132.  
  133.           DH0:
  134.           System
  135.           Icons
  136.  
  137.         The trashing process may be paused with "Pause" and be stopped with
  138.         "Stop".
  139.  
  140.         The processing panel may be closed. Then, XTrash trashes in the
  141.         background. You can enter the processing panel by double-clicking
  142.         the XTrash icon. Perhaps, all actions in the panel may not react in
  143.         real time. You may click "Pause", and nothing pauses. The reason:
  144.         XTrash doesn't delete, format or copy synchronous to the input con-
  145.         trol.
  146.  
  147.  
  148.   6 .   P R E F E R E N C E S
  149.  
  150.         You enter the Preferences by selecting the Menu item "Preferences"
  151.         in the Project menus or the corrosponding gadget in the window
  152.         appearing when double-clicking the XTrash icon..
  153.  
  154.         The first six gadgets look like the gadgets appearing in the
  155.         status window. The values currently set in that window may be
  156.         set here by pressing "Current Values", too. The values specified
  157.         here are set if pressing "Std. Values" in the status window.
  158.  
  159.         The other gadgets:
  160.  
  161.         "Program"/"Stack": Now, the most complex part of this story: XTrash
  162.             uses a seperate formatting program to format volumes. You can
  163.             specify the stack of this program, and the program's path and
  164.             parameters.
  165.  
  166.             The last is entered in the "Program" text gadget. By pressing
  167.             "Get...", a file requester appears. Then specify the formatting
  168.             program you'd like to use.
  169.  
  170.             The parameters are to be specified in the normal cli way, simply
  171.             by entering them just after the program's name. But there are
  172.             some problems:
  173.  
  174.             Where should XTrash place the volume's name? Where the options?
  175.             Where the volume's device? XTrash offers the possibility to
  176.             enter them by using placeholders. They are the following:
  177.  
  178.             "\d": the volume's device
  179.             "\n": the volume's name after having formatted the volume
  180.             "\o": the options string
  181.  
  182.             An example:
  183.  
  184.               "SYS:System/Format DRIVE \d NAME "\n" \o"
  185.  
  186.             starts the program "SYS:System/Format". Instead of "\d", the
  187.             device of the volume that has been dragged over the XTrash icon
  188.             is set. Let's say it was "DF0:". The "\n" is replaced by the
  189.             string entered in the status window's "Fmt. Name" text gadget.
  190.             The string in the "Options" text gadget in the status window
  191.             is put at the position of the "\o". Let's say that the "Fmt.
  192.             Name" string was "Empty", and that the "Options" string was
  193.             "QUICK NOICONS". The program would then be started like this:
  194.  
  195.               "SYS:System/Format DRIVE DF0: NAME "Empty" QUICK NOICONS"
  196.  
  197.             You may not enter the the "\n" or "\o" string. Then, the corros-
  198.             ponding text gadget in the status window doesn't appear.
  199.  
  200.             If you want to specify a "\n" in the program's name or somewhere
  201.             else, and it oughtn't to stand for the volume's name, simply
  202.             write "\\n". This means that you have to specify two "\" for
  203.             every "\" in the program gadget. "\\" would mean "\\\\" then.
  204.  
  205.         "Move-Trashcan": The directory in which files are to be moved in
  206.             move mode.
  207.  
  208.         "Icon File": A ".info" file for the XTrash icon outfit.
  209.  
  210.         "Name": A name for the XTrash icon.
  211.  
  212.         "X"/"Y": The position of the XTrash icon.
  213.  
  214.         "Textgadg. coloured": Specify if the XTrash text gadgets are to be
  215.             coloured when selected.
  216.  
  217.         "Processing panel": Specify if the process panel is to be opened
  218.             when trashing.
  219.  
  220.         "Save": Stores the settings and leaves the requester.
  221.  
  222.         "Use": Leaves the requester and uses the settings now specified.
  223.  
  224.         "Cancel": Leaves the requester and uses the settings that were
  225.             used before going into the Preferences requester.
  226.  
  227.         The XTrash Preferences window owns a menu in which you can switch
  228.         between the default XTrash Prefs, the last saved prefs and the
  229.         current prefs. It's built up like any Preferences "Edit" window.
  230.  
  231.  
  232.   7 .   B U G   R E P O R T
  233.  
  234.      í! Well, currently, I kno two bugs in XTrash. These are no real bugs
  235.         in XTrash, but of the AMIGA OS. The first one is normally rather
  236.         uninteresting, but has to be specified: XTrash has problems with
  237.         links. These links are a new advantage of the AMIGA OS 2. But never
  238.         drag the icon of a directory hich is only a link to another one over
  239.         the XTrash icon - XTrash will delete the original directory!
  240.  
  241.         The bug lies, as I found out, in the workbench communication system.
  242.         Dragging an linked dir icon over an application icon like the XTrash
  243.         icon will always cause a message referring to the icon which has
  244.         been linked. What is paradox, the whole thing works properly with
  245.         linked file icons!
  246.  
  247.         You may cope with the bug by using the "Delete..." menu item out of
  248.         the workbench "Icons" menu. Here, the deleting works properly be-
  249.         cause the workbench doesnt't have to send a message to itself.
  250.         XTrash receives a message that isn't built up correctly, the work-
  251.         bench only looks up in its variables.
  252.  
  253.         It may be (but it's unlikely) that the error is caused by the pro-
  254.         gram "WBLink" by Dave Schreiber which has been used for creating
  255.         the links. But: perhaps, links may cause another behaviour at your
  256.         personal AMIGA :-). Maybe, you have a newer OS (mine is 2.04) or
  257.         anything else. In this case, contact me under the address above!
  258.  
  259.      í! The second bug in XTrash is again a bug of the AMIGA OS. Try to
  260.         delete a file or dir iconless - and what happens on your workbench
  261.         screen? Nothing? Well, this is the problem. The workbench doesn't
  262.         recognize whether a file or dir is deleted or not. In contrast to
  263.         this, it reconizes if an icon is deleted! Well, don't wonder but use
  264.         the command "Update" out of your workbench "Window" menu and hope
  265.         that the OS bug will be fixed soon...
  266.  
  267.  
  268.       ╖╖╖╖╖╖╖╖╖╖╖
  269.  
  270.         Tata! Now, we present again:
  271.  
  272.         Thanks people out there in the world's non-german-speaking areas
  273.         that you have been able to read this doc to this char position!
  274.         Switch off and click the close gadget! It's over now! The nightmare
  275.         is over!,
  276.  
  277.         thanks to Langenscheidt for the English vocabulary...,
  278.  
  279.         thanks to the "KICKStart" and the "AMIGA Magazin". Without their
  280.         help, such a perfect and complete program, as wonderful and glorious
  281.         as it is, would never have been possible! :-)
  282.  
  283.  
  284.       ╖╖╖╖╖╖╖╖╖╖╖
  285.  
  286.         X T R A S H   P R O G R A M   H I S T O R Y :
  287.  
  288.         V1.0    First "Final Release", but I really did love it :-)
  289.  
  290.         V1.01   Exactly one bug removed: Now, you can change the workbench
  291.                 screen when XTrash is started.
  292.  
  293.  
  294.  
  295.