From 735fb58f6cc2b52fcc2c8b24d5e1d3e127bae86e Mon Sep 17 00:00:00 2001 From: slotThe Date: Sun, 27 Dec 2020 19:19:21 +0100 Subject: [PATCH 1/2] Revise XDG handling Improve handling of the whole XDG situation. This now looks as follows 1. If all three of xmonad's environment variables (XMONAD_DATA_DIR, XMONAD_CONFIG_DIR, and XMONAD_CACHE_DIR) are set, use them. 2. If there is a build script `build' or configuration `xmonad.hs' in `~/.xmonad', set all three directories to `~/.xmonad'. 3. Otherwise, use XDG_DATA_HOME, XDG_CONFIG_HOME, and XDG_CACHE_HOME (or their respective fallbacks). If none of the above exist, we default to using the XDG_* variables, creating the necessary directories if needed. --- src/XMonad/Core.hs | 215 +++++++++++++++++---------------------- src/XMonad/Main.hs | 32 +++--- src/XMonad/Operations.hs | 12 +-- 3 files changed, 116 insertions(+), 143 deletions(-) diff --git a/src/XMonad/Core.hs b/src/XMonad/Core.hs index 5bd97b4..24a1974 100644 --- a/src/XMonad/Core.hs +++ b/src/XMonad/Core.hs @@ -1,5 +1,6 @@ {-# LANGUAGE ExistentialQuantification, FlexibleInstances, GeneralizedNewtypeDeriving, - MultiParamTypeClasses, TypeSynonymInstances, DeriveDataTypeable #-} + MultiParamTypeClasses, TypeSynonymInstances, DeriveDataTypeable, + LambdaCase, NamedFieldPuns, DeriveTraversable #-} ----------------------------------------------------------------------------- -- | @@ -28,7 +29,7 @@ module XMonad.Core ( getAtom, spawn, spawnPID, xfork, recompile, trace, whenJust, whenX, getXMonadDir, getXMonadCacheDir, getXMonadDataDir, stateFileName, atom_WM_STATE, atom_WM_PROTOCOLS, atom_WM_DELETE_WINDOW, atom_WM_TAKE_FOCUS, withWindowAttributes, - ManageHook, Query(..), runQuery + ManageHook, Query(..), runQuery, Directories(..), Dirs, getDirs ) where import XMonad.StackSet hiding (modify) @@ -36,10 +37,12 @@ import XMonad.StackSet hiding (modify) import Prelude import Control.Exception.Extensible (fromException, try, bracket, throw, finally, SomeException(..)) import qualified Control.Exception.Extensible as E +import Control.Applicative ((<|>), empty) import Control.Monad.Fail import Control.Monad.State import Control.Monad.Reader import Data.Semigroup +import Data.Traversable (for) import Data.Default import System.FilePath import System.IO @@ -57,7 +60,6 @@ import Graphics.X11.Xlib.Extras (getWindowAttributes, WindowAttributes, Event) import Data.Typeable import Data.List ((\\)) import Data.Maybe (isJust,fromMaybe) -import System.Environment (lookupEnv) import qualified Data.Map as M import qualified Data.Set as S @@ -91,8 +93,8 @@ data XConf = XConf , mousePosition :: !(Maybe (Position, Position)) -- ^ position of the mouse according to -- the event currently being processed - , currentEvent :: !(Maybe Event) - -- ^ event currently being processed + , currentEvent :: !(Maybe Event) -- ^ event currently being processed + , dirs :: !Dirs -- ^ directories to use } -- todo, better name @@ -447,126 +449,97 @@ runOnWorkspaces job = do $ current ws : visible ws modify $ \s -> s { windowset = ws { current = c, visible = v, hidden = h } } --- | Return the path to the xmonad configuration directory. This --- directory is where user configuration files are stored (e.g, the --- xmonad.hs file). You may also create a @lib@ subdirectory in the --- configuration directory and the default recompile command will add --- it to the GHC include path. +-- | All the directories that xmonad will use. They will be used for +-- the following purposes: -- --- Several directories are considered. In order of --- preference: +-- * @dataDir@: This directory is used by XMonad to store data files +-- such as the run-time state file and the configuration binary +-- generated by GHC. -- --- 1. The directory specified in the @XMONAD_CONFIG_DIR@ environment variable. --- 2. The @~\/.xmonad@ directory. --- 3. The @XDG_CONFIG_HOME/xmonad@ directory. +-- * @cfgDir@: This directory is where user configuration files are +-- stored (e.g, the xmonad.hs file). You may also create a @lib@ +-- subdirectory in the configuration directory and the default recompile +-- command will add it to the GHC include path. -- --- The first directory that exists will be used. If none of the --- directories exist then (1) will be used if it is set, otherwise (2) --- will be used. Either way, a directory will be created if necessary. -getXMonadDir :: MonadIO m => m String -getXMonadDir = - findFirstDirWithEnv "XMONAD_CONFIG_DIR" - [ getAppUserDataDirectory "xmonad" - , getXDGDirectory XDGConfig "xmonad" - ] +-- * @cacheDir@: This directory is used to store temporary files that +-- can easily be recreated. For example, the XPrompt history file. +-- +-- For how these directories are chosen, see 'getDirs'. +-- +data Directories a = Dirs + { dataDir :: !a + , cfgDir :: !a + , cacheDir :: !a + } + deriving (Show, Functor, Foldable, Traversable) --- | Return the path to the xmonad cache directory. This directory is --- used to store temporary files that can easily be recreated. For --- example, the XPrompt history file. --- --- Several directories are considered. In order of preference: --- --- 1. The directory specified in the @XMONAD_CACHE_DIR@ environment variable. --- 2. The @~\/.xmonad@ directory. --- 3. The @XDG_CACHE_HOME/xmonad@ directory. --- --- The first directory that exists will be used. If none of the --- directories exist then (1) will be used if it is set, otherwise (2) --- will be used. Either way, a directory will be created if necessary. -getXMonadCacheDir :: MonadIO m => m String -getXMonadCacheDir = - findFirstDirWithEnv "XMONAD_CACHE_DIR" - [ getAppUserDataDirectory "xmonad" - , getXDGDirectory XDGCache "xmonad" - ] +-- | Convenient type alias for the most common case in which one might +-- want to use the 'Directories' type. +type Dirs = Directories FilePath --- | Return the path to the xmonad data directory. This directory is --- used by XMonad to store data files such as the run-time state file --- and the configuration binary generated by GHC. +-- | Build up the 'Dirs' that xmonad will use. They are chosen as +-- follows: -- --- Several directories are considered. In order of preference: +-- 1. If all three of xmonad's environment variables (@XMONAD_DATA_DIR@, +-- @XMONAD_CONFIG_DIR@, and @XMONAD_CACHE_DIR@) are set, use them. +-- 2. If there is a build script called @build@ or configuration +-- @xmonad.hs@ in @~\/.xmonad@, set all three directories to +-- @~\/.xmonad@. +-- 3. Otherwise, use the @xmonad@ directory in @XDG_DATA_HOME@, +-- @XDG_CONFIG_HOME@, and @XDG_CACHE_HOME@ (or their respective +-- fallbacks). These directories are created if necessary. -- --- 1. The directory specified in the @XMONAD_DATA_DIR@ environment variable. --- 2. The @~\/.xmonad@ directory. --- 3. The @XDG_DATA_HOME/xmonad@ directory. +-- The xmonad configuration file (or the build script, if present) is +-- always assumed to be in @cfgDir@. -- --- The first directory that exists will be used. If none of the --- directories exist then (1) will be used if it is set, otherwise (2) --- will be used. Either way, a directory will be created if necessary. -getXMonadDataDir :: MonadIO m => m String -getXMonadDataDir = - findFirstDirWithEnv "XMONAD_DATA_DIR" - [ getAppUserDataDirectory "xmonad" - , getXDGDirectory XDGData "xmonad" - ] - --- | Helper function that will find the first existing directory and --- return its path. If none of the directories can be found, create --- and return the first from the list. If the list is empty this --- function returns the historical @~\/.xmonad@ directory. -findFirstDirOf :: MonadIO m => [IO FilePath] -> m FilePath -findFirstDirOf [] = findFirstDirOf [getAppUserDataDirectory "xmonad"] -findFirstDirOf possibles = do - found <- go possibles - - case found of - Just path -> return path - Nothing -> do - primary <- io (head possibles) - io (createDirectoryIfMissing True primary) - return primary - +getDirs :: IO Dirs +getDirs = xmEnvDirs <|> xmDirs <|> xdgDirs where - go [] = return Nothing - go (x:xs) = do - dir <- io x - exists <- io (doesDirectoryExist dir) - if exists then return (Just dir) else go xs + -- | Check for xmonad's environment variables first + xmEnvDirs :: IO Dirs + xmEnvDirs = do + let xmEnvs = Dirs{ dataDir = "XMONAD_DATA_DIR" + , cfgDir = "XMONAD_CONFIG_DIR" + , cacheDir = "XMONAD_CACHE_DIR" + } + maybe empty pure . sequenceA =<< traverse getEnv xmEnvs --- | Simple wrapper around @findFirstDirOf@ that allows the primary --- path to be specified by an environment variable. -findFirstDirWithEnv :: MonadIO m => String -> [IO FilePath] -> m FilePath -findFirstDirWithEnv envName paths = do - envPath' <- io (getEnv envName) + -- | Check whether the config file or a build script is in the + -- @~\/.xmonad@ directory + xmDirs :: IO Dirs + xmDirs = do + xmDir <- getAppUserDataDirectory "xmonad" + conf <- doesFileExist $ xmDir "xmonad.hs" + build <- doesFileExist $ xmDir "build" - case envPath' of - Nothing -> findFirstDirOf paths - Just envPath -> findFirstDirOf (return envPath:paths) + -- Place *everything* in ~/.xmonad if yes + guard $ conf || build + pure Dirs{ dataDir = xmDir, cfgDir = xmDir, cacheDir = xmDir } --- | Helper function to retrieve the various XDG directories. --- This has been based on the implementation shipped with GHC version 8.0.1 or --- higher. Put here to preserve compatibility with older GHC versions. -getXDGDirectory :: XDGDirectory -> FilePath -> IO FilePath -getXDGDirectory xdgDir suffix = - normalise . ( suffix) <$> - case xdgDir of - XDGData -> get "XDG_DATA_HOME" ".local/share" - XDGConfig -> get "XDG_CONFIG_HOME" ".config" - XDGCache -> get "XDG_CACHE_HOME" ".cache" - where - get name fallback = do - env <- lookupEnv name - case env of - Nothing -> fallback' - Just path - | isRelative path -> fallback' - | otherwise -> return path - where - fallback' = ( fallback) <$> getHomeDirectory -data XDGDirectory = XDGData | XDGConfig | XDGCache + -- | Use XDG directories as a fallback + xdgDirs :: IO Dirs + xdgDirs = + for Dirs{ dataDir = XdgData, cfgDir = XdgConfig, cacheDir = XdgCache } + $ \dir -> do d <- getXdgDirectory dir "xmonad" + d <$ createDirectoryIfMissing True d + +-- | Return the path to the xmonad configuration directory. +getXMonadDir :: X String +getXMonadDir = asks (cfgDir . dirs) +{-# DEPRECATED getXMonadDir "Use `asks (cfgDir . dirs)' instead." #-} + +-- | Return the path to the xmonad cache directory. +getXMonadCacheDir :: X String +getXMonadCacheDir = asks (cacheDir . dirs) +{-# DEPRECATED getXMonadCacheDir "Use `asks (cacheDir . dirs)' instead." #-} + +-- | Return the path to the xmonad data directory. +getXMonadDataDir :: X String +getXMonadDataDir = asks (dataDir . dirs) +{-# DEPRECATED getXMonadDataDir "Use `asks (dataDir . dirs)' instead." #-} -- | Get the name of the file used to store the xmonad window state. -stateFileName :: (Functor m, MonadIO m) => m FilePath +stateFileName :: X FilePath stateFileName = ( "xmonad.state") <$> getXMonadDataDir -- | 'recompile force', recompile the xmonad configuration file when @@ -588,16 +561,14 @@ stateFileName = ( "xmonad.state") <$> getXMonadDataDir -- -- 'False' is returned if there are compilation errors. -- -recompile :: MonadIO m => Bool -> m Bool -recompile force = io $ do - cfgdir <- getXMonadDir - datadir <- getXMonadDataDir +recompile :: MonadIO m => Dirs -> Bool -> m Bool +recompile Dirs{ cfgDir, dataDir } force = io $ do let binn = "xmonad-"++arch++"-"++os - bin = datadir binn - err = datadir "xmonad.errors" - src = cfgdir "xmonad.hs" - lib = cfgdir "lib" - buildscript = cfgdir "build" + bin = dataDir binn + err = dataDir "xmonad.errors" + src = cfgDir "xmonad.hs" + lib = cfgDir "lib" + buildscript = cfgDir "build" libTs <- mapM getModTime . Prelude.filter isSource =<< allFiles lib srcT <- getModTime src @@ -640,8 +611,8 @@ recompile force = io $ do uninstallSignalHandlers status <- bracket (openFile err WriteMode) hClose $ \errHandle -> waitForProcess =<< if useBuildscript - then compileScript bin cfgdir buildscript errHandle - else compileGHC bin cfgdir errHandle + then compileScript bin cfgDir buildscript errHandle + else compileGHC bin cfgDir errHandle -- re-enable SIGCHLD: installSignalHandlers diff --git a/src/XMonad/Main.hs b/src/XMonad/Main.hs index 7041c38..e393d77 100644 --- a/src/XMonad/Main.hs +++ b/src/XMonad/Main.hs @@ -1,4 +1,4 @@ -{-# LANGUAGE MultiParamTypeClasses, FlexibleContexts #-} +{-# LANGUAGE MultiParamTypeClasses, FlexibleContexts, NamedFieldPuns #-} ---------------------------------------------------------------------------- -- | -- Module : XMonad.Main @@ -39,7 +39,7 @@ import XMonad.Operations import System.IO import System.Directory import System.Info -import System.Environment +import System.Environment (getArgs, getProgName, withArgs) import System.Posix.Process (executeFile) import System.Exit (exitFailure) import System.FilePath @@ -59,17 +59,18 @@ xmonad :: (LayoutClass l Window, Read (l Window)) => XConfig l -> IO () xmonad conf = do installSignalHandlers -- important to ignore SIGCHLD to avoid zombies + dirs <- getDirs let launch' args = do - catchIO buildLaunch + catchIO (buildLaunch dirs) conf'@XConfig { layoutHook = Layout l } <- handleExtraArgs conf args conf{ layoutHook = Layout (layoutHook conf) } - withArgs [] $ launch (conf' { layoutHook = l }) + withArgs [] $ launch (conf' { layoutHook = l }) dirs args <- getArgs case args of - ("--resume": ws : xs : args') -> migrateState ws xs >> launch' args' + ("--resume": ws : xs : args') -> migrateState dirs ws xs >> launch' args' ["--help"] -> usage - ["--recompile"] -> recompile True >>= flip unless exitFailure + ["--recompile"] -> recompile dirs True >>= flip unless exitFailure ["--restart"] -> sendRestart ["--version"] -> putStrLn $ unwords shortVersion ["--verbose-version"] -> putStrLn . unwords $ shortVersion ++ longVersion @@ -90,7 +91,7 @@ usage = do "Options:" : " --help Print this message" : " --version Print the version number" : - " --recompile Recompile your ~/.xmonad/xmonad.hs" : + " --recompile Recompile your xmonad.hs" : " --replace Replace the running window manager with xmonad" : " --restart Request a running xmonad process to restart" : [] @@ -111,8 +112,8 @@ usage = do -- -- * Missing XMonad\/XMonadContrib modules due to ghc upgrade -- -buildLaunch :: IO () -buildLaunch = do +buildLaunch :: Dirs -> IO () +buildLaunch dirs@Dirs{ dataDir } = do whoami <- getProgName let compiledConfig = "xmonad-"++arch++"-"++os unless (whoami == compiledConfig) $ do @@ -122,10 +123,9 @@ buildLaunch = do , " but the compiled configuration should be called " , show compiledConfig ] - recompile False - dir <- getXMonadDataDir + recompile dirs False args <- getArgs - executeFile (dir compiledConfig) False args Nothing + executeFile (dataDir compiledConfig) False args Nothing sendRestart :: IO () sendRestart = do @@ -166,8 +166,8 @@ sendReplace = do -- function instead of 'xmonad'. You probably also want to have a key -- binding to the 'XMonad.Operations.restart` function that restarts -- your custom binary with the resume flag set to @True@. -launch :: (LayoutClass l Window, Read (l Window)) => XConfig l -> IO () -launch initxmc = do +launch :: (LayoutClass l Window, Read (l Window)) => XConfig l -> Dirs -> IO () +launch initxmc drs = do -- setup locale information from environment setLocale LC_ALL (Just "") -- ignore SIGPIPE and SIGCHLD @@ -216,7 +216,9 @@ launch initxmc = do , buttonActions = mouseBindings xmc xmc , mouseFocused = False , mousePosition = Nothing - , currentEvent = Nothing } + , currentEvent = Nothing + , dirs = drs + } st = XState { windowset = initialWinset diff --git a/src/XMonad/Operations.hs b/src/XMonad/Operations.hs index 2d0036b..a97d09f 100644 --- a/src/XMonad/Operations.hs +++ b/src/XMonad/Operations.hs @@ -1,5 +1,5 @@ {-# OPTIONS_GHC -fno-warn-orphans #-} -{-# LANGUAGE FlexibleContexts, FlexibleInstances, MultiParamTypeClasses, PatternGuards, TypeSynonymInstances #-} +{-# LANGUAGE FlexibleContexts, FlexibleInstances, MultiParamTypeClasses, PatternGuards, TypeSynonymInstances, NamedFieldPuns #-} -- -------------------------------------------------------------------------- -- | -- Module : XMonad.Operations @@ -36,6 +36,7 @@ import qualified Control.Exception.Extensible as C import System.IO import System.Directory +import System.FilePath (()) import System.Posix.Process (executeFile) import Graphics.X11.Xlib import Graphics.X11.Xinerama (getScreenInfo) @@ -524,12 +525,11 @@ readStateFile xmc = do -- | Migrate state from a previously running xmonad instance that used -- the older @--resume@ technique. {-# DEPRECATED migrateState "will be removed some point in the future." #-} -migrateState :: (Functor m, MonadIO m) => String -> String -> m () -migrateState ws xs = do +migrateState :: (Functor m, MonadIO m) => Dirs -> String -> String -> m () +migrateState Dirs{ dataDir } ws xs = do io (putStrLn "WARNING: --resume is no longer supported.") - whenJust stateData $ \s -> do - path <- stateFileName - catchIO (writeFile path $ show s) + whenJust stateData $ \s -> + catchIO (writeFile (dataDir "xmonad.state") $ show s) where stateData = StateFile <$> maybeRead ws <*> maybeRead xs maybeRead s = case reads s of From 70a75e5e3f15c89e840fc2940c071414d8b91bef Mon Sep 17 00:00:00 2001 From: slotThe Date: Tue, 5 Jan 2021 16:16:10 +0100 Subject: [PATCH 2/2] Update documentation --- CHANGES.md | 14 ++ CONFIG | 9 +- man/xmonad.1 | 230 ++++++++++++-------------------- man/xmonad.1.html | 297 +++++++++++++++++++++++++++++++----------- man/xmonad.1.markdown | 16 ++- 5 files changed, 336 insertions(+), 230 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 6715c44..7e6f741 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -15,6 +15,20 @@ * Compatibility with GHC 9.0 + * Improve handling of XDG directories. + + 1. If all three of xmonad's environment variables (`XMONAD_DATA_DIR,` + `XMONAD_CONFIG_DIR`, and `XMONAD_CACHE_DIR`) are set, use them. + 2. If there is a build script called `build` (see [here](https://github.com/xmonad/xmonad-testing/tree/master/build-scripts) for usage + examples) or configuration `xmonad.hs` in `~/.xmonad`, set all three + directories to `~/.xmonad`. + 3. Otherwise, use the `xmonad` directory in `XDG_DATA_HOME`, + `XDG_CONFIG_HOME`, and `XDG_CACHE_HOME` (or their respective + fallbacks). These directories are created if necessary. + + In the cases of 1. and 3., the build script or executable is + expected to be in the config dir. + ## 0.15 (September 30, 2018) * Reimplement `sendMessage` to deal properly with windowset changes made diff --git a/CONFIG b/CONFIG index f83292b..8dce8e7 100644 --- a/CONFIG +++ b/CONFIG @@ -4,8 +4,13 @@ xmonad is configured by creating and editing the file: ~/.xmonad/xmonad.hs -xmonad then uses settings from this file as arguments to the window manager, -on startup. For a complete example of possible settings, see the file: +xmonad then uses settings from this file as arguments to the window +manager, on startup. It is also possible to use alternative paths for +your configuration file; for that, consult + + man xmonad + +For a complete example of possible settings see the file: man/xmonad.hs diff --git a/man/xmonad.1 b/man/xmonad.1 index 3ec791f..04af000 100644 --- a/man/xmonad.1 +++ b/man/xmonad.1 @@ -1,13 +1,13 @@ -.\" Automatically generated by Pandoc 2.2.1 +.\" Automatically generated by Pandoc 2.11.3.1 .\" .TH "XMONAD" "1" "30 September 2018" "Tiling Window Manager" "" .hy .SH Name .PP -xmonad \- Tiling Window Manager +xmonad - Tiling Window Manager .SH Description .PP -\f[I]xmonad\f[] is a minimalist tiling window manager for X, written in +\f[I]xmonad\f[R] is a minimalist tiling window manager for X, written in Haskell. Windows are managed using automatic layout algorithms, which can be dynamically reconfigured. @@ -15,14 +15,14 @@ At any time windows are arranged so as to maximize the use of screen real estate. All features of the window manager are accessible purely from the keyboard: a mouse is entirely optional. -\f[I]xmonad\f[] is configured in Haskell, and custom layout algorithms +\f[I]xmonad\f[R] is configured in Haskell, and custom layout algorithms may be implemented by the user in config files. -A principle of \f[I]xmonad\f[] is predictability: the user should know +A principle of \f[I]xmonad\f[R] is predictability: the user should know in advance precisely the window arrangement that will result from any action. .PP -By default, \f[I]xmonad\f[] provides three layout algorithms: tall, wide -and fullscreen. +By default, \f[I]xmonad\f[R] provides three layout algorithms: tall, +wide and fullscreen. In tall or wide mode, windows are tiled and arranged to prevent overlap and maximize screen use. Sets of windows are grouped together on virtual screens, and each screen @@ -31,34 +31,34 @@ Multiple physical monitors are supported via Xinerama, allowing simultaneous display of a number of screens. .PP By utilizing the expressivity of a modern functional language with a -rich static type system, \f[I]xmonad\f[] provides a complete, featureful -window manager in less than 1200 lines of code, with an emphasis on -correctness and robustness. +rich static type system, \f[I]xmonad\f[R] provides a complete, +featureful window manager in less than 1200 lines of code, with an +emphasis on correctness and robustness. Internal properties of the window manager are checked using a combination of static guarantees provided by the type system, and -type\-based automated testing. +type-based automated testing. A benefit of this is that the code is simple to understand, and easy to modify. .SH Usage .PP -\f[I]xmonad\f[] places each window into a \[lq]workspace\[rq]. +\f[I]xmonad\f[R] places each window into a \[lq]workspace\[rq]. Each workspace can have any number of windows, which you can cycle -though with mod\-j and mod\-k. +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 +You can toggle the layout mode with mod-space, which will cycle through the available modes. .PP -You can switch to workspace N with mod\-N. -For example, to switch to workspace 5, you would press mod\-5. +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. +mod-shift-N. .PP When running with multiple monitors (Xinerama), each screen has exactly 1 workspace visible. -mod\-{w,e,r} switch the focus between screens, while shift\-mod\-{w,e,r} +mod-{w,e,r} switch the focus between screens, while shift-mod-{w,e,r} move the current window to that screen. -When \f[I]xmonad\f[] starts, workspace 1 is on screen 1, workspace 2 is +When \f[I]xmonad\f[R] starts, workspace 1 is on screen 1, workspace 2 is on screen 2, etc. When switching workspaces to one that is already visible, the current and visible workspaces are swapped. @@ -67,221 +67,159 @@ and visible workspaces are swapped. xmonad has several flags which you may pass to the executable. These flags are: .TP -.B \[en]recompile -Recompiles your configuration in \f[I]~/.xmonad/xmonad.hs\f[] -.RS -.RE +\[en]recompile +Recompiles your \f[I]xmonad.hs\f[R] configuration .TP -.B \[en]restart -Causes the currently running \f[I]xmonad\f[] process to restart -.RS -.RE +\[en]restart +Causes the currently running \f[I]xmonad\f[R] process to restart .TP -.B \[en]replace +\[en]replace Replace the current window manager with xmonad -.RS -.RE .TP -.B \[en]version -Display version of \f[I]xmonad\f[] -.RS -.RE +\[en]version +Display version of \f[I]xmonad\f[R] .TP -.B \[en]verbose\-version -Display detailed version of \f[I]xmonad\f[] -.RS -.RE -.PP -##Default keyboard bindings +\[en]verbose-version +Display detailed version of \f[I]xmonad\f[R] +.SS Default keyboard bindings .TP -.B mod\-shift\-return +mod-shift-return Launch terminal -.RS -.RE .TP -.B mod\-p +mod-p Launch dmenu -.RS -.RE .TP -.B mod\-shift\-p +mod-shift-p Launch gmrun -.RS -.RE .TP -.B mod\-shift\-c +mod-shift-c Close the focused window -.RS -.RE .TP -.B mod\-space +mod-space Rotate through the available layout algorithms -.RS -.RE .TP -.B mod\-shift\-space +mod-shift-space Reset the layouts on the current workspace to default -.RS -.RE .TP -.B mod\-n +mod-n Resize viewed windows to the correct size -.RS -.RE .TP -.B mod\-tab +mod-tab Move focus to the next window -.RS -.RE .TP -.B mod\-shift\-tab +mod-shift-tab Move focus to the previous window -.RS -.RE .TP -.B mod\-j +mod-j Move focus to the next window -.RS -.RE .TP -.B mod\-k +mod-k Move focus to the previous window -.RS -.RE .TP -.B mod\-m +mod-m Move focus to the master window -.RS -.RE .TP -.B mod\-return +mod-return Swap the focused window and the master window -.RS -.RE .TP -.B mod\-shift\-j +mod-shift-j Swap the focused window with the next window -.RS -.RE .TP -.B mod\-shift\-k +mod-shift-k Swap the focused window with the previous window -.RS -.RE .TP -.B mod\-h +mod-h Shrink the master area -.RS -.RE .TP -.B mod\-l +mod-l Expand the master area -.RS -.RE .TP -.B mod\-t +mod-t Push window back into tiling -.RS -.RE .TP -.B mod\-comma +mod-comma Increment the number of windows in the master area -.RS -.RE .TP -.B mod\-period +mod-period Deincrement the number of windows in the master area -.RS -.RE .TP -.B mod\-shift\-q +mod-shift-q Quit xmonad -.RS -.RE .TP -.B mod\-q +mod-q Restart xmonad -.RS -.RE .TP -.B mod\-shift\-slash +mod-shift-slash Run xmessage with a summary of the default keybindings (useful for beginners) -.RS -.RE .TP -.B mod\-question +mod-question Run xmessage with a summary of the default keybindings (useful for beginners) -.RS -.RE .TP -.B mod\-[1..9] +mod-[1..9] Switch to workspace N -.RS -.RE .TP -.B mod\-shift\-[1..9] +mod-shift-[1..9] Move client to workspace N -.RS -.RE .TP -.B mod\-{w,e,r} +mod-{w,e,r} Switch to physical/Xinerama screens 1, 2, or 3 -.RS -.RE .TP -.B mod\-shift\-{w,e,r} +mod-shift-{w,e,r} Move client to screen 1, 2, or 3 -.RS -.RE .TP -.B mod\-button1 +mod-button1 Set the window to floating mode and move by dragging -.RS -.RE .TP -.B mod\-button2 +mod-button2 Raise the window to the top of the stack -.RS -.RE .TP -.B mod\-button3 +mod-button3 Set the window to floating mode and resize by dragging -.RS -.RE .SH Examples .PP -To use xmonad as your window manager add to your \f[I]~/.xinitrc\f[] -file: +To use xmonad as your window manager add to your +\f[I]\[ti]/.xinitrc\f[R] file: .RS .PP exec xmonad .RE .SH Customization .PP -xmonad is customized in ~/.xmonad/xmonad.hs, and then restarted with -mod\-q. +xmonad is customized in your \f[I]xmonad.hs\f[R], and then restarted +with mod-q. +You can choose where your configuration file lives by +.IP "1." 3 +Setting \f[C]XMONAD_DATA_DIR,\f[R] \f[C]XMONAD_CONFIG_DIR\f[R], and +\f[C]XMONAD_CACHE_DIR\f[R]; \f[I]xmonad.hs\f[R] is then expected to be +in \f[C]XMONAD_CONFIG_DIR\f[R]. +.IP "2." 3 +Creating \f[I]xmonad.hs\f[R] in \f[I]\[ti]/.xmonad\f[R]. +.IP "3." 3 +Creating \f[I]xmonad.hs\f[R] in \f[C]XDG_CONFIG_HOME\f[R]. +Note that, in this case, xmonad will use \f[C]XDG_DATA_HOME\f[R] and +\f[C]XDG_CACHE_HOME\f[R] for its data and cache directory respectively. .PP -You can find many extensions to the core feature set in the xmonad\- +You can find many extensions to the core feature set in the xmonad- contrib package, available through your package manager or from -xmonad.org (http://xmonad.org). +xmonad.org (https://xmonad.org). .SS Modular Configuration .PP -As of \f[I]xmonad\-0.9\f[], any additional Haskell modules may be placed -in \f[I]~/.xmonad/lib/\f[] are available in GHC's searchpath. +As of \f[I]xmonad-0.9\f[R], any additional Haskell modules may be placed +in \f[I]\[ti]/.xmonad/lib/\f[R] are available in GHC\[cq]s searchpath. Hierarchical modules are supported: for example, the file -\f[I]~/.xmonad/lib/XMonad/Stack/MyAdditions.hs\f[] could contain: +\f[I]\[ti]/.xmonad/lib/XMonad/Stack/MyAdditions.hs\f[R] could contain: .IP .nf \f[C] -module\ XMonad.Stack.MyAdditions\ (function1)\ where -\ \ function1\ =\ error\ "function1:\ Not\ implemented\ yet!" -\f[] +module XMonad.Stack.MyAdditions (function1) where + function1 = error \[dq]function1: Not implemented yet!\[dq] +\f[R] .fi .PP Your xmonad.hs may then import XMonad.Stack.MyAdditions as if that -module was contained within xmonad or xmonad\-contrib. +module was contained within xmonad or xmonad-contrib. .SH Bugs .PP Probably. diff --git a/man/xmonad.1.html b/man/xmonad.1.html index 1d2f071..0da9ee1 100644 --- a/man/xmonad.1.html +++ b/man/xmonad.1.html @@ -7,94 +7,230 @@ XMONAD(1) Tiling Window Manager - - -
+

XMONAD(1) Tiling Window Manager

30 September 2018

-