diff --git a/docs.php b/docs.php index fd8c5ab..eb0fc7f 100644 --- a/docs.php +++ b/docs.php @@ -38,7 +38,7 @@
- WindowMaker User's Guide: Table of Contents-- -
- |
-
|
+ + + + + Chapter 2+ +Windows+ + + + 2.1 Anatomy of a WindowGenerally an application will have the following layout:+ + + ![]() + + +
+ + + + + 2.2 Working With Windows+ + + + 2.2.1 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. + + +
+ + + 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: + +
+ 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: + +
+ + + + + + 2.2.2 Reordering Overlapping WindowsWindows can overlap other + windows, making some windows be over or in front of others.+ + + To bring a window to the front: + +
+ + 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+ +
+ + + + + 2.2.3 Moving a WindowTo 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: + +
+ + 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+ +
+ + + + + + 2.2.4 Resizing a WindowThe size of a window can be adjusted by + dragging the resizebar.+ + + + + Depending on the place you click to drag the resizebar, the resize operation is constrained to a direction. + + + To resize a window + +
+ + + Extra Bindings+ +
+ + + + + 2.2.5 Miniaturizing a Window+ If you want to temporarily get rid of a window, you can miniaturize it. When miniaturizing a window, it will shrink + into a miniwindow with a icon and a title that is placed at the bottom of the screen. + + +
+ + + +
+ + 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: + +
+ + 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. + + + + + 2.2.6 Shading a WindowIf 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: + +
+ + + + + + 2.2.7 Closing a WindowAfter 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.+ + +
+ + + 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): + +
+ + It is also possible to kill applications that can be normally closed by clicking the close button while holding the + Control key. + + + + + 2.2.8 Maximizing a WindowIf 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: + +
+ + + To restore the size of a maximized window: + +
+ + 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. + + + + + + 2.2.9 The Window Commands MenuClicking 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.+ + +
2.3 The Window Attributes Inspector+ +2.3.1 Window SpecificationThis panel Allows you to specify the + WM_CLASS that WindowMaker should use to identify the window whose attributes you are setting.+ + +
+ + + + + + 2.3.2 Window AttributesThis panel lets you set the attributes for the + selected window.+ + +
+ + + +
+ + + + + 2.3.3 Advanced Options+ + +
+ + + +
+ + + + + 2.3.4 Icon and Initial WorkspaceThis panel allows you to + browse for, and update the mini-window image for the selected window, as well as setting the + initial workspace.+ + +
+ + + + + + + + 2.3.5 Application SpecificAttributes specific to the selected + application+ + +
+ + + +
+ + + |
+ |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
+ + + + + Chapter 3+ +The Workspace+ + + + + 3.1 Working with MenusMenus provide a list of commands that you can + execute.+ + +
+ + + To execute a command listed in a menu, click in the corresponding item. The item will blink telling that the command is + going to be executed. + + Grayed commands are disabled and cannot be executed at that moment. If you click on them nothing will happen. + + 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. + + + + + 3.1.1 The Root Window MenuThe 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. + + + + + 3.1.2 The Window List MenuClicking 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.+ + + + + + 3.2 Working with ApplicationsIn 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. + + + + + 3.2.1 Hiding an ApplicationIf 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 + +
+ + + To unhide an application + +
+ + 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+ +
+ + There are two other commands in the applications menu related to application hiding: + + +
+ + + + + + 3.2.2 The Application Icon MenuA 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: + + +
3.2.3 The Application DockThe 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 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: + +
+ + 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. + + +
+ + + 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 out put redirectors. (>, >> etc.) + + + + + 3.3 Working with Workspaces+ + + 3.3.1 The Workspaces MenuThe Workspaces Menu allows you to + create, switch, destroy and rename workspaces.+ + It has the following items: + + +
+ + +
+ + + 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: + +
+ + + + + 3.3.2 The workspace clip[This section was unavailable in the + original, and thus is not here]+ + + + + + |
+ |||||||||||||||||||||||||||||||||||||||
|
+ + + + + Chapter 4+ +Configuring Window Maker+ + + + 4.1 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. + + + + + 4.1.1 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)+ +
+ + + Example property list file+
+ {
+ "*" = {
+ 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: + +
+{
+ 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 + + + + 4.1.2 Value Types+ Here is a description of some of the types of values that an option might have: + + +
+ + + + + 4.1.3 PreferencesGeneral 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. + + +
+ + + 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: + + +
+ + Examples: + +
+ + + + +
+ + + Keyboard Bindings+ + Keyboard shortcut specifications are in the form: + + + + [<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: + + +
+ + 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). + + +
+ + + + + + 4.1.4 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: + +
+
+{
+ "*" = {
+ Icon = "defaultAppIcon.xpm";
+ };
+ "xterm.XTerm" = {
+ Icon = "xterm.xpm";
+ };
+ xconsole = {
+ Omnipresent = YES;
+ NoTitlebar = YES;
+ KeepOnTop = NO;
+ };
+}
+
+Window names are in the form1:+ + <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. + + + 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: + + WM_CLASS(STRING) = "xterm", "XTerm" + + The first string (xterm) is the window instance name and the second (XTerm) the window class name.} + + + Options:+ + The default is NO for all options + + + +
+ + + + 4.1.5 Applications MenuThe applications menu (AKA: Root Menu) can be + defined in one of two distinct ways:+ + +
+ + + |
+ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
+ + + + + Chapter 5+ +Tips+ + +
+ + + |
+
|
+ + + + + Glossary+ +
+ + + |
+
|
+ + + + + Chapter 7+ +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. + + + |
+
|
+ + + + Chapter 1: Introduction+ ++ + Chapter 2: Windows+ +
+ + Chapter 3: The Workspace+ +
+ + Chapter 4: Configuring WindowMaker+ +
+ + + Chapter 5: Tips+ + + Chapter 6: Glossary+ + + Chapter 7: Credits+ + + + + |
+