
		WindowMaker X11 Window Manager


		    Alfredo K. Kojima 
		   <kojima@afterstep.org>
		   <kojima@inf.ufrgs.br>


Description
===========

WindowMaker is a window manager designed to emulate the look
and feel of part of the NEXTSTEP(tm) GUI. It's supposed to be fast,
relatively small, feature rich and easy to configure, with
a simple and elegant appearance borrowed from NEXTSTEP(tm).


Directories & Files
===================

INSTALL contains installation instructions.

BINDINGS contains the hardcoded keyboard and mouse bindings

CHANGES contains the changes since the last version

BUGS contains a list of the currently known bugs

FAQ is a list of frequently asked questions.

NEWS is a list of user visible changes since the last version

Documentation/ contains a formatted version of the documentation above.

wmlib/ contains the library necessary to write applications that
use WindowMaker specific features, like application defined menus.

test/ contains a simple test program that shows some of the things
that can be done with WindowMaker and wmlib

wrlib/ contains the library used to do image manipulation (loading,
dithering etc.) in WindowMaker. It can be used on other applications.

Configuration options and instructions can be found in the
Library/WindowMaker/ directory. This directory contains the 
preference files that each user must have in it's preference directory.

src/wconfig.h contains various compile time options you can change
to select some options/features and things like the path for
configuration directory.

build is a script for configuring and compiling WindowMaker in a easy way.

patches/ contains some patches that can be applied to applications so that
they interact better with WindowMaker.

INTERFACE contains information about the low level interface for
applications to communicate with WindowMaker.


Help
====

There is a mailing list for discussing WindowMaker. To subscribe to it,
send a message containing: 
	subscribe
to wmaker-request@eosys.com.


Notes
=====

Saved workspaces must be restored on startup, by placing
the ~/.workspace_state command in ~/.xinitrc or ~/.xsession

After setting the gradients from the menu, you must restart to make
the gradients appear.

Send bugreports (with the output of util/bughint (sysinfo.txt),
a detailed description of how to reproduce the bug, any
error messages and a copy of your ~/gnustep/Library/Windowmaker directory)
to kojima@inf.ufrgs.br

If you get an error message in a language different from English,
please reproduce the bug running wmaker in the C locale and send
me the message in English. I'm a computer scientist not a
linguist ;-).

Note: I reserve the right to ignore questions that are answered in the
docs (this file, INSTALL, FAQ, BINDINGS, Library/WindowMaker/menu and
Library/WindowMaker/preferences, util/README and patches/README).

The Dock:
=========
The dock is configurable both manually and interactively, but
only some apps may be Docked interactively. Apps that display an 
icon without a title (application icon) are generally dockable. 

Icons used for the Dock are the same used for the app icons.

To assign an icon to an app (or a miniwindow):

- right-dbl clicking on the app icon will print a string like this
to the terminal:
nxterm.NXTerm:
or
NXTerm:

If you get a message like "instance/class information not available" it 
means you can't assign an icon to it.

- Get this string and add it to ~/gnustep/Library/WindowMaker/app_options
as follows:
nxterm.NXTerm.icon:	MyTerminalIconPixmap.xpm

- Restart WindowMaker.

Instructions for using it are in the BINDINGS file.

For apps that can't be docked, use the "Dock application" command 
in the window menu or the dockapp script to dock it manually. 
Look at util/dockapp.

To make an docked app be launched on startup, dbl-click
the dock icon with the 3rd button. A dot should appear on the top
right corner.


Tips:
=====

Menus are dynamically loaded, so you can change the menu definitions
and see the results without restarting.

Use a solid background to see the new style resize geometry 
display (like #616179)

If you use focus-follows-mouse start getting used to click-to-focus,
because application menus only work properly with click-to-focus

Copyrights
==========
WindowMaker is copyrighted by Alfredo K. Kojima and is
licensed through the GNU General Public License. Read the 
LICENSE file.


NeXT, OpenStep and NEXTSTEP are a trademarks of NeXT Computer, Inc.

Some portions of this program were taken from fvwm, which
is Copyright (c) Robert Nation and others.



