******************************************************************************

				 TYCOON 1.06

			   Last updated 14/07/95.

******************************************************************************
NOTE: This file might not be updated to the latest state of the code

General Information:
--------------------

   The program adds nicely shaped icons a little bit like those of windows 
manager. You can launch programs by clicking on them. The layout of the icons 
is remembered and restored on the next run.
   One interesting thing about this utility - it does not depend on any window
manager. For example, if you are using olvwm or mwm but like to have feature 
like FvwmButtons (GoodStuff) of fvwm, this package can provide you with 
similar functionality.
   Ah, almost forgot - why we named this program tycoon ? Very simple -
tycoon is improvised abbreviation for Tool Icons :).
   The latest snapshot of the cuurent state of this program can always
be found at ftp://shani.net/pub/tmp. Please note that I do not keep exact
version control information at ftp://shani.net/pub/tmp, look at the DATE
of the file to figure out latest version, or use sunsite.unc.edu for
latest "released" version.

Installation:
-------------

   Untar the package like this:

> zcat tycoon-1.##.tar.gz | tar xvf - 
> cd tycoon-1.##

   If you have imake then do the following:
   
> xmkmf -a
> make

   Otherwise edit Makefile.noX to correspond your system and run

> make -f Makefile.noX
   

   Then you need to copy ini-file dot_tycoon to $HOME/.tycoon and edit it
to feet your needs. That's it. Try to run tycoon now:

> tycoon &

  It will read the configuration file and wait for your orders.


Configuration:
--------------

   Check out dot_tycoon file for the format - it's pretty obvious. But for 
those who got confused with it - check out the next section.


Ini-file format and command line arguments:
-------------------------------------------

Ini-file commands:
   Icon        
               Specifies an icon. The arguments are: X Y LABEL ICON CMDLINE
   Active      
               Same as Icon, but makes this item be active by default.
   Freezed     
               Means that all icons are freezed (can't be moved)

Command line arguments:
   -h       
               Show some help.
	       
   -rm   
               Remove current (selected) icon.
	       
  -kill
               Terminate tycoon.

  -raise/-lower
               Raise/lower all icons.

  -freeze/-unfreeze
               Freeze/Unfreeze all icons. (Freezed icons can be moved around)

  -add X Y LABEL ICON CMDLINE
               Add new icon at X,Y using LABEL as label, CMDLINE as command
               line to execute and ICON as .xpm file with icon picture.

  -edit X Y LABEL ICON CMDLINE
               Changes the attributes of the selected icon setting position
	       of X,Y using LABEL as label, CMDLINE as command
               line to execute, and ICON as .xpm file with icon picture.

  -align X Y ORIENTATION
               Align icons on desktop starting at X, Y. ORIENTATION can be
	       h (horizontal) or v (vertical).

For example:

> tycoon -add 12 140 smile.com /usr/include/X11/pixmap/smile.xpm xterm -ls
> tycoon -align 10 10 v

NOTE: 
   You can use "\n" to break the lines in the label strings. Do not edit the
file while running tycoon, it may cause confusion. In fact, try to avoid
editing it by hand, use tycoon command line instead.

Extra stuff:
----------------

   There is a very simple interactive utility for adding icons, found in the 
newicon/ directory, and properties editor, found in editicon/ directory.
Both programs are not necessary to run tycoon.  To compile those utilities
you need the latest version of XForms installed (You can get XForms at
bloch.phys.uwm.edu:/pub/xforms/).

   Best idea for using the command line options is to insert invocations
of tycoon into the window-manager menus. For example, if you use fvwm 1.2,
you can add the following to your .fvwmrc menu, bound, say, to the right
mouse button:
 
PopUp "TycoonMenu"
        Title   "Tycoon menu"
        Nop             
        Exec    "Add new icon"         exec newicon
        Exec    "Edit selected icon"   exec editicon
        Exec    "Lower icons"          exec tycoon -lower
        Exec    "Raise icons"          exec tycoon -raise
        Exec    "Unfreeze icons"       exec tycoon -unfreeze
        Exec    "Freeze icons"         exec tycoon -freeze
	Exec    "Remove selected icon" exec tycoon -rm
        Exec    "Shutdown tycoon"      exec tycoon -kill
        Exec    "Run tycoon"           exec tycoon
EndPopUp

Binding is done via:

Mouse 3         R       A       PopUp "TycoonMenu"    

Application defaults:
---------------------

   You will probably want to look at Tycoon.ad file if you want to set custom
colors for the icons and labels. After you make changes there, you can copy
it to your home (or to /usr/lib/X11/app-defaults) directory under the name
Tycoon, or insert the contents into your .Xdefaults. Also, app-defaults
file is *very* useful if you want to set minimal size of icons. 


Last words:
-----------
 The program is not very stable, few annoying bugs are hanging around waiting
for me to remove them, but I am still adding new features.
 I would like very much to see this program turned into fvwm module, but
will not do anything in this direction. Any volunteers?
 If you are going to use this program drop an e-mail to mitnits@shani.net. 
I'll be glad to hear your opinions and just to get your e-mail :).
 Don't send any e-mail to vels@spider.cs.biu.ac.il, he is not participating
in this project any more.


 Roman Mitnitski                                 Vladimir Lobak
 mitnits@shani.net                               vels@spider.cs.biu.ac.il      


