<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>XMonad.Util.Scratchpad</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_XMonad-Util-Scratchpad.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Util-Scratchpad.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">xmonad-contrib-0.11: Third party extensions for xmonad</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>unportable</td></tr><tr><th>Stability</th><td>unstable</td></tr><tr><th>Maintainer</th><td>Braden.Shepherdson@gmail.com</td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">XMonad.Util.Scratchpad</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Usage
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Very handy hotkey-launched floating terminal window.
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:scratchpadSpawnAction">scratchpadSpawnAction</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:XConfig">XConfig</a> l -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:scratchpadSpawnActionTerminal">scratchpadSpawnActionTerminal</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:scratchpadSpawnActionCustom">scratchpadSpawnActionCustom</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:scratchpadManageHookDefault">scratchpadManageHookDefault</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:ManageHook">ManageHook</a></li><li class="src short"><a href="#v:scratchpadManageHook">scratchpadManageHook</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-StackSet.html#t:RationalRect">RationalRect</a> -> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:ManageHook">ManageHook</a></li><li class="src short"><a href="#v:scratchpadFilterOutWorkspace">scratchpadFilterOutWorkspace</a> :: [<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WindowSpace">WindowSpace</a>] -> [<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WindowSpace">WindowSpace</a>]</li></ul></div><div id="interface"><h1 id="g:1">Usage
</h1><div class="doc"><p>Bind a key to <code><a href="XMonad-Util-Scratchpad.html#v:scratchpadSpawnAction">scratchpadSpawnAction</a></code>
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 <code>NSP</code>.
</p><p>If you already have a workspace called <code>NSP</code>, it will use that.
<code>NSP</code> will also appear in xmobar and dzen status bars. You can tweak your
<code>dynamicLog</code> settings to filter it out if you like.
</p><p>A tool like detach (<a href="http://detach.sourceforge.net">http://detach.sourceforge.net</a>) turns it
into a launchpad for X apps.
</p><p>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.
</p><p>The terminal application must support the <code>-name</code> argument.
Known supported terminals: rxvt, rxvt-unicode, xterm.
Most others are likely to follow the lead set by xterm.
</p><p>Bind the following to a key in your xmonad.hs keybindings:
</p><pre> scratchpadSpawnAction conf
</pre><p>Where <code>conf</code> is the configuration.
</p><p>And add one of the <code>scratchpadManageHook*</code>s to your ManageHook list.
The default rectangle is half the screen wide and a quarter of the
screen tall, centered.
</p></div><div class="top"><p class="src"><a name="v:scratchpadSpawnAction" class="def">scratchpadSpawnAction</a><a href="src/XMonad-Util-Scratchpad.html#scratchpadSpawnAction" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:XConfig">XConfig</a> l</td><td class="doc"><p>The configuration, to retrieve the terminal
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Action to pop up the terminal, for the user to bind to a custom key.
</p></div></div><div class="top"><p class="src"><a name="v:scratchpadSpawnActionTerminal" class="def">scratchpadSpawnActionTerminal</a><a href="src/XMonad-Util-Scratchpad.html#scratchpadSpawnActionTerminal" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></td><td class="doc"><p>Name of the terminal program
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Action to pop up the terminal, with a directly specified terminal.
</p></div></div><div class="top"><p class="src"><a name="v:scratchpadSpawnActionCustom" class="def">scratchpadSpawnActionCustom</a><a href="src/XMonad-Util-Scratchpad.html#scratchpadSpawnActionCustom" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></td><td class="doc"><p>Command to spawn a program with resource "scratchpad"
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:X">X</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Action to pop up any program with the user specifying how to set
its resource to "scratchpad". For example, with gnome-terminal:
</p><pre> scratchpadSpawnActionCustom "gnome-terminal --disable-factory --name scratchpad"
</pre></div></div><div class="top"><p class="src"><a name="v:scratchpadManageHookDefault" class="def">scratchpadManageHookDefault</a> :: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:ManageHook">ManageHook</a><a href="src/XMonad-Util-Scratchpad.html#scratchpadManageHookDefault" class="link">Source</a></p><div class="doc"><p>The ManageHook, with the default rectangle:
Half the screen wide, a quarter of the screen tall, centered.
</p></div></div><div class="top"><p class="src"><a name="v:scratchpadManageHook" class="def">scratchpadManageHook</a><a href="src/XMonad-Util-Scratchpad.html#scratchpadManageHook" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-StackSet.html#t:RationalRect">RationalRect</a></td><td class="doc"><p>User-specified screen rectangle.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:ManageHook">ManageHook</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>The ManageHook, with a user-specified StackSet.RationalRect,
e.g., for a terminal 4/10 of the screen width from the left, half
the screen height from the top, and 6/10 of the screen width by
3/10 the screen height, use:
</p><pre> scratchpadManageHook (W.RationalRect 0.4 0.5 0.6 0.3)
</pre></div></div><div class="top"><p class="src"><a name="v:scratchpadFilterOutWorkspace" class="def">scratchpadFilterOutWorkspace</a> :: [<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WindowSpace">WindowSpace</a>] -> [<a href="/usr/share/doc/ghc/html/libraries/xmonad-0.11/XMonad-Core.html#t:WindowSpace">WindowSpace</a>]<a href="src/XMonad-Util-Scratchpad.html#scratchpadFilterOutWorkspace" class="link">Source</a></p><div class="doc"><p>Transforms a workspace list containing the SP workspace into one that
doesn't contain it. Intended for use with logHooks.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>
