]> git.lizzy.rs Git - bspwm.git/commitdiff
Update and enhance documentation
authorBastien Dejean <nihilhill@gmail.com>
Sun, 2 Jun 2013 09:00:15 +0000 (11:00 +0200)
committerBastien Dejean <nihilhill@gmail.com>
Sun, 2 Jun 2013 09:00:15 +0000 (11:00 +0200)
README.md
bspwm.1

index 62093ca2ee4072b2cd66c5255cb1bfb2e8aa1a5a..90097c8af8c9fd4f5c2b7171b5d7378b30a12af6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@
 
 ## Description
 
-`bspwm` is a tiling window manager where each window is represented as the leaf of a binary tree.
+`bspwm` is a tiling window manager that represents windows as the leaves of a full binary tree.
 
 It is controlled and configured via `bspc`.
 
@@ -18,7 +18,7 @@ It is controlled and configured via `bspc`.
 
 Its configuration file is `$XDG_CONFIG_HOME/bspwm/autostart`.
 
-Keyboard and pointer bindings are defined through [sxhkd](https://github.com/baskerville/sxhkd).
+Keyboard and pointer bindings are defined with [sxhkd](https://github.com/baskerville/sxhkd).
 
 Example configuration files can be found in the `examples` directory.
 
@@ -67,6 +67,12 @@ was sent beforehand:
         |            |            |         |            |            |
         +-------------------------+         +-------------------------+
 
+## Containers
+
+Each monitor contains at least one desktop.
+
+Each desktop contains at most one tree.
+
 ## Messages
 
 The syntax for the client is `bspc MESSAGE [ARGUMENTS ...]`.
@@ -101,7 +107,7 @@ The following messages are handled:
 
 - `shift left|right|up|down` — Exchange the current window with the given neighbor.
 
-- `swap [--swap-focus|--keep-focus]` — Swap the focused window the last focused window.
+- `swap [--swap-focus|--keep-focus]` — Swap the focused window with the last focused window.
 
 - `push left|right|up|down` — Push the fence located in the given direction.
 
@@ -240,15 +246,14 @@ Colors are either [X color names](http://en.wikipedia.org/wiki/X11_color_names)
 ## Key Features
 
 - Configured and controlled through messages.
-- Multiple monitors support (via *Xinerama*).
+- Multiple monitors support (via *RandR*).
 - EWMH support (`tint2` works).
 - Automatic and manual modes.
 
 ## Panels
 
-- Any EWMH compliant panel (e.g. `tint2`, `bmpanel2`, etc.).
+- Any EWMH compliant panel (e.g.: `tint2`, `bmpanel2`, etc.).
 - A custom panel if the `-s` flag is used (have a look at the files in `examples/panel`).
-- `dzen2` fed with the output of `ewmhstatus`. Example: [launchpanel](https://github.com/baskerville/bin/blob/master/launchpanel).
 
 ## Required Libraries:
 
diff --git a/bspwm.1 b/bspwm.1
index 4b59c5a5678a3332f487fe24daf4fdb9854b82c9..51f82a8c0fb52d2b5a9f8a89cae3e810c6504fdc 100644 (file)
--- a/bspwm.1
+++ b/bspwm.1
@@ -10,7 +10,7 @@ bspwm \- Tiling window manager based on binary space partitioning
 .RI [ OPTIONS ]
 .SH DESCRIPTION
 .B bspwm
-is a tiling window manager where each window is represented as the leaf of a binary tree.
+is a tiling window manager that represents windows as the leaves of a full binary tree.
 .P
 It is controlled and configured via
 .BR bspc .
@@ -23,7 +23,7 @@ events it receives and the messages it reads on a dedicated socket.
 Its configuration file is
 .IR $XDG_CONFIG_HOME/bspwm/autostart .
 .P
-Keyboard and pointer bindings are defined through
+Keyboard and pointer bindings are defined with
 .BR sxhkd .
 .P
 Example configuration files can be found in the
@@ -89,6 +89,11 @@ message was sent beforehand:
     +-------------------------+         +-------------------------+
 
 .EE
+.SH CONTAINERS
+.P
+Each monitor contains at least one desktop.
+.P
+Each desktop contains at most one tree.
 .SH MESSAGES
 .TP
 .BI get " SETTING"