xmonad-contrib-0.8.1: Third party extensions for xmonadSource codeContentsIndex
XMonad.Util.Scratchpad
Portabilityunportable
Stabilityunstable
MaintainerBraden.Shepherdson@gmail.com
Contents
Usage
Description
Very handy hotkey-launched floating terminal window.
Synopsis
scratchpadSpawnAction :: XConfig l -> X ()
scratchpadSpawnActionTerminal :: String -> X ()
scratchpadManageHookDefault :: ManageHook
scratchpadManageHook :: RationalRect -> ManageHook
scratchpadFilterOutWorkspace :: [WindowSpace] -> [WindowSpace]
Usage

Bind a key to scratchpadSpawnAction Pressing it will spawn the terminal, or bring it to the current workspace if it already exists. Pressing the key with the terminal on the current workspace will send it to a hidden workspace called SP.

If you already have a workspace called SP, it will use that. SP will also appear in xmobar and dzen status bars. You can tweak your dynamicLog settings to filter it out if you like.

A tool like detach (http://detach.sourceforge.net) turns it into a launchpad for X apps.

By default, your xmonad terminal is used. The default ManageHook uses a centered, half-screen-wide, quarter-screen-tall window. The key, position and size are configurable.

The terminal application must support the -name argument. Known supported terminals: rxvt, rxvt-unicode, xterm. Most others are likely to follow the lead set by xterm.

Bind the following to a key in your xmonad.hs keybindings: 

 scratchpadSpawnAction conf

Where conf is the configuration.

And add one of the scratchpadManageHook*s to your ManageHook list. The default rectangle is half the screen wide and a quarter of the screen tall, centered.

scratchpadSpawnActionSource
::
=> XConfig lThe configuration, to retrieve the terminal
-> X ()
Action to pop up the terminal, for the user to bind to a custom key.
scratchpadSpawnActionTerminalSource
:: StringName of the terminal program
-> X ()
Action to pop up the terminal, with a directly specified terminal.
scratchpadManageHookDefault :: ManageHookSource
The ManageHook, with the default rectangle: Half the screen wide, a quarter of the screen tall, centered.
scratchpadManageHookSource
:: RationalRectUser-specified screen rectangle.
-> ManageHook

The ManageHook, with a user-specified StackSet.RationalRect, eg. 

 scratchpadManageHook (W.RationalRect 0.25 0.375 0.5 0.25)
scratchpadFilterOutWorkspace :: [WindowSpace] -> [WindowSpace]Source
Transforms a workspace list containing the SP workspace into one that doesn't contain it. Intended for use with logHooks.
Produced by Haddock version 2.4.2