home *** CD-ROM | disk | FTP | other *** search
/ Enigma Amiga Life 113 / EnigmaAmiga113CD.iso / software / utilities / rawbinfo / rawbinfo.doc < prev    next >
Encoding:
Text File  |  2000-06-20  |  10.6 KB  |  295 lines
  1.                  RAWBInfo
  2.         © 1999/2000 by Stephan Rupprecht
  3.             All rights reserved.
  4.  
  5.  
  6. COPYRIGHT AND DISCLAIMER
  7.  RAWBInfo is copyrighted 1999-2000 by Stephan Rupprecht. 
  8.  All rights reserved. This program is freeware, so no financial
  9.  donations required. Redistribution allowed if the package is 
  10.  left unchanged. The author is not responsible for any damage 
  11.  caused by the use or misuse of this documentation and/or the 
  12.  program(s) it describes.
  13.  
  14.  
  15. REQUIREMENTS
  16.  Any Amiga® (compatible) computer with at least OS3.5 and
  17.  68020+ cpu.
  18.  gtdrag.library v3+ for drag'n'drop support from one RAWBInfo
  19.  window to another one (dev/gui/gtdrag#?.lha).
  20.  
  21.  
  22. DESCRIPTION
  23.  RAWBInfo is a replacement for the AmigaOS3.5 icon information.
  24.  Unlike the original one, this one uses ReAction for the user
  25.  interface.
  26.  
  27.  
  28. STARTING THE PROGRAM
  29.  The program can be started from shell as well as workbench. It
  30.  currently takes the following arguments:
  31.  
  32.  SDT=SHORTDATETIME/S,AC=ALLCONTROLS/S,WP=WINPOS/K,SBB=SIZEBBOTTOM/S,
  33.  DNI=DROPNEWICONSDATA/S,DP=DROPPLANARDATA/S,MV=MULTIVIEW/K,LOADPATH/K,
  34.  SAVEPATH/K,TOOLS/M,AGS=AUTOGETSIZE/S,DW=DESTWIDTH/N/K,DH=DESTHEIGHT/N/K,
  35.  CREATEICON/K
  36.  
  37.  SDT=SHORTDATETIME/S: this option tells RAWBInfo to use the
  38.   short date and time format of the current locale. Enabling it
  39.   makes the icon information windows a bit smaller.
  40.  
  41.  AC=ALLCONTROLS/S: no function as of 1.8.
  42.  
  43.  WP=WINPOS/K: place where the window should be opened. Possible keywords
  44.   are (default is TOPLEFT):
  45.   TOPLEFT: open the window in the left corner right under the titlebar.
  46.   CENTER: center the window on the screen.
  47.   MOUSE: open it relative to the mouse pointer.
  48.  
  49.  SIZEBBOTTOM/S: makes the bottom border of information windows as high
  50.   as the sizing gadget.
  51.   
  52.  DNI=DROPNEWICONSDATA/S: when an icon was originally saved in NewIcons
  53.   format, setting this option keeps icon.library from saving the
  54.   information back to the .info file.
  55.  
  56.  DP=DROPPLANARDATA/S: setting this option will keep icon.library from
  57.   storing any pre OS3.5 image data.
  58.  
  59.  MV=MULTIVIEW/K: the path were multiview can be found. Default: Sys/
  60.   Utilities/Multiview.
  61.   
  62.  IE=ICONEDIT/K: the path of IconEdit, defaults to Sys:Tools/IconEdit.
  63.  
  64.  LOADPATH/K: initial path of the "Icon Image/Load ..." filerequester
  65.   (see later).
  66.  
  67.  SAVEPATH/K: initial path of the "Icon Image/Save ..." filerequester
  68.   (see later).
  69.   
  70.  TOOLS/M: a list of default tools that are available when you click
  71.   on the dropdown chooser (that's the button on the _right_ side of
  72.   the default tool string gadget).
  73.   Example: TOOLS="MultiView" "Installer"
  74.   
  75.  CREATEICON/K: For objects that don't have an icon, rawbinfo automatically
  76.   saves one to disk. If you don't want this to happen or only optionally,
  77.   you can set this option to either NEVER or ASK.
  78.   
  79.  AGS=AUTOGETSIZE/S: setting this option causes RAWBInfo to automatically
  80.   start calculating the drawer size.
  81.   
  82.  DW=DESTWIDTH/N/K,DH=DESTHEIGHT/N/K: 
  83.   
  84.  Once the program has been started it can be removed by either 
  85.  sending CTRL-C to it, by the system tool Exchange or by starting
  86.  it a second time.
  87.  
  88.  
  89. USAGE
  90.  Well, if you know how to use the original icon information, you'll
  91.  know how to use this replacement ;) So, I will just mention the
  92.  extras here:
  93.  
  94.  ° dropping an icon on the window will open another icon information
  95.    window with information on the dropped icon.
  96.    
  97.  ° if you drop an icon on the tooltypes gadget, the program will replace
  98.    the current tooltypes with the one the dropped icon has.
  99.  
  100.  ° the default tool of a project can also be changed by drag&drop.
  101.  
  102.  ° double-clicking the icon will open the workbench object.
  103.  
  104.  ° you can dragNdrop icons from one rawbinfo window to another one
  105.    (requires gtdrag.library by Axel Dörfler, dev/gui/gtdrag#?.lha).
  106.    
  107.  ° starting 1.7 the following menu functions are available:
  108.    
  109.    Project
  110.    ============
  111.    Next        activate and bring to front the next rawbinfo window.
  112.    Previous    same as above but the previous one.
  113.    ------------
  114.    Version...    get the version of the file (requires c:version!).
  115.    ------------
  116.    Save        save the icon to disk.
  117.    Load default Replaces the current icon with the default one.
  118.    icon   
  119.    Save as     allows you to save the icon as default one to disk.
  120.    default icon 
  121.    ...
  122.    ------------
  123.    Delete icon    delete icon.
  124.    ------------
  125.    About    program copyright and version.
  126.    ------------    
  127.    Quit        guess what it does ;)
  128.    
  129.    Type        the Type menu allows you to change the icon type.
  130.    ============
  131.    Disk
  132.    Drawer
  133.    Project
  134.    Tool
  135.    Garbage
  136.    
  137.    Icon Image
  138.    ============
  139.    Default    get default image (supports DefIcons).
  140.    Copy        copies current icon image to the clipboard.
  141.    Paste    replaces current icon image with the one
  142.            stored in the clipboard.
  143.    Restore    restore original icon image.
  144.    ------------
  145.    Convert to    allows you to convert any old style icon
  146.    palette     to an os3.5 color icon.
  147.    mapped
  148.    Extras     -> Remap 1.3/2.0   
  149.             swaps the colors of any *4 color* old style icon.
  150.              this is useful for converting os1.3 icon colors to
  151.             os2.0 colors.
  152.              -> Pic2Icon
  153.                 when the file that belongs to the .info file is a
  154.                 picture, the icon images will be replaced by this
  155.                 picture.
  156.              -> Delete alternate image
  157.                   this one will delete the 2nd image from any color
  158.                   mapped icon (NewIcons, os3.5), icon.library creates
  159.                   a shadowed version of the normal image as a replace-
  160.                   ment. NOTE: there's a bug in icon.library that will
  161.                   produce garbage instead of a shadowed image. The
  162.                   icon will be correctly saved to disk.
  163.    ------------
  164.    Show clip ..    shows contents of the clipboad (see also
  165.            MULTIVIEW/K option).
  166.    IconEdit ... starts IconEdit.
  167.    ------------
  168.    Load ...    replace the current icon image with another one.
  169.    Save ...    allows you to save the current image to disk.
  170.    ------------
  171.    Frameless    make the icon frameless (works only for os3.5
  172.              coloricons, not for NewIcons!).
  173.    Drop     don't save NewIcons back in the NewIcons format.
  174.    NewIcons    
  175.    data
  176.    Drop planar    remove any old style image data from the icon.
  177.    data
  178.   
  179.    Tooltypes
  180.    ============
  181.    Clear    clear all tooltypes.
  182.    Sort        sort,
  183.    ------------
  184.    Disable all    disable,
  185.    Enable all    enable,
  186.    Toggle    toggle them ;)
  187.    ------------
  188.    Restore    restore original tooltypes.
  189.    
  190.  
  191. EXTRAS
  192.  The Installer script automatically installs an command called
  193.  WBInfo to your C: drawer. This command allows you to open an
  194.  icon information window from a shell. WBInfo takes the following
  195.  arguments: FILE=DRAWER=OBJECT/M/A,PUBSCREEN/K.
  196.  Where FILE,DRAWER or OBJECT is/are the object(s) to get information
  197.  on and PUBSCREEN the screen where the window should be opened
  198.  (defaults to Workbench).
  199.  
  200.  
  201. INSTALLATION
  202.  Simply use the supplied Installer script.
  203.  
  204.  
  205. SPECIAL THANKS GO TO
  206.  Thomas Richter for his help.
  207.  Nils Görs for the bug reports.
  208.  Roland Florac, Francis Labrie, Aleksandr, Alfredo Soro
  209.  Adam Chodorowski, Dámaso D. Estévez, Javier de las Rivas,
  210.  Llorenç Grau, Raul Silva, Joni Halme, Sinan Gürkan for
  211.  the catalogs. Also thanks to Raul for the icons.
  212.  
  213.  
  214. HISTORY
  215.  1.0    first public release for os35 betatesters.
  216.  1.1    various changes. supports localisation now.
  217.  1.2    added AC=ALLCONTROLS/S and SDT=SHORTDATETIME/S options.
  218.      fixed Enforcer hit on exit (FreeClass() stub instead
  219.      of inline was used). Thanks to Nils Goers for the bug 
  220.      report.
  221.  1.3    More than 127 tooltypes weren't supported (crashed badly).
  222.      Fixed. Thanks again to Nils Goers :)
  223.  1.4    included french catalog by R.Florac (Roland, there's something
  224.      wrong with your email account, I wasn't able to reply to your
  225.      message). some internal changes I can't remember ;) Changed the
  226.      way the icon gadget reacts to mouse clicks, now it behaves
  227.      like workbench icons (well, almost;).
  228.  1.5    Calculation of drawersize can be aborted at any time now. fixed
  229.      small bug in icon duplication function.
  230.  1.6    added CENTERED/S,SIZEBBOTTOM/S,TOOLS/M options.
  231.  1.7    released to my homepage. added a couple of new functions, the majority 
  232.      of them were adapted from SwazInfo (Icon Image menu/Tooltypes menu ...).
  233.      Added drag'n'drop support via gtdrag.library. misc house-keeping
  234.      changes. included russian catalog by Aleksandr <nikolya@bios.iuf.net>,
  235.      new french one by Francis Labrie and a spanish catalog by
  236.      Alfredo Soro.
  237.  1.8    swedish catalog by Adam Chodorowski. changed the user interface
  238.      a bit (still has to be improved) and added some more "SwazInfo
  239.      functions". ALLCONTROLS/S option is obsolete now, the layout code tries
  240.      its best to make the gui fit on the screen.
  241.  1.9    just a minor update, I am currently too lazy to add the requested 
  242.      features ;) added stackswapping code. now disables the "Type" menu
  243.      when calculting the drawer size. added a requester when changing
  244.      the icon type. new options IE=ICONEDIT/K and CI=CREATEICON/K.
  245.  1.10    fixed bug in menu handling code, "Icon Image / Copy" crashed
  246.      when cgx pictdt was used <Javier de las Rivas>.
  247.  1.11    fixed an english text <G.Donner>. replaced CENTERED/S with WINPOS/K.
  248.      new menu item "Project / Load default icon". fixed Installer script.
  249.  1.11a    fixed another english text (loose->lose;). Thanks again to G.Donner.
  250.  1.12    the get size gadget could report the wrong size for very big drives
  251.      and drawers (>4gb) <Stephen White>. now disables "Project / Load
  252.      default icon" while retrieving the size of a drive or drawer. new
  253.      option AGS=AUTOGETSIZE/S. note to the translators: new rawbinfo.cd!
  254.  1.13    added a new menu item to the "Project" menu to get the version of
  255.      a file. removed the space between the last word of a menu item and
  256.      the ellipsis (...) <G.Donner>. for drawers >2gb and <4gb, a negative
  257.      size was shown because of a wrong formating code (note to the 
  258.      translators: MSG_DRAWER_SIZE_FMT_NEW has changed) <Klaus B. Küsche>.
  259.      new menu item "Image / Extras / Remap 1.3/2.0" to remap os1.3
  260.      icon colors to os2.0 colors and vice versa <Klaus B. Küsche>.
  261.  1.14    the size gadget updates in real time, now. replacing the icon image(s)
  262.      by drag'n'drop could fail when the source icon didn't have 2nd
  263.      image <Arturo Franzin>.
  264.  1.15    saving an icon back to disk will now even work when the .info file
  265.      is protected from deletion <Arturo Franzin>. added "Icon Image /
  266.      Extras / Pic2Icon" and " ... / Delete alt. image" menu items.
  267.      the program can scale down images loaded via "Icon Image / Load ...",
  268.      now. when the name of the .info file exceeds the maximum length,
  269.      a (new) error requester will come up.
  270.  
  271.  
  272. TODO (in no special order)
  273.  - improve gui.
  274.  - arexx interface.
  275.  - implement rename function.
  276.  
  277.  
  278. AUTHOR
  279.  
  280.  Please send bug reports and ideas to:
  281.  
  282.     Stephan Rupprecht
  283.     Apfeldweg 1
  284.     D44359 Dortmund
  285.     Germany
  286.  
  287.  Send emails to
  288.  
  289.     stephan.rupprecht@gmx.de or
  290.     stephan.rupprecht@web.de
  291.     
  292.  WWW
  293.  
  294.      http://stephan.2xs.de
  295.