twin/xmonad
1
0
Fork 0
mirror of https://github.com/xmonad/xmonad.git synced 2025-05-19 08:30:21 -07:00
Code Issues Packages Projects Releases Wiki Activity

Generate keybindings section in manpage from Config.hs

Browse Source
This commit is contained in:
Jason Creighton 2007-05-27 06:29:14 +00:00
parent d3f56af172
commit 8cfe050be7
4 changed files with 70 additions and 121 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
Config.hs
View File

@ -17,72 +17,6 @@
module Config where
--
-- xmonad bindings follow mostly the dwm/wmii conventions:
--
-- key combination action
--
-- mod-shift-return new xterm
-- mod-p launch dmenu
-- mod-shift-p launch gmrun
--
-- mod-space switch tiling mode
-- mod-n nudge current window into fullscreen mode
--
-- mod-tab shift focus to next window in stack
-- mod-j shift focus to next window in stack
-- mod-k shift focus previous window in stack
--
-- mod-h decrease the size of the master area
-- mod-l increase the size of the master area
--
-- mod-shift-c kill client
-- mod-shift-q exit window manager
-- mod-shift-ctrl-q restart window manager ('xmonad' must be in $PATH)
--
-- mod-return swap focused window with master window
--
-- mod-1..9 switch to workspace N
-- mod-shift-1..9 move client to workspace N
--
-- mod-w,e,r switch to physical/Xinerama screen 1, 2 or 3.
--
-- xmonad places each window into a "workspace." Each workspace can have
-- any number of windows, which you can cycle though with mod-j and mod-k.
-- Windows are either displayed full screen, tiled horizontally, or tiled
-- vertically. You can toggle the layout mode with mod-space, which will
-- cycle through the available modes.
--
-- You can switch to workspace N with mod-N. For example, to switch to
-- workspace 5, you would press mod-5. Similarly, you can move the current
-- window to another workspace with mod-shift-N.
--
-- When running with multiple monitors (Xinerama), each screen has exactly
-- 1 workspace visible. When xmonad starts, workspace 1 is on screen 1,
-- workspace 2 is on screen 2, etc. If you switch to a workspace which is
-- currently visible on another screen, xmonad simply switches focus to
-- that screen. If you switch to a workspace which is *not* visible, xmonad
-- replaces the workspace on the *current* screen with the workspace you
-- selected.
--
-- For example, if you have the following configuration:
--
-- Screen 1: Workspace 2
-- Screen 2: Workspace 5 (current workspace)
--
-- and you wanted to view workspace 7 on screen 1, you would press:
--
-- mod-2 (to select workspace 2, and make screen 1 the current screen)
-- mod-7 (to select workspace 7)
--
-- Since switching to the workspace currently visible on a given screen is
-- such a common operation, shortcuts are provided: mod-{w,e,r} switch to
-- the workspace currently visible on screens 1, 2, and 3 respectively.
-- Likewise, shift-mod-{w,e,r} moves the current window to the workspace on
-- that screen. Using these keys, the above example would become mod-w
-- mod-7.
--
--
-- Useful imports
--
@ -149,49 +83,47 @@ defaultLayouts = [ full
keys :: M.Map (KeyMask, KeySym) (X ())
keys = M.fromList $
-- launching and killing programs
[ ((modMask .|. shiftMask, xK_Return), spawn "xterm")
, ((modMask, xK_p ), spawn "exe=`dmenu_path | dmenu` && exec $exe")
, ((modMask .|. shiftMask, xK_p ), spawn "gmrun")
, ((modMask .|. shiftMask, xK_c ), kill)
[ ((modMask .|. shiftMask, xK_Return), spawn "xterm") -- @@ Launch an xterm
, ((modMask, xK_p ), spawn "exe=`dmenu_path | dmenu` && exec $exe") -- @@ Launch dmenu
, ((modMask .|. shiftMask, xK_p ), spawn "gmrun") -- @@ Launch gmrun
, ((modMask .|. shiftMask, xK_c ), kill) -- @@ Close the focused window
-- rotate through the available layout algorithms
, ((modMask, xK_space ), switchLayout)
, ((modMask, xK_space ), switchLayout) -- @@ Rotate through the available layout algorithms
-- 'nudge': resize viewed windows to the correct size.
, ((modMask, xK_n ), refresh)
, ((modMask, xK_n ), refresh) -- 'nudge': resize viewed windows to the correct size
-- move focus up or down the window stack
, ((modMask, xK_Tab ), focusDown)
, ((modMask, xK_j ), focusDown)
, ((modMask, xK_k ), focusUp)
, ((modMask, xK_Tab ), focusDown) -- @@ Move focus to the next window
, ((modMask, xK_j ), focusDown) -- @@ Move focus to the next window
, ((modMask, xK_k ), focusUp ) -- @@ Move focus to the previous window
-- modifying the window order
, ((modMask, xK_Return), swapMaster)
, ((modMask .|. shiftMask, xK_j ), swapDown)
, ((modMask .|. shiftMask, xK_k ), swapUp)
, ((modMask, xK_Return), swapMaster) -- @@ Swap the focused window and the master window
, ((modMask .|. shiftMask, xK_j ), swapDown ) -- @@ Swap the focused window with the next window
, ((modMask .|. shiftMask, xK_k ), swapUp ) -- @@ Swap the focused window with the previous window
-- resizing the master/slave ratio
, ((modMask, xK_h ), sendMessage Shrink)
, ((modMask, xK_l ), sendMessage Expand)
, ((modMask, xK_h ), sendMessage Shrink) -- @@ Shrink the master area
, ((modMask, xK_l ), sendMessage Expand) -- @@ Expand the master area
-- increase or decrease number of windows in the master area
, ((modMask , xK_comma ), sendMessage (IncMasterN 1))
, ((modMask , xK_period), sendMessage (IncMasterN (-1)))
, ((modMask , xK_comma ), sendMessage (IncMasterN 1)) -- @@ Increment the number of windows in the master area
, ((modMask , xK_period), sendMessage (IncMasterN (-1))) -- @@ Deincrement the number of windows in the master area
-- quit, or restart
, ((modMask .|. shiftMask, xK_q ), io $ exitWith ExitSuccess)
, ((modMask .|. shiftMask .|. controlMask, xK_q ), restart Nothing True)
, ((modMask .|. shiftMask, xK_q ), io (exitWith ExitSuccess)) -- @@ Quit xmonad
, ((modMask .|. shiftMask .|. controlMask, xK_q ), restart Nothing True) -- @@ Restart xmonad
] ++
-- Keybindings to get to each workspace:
-- mod-[1..9] @@ Switch to workspace N
-- mod-shift-[1..9] @@ Move client to workspace N
[((m .|. modMask, k), f i)
| (i, k) <- zip [0 .. fromIntegral workspaces - 1] [xK_1 ..]
, (f, m) <- [(view, 0), (shift, shiftMask)]]
-- Keybindings to each screen :
-- mod-wer (underneath 123) switches to physical/Xinerama screens 1 2 and 3
-- mod-{w,e,r} @@ Switch to physical/Xinerama screens 1, 2, or 3
-- mod-shift-{w,e,r} @@ Move client to screen 1, 2, or 3
++
[((m .|. modMask, key), screenWorkspace sc >>= f)
| (key, sc) <- zip [xK_w, xK_e, xK_r] [0..]
, (f, m) <- [(view, 0), (shift, shiftMask)]]

1
TODO
View File

@ -1,5 +1,4 @@
- tasks for xmonad 0.2
- generate man page from Config.hs
- screenshots/web page
- testing/ more QC
- check build systems for X11-extras/X11.

31
man/xmonad.1 → man/xmonad.1.in
View File

@ -36,36 +36,7 @@ mod-7 (to select workspace 7)
.PP
Since switching to the workspace currently visible on a given screen is such a common operation, shortcuts are provided: mod-{w,e,r} switch to the workspace currently visible on screens 1, 2, and 3 respectively. Likewise, shift-mod-{w,e,r} moves the current window to the workspace on that screen. Using these keys, the above example would become mod-w mod-7.
.SS Default keyboard bindings
.IP \fBmod\-shift\-return\fR
Launch \fBxterm\fR.
.IP \fBmod\-p\fR
Launch \fBdmenu\fR.
.IP \fBmod\-shift\-p\fR
Launch \fBgmrun\fR.
.IP \fBmod\-space\fR
Switch tiling mode.
.IP "\fBmod\-j\fR or \fBmod\-tab\fR"
Focus next window in stack.
.IP \fBmod\-k\fR
Focus previous window in stack.
.IP \fBmod\-h\fR
Decrease the size of the master area.
.IP \fBmod\-l\fR
Increase the size of the master area.
.IP \fBmod\-shift\-c\fR
Kill client.
.IP \fBmod\-shift\-q\fR
Exit xmonad window manager.
.IP \fBmod\-shift\-ctrl\-q\fR
Restart xmonad window manager.
.IP \fBmod\-return\fR
Cycle the current tiling order.
.IP \fBmod\-[1..9]\fR
Switch to workspace N.
.IP \fBmod\-shift\-[1..9]\fR
Move client to workspace N.
.IP \fBmod\-[w,e,r]\fR
Switch to physical/Xinerama screen 1, 2 or 3.
___KEYBINDINGS___
.SH EXAMPLES
To use \fBxmonad\fR as your window manager add:
.RS

47
util/GenerateManpage.hs Normal file
View File

@ -0,0 +1,47 @@
--
-- Generates man/xmonad.1 from man/xmonad.1.in by filling the list of
-- keybindings with values scraped from Config.hs
--
-- Format for the docstrings in Config.hs takes the following form:
--
-- -- mod-x @@ Frob the whatsit
--
-- "Frob the whatsit" will be used as the description for keybinding "mod-x"
--
-- If the keybinding name is omitted, it will try to guess from the rest of the
-- line. For example:
--
-- [ ((modMask .|. shiftMask, xK_Return), spawn "xterm") -- @@ Launch an xterm
--
-- Here, mod-shift-return will be used as the keybinding name.
--
import Control.Monad
import Text.Regex.Posix
import Data.Char
import Data.List
trim :: String -> String
trim = reverse . dropWhile isSpace . reverse . dropWhile isSpace
guessKeys line = concat $ intersperse "-" (modifiers ++ [map toLower key])
where modifiers = map (!!1) (line =~ "(mod|shift|control)Mask")
(_, _, _, [key]) = line =~ "xK_(\\w+)" :: (String, String, String, [String])
binding :: [String] -> (String, String)
binding [ _, bindingLine, "", desc ] = (guessKeys bindingLine, desc)
binding [ _, _, keyCombo, desc ] = (keyCombo, desc)
allBindings :: String -> [(String, String)]
allBindings xs = map (binding . map trim) (xs =~ "(.*)--(.*)@@(.*)")
-- FIXME: What escaping should we be doing on these strings?
troff :: (String, String) -> String
troff (key, desc) = ".IP \\fB" ++ key ++ "\\fR\n" ++ desc ++ "\n"
replace :: Eq a => a -> a -> [a] -> [a]
replace x y = map (\a -> if a == x then y else a)
main = do
troffBindings <- (concatMap troff . allBindings) `liftM` readFile "./Config.hs"
let sed = unlines . replace "___KEYBINDINGS___" troffBindings . lines
readFile "./man/xmonad.1.in" >>= return . sed >>= writeFile "./man/xmonad.1"