commit 28fa7146f2dd808c64c6d79e4854403024fd37bc
parent dba156e3f906401362630fdba24a9aa23d8be7f8
Author: Anselm R. Garbe <garbeam@wmii.de>
Date: Fri, 28 Apr 2006 16:39:29 +0200
proceeded with wmiiwm.1 man page, not finished yet though
Diffstat:
| cmd/wm/wmiiwm.1 | | | 158 | ++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------------- |
1 file changed, 105 insertions(+), 53 deletions(-)
diff --git a/cmd/wm/wmiiwm.1 b/cmd/wm/wmiiwm.1
@@ -11,72 +11,122 @@ wmiiwm \- window manager improved 2 (core)
.SS Overview
.BR wmiiwm (1)
is the core of the window manager improved 2.
+.P
+.BR wmii
+is a dynamic window manager for X11. In contrast to static window management
+the user rarely has to think about how to organize windows, no matter what he
+is doing or how many applications are used at the same time. The window manager
+adapts to the current environment and helps the user to fit to his needs,
+rather than forcing him to use a preset, fixed layout and trying to
+shoehorn all windows and applications into it.
+.P
+.BR wmii
+supports classic and tiled window management with extended keyboard and mouse
+control. The classic window management arranges windows in a floating layer,
+whereas windows can be moved and resized freely. The tiled window management
+is based on columns which split up the screen horizontally. Each column handles
+arbitrary windows and arranges them vertically in a non-overlapping way,
+whereas windows can be moved and resized between and within columns freely.
+.P
+.BR wmii
+provides a virtual filesystem which represents the internal state pretty much
+similiar to the procfs of Unix operating systems. Modifying this virtual
+filesystem results in changing the state of the window manager. The virtual
+filesystem service can be accessed through 9P-capable client programs,
+like
+.BR wmiir (1) .
+This allows simple and powerful remote control of the core window manager.
+.P
.BR wmii
-is a dynamic window manager for X11.
-.br
-Dynamic window management states that it is the window manager's job to manage
-windows - and not the user's job to have to set up some specialized layout that
-will only work for specific work scenarios.
-.br
-In contrast to static window management, the user rarely has to think about how
-to organize windows, no matter what he is doing or how many applications are
-used at the same time. The window manager adapts to the current environment and
-helps the user to fit to his needs, rather than forcing him to use a preset,
-fixed layout and trying to shoehorn all windows and applications into it.
-.br
-Dynamic window management has many advantages - one can create and tear down
-whole working environments in a matter of seconds, rather than spending months
-fine-tuning a fixed layout that would never work well in all cases anyway. The
-number and nature of windows one works with, changes all the time, and a dynamic
-window manager lets the user adapt to that and always efficiently use its
-precious screen real estate.
-.br wmii
-supports classic and tiled window management with extended keyboard and
-mouse control.
-.br
-The classic window management provides the user to arrange his windows
-in a floating layer without much support by the window manager. Windows can be
-moved and resized on the screen freely.
-.br
-The tiled window management of
-.br wmii
-is based on columns which split up the screen horizontally. Each column
-handles arbitrary windows and arranges them vertically in a non-overlapping
-way. Each column is a stack of windows. The user can move the windows
-freely between columns and resize the height of such tiled windows.
-.br wmii
-provides a virtual filesystem which represents the internal data structure
-and states as a file hierarchy, pretty much similiar to the
-.IR procfs
-of Unix operating systems. Modifying this virtual filesystem results in
-changing the state of the window manager. The filesystem service can be
-accessed through 9P-capable client programs.to client programs like
-.br wmiir (1)
-which
-, and 9P-based remote control.
+basically consists of clients, columns, views, and the bar, which are described
+in detail in the next section.
+.SS Options
+.TP
+.BI \-a " address"
+Lets you specify the address which
+.B wmiiwm
+uses to listen for connections. The syntax for
+.I address
+is taken (along with many other profound ideas) from the Plan 9 operating
+system and has the form
+.BR unix!/path/to/socket
+for unix socket files, and
+.BR tcp!hostname!port
+for tcp sockets.
+.TP
+.B \-c
+Checks if another window manager is running. If not it exits with termination code
+0.
+.TP
+.B \-v
+Prints version information to stdout, then exits.
.SS Terminology
.TP 2
+Display
+A running X server instance consisting of input devices and screens.
+.TP 2
Screen
-
+A physical or virtual (Xinerama or
+.BR Xnest (1))
+screen of an X display. A screen displays a bar window and a view at a time.
.TP 2
-View
-
+Window
+A (rectangular) drawable X object which is displayed on a screen, usually an
+application window.
.TP 2
-Tag
-
+Client
+An application window surrounded with a frame window, which contains a border
+and a title-bar. The title-bar consists of two labels, the tags of a client, and
+the client's title.
.TP 2
Floating layer
-
+A screen layer of
+.BR wmii
+on top of all other layers, where clients are arranged in a floating way.
+They can be resized or moved freely.
.TP 2
Managed layer
-
+A screen layer of
+.BR wmii
+behind the floating layer, where clients are arranged in a non-overlapping
+(managed) way. The window manager keeps track that they not overlap each others.
+The managed layer consists of columns.
+.TP 2
+Tag
+Alphanumeric strings which can be assigned to a client. This allows to address
+single clients or groups of clients with a single tag, e.g.
+.IR work ,
+or several tags, e.g.
+.IR work+mail .
+Tags are separated with the
+.I +
+character.
+.TP 2
+View
+A set of clients containing a specific tag, quite similiar to a workspace in
+other window managers. It consists of the floating and managed layers.
.TP 2
Column
-
+A column is a screen area which arranges clients vertically in a
+non-overlapping way. Columns provide three different modes, which arrange
+clients with equal size, stacked, or maximized respectively. Clients can be
+moved and resized between and within columns freely.
.TP 2
-Client
-
-.SS Configuration
+Bar
+The bar at the bottom of the screen displays a label for each view and
+allows to create arbitrary user-defined labels.
+.SS Basic window management
+Running a raw
+.BR wmiiwm
+process without the
+.BR wmii (1)
+script provides basic window management capabilities already. However it is
+necessary to control the window manager remotely through its filesystem
+interface, to use it effectively. By default it is only usable with the mouse
+and you need to do
+.BR wmiir (1)
+calls to kill clients, if they don't provide a way to be closed nicely.
+.SS File system
If you feel the need to change the default configuration, then customize (as
described above) the
.B wmiirc
@@ -84,6 +134,8 @@ action. This action is executed at the end of the
.BR wmii (1)
script and does all the work of setting up the window manager, the key
bindings, the bar labels, etc.
+.SH EXAMPLES
+.TP
.SH FILES
.TP
/tmp/ns.$USER.$DISPLAY/wmii
