diff options
Diffstat (limited to '')
| -rw-r--r-- | man/xmonad.1.in | 57 | ||||
| -rw-r--r-- | man/xmonad.1.markdown | 96 | ||||
| -rw-r--r-- | util/GenerateManpage.hs | 42 |
3 files changed, 131 insertions, 64 deletions
diff --git a/man/xmonad.1.in b/man/xmonad.1.in deleted file mode 100644 index 2d088dc..0000000 --- a/man/xmonad.1.in +++ /dev/null @@ -1,57 +0,0 @@ -./" man page created by David Lazar on April 24, 2007 -./" uses ``tmac.an'' macro set -.TH xmonad 1 "8 September 09"\ -___RELEASE___\ -"xmonad manual" -.SH NAME -xmonad \- a tiling window manager -.SH DESCRIPTION -.PP -\fBxmonad\fR is a minimalist tiling window manager for X, written in Haskell. Windows are managed using automatic layout algorithms, which can be dynamically reconfigured. 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. \fBxmonad\fR is configured in Haskell, and custom layout algorithms may be implemented by the user in config files. A principle of \fBxmonad\fR is predictability: the user should know in advance precisely the window arrangement that will result from any action. -.PP -By default, \fBxmonad\fR 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 retains its own layout, which may be reconfigured dynamically. 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, \fBxmonad\fR 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. A benefit of this is that the code is simple to understand, and easy to modify. -.SH USAGE -.PP -\fBxmonad\fR 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. -.PP -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. -.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} move the current window to that screen. When \fBxmonad\fR 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. -.PP -.SS Flags -\fBxmonad\fR has several flags which you may pass to the executable. These flags are: -.TP -\fB--recompile -Recompiles your configuration in ~/.xmonad/xmonad.hs -\fB--restart -Causes the currently running xmonad process to restart -.TP -\fB--version -Display version of \fBxmonad\fR. -.SS Default keyboard bindings -___KEYBINDINGS___ -.SH EXAMPLES -To use \fBxmonad\fR as your window manager add: -.RS -exec xmonad -.RE -to your \fI~/.xinitrc\fR file -.SH CUSTOMIZATION -\fBxmonad\fR is customized in ~/.xmonad/xmonad.hs, and then restarting with mod-q. -.PP -You can find many extensions to the core feature set in the xmonad-contrib package, available through your package manager or from http://xmonad.org/. -.SS "Modular Configuration" -As of \fBxmonad-0.9\fR, any additional Haskell modules may be placed in \fI~/.xmonad/lib/\fR are available in GHC's searchpath. Hierarchical modules are supported: for example, the file \fI~/.xmonad/lib/XMonad/Stack/MyAdditions.hs\fR could contain: -.RS -.nf - -module XMonad.Stack.MyAdditions (function1) where -function1 = error "function1: Not implemented yet!" -.fi -.RE -.PP -Your xmonad.hs may then \fBimport XMonad.Stack.MyAdditions\fR as if that module was contained within \fBxmonad\fR or \fBxmonad-contrib\fR. -.SH BUGS -Probably. If you find any, please report them: http://code.google.com/p/xmonad/issues/list diff --git a/man/xmonad.1.markdown b/man/xmonad.1.markdown new file mode 100644 index 0000000..c7c2519 --- /dev/null +++ b/man/xmonad.1.markdown @@ -0,0 +1,96 @@ +#Name +xmonad - a tiling window manager + +#Description + +_xmonad_ is a minimalist tiling window manager for X, written in Haskell. +Windows are managed using automatic layout algorithms, which can be +dynamically reconfigured. 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. +_xmonad_ is configured in Haskell, and custom layout algorithms may be +implemented by the user in config files. A principle of _xmonad_ is +predictability: the user should know in advance precisely the window +arrangement that will result from any action. + +By default, _xmonad_ 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 retains its own layout, which may be +reconfigured dynamically. Multiple physical monitors are supported via +Xinerama, allowing simultaneous display of a number of screens. + +By utilizing the expressivity of a modern functional language with a rich +static type system, _xmonad_ 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. A benefit of this is that the code is simple +to understand, and easy to modify. + +#Usage + +_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. mod-{w,e,r} switch the focus between screens, while +shift-mod-{w,e,r} move the current window to that screen. When _xmonad_ +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. + +##Flags +xmonad has several flags which you may pass to the executable. +These flags are: + +--recompile +: Recompiles your configuration in _~/.xmonad/xmonad.hs_ + +--restart +: Causes the currently running _xmonad_ process to restart + +--version +: Display version of _xmonad_ + +##Default keyboard bindings + +___KEYBINDINGS___ + +#Examples +To use xmonad as your window manager add to your _~/.xinitrc_ file: + +> exec xmonad + +#Customization +xmonad is customized in ~/.xmonad/xmonad.hs, and then restarting +with mod-q. + +You can find many extensions to the core feature set in the xmonad- +contrib package, available through your package manager or from +[xmonad.org]. + +##Modular Configuration +As of _xmonad-0.9_, any additional Haskell modules may be placed in +_~/.xmonad/lib/_ are available in GHC's searchpath. Hierarchical modules +are supported: for example, the file +_~/.xmonad/lib/XMonad/Stack/MyAdditions.hs_ could contain: + +> module XMonad.Stack.MyAdditions (function1) where +> function1 = error "function1: Not implemented yet!" + +Your xmonad.hs may then import XMonad.Stack.MyAdditions as if that +module was contained within xmonad or xmonad-contrib. + +#Bugs +Probably. If you find any, please report them to the [bugtracker] + +[xmonad.org]: http://xmonad.org +[bugtracker]: http://code.google.com/p/xmonad/issues/list diff --git a/util/GenerateManpage.hs b/util/GenerateManpage.hs index 6be229b..77a45ab 100644 --- a/util/GenerateManpage.hs +++ b/util/GenerateManpage.hs @@ -2,6 +2,10 @@ -- Generates man/xmonad.1 from man/xmonad.1.in by filling the list of -- keybindings with values scraped from Config.hs -- +-- Uses cabal to grab the xmonad version from xmonad.cabal +-- +-- Uses pandoc to convert the "xmonad.1.markdown" to "xmonad.1" +-- -- Format for the docstrings in Config.hs takes the following form: -- -- -- mod-x %! Frob the whatsit @@ -14,8 +18,8 @@ -- [ ((modMask .|. shiftMask, xK_Return), spawn "xterm") -- %! Launch an xterm -- -- Here, mod-shift-return will be used as the keybinding name. --- import Control.Monad +import Control.Applicative import Text.Regex.Posix import Data.Char import Data.List @@ -27,6 +31,10 @@ import Distribution.PackageDescription import Text.PrettyPrint.HughesPJ import Distribution.Text +import Text.Pandoc + +releaseDate = "\"8 September 09\"" + trim :: String -> String trim = reverse . dropWhile isSpace . reverse . dropWhile isSpace @@ -42,16 +50,36 @@ 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\n \\fB" ++ key ++ "\\fR\n" ++ desc ++ "\n" +markdownDefn :: (String, String) -> String +markdownDefn (key, desc) = key ++ "\n: " ++ desc replace :: Eq a => a -> a -> [a] -> [a] replace x y = map (\a -> if a == x then y else a) +-- rawSystem "pandoc" ["--read=markdown","--write=man","man/xmonad.1.markdown"] + main = do - releaseName <- ((' ':) . (++" \\") . show . disp . package . packageDescription) `liftM` readPackageDescription normal "xmonad.cabal" + releaseName <- (show . disp . package . packageDescription) + `liftM`readPackageDescription normal "xmonad.cabal" + keybindings <- (intercalate "\n\n" . map markdownDefn . allBindings) + `liftM` readFile "./XMonad/Config.hs" + + let manHeader = unwords [".TH xmonad 1",releaseDate,releaseName,"\"xmonad manual\""] + writeOpts = defaultWriterOptions -- { writerLiterateHaskell = True } + + parsed <- readMarkdown defaultParserState { stateLiterateHaskell = True } + . unlines + . replace "___KEYBINDINGS___" keybindings + . lines + <$> readFile "./man/xmonad.1.markdown" - troffBindings <- (concatMap troff . allBindings) `liftM` readFile "./XMonad/Config.hs" + writeFile "./man/xmonad.1" + . (manHeader ++) + . writeMan writeOpts + $ parsed + putStrLn "Documentation created: man/xmonad.1" - let sed = unlines . replace "___RELEASE___\\" releaseName . replace "___KEYBINDINGS___" troffBindings . lines - readFile "./man/xmonad.1.in" >>= return . sed >>= writeFile "./man/xmonad.1" + writeFile "./man/xmonad.1.html" + . writeHtmlString writeOpts { writerStandalone = True } + $ parsed + putStrLn "Documentation created: man/xmonad.1.html" |