660a4036e7517e2521a6432cd96a4196c355ad76 — Nick Parker 3 years ago 153a7b7
Move docs from gh-pages branch
A docs/_layouts/default.html => docs/_layouts/default.html +20 -0
@@ 0,0 1,20 @@
  <title>{{ page.title }}</title>
  <link rel="shortcut icon" href="/gridmgr/favicon.ico" />
  <style type="text/css">
  @import url("style.css");
<div id="container">
 <div id="titlebar" align="center">
  <a href="/gridmgr"><img src="gridmgr-black.png" alt="gridmgr"/></a>

 <div id="content">
  {{ content }}

A docs/favicon.ico => docs/favicon.ico +0 -0
A docs/gridmgr-black.png => docs/gridmgr-black.png +0 -0
A docs/gridmgr-white.png => docs/gridmgr-white.png +0 -0
A docs/index.html => docs/index.html +59 -0
@@ 0,0 1,59 @@
layout: default
title: gridmgr
<p>gridmgr is a command line tool which provides keyboard-bindable commands for easy window manipulation. Commands include placement of windows into predefined grid layouts, directional selection of adjacent windows, and directional movement of windows to adjacent monitors. This is all accomplished without requiring a full-blown tiling window manager, nor any sort of background process, service, or configuration.</p>

<p>With gridmgr, you gain the organizational strengths of a tiling window manager, without sacrificing the free-form flexibility that you get from a stacking window manager. Or, if you're already using a tiling window manager, it gives you some nice commands for window movement and selection.</p>

<p>Its grid placement functionality behaves similarly to the "Grid" Compiz plugin, but written to use standard APIs supported by nearly all modern window managers. But don't take my word for it...</p>

<p class="header">Video</p>

<p align="center"><iframe src="http://player.vimeo.com/video/37074904?portrait=0" width="561" height="200" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowFullScreen></iframe></p>

<p>Playing around with gridmgr on a two-monitor system running Openbox.</p>

<p class="header">Documentation</p>

<p>The best way to learn gridmgr is by experimenting with the available commands. Just run <i>gridmgr</i> with no arguments to see what's available. Here are some commands you can try out:</p>

<p class="subheader">Example Commands</p>

<li><i>gridmgr wleft</i> - Activates the window to the left of the current window. If there's nothing to the left, wrap around and pick something from the far right.</li>
<li><i>gridmgr mright</i> - Moves the current window one monitor to the right. If there's no monitor to the right, wrap around and pick the leftmost monitor.</li>
<li><i>gridmgr guleft</i> - Moves the current window to the upper left quarter of the screen. Try running <i>guleft</i> repeatedly against the same window and you'll see that it adjusts the window's width.</li>
<li><i>gridmgr gleft mup</i> - A compound action which moves the active window one monitor up, then places it on the left half of that monitor.</li>

<p>A note about compound actions: Only one "type" of action will be performed at a time (eg <i>gridmgr mup mup</i> won't work). Also, compound actions are always executed in this order, regardless of the argument order: window selection, monitor movement, grid placement.</p>

<p class="header">Installation</p>

<p class="subheader">Prerequisites</p>

<li>g++ 4.4+ or thereabouts (I've been using 4.6 myself)</li>
<li>CMake 2.6+</li>
<li>Xlib (libx11-dev)</li>
<li>Optional: Xinerama (libxinerama-dev), for multi-monitor support.</li>

<p class="subheader">Getting the Code</p>

<p>Get the latest <a href="https://github.com/nickbp/gridmgr">Source Code</a> from Git.</p>

<p class="code">$ git clone git://github.com/nickbp/gridmgr.git</p>

<p class="subheader">Building</p>

<p class="code">$ cd gridmgr <i>(where LICENCE is found)</i><br/>
$ mkdir bin<br/>
$ cd bin<br/>
$ cmake ../src <i>(autodetects Xlib/Xinerama and creates Makefiles)</i><br/>
$ make</p>

<p>That should do it! The <i>gridmgr</i> executable will be found in bin/. Just run <i>gridmgr</i> with no arguments to see the available commands.</p>

<p>The build can optionally be configured with standard CMake tools like "ccmake" and "cmake-gui". They can be used to enable or disable optional components, or to enable a release build by setting CMAKE_BUILD_TYPE to "Release".</p>

A docs/style.css => docs/style.css +22 -0
@@ 0,0 1,22 @@
/* From YUI v2.5.2: base-min.css and fonts-min.css */
h1{font-size:138.5%;}h2{font-size:123.1%;}h3{font-size:108%;}h1,h2,h3{margin:1em 0;}h1,h2,h3,h4,h5,h6,strong{font-weight:bold;}abbr,acronym{border-bottom:1px dotted #000;cursor:help;} em{font-style:italic;}blockquote,ul,ol,dl{margin:1em;}ol,ul,dl{margin-left:2em;}ol li{list-style:decimal outside;}ul li{list-style:square outside;}dl dd{margin-left:1em;}th,td{border:1px solid #000;padding:.5em;}th{font-weight:bold;text-align:center;}caption{margin-bottom:.5em;text-align:center;}p,fieldset,table,pre{margin-bottom:1em;}input[type=text],input[type=password],textarea{width:12.25em;*width:11.9em;}
body {font:13px/1.231 arial,helvetica,clean,sans-serif;*font-size:small;*font:x-small;}table {font-size:inherit;font:100%;}pre,code,kbd,samp,tt{font-family:monospace;*font-size:108%;line-height:100%;}
font-sizes are (px=%):
10=77, 11=85, 12=93, 13=100,
14=108, 15=116, 16=123.1, 17=131,
18=138.5, 19=146.5, 20=153.9, 21=161.6,
22=167, 23=174, 24=182, 25=189, 26=197

ol, ul, li { margin: 0; }
body { font-family: sans-serif; text-align: center; /*IE: centered content*/ }
a { color: black }

#container { margin: 2em auto 0 auto; width: 45em; text-align: left; }
#titlebar { float: left; }
#content { clear: left; float: left; margin: 0.5em 0 1em 0.5em; font-size: 93%; text-align: justify; }

#content .header { margin: 1em 0 0.9em -0.5em; font-size: 116%; font-weight: bold; }
#content .subheader { font-size: 108%; font-weight: bold; }
#content .code { font-family: monospace; padding: 0.2em; text-align: left; background-color: #F0F0F0; }