source: trunk/third/xalf/README @ 15966

Revision 15966, 3.9 KB checked in by ghudson, 24 years ago (diff)
This commit was generated by cvs2svn to compensate for changes in r15965, which included commits to RCS files with non-trunk default branches.
Line 
1Xalf 0.7 (http://www.lysator.liu.se/~astrand/projects/xalf/)
2----------------------------------------------------------
3
4This a utility to provide feedback when starting X11 applications.
5
6Xalf is solving the same problem as Busycursor (also written by me),
7but in a more reliable and flexible way. The main differences are:
8
91) Xalf can reliable detect if newly mapped windows are belonging to a
10particular launched application. It does this by overloading the Xlib
11function XMapWindow with a version that signals the tracking xalf
12process.
13
142) Xalf provides (currently) four different types as "indicators",
15described below.
16
17Invisible Window:
18Xalf creates an invisible window, to be used in conjunction with a
19standard task pager like Gnomes tasklist_applet or the KDE
20Taskbar. The name of the window is the application name within
21parenthesis. The small window icon (KWM_WIN_ICON) is set to a small
22hourglass. This indicator is default.
23
24Splash screen:
25An generic splashscreen is displayed during application launch.
26
27Mouse cursor change:
28Xalf adds an hourglass symbol to the mousecursor for the root window
29and the Gnome panel. Note that the cursor is not changed for the Gnome
30foot-menu windows.
31
32Animated star:
33An animated indicator resembling the look of that on SGI/Irix
34machines (a kind of yellow star blinking while loading a program).
35
36
37INSTALL
38-------
39See the file INSTALL.
40
41
42GNOME INTEGRATION
43-----------------
44Gnome-libs 1.2.0 has built-in support for Xalf. It can be activated by
45setting the environment variable GNOME_USE_XALF before starting GNOME
46(eg. add: export GNOME_USE_XALF=1 to .bash_profile or other appropiate
47dotfile). This means that all applications will be started via Xalf.
48Note: The built-in hooks has some drawbacks: Xalf is always given the
49arguments --mappingmode and --invisiblewindow.
50
51I recommend using an updated version of Gnome-libs, which can be
52downloaded on the Xalf homepage. You should use version
53gnome-libs-1.2.1-0_helix_1xalf2.i386.rpm or newer. Starting with this
54version, GNOME_USE_XALF and GNOME_XALF_OPTIONS is obsolete and doesn't
55work anymore. Instead, Xalf behavior is controlled by the file
56/.gnome/xalf. Use control center to control it (see below). With this
57modified version, you can prepend NO_XALF to desktop entries
58commandlines to disable Xalf for a specific application. This is
59especially useful for launching applications that doesn't start new
60processes but only creates new windows. Gmc works like this, so I
61recommend change "Exec=gmc" in /usr/share/gnome/apps/Gmc.desktop to
62"Exec=NO_XALF gmc".
63
64
65GNOME CONTROL CENTER CAPPLET
66----------------------------
67From version 0.4, an GNOME Control Center capplet is included. It
68requires an updated version of gnome-libs
69(gnome-libs-1.2.1-0_helix_1xalf2.i386.rpm or newer).
70
71
72KDE INTEGRATION
73---------------
74KDE has borrowed some Xalf techniques, and integrated them into
75KDE2. I don't know the current status of this work, though.
76
77
78USAGE
79-----
80If you are not using GNOME with built-in hooks, prepend xalf to your
81commandlines. For example, create an desktop icon running:
82 xalf netscape
83
84
85COMMANDLINE OPTIONS
86-------------------
87   -h, --help               display this help and exit
88   -v, --version            output version information and exit
89   -t, --timeout nseconds   use a time-out period of nseconds seconds
90   -n, --noxalf             do nothing, besides launch application
91   -m, --mappingmode        compatibility mode: Do not distinguish between
92                            windows. All new mapped windows turns off indicator
93   -i, --invisiblewindow    use an invisible window as indicator (default)
94                            (for use with Gnome panel, KDE taskbar etc)
95   -s, --splash             use splashscreen as indicator
96   -c, --cursor             add hourglass to mouse cursor
97   -a, --anim               use animated star as indicator
98   -l, --title titlestring  Title to show in the tasklist
99
100Comments and bug-reports are appreciated.
101
102/Peter Åstrand <astrand@lysator.liu.se>
103
104
105
Note: See TracBrowser for help on using the repository browser.