Deploy gryf/window-maker.github.io to github.com/gryf/window-maker.github.io.git:gh-pages

This commit is contained in:
Deployment Bot (from Travis CI)
2020-04-06 17:04:05 +00:00
commit 17a465baa1
240 changed files with 23516 additions and 0 deletions

1864
docs/FAQ.html Normal file

File diff suppressed because it is too large Load Diff

2313
docs/FAQ.rst Normal file

File diff suppressed because it is too large Load Diff

120
docs/chap1.html Normal file
View File

@@ -0,0 +1,120 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: User Guide - Introduction</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
<div class="document" id="introduction">
<h1 class="title">Introduction</h1>
<p>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 users who have experience with other window managers.</p>
<p>How to Read this guide If you never have used a X window manager, you should
read all of this guide, as it contains detailed instructions for new users.</p>
<p>Text in 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.</p>
<p>You can ignore the text in 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.</p>
<div class="section" id="what-is-a-window-manager">
<h1>What is a window manager?</h1>
<p>If you come from the Windows or MacOS world, you might be confused about all
these things like window managers, X windows etc.</p>
<p>In the Unix world, the task of providing a graphical user interface (GUI) is
normally divided by 3 different components:</p>
<p>the window server; the window manager and the user interface toolkit. The
window server is standard and is usually the X Window System 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.</p>
<p>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.</p>
<p>For more information, read the manual page for X(1) and the documentation for
Xlib.</p>
<p>The primary function of the window manager 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.</p>
<p>The user interface toolkit 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 are currently many
of these toolkits available for X. Motif, OpenLook, and Athena are examples of
toolkits.</p>
<p>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.</p>
</div>
</div>
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: User Guide - Introduction</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

129
docs/chap1.rst Normal file
View File

@@ -0,0 +1,129 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: User Guide - Introduction</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
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 users who have experience with other window managers.
How to Read this guide If you never have used a X window manager, you should
read all of this guide, as it contains detailed instructions for new users.
Text in 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 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.
What is a window manager?
-------------------------
If you come from the Windows or MacOS world, you might be confused about all
these things like window managers, X windows etc.
In the Unix world, the task of providing a graphical user interface (GUI) is
normally divided by 3 different components:
the window server; the window manager and the user interface toolkit. The
window server is standard and is usually the X Window System 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 X(1) and the documentation for
Xlib.
The primary function of the window manager 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 user interface toolkit 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 are currently many
of these toolkits available for X. Motif, OpenLook, 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.
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: User Guide - Introduction</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

578
docs/chap2.html Normal file
View File

@@ -0,0 +1,578 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: User Guide - Windows</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
<div class="document" id="windows">
<h1 class="title">Windows</h1>
<div class="section" id="anatomy-of-a-window">
<h1>Anatomy of a Window</h1>
<p>Generally an application will have the following layout:</p>
<div class="borderless figure">
<img alt="Anatomy of a Window" src="guide/images/anatomy.gif">
</div>
<dl class="simple">
<dt>Titlebar</dt>
<dd>
<p>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.</p>
</dd>
<dt>Miniaturize button</dt>
<dd>
<p>You can click on the miniaturize button to miniaturize/iconify a window or
click it with the <strong>Meta</strong> key pressed to hide the application.</p>
</dd>
<dt>Close Button</dt>
<dd>
<p>The close button can be used to close a window or kill the application, if
the application can't understand the close message.</p>
</dd>
<dt>Resizebar</dt>
<dd>
<p>You use the resizebar to (surprise!) resize a window.</p>
</dd>
<dt>Client Area</dt>
<dd>
<p>The client area is where the application show it's information. If the
window if inactive, you can click on it to activate it.</p>
</dd>
</dl>
</div>
<div class="section" id="working-with-windows">
<h1>Working With Windows</h1>
<div class="section" id="focusing-a-window">
<h2>Focusing a Window</h2>
<p>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 black titlebar and is the window
that receives keyboard input, ie: where you can type text. 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. Some applications have a special type of
window, called dialog windows transient windows or panels. When these windows
are active, 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.</p>
<p>The image below shows an active Open File panel and it's owner window.</p>
<div class="borderless figure">
<img alt="Focused, Unfocused, and Parent Window" src="guide/images/focus.gif">
</div>
<p>There are three styles of window focusing:</p>
<p><strong>Click-to-Focus</strong>, or manual focus mode. In click-to-focus mode, you
explicitly choose the window that should be focused. This is the default mode.</p>
<p><strong>Focus-Follow-Mouse</strong>, 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.</p>
<p><strong>Sloppy-Focus</strong>, or semi-auto-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.</p>
<p>You can choose between these modes with the <em>FocusMode</em> option.</p>
<p>To focus a window in <strong>Click-To-Focus</strong> mode:</p>
<ul class="simple">
<li><p>Click on the titlebar, resizebar or in the client area of the window with the
left or right mouse button.</p></li>
</ul>
<p>OR</p>
<ul class="simple">
<li><p>Click on the titlebar with the middle mouse button. This will focus the
window without bringing it to the front.</p></li>
</ul>
<p>OR</p>
<ul class="simple">
<li><p>Open the window list menu and select the window to focus.</p></li>
</ul>
<p>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
<em>IgnoreFocusClick</em> option.</p>
<p>To focus a window in <strong>Focus-Follow-Mouse</strong> mode:</p>
<ul class="simple">
<li><p>Move the pointer over the window you want to focus.</p></li>
</ul>
</div>
<div class="section" id="reordering-overlapping-windows">
<h2>Reordering Overlapping Windows</h2>
<p>Windows can overlap other windows, making some windows be over or in front of
others.</p>
<p>To bring a window to the front:</p>
<ul class="simple">
<li><p>Click on the titlebar or resizebar of the desired window with the left mouse
button.</p></li>
</ul>
<p>OR</p>
<ul class="simple">
<li><p>Select the desired window from the Window List menu.</p></li>
</ul>
<p>Dialog/transient windows are always placed over their owner windows, unless the
<em>OnTopTransients</em> 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 <em>AlwaysOnTop</em> window option or set it in
the Window Inspector panel.</p>
<p><strong>Extra Bindings</strong></p>
<table>
<colgroup>
<col style="width: 49%">
<col style="width: 51%">
</colgroup>
<thead>
<tr>
<th class="head"><p>Action</p></th>
<th class="head"><p>Effect</p></th>
</tr>
</thead>
<tbody>
<tr>
<td><p>Meta-Click on the window titlebar,
with the left mouse button</p></td>
<td><p>Sends the window to the
back.</p></td>
</tr>
<tr>
<td><p>Meta-Click on the Client Area of
the window with the left mouse
button.</p></td>
<td><p>Brings the window to the front and
focuses it.</p></td>
</tr>
<tr>
<td><p>Hold the Meta key and press the Up
Arrow key</p></td>
<td><p>Brings the current focused window to
the front.</p></td>
</tr>
<tr>
<td><p>Hold the Meta key and press the
Down Arrow key</p></td>
<td><p>Sends the current focused window to
the back.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="moving-a-window">
<h2>Moving a Window</h2>
<p>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.</p>
<p>To move a window:</p>
<ul class="simple">
<li><p>Click on the titlebar of the window you want to move with the left mouse
button and drag it with the button pressed.</p></li>
</ul>
<p>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 Shift
key during the move operation.</p>
<p>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 <em>DontMoveOff</em> window attribute.</p>
<p><strong>Extra Bindings</strong></p>
<table>
<colgroup>
<col style="width: 49%">
<col style="width: 51%">
</colgroup>
<thead>
<tr>
<th class="head"><p>Action</p></th>
<th class="head"><p>Effect</p></th>
</tr>
</thead>
<tbody>
<tr>
<td><p>Drag the titlebar with the middle
mouse button</p></td>
<td><p>Move the window without changing it's
stacking order.</p></td>
</tr>
<tr>
<td><p>Drag the titlebar while holding the
Control key</p></td>
<td><p>Move the window without focusing it.</p></td>
</tr>
<tr>
<td><p>Drag the client area or resizebar
while holding the Meta key</p></td>
<td><p>Move the window.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="resizing-a-window">
<h2>Resizing a Window</h2>
<p>The size of a window can be adjusted by dragging the resizebar.</p>
<div class="borderless figure">
<img alt="A Resizebar" src="guide/images/resizebar.gif">
</div>
<p>Depending on the place you click to drag the resizebar, the resize operation is
constrained to a direction.</p>
<p>To resize a window:</p>
<ul class="simple">
<li><p>To change the window's height, click in the middle region of the resizebar
and drag it vertically.</p></li>
<li><p>To change the window's width, click in either end regions of the resizebar
and drag it horizontally.</p></li>
<li><p>To change both height and width at the same time, click in either end regions
of the resizebar and drag it diagonally.</p></li>
</ul>
<p><strong>Extra Bindings</strong></p>
<table>
<colgroup>
<col style="width: 50%">
<col style="width: 50%">
</colgroup>
<thead>
<tr>
<th class="head"><p>Action</p></th>
<th class="head"><p>Effect</p></th>
</tr>
</thead>
<tbody>
<tr>
<td><p>Drag the window in the client area
with the Right mouse button, while
holding the Meta key</p></td>
<td><p>Resizes the window.</p></td>
</tr>
<tr>
<td><p>Drag the resizebar with the middle
mouse button</p></td>
<td><p>Resize the window without bringing
it to the front</p></td>
</tr>
<tr>
<td><p>Drag the resizebar while holding
the Control key</p></td>
<td><p>Resize the window without focusing
it.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="miniaturizing-a-window">
<h2>Miniaturizing a Window</h2>
<p>If you want to temporarily get rid of a window, you can miniaturize it.</p>
<div class="borderless figure">
<img alt="A Titlebar" src="guide/images/title.gif">
</div>
<p>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.</p>
<div class="borderless figure">
<img alt="A Mini-window" src="guide/images/mini.gif">
<p class="caption">A mini-window</p>
</div>
<p>You can move the miniwindow around the screen by dragging it. Unlike
application icons, miniwindows cannot be docked.</p>
<p>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.</p>
<p>To miniaturize a window:</p>
<ul class="simple">
<li><p>Click on the miniaturize button</p></li>
</ul>
<p>OR</p>
<ul class="simple">
<li><p>Use the keyboard shortcut assigned to this action, Meta+m in the default
configuration.</p></li>
</ul>
<p>You can also restore all miniaturized and hidden windows of a given application
by double clicking in it's application icon with the middle mouse button.</p>
</div>
<div class="section" id="shading-a-window">
<h2>Shading a Window</h2>
<p>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.</p>
<p>To shade a window:</p>
<ul class="simple">
<li><p>Double Click on the titlebar of the window.</p></li>
</ul>
<div class="borderless figure">
<img alt="A Shaded window" src="guide/images/shade.gif">
</div>
</div>
<div class="section" id="closing-a-window">
<h2>Closing a Window</h2>
<p>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.</p>
<div class="borderless figure">
<img alt="A Titlebar with a close button" src="guide/images/imagtitle2.gif">
</div>
<p>Some windows will have a close button with some dots around it. These windows
can't be closed normally and the only way to get rid of them is by exiting the
application. You should try exiting from inside the application (through it's
menus or buttons) when possible. Otherwise you can force WindowMaker to
<span class="docutils literal">kill</span> the application.</p>
<p>To force the closure of a window (by killing the application):</p>
<ul class="simple">
<li><p>Hold the Control key and click on the close button.</p></li>
</ul>
<p>OR</p>
<ul class="simple">
<li><p>Double click the close button.</p></li>
</ul>
<p>It is also possible to kill applications that can be normally closed by
clicking the close button while holding the Control key.</p>
</div>
<div class="section" id="maximizing-a-window">
<h2>Maximizing a Window</h2>
<p>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.</p>
<p>To maximize a window:</p>
<ul class="simple">
<li><p>Hold the Control key and double click on the window titlebar to resize the
window's height to full screen.</p></li>
</ul>
<p>OR</p>
<ul class="simple">
<li><p>Hold the Shift key and double click on the window titlebar to resize the
window's width to full screen.</p></li>
</ul>
<p>OR</p>
<ul class="simple">
<li><p>Hold both the Control and Shift keys and double click on the window titlebar
to resize both window's height and width to full screen.</p></li>
</ul>
<p>To restore the size of a maximized window:</p>
<ul class="simple">
<li><p>Hold the Control OR Shift key and double click on the window titlebar.</p></li>
</ul>
<p>You can select whether the window should be maximized to the whole screen or if
the position of the Dock should be accounted for by setting the <em>WinDock</em>
option.</p>
</div>
<div class="section" id="the-window-commands-menu">
<h2>The Window Commands Menu</h2>
<p>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 Control+Escape key, by default.</p>
<dl class="simple">
<dt>(Un)Maximize</dt>
<dd>
<p>Will either maximize the window horizontally and vertically, or, if the
window is already maximized, restore the window to the size it was prior to
being maximized.</p>
</dd>
<dt>Miniaturize</dt>
<dd>
<p>Will miniaturize the window.</p>
</dd>
<dt>(Un)Shade</dt>
<dd>
<p>Will shade the window, or unshade it if it is already shaded.</p>
</dd>
<dt>Hide</dt>
<dd>
<p>Will hide all the windows of the application</p>
</dd>
<dt>Hide Others</dt>
<dd>
<p>Will hide all current applications except the current one</p>
</dd>
<dt>Move To</dt>
<dd>
<p>Allows you to move the window to a different workspace</p>
</dd>
<dt>Attributes...</dt>
<dd>
<p>Opens the Window Attributes Inspector (see section <cite>2.3 &lt;#2.3&gt;</cite>)</p>
</dd>
<dt>Close</dt>
<dd>
<p>Will close the window</p>
</dd>
<dt>Kill</dt>
<dd>
<p>Will kill the application. Use this option only if the application does not
provide means to close it normally, or in extreme cases.</p>
</dd>
</dl>
</div>
</div>
<div class="section" id="the-window-attributes-inspector">
<h1>The Window Attributes Inspector</h1>
<div class="section" id="window-specification">
<h2>Window Specification</h2>
<p>This panel Allows you to specify the WM_CLASS that WindowMaker should use to
identify the window whose attributes you are setting.</p>
<div class="borderless figure">
<img alt="Window Attributes Inspector: Window Specification" src="guide/images/wiaspec.gif">
</div>
</div>
<div class="section" id="window-attributes">
<h2>Window Attributes</h2>
<p>This panel lets you set the attributes for the selected window.</p>
<div class="borderless figure">
<img alt="Window Attributes Inspector: Window Attributes" src="guide/images/wiaattrib.gif">
</div>
<dl class="simple">
<dt>Disable titlebar</dt>
<dd>
<p>Causes the titlebar for the selected window not to be displayed</p>
</dd>
<dt>Disable resizebar</dt>
<dd>
<p>Causes the resizebar for the selected window not to be displayed</p>
</dd>
<dt>Disable close button</dt>
<dd>
<p>Causes the close button for the selected window not to be displayed</p>
</dd>
<dt>Disable miniaturize button</dt>
<dd>
<p>Causes the miniaturize button for the selected window not to be displayed</p>
</dd>
<dt>Keep on Top</dt>
<dd>
<p>Causes the selected window to stay on top of all other windows</p>
</dd>
<dt>Omnipresent</dt>
<dd>
<p>Causes the selected window to be displayed in all workspaces</p>
</dd>
<dt>Start miniaturized</dt>
<dd>
<p>Causes the selected window to start miniaturized</p>
</dd>
<dt>Skip window list</dt>
<dd>
<p>Causes the select window to be skipped when cycling through the window list.</p>
</dd>
</dl>
</div>
<div class="section" id="advanced-options">
<h2>Advanced Options</h2>
<div class="borderless figure">
<img alt="Window Attributes Inspector: Advanced Options" src="guide/images/wiaadvanced.gif">
</div>
<dl class="simple">
<dt>Ignore HideOthers</dt>
<dd>
<p>Causes the selected window to remain visible when <strong>HideOthers</strong> is selected
from the <a class="reference external" href="#2.2.9">Window Commands Menu</a></p>
</dd>
<dt>Don't bind keyboard shortcuts</dt>
<dd>
<p>Causes the selected window to receive ALL keyboard events</p>
</dd>
<dt>Don't bind mouse clicks</dt>
<dd>
<p>Causes the selected window to receive all mouse-click events</p>
</dd>
<dt>Keep Inside Screen</dt>
<dd>
<p>Causes the selected window not to be able to place itself off the screen</p>
</dd>
<dt>Don't let it take focus</dt>
<dd>
<p>Causes the selected window not to be able to take input focus</p>
</dd>
<dt>Don't Save Session</dt>
<dd>
<p>Causes the state of the selected window not to be saved when a session is
saved. (either when quitting WindowMaker, or when done manually.)</p>
</dd>
<dt>Emulate Application Icon</dt>
<dd>
<p>Emulates an Application Icon for "broken" applications</p>
</dd>
</dl>
</div>
<div class="section" id="icon-and-initial-workspace">
<h2>Icon and Initial Workspace</h2>
<p>This panel allows you to <strong>browse</strong> for, and <strong>update</strong> the <strong>mini-window
image</strong> for the selected window, as well as setting the <strong>initial workspace</strong>.</p>
<div class="borderless figure">
<img alt="Window Attributes Inspector: Icon and Initia Workspace" src="guide/images/wiaiandiw.gif">
</div>
</div>
<div class="section" id="application-specific">
<h2>Application Specific</h2>
<p>Attributes specific to the selected application</p>
<div class="borderless figure">
<img alt="Window Attributes Inspector: Icon and Initia Workspace" src="guide/images/wiaappspec.gif">
</div>
<dl class="simple">
<dt>Start hidden</dt>
<dd>
<p>Starts the selected application in a hidden state</p>
</dd>
<dt>No application icon</dt>
<dd>
<p>Disables the application icon for the selected application</p>
</dd>
</dl>
</div>
</div>
</div>
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: User Guide - Windows</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

539
docs/chap2.rst Normal file
View File

@@ -0,0 +1,539 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: User Guide - Windows</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
Windows
=======
Anatomy of a Window
-------------------
Generally an application will have the following layout:
.. figure:: guide/images/anatomy.gif
:figclass: borderless
:alt: Anatomy of a Window
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.
Miniaturize button
You can click on the miniaturize button to miniaturize/iconify a window or
click it with the **Meta** key pressed to hide the application.
Close Button
The close button can be used to close a window or kill the application, if
the application can't understand the close message.
Resizebar
You use the resizebar to (surprise!) resize a window.
Client Area
The client area is where the application show it's information. If the
window if inactive, you can click on it to activate it.
Working With Windows
--------------------
Focusing a Window
~~~~~~~~~~~~~~~~~
Windows can be in two states: *focused*, or *unfocused.* The focused window
(also called the key or active window) has a black titlebar and is the window
that receives keyboard input, ie: where you can type text. 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. Some applications have a special type of
window, called dialog windows transient windows or panels. When these windows
are active, 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.
The image below shows an active Open File panel and it's owner window.
.. figure:: guide/images/focus.gif
:figclass: borderless
:alt: Focused, Unfocused, and Parent Window
There are three styles of window focusing:
**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.
**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.
**Sloppy-Focus**, or semi-auto-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.
You can choose between these modes with the *FocusMode* option.
To focus a window in **Click-To-Focus** mode:
- Click on the titlebar, resizebar or in the client area of the window with the
left or right mouse button.
OR
- Click on the titlebar with the middle mouse button. This will focus the
window without bringing it to the front.
OR
- Open the window list menu and select the window to focus.
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
*IgnoreFocusClick* option.
To focus a window in **Focus-Follow-Mouse** mode:
- Move the pointer over the window you want to focus.
Reordering Overlapping Windows
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Windows can overlap other windows, making some windows be over or in front of
others.
To bring a window to the front:
- Click on the titlebar or resizebar of the desired window with the left mouse
button.
OR
- Select the desired window from the Window List menu.
Dialog/transient windows are always placed over their owner windows, unless the
*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 *AlwaysOnTop* window option or set it in
the Window Inspector panel.
**Extra Bindings**
+------------------------------------+--------------------------------------+
| Action | Effect |
+====================================+======================================+
| Meta-Click on the window titlebar, | Sends the window to the |
| with the left mouse button | back. |
+------------------------------------+--------------------------------------+
| Meta-Click on the Client Area of | Brings the window to the front and |
| the window with the left mouse | focuses it. |
| button. | |
+------------------------------------+--------------------------------------+
| Hold the Meta key and press the Up | Brings the current focused window to |
| Arrow key | the front. |
+------------------------------------+--------------------------------------+
| Hold the Meta key and press the | Sends the current focused window to |
| Down Arrow key | the back. |
+------------------------------------+--------------------------------------+
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.
To move a window:
- Click on the titlebar of the window you want to move with the left mouse
button and drag it with the button pressed.
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 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* window attribute.
**Extra Bindings**
+-------------------------------------+---------------------------------------+
| Action | Effect |
+=====================================+=======================================+
| Drag the titlebar with the middle | Move the window without changing it's |
| mouse button | stacking order. |
+-------------------------------------+---------------------------------------+
| Drag the titlebar while holding the | Move the window without focusing it. |
| Control key | |
+-------------------------------------+---------------------------------------+
| Drag the client area or resizebar | Move the window. |
| while holding the Meta key | |
+-------------------------------------+---------------------------------------+
Resizing a Window
~~~~~~~~~~~~~~~~~
The size of a window can be adjusted by dragging the resizebar.
.. figure:: guide/images/resizebar.gif
:figclass: borderless
:alt: A Resizebar
Depending on the place you click to drag the resizebar, the resize operation is
constrained to a direction.
To resize a window:
- To change the window's height, click in the middle region of the resizebar
and drag it vertically.
- To change the window's width, click in either end regions of the resizebar
and drag it horizontally.
- To change both height and width at the same time, click in either end regions
of the resizebar and drag it diagonally.
**Extra Bindings**
+------------------------------------+------------------------------------+
| Action | Effect |
+====================================+====================================+
| Drag the window in the client area | Resizes the window. |
| with the Right mouse button, while | |
| holding the Meta key | |
+------------------------------------+------------------------------------+
| Drag the resizebar with the middle | Resize the window without bringing |
| mouse button | it to the front |
+------------------------------------+------------------------------------+
| Drag the resizebar while holding | Resize the window without focusing |
| the Control key | it. |
+------------------------------------+------------------------------------+
Miniaturizing a Window
~~~~~~~~~~~~~~~~~~~~~~
If you want to temporarily get rid of a window, you can miniaturize it.
.. figure:: guide/images/title.gif
:figclass: borderless
:alt: A Titlebar
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.
.. figure:: guide/images/mini.gif
:figclass: borderless
:alt: A Mini-window
A mini-window
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.
To miniaturize a window:
- Click on the miniaturize button
OR
- Use the keyboard shortcut assigned to this action, Meta+m in the default
configuration.
You can also restore all miniaturized and hidden windows of a given application
by double clicking in it's application icon with the middle mouse button.
Shading a Window
~~~~~~~~~~~~~~~~
If you want to temporarily get rid of a window, an option for it's
miniaturization is to *shade* 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.
To shade a window:
- Double Click on the titlebar of the window.
.. figure:: guide/images/shade.gif
:figclass: borderless
:alt: A Shaded window
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.
.. figure:: guide/images/imagtitle2.gif
:figclass: borderless
:alt: A Titlebar with a close button
Some windows will have a close button with some dots around it. These windows
can't be closed normally and the only way to get rid of them is by exiting the
application. You should try exiting from inside the application (through it's
menus or buttons) when possible. Otherwise you can force WindowMaker to
``kill`` the application.
To force the closure of a window (by killing the application):
- Hold the Control key and click on the close button.
OR
- Double click the close button.
It is also possible to kill applications that can be normally closed by
clicking the close button while holding the Control key.
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.
To maximize a window:
- Hold the Control key and double click on the window titlebar to resize the
window's height to full screen.
OR
- Hold the Shift key and double click on the window titlebar to resize the
window's width to full screen.
OR
- Hold both the Control and Shift keys and double click on the window titlebar
to resize both window's height and width to full screen.
To restore the size of a maximized window:
- Hold the Control OR Shift key and double click on the window titlebar.
You can select whether the window should be maximized to the whole screen or if
the position of the Dock should be accounted for by setting the *WinDock*
option.
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 Control+Escape key, by default.
(Un)Maximize
Will either maximize the window horizontally and vertically, or, if the
window is already maximized, restore the window to the size it was prior to
being maximized.
Miniaturize
Will miniaturize the window.
(Un)Shade
Will shade the window, or unshade it if it is already shaded.
Hide
Will hide all the windows of the application
Hide Others
Will hide all current applications except the current one
Move To
Allows you to move the window to a different workspace
Attributes...
Opens the Window Attributes Inspector (see section `2.3 <#2.3>`)
Close
Will close the window
Kill
Will kill the application. Use this option only if the application does not
provide means to close it normally, or in extreme cases.
The Window Attributes Inspector
-------------------------------
Window Specification
~~~~~~~~~~~~~~~~~~~~
This panel Allows you to specify the WM_CLASS that WindowMaker should use to
identify the window whose attributes you are setting.
.. figure:: guide/images/wiaspec.gif
:figclass: borderless
:alt: Window Attributes Inspector: Window Specification
Window Attributes
~~~~~~~~~~~~~~~~~~
This panel lets you set the attributes for the selected window.
.. figure:: guide/images/wiaattrib.gif
:figclass: borderless
:alt: Window Attributes Inspector: Window Attributes
Disable titlebar
Causes the titlebar for the selected window not to be displayed
Disable resizebar
Causes the resizebar for the selected window not to be displayed
Disable close button
Causes the close button for the selected window not to be displayed
Disable miniaturize button
Causes the miniaturize button for the selected window not to be displayed
Keep on Top
Causes the selected window to stay on top of all other windows
Omnipresent
Causes the selected window to be displayed in all workspaces
Start miniaturized
Causes the selected window to start miniaturized
Skip window list
Causes the select window to be skipped when cycling through the window list.
Advanced Options
~~~~~~~~~~~~~~~~
.. figure:: guide/images/wiaadvanced.gif
:figclass: borderless
:alt: Window Attributes Inspector: Advanced Options
Ignore HideOthers
Causes the selected window to remain visible when **HideOthers** is selected
from the `Window Commands Menu <#2.2.9>`_
Don't bind keyboard shortcuts
Causes the selected window to receive ALL keyboard events
Don't bind mouse clicks
Causes the selected window to receive all mouse-click events
Keep Inside Screen
Causes the selected window not to be able to place itself off the screen
Don't let it take focus
Causes the selected window not to be able to take input focus
Don't Save Session
Causes the state of the selected window not to be saved when a session is
saved. (either when quitting WindowMaker, or when done manually.)
Emulate Application Icon
Emulates an Application Icon for "broken" applications
Icon and Initial Workspace
~~~~~~~~~~~~~~~~~~~~~~~~~~
This panel allows you to **browse** for, and **update** the **mini-window
image** for the selected window, as well as setting the **initial workspace**.
.. figure:: guide/images/wiaiandiw.gif
:figclass: borderless
:alt: Window Attributes Inspector: Icon and Initia Workspace
Application Specific
~~~~~~~~~~~~~~~~~~~~
Attributes specific to the selected application
.. figure:: guide/images/wiaappspec.gif
:figclass: borderless
:alt: Window Attributes Inspector: Icon and Initia Workspace
Start hidden
Starts the selected application in a hidden state
No application icon
Disables the application icon for the selected application
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: User Guide - Windows</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

370
docs/chap3.html Normal file
View File

@@ -0,0 +1,370 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: User Guide - Workspace</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
<div class="document" id="the-workspace">
<h1 class="title">The Workspace</h1>
<div class="section" id="working-with-menus">
<h1>Working with Menus</h1>
<p>Menus provide a list of commands that you can execute.</p>
<div class="borderless figure">
<img alt="An Example Menu" src="guide/images/menu.gif">
</div>
<p>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.</p>
<p>Grayed commands are disabled and cannot be executed at that moment. If you
click on them nothing will happen.</p>
<p>Some menu entries have a little triangular indicator at the right. Selecting
these entries will open a submenu, with a new list of commands.</p>
<p>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 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
Return. To close the menu or stop menu traversal, press Escape. Additionally,
pressing the first letter for an menu item, will jump the current selection to
that item.</p>
<p>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.</p>
<p>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 Meta key. Repeat this to make the
menus not obscurable again.</p>
<div class="section" id="the-root-window-menu">
<h2>The Root Window Menu</h2>
<p>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.</p>
<p>To open this menu, click on the workspace (root window) with the 3rd mouse
button or hit the key bound to it (F12 by default).</p>
<p>The contents of the applications menu can be configured to hold the
applications installed on your system. To learn how to configure it, read the
section on application menu configuration.</p>
</div>
<div class="section" id="the-window-list-menu">
<h2>The Window List Menu</h2>
<p>Clicking in the workspace with the middle mouse button will open a menu listing
all windows that currently exist, with the workspace in which the window is
located to its right. The current focused window is marked by a diamond sign
next to its name. Clicking in an entry in this menu will focus the window,
raise it, and change to the workspace where it is located.</p>
</div>
</div>
<div class="section" id="working-with-applications">
<h1>Working with Applications</h1>
<p>In WindowMaker the instance of a running application is represented by an
application icon. Do not confuse it with the icons (miniwindows in WindowMaker)
displayed by other window managers when a window is iconified. Application
icons and miniwindows can be differentiated in that miniwindows have titlebars,
application icons do not.</p>
<p>WindowMaker 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
<strong>WM.CLASS</strong>, <strong>WM.COMMAND</strong>, and <strong>WM.CLIENT.LEADER</strong> or the group leader in
<strong>WM.HINTS</strong>.</p>
<p>Note: The information about applications contained in this section only applies
to versions of WindowMaker built without the --enable-single-icon compile time
option. This option is unsupported and behaviour when it's enabled will not be
covered in this text.</p>
<div class="section" id="hiding-an-application">
<h2>Hiding an Application</h2>
<p>If you want to close and 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 hidden into its
application icon.</p>
<p>To hide an application:</p>
<ul class="simple">
<li><p>Click the miniaturize button of any of the windows that belong to the
application while holding the Control key.</p></li>
</ul>
<p>OR</p>
<ul class="simple">
<li><p>Press the keyboard shortcut assigned to it, which is Meta+h in the default
configuration.</p></li>
</ul>
<p>OR</p>
<ul class="simple">
<li><p>User the hide command in the <a class="reference external" href="chap2.html#the-window-commands-menu">window commands menu</a> brought up when the window titlebar
is clicked with the right mouse button.</p></li>
</ul>
<p>OR</p>
<ul class="simple">
<li><p>Use the (Un)Hide command in the application icon commands menu brought up
when the application icon is clicked with the right mouse button.</p></li>
</ul>
<p>To unhide an application</p>
<ul class="simple">
<li><p>Double click the application icon with the left mouse button.</p></li>
</ul>
<p>OR</p>
<ul class="simple">
<li><p>Use the (Un)Hide command in the application icon commands menu brought up
when the application icon is clicked with the right mouse button.</p></li>
</ul>
<p>When you unhide an application, all it's windows and miniwindows will brought
back, and you will be taken to the last workspace in which you worked with that
application.</p>
<p><strong>Extra Bindings</strong></p>
<table>
<colgroup>
<col style="width: 49%">
<col style="width: 51%">
</colgroup>
<thead>
<tr>
<th class="head"><p>Action</p></th>
<th class="head"><p>Effect</p></th>
</tr>
</thead>
<tbody>
<tr>
<td><p>Double-click the application icon
while holding the Meta key</p></td>
<td><p>Unhide the clicked application,
and hide all other applications
that are present in the current
workspace.</p></td>
</tr>
<tr>
<td><p>Double-click the application icon
while holding the Shift key</p></td>
<td><p>Unhide the clicked application in
the current workspace</p></td>
</tr>
<tr>
<td><p>Double-click the application icon
with the middle mouse button</p></td>
<td><p>Unhide the clicked application and
deminiaturize all its windows.</p></td>
</tr>
<tr>
<td><p>Double-click the window titlebar
with the right mouse button while
holding the Meta key.</p></td>
<td><p>Hide all applications in the
current workspace except for the
clicked one.</p></td>
</tr>
</tbody>
</table>
<p>There are two other commands in the applications menu related to application
hiding:</p>
<dl class="simple">
<dt>Hide others</dt>
<dd>
<p>Hide all applications in the current workspace, except for the currently
active one.</p>
</dd>
<dt>Show All</dt>
<dd>
<p>Unhide all applications that were hidden from the current workspace</p>
</dd>
</dl>
</div>
<div class="section" id="the-application-icon-menu">
<h2>The Application Icon Menu</h2>
<p>A menu with commands that will apply to the application can be brought up by
clicking the application icon with the right mouse button.</p>
<p>The commands available in this menu are:</p>
<dl class="simple">
<dt>Unhide Here</dt>
<dd>
<p>Unhides the application in the current workspace.</p>
</dd>
<dt>(Un)Hide</dt>
<dd>
<p>Hides the application. Unless the application is already hidden, in which
case it will unhide the application and take you to its workspace.</p>
</dd>
<dt>Set Icon...</dt>
<dd>
<p>Opens the icon image selection panel for the application icon.</p>
</dd>
<dt>Kill</dt>
<dd>
<p>Will kill the application.</p>
</dd>
</dl>
</div>
<div class="section" id="the-application-dock">
<h2>The Application Dock</h2>
<p>The application dock is a place where you can store frequently used
applications for easy and fast access. It is located, by default, on the right
side of the screen.</p>
<p>You can click 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 sideways to move
the entire dock from side of the screen to the other.</p>
<p>A menu similar to the <a class="reference external" href="#the-application-icon-menu">application icon menu</a> is
brought up when you click a docked icon with the right mouse button.</p>
<p>To make the dock <em>float</em> over windows (not be coverable by windows), either
double-click the top dock icon while holding the Meta key, or select the
"Floating Dock" option in the dock menu.</p>
<div class="section" id="starting-a-docked-application">
<h3>Starting a docked application</h3>
<p>To start an application that is docked, double-click its icon. The icon will be
briefly highlighted and the application will start.</p>
<p>While an application is not running an ellipsis is present in the lower
left-hand corner of the icon. This ellipsis will disappear when the application
is started and reappear when the application is exited.</p>
<p>While the application is running the docked icon will behave just like a
normal, undocked application icon, except for some extra actions specific to
the dock.</p>
<p>To start a docked application:</p>
<ul class="simple">
<li><p>Double-click the application icon with the left mouse button.</p></li>
</ul>
<p>OR</p>
<ul class="simple">
<li><p>Use the "Launch" command in the dock menu for the icon. If the application is
already running it will start another instance.</p></li>
</ul>
<p>OR</p>
<ul class="simple">
<li><p>Hold the Control key while double-clicking the icon to start another instance
of the application.</p></li>
</ul>
<p>If a new instance of an already running application is started it will get a
new application icon.</p>
</div>
<div class="section" id="customizing-the-dock">
<h3>Customizing the dock</h3>
<p>To add new applications to the dock, you can click an application icon and drag
it onto the dock. When a ghost image of the icon appears you can release the
mouse button and the icon will be docked.</p>
<p>To reorder the docked applications, drag an icon to an empty slot and move the
icons around as you want.</p>
<p>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 Meta key while dragging it.</p>
</div>
<div class="section" id="configuring-the-docked-application">
<h3>Configuring the docked application</h3>
<p>To change the settings of a docked application, select the "Settings..." item
in the dock menu for that icon. A settings panel for that icon will appear.</p>
<div class="borderless figure">
<img alt="Docked Application Settings Panel" src="guide/images/dockapppanel.gif">
</div>
<p>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 <span class="docutils literal">xterm</span> you can't change
the field's value to <strong>ghostview</strong>; or if the icon is for <span class="docutils literal">xterm <span class="pre">-name</span> vi</span>,
you can't change it to <span class="docutils literal">xterm <span class="pre">-name</span> pine</span>. Also note that you cannot use
shell commands, such as output redirectors. (<span class="docutils literal">&gt;</span>, <span class="docutils literal">&gt;&gt;</span>; etc.)</p>
</div>
</div>
</div>
<div class="section" id="working-with-workspaces">
<h1>Working with Workspaces</h1>
<div class="section" id="the-workspaces-menu">
<h2>The Workspaces Menu</h2>
<p>The <em>Workspaces Menu</em> allows you to create, switch, destroy and rename
workspaces.</p>
<p>It has the following items:</p>
<dl class="simple">
<dt>New</dt>
<dd>
<p>Creates a new workspace and automatically switches to it</p>
</dd>
<dt>Destroy Last</dt>
<dd>
<p>Destroys the last workspace unless it is occupied</p>
</dd>
<dt>Workspaces</dt>
<dd>
<p>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.</p>
</dd>
</dl>
<p>The current active workspace is indicated by a small indicator at the left of
the workspace item.</p>
<div class="borderless figure">
<img alt="Workspace Menu" src="guide/images/wsmenu.gif">
</div>
<p>To change the name of a workspace you must first "stick" the menu. Then 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 Return; to cancel it, press Escape.</p>
<p>There is a limit of 16 characters on the length of the workspace name.</p>
<p>An example Workspace menu being edited:</p>
<div class="borderless figure">
<img alt="Workspace Menu: Editing a Workspace name" src="guide/images/wsmenued.gif">
</div>
</div>
<div class="section" id="the-workspace-clip">
<h2>The workspace clip</h2>
<!-- WTF is that?? -->
<p>[This section was unavailable in the original, and thus is not here]</p>
</div>
</div>
</div>
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: User Guide - Workspace</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

387
docs/chap3.rst Normal file
View File

@@ -0,0 +1,387 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: User Guide - Workspace</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
The Workspace
=============
Working with Menus
------------------
Menus provide a list of commands that you can execute.
.. figure:: guide/images/menu.gif
:figclass: borderless
:alt: An Example Menu
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.
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 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
Return. To close the menu or stop menu traversal, press 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 Meta key. Repeat this to make the
menus not obscurable again.
The Root Window Menu
~~~~~~~~~~~~~~~~~~~~
The *Root Window Menu* or *Applications Menu* 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 3rd mouse
button or hit the key bound to it (F12 by default).
The contents of the applications menu can be configured to hold the
applications installed on your system. To learn how to configure it, read the
section on application menu configuration.
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 in which the window is
located to its right. The current focused window is marked by a diamond sign
next to its name. Clicking in an entry in this menu will focus the window,
raise it, and change to the workspace where it is located.
Working with Applications
-------------------------
In WindowMaker the instance of a running application is represented by an
application icon. Do not confuse it with the icons (miniwindows in WindowMaker)
displayed by other window managers when a window is iconified. Application
icons and miniwindows can be differentiated in that miniwindows have titlebars,
application icons do not.
WindowMaker 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
**WM.CLASS**, **WM.COMMAND**, and **WM.CLIENT.LEADER** or the group leader in
**WM.HINTS**.
Note: The information about applications contained in this section only applies
to versions of WindowMaker built without the --enable-single-icon compile time
option. This option is unsupported and behaviour when it's enabled will not be
covered in this text.
Hiding an Application
~~~~~~~~~~~~~~~~~~~~~
If you want to close and application but intend to use it later you can *hide*
it. When you hide an application all windows and miniwindows that belong to
that application will be removed from the screen and hidden into its
application icon.
To hide an application:
- Click the miniaturize button of any of the windows that belong to the
application while holding the Control key.
OR
- Press the keyboard shortcut assigned to it, which is Meta+h in the default
configuration.
OR
- User the hide command in the `window commands menu
<chap2.html#the-window-commands-menu>`_ brought up when the window titlebar
is clicked with the right mouse button.
OR
- Use the (Un)Hide command in the application icon commands menu brought up
when the application icon is clicked with the right mouse button.
To unhide an application
- Double click the application icon with the left mouse button.
OR
- Use the (Un)Hide command in the application icon commands menu brought up
when the application icon is clicked with the right mouse button.
When you unhide an application, all it's windows and miniwindows will brought
back, and you will be taken to the last workspace in which you worked with that
application.
**Extra Bindings**
+-----------------------------------+------------------------------------+
| Action | Effect |
+===================================+====================================+
| Double-click the application icon | Unhide the clicked application, |
| while holding the Meta key | and hide all other applications |
| | that are present in the current |
| | workspace. |
+-----------------------------------+------------------------------------+
| Double-click the application icon | Unhide the clicked application in |
| while holding the Shift key | the current workspace |
+-----------------------------------+------------------------------------+
| Double-click the application icon | Unhide the clicked application and |
| with the middle mouse button | deminiaturize all its windows. |
+-----------------------------------+------------------------------------+
| Double-click the window titlebar | Hide all applications in the |
| with the right mouse button while | current workspace except for the |
| holding the Meta key. | clicked one. |
+-----------------------------------+------------------------------------+
There are two other commands in the applications menu related to application
hiding:
Hide others
Hide all applications in the current workspace, except for the currently
active one.
Show All
Unhide all applications that were hidden from the current workspace
The Application Icon Menu
~~~~~~~~~~~~~~~~~~~~~~~~~
A menu with commands that will apply to the application can be brought up by
clicking the application icon with the right mouse button.
The commands available in this menu are:
Unhide Here
Unhides the application in the current workspace.
(Un)Hide
Hides the application. Unless the application is already hidden, in which
case it will unhide the application and take you to its workspace.
Set Icon...
Opens the icon image selection panel for the application icon.
Kill
Will kill the application.
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, on the right
side of the screen.
You can click 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 sideways to move
the entire dock from side of the screen to the other.
A menu similar to the `application icon menu <#the-application-icon-menu>`_ is
brought up when you click a docked icon with the right mouse button.
To make the dock *float* over windows (not be coverable by windows), either
double-click the top dock icon while holding the Meta key, or select the
"Floating Dock" option in the dock menu.
Starting a docked application
.............................
To start an application that is docked, double-click its icon. The icon will be
briefly highlighted and the application will start.
While an application is not running an ellipsis is present in the lower
left-hand corner of the icon. This ellipsis will disappear when the application
is started and reappear when the application is exited.
While the application is running the docked icon will behave just like a
normal, undocked application icon, except for some extra actions specific to
the dock.
To start a docked application:
- Double-click the application icon with the left mouse button.
OR
- Use the "Launch" command in the dock menu for the icon. If the application is
already running it will start another instance.
OR
- Hold the Control key while double-clicking the icon to start another instance
of the application.
If a new instance of an already running application is started it will get a
new application icon.
Customizing the dock
....................
To add new applications to the dock, you can click an application icon and drag
it onto the dock. When a ghost image of the icon appears you can 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 Meta key while dragging it.
Configuring the docked application
..................................
To change the settings of a docked application, select the "Settings..." item
in the dock menu for that icon. A settings panel for that icon will appear.
.. figure:: guide/images/dockapppanel.gif
:figclass: borderless
:alt: Docked Application Settings Panel
In the *Application path and arguments* 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 ``xterm`` you can't change
the field's value to **ghostview**; or if the icon is for ``xterm -name vi``,
you can't change it to ``xterm -name pine``. Also note that you cannot use
shell commands, such as output redirectors. (``>``, ``>>``; etc.)
Working with Workspaces
-----------------------
The Workspaces Menu
~~~~~~~~~~~~~~~~~~~~
The *Workspaces Menu* allows you to create, switch, destroy and rename
workspaces.
It has the following items:
New
Creates a new workspace and automatically switches to it
Destroy Last
Destroys the last workspace unless it is occupied
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.
.. figure:: guide/images/wsmenu.gif
:figclass: borderless
:alt: Workspace Menu
To change the name of a workspace you must first "stick" the menu. Then 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 Return; to cancel it, press Escape.
There is a limit of 16 characters on the length of the workspace name.
An example Workspace menu being edited:
.. figure:: guide/images/wsmenued.gif
:figclass: borderless
:alt: Workspace Menu: Editing a Workspace name
The workspace clip
~~~~~~~~~~~~~~~~~~~
.. WTF is that??
[This section was unavailable in the original, and thus is not here]
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: User Guide - Workspace</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

1271
docs/chap4.html Normal file

File diff suppressed because it is too large Load Diff

843
docs/chap4.rst Normal file
View File

@@ -0,0 +1,843 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: User Guide - Configuration</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
Configuring Window Maker
========================
.. contents::
:backlinks: none
:local:
The Defaults System
-------------------
WindowMaker 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
*property lists* in the $(HOME)/GNUstep/Defaults directory. Each file in the
$(HOME)/GNUstep/Defaults directory contains data that belongs to a specific
*domain*.
Any application can use the defaults database to store its information.
Generally an application will have one or more *domains* that belong to it.
Property list File Format
~~~~~~~~~~~~~~~~~~~~~~~~~
The syntax of the property list is simple, but, if you need to change it
manually you must take care not to leave any syntax errors.
The EBNF for the property list is the following:
**Description of the syntax of a property list in the Bacchus Naur Form (BNF)**
.. code::
:class: highlight
<object> ::= <string> | <data> | <array> | <dictionary>
<string> ::= text with non-alphanumeric characters | alphanumeric text
<array> ::= `(' [ <object> { `,' <object> }* ] `)'
<dictionary> ::= `{' [ <keyval_pair> { `,' <keyval_pair> }* ] `}'
<keyval_pair> ::= <string> `=' <object> `;'
**Example property list file**
.. code::
:class: highlight
{
"*" = {
Icon = "defaultAppIcon.xpm";
};
"xterm.XTerm" = {
Icon = "xterm.xpm";
};
xconsole = {
Omnipresent = YES;
NoTitlebar = YES;
KeepOnTop = NO;
};
}
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.
Here is another example:
.. code::
:class: highlight
{
FTitleBack = ( hgradient, gray, "#112233" );
}
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.
Value Types
~~~~~~~~~~~
Here is a description of some of the types of values that an option might have:
+------------------+--------------------------------------------+
| Type | Value |
+==================+============================================+
| boolean | YES or NO |
+------------------+--------------------------------------------+
| integer | any integer number, usually limited |
| | by a range that will be indicated |
+------------------+--------------------------------------------+
| positive integer | any integer number greater than or |
| | equal to zero (0) a |
+------------------+--------------------------------------------+
| speed | UltraFast, Fast, Medium, Slow, or VerySlow |
+------------------+--------------------------------------------+
| mouse button | Left, Middle, Right, Button1, Button2, |
| | Button3, Button4, or Button5 |
+------------------+--------------------------------------------+
Preferences
~~~~~~~~~~~
General preference options are stored in the *WindowMaker* domain; i.e. the
$(HOME)/GNUstep/Defaults/WindowMaker file.
Changes in preference options will automatically affect the current WindowMaker
session, without a restart. Some options, however, require a restart of
WindowMaker before they take effect. Such options are marked with a * .
Note that values marked as *Default* are values that are assumed if the option
is not specified, instead of *factory default* values that are set in the
preference file.
.. TODO there is no point for describing all of the options. There is a lot of
them added, some of the changed and possibly removed. Let's treat them as
the advanced configuration and point to the right sources, where one can
easily figure out which options take which values
+----------------------------+---------------------+--------------------------------------+
| Option | Value | Description |
+============================+=====================+======================================+
| PixmapPath | list of directories | A list of directories where pixmaps |
| | separated by ":" | can be found. The pixmaps for things |
| | (default: depends | like icons, are searched in these |
| | on the system) | paths in order of appearance. |
+----------------------------+---------------------+--------------------------------------+
| `*NoDithering` | boolean | Disable internal dithering of |
| | (default: NO) | images. Not recommended for displays |
| | | with less than 8 bits per pixel. |
+----------------------------+---------------------+--------------------------------------+
| `*ColormapSize` | integer number > 1 | Number of colors for each of the |
| | (default: 4) | 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. |
+----------------------------+---------------------+--------------------------------------+
| `*ModifierKey` | modifier key name | The key to use as the modifier being |
| | (default: Mod1) | referred as Meta in this manual, |
| | | like Meta dragging a window to move |
| | | it. Valid values are Alt, Meta, |
| | | Super, Hyper, Mod1, Mod2, Mod3, |
| | | Mod4, Mod5. |
+----------------------------+---------------------+--------------------------------------+
| UseSaveUnders | boolean | Use *saveunders* in WindowMaker |
| | (default: NO) | windows. This can improve |
| | | performance but increases memory |
| | | usage. It also can cause problems |
| | | with refreshing in some |
| | | applications. |
+----------------------------+---------------------+--------------------------------------+
| DisableClip | boolean | Will remove the application Clip |
| | (default: NO) | from the workspace. |
+----------------------------+---------------------+--------------------------------------+
| DisableDock | boolean | Will remove the application Dock |
| | (default: NO) | from the workspace |
+----------------------------+---------------------+--------------------------------------+
| Superfluous | boolean | Enable extra animations and other |
| | (default: NO) | cosmetic things that might increase |
| | | peak memory and CPU usage. |
+----------------------------+---------------------+--------------------------------------+
| SaveSessionOnExit | boolean | Automatically save the state of the |
| | (default: NO) | session when exiting WindowMaker. |
+----------------------------+---------------------+--------------------------------------+
| `*IconSize` | integer > 4 | The size of application icons and |
| | (default: 64) | miniwindows. |
+----------------------------+---------------------+--------------------------------------+
| OpaqueMove | boolean | Whether the whole window should be |
| | (default: NO) | moved while dragging it, or, if only |
| | | it's frame should be dragged. |
+----------------------------+---------------------+--------------------------------------+
| FocusMode | Manual or | The mode of input focus setting. |
| | ClickToFocus, Auto | Refer to section `Focusing a Window |
| | or | <chap2.html#focusing-a-window>`_ |
| | FocusFollowsMouse, | |
| | SemiAuto or Sloppy | |
| | (default: | |
| | ClickToFocus) | |
| | | |
+----------------------------+---------------------+--------------------------------------+
| IgnoreFocusClick | boolean | Whether the mouse click use to focus |
| | (default: NO) | a window should be ignore or treated |
| | | normally. |
+----------------------------+---------------------+--------------------------------------+
| AutoFocus | boolean | Whether newly created windows should |
| | (default: NO) | receive input focus. Do not confuse |
| | | with FocusMode=Auto. |
+----------------------------+---------------------+--------------------------------------+
| RaiseDelay | integer number | How many tenths of a second to wait |
| | (default: 0) | before raising a window in Auto or |
| | | Semi-Auto focus mode. 0 disables |
| | | this feature. |
+----------------------------+---------------------+--------------------------------------+
| DoubleClickTime | integer number | If two mouse clicks occur in this |
| | (default: 250) | interval of time, it will be |
| | | considered a double click. |
+----------------------------+---------------------+--------------------------------------+
| ColorMapMode | Manual or | The mode of colormap setting. In |
| | ClickToFocus, | *Manual* or *ClickToFocus* mode, the |
| | Auto or | colormap is set to the one belonging |
| | FocusFollowsMouse | to the current focused window. In |
| | (default: auto) | *Auto* or *FocusFollowsMouse* mode, |
| | | the colormap is set to the one |
| | | belonging to the window under the |
| | | pointer. |
+----------------------------+---------------------+--------------------------------------+
| CirculateRaise | boolean | Whether the window should be raised |
| | (default: NO) | when circulating. (focus the next or |
| | | previous window through the |
| | | keyboard) |
+----------------------------+---------------------+--------------------------------------+
| OnTopTransients | boolean | Whether transient windows should |
| | (default: NO) | always be placed over their owners |
+----------------------------+---------------------+--------------------------------------+
| WindowPlacement | auto, cascade, | Sets placement mode for new windows. |
| | manual, or | *Auto* places the window |
| | random | automatically in the first open |
| | (default: cascade) | space found in the workspace. |
| | | *Cascade* places the window in |
| | | incrementing positions starting from |
| | | the the top-left corner of the |
| | | workspace. *Manual* allows you to |
| | | place the window interactively with |
| | | the mouse. *Random* paces the window |
| | | randomly in the workspace. |
+----------------------------+---------------------+--------------------------------------+
| WindowPlaceOrigin | (X,Y) where X | Sets the offset, from the top-left |
| | and Y are integer | corner of the screen, to place |
| | numbers | windows. In non-manual |
| | (default: (0,0)) | WindowPlacement modes windows will |
| | | not be placed above or to the left |
| | | of this point. |
+----------------------------+---------------------+--------------------------------------+
| AutoArrangeIcons | boolean | Whether icons should be |
| | (default: NO) | automatically arranged |
+----------------------------+---------------------+--------------------------------------+
| ResizeDisplay | center, corner, | Selects the type or position of the |
| | floating, or | box that shows the window size when |
| | line | a window is being resized. *center* |
| | (default: corner) | places the box in the center of the |
| | | workspace, *corner* places it in the |
| | | top-left corner of the workspace, |
| | | *floating* places it in the center |
| | | of the window being resized and |
| | | *line* draws the current window size |
| | | over the workspace, like in a |
| | | technical drawing. |
+----------------------------+---------------------+--------------------------------------+
| MoveDisplay | center, corner | Selects the type or position of the |
| | or floating | box that shows the window position |
| | (default: corner) | when a window is being moved. The |
| | | value meanings are the same as for |
| | | the ResizeDisplay option. |
+----------------------------+---------------------+--------------------------------------+
| AlignSubmenus | boolean | Whether submenus should be aligned |
| | (default: NO) | vertically with their parent menus. |
+----------------------------+---------------------+--------------------------------------+
| WrapMenus | boolean | Whether submenus should be placed to |
| | (default: NO) | the right of their parent menus when |
| | | they don't fit the screen. Note that |
| | | menus placed off the screen can be |
| | | scrolled. |
+----------------------------+---------------------+--------------------------------------+
| ScrollableMenus | boolean | Whether menus that are not fully |
| | (default: NO) | inside the screen should |
| | | automatically scroll when the |
| | | pointer is over them and near the |
| | | border of the screen. |
+----------------------------+---------------------+--------------------------------------+
| MenuScrollSpeed | speed | The scrolling speed of menus. |
| | (default: medium) | |
+----------------------------+---------------------+--------------------------------------+
| DontLinkWorkspaces | boolean | Do not automatically switch to the |
| | (default: NO) | next or previous workspace when a |
| | | window is dragged to the edge of the |
| | | screen. |
+----------------------------+---------------------+--------------------------------------+
| NoWindowUnderDock | boolean | When maximizing windows, limit their |
| | (default: NO) | sizes so that they will not be |
| | | covered by the dock. |
+----------------------------+---------------------+--------------------------------------+
| NoWindowOverIcons | boolean | When maximizing windows, limit their |
| | (default: NO) | sizes so that they will cover |
| | | miniwindows and application icons. |
+----------------------------+---------------------+--------------------------------------+
| StickyIcons | boolean | Whether miniwindows should be |
| | (default: NO) | present in all workspaces. |
+----------------------------+---------------------+--------------------------------------+
| CycleWorkspaces | boolean | Set to YES if you want windows that |
| | (default: NO) | are dragged past the last workspace |
| | | to be moved to the first workspace, |
| | | and vice-versa. |
+----------------------------+---------------------+--------------------------------------+
| AdvanceToNewWorkspace | boolean | Whether windows dragged past the |
| | (default: NO) | last workspace should create a new |
| | | workspace. |
+----------------------------+---------------------+--------------------------------------+
| DisableAnimations | boolean | Whether animations, like the one |
| | (default: NO) | done during minimization, should be |
| | | disabled. |
+----------------------------+---------------------+--------------------------------------+
| IconSlideSpeed | speed | The speed of icons when they are |
| | (default: medium) | being slid across the workspace. |
+----------------------------+---------------------+--------------------------------------+
| ShadeSpeed | speed | The speed of the shading animation. |
| | (default: medium) | |
+----------------------------+---------------------+--------------------------------------+
| DisableSound | boolean | Whether sound support in WindowMaker |
| | (default: NO) | should be disabled |
+----------------------------+---------------------+--------------------------------------+
| `*DisableWSMouseActions` | boolean | Whether actions in the workspace |
| | (default: NO) | triggered by mouse-clicks should be |
| | | disabled. This allows the use of |
| | | file and desktop managers that place |
| | | icons on the root window (such as |
| | | KDE). |
+----------------------------+---------------------+--------------------------------------+
| SelectWindowMouseButton | mouse button | The mouse button that activates |
| | (default: left) | selection of multiple windows in the |
| | | workspace. |
+----------------------------+---------------------+--------------------------------------+
| WindowListMouseButton | mouse button | The mouse button that opens the |
| | (default: middle) | window list menu in the workspace. |
+----------------------------+---------------------+--------------------------------------+
| ApplicationMenuMouseButton | mouse button | The mouse button that opens the |
| | (default: right) | applications menu in the workspace. |
+----------------------------+---------------------+--------------------------------------+
Appearance Options
~~~~~~~~~~~~~~~~~~
Fonts are specified in the X Logical Font Description format. You can cut and
paste these names from programs like ``xfontsel``.
Colors are specified as color names in the standard X format. This can be any
color name shown by the ``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.
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:
(solid, color)
the texture is a simple solid color.
(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.
(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.
(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.
(mdgradient, color1, color2,...,color*n*)
this is equivalent to drgadient, but you can specify more than two colors
(mhgradient, color1, color2,...,color*n*)
this is equivalent to hrgadient, but you can specify more than two colors
(mvgradient, color1, color2,...,color<i>n</i>)
this is equivalent to vrgadient, but you can specify more than two colors
**Examples**:
.. figure:: guide/images/texsolid.gif
:figclass: borderless
:alt: Solid Color
(solid, gray)
.. figure:: guide/images/texdgrad.gif
:figclass: borderless
:alt: Diagoonal Gradient
(dgradient, gray80, gray20)
.. figure:: guide/images/texhgrad.gif
:figclass: borderless
:alt: Horizontal Gradient
(hgradient, gray80, gray20)
.. figure:: guide/images/texvgrad.gif
:figclass: borderless
:alt: Vertical Gradient
(vgradient, gray80, gray20)
+--------------------+----------------------+----------------------------------------+
| Option | Value | Description |
+====================+======================+========================================+
| `*NewStyle` | boolean | Selects between N*XTSTEP style buttons |
| | (default: NO) | in the titlebar and a newer style of |
| | | buttons. |
+--------------------+----------------------+----------------------------------------+
| WidgetColor | (solid, color) | Chooses the color to be used in |
| | where color is a | titlebar buttons if NewStyle=No; |
| | color name | |
| | (default: | |
| | (solid, grey)) | |
+--------------------+----------------------+----------------------------------------+
| WorkspaceBack | a texture or | Default texture for the workspace |
| | none | background. Note the *dgradient* and |
| | (default: none) | *mdgradient* textures can take a lot |
| | | of time to be rendered. |
+--------------------+----------------------+----------------------------------------+
| IconBack | texture | Texture for the background of icons |
| | (default: | and miniwindows. |
| | (solid, grey)) | |
+--------------------+----------------------+----------------------------------------+
| FTitleBack | texture | Texture for the focused window |
| | (default: | titlebar. |
| | (solid, black)) | |
+--------------------+----------------------+----------------------------------------+
| PTitleBack | texture | Texture for the titlebar of the parent |
| | (default: | window of the currently focused |
| | (solid, "#616161")) | transient window |
+--------------------+----------------------+----------------------------------------+
| UTitleBack | texture | Texture for unfocused window |
| | (default: | titlebars. |
| | (solid, gray)) | |
+--------------------+----------------------+----------------------------------------+
| MenuTitleBack | texture | Texture for menu titlebars. |
| | (default: | |
| | (solid, black)) | |
+--------------------+----------------------+----------------------------------------+
| MenuTextBack | texture | Texture for menu items |
| | (default: | |
| | (solid, gray)) | |
| | | |
+--------------------+----------------------+----------------------------------------+
| FTitleColor | color | The color of the text in the focused |
| | (default: white) | window titlebar. |
+--------------------+----------------------+----------------------------------------+
| PTitleColor | color | Color for the text in the titlebar of |
| | (default: white) | the parent window of the currently |
| | | focused transient. |
+--------------------+----------------------+----------------------------------------+
| UTitleColor | color | The color for the text in the titlebar |
| | (default: black) | of unfocused windows. |
+--------------------+----------------------+----------------------------------------+
| MenuTitleColor | color | Color for the text in menu titlebars |
| | (default: white) | |
+--------------------+----------------------+----------------------------------------+
| MenuTextColor | color | Color for the text in menu items |
| | (default: black) | |
+--------------------+----------------------+----------------------------------------+
| HighlightColor | color | Color for the highlighted item in |
| | (default: white) | menus. |
+--------------------+----------------------+----------------------------------------+
| HighlightTextColor | color | Color for the highlighted item text in |
| | (default: black) | menus. |
+--------------------+----------------------+----------------------------------------+
| MenuDisabledColor | color | Color for the text of disabled menu |
| | (default: "#616161") | items. |
+--------------------+----------------------+----------------------------------------+
| ClipTitleColor | color | Color for the text in the clip. |
| | (default: black) | |
+--------------------+----------------------+----------------------------------------+
| CClipTitleColor | color | Color for the text in the collapsed |
| | (default: "#454045") | clip. |
+--------------------+----------------------+----------------------------------------+
| WindowTitleFont | font (default: | Font for the text in window |
| | Helvetica bold 12) | titlebars. |
+--------------------+----------------------+----------------------------------------+
| MenuTitleFont | font (default: | Font for the text in menu titlebars) |
| | Helvetica bold 12) | |
+--------------------+----------------------+----------------------------------------+
| MenuTextFont | font (default: | Font for the text in menu items |
| | Helvetica medium 12) | |
+--------------------+----------------------+----------------------------------------+
| IconTitleFont | font (default: | Font for the text in miniwindow |
| | Helvetica medium 8) | titlebars. |
+--------------------+----------------------+----------------------------------------+
| ClipTitleFont | font (default: | Font for the text in the clip. |
| | Helvetica bold 10) | |
+--------------------+----------------------+----------------------------------------+
| Displayfont | font (default: | Font for the text information in |
| | Helvetica medium 12) | windows, like the size of windows |
| | | during resize. |
+--------------------+----------------------+----------------------------------------+
| TitleJustify | center, left, | Justification of the text in window |
| | or right | titlebars. |
| | (default: center) | |
+--------------------+----------------------+----------------------------------------+
Keyboard Bindings
~~~~~~~~~~~~~~~~~
Keyboard shortcut specifications are in the form:
.. code::
:class: highlight
[<modifier key names> + ] <key name>
Where *modifier key names* specify an optional modifier key, like Meta or
Shift. Any number of modifier keys might be specified. The *key name* is the
actual key that will trigger the action bound to the option.
Examples:
[F10]
Means the F10 key.
Meta+TAB
Means the TAB key with the Meta modifier key pressed at the same time.
Meta+Shift+TAB
Means the TAB key with the Meta and Shift modifier keys pressed at the same
time.
Key names can be found at /usr/X11R6/include/X11/keysymdef.h The *XK_* prefixes
must be ignored (if key name is *XK_Return* use *Return*).
+-----------------------+---------------+-----------------------------------------+
| Option | Default Value | Description |
+=======================+===============+=========================================+
| RootMenuKey | None | Opens the `root window menu |
| | | <chap3.html#the-root-window-menu>`_ |
| | | at the current position of the |
| | | mouse pointer. |
+-----------------------+---------------+-----------------------------------------+
| WindowListKey | None | Opens the `window list menu`_ |
| | | menu at the current position of the |
| | | mouse pointer. |
+-----------------------+---------------+-----------------------------------------+
| WindowMenuKey | None | Opens the `window commands menu |
| | | <chap2.html#the-window-commands-menu>`_ |
| | | for the currently focused window. |
+-----------------------+---------------+-----------------------------------------+
| MiniaturizeKey | None | Miniaturizes the currently focused |
| | | window. |
+-----------------------+---------------+-----------------------------------------+
| HideKey | None | Hides the currently active |
| | | application. |
+-----------------------+---------------+-----------------------------------------+
| CloseKey | None | Closes the current focused window |
+-----------------------+---------------+-----------------------------------------+
| MaximizeKey | None | Maxmizes the currently focused window. |
+-----------------------+---------------+-----------------------------------------+
| VMaximizeKey | None | Vertically Maximizes the currently |
| | | focused window. |
+-----------------------+---------------+-----------------------------------------+
| RaiseKey | Meta+Up | Raises the currently focused window. |
+-----------------------+---------------+-----------------------------------------+
| LowerKey | Meta+Down | Lowers the currently focused window. |
+-----------------------+---------------+-----------------------------------------+
| RaiseLowerKey | None | Raises the window under the pointer, |
| | | or lowers it if it is already raised. |
+-----------------------+---------------+-----------------------------------------+
| ShadeKey | None | Shades the currently focused window. |
+-----------------------+---------------+-----------------------------------------+
| SelectKey | None | Selects current focused window. |
+-----------------------+---------------+-----------------------------------------+
| FocusNextKey | None | Switch focus to next window. |
+-----------------------+---------------+-----------------------------------------+
| FocusPrevKey | None | Switch focus to previous window. |
+-----------------------+---------------+-----------------------------------------+
| NextWorkspaceKey | None | Switches to next workspace. |
+-----------------------+---------------+-----------------------------------------+
| PrevWorkspaceKey | None | Switches to previous workspace. |
+-----------------------+---------------+-----------------------------------------+
| NextWorkspaceLayerKey | None | Switches to the next group of 10 |
| | | workspaces. |
+-----------------------+---------------+-----------------------------------------+
| PrevWorkspaceLayerKey | None | Switches to the previous group of |
| | | 10 workspaces. |
+-----------------------+---------------+-----------------------------------------+
| Workspace1Key | None | Switches to workspace 1. |
+-----------------------+---------------+-----------------------------------------+
| Workspace2Key | None | Switches to workspace 2, creating |
| | | it if it does not exist. |
+-----------------------+---------------+-----------------------------------------+
| Workspace3Key | None | Switches to workspace 3, creating |
| | | it if it does not exist. |
+-----------------------+---------------+-----------------------------------------+
| Workspace4Key | None | Switches to workspace 4, creating |
| | | it if it does not exist. |
+-----------------------+---------------+-----------------------------------------+
| Workspace5Key | None | Switches to workspace 5, creating |
| | | it if it does not exist. |
+-----------------------+---------------+-----------------------------------------+
| Workspace6Key | None | Switches to workspace 6, creating |
| | | it if it does not exist. |
+-----------------------+---------------+-----------------------------------------+
| Workspace7Key | None | Switches to workspace 7, creating |
| | | it if it does not exist. |
+-----------------------+---------------+-----------------------------------------+
| Workspace8Key | None | Switches to workspace 8, creating |
| | | it if it does not exist. |
+-----------------------+---------------+-----------------------------------------+
| Workspace9Key | None | Switches to workspace 9, creating |
| | | it if it does not exist. |
+-----------------------+---------------+-----------------------------------------+
| | | |
| Workspace10Key | None | Switches to workspace 10, creating |
| | | it if it does not exist. |
+-----------------------+---------------+-----------------------------------------+
| ClipLowerKey | None | Lowers the clip. |
+-----------------------+---------------+-----------------------------------------+
| ClipRaiseLowerKEy | None | Raises the clip, or lowers it if |
| | | it is already raised. |
+-----------------------+---------------+-----------------------------------------+
Window Attributes
~~~~~~~~~~~~~~~~~
Window attributes are stored in the $(HOME)/GNUstep/Defaults/WMWindowAttributes
file.
The contents of this file is a dictionary of attribute dictionaries keyed by
window names. Like this:
.. code::
:class: highlight
{
"*" = {
Icon = "defaultAppIcon.xpm";
};
"xterm.XTerm" = {
Icon = "xterm.xpm";
};
xconsole = {
Omnipresent = YES;
NoTitlebar = YES;
KeepOnTop = NO;
};
}
Window names are in the form [1]_ :
- <window instance name>.<window class name>
OR
- <window instance name>
OR
- <window class name>
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 Icon attribute, it will use the default value, which in the above
example is defaultAppIcon.xpm.
**Options:**
The default is NO for all options
+---------------------+------------------+-------------------------------------+
| Option | Value | Description |
+=====================+==================+=====================================+
| Icon | pixmap file name | Assigns a pixmap image to be |
| | | used as the icon for that window. |
+---------------------+------------------+-------------------------------------+
| NoTitleBar | boolean | Disables the titlebar in the |
| | | window. |
+---------------------+------------------+-------------------------------------+
| NoResizeBar | boolean | Disables the resizebar in the |
| | | window. |
+---------------------+------------------+-------------------------------------+
| NoMiniaturizeButton | boolean | Remove the miniaturize |
| | | button. |
+---------------------+------------------+-------------------------------------+
| NoCloseButton | boolean | Remove the close button. |
+---------------------+------------------+-------------------------------------+
| NoHideOthers | boolean | Do not hide the window, or the |
| | | application to which the window |
| | | belongs when a *Hide Others* |
| | | command is issued. |
+---------------------+------------------+-------------------------------------+
| NoMouseBindings | boolean | Do not grab mouse buttons in that |
| | | window. This means that actions |
| | | like a Meta-click on the window |
| | | will be caught by the application |
| | | instead of WindowMaker. |
+---------------------+------------------+-------------------------------------+
| NoKeyBindings | boolean | Do not grab keys in that window. |
| | | This means that keystrokes that |
| | | would normally be intercepted by |
| | | WindowMaker (because they are |
| | | bound to some action), like |
| | | Meta+Up, will be passed to the |
| | | application. |
+---------------------+------------------+-------------------------------------+
| NoAppIcon | boolean | Do not create application icon for |
| | | the window. This is useful for some |
| | | applications that incorrectly get |
| | | more than one application icon. |
+---------------------+------------------+-------------------------------------+
| KeepOnTop | boolean | Always keep the window over other |
| | | normal windows. |
+---------------------+------------------+-------------------------------------+
| Omnipresent | boolean | Make the window be present in all |
| | | workspaces, AKA sticky window. |
+---------------------+------------------+-------------------------------------+
| | | |
| SkipWindowList | boolean | Do not list the window in the |
| | | `window list menu`_ |
+---------------------+------------------+-------------------------------------+
| | | |
| KeepInsideScreen | boolean | Always keep the window inside the |
| | | visible are of the screen. |
+---------------------+------------------+-------------------------------------+
| Unfocusable | boolean | Do not let the window be focused. |
+---------------------+------------------+-------------------------------------+
| StartWorkspace | Workspace number | Make the window always be initially |
| | or name | shown in the indicated workspace. |
+---------------------+------------------+-------------------------------------+
Applications Menu
~~~~~~~~~~~~~~~~~
The applications menu (AKA: Root Menu) can be defined in one of two distinct
ways:
- In the form of an array in property list format, in
$(HOME)/GNUstep/Defaults/WMRootMenu
- In the form of a text file, whose location is present in
$(HOME)/GNUstep/Defaults/WMRootMenu
----
.. [1] You can get the values for these information by running the ``xprop``
utility on the desired window. When you do that, it will show the following
line, among other things:
.. code::
:class: highlight
WM_CLASS(STRING) = "xterm", "XTerm"
The first string (xterm) is the window instance name and the second (XTerm)
the window class name.
.. _window list menu: chap3.html#3.12
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: User Guide - Configuration</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

87
docs/chap5.html Normal file
View File

@@ -0,0 +1,87 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: User Guide - Tips</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
<div class="document" id="tips">
<h1 class="title">Tips</h1>
<ul class="simple">
<li><p>If the size of a window gets so large that it doesn't fit on the screen and
you can't manipulate it, you can simply hold the 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.</p></li>
<li><p>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 Meta key.
Then, you can raise and lower the dock through the first icon, just like you
do with windows.</p></li>
<li><p>If you want windows to be able to cover menus, you can make them lowerable
just like the dock by double clicking the titlebar with the Meta key pressed.</p></li>
</ul>
</div>
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: User Guide - Tips</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

85
docs/chap5.rst Normal file
View File

@@ -0,0 +1,85 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: User Guide - Tips</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
Tips
====
- If the size of a window gets so large that it doesn't fit on the screen and
you can't manipulate it, you can simply hold the 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.
- 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 Meta key.
Then, you can raise and lower the dock through the first icon, just like you
do with windows.
- If you want windows to be able to cover menus, you can make them lowerable
just like the dock by double clicking the titlebar with the Meta key pressed.
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: User Guide - Tips</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

83
docs/chap6.html Normal file
View File

@@ -0,0 +1,83 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: User Guide - Glossary</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
<div class="document" id="glossary">
<h1 class="title">Glossary</h1>
<ul class="simple">
<li><p>[drag] to click in an object with the mouse and move the mouse while holding
the mouse button.</p></li>
<li><p>[miniaturize] (iconify, minimize) to temporarily put a window aside,
replacing the window with a miniature representation of it.</p></li>
<li><p>[Meta key] depending on the system and keyboard types, this can mean
different keys. Under Linux, it is usually the Alt or Alternate key.</p></li>
</ul>
</div>
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: User Guide - Glossary</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

81
docs/chap6.rst Normal file
View File

@@ -0,0 +1,81 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: User Guide - Glossary</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
Glossary
========
- [drag] to click in an object with the mouse and move the mouse while holding
the mouse button.
- [miniaturize] (iconify, minimize) to temporarily put a window aside,
replacing the window with a miniature representation of it.
- [Meta key] depending on the system and keyboard types, this can mean
different keys. Under Linux, it is usually the Alt or Alternate key.
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: User Guide - Glossary</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

78
docs/chap7.html Normal file
View File

@@ -0,0 +1,78 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: User Guide - Credits</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
<div class="document" id="credits">
<h1 class="title">Credits</h1>
<p>The original TeX version of this document was written by Afredo K. Kojima.</p>
<p>The HTML conversion was done primarily by Jeremy Crabtree, with assistance from
Dan Olav Mikael Hultgren Gudmundsson.</p>
</div>
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: User Guide - Credits</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

77
docs/chap7.rst Normal file
View File

@@ -0,0 +1,77 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: User Guide - Credits</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
Credits
=======
The original TeX version of this document was written by Afredo K. Kojima.
The HTML conversion was done primarily by Jeremy Crabtree, with assistance from
Dan Olav Mikael Hultgren Gudmundsson.
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: User Guide - Credits</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

BIN
docs/guide/images/focus.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.6 KiB

BIN
docs/guide/images/menu.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.9 KiB

BIN
docs/guide/images/mini.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 818 B

BIN
docs/guide/images/shade.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 KiB

BIN
docs/guide/images/title.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.8 KiB

84
docs/guide_toc.html Normal file
View File

@@ -0,0 +1,84 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: User Guide</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
<div class="document">
<ul class="simple">
<li><p><a class="reference external" href="chap1.html">Chapter 1: Introduction</a></p></li>
<li><p><a class="reference external" href="chap2.html">Chapter 2: Windows</a></p></li>
<li><p><a class="reference external" href="chap3.html">Chapter 3: The Workspace</a></p></li>
<li><p><a class="reference external" href="chap4.html">Chapter 4: Configuring WindowMaker</a></p></li>
<li><p><a class="reference external" href="chap5.html">Chapter 5: Tips</a></p></li>
<li><p><a class="reference external" href="chap6.html">Chapter 6: Glossary</a></p></li>
<li><p><a class="reference external" href="chap7.html">Chapter 7: Credits</a></p></li>
</ul>
</div>
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: User Guide</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

77
docs/guide_toc.rst Normal file
View File

@@ -0,0 +1,77 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: User Guide</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
- `Chapter 1: Introduction <chap1.html>`_
- `Chapter 2: Windows <chap2.html>`_
- `Chapter 3: The Workspace <chap3.html>`_
- `Chapter 4: Configuring WindowMaker <chap4.html>`_
- `Chapter 5: Tips <chap5.html>`_
- `Chapter 6: Glossary <chap6.html>`_
- `Chapter 7: Credits <chap7.html>`_
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: User Guide</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

173
docs/guidedtour/back.html Normal file
View File

@@ -0,0 +1,173 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Backgrounds and Themes</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
<div class="document" id="backgrounds-and-themes">
<h1 class="title">Backgrounds and Themes</h1>
<!-- TODO: check for the dead links -->
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#backgrounds" id="id1">Backgrounds</a></p></li>
<li><p><a class="reference internal" href="#styles" id="id2">Styles</a></p></li>
<li><p><a class="reference internal" href="#themes" id="id3">Themes</a></p></li>
</ul>
</div>
<p>For the purposes of this guided tour, only those appearance options that are
built-in to Window Maker will be considered. Crafting custom styles and themes
is not terribly difficult, nor do you need any special knowledge of programming
languages or other specialized skills, but this is outside the intended scope
of the guided tour.</p>
<p>The appearance of the Window Maker GUI can easily be customized from the
applications menu item "Appearance".</p>
<p>Themes, styles, icon sets, and backgrounds can be selected as soon as they are
installed in the right directory.</p>
<p>Themes should be installed in the directory
<span class="docutils literal">~/GNUstep/Library/WindowMaker/Themes/</span></p>
<p>Styles should be installed in the directory
<span class="docutils literal">~/GNUstep/Library/WindowMaker/Styles/</span></p>
<p>Backgrounds should be installed in the directory
<span class="docutils literal">~/GNUstep/Library/WindowMaker/Backgrounds/</span></p>
<p>If you are working within a freshly-installed instance of Window Maker, your
Linux distribution probably provided some default themes, styles and
backgrounds. Rarely, a distribution provides no additional themes, styles or
backgrounds - expecting users to provide these on their own.</p>
<p>Here is the "Appearance" menu and some of its associated sub-menus,
including themes, styles and backgrounds:</p>
<div class="borderless figure">
<img alt="Appearance menu items" src="images/appearancemenu.png">
</div>
<p>In the screenshot above, most of the styles are default to the Debian GNU/Linux
distribution, while most of the themes were user-installed. Many themes are
available for download on the internet.</p>
<div class="section" id="backgrounds">
<h1>Backgrounds</h1>
<p>Backgrounds may be system-generated solid or gradient colors, or they may be
images from user or distribution-supplied image files. The easiest way to
change a system-generated background color or color gradient is to select one
from the "Appearance -&gt; Background -&gt; &lt;Solid | Gradient&gt;" menu. In most default
configurations there will be six to eight selections in each category.</p>
<p>Likewise, the easiest way to change to a background image is to select one from
the "Appearance -&amp;gt; Background -&amp;gt; Images" menu. If you wish to install
your own images for use as backgrounds, place the image file in your
<span class="docutils literal">~/GNUstep/Library/WindowMaker/Backgrounds/</span> directory and they will be
available from the menu immediately.</p>
</div>
<div class="section" id="styles">
<h1>Styles</h1>
<p>A style defines the look of the key components of the Window Maker desktop.
These components include the window titlebar and resizebar, the menu title and
text field, and the icon background.</p>
<p>The characteristics defined in a style (or theme) are the color and "texture"
of key GUI elements. Texture in this context means using multiple colors in
various color gradients - you are not limited to solid colors only.</p>
<p>The easiest method for changing the style is to select a style from the
"Appearance -&gt; Style" menu.</p>
<p>A style may also be created using the <em>Appearance Preferences</em> tool in
<em>WPrefs.app</em>. From this tool, you may configure the color and texture of
window elements (titlebars, resizebars), menu elements (menu titlebar, menu
item text colors, menu "style") and the color and texture of icon backgrounds.
The location of titlebar text and the font and text color for window and menu
text may also be configured here.</p>
<div class="borderless figure">
<img alt="Appearance preferences tool" src="images/prefs13.png">
<p class="caption">Appearance preferences tool</p>
</div>
<p>More information on creating a style "from scratch" may be found <a class="reference external" href="/docs/chap4.html">in the Window
Maker User's Guide</a>. (Scroll down to the
section on "Appearance Options.")</p>
<p>A step-by-step guide to crafting a custom style is available <a class="reference external" href="http://windowmakerandi.blogspot.com/search?updated-min=2011-01-01T00:00:00-06:00&amp;amp;updated-max=2012-01-01T00:00:00-06:00&amp;amp;max-results=4target=%22_blank%22">HERE</a>.</p>
</div>
<div class="section" id="themes">
<h1>Themes</h1>
<p>In its most basic form, a theme is simply a style that also includes a
background. Some Linux distributions provide one or more default themes for use
system-wide. You may install your own themes in the
<span class="docutils literal">~/GNUstep/Library/WindowMaker/Themes/</span> directory. Themes installed in the
correct directory will be available for selection in the "Appearance -&amp;gt;
Themes" menu. Selecting Themes from the Appearance menu runs the <em>setstyle</em>
program to install the theme and record it in the
<span class="docutils literal">~/GNUstep/Defaults/WindowMaker</span> file.</p>
<p>Two sites providing preconfigured themes are <a class="reference external" href="http://lonelymachines.org/windowmaker-themes/">HERE</a> and <a class="reference external" href="http://www.jessanderson.org/wmthemes/">HERE</a>. An internet search for "Window
Maker themes" will generate additional results, and you should also check your
Linux distribution's repositories - some provide themes for installation using
your distribution's package management system.</p>
<p>Themes may include images in png, jpg, xpm, and other supported image file
formats for key elements of the GUI such as titlebars, icon backgrounds, and
the workspace background. Themes that include images cannot be stored as a
single text file, and therefore must be stored in a directory. A theme
directory must contain all of the image files needed for the theme along with a
file named "style." The style file in a theme directory will specify all of the
GUI elements including any image files used for those elements in lieu of rgb
color specifications. A theme directory must use the suffix ".themed" after the
theme name.</p>
</div>
</div>
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Backgrounds and Themes</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

194
docs/guidedtour/back.rst Normal file
View File

@@ -0,0 +1,194 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Backgrounds and Themes</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
.. TODO: check for the dead links
Backgrounds and Themes
======================
.. contents::
:backlinks: none
For the purposes of this guided tour, only those appearance options that are
built-in to Window Maker will be considered. Crafting custom styles and themes
is not terribly difficult, nor do you need any special knowledge of programming
languages or other specialized skills, but this is outside the intended scope
of the guided tour.
The appearance of the Window Maker GUI can easily be customized from the
applications menu item "Appearance".
Themes, styles, icon sets, and backgrounds can be selected as soon as they are
installed in the right directory.
Themes should be installed in the directory
``~/GNUstep/Library/WindowMaker/Themes/``
Styles should be installed in the directory
``~/GNUstep/Library/WindowMaker/Styles/``
Backgrounds should be installed in the directory
``~/GNUstep/Library/WindowMaker/Backgrounds/``
If you are working within a freshly-installed instance of Window Maker, your
Linux distribution probably provided some default themes, styles and
backgrounds. Rarely, a distribution provides no additional themes, styles or
backgrounds - expecting users to provide these on their own.
Here is the "Appearance" menu and some of its associated sub-menus,
including themes, styles and backgrounds:
.. figure:: images/appearancemenu.png
:alt: Appearance menu items
:figclass: borderless
In the screenshot above, most of the styles are default to the Debian GNU/Linux
distribution, while most of the themes were user-installed. Many themes are
available for download on the internet.
Backgrounds
-----------
Backgrounds may be system-generated solid or gradient colors, or they may be
images from user or distribution-supplied image files. The easiest way to
change a system-generated background color or color gradient is to select one
from the "Appearance -> Background -> <Solid | Gradient>" menu. In most default
configurations there will be six to eight selections in each category.
Likewise, the easiest way to change to a background image is to select one from
the "Appearance -&gt; Background -&gt; Images" menu. If you wish to install
your own images for use as backgrounds, place the image file in your
``~/GNUstep/Library/WindowMaker/Backgrounds/`` directory and they will be
available from the menu immediately.
Styles
------
A style defines the look of the key components of the Window Maker desktop.
These components include the window titlebar and resizebar, the menu title and
text field, and the icon background.
The characteristics defined in a style (or theme) are the color and "texture"
of key GUI elements. Texture in this context means using multiple colors in
various color gradients - you are not limited to solid colors only.
The easiest method for changing the style is to select a style from the
"Appearance -> Style" menu.
A style may also be created using the *Appearance Preferences* tool in
*WPrefs.app*. From this tool, you may configure the color and texture of
window elements (titlebars, resizebars), menu elements (menu titlebar, menu
item text colors, menu "style") and the color and texture of icon backgrounds.
The location of titlebar text and the font and text color for window and menu
text may also be configured here.
.. figure:: images/prefs13.png
:figclass: borderless
:alt: Appearance preferences tool
Appearance preferences tool
More information on creating a style "from scratch" may be found `in the Window
Maker User's Guide </docs/chap4.html>`_. (Scroll down to the
section on "Appearance Options.")
A step-by-step guide to crafting a custom style is available `HERE
<http://windowmakerandi.blogspot.com/search?updated-min=2011-01-01T00:00:00-06:00&amp;updated-max=2012-01-01T00:00:00-06:00&amp;max-results=4
target="_blank">`__.
Themes
------
In its most basic form, a theme is simply a style that also includes a
background. Some Linux distributions provide one or more default themes for use
system-wide. You may install your own themes in the
``~/GNUstep/Library/WindowMaker/Themes/`` directory. Themes installed in the
correct directory will be available for selection in the "Appearance -&gt;
Themes" menu. Selecting Themes from the Appearance menu runs the *setstyle*
program to install the theme and record it in the
``~/GNUstep/Defaults/WindowMaker`` file.
Two sites providing preconfigured themes are `HERE
<http://lonelymachines.org/windowmaker-themes/>`__ and `HERE
<http://www.jessanderson.org/wmthemes/>`__. An internet search for "Window
Maker themes" will generate additional results, and you should also check your
Linux distribution's repositories - some provide themes for installation using
your distribution's package management system.
Themes may include images in png, jpg, xpm, and other supported image file
formats for key elements of the GUI such as titlebars, icon backgrounds, and
the workspace background. Themes that include images cannot be stored as a
single text file, and therefore must be stored in a directory. A theme
directory must contain all of the image files needed for the theme along with a
file named "style." The style file in a theme directory will specify all of the
GUI elements including any image files used for those elements in lieu of rgb
color specifications. A theme directory must use the suffix ".themed" after the
theme name.
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Backgrounds and Themes</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

153
docs/guidedtour/clip.html Normal file
View File

@@ -0,0 +1,153 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Clip</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
<div class="document" id="clip">
<h1 class="title">CLIP</h1>
<p>By default, The clip is represented by the icon on the top left of the screen
containing a paperclip image.</p>
<div class="borderless figure">
<img alt="Clip icon" src="images/clip.png">
</div>
<p>The clip's primary function is to serve as a workspace-specific dock. In other
words, applications may be attached to the clip just as they are to the dock,
but the clip and its associated applications are specific to each individual
workspace - not available on all workspaces as they are on the dock.</p>
<p>The clip's secondary function is to act as a "pager" - a utility for changing
from one workspace to another (paging). The arrows at the top right and bottom
left corners of the clip icon allow you to switch from one workspace to the
next workspace (top right) or previous workspace (bottom left).</p>
<p>The current workspace name (if any) and number are displayed on the
clip.</p>
<p>The clip also has a number of menu-driven features.</p>
<div class="section" id="clip-menu">
<h1>Clip Menu</h1>
<p>Right-clicking the clip displays a menu.</p>
<div class="borderless figure">
<img alt="Clip menu" src="images/menu_clip.png">
<p class="caption">Clip menu</p>
</div>
</div>
<div class="section" id="clip-options">
<h1>Clip Options</h1>
<p>The first menu item allows you to select clip options. The following options
are available:</p>
<ul class="simple">
<li><p><em>Keep on top</em> - do not allow windows to cover the clip.</p></li>
<li><p><em>Collapsed</em> - icons attached to the clip are hidden until you left-click the
clip, which unhides them.</p></li>
<li><p><em>Autocollapse</em> - same as the previous option, except that mouseing over the
clip unhides application icons.</p></li>
<li><p><em>Autoraise</em> - clicking an icon representing a window hidden under a larger
window brings that window to the front.</p></li>
<li><p><em>Autoattract icons</em> - selecting this option attracts the icon of any
application launched on the current workspace. Closing the application
removes the icon from the clip.</p></li>
</ul>
</div>
<div class="section" id="rename-workspace">
<h1>Rename Workspace</h1>
<p>This item gives you to ability to name (or rename) the current workspace.</p>
<p>Some users tend to group certain applications by workspace and like to name the
workspace to indicate the nature of the applications on the clip. For example,
a user might have a browser, an IRC client, and a file transfer application
clipped on a workspace, and might name that workspace "internet" to indicate
the workspace's primary function. The user might have a seperate workspace with
a vector graphics application, an image manipulation application, and an image
viewer on the clip, and might name that workspace "graphics."</p>
</div>
<div class="section" id="other-options">
<h1>Other Options</h1>
<p>Right-clicking a clipped application's icon gives options specific to that
application.</p>
<ul class="simple">
<li><p>You may make the application's icon <em>omnipresent</em> (clipped on all
workspaces).</p></li>
<li><p>You may <em>select</em> one or all clipped icons.</p></li>
<li><p>You may <em>move</em> one or all icons to a different workspace.</p></li>
<li><p>You may <em>remove</em> the icon.</p></li>
<li><p>You may instruct Window Maker to have all icons <em>attracted</em> to the clip as
soon as each application is launched, rather than placing them initially in
the defined location on the display.</p></li>
</ul>
<p>The remaining clip menu items are similar to those of the <a class="reference external" href="dock.html#conf">Dock application
icon menu</a>. As with the dock, clipped applications may be
launched, hidden, or killed and their settings (icon used, application launch
path/arguments, middle-click launch) may be modified.</p>
<p>From version 0.80.0 on, the clip can "steal" appicons. This feature has nothing
to do with autoattracting icons. When you start an application from somewhere
other than either the clip or the dock (i.e., from the menu or a terminal), and
the application is already either docked or clipped, a new application icon
does not appear at the bottom of your screen. The icon that is already docked
or clipped "steals" the icon function. As a result, the icon for the
newly-launched application is the icon already on the clip or the dock.</p>
</div>
</div>
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Clip</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

167
docs/guidedtour/clip.rst Normal file
View File

@@ -0,0 +1,167 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Clip</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
CLIP
====
By default, The clip is represented by the icon on the top left of the screen
containing a paperclip image.
.. figure:: images/clip.png
:alt: Clip icon
:figclass: borderless
The clip's primary function is to serve as a workspace-specific dock. In other
words, applications may be attached to the clip just as they are to the dock,
but the clip and its associated applications are specific to each individual
workspace - not available on all workspaces as they are on the dock.
The clip's secondary function is to act as a "pager" - a utility for changing
from one workspace to another (paging). The arrows at the top right and bottom
left corners of the clip icon allow you to switch from one workspace to the
next workspace (top right) or previous workspace (bottom left).
The current workspace name (if any) and number are displayed on the
clip.
The clip also has a number of menu-driven features.
Clip Menu
---------
Right-clicking the clip displays a menu.
.. figure:: images/menu_clip.png
:alt: Clip menu
:figclass: borderless
Clip menu
Clip Options
------------
The first menu item allows you to select clip options. The following options
are available:
- *Keep on top* - do not allow windows to cover the clip.
- *Collapsed* - icons attached to the clip are hidden until you left-click the
clip, which unhides them.
- *Autocollapse* - same as the previous option, except that mouseing over the
clip unhides application icons.
- *Autoraise* - clicking an icon representing a window hidden under a larger
window brings that window to the front.
- *Autoattract icons* - selecting this option attracts the icon of any
application launched on the current workspace. Closing the application
removes the icon from the clip.
Rename Workspace
----------------
This item gives you to ability to name (or rename) the current workspace.
Some users tend to group certain applications by workspace and like to name the
workspace to indicate the nature of the applications on the clip. For example,
a user might have a browser, an IRC client, and a file transfer application
clipped on a workspace, and might name that workspace "internet" to indicate
the workspace's primary function. The user might have a seperate workspace with
a vector graphics application, an image manipulation application, and an image
viewer on the clip, and might name that workspace "graphics."
Other Options
-------------
Right-clicking a clipped application's icon gives options specific to that
application.
- You may make the application's icon *omnipresent* (clipped on all
workspaces).
- You may *select* one or all clipped icons.
- You may *move* one or all icons to a different workspace.
- You may *remove* the icon.
- You may instruct Window Maker to have all icons *attracted* to the clip as
soon as each application is launched, rather than placing them initially in
the defined location on the display.
The remaining clip menu items are similar to those of the `Dock application
icon menu <dock.html#conf>`_. As with the dock, clipped applications may be
launched, hidden, or killed and their settings (icon used, application launch
path/arguments, middle-click launch) may be modified.
From version 0.80.0 on, the clip can "steal" appicons. This feature has nothing
to do with autoattracting icons. When you start an application from somewhere
other than either the clip or the dock (i.e., from the menu or a terminal), and
the application is already either docked or clipped, a new application icon
does not appear at the bottom of your screen. The icon that is already docked
or clipped "steals" the icon function. As a result, the icon for the
newly-launched application is the icon already on the clip or the dock.
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Clip</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

177
docs/guidedtour/dock.html Normal file
View File

@@ -0,0 +1,177 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Dock</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
<div class="document" id="dock">
<h1 class="title">Dock</h1>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#application-dock" id="id1">Application dock</a></p></li>
<li><p><a class="reference internal" href="#starting-an-application" id="id2">Starting an application</a></p></li>
<li><p><a class="reference internal" href="#customizing" id="id3">Customizing</a></p></li>
<li><p><a class="reference internal" href="#configuring" id="id4">Configuring</a></p></li>
</ul>
</div>
<div class="section" id="application-dock">
<h1>Application dock</h1>
<p>The dock is the column of icons located by default on the right side of the
screen.</p>
<p>Any application can be attached to the dock. To do this, open an application
then simply left-click-and-drag the application's icon to the last position on
the dock. The dock will "attract" the icon and it will remain on the dock until
removed by the user (left-click-and-drag the icon off the dock - it will
disappear.) If you have saved your Window Maker session prior to logout (or set
Window Maker to autosave your session upon logout) any icons you docked will
automatically reappear at your next - and each subsequent - session.</p>
<p>The dock can be configured to remain on top of maximized windows. To do this,
right-click on a dock or any docked icon then select appropriate option form
<em>Dock position</em> submenu. Consult <a class="reference external" href="menu.html#application-icon-menu">Application icon menu</a> for details.</p>
<p>The WMDock icon (by default, with the GNUstep logo) can be dragged sideways to
switch the the entire dock from one side of the display to the other.</p>
<p>Dragging the WMDock icon downward will move the dock off the display with the
exception of the WMDock icon itself, which will remain visible. To restore dock
visibility, left-click-and-drag the dock back on screen.</p>
</div>
<div class="section" id="starting-an-application">
<h1>Starting an application</h1>
<p>Double-clicking the icon of a docked application starts the application.</p>
<p>An application that has not been launched normally has an elipsis (three dots)
in the bottom-left-corner of the icon and appears in full color as shown below.</p>
<div class="borderless figure">
<img alt="Unlaunched application icon" src="images/unlaunched_app.png">
<p class="caption">Unlaunched application icon</p>
</div>
<p>When the application is running, the elipsis disappears from the
bottom-left-corner of the icon and the icon becomes highlited.</p>
<div class="borderless figure">
<img alt="Launched application icon" src="images/launched_app.png">
<p class="caption">Launched application icon</p>
</div>
<p>Sometimes, when the application is running, instead of highlited icon, the icon
becomes "greyed out", giving a visual cue that the application is already open,
and cannot be launched again.</p>
<div class="borderless figure">
<img alt="Launched application icon" src="images/grayed_out_icon.png">
<p class="caption">Grayed-out application icon</p>
</div>
<p>A docked icon that continues to show an elipsis and remains "full color" even
after an instance of the application is running indicates that the
application's settings have been modified to allow multiple launches from one
docked icon. To do this you must open the application and modify the
"application specific" settings in the <a class="reference external" href="win.html#menu">commands menu</a> of the
application to allow "shared application icons".</p>
<p>Using the "launch" command in the "application icon menu" for the icon is
another way to start an application from the dock.</p>
<p>From version 0.80.0 on, the dock can "steal" appicons. This feature has nothing
to do with Autoattract Icons. When you start an application from somewhere else
than either the clip or the dock (menu or terminal), and the appicon exists in
one of them (clip or dock), this appicon doesn't appear at the bottom of your
screen. The appicon existing in the clip or the dock "stole" it. As a result,
the appicon is the same as the one used to start the application from the clip
or the dock.</p>
</div>
<div class="section" id="customizing">
<h1>Customizing</h1>
<p>Left-clicking and dragging an application icon to the dock adds this
application to the dock. Obviously, this means the application is running!</p>
<p><em>Miniwindows</em> (windows of minimized applications) cannot be docked. The small
titlebar on the miniwindow differentiates it from an application's icon.</p>
<p>Dragging an icon off the dock removes the docked application.</p>
</div>
<div class="section" id="configuring">
<h1>Configuring</h1>
<p>There is a dock menu for each icon. Right-clicking the icon displays the
"application icon menu". Select the "Settings..." option to configure the
application.</p>
<div class="borderless figure">
<img alt="Launched application icon" src="images/docked_application_settings.png">
<p class="caption">Launched application icon</p>
</div>
<p>The application's <em>path</em> and its arguments, the command for middle-click
launch, and the icon employed can be changed in this panel.</p>
<p>Shell commands such as redirection cannot be used in the command field.</p>
<p>The desired icon must be in one of the directories displayed in the panel while
browsing. New directories can be added from the <a class="reference external" href="prefs.html#search-path">Search path preferences</a>.</p>
<p>A checkbox allows you to start the application when Window Maker is first
started. (Note: <em>You want to be careful with this</em>. If you have, for example,
your terminal emulator, your file manager, and your browser set to start when
Window Maker is started you'll get an open terminal, an open file manager and
an open browser <em>every time</em> you start a session! Normally you will only want
to start certain dockapps - "regular" applications like a terminal emulator or
browser can be started <em>after</em> your session is up and going.)</p>
<p>From version 0.62.0 on, a checkbox can be used to prevent accidental
removal from the dock.</p>
<p>From version 0.70.0 on, a new field has been added for middle-click launch.
Entering, for example, "firefox" into a docked application settings panel will
launch the Firefox browser.</p>
</div>
</div>
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Dock</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

200
docs/guidedtour/dock.rst Normal file
View File

@@ -0,0 +1,200 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Dock</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
Dock
====
.. contents::
:backlinks: none
Application dock
----------------
The dock is the column of icons located by default on the right side of the
screen.
Any application can be attached to the dock. To do this, open an application
then simply left-click-and-drag the application's icon to the last position on
the dock. The dock will "attract" the icon and it will remain on the dock until
removed by the user (left-click-and-drag the icon off the dock - it will
disappear.) If you have saved your Window Maker session prior to logout (or set
Window Maker to autosave your session upon logout) any icons you docked will
automatically reappear at your next - and each subsequent - session.
The dock can be configured to remain on top of maximized windows. To do this,
right-click on a dock or any docked icon then select appropriate option form
*Dock position* submenu. Consult `Application icon menu
<menu.html#application-icon-menu>`_ for details.
The WMDock icon (by default, with the GNUstep logo) can be dragged sideways to
switch the the entire dock from one side of the display to the other.
Dragging the WMDock icon downward will move the dock off the display with the
exception of the WMDock icon itself, which will remain visible. To restore dock
visibility, left-click-and-drag the dock back on screen.
Starting an application
-----------------------
Double-clicking the icon of a docked application starts the application.
An application that has not been launched normally has an elipsis (three dots)
in the bottom-left-corner of the icon and appears in full color as shown below.
.. figure:: images/unlaunched_app.png
:alt: Unlaunched application icon
:figclass: borderless
Unlaunched application icon
When the application is running, the elipsis disappears from the
bottom-left-corner of the icon and the icon becomes highlited.
.. figure:: images/launched_app.png
:alt: Launched application icon
:figclass: borderless
Launched application icon
Sometimes, when the application is running, instead of highlited icon, the icon
becomes "greyed out", giving a visual cue that the application is already open,
and cannot be launched again.
.. figure:: images/grayed_out_icon.png
:alt: Launched application icon
:figclass: borderless
Grayed-out application icon
A docked icon that continues to show an elipsis and remains "full color" even
after an instance of the application is running indicates that the
application's settings have been modified to allow multiple launches from one
docked icon. To do this you must open the application and modify the
"application specific" settings in the `commands menu <win.html#menu>`_ of the
application to allow "shared application icons".
Using the "launch" command in the "application icon menu" for the icon is
another way to start an application from the dock.
From version 0.80.0 on, the dock can "steal" appicons. This feature has nothing
to do with Autoattract Icons. When you start an application from somewhere else
than either the clip or the dock (menu or terminal), and the appicon exists in
one of them (clip or dock), this appicon doesn't appear at the bottom of your
screen. The appicon existing in the clip or the dock "stole" it. As a result,
the appicon is the same as the one used to start the application from the clip
or the dock.
Customizing
-----------
Left-clicking and dragging an application icon to the dock adds this
application to the dock. Obviously, this means the application is running!
*Miniwindows* (windows of minimized applications) cannot be docked. The small
titlebar on the miniwindow differentiates it from an application's icon.
Dragging an icon off the dock removes the docked application.
Configuring
-----------
There is a dock menu for each icon. Right-clicking the icon displays the
"application icon menu". Select the "Settings..." option to configure the
application.
.. figure:: images/docked_application_settings.png
:alt: Launched application icon
:figclass: borderless
Launched application icon
The application's *path* and its arguments, the command for middle-click
launch, and the icon employed can be changed in this panel.
Shell commands such as redirection cannot be used in the command field.
The desired icon must be in one of the directories displayed in the panel while
browsing. New directories can be added from the `Search path preferences
<prefs.html#search-path>`_.
A checkbox allows you to start the application when Window Maker is first
started. (Note: *You want to be careful with this*. If you have, for example,
your terminal emulator, your file manager, and your browser set to start when
Window Maker is started you'll get an open terminal, an open file manager and
an open browser *every time* you start a session! Normally you will only want
to start certain dockapps - "regular" applications like a terminal emulator or
browser can be started *after* your session is up and going.)
From version 0.62.0 on, a checkbox can be used to prevent accidental
removal from the dock.
From version 0.70.0 on, a new field has been added for middle-click launch.
Entering, for example, "firefox" into a docked application settings panel will
launch the Firefox browser.
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Dock</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 215 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 366 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 658 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 817 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 554 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

146
docs/guidedtour/index.html Normal file
View File

@@ -0,0 +1,146 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Index</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
<div class="document" id="window-maker">
<h1 class="title">Window Maker</h1>
<div class="center section" id="guided-tour">
<h1>Guided Tour</h1>
<img alt="images/gnusteplogo.png" class="screenshot center" src="images/gnusteplogo.png" style="width: 100px; height: 100px;">
</div>
<div class="section" id="foreword">
<h1>Foreword</h1>
<p>This tutorial is intended to help Window Maker users gain knowledge about the
many excellent features of this window manager. The official Users Guide is
worth reading. It can be reached from the <a class="reference external" href="/docs/guide_toc.html">Window Maker site</a>. Other guides, tutorials and tips can be found at
various sites on the internet. An internet search for "Window Maker guide
how-to" might provide additional worthwhile information.</p>
<p>This guided tour is NOT supposed to be a README, INSTALL or FAQ. These are
worth reading, or more accurately, they should be considered COMPULSORY
reading.</p>
<p>The information in the guided tour is based upon Window Maker version 0.95.3.
Check your version by opening WPrefs.app (the Window Maker Preferences tool).
The version number is shown in the initial WPrefs window just below the "Window
Maker Preferences" title. You may also run the command "<em>wmaker --version</em>" in
a terminal (without the quotation marks). This command returns the installed
version number of Window Maker.</p>
</div>
<div class="section" id="a-special-word-of-thanks">
<h1>A special word of thanks</h1>
<p>The original Window Maker Guided Tour site was created and maintained for many
years by Georges Tarbouriech. Where possible, I have retained his original
work - including the layout and structure of the pages, the descriptions of
Window Maker features, and even some of his original graphics. I want these
pages to be up-to-date, but I also want them to be (as much as possible) a
continuation of Georges' work. <em>Thank you, Georges</em>. (Having said that,
anything you find in error is without question my fault - so don't blame
Georges for any mistakes!) If you find an error, have a suggestion, or wish to
make a comment, you may contact me by email at
<em>bnance&amp;lt;atsigngoeshere&amp;gt;uu.edu</em>.</p>
<p>This tour will attempt to follow Window Maker development, but not
every update can be taken into account. In other words, this
tour can help you learn the basics, but does not pretend to provide all
of the detail or all of the latest information available in the
official README, INSTALL and FAQ documents provided by Window Maker
developers and maintainers.</p>
<div class="section" id="table-of-contents">
<h2>Table of contents</h2>
<ul class="contents simple">
<li><p><a class="reference external" href="prefs.html">Preferences</a></p></li>
<li><p><a class="reference external" href="win.html">Windows</a></p></li>
<li><p><a class="reference external" href="menu.html">Menus</a></p></li>
<li><p><a class="reference external" href="dock.html">Dock</a></p></li>
<li><p><a class="reference external" href="clip.html">Clip</a></p></li>
<li><p><a class="reference external" href="back.html">Backgrounds and themes</a></p></li>
<li><p><a class="reference external" href="misc.html">Miscellaneous</a></p></li>
</ul>
</div>
</div>
<div class="section" id="archives">
<h1>Archives</h1>
<p>Two archives are available: HTML and pictures.</p>
<!-- TODO: figure out what's the status of those archives. -->
<ul class="simple">
<li><p><a class="reference external" href="tut.tar.gz">tut.tar.gz (12K) HTML files</a></p></li>
<li><p><a class="reference external" href="img.tar.gz">img.tar.gz (613K) Picture files</a></p></li>
</ul>
</div>
<div class="section" id="links-of-interest">
<h1>Links of interest</h1>
<ul class="simple">
<li><p><a class="reference external" href="https://www.youtube.com/watch?v=dIkbxMbhBpc">Window Maker on Debian 6 (YouTube)</a> by fourandnine</p></li>
<li><p><a class="reference external" href="https://wiki.archlinux.org/index.php/Window_Maker">Arch Linux Window Maker Wiki Entry</a></p></li>
<li><p><a class="reference external" href="http://packages.debian.org/squeeze/wmaker">Debian Stable (Squeeze) Package Listing</a></p></li>
<li><p><a class="reference external" href="http://www.youtube.com/watch?v=T7VFjW8p9NU">Window Maker on Mageia Linux (YouTube)</a> by St. Louis Mageia Users' Group</p></li>
</ul>
<p class="center"><a class="reference external" href="http://www.windowmaker.org">Window Maker</a></p>
</div>
</div>
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Index</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

164
docs/guidedtour/index.rst Normal file
View File

@@ -0,0 +1,164 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Index</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
Window Maker
============
.. class:: center
Guided Tour
-----------
.. class:: screenshot center
.. image:: images/gnusteplogo.png
:height: 100
:width: 100
Foreword
--------
This tutorial is intended to help Window Maker users gain knowledge about the
many excellent features of this window manager. The official Users Guide is
worth reading. It can be reached from the `Window Maker site </docs/guide_toc.html>`_. Other guides, tutorials and tips can be found at
various sites on the internet. An internet search for "Window Maker guide
how-to" might provide additional worthwhile information.
This guided tour is NOT supposed to be a README, INSTALL or FAQ. These are
worth reading, or more accurately, they should be considered COMPULSORY
reading.
The information in the guided tour is based upon Window Maker version 0.95.3.
Check your version by opening WPrefs.app (the Window Maker Preferences tool).
The version number is shown in the initial WPrefs window just below the "Window
Maker Preferences" title. You may also run the command "*wmaker --version*" in
a terminal (without the quotation marks). This command returns the installed
version number of Window Maker.
A special word of thanks
------------------------
The original Window Maker Guided Tour site was created and maintained for many
years by Georges Tarbouriech. Where possible, I have retained his original
work - including the layout and structure of the pages, the descriptions of
Window Maker features, and even some of his original graphics. I want these
pages to be up-to-date, but I also want them to be (as much as possible) a
continuation of Georges' work. *Thank you, Georges*. (Having said that,
anything you find in error is without question my fault - so don't blame
Georges for any mistakes!) If you find an error, have a suggestion, or wish to
make a comment, you may contact me by email at
*bnance&lt;atsigngoeshere&gt;uu.edu*.
This tour will attempt to follow Window Maker development, but not
every update can be taken into account. In other words, this
tour can help you learn the basics, but does not pretend to provide all
of the detail or all of the latest information available in the
official README, INSTALL and FAQ documents provided by Window Maker
developers and maintainers.
Table of contents
~~~~~~~~~~~~~~~~~
.. class:: contents
- `Preferences <prefs.html>`_
- `Windows <win.html>`_
- `Menus <menu.html>`_
- `Dock <dock.html>`_
- `Clip <clip.html>`_
- `Backgrounds and themes <back.html>`_
- `Miscellaneous <misc.html>`_
Archives
--------
Two archives are available: HTML and pictures.
.. TODO: figure out what's the status of those archives.
- `tut.tar.gz (12K) HTML files <tut.tar.gz>`_
- `img.tar.gz (613K) Picture files <img.tar.gz>`_
Links of interest
-----------------
- `Window Maker on Debian 6 (YouTube)
<https://www.youtube.com/watch?v=dIkbxMbhBpc>`_ by fourandnine
- `Arch Linux Window Maker Wiki Entry
<https://wiki.archlinux.org/index.php/Window_Maker>`_
- `Debian Stable (Squeeze) Package Listing
<http://packages.debian.org/squeeze/wmaker>`_
- `Window Maker on Mageia Linux (YouTube)
<http://www.youtube.com/watch?v=T7VFjW8p9NU>`_ by St. Louis Mageia Users' Group
.. class:: center
`Window Maker <http://www.windowmaker.org>`_
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Index</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

Some files were not shown because too many files have changed in this diff Show More