Use consistent names

[bspwm.git] / bspwm.1

diff --git a/bspwm.1 b/bspwm.1
index fa607902eccab909ce70f5b928f2ea9de187cbe1..2bccf8b281ab834430e82aebf14bfcb026ec723d 100644 (file)
--- a/bspwm.1
+++ b/bspwm.1
@@ -3,14 +3,16 @@
 bspwm \- Tiling window manager based on binary space partitioning
 .SH SYNOPSIS
 .B bspwm
-.RI [ -v | "-s STATUS_FIFO" ]
+.RI [ -h | -v | "-s PANEL_FIFO" | "-p PANEL_PREFIX" ]
 .P
 .BI bspc " MESSAGE"
 .RI [ ARGUMENTS ]
 .RI [ OPTIONS ]
 .SH DESCRIPTION
 .B bspwm
-is a tiling window manager where each window is represented as the leaf of a binary tree. It is controlled and configured via
+is a tiling window manager where each window is represented as the leaf of a binary tree.
+.P
+It is controlled and configured via
 .BR bspc .
 .SH CONFIGURATION
 .B bspwm
@@ -18,28 +20,15 @@ have only two sources of informations: the
 .B X
 events it receives and the messages it reads on a dedicated socket.
 .P
-Those messages are sent via
-.BR bspc .
-.P
-If the
-.I BSPWM_SOCKET
-environment variable is defined, it will be used as the socket path, otherwise
-.I /tmp/bspwm-socket
-is used.
+Its configuration file is
+.IR $XDG_CONFIG_HOME/bspwm/autostart .
 .P
-The recommended way of defining keyboard shortcuts is to use
+Keyboard and pointer bindings are defined through
 .BR sxhkd .
 .P
-The only way to configure
-.B bspwm
-is by sending
-.I set
-messages via the client, hence
-.BR bspwm \'s
-configuration file is an executable called
-.I autostart
-which lives in
-.IR $XDG_CONFIG_HOME/bspwm/ .
+Example configuration files can be found in the
+.I examples
+directory.
 .SH SPLITTING MODES
 There is only two splitting modes:
 .IR automatic " and " manual .
@@ -141,8 +130,8 @@ Focus the neighbor window situated in the given direction.
 .BI shift " left|right|up|down"
 Exchange the current window with the given neighbor.
 .TP
-.BI swap
-Swap the focused window with the last focused window.
+.BI swap " [biggest|smallest]"
+Swap the focused window with the biggest/smallest window or with the last focused window if no arguments are given.
 .TP
 .BI push " left|right|up|down"
 Push the fence located in the given direction.
@@ -248,7 +237,7 @@ Flip the window tree.
 .B balance
 Adjust the split ratios so that all windows occupy the same area.
 .TP
-.BI rule " PATTERN [DESKTOP_NAME] [floating]"
+.BI rule " PATTERN [DESKTOP_NAME] [floating] [follow]"
 Create a new rule (PATTERN must match the class or instance name).
 .TP
 .BI remove_rule " UID ..."
@@ -257,12 +246,6 @@ Remove the rules with the given UIDs.
 .BI adopt_orphans
 Manage all the unmanaged windows remaining from a previous session.
 .TP
-.BI reload_autostart
-Reload the autostart file.
-.TP
-.BI reload_settings
-Reload the default settings.
-.TP
 .BI restore " FILE_PATH"
 Restore the layout of each desktop from the content of FILE_PATH.
 .TP
@@ -333,7 +316,7 @@ Whether to remove borders for tiled windows in monocle mode.
 Whether to remove gaps for tiled windows in monocle mode.
 .TP
 .I focus_follows_pointer
-Wether to focus the window under the pointer.
+Whether to focus the window under the pointer.
 .TP
 .I adaptative_raise
 Prevent floating windows from being raised when they might cover other floating windows.
@@ -342,12 +325,25 @@ Prevent floating windows from being raised when they might cover other floating
 Enable shadows for floating windows via the
 .B _COMPTON_SHADOW
 property.
+.TP
+.I auto_alernate
+Whether to interpret two consecutive identical
+.B use
+messages as an
+.B alternate
+message.
+.SH ENVIRONMENT VARIABLES
+.TP
+.I BSPWM_SOCKET
+The path of the socket used for the communication between
+.BR bspc " and " bspwm .
 .SH AUTHOR
 .EX
 Bastien Dejean <baskerville at lavabit.com>
 .SH CONTRIBUTORS
 .EX
 Ivan Kanakarakis <ivan.kanak at gmail.com>
+Thomas Adam <thomas at xteddy.org>
 .EE
 .SH HOMEPAGE
 .TP