Merge tag '20130209-2' into debianization

20130209-2

1 files changed, 116 insertions, 39 deletions

diff --git a/mcwm.man b/mcwm.man
index 5b234db..6d6cd4a 100644
--- a/mcwm.man
+++ b/mcwm.man
@@ -1,11 +1,14 @@
-.TH mcwm 1 "Nov 07, 2011" "" ""
+.TH mcwm 1 "Apr 30, 2012" "" ""
 .SH NAME
 mcwm \- MC's Window Manager for X11.
 .SH SYNOPSIS
 .B mcwm
 [ 
 .B \-b 
-] width
+width ] 
+[ 
+.B \-i
+]
 [ 
 .B \-t 
 .I terminal-program
@@ -27,6 +30,12 @@ mcwm \- MC's Window Manager for X11.
 .PP
 \-b width sets border width to this many pixels.
 .PP
+\-i turns on icons/hidden windows. 
+.B Please note
+that there is no way from mcwm to get a hidden window back! You have
+to use an external program such as a panel or the mcicon or 9icon
+scripts (see below) to get the window mapped again.
+.PP
 \-t urxvt will start urxvt when MODKEY + Return is pressed. Change to
 your prefered terminal program or something else entirely.
 .PP
@@ -65,44 +74,57 @@ Note that the mouse cursor needs to be inside the window you want to
 move, raise/lower or resize even if it currently has the focus. This
 is a feature, not a bug.
 .PP
-Mod4 + key:
+Mod4 + key on focused window:
 .RS
 .IP \(bu 2
 .B r 
-raise or lower (toggles)
+raise or lower (toggles).
 .IP \(bu 2
 .B x 
-maximize (toggles)
+maximize (toggles).
 .IP \(bu 2
 .B m 
-maximize vertically (toggles)
+maximize vertically (toggles).
+.IP \(bu 2
+.B H 
+resize left.
+.IP \(bu 2
+.B J 
+resize down.
+.IP \(bu 2
+.B K 
+resize up.
+.IP \(bu 2
+.B L
+resize right.
 .IP \(bu 2
 .B h 
-move left
+move left.
 .IP \(bu 2
 .B j 
-move down
+move down.
 .IP \(bu 2
 .B k 
-move up
+move up.
 .IP \(bu 2
 .B l 
-move right
+move right.
 .IP \(bu 2
-.B H 
-resize left
+.B y
+move to upper left corner of monitor.
 .IP \(bu 2
-.B J 
-resize down
+.B u
+move  to upper right corner of monitor.
 .IP \(bu 2
-.B K 
-resize up
+.B b
+move to lower left corner of monitor.
 .IP \(bu 2
-.B L
-resize right
+.B n
+move to lower right corner of monitor.
 .IP \(bu 2
 .B Return
-start terminal
+start terminal or whatever program you have configured with -t or in
+the config.h.
 .IP \(bu 2
 .B Tab
 go to next window in the current workspace window ring. If you release
@@ -110,35 +132,41 @@ MODKEY or press another command key mcwm will change focus to the new
 window. A new press of MODKEY + Tab will bring you back to the window
 where you last had focus.
 .IP \(bu 2
-.B f
-fix window so it is visible on all workspaces. Toggles. Press again to
-unfix window. Also used to move windows between workspaces: First fix
-the window, change to the workspace you want, then unfix the window on
-the new workspace.
-.IP \(bu 2
-.B y
-move to upper left corner of physical screen.
-.IP \(bu 2
-.B u
-move  to upper right corner of physical screen..
+.B Shift-Tab
+go to previous window in the current workspace window ring. This is
+most useful while you are tabbing: if you accidentally pressed Tab one
+time too many, you can move back by pressing Shift + TAB (all the
+while holding down the MODKEY).
 .IP \(bu 2
-.B b
-move to lower left corner of physical screen..
+.B f
+fix window so it is visible on all workspaces (toggles). Note that
+this is also used to move windows between workspaces: First fix the
+window, change to the workspace you want, then unfix the window on the
+new workspace.
 .IP \(bu 2
-.B n
-move to lower right corner of physical screen..
+.B i
+iconify (or hide) window from the display. Only usable when mcwm has
+been started with -i. Currently there is no way to get a hidden window
+back. You have to use an external program such as a panel or the
+mcicon or 9icon script in the mcwm distribution.
 .IP \(bu 2
 .B 0\-9
 go to workspace n, 0-9.
 .IP \(bu 2
+.B c
+go to previous workspace.
+.IP \(bu 2
+.B v
+go to next workspace.
+.IP \(bu 2
 .B End
-close focused window.
+close window.
 .IP \(bu 2
 .B ,
-move window to previous physical screen.
+move window to previous monitor.
 .IP \(bu 2
 .B .
-move window to next physical screen.
+move window to next monitor.
 .RE
 .PP
 Note that all functions activated from the keyboard work on the
@@ -147,8 +175,12 @@ cursor. Of course, changing workspaces has nothing to do with the
 focused window.
 .PP
 If you don't like the default key bindings, border width, et cetera,
-look in the config.h file, change and recompile.
-.PP
+look in the config.h file, change and recompile. In the config.h file
+you can also define mouse button actions on the root window. By
+default button 3 starts the command mcmenu. You can write your own
+mcmenu by using, for instance, 9menu, dmenu or ratmenu.
+.SH ENVIRONMENT
+.B mcwm\fP obeys the $DISPLAY variable.
 .SH STARTING
 Typically the window manager is started from a script, either run by
 .B startx(1) 
@@ -174,10 +206,55 @@ xrdb \-load ~/.Xresources
 # Start window manager in the background. If it dies, X still lives.
 mcwm &
 
+# If you want to allow windows to be hidden, use this instead:
+# mcwm -i &
+
 # Start a terminal in the foreground. If this dies, X dies.
 exec urxvt
 .fi
 .in -4
 .sp
+.SH SCRIPTS
+You may want to define a menu program for use with mcwm (see
+config.h). In the source distribution you can find an example as
+mcmenu (the default menu program in config.h) in the scripts
+directory.
+.PP
+Christian Neukirchen wrote a little script you can use to get
+iconified windows mapped again if you are running mcwm in allow icons
+mode (-i). You need awk, xdotool, xprop and xwininfo installed. You
+can find the script as scripts/9icon.
+.PP
+Inspired by Christian's work I wrote a small program, hidden(1), which
+is included with mcwm. You can use hidden(1) with the -c option
+together with 9menu. See scripts/mcicon for an example.
+.PP
+You might also be interested in the following shell function that
+might come in handy to give your terminal emulators good titles before
+hiding them.
+.sp
+.in +4
+.nf
+# Set the title and icon name of an xterm or clone.
+function title
+{
+    # icon name
+    echo -e '\\033]1;'$1'\\007'
+    # title
+    echo -e '\\033]2;'$1'\\007'
+}
+.fi
+.in -4
+.sp
+Use it like this:
+.sp
+.in +4
+.nf
+% title 'really descriptive title'
+.fi
+.in -4
+.sp
+.SH SEE ALSO
+.B hidden(1)
 .SH AUTHOR
 Michael Cardell Widerkrantz <mc@hack.org>.