@database trashman.guide
@rem $VER: trashman.guide_English 1.0 (1.7.96)
@rem Language: english
@index INDEX

@node MAIN "Trashman Help"

              @{b}Trashman v1.0@{ub}
                    by
       Tomasz Muszynski (Thom/Union)

    @{" Copyrights     " link COPYRIGHTS}
    @{" Disclaimer     " link DISCLAIMER}
    @{" Introduction   " link INTRODUCTION}
    @{" Requirements   " link REQUIREMENTS}
    @{" Usage          " link USAGE}
    @{" History        " link HISTORY}
    @{" To do          " link TODO}
    @{" Author         " link AUTHOR}
    @{" Other products " link OTHERPRODUCTS}

=======================================================

                       ¶ ¶ ¶\\¶ ¶ /\\ ¶\\¶
                       |_| | | | \\/ | |
@endnode

@wordwrap

@node DISCLAIMER "Disclaimer"

@{b}Disclaimer@{ub}
@{b}==========@{ub}

TRASHMAN IS FREEWARE.  USE IT AT YOUR OWN RISK.  THERE IS NO WARRANTY FOR RELIABLE FUNCTIONING OF THIS PROGRAM.

@endnode

@node INTRODUCTION "Introduction"

@{b}Introduction@{ub}
@{b}============@{ub}

  AmigaOS has a very good feature - Trashcan. But it is not convenient if you use multiple partitions. Also you must use Workbench to manage files. I was looking for a better trashcan. I found few, but it was only making drop icon on Workbench and nothing more. Have you seen Trash on Mac? Or even trashcan in Windows 95? I was missing them so I wrote my own trashcan replacement.
  It has following features:

  - Deleted and replaced files are moved to trashcan (for all programs).

  - Remembers original location of deleted files.

  - Patches dos DeleteFile() function for increased functionality (now it can delete not empty directory).

  - You can use enchanced trashcan only on selected devices (eg. you can leave standard operating of floppy disks).

  - Automatic trashcan emptying if there is out of free space.

  - And many more...

  Trashman is very helpful when using together with DirectoryOpus5 by Jonathan Potter.

  Remember! This program patches original ROM functions: DeleteFile() and Open(), anyway you can disable this feature if you will experience any problems.

@endnode

@node USAGE "Usage"

@{b}Usage@{ub}
@{b}=====@{ub}

Place icon of trashman in WBStartup drawer. Double click on it's icon and set some @{"preferences" link WINDOWS}.
Now you will see drop trashcan icon. Here you can drop files to delete. You can double-click on it, then you will see empty window.

Program has some parameters in tooltypes and in command line:

  CX_PRIORITY=<number> - priority of commodities hotkeys (default: 0)
  CX_POPKEY=<hotkey> - key to pop up trashcan window (default: control t)
  FROM=<prefs file> - preferences file to load at startup (default: ENV:Trashman.prefs)
  FONTNAME=<font name> - font name used to show filenames (default: topaz.font)
  FONTSIZE=<font size> - font size used to show filenames (default: 8)

@{b}Notes@{ub}
@{b}=====@{ub}

  With trashcan handler running you can still use Workbench menu 'Icons/Empty trash', but it will only empty selected trashcan. To empty all trashcans you must use 'Empty Trash' item from 'Tools' menu. It's available if you select @{"App Menu" link WINDOWS} gadget in preferences window.
  Programs like DirectoryOpus when are deleting directory they do it recursive - scaning deleted directory for all files, but with trashman you can delete directories without emptying deleted directory. If you want to use this feature you can use standard Delete command from C: directory.
  To remember position of desktop icon, use trashcan window (I don't know how to read position of icon).

@{b}Bugs@{ub}
@{b}====@{ub}

  When you select Use or Save gadget in system preferences (eg: ScreenMode), it will request you 'ERROR: Can't open file ...', but all should work normally.

@endnode

@rem  Animations - Turns animations when deleting or moving files to trashcan (see Windows95)

@node WINDOWS "Windows"

@{b}Main window@{ub}
@{b}===========@{ub}

  This window is something like standard trashcan directory in Workbench, but it shows directory of all available trashcans. There you can select files and directories you want to remove physicialy from disk (you can recover these files only by using recovery tools like DiskSalv), or undelete to another directory or to original location before delete. Like drop window you can also drop files on this window.

  Project/
    Open... - Loads another preferences from disk.
    Save As... - Saves preferences on disk.
    Hide - Hides trashman windows and (if selected) tools menu and desktop window.
    Quit - Quits trashman.

  Window/
    Close - Same as Hide, but closes only main window.
    Update - Updates contents of main window.
    Salect Contents - Selects all files and dirs in main window.
    Snapshot/
      Desktop Icon - Remembers position of desktop icon (use for it Trashcan window).
      Main Window - Remebers position and size of main window.
      Trashcan Window - Remembers position of trashcan window.
    View by/
      Name - Sorts contents of window by name.
      Size - Sorts contents of window by size.
      Date - Sorts contents of window by creation date.
      Location - Sorts contents of window by original location of file.

  Files/
    Remove Selected - Removes selected files/dirs from trashcan (normal delete).
    Empty All Trashcans - Removes all files/dirs from all trashcans.
    Undelete to Original - Moves files from trashcan to original directory.
    Undelete to Other... - Moves files from trashcan to other directory.

  Settings/
    Edit... - Edit settings of trashcan.
    About... - Something about program.

@{b}Preferences@{ub}
@{b}===========@{ub}

  This is window for configuring trashcan. You should see some gadgets:

  Volumes - Devices which should use trashcan.
  Force Delete - Files which should be deleted instead of moving to trashcan (eg.: for temprorary files). You can use standard file matching pattern like '#?.tmp'.
  Overwrite - Ehat trashman should do if there already is file in trashcan with the same name. You can select:
    - Never - moves to trashcan adding 'copy_of_#?' prefix,
    - Always - replace file if exists,
    - Ask - asks user what to do,
    - Same location - replaces only if file is from the same location (eg.: if you are writing a document you will save file many times, so there is no need to keep all copies of this file).
  Min. free disk - Minimal free space on disk.
  Patch Delete - Replaces original Delete() function with my own (you must restart trashcan to turn it).
  Patch Open - Replaces original Open() function with my own (you must restart trashcan to turn it).
  App Window - Opens small window on workbench where you can drop files on it (double click opens main window).
  App Icon - Makes icon on workbench where you can drop files on it (double click opens main window).
  App Menu - Adds to Tools menu 'Empty Trash' option. 
  Ask before delete - When you want delete file from trashcan you will be prompted to confirm it.
  Hide closes all - When you select 'Hide' menu it will remove all windows, menus and icons (eg.: if you want to change screen resolution you must close all windows, Tools menus and drop icons, this function makes it for you)
  Delete if size 0 - If deleted file has size 0 there is no sense to keep it in trashcan.
  Save - Saves prefs in ENVARC:Trashman.prefs file.
  Use - Uses changed options without saving preferences.
  Cancel - Restores previous settings (without Volumes and Force Delete :-(.

@{b}Drop window@{ub}
@{b}===========@{ub}

  Drop files to delete on this window. Only available if AppWindow gadget is set. On this window you will see default trashcan image, if you want to change it, save new icon in 'ENV:Sys/def_Trashcan.info'.
  Using this window you can remember position of desktop icon.

@endnode

@node TODO "To do"

@{b}To do@{ub}
@{b}=====@{ub}

  This is first version of trashman, and I have many things to do. There is list of unimplemented features that should be done (in important order):

  - Double clicking on directory in main window should open new window with contents of this directory.
  - Special file with containing list of all files, original locations, name of program deleted by, and other important informations. This must be done because you lose file comment, and original location is limited to 80 chars (depends on file system).
  - When selecting volumes with trashcan there should be possibility to select directory, too (especially for another file systems, eg.: if you have mounted Macintosh partition, trashcan directory has 'Trash' name instead of 'Trashcan').
  - maybe ARexx.
  - if there will be ARexx, then main window should be used as a DirectoryOpus5 lister.
@endnode

@node HISTORY "History"

@{b}History@{ub}
@{b}=======@{ub}

7.7.96 - v1.0
  - initial release.

@endnode

@node AUTHOR "How to contact"

@{b}Author@{ub}
@{b}======@{ub}

This program was developed and tested on my Amiga 1200T/030/50MHz/8MB/4xCD Sony/1.2GB HD/Star SJ48 Printer.

If you have some ideas, bug reports, catalog translations or something other - write on my internet address:

e-mail: muszynsk@ipeneuro.ipe.pw.edu.pl
IRC: Nick Thom - on channel #amigapl (I am very seldom here and this is polish channel, in polish language)

@{b}Locale@{ub}
@{b}======@{ub}

If you want to translate Trashman to another language, please translate help and install files too. And send to me translated help and catalog translation file (trashman.ct instead of trashman.catalog).

@endnode

@node REQUIREMENTS "Requirements"

@{b}Requirements@{ub}
@{b}============@{ub}

  - OS3.0
  - reqtools.library (not included, you can find full package on AmiNet)
  - gadgets/progress.gadget (included in this package)

  Recommended configuration:

  - OS3.1 (notifications works better)

@endnode

@node COPYRIGHTS "Copyrights"

@{b}Copyrights@{ub}
@{b}==========@{ub}

Trashman is copyright by Tomasz Muszynski.
This program is @{b}FREEWARE@{ub} and can be freely distributed without restrictions.

ReqTools is Copyright (c) Nico François and Magnus Holmgren.
DirectoryOpus is Copyright (c) by Jonathan Potter.

Original archive should contain:

        catalogs/
                polski/
                        trashman.catalog
                trashman.cd
                trashman.ct
        gadgets/
                progress.gadget
        help/
                english/
                        Trashman.guide
                        Trashman.guide.info
                polski/
                        Trashman.guide
                        Trashman.guide.info
        Install-Trashman
        Install-Trashman.info
        Trashman
        Trashman.info

@endnode

@node OTHERPRODUCTS "Other products"

@{b}Other products@{ub}
@{b}==============@{ub}

 Available on AmiNet:

  - ClassPatch v1.0b - Replaces system gadget layout. You can select what GUI you like (Standard, XEN, Win95).
  - HDSleep v1.2 - Shutdowns your HD if it's not used for a given period of time.
  - Link v1.0 - Program to make file links (see MakeLink in C: directory). You can make hard and soft links.
  - Mod2Smp v1.0 - Creates sample from a ProTracker module. Has a very good sound mixing.

 Other (not available on AmiNet):

  - TPlayer v2.4 - Module player of ProTracker, OctaMed, Med, ScreamTracker III i FastTracker. It has many bugs, and it cannot be on AmiNet.
  - TDupe v1.3p - DiskCopy (Disk-disk, disk-file). Not developed for 2 years.

 In progress:

  - GadToolsBox v3.0 - Very powerful GUI generator for many languages. Has new useful gadgets, support for other gadgets (eg.: TextField.gadget), you can edit many windows at one time, locale, full OS 3.0 i 3.1 compatible, it's a completly new program, and many more... Based on GadToolsBox 2.0c by Jan van den Baard. Comming soon on AmiNet. (SHAREWARE)

@endnode

@node INDEX "Index"

@{b}Index@{ub}
@{b}=====@{ub}

@{"Author" link AUTHOR}

@{"Copyrights" link COPYRIGHTS}

@{"Disclaimer" link DISCLAIMER}

@{"History" link HISTORY}
@{"How To Contact" link AUTHOR}

@{"Introduction" link INTRODUCTION}

@{"Notes" link USAGE}

@{"Other Products" link OTHERPRODUCTS}

@{"Requirements" link REQUIREMENTS}

@{"To Do" link TODO}

@{"Usage" link USAGE}

@{"Windows" link WINDOWS}

@endnode
