<!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.Actions.SpawnOn</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-Actions-SpawnOn.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/XMonad-Actions-SpawnOn.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.9.2: 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>Spencer Janssen <spencerjanssen@gmail.com></td></tr></table><p class="caption">XMonad.Actions.SpawnOn</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>Provides a way to modify a window spawned by a command(e.g shift it to the workspace
it was launched on) by using the _NET_WM_PID property that most windows set on creation.
Hence this module won't work on applications that don't set this property.
</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"><span class="keyword">data</span> <a href="#t:Spawner">Spawner</a> </li><li class="src short"><a href="#v:mkSpawner">mkSpawner</a> :: (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Control-Monad.html#t:Functor">Functor</a> m, <a href="/usr/share/doc/ghc/html/libraries/transformers-0.2.2.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m) => m <a href="XMonad-Actions-SpawnOn.html#t:Spawner">Spawner</a></li><li class="src short"><a href="#v:manageSpawn">manageSpawn</a> :: <a href="XMonad-Actions-SpawnOn.html#t:Spawner">Spawner</a> -> ManageHook</li><li class="src short"><a href="#v:spawnHere">spawnHere</a> :: <a href="XMonad-Actions-SpawnOn.html#t:Spawner">Spawner</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:spawnOn">spawnOn</a> :: <a href="XMonad-Actions-SpawnOn.html#t:Spawner">Spawner</a> -> WorkspaceId -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:spawnAndDo">spawnAndDo</a> :: <a href="XMonad-Actions-SpawnOn.html#t:Spawner">Spawner</a> -> ManageHook -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:shellPromptHere">shellPromptHere</a> :: <a href="XMonad-Actions-SpawnOn.html#t:Spawner">Spawner</a> -> <a href="XMonad-Prompt.html#t:XPConfig">XPConfig</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:shellPromptOn">shellPromptOn</a> :: <a href="XMonad-Actions-SpawnOn.html#t:Spawner">Spawner</a> -> WorkspaceId -> <a href="XMonad-Prompt.html#t:XPConfig">XPConfig</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li></ul></div><div id="interface"><h1 id="g:1">Usage
</h1><div class="doc"><p>You can use this module with the following in your <code>~/.xmonad/xmonad.hs</code>:
</p><pre> import XMonad.Actions.SpawnOn
</pre><pre> main = do
sp <- mkSpawner
xmonad defaultConfig {
...
manageHook = manageSpawn sp <+> manageHook defaultConfig
...
}
</pre><p>To ensure that application appears on a workspace it was launched at, add keybindings like:
</p><pre> , ((mod1Mask,xK_o), spawnHere sp "urxvt")
, ((mod1Mask,xK_s), shellPromptHere sp defaultXPConfig)
</pre><p>The module can also be used to apply other manage hooks to the window of
the spawned application(e.g. float or resize it).
</p><p>For detailed instructions on editing your key bindings, see
<a href="XMonad-Doc-Extending.html#Editing_key_bindings">XMonad.Doc.Extending</a>.
</p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Spawner" class="def">Spawner</a> <a href="src/XMonad-Actions-SpawnOn.html#Spawner" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:mkSpawner" class="def">mkSpawner</a> :: (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Control-Monad.html#t:Functor">Functor</a> m, <a href="/usr/share/doc/ghc/html/libraries/transformers-0.2.2.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m) => m <a href="XMonad-Actions-SpawnOn.html#t:Spawner">Spawner</a><a href="src/XMonad-Actions-SpawnOn.html#mkSpawner" class="link">Source</a></p><div class="doc"><p>Create <code><a href="XMonad-Actions-SpawnOn.html#t:Spawner">Spawner</a></code> which then has to be passed to other functions.
</p></div></div><div class="top"><p class="src"><a name="v:manageSpawn" class="def">manageSpawn</a> :: <a href="XMonad-Actions-SpawnOn.html#t:Spawner">Spawner</a> -> ManageHook<a href="src/XMonad-Actions-SpawnOn.html#manageSpawn" class="link">Source</a></p><div class="doc"><p>Provides a manage hook to react on process spawned with
<code><a href="XMonad-Actions-SpawnOn.html#v:spawnOn">spawnOn</a></code>, <code><a href="XMonad-Actions-SpawnOn.html#v:spawnHere">spawnHere</a></code> etc.
</p></div></div><div class="top"><p class="src"><a name="v:spawnHere" class="def">spawnHere</a> :: <a href="XMonad-Actions-SpawnOn.html#t:Spawner">Spawner</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/XMonad-Actions-SpawnOn.html#spawnHere" class="link">Source</a></p><div class="doc"><p>Replacement for <code>spawn</code> which launches
application on current workspace.
</p></div></div><div class="top"><p class="src"><a name="v:spawnOn" class="def">spawnOn</a> :: <a href="XMonad-Actions-SpawnOn.html#t:Spawner">Spawner</a> -> WorkspaceId -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/XMonad-Actions-SpawnOn.html#spawnOn" class="link">Source</a></p><div class="doc"><p>Replacement for <code>spawn</code> which launches
application on given workspace.
</p></div></div><div class="top"><p class="src"><a name="v:spawnAndDo" class="def">spawnAndDo</a> :: <a href="XMonad-Actions-SpawnOn.html#t:Spawner">Spawner</a> -> ManageHook -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/XMonad-Actions-SpawnOn.html#spawnAndDo" class="link">Source</a></p><div class="doc"><p>Spawn an application and apply the manage hook when it opens.
</p></div></div><div class="top"><p class="src"><a name="v:shellPromptHere" class="def">shellPromptHere</a> :: <a href="XMonad-Actions-SpawnOn.html#t:Spawner">Spawner</a> -> <a href="XMonad-Prompt.html#t:XPConfig">XPConfig</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/XMonad-Actions-SpawnOn.html#shellPromptHere" class="link">Source</a></p><div class="doc"><p>Replacement for Shell prompt (<a href="XMonad-Prompt-Shell.html">XMonad.Prompt.Shell</a>) which launches
application on current workspace.
</p></div></div><div class="top"><p class="src"><a name="v:shellPromptOn" class="def">shellPromptOn</a> :: <a href="XMonad-Actions-SpawnOn.html#t:Spawner">Spawner</a> -> WorkspaceId -> <a href="XMonad-Prompt.html#t:XPConfig">XPConfig</a> -> X <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/XMonad-Actions-SpawnOn.html#shellPromptOn" class="link">Source</a></p><div class="doc"><p>Replacement for Shell prompt (<a href="XMonad-Prompt-Shell.html">XMonad.Prompt.Shell</a>) which launches
application on given workspace.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
