%%
%% Window Maker User's Guide
%%
%% Copyright (c) 1997, 1998 Alfredo K. Kojima
%%
%% Date:	WM Version:	Author:
%% 1997         0.10.0          Alfredo
%% 1998-7-6	0.17.0		Alfredo
%% 1998-8-1	0.18.0		Alfredo
%% 1998-9-1	0.19.0		Alfredo
%% 1998-9-7	0.19.2		Alfredo
%% 1998-10-15	0.20.2		Alfredo
%%
% I'm still learning LaTeX, so there are lots'o stuff that must be
% either fixed or improved.


\documentclass[10pt,oneside,onecolumn]{book}
\usepackage{fontenc}
\usepackage{graphics}
\usepackage[dvips]{epsfig}

% keystrokes
\newcommand{\kstr}[1]{\texttt{#1}}


\pagestyle{headings}

\topmargin 0pt
\textheight 8.5in

\oddsidemargin 1.5cm
\evensidemargin \oddsidemargin
\marginparwidth 0.5in
\textwidth 5.7in


\begin{document}



\title{\Huge \textsc{Window Maker}\\
        \large \textsc{X Window Manager}\\
        \vspace{20mm}
        \includegraphics[totalheight=15mm]{logo.eps} \\
        \vspace{5cm}
        \LARGE User's Guide
        \vspace{5cm}
        } 

\author{%
        Alfredo K. Kojima
        }
\date{Version 0.20.2}

\maketitle



\newpage

\chapter{Introduction}

This manual describes the usage and configuration of the Window Maker
window manager. It is intended for both users who never used the X Window 
System and for those who have experience with other window managers. 

\paragraph{How to Read this guide\\}

If you never have used a X window manager, you should read all this
guide, as it contains detailed instructions for newbies.

Text in \textsf{sans serif} font, indicate instructions you must
follow to accomplish a given task. If you're out of time (or patience),
you should at least read text in these parts.

You can ignore the text in \textsf{Extra Bindings} boxes while you're
getting familiar with Window Maker. Once you've got familiar with
it, you can read the text in these boxes to learn more ways to accomplish 
tasks.

Some of the actions described here can be performed by keyboard shortcuts,
but are only described in the section about configuration options.


\section{What is a window manager?}
If you come from the Windows\textregistered or MacOS\texttrademark world, 
you might be confused about all these things like window managers, X windows 
etc.

In the \textsc{Unix}\texttrademark world, the task of providing a 
graphical user interface (GUI) is normally divided by 3 different components: 

\begin{itemize}

\item the window server; 

\item the window manager and

\item the application itself, normally by using a user interface toolkit.

\end{itemize}

The \bfseries window server \mdseries is standard and is usually
the \em X Window System \em or some vendor provided compatible version
of it. The X Window System, or X for short, is a window server. It's
function is to provide a portable and high-level access to devices
like keyboard, mouse and video display. It allows applications to
show graphical information on the display through rectangular areas
called windows. 

Most user interface objects, like buttons, menus and scrollers are
made of windows. The top level windows displayed by applications are
named windows as well. These objects are not provided by the window
server. These must be made by the application program or by the user
interface toolkit.

For more information, read the manual page for \texttt{X(1)} and
the documentation for Xlib.

The primary function of the \bfseries window manager \mdseries is
to control the layout of top level windows on screen. Window Maker
is a window manager. It provides a titlebar and a resizebar to change
window layout, application menus to launch applications and execute
special commands, application icons, miniwindows and an application
dock. They will be explained in more detail in the following chapters.

The \bfseries user interface toolkit \mdseries is a library
or collection of libraries that provide an API for application developers
to program the interfaces for their applications. Toolkits generally
provide controls like buttons, menus, radio-buttons etc to be used
for program interaction. There is currently many of these toolkits
available for X. Motif\texttrademark, OpenLook\texttrademark, and Athena 
are examples of toolkits.

All other features normally found in other operating systems, like
file managers, are implemented as separate programs
and are not directly related to the window manager.



\chapter{Windows}

\section{Anatomy of a Window}

Generally an application window will have the following layout: 

\begin{figure}[h]
\epsfig{file=anatomy.ps}
\end{figure}

\begin{description}

\item [Titlebar.]The titlebar presents the name of the application, document
or window. It's color indicates the keyboard focus state and type
of the window. You can use it to move, activate, raise, lower and
access the window commands menu.

\item [Miniaturize button.] You can click on the miniaturize button to 
miniaturize/iconify a window or click it with the \kstr{Control} key pressed
to hide the application.

\item [Close button.] The close button can be used to close a window or kill
the application by clicking it with the \kstr{Control} key pressed.

\item [Resizebar.] You use the resizebar to (surprise!) resize a window.

\item [Client Area.] The client area is where the application show it's
information. If the window is inactive, you can click on it to activate it.

\end{description}


\newpage

\section{Working with Windows}


\subsection{Focusing a Window}
\label{secfocus}

Windows can be in two states: \em focused\em , or \em unfocused. \em The
focused window (also called the key or active window) has a 
titlebar with a differentiated color and is the window that receives
the keystrokes you type in the keyboard.
Usually it's the window where you work on. Only
one window may be focused at a time. Unfocused windows have a light
gray titlebar.

Applications may have a special type of window, called dialog windows,
transient windows or panels. When these windows are focused, the window
that owns them (the main window) get a dark gray titlebar. As soon
as the dialog window is closed, the focus is returned to the owner
window. \ref{figfocus} shows an active Open File panel and it's owner window.


\vspace{0.50cm}
\begin{figure}[h]
\epsfig{file=focus.ps}
\label{figfocus}
\end{figure}
\vspace{0.50cm}

There are three styles of window focusing: 

\begin{description}

\item [Click-to-Focus,]or manual focus mode. In click-to-focus mode, you
explicitly choose the window that should be focused. This is the default
mode.

\item [Focus-Follow-Mouse,]or auto-focus mode. In this mode, the focused
window is chosen based on the position of the mouse pointer. The window
below the mouse pointer is always the focused window.

\item [Sloppy-Focus] mode. This is similar to the focus-follow-mouse
mode, but if you move the pointer from a window to the root window,
the window will not loose focus.

\end{description}


You can choose between these modes with the \texttt{FocusMode} option.

\begin{quote}
\sffamily
\vspace{0.5cm}
 \bfseries To focus a window in click-to-focus mode: \mdseries

\begin{itemize}

\item Click on the titlebar, resizebar or in the client area
of the window with the left or right mouse button. 

OR

\item Click on the titlebar with the middle mouse button. This
will focus the window without bringing it to the front. 

OR

\item Open the window list menu and select the window to focus.
 
\vspace{0.5cm}

\end{itemize}
\rmfamily
\end{quote}

When you click in the client area of an inactive window to set the
focus, the click is normally processed by the application. If you
find this behaviour a little confusing, you can make the application
ignore this click by using the \texttt{IgnoreFocusClick} option.

\begin{quote}
\sffamily
\vspace{0.5cm}
 \bfseries To focus a window in focus-follow-mouse
mode: \mdseries

\begin{itemize}

\item Move the pointer over the window you want to focus. 
\vspace{0.5cm}

\end{itemize}
\rmfamily
\end{quote}

\newpage

\subsection{Reordering Overlapping Windows}

Windows can overlap other windows, making some windows be over or
in front of others. 

\begin{quote}
\sffamily
\vspace{0.5cm}
\bfseries To bring a window to the front: \mdseries

\begin{itemize}

\item Click on the titlebar or resizebar of the desired window
with the left mouse button.

OR

\item  Select the desired window from the Window List menu.

\end{itemize}

\vspace{0.5cm}

\rmfamily
\end{quote}


Dialog/transient windows are always placed over their owner windows,
unless the \texttt{OnTopTransients} option is disabled. Some windows have
a special attribute that allow them be permanently over normal windows.
You can make specific windows have this attribute use the 
\texttt{KeepOnTop} window option or set it in the Attributes Panel. 

\vspace{1cm}
\sffamily
\textbf{Extra Bindings}

{\centering \begin{tabular}{p{5cm} p{5cm}}
\textbf{Action}&
\textbf{Effect}\\
\hline
Hold the \kstr{Meta} key and click on the window titlebar with the left
mouse button& Sends the window to the back of all other windows.\\
\hline
Hold the \kstr{Meta} key and click on the Client Area of the window with the
left mouse button& Brings the window to the front and focuses it.\\
\hline
Hold the \kstr{Meta} key and press the Up Arrow key&
Brings the current focused window to the front.\\
\hline 
Hold the \kstr{Meta} key and press the Down Arrow key&
Sends the current focused window to the back. \\
\hline 
\end{tabular}\par}
\rmfamily
\vspace{0.50cm}

\newpage

\subsection{Moving a Window}
To move the window around the screen, drag the window through it's titlebar
with the left mouse button pressed. This will also bring the window to the
front and focus the window.

\begin{quote}
\sffamily
\vspace{0.5cm}
\bfseries To move a window: \mdseries

\begin{itemize}

\item Click on the titlebar of the window you want to move with the left
mouse button and drag it with the button pressed.

\end{itemize}

\vspace{0.5cm}

\rmfamily
\end{quote}

While you move the window, a little box will appear in the screen,
indicating the current window position in pixels, relative to the top left 
corner of the screen. You can change the location of this position box by
hitting the \kstr{Shift} key during the move operation.


In some rare occasions, it is possible for a window to be placed off screen.
This can happen with some buggy applications. To bring a window back to the 
visible screen area, select the window in the Window List menu. You can
prevent windows from doing that with the dontmoveoff\_at window attribute.

\vspace{1cm}
\sffamily
\textbf{Extra Bindings}

{\centering \begin{tabular}{p{5cm} p{5cm}}
\textbf{Action}&
\textbf{Effect}\\
\hline 
Drag the titlebar with the middle mouse button&
Move the window without changing it's stacking order.\\
\hline 
Drag the titlebar while holding the \kstr{Control} key&
Move the window without focusing it.\\
\hline
Drag the client area or resizebar while holding the \kstr{Meta} key&
Move the window.\\
\hline 
\end{tabular}\par}
\rmfamily
\vspace{0.50cm}

\newpage

\subsection{Resizing a Window}

The size of a window can be adjusted by dragging the resizebar.

\vspace{0.50cm}
\begin{figure}[h]
\epsfig{file=resizebar.ps}
\end{figure}
\vspace{0.50cm}

Depending on the place you click to drag the resizebar, the resize operation 
is constrained to a direction.


\begin{quote}
\sffamily
\vspace{0.5cm}
\bfseries To resize a window: \mdseries

\begin{itemize}

\item To change the window's height, click in the middle region of the 
resizebar and drag it vertically.

\item To change the window's width, click in either end regions of the 
resizebar and drag it horizontally or drag it with the \kstr{Shift} key
pressed.

\item To change both height and width at the same time, click in either
end regions of the resizebar and drag it diagonally.

\end{itemize}

\vspace{0.5cm}

\rmfamily
\end{quote}


While you resize the window, a little box will appear in the screen,
indicating the current window size. You can change the location of
this size box or change it into a different format by hitting the 
\kstr{Shift} key during the resize operation.

If a window gets too big to fit on the screen and you loose
access to it's titlebar or resizebar, you can move
the window through the client are, holding the \kstr{Meta} key
and then resize it.


\vspace{1cm}
\sffamily
\textbf{Extra Bindings}

{\centering \begin{tabular}{p{5cm} p{5cm}}
\textbf{Action}&
\textbf{Effect}\\
\hline
Drag the window in the client area with the Right mouse button
while holding the \kstr{Meta} key&
Resizes the window.\\
\hline
Drag the resizebar with the middle mouse button&
Resize the window without bringing it to the front\\
\hline 
Drag the resizebar while holding the \kstr{Control} key&
Resize the window without focusing it.\\
\hline 
\end{tabular}\par}
\rmfamily
\vspace{0.50cm}

\newpage

\subsection{Miniaturizing a Window}

If you want to temporarily get rid of a window, you can miniaturize it.
When miniaturizing a window, it will shrink into a miniwindow with a
icon and a title that is placed at the bottom of the screen. 

\vspace{0.50cm}
\begin{figure}[h]
\epsfig{file=title.ps}
\end{figure}

\begin{figure}[h]
\epsfig{file=mini.ps}
\caption{Miniwindow}
\end{figure}
\vspace{0.50cm}

You can move the miniwindow around the screen by dragging it.
Unlike application icons, miniwindows cannot be docked.

To restore a window from it's miniwindow, double click the miniwindow.
The window will be restored in the current workspace, with the same
position, size and contents as it had before miniaturization.


\begin{quote}
\sffamily
\vspace{0.5cm}
\bfseries To miniaturize a window: \mdseries

\begin{itemize}

\item Click on the miniaturize button.

OR

\item Hit the shortcut assigned to this action, which is
\kstr{Meta}+\kstr{M} in the default configuration.

\end{itemize}

\vspace{0.5cm}

\bfseries To restore a miniaturized window: \mdseries

\begin{itemize}

\item Double click in the miniwindow.

\end{itemize}

\vspace{0.5cm}

\rmfamily
\end{quote}

You can also restore all miniaturized and hidden windows of an
application at once by double clicking in it's application icon with the 
middle mouse button.
  

\newpage
\subsection{Shading a Window}

If you want to temporarily get rid of a window, an option for it's
miniaturization is to \em shade \em it. When you shade a window, the
window rolls up to it's titlebar. You can do almost everything you do
with a normal window with shaded windows, like miniaturizing or
closing it. 

\vspace{0.50cm}
\begin{figure}
\epsfig{file=shade.ps}
\end{figure}
\vspace{0.50cm}

\begin{quote}
\sffamily
\vspace{0.5cm}
\bfseries To shade a window: \mdseries

\begin{itemize}

\item Double Click on the titlebar of the window.

\end{itemize}
\end{quote}
\vspace{0.5cm}



\newpage
\subsection{Closing a Window}

After finishing work in a window, you can close it to completely get 
rid of it. When you close a window, it is removed from the screen
and can no longer be restored. So, before closing a window, be sure
you have saved any work you were doing on it.

\vspace{0.50cm}
\begin{figure}
\epsfig{file=title2.ps}
\end{figure}
\vspace{0.50cm}

Some windows will have a different close button. These windows can't be
closed normally and the only ways to get rid of them is by exiting or
killing the application. You should try exiting from inside the application
(through it's menus or buttons) whenever possible. Otherwise you can force
Window Maker to ``kill'' the application.

\begin{quote}
\sffamily
\vspace{0.5cm}
\bfseries To force the closure of a window (by killing the application):\mdseries

\begin{itemize}

\item Hold the \kstr{Control} key and click in the close button.

OR

\item Double click the close button.

\end{itemize}

\vspace{0.5cm}
\rmfamily
\end{quote}

It is also possible to kill applications that can be normally closed
by clicking the close button while holding the \kstr{Control} key. 

\vspace{0.50cm}
\begin{figure}
\epsfig{file=title3.ps}
\end{figure}
\vspace{0.50cm}


\newpage
\subsection{Maximizing a Window}

If you want to resize a window to occupy the whole screen, you can
maximize the window. When you unmaximize it, the window will be
restored to the same position and size it was before maximized.

\begin{quote}
\sffamily
\vspace{0.5cm}
\bfseries To maximize a window:\mdseries

\begin{itemize}

\item Hold the \kstr{Control} key and double click on the window titlebar
to resize the window's height to full screen.

\item Hold the \kstr{Shift} key and double click on the window titlebar
to resize the window's width to full screen.

\item Hold both the \kstr{Control} and \kstr{Shift} keys and double 
click on the window titlebar to resize both window's height and width 
to full screen.

\end{itemize}

\vspace{0.5cm}
\bfseries To restore the size of a maximized window:\mdseries

\begin{itemize}

\item Hold the \kstr{Control} OR \kstr{Shift} key and double click on 
the window titlebar.

\end{itemize}

\vspace{0.5cm}
\rmfamily
\end{quote}


You can select whether the window should be maximized to the whole
screen or if the position of the Dock and icons should be accounted for
with the \texttt{NoWindowOverIcons} option and by making the dock
float over normal windows (by enabling the ``Keep Dock On Top'' option
in the dock menu).

\newpage
\subsection{The Window Commands Menu}

Clicking on the titlebar of a window with the right mouse button will open a
menu containing commands that will apply to that window. The menu can also
be opened through the keyboard with the \kstr{Control}+\kstr{Escape} key, by
default.

The available commands are:

\begin{description}
\item [(Un)Maximize] will maximize the window both vertically and horizontally.
If the window is already maximized, it will make the window have the size it 
had before maximization.
\item [Miniaturize] will miniaturize the window.
\item [(Un)Shade] will shade the window or unshade it if is already shaded.
\item [Hide] will hide all windows of the application.
\item [Hide Others] will hide all applications except for the current one.
\item [Move To] allows you to move the window to another workspace.
\item [Attributes\ldots ] opens the \em Attributes Panel \em, where you can
edit the Window Maker specific attributes and options for that window.
\item [Close] will close the window. 
\item [Kill] will kill the application. Use this option only if the
application does not provide means to close it normally or in extreme cases.
\end{description}


%\newpage
%\section{The Window Attributes Inspector}

%%%%%%%%%%%%%%%%%%%%%%%%%%%


\chapter{The Workspace}




\section{Working with Menus}

Menus provide a list of commands that you can execute. To execute a
command listed in a menu, click in the corresponding item. The
item will blink telling that the command is going to be executed.

Grayed commands are disabled and cannot be executed at that moment. If you
click on them nothing will happen.

\begin{figure}
\epsfig{file=menu.ps}
\end{figure}

Some menu entries have a little triangular indicator at the right.
Selecting these entries will open a submenu, with a new list of commands.

You can use the keyboard to traverse and execute commands in some of the
menus. First you must hit the key used to open the menu --- like \kstr{F12}
for the root menu --- to enable keyboard traversal of it. Then you can
use the Up and Down arrow keys to change the current selected item and
the Left and Right arrow keys to jump between submenus and parent menus.
To execute the current selected item press \kstr{Return}. To close the
menu or stop menu traversal, press \kstr{Escape}. Additionally, pressing 
the first letter for an menu item, will jump the current selection to that 
item.

You can make frequently used menus ``stick'' to the workspace by dragging
the titlebar of the menu. This will make a close button appear in the menu
titlebar. If you want to close the menu, just click in that button.

Menus are normally placed on top of other windows and cannot be obscured
by them. If you want the menus to be able to be obscured by lowering them,
double click the menu titlebar while holding the \kstr{Meta} key. 
Repeat this to make the menus not obscurable again.

\subsection{The Root Window Menu}

The \em Root Window Menu \em or \em Applications Menu \em has items that allow
you to quickly launch applications and do some workspace management.

To open this menu, click on the workspace (root window) with the right mouse 
button or hit the key bound to it (\kstr{F12} by default).

The contents of the applications menu can be configured to
have the applications installed in your system. To learn how to
configure it, read the section on application menu configuration.


\subsection{The Window List Menu}

Clicking in the workspace with the middle mouse button will open a menu
listing all windows that currently exist, with the workspace where the window
is located at it\'s right. The current focused window is marked by a 
diamond sign at the left of it\'s name. Clicking in an entry of that
menu will focus the window, raise it and change the current workspace to
the one where the window is located.


\section{Working with Applications}

In Window Maker, the instance of a running application is represented by an
application icon. Do not confuse it with the icons (miniwindows in
Window Maker) displayed by other window managers when a window is iconified.
Application icons and miniwindows can be differentiated by the lack of
a title in the former. 

\begin{quote}
Window Maker identifies a group of windows as belonging to a single instance
of an application through some standard hints that the application sets in
its windows. Unfortunately not all applications that exist set these hints,
preventing some application specific features from working. These hints are
\texttt{WM\_CLASS}, \texttt{WM\_COMMAND} and \texttt{WM\_CLIENT\_LEADER} or 
the group leader in \texttt{WM\_HINTS}. You can see if an application
supports these hints by running the xprop utility and selecting the desired
window.

If the application does not set these hints, it's impossible to treat
it as an application in the point of view of Window Maker.
\end{quote}


Note: The information about applications contained in this section only
applies for versions of Window Maker built without the
\texttt{--enable-single-icon} compile time option. This option is
unsupported and behaviour when it's enabled will not be covered in this
text.



\subsection{Hiding an Application}

If you want to close an application but intend to use it later you can 
\em hide \em it. 
When you hide an application all windows and miniwindows that belong to that
application will be removed from the screen and are hidden into its application
icon. 

\begin{quote}
\sffamily
\vspace{0.5cm}
\bfseries To hide an application: \mdseries

\begin{itemize}

\item Click in the miniaturize button of any of the windows that belong to
the application while holding the \kstr{Control} key.

OR

\item Press the keyboard shortcut assigned to it, which is
\kstr{Meta}+\kstr{H} in the default configuration.

OR

\item Use the Hide command in the window commands menu brought when the window
titlebar is clicked witht the right mouse button.

OR

\item Use the (Un)Hide command in the application icon commands menu brought
when the application icon is clicked witht the right mouse button.

\end{itemize}
\end{quote}
\vspace{0.5cm}




\begin{quote}
\sffamily
\vspace{0.5cm}
\bfseries To unhide an application: \mdseries

\begin{itemize}

\item Double click in the application icon with the left mouse button.

OR

\item Use the (Un)Hide command in the application icon commands menu brought
when the application icon is clicked with the right mouse button.

\end{itemize}
\end{quote}
\vspace{0.5cm}

When you unhide an application, all it's windows and miniwindows will be
brought back and you will be taken to the last workspace you worked with
that application.

\vspace{1cm}
\sffamily
\textbf{Extra Bindings}

{\centering \begin{tabular}{p{5cm} p{5cm}}
\textbf{Action}&
\textbf{Effect}\\
\hline
Double-click in the application icon while holding the \kstr{Meta} key&
Unhide the clicked application and hide all other applications that are
present in the current workspace.\\
\hline
Double-click in the application icon while holding the \kstr{Shift} key&
Unhide the clicked application in the current workspace. If the application
is already unhidden in another workspace, the application is brought to the
current workspace.\\
\hline
Double-click in the application icon with the middle mouse button&
Unhide the clicked application and deminiaturizes all it's windows.\\
\hline
Double-click in the window titlebar with the right mouse button while
holding the \kstr{Meta} key&
Hide all applications in the current workspace except for the clicked one.\\
\end{tabular}\par}
\rmfamily
\vspace{0.50cm}

There are two other commands in the applications menu related to application
hiding:

\begin{description}

\item [Hide Others] hide all applications in the current workspace
except the currently active one;
\item [Show All] unhide all applications that were hidden in the current
workspace.

\end{description}


\subsection{The application icon menu}

A menu with commands that will apply to the application can be brought by
clicking the icon with the right mouse button.

The commands available in this menu are:

\begin{description}
\item[Unhide Here] unhides the application in the current workspace;

\item[(Un)Hide] hides the application.  If the application is already
hidden, unhide it and take you to the workspace where the application is
located;

\item[Set Icon\ldots ] open the icon image selection panel for the 
application icon.

\item[Kill] will kill the application. 

\end{description}

\subsection{The application dock}

The application dock is a place where you can store frequently used
applications for easy and fast access. It is located, by default, in the
right side of the screen.

You can click in the top icon (the one with the GNUstep logo) and drag it
downward to remove most of the dock from view. You can also drag it
sidewards to switch the side of the dock from right to side or vice-versa.

A menu similar to the application icon menu is brought up when you click in
a docked icon with the right menu button. It contains some extra commands
that are specific for docked applications.

To make the dock be uncoverable by other windows,
either double-click in the top dock icon while holding the \kstr{Meta}
key or select the ``Keep Dock on Top'' item in the dock menu. In this
mode, maximized windows will not be resized over the dock.


\subsubsection{Starting a docked application}

To start an application that is docked, double-click in its icon. The icon
will be briefly highlighted and the application started.

While an application is not running, an ellipsis mark is present in the
bottom left corner of the icon. When the application is started and is
running the ellipsis will disappear, until the application is quit.

While the application is running, the docked icon will behave just like a
normal undocked application icon, except for some extra actions specific for
the dock.

\begin{quote}
\sffamily
\vspace{0.5cm}
\bfseries To start a docked application: \mdseries

\begin{itemize}

\item Double-click in the application icon with the left mouse button.

OR

\item Use the ``Launch'' command in the dock menu for the icon. If the
application is already running it will start another instance.

OR

\item Hold the \kstr{Control} key while double-clicking in the icon to
start another instance of the application.

\end{itemize}
\end{quote}
\vspace{0.5cm}


If a new instance of an already running application is started, it will get
a new application icon.


\subsubsection{Customizing the dock}

To add new applications to the dock, you can click in an application icon 
and drag it into the dock. When a ghost image of the icon appear, release
the mouse button and the icon will be docked.

To reorder the docked applications, drag an icon to an empty slot and move
the icons around as you want.

To remove a docked application, drag it from the dock and release the mouse
button when the ghost image disappears. To remove the icon of an application
that is running, hold the \kstr{Meta} key while dragging it.


\subsubsection{Configuring the docked application}

To change the settings of the docked application, select the 
``Settings\ldots `` item in the dock menu for that icon. A settings panel
for that icon will appear.

\begin{figure}[h]
\epsfig{file=dsetpanel.ps}
\end{figure}


In the \em Application path and arguments \em field, the path for the
application and its arguments can be changed. Note that you can't change the
application that is represented in the icon or change anything that would
cause the application name to be changed. For example, if the icon is for
\texttt{xterm}, you can't change the field's value to \texttt{ghostview};
or if the icon is for \texttt{xterm -name vi}, you can't change it to
\texttt{xterm -name pine}. Also note that you cannot use shell commands,
such as output redirectors ($>$, $>>$ etc.).


\newpage

\section{Working with Workspaces}


\subsection{The Workspaces Menu}

The \em Workspaces Menu \em allows you to create, switch, destroy and
rename workspaces.

It has the following items:

\begin{description}
\item [New] creates a new workspace and automatically switches to it
\item [Destroy Last] destroys the last workspace unless it is occupied
by some window
\item [Workspaces] Each workspace has a corresponding item in the Workspaces
menu. Clicking in one of these entries will switch from the current
workspace to the selected workspace. 

The current active workspace is indicated by a small indicator at the left
of the workspace item.
\end{description}

\begin{figure}[h]
\epsfig{file=wsmenu.ps}

\caption{Workspaces Menu}
\end{figure}


To change the name of a workspace you must first ``stick'' the menu. Then
\kstr{Control} click in the item corresponding to the workspace you
want to rename. The item will turn into a editable text field where you
can edit the workspace name. To finish editing the workspace name,
press \kstr{Return}; to cancel it, press \kstr{Escape}.

There is a limit of 16 characters on the length of the workspace name.

\begin{figure}[h]
\epsfig{file=wsmenued.ps}
\caption{The editable workspace menu}
\end{figure}



\subsection{The workspace Clip}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\chapter{Configuring Window Maker}

Window Maker is fully configurable graphically, from WPrefs.app,
attributes panel and other built-in configuration panels.
In some cases you might want to change the configuration manually,
from a text editor. This section describes the configuration files
and options available.

\section{The Defaults Database System}

Window Maker uses a defaults database for storing various information,
like configurations and other data that must be kept between sessions (like
the list of applications of a saved session). The defaults database
is stored as \em property lists \em in the \texttt{\$(HOME)/GNUstep/Defaults}
directory. Each file in the \texttt{\$(HOME)/GNUstep/Defaults} directory
contains data that belongs to a specific \em domain\em .

Any application can use the defaults database to store its configuration 
information. Generally an application will have one or more \em domains \em
that belong to it. 

\subsection{Property List File Format}

The syntax of a property list is simple, but if you need to change it
manually, you must take care to not leave any syntax errors.

The EBNF for the property list is the following:

 

\subsubsection{Description of the syntax of a property list in
the Bacchus Naur Form (BNF)}
  
\ttfamily
%%\vspace{0.5cm}
\fbox{
\small{
  \begin{tabular}{l l l}
    \(<\)object\(>\)  & ::= & \(<\)string\(>\) \(|\) \(<\)data\(>\) \(|\)\(<\)array\(>\) \(|\) \(<\)dictionary\(>\)\\
    \(<\)string\(>\) & ::= & \textsl{text with non-alphanumeric characters} \(|\) alphanumeric text\\
    \(<\)array\(>\) & ::= & `(' \([\) \(<\)object\(>\) \{ `,' \(<\)object\(>\) \}* \(]\) `)'\\
    \(<\)dictionary\(>\) & ::= &`\{' \([\) \(<\)keyval\_pair\(>\) \{ `,'\(<\)keyval\_pair\(>\) \}*\(]\) `\}'\\
    \(<\)keyval\_pair\(>\) & ::= & \(<\)string\(>\) `=' \(<\)object\(>\) `;'
  \end{tabular}
  }}

\rmfamily


\subsubsection{Example property list file}
\small{
\begin{verbatim}
{
	"*" = {
		Icon = "defaultAppIcon.xpm";
	};
	"xterm.XTerm" = {
		Icon = "xterm.xpm";
	};
	xconsole = {
		Omnipresent = YES;
		NoTitlebar = YES;
		KeepOnTop = NO;
	};
}
\end{verbatim}}

The property list above is a dictionary with 3 dictionaries inside.
The first is keyed by ``*'', the second by ``XTerm.xterm'' and the last
by ``xconsole''. 

Note that all strings that have non-alphabetic or numeric characters (like
a dot ``.'' or the asterisk ``*'' are enclosed by double quotes. Strings
with only alphanumeric characters may or may not be enclosed in double
quotes, as they will not make any difference.


\noindent Here is another example:
\begin{verbatim}
{
	FTitleBack = ( hgradient, gray, "#112233" );
}
\end{verbatim}

The property list in the example above contains an array with 3 elements
with a key named ``FTitleBack''. 

Except for cases like file names and paths, all value strings are case
insensitive, i.e.: YES = Yes = yes = yEs

\subsection{Value Types}

Here is a description of some the types of values that an option might have.

{\centering \begin{tabular}{p{2cm} p{10cm}}
\textbf{Type}&
\textbf{Values:}\\
\hline
boolean&
YES or NO\\
\hline
integer&
any integer number, usually limited by a range that will be indicated\\
\hline
positive integer&
any integer number greater than or equal to zero (0)\\
\hline
speed&
one of UltraFast, Fast, Medium, Slow or VerySlow\\
\hline
mouse button&
one of Left, Middle, Right, Button1, Button2, Button3, Button4 or Button5\\
\hline
\end{tabular}\par}


\newpage

\subsection{Preferences}

General preference options are stored in the \em Window Maker \em domain,
ie: in the \texttt{\$(HOME)/GNUstep/Defaults/WindowMaker} file.

Changes in preference options will automatically affect the current
Window Maker session, even without a restart. Some options, however,
require a restart of Window Maker so that they apply. Such options
are marked by a * .

Note that values marked as \em Default \em are values that
are assumed if the option is not specified, instead of \em factory default \em
values that are set in the preference file.

\subsubsection{General Configuration}

%
% Desired layout:
%
%
%      Option   FooBar
%      Values   boolean (default: NO)
% Description   jekqwljrewl  rjew rjwelk rjwel jr jqwlrqw rjkwqr jewl
%               wlj l;j kl; jy triyre
%
%      Option   FooBaz
%         ...
%

\begin{itemize}

\item [Option] \texttt{PixmapPath}

\item [Value] list of directories separated by ``\textbf{:}'' (default: 
depends on the system)

\item [Description]
A list of directories where pixmaps can be found. The pixmaps for
things like icons, are searched in these paths in order of appearance.\\



\item [Option] \texttt{*NoDithering}

\item [Value] boolean (default: NO)

\item [Description]
Disable internal dithering of images. Not recommended for displays with
less than 8 bits per pixel.\\



\item [Option] \texttt{*ColormapSize}

\item [Value] integer number \(>\) 1 (default: 4)

\item [Description]
Number of colors for each of the red, green and blue components to be used
for the dithering colormap. This value must be greater than 1 and smaller
than 6 for 8bpp displays. It only makes sense on PseudoColor displays.
This option has not effect on TrueColor displays. Larger values result
in better appearance, but leaves less colors for other applications.\\



\item [Option] \texttt{*ModifierKey}

\item [Value] modifier key name (default: Mod1)

\item [Description]
The key to use as the modifier being referred as \kstr{Meta} in this manual,
like \kstr{Meta} dragging a window to move it.
Valid values are \texttt{Alt}, \texttt{Meta}, \texttt{Super}, \texttt{Hyper},
\texttt{Mod1}, \texttt{Mod2}, \texttt{Mod3}, \texttt{Mod4}, \texttt{Mod5}.\\


\item [Option] \texttt{UseSaveUnders}

\item [Value] boolean (default: NO)

\item [Description]
Use \em saveunder \em in Window Maker windows. This can improve performance
but increases memory usage. It also can cause problems with 
window refreshing in some buggy X servers.\\



\item [Option] \texttt{DisableClip}

\item [Value] boolean (default: NO)

\item [Description]
Will remove the application Clip from the workspace.\\



\item [Option] \texttt{DisableDock}

\item [Value] boolean (default: NO)

\item [Description] 
Will remove the application Dock from the workspace.\\



\item [Option] \texttt{Superfluous}

\item [Value] boolean (default: NO)

\item [Description]
Enable extra animations and other cosmetic things that might increase peak
memory and CPU usage.\\



\item [Option] \texttt{SaveSessionOnExit}

\item [Value] bolean (default: NO)

\item [Description]
Automatically save the state of the session when exiting Window Maker.\\



\item [Option] \texttt{*IconSize}

\item [Value] integer number \(>\) 4 (default: 64)

\item [Description]
The size of application icons and miniwindows.\\



\item [Option] \texttt{OpaqueMove}

\item [Value] boolean (default: NO)

\item [Description]
Whether the whole window should be moved while dragging it or only a
frame representing the window should be moved.
\footnote{When OpaqueMove is turned off, Window Maker will grab the server,
so that applications won't refresh their contents. This is necessary,
otherwise the frame drawn over windows will not be erased correctly.}\\


\item [Option] \texttt{*FocusMode}

\item [Value] Manual or ClickToFocus, Auto or FocusFollowsMouse, SemiAuto 
or Sloppy (default: Manual)

\item [Description]
The mode of input focus setting. Refer to the section
about focus selection (\ref{secfocus}) for an explanation of the
focus modes.\\



\item [Option] \texttt{IgnoreFocusClick}

\item [Value] boolean (default: NO)

\item [Description]
Whether the mouse click used to focus a window should be ignored or treated
normally.\\



\item [Option] \texttt{AutoFocus}

\item [Value] boolean (default: NO)

\item [Description]
Whether newly created windows should automatically receive input focus.
Do not confuse with FocusMode=Auto.\\



\item [Option] \texttt{RaiseDelay}

\item [Value] integer number (default: 0)

\item [Description]
How many tenths of a second to wait before raising a window in Auto or
SemiAuto focus mode. 0 disables this feature.\\



\item [Option] \texttt{DoubleClickTime}

\item [Value] integer number (default: 250)

\item [Description]
If two mouse clicks occur in this interval of time, it will be considered
a double click.\\



\item [Option] \texttt{ColormapMode}

\item [Value] Manual or ClickToFocus, Auto or FocusFollowsMouse 
(default: Auto)

\item [Description]
The mode of colormap setting. In \em Manual \em or \em ClickToFocus \em 
mode, the colormap is set to the one belonging to the current focused window.
In \em Auto \em or \em FocusFollowsMouse \em mode, the colormap is 
set to the colormap of the window below the pointer.\\



\item [Option] \texttt{CirculateRaise}

\item [Value] boolean (default: NO)

\item [Description]
Whether the window should be raised when circulating 
(focus the next or previous window through the keyboard).\\



\item [Option] \texttt{OnTopTransients}

\item [Value] boolean (default: NO)

\item [Description]
Whether transient windows should always be placed over their owner windows.\\



\item [Option] \texttt{WindowPlacement}

\item [Value] auto, cascade, manual or random (default: cascade)

\item [Description]
Selects placement mode for new windows. \em auto \em places the window
automatically in the first open space found in the workspace. \em cascade \em
places the window in incrementing positions starting from the top-left 
corner of the workspace. \em manual \em allows you to place the window
interactively with the mouse. \em random \em places the window randomly
on the workspace.\\


\item [Option] \texttt{WindowPlaceOrigin}

\item [Value] (x, y) where x and y are integer numbers. (default: (0,0))

\item [Description]
Sets the offset from the top-left corner of the screen to place windows.
In non-manual WindowPlacement modes, windows will not be placed above or
to the left of this point.

\item [Option] \texttt{AutoArrangeIcons}

\item [Value] boolean (default: NO)

\item [Description]
Whether icons should be automatically arranged.\\



\item [Option] \texttt{ResizeDisplay}

\item [Value] center, corner, floating or line (default: corner)

\item [Description]
Selects the type or position of the box that shows the window size when
a window is being resized. \em center \em places the box in the center of
the workspace, \em corner \em places it in the top-left corner of the 
workspace, \em floating \em places it in the center of the window being
resized and \em line \em draws the current window size over the workspace,
like in a technical drawing.\\

\item [Option] \texttt{MoveDisplay}

\item [Value] center, center or floating (default: corner)

\item [Description]
Selects the type or position of the box that shows the window position when
a window is being moved. The value meanings are the same as for the
ResizeDisplay option.\\



\item [Option] \texttt{AlignSubmenus}

\item [Value] boolean (default: NO)

\item [Description]
Whether submenus should be aligned vertically with their parent menus.\\



\item [Option] \texttt{WrapMenus}

\item [Value] boolean (default: NO)

\item [Description]
Whether submenus should be placed at the right of it\'s parent menu when they
don\'t fit on screen. Note that menus that are placed outside the screen can
be scrolled.\\



\item [Option] \texttt{ScrollableMenus}

\item [Value] boolean (default: NO)

\item [Description]
Whether menus that are not fully inside the screen should 
automatically scroll when the pointer is over them and near the border
of the screen.\\



\item [Option] \texttt{MenuScrollSpeed}

\item [Value] speed (default: Medium)

\item [Description]
The scrolling speed of menus.\\



\item [Option] \texttt{DontLinkWorkspaces}

\item [Value] boolean (default: NO)

\item [Description]
Do not automatically switch to the next or previous workspace when a
window is dragged to the edge of the screen.\\



\item [Option] \texttt{NoWindowOverIcons}

\item [Value] boolean (default: NO)

\item [Description]
When maximizing windows, limit their sizes so that they will not cover
miniwindows and application icons.\\


\item [Option] \texttt{StickyIcons}

\item [Value] boolean (default: NO)

\item [Description]
Whether miniwindows should be present in all workspaces.\\


\item [Option] \texttt{CycleWorkspaces}

\item [Value] boolean (default: NO)

\item [Description]
Set to YES if you want windows that are dragged past the last workspace
should be moved to the first workspace, or vice-versa.\\


\item [Option] \texttt{AdvanceToNewWorkspace}

\item [Value] boolean (default: NO)

\item [Description]
Whether windows dragged past the last workspace should create a new
workspace.\\


\item [Option] \texttt{DisableAnimations}

\item [Value] boolean (default: NO)

\item [Description]
Whether animations, like the one done during miniaturization, should be
disabled.\\


\item [Option] \texttt{IconSlideSpeed}

\item [Value] speed (default: Medium)

\item [Description]
The speed of icons when they are being slided across the workspace.\\


\item [Option] \texttt{ShadeSpeed}

\item [Value] speed (default: Medium)

\item [Description]
The speed of the shading animation.\\


\item [Option] \texttt{DisableSound}

\item [Value] boolean (default: NO)

\item [Description]
Whether sound support in Window Maker should be disabled.
Note that to have sound support in Window Maker, you must have a sound
module for Window Maker compiled for your system and a version of
Window Maker compiled with the --enable-sound configure flag. The sound
module is currently only available for Linux and FreeBSD systems.
Read the README file for Window Maker or the Window Maker Home Page
to find where to download the module.\\


\item [Option] \texttt{*DisableWSMouseActions}

\item [Value] boolean (default: NO)

\item [Description]
Whether actions triggered by mouse clicks in the workspace should be
disabled. This allows the use of file managers and desktop managers that
place icons in the root window (such as KDE). \\


\item [Option] \texttt{SelectWindowsMouseButton}

\item [Value] mouse button (default: Left)

\item [Description]
The mouse button that activates the ``rubberband'' selection of multiple 
windows in the workspace.\\


\item [Option] \texttt{WindowListMouseButton}

\item [Value] mouse button (default: Middle)

\item [Description]
The mouse button that opens the window list menu in the workspace.\\


\item [Option] \texttt{ApplicationMenuMouseButton}

\item [Value] mouse button (default: Right)

\item [Description]
The mouse button that opens the applications menu in the workspace.\\


\item [Option] \texttt{IconPosition}

\item [Value] tlh, tlv, trh, trv, blh, blv, brh, brv (default: blh)

\item [Description]
The position on the screen where miniwindows and application icons should
be placed. The first character can be \em t \em or \em b \em, meaning
top or bottom. The second character can be \em l \em or \em r \em, meaning
left or right. The third character can be \em v \em or \em h \em, meaning
vertical or horizontal. So, \em blh \em will make the icons be placed
horizontally starrting from the bottom left corner of the screen.\\



\item [Option] \texttt{AppIconBalloons}

\item [Value] boolean (default: NO)

\item [Description]
Show a balloon with the class name (normally the name of the application,
unless that application is coded in an uncommon way) of the application
represented when the mouse pointer is placed over an application icon. If
the application icon is docked, the command line for that application is
also displayed.\\


\item [Option] \texttt{MiniwindowTitleBalloons}

\item [Value] boolean (default: NO)

\item [Description]
Show a balloon with the title of the miniwindow when the mouse pointer is
placed over a miniwindow.\\


\item [Option] \texttt{WindowTitleBalloons}

\item [Value] boolean (default: NO)

\item [Description]
Show a balloon with the full title of the window the mouse pointer is placed
over the window's titlebar and the title doesn't fully fit in the titlebar.\\


\item [Option] \texttt{EdgeResistance}

\item [Value] integer (default: 0)

\item [Description]
How many pixels to move a window against the edge of the screen to
actually put it outside of the screen.\\


\item [Option] \texttt{IconificationStyle}

\item [Value] zoom, twist, flip or none (default: zoom)

\item [Description]
The style of the animation for miniaturization of miniwindows.\\


\end{itemize}


\subsubsection{Appearance Options}

Fonts are specified in the X Logical Font Description format (aka Xtra Long
Font Description). You can cut and paste these names from programs like
\texttt{xfontsel}.

Colors are specified as color names in the standard X format. 
This can be any color name shown by the \texttt{showrgb} program (like
black, white or gray) or a color value in the \#rrggbb format, where rr, gg
and bb is the intensity of the color component (like \#ff0000 for pure red
or \#000080 for medium blue). Note that color names in the \#rrggbb format
must be enclosed with double quotes. There are other formats to specify
colors. Look at the \texttt{XParseColor(3)} manual page 
(type |man XParseColor|) for more information.

Textures are specified as an array, where the first element specifies
the texture type followed by a variable number of arguments.

Valid texture types are:

\begin{description}
\item [(solid, color)] the texture is a simple solid color.

\item [(dgradient, color1, color2)] the texture is a diagonal gradient 
rendered from the top-left corner to the bottom-right corner. The first 
argument (color1) is the color for the top-left corner and the second (color2) 
is for the bottom-right corner.

\item [(hgradient, color1, color2)] the texture is a horizontal 
gradient rendered from the left edge to the right edge. The first argument
(color1) is the color for the left edge and the second (color2) is
for the right edge.

\item [(vgradient, color1, color2)] the texture is a vertical
gradient rendered from the top edge to the bottom edge. The first argument
(color1) is the color for the top edge and the second (color2) is
for the bottom edge.

\item [(mdgradient, color1, color2, \ldots , color$n$)]
this is equivalent to dgradient, but you can specify more than two colors.

\item [(mhgradient, color1, color2, \ldots , color$n$)]
this is equivalent to hgradient, but you can specify more than two colors.

\item [(mvgradient, color1, color2, \ldots , color$n$)]
this is equivalent to vgradient, but you can specify more than two colors.

\item [(tpixmap, pixmapFile, color)] the texture will be the pixmap
specified by pixmapFile and it will be tiled all over the area. color
is the color Window Maker will use when it needs to know the color of the
titlebar. You can specify the predominant color of the pixmap.

\item [(spixmap, pixmapFile, color)] the texture will be the pixmap
specified by pixmapFile and it will be scaled to fit the area. color
has the same meaning as in tpixmap.

\item [(cpixmap, pixmapFile, color)] the texture will be the pixmap
specified by pixmapFile and it will be centered to fit the area. color
has the same meaning as in tpixmap and will also be used to fill the
back of the pixmap. Note that this has the same memory usage as spixmap.

\end{description}

\textbf{Examples}

{\centering \begin{tabular}{p{6cm} p{5cm}}
\epsfig{file=texsolid.ps}&
(solid, gray)\\
\epsfig{file=texdgrad.ps}&
(dgradient, gray80, gray20)\\
\epsfig{file=texhgrad.ps}&
(hgradient, gray80, gray20)\\
\epsfig{file=texvgrad.ps}&
(vgradient, gray80, gray20)\\
\end{tabular}\par}


\begin{itemize}

\item [Option] \texttt{*NewStyle}

\item [Value] boolean (default: NO)

\item [Description]
Selects between N*XTSTEP style buttons in the titlebar and a newer style
of buttons.\\


\item [Option] \texttt{WidgetColor}

\item [Value] (solid, color) where color is a color name (default: (solid, gray))

\item [Description]
Chooses the color to be used in titlebar buttons if NewStyle=NO.\\


\item [Option] \texttt{WorkspaceBack}

\item [Value] a texture or None (default: None)

\item [Description]
Default texture for the workspace background. Note: The \em dgradient \em
and \em mdgradient \em textures can take a lot of time to be rendered.\\


\item [Option] \texttt{IconBack}

\item [Value] texture (default: (solid, gray))

\item [Description]
Texture for the background of application icons and miniwindows.\\


\item [Option] \texttt{FTitleBack}

\item [Value] texture (default: (solid, black))

\item [Description]
Texture for the focused window titlebar.\\


\item [Option] \texttt{PTitleBack}

\item [Value] texture (default: (solid, "\#616161"))

\item [Description]
Texture for the owner of the currently focused transient window.\\

\item [Option] \texttt{UTitleBack}

\item [Value] texture (default: (solid, gray))

\item [Description]
Texture for untitled window titlebars.\\


\item [Option] \texttt{MenuTitleBack}

\item [Value] texture (default: (solid, black))

\item [Description]
Texture for menu titlebars.\\


\item [Option] \texttt{MenuTextBack}

\item [Value] texture (default: (solid, gray))

\item [Description]
Texture for menu items.\\


\item [Option] \texttt{FTitleColor}

\item [Value] color (default: white)

\item [Description]
The color of the text in the focused window titlebar.\\


\item [Option] \texttt{PTitleColor}

\item [Value] color (default: white)

\item [Description]
Color for the text in the unfocused main window titlebar or the owner of
the currently focused transient window.\\


\item [Option] \texttt{UTitleColor}

\item [Value] color (default: black)

\item [Description]
Color for the text in unfocused window titlebars.\\


\item [Option] \texttt{MenuTitleColor}

\item [Value] color (default: white)

\item [Description]
Color for the text in menu titlebars.\\


\item [Option] \texttt{MenuTextColor}

\item [Value] color (default: black)

\item [Description]
Color for the text in menu items.\\


\item [Option] \texttt{HighlightColor}

\item [Value] color (default: white)

\item [Description]
Color for the highlighted item in menus.\\


\item [Option] \texttt{HighlightTextColor}

\item [Value] color (default: black)

\item [Description]
Color for the highlighted item text in menus.\\


\item [Option] \texttt{MenuDisabledColor}

\item [Value] color (default: "\#616161")

\item [Description]
Color for the text of disabled menu items.\\


\item [Option] \texttt{ClipTitleColor}

\item [Value] color (default: black)

\item [Description]
Color for the text in the clip.\\


\item [Option] \texttt{CClipTitleColor}

\item [Value] color (default: \#454045)

\item [Description]
Color for the text in the collapsed clip.\\



\item [Option] \texttt{WindowTitleFont}

\item [Value] font (default: helvetica bold 12)

\item [Description]
Font for the text in window titlebars.\\


\item [Option] \texttt{MenuTitleFont}

\item [Value] font (default: helvetica bold 12)

\item [Description]
Font for the text in menu titlebars.\\


\item [Option] \texttt{MenuTextFont}

\item [Value] font (default: helvetica medium 12)

\item [Description]
Font for the text in menu items.\\


\item [Option] \texttt{IconTitleFont}

\item [Value] font (default: helvetica medium 8)

\item [Description]
Font for the text in miniwindow titlebars.\\


\item [Option] \texttt{ClipTitleFont}

\item [Value] font (default: helvetica bold 10)

\item [Description]
Font for the text in the Clip.\\


\item [Option] \texttt{DisplayFont}

\item [Value] font (default: helvetica medium 12)

\item [Description]
Font for the text in information windows, like the size of windows during
resize.\\


\item [Option] \texttt{TitleJustify}

\item [Value] center, left or right (default: center)

\item [Description]
Justification of the text in window titlebars.\\


\end{itemize}

\subsubsection{Keyboard Bindings}

Keyboard shortcut specifications are in the form:

\begin{quote}
	\([<\)modifier key names\(>\) + \(] <\)key name\(>\)
\end{quote}

Where \em modifier key names \em specify an optional modifier key,
like \kstr{Meta} or \kstr{Shift}. Any number of modifier keys might be
specified. The \em key name \em is the actual key that will trigger
the action bound to the option.

Examples:

\begin{description}
\item [F10] means the \kstr{F10} key.

\item [Meta+Tab] means the \kstr{Tab} key with the \kstr{Meta} modifier 
key pressed at the same time.

\item [Meta+Shift+Tab] means the \kstr{Tab} key with the \kstr{Meta} 
and \kstr{Shift} modifier keys pressed at the same time.
\end{description}

Key names can be found at \texttt{/usr/X11R6/include/X11/keysymdef.h}
The \texttt{XK\_} prefixes must be ignored (if key name is \texttt{XK\_Return}
use \texttt{Return}).


\begin{itemize}


\item [Option] \texttt{RootMenuKey}

\item [Default Value] None

\item [Action]  
Opens the root menu in the current position of the mouse pointer.\\


\item [Option] \texttt{WindowListKey}

\item [Default Value] None

\item [Action]  
Opens the window list menu in the current position of the mouse pointer.\\


\item [Option] \texttt{WindowMenuKey}

\item [Default Value] None

\item [Action]  
Opens the window commands menu of the current focused window.\\


\item [Option] \texttt{MiniaturizeKey}

\item [Default Value] None

\item [Action]  
Miniaturizes the current focused window.\\


\item [Option] \texttt{HideKey}

\item [Default Value] None

\item [Action]  
Hides the current active application.\\


\item [Option] \texttt{CloseKey}

\item [Default Value] None

\item [Action]  
Closes the current focused window.\\


\item [Option] \texttt{MaximizeKey}

\item [Default Value] None

\item [Action]  
Maximizes the current focused window.\\


\item [Option] \texttt{VMaximizeKey}

\item [Default Value] None

\item [Action]  
Maximizes the current focused window vertically.\\


\item [Option] \texttt{RaiseKey}

\item [Default Value] Meta+Up

\item [Action]  
Raises the current focused window.\\


\item [Option] \texttt{LowerKey}

\item [Default Value] Meta+Down

\item [Action]  
Lowers the current focused window.\\


\item [Option] \texttt{RaiseLowerKey}

\item [Default Value] None

\item [Action] 
Raises the window under the pointer or lower it if it is already raised.\\


\item [Option] \texttt{ShadeKey}

\item [Default Value] None

\item [Action]  
Shades the current focused window.\\



\item [Option] \texttt{SelectKey}

\item [Default Value] None

\item [Action] 
Selects the current focused window.\\


\item [Option] \texttt{FocusNextKey}

\item [Default Value] None

\item [Action]  
Switch focus to the next window.\\


\item [Option] \texttt{FocusPrevKey}

\item [Default Value] None

\item [Action] 
Switch focus to the previous window.\\


\item [Option] \texttt{NextWorkspaceKey}

\item [Default Value] None

\item [Action]  
Switches to the next workspace.\\


\item [Option] \texttt{PrevWorkspaceKey}

\item [Default Value] None

\item [Action]  
Switches to the previous workspace.\\


\item [Option] \texttt{NextWorkspaceLayerKey}

\item [Default Value] None

\item [Action]  
Switches to the next group of 10 workspaces.\\


\item [Option] \texttt{PrevWorkspaceLayerKey}

\item [Default Value] None

\item [Action]  
Switches to the previous group of 10 workspaces.\\


\item [Option] \texttt{Workspace1Key}

\item [Default Value] None

\item [Action]  
Switches to workspace 1\\


\item [Option] \texttt{Workspace2Key}

\item [Default Value] None

\item [Action] 
Switches to workspace 2, creating it if it does not exist.\\


\item [Option] \texttt{Workspace3Key}

\item [Default Value] None

\item [Action] 
Switches to workspace 3, creating it if it does not exist.\\


\item [Option] \texttt{Workspace4Key}

\item [Default Value] None

\item [Action] 
Switches to workspace 4, creating it if it does not exist.\\


\item [Option] \texttt{Workspace5Key}

\item [Default Value] None

\item [Action] 
Switches to workspace 5, creating it if it does not exist.\\


\item [Option] \texttt{Workspace6Key}

\item [Default Value] None

\item [Action]  
Switches to workspace 6, creating it if it does not exist.\\


\item [Option] \texttt{Workspace7Key}

\item [Default Value] None

\item [Action]  
Switches to workspace 7, creating it if it does not exist.\\


\item [Option] \texttt{Workspace8Key}

\item [Default Value] None

\item [Action]  
Switches to workspace 8, creating it if it does not exist.\\


\item [Option] \texttt{Workspace9Key}

\item [Default Value] None

\item [Action]  
Switches to workspace 9, creating it if it does not exist.\\


\item [Option] \texttt{Workspace10Key}

\item [Default Value] None

\item [Action]  
Switches to workspace 10, creating it if it does not exist.\\


\item [Option] \texttt{ClipLowerKey}

\item [Default Value] None

\item [Action]  
Lowers the clip.\\


\item [Option] \texttt{ClipRaiseKey}

\item [Default Value] None

\item [Action] 
Raises the clip.\\


\item [Option] \texttt{ClipRaiseLowerKey}

\item [Default Value] None

\item [Action] 
Raises the clip or lowers it if it is already raised.\\


\end{itemize}


\subsection{Window Attributes}

Window attributes are stored in the 
\texttt{\$(HOME)/GNUstep/Defaults/WMWindowAttributes} file.

\subsubsection{Syntax}

The contents of this file is a dictionary of attribute dictionaries keyed 
by window names. Like this:

\begin{verbatim}
{
	"*" = {
		Icon = "defaultAppIcon.xpm";
	};
	"xterm.XTerm" = {
		Icon = "xterm.xpm";
	};
	xconsole = {
		Omnipresent = YES;
		NoTitlebar = YES;
		KeepOnTop = NO;
	};	
}
\end{verbatim}

Window names are in the form:
\footnote{You can get the values for these information by running the 
\texttt{xprop}
utility on the desired window. When you do that, it will show the following
line, among other things:

\texttt{WM\_CLASS(STRING) = "xterm", "XTerm"}

The first string (\texttt{xterm}) is the window instance name and the second 
(\texttt{XTerm}) the window class name.}

\begin{quote}
	\(<\)window instance name\(>\) . \(<\)window class name\(>\)
	
	OR
	
	\(<\)window instance name\(>\) 
	
	OR
	
	\(<\)window class name\(>\)
\end{quote}


Placing an asterisk as the window name means that the values set for
that key are to be used as default values for all windows. So, since
xconsole does not specify an \texttt{Icon} attribute, it will use the default
value, which in the above example is \texttt{defaultAppIcon.xpm}.


\subsubsection{Options}

The default value is NO for all options.


\begin{itemize}

\item [Attribute] \texttt{Icon}
\item [Value]pixmap file name
\item [Description]
Assigns a pixmap image to be used as the icon for that window.\\



\item [Attribute] \texttt{NoTitlebar}

\item [Value] boolean

\item [Description]
Do not put a titlebar in the window.\\



\item [Attribute] \texttt{NoResizebar}

\item [Value] boolean

\item [Description]
Do not put a resizebar in the window.\\



\item [Attribute] \texttt{NoMiniaturizeButton}

\item [Value] boolean

\item [Description]
Remove the miniaturize button from the titlebar.\\



\item [Attribute] \texttt{NoCloseButton}

\item [Value] boolean

\item [Description]
Remove the close button from the titlebar.\\



\item [Attribute] \texttt{NoHideOthers}

\item [Value] boolean

\item [Description]
Do not hide the window or the application to which the window belongs when a
|Hide Others| command is issued.\\



\item [Attribute] \texttt{NoMouseBindings}

\item [Value] boolean

\item [Description]
Do not grab mouse buttons in that window. This means that actions like
\kstr{Meta} Click on the window will be caught by the application instead of
being intercepted by Window Maker.\\



\item [Attribute] \texttt{NoKeyBindings}

\item [Value] boolean

\item [Description]
Do not grab keys in that window. This means that keystrokes that would be
normally intercepted by Window Maker (because they are bound to some action),
like \kstr{Meta} + \kstr{Up}, will be passed to the application.\\



\item [Attribute] \texttt{NoAppIcon}

\item [Value] boolean

\item [Description]
Do not create an application icon for the window. This is usefull for some
applications that incorrectly get more than one application icon.\\



\item [Attribute] \texttt{KeepOnTop}

\item [Value] boolean

\item [Description]
Always keep the window over other normal windows.\\



\item [Attribute] \texttt{Omnipresent}

\item [Value] boolean

\item [Description]
Make the window be present in all workspaces. AKA sticky window.\\



\item [Attribute] \texttt{SkipWindowList}

\item [Value] boolean

\item [Description]
Do not list the window in the window list menu.\\



\item [Attribute] \texttt{KeepInsideScreen}

\item [Value] boolean

\item [Description]
Always keep window inside the visible area of the screen.\\



\item [Attribute] \texttt{Unfocusable}

\item [Value] boolean

\item [Description]
Do not let the window be focused.\\



\item [Attribute] \texttt{StartWorkspace}

\item [Value] workspace number or name

\item [Description]
Make the window always be initially shown in the indicated workspace.\\



\item [Attribute] \texttt{EmulateAppIcon}

\item [Value] boolean

\item [Description]
Make the window emulate an application that provides enough information
for Window Maker to create an application icon for it. If you want to use
this attribute in a application that opens other windows, set it only
in the main window of that application (ie: the first window of
the application that is shown and the one that quits the whole application
when closed).\\



\end{itemize}


\subsection{Applications Menu}

The applications menu (aka: root menu) can be defined in two distinct ways:
\begin{itemize}
\item in the form of an array in property list format, in
\texttt{\$(HOME)/GNUstep/Defaults/WMRootMenu}
\item in the form of a text file, which location is present in
\texttt{\$(HOME)/GNUstep/Defaults/WMRootMenu}
\end{itemize}

In any of these ways, the contents of the menu can be defined statically
in the configuration file or dynamically, by using the contents of
a directory or by the output of some script.



\appendix{Tips}

\begin{itemize}

\item If the size of a window is so large that it doesn't fit on the screen
and you can't manipulate it, you can simply hold the \kstr{Meta}
key while dragging the window in the client area. This
way you can move the window up or down and resize it, if you want.
 
\item If you want windows to be able to cover the dock, you can make the
dock lowerable by double clicking the first dock icon while holding
the \kstr{Meta} key. Then, you can raise and lower
the dock through the first icon, just like you do with windows.

\item If you want windows to be able to cover menus, you can make them 
lowerable just like the dock by double clicking the titlebar of the menu
with the \kstr{Meta} key pressed.

\item You can make a ``taskbar'' by opening the window list menu, attaching it
to the workspace and moving it to the bottom of the screen, leaving only
it's title visible. Then, when you move the mouse over it, the menu will
become visible.

\item If you removed the titlebar of a window, you can still access the
attributes panel for it by focusing the window and hitting the shortcut for
opening the window commands menu (default is \kstr{Control}+\kstr{Escape}).

\item If you need to execute a command every time Window Maker is 
started, you can place the command in the 
\texttt{\$(HOME)/GNUstep/Library/WindowMaker/autostart} script.
Similarly, the \texttt{\$(HOME)/GNUstep/Library/WindowMaker/exitscript} 
script is always executed when Window Maker is exited.


\end{itemize}


\appendix{Glossary}

\begin{description}

\item [drag] to click in an object with the mouse and move the mouse
while holding the mouse button, wich cause that object to be
``dragged'' by the mouse.

\item [miniaturize] (iconify, minimize) to temporarily put a window
aside, replacing the window with a miniature representation of it.


\item [Meta key] depending on the system, keyboard type and configuration,
this can mean different keys. On PCs, it is usually the \kstr{Alt} or
\kstr{Alternate} key.


\end{description}

\end{document}
