<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html> <head> <title>Reference</title> <link rel="stylesheet" href="luadoc.css" type="text/css" /> <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/--> </head> <body> <div id="container"> <div id="product"> <div id="product_logo"></div> <div id="product_name"><big><b></b></big></div> <div id="product_description"></div> </div> <!-- id="product" --> <div id="main"> <div id="navigation"> <h1>LuaDoc</h1> <ul> <li><strong>Index</strong></li> </ul> <!-- Module list --> <h1>Modules</h1> <ul> <li> <a href="modules/awesome.html">awesome</a> </li> <li> <a href="modules/awful.html">awful</a> </li> <li> <a href="modules/awful.autofocus.html">awful.autofocus</a> </li> <li> <a href="modules/awful.button.html">awful.button</a> </li> <li> <a href="modules/awful.client.html">awful.client</a> </li> <li> <a href="modules/awful.completion.html">awful.completion</a> </li> <li> <a href="modules/awful.dbus.html">awful.dbus</a> </li> <li> <a href="modules/awful.hooks.html">awful.hooks</a> </li> <li> <a href="modules/awful.key.html">awful.key</a> </li> <li> <a href="modules/awful.layout.html">awful.layout</a> </li> <li> <a href="modules/awful.layout.suit.html">awful.layout.suit</a> </li> <li> <a href="modules/awful.layout.suit.fair.html">awful.layout.suit.fair</a> </li> <li> <a href="modules/awful.layout.suit.floating.html">awful.layout.suit.floating</a> </li> <li> <a href="modules/awful.layout.suit.magnifier.html">awful.layout.suit.magnifier</a> </li> <li> <a href="modules/awful.layout.suit.max.html">awful.layout.suit.max</a> </li> <li> <a href="modules/awful.layout.suit.spiral.html">awful.layout.suit.spiral</a> </li> <li> <a href="modules/awful.layout.suit.tile.html">awful.layout.suit.tile</a> </li> <li> <a href="modules/awful.menu.html">awful.menu</a> </li> <li> <a href="modules/awful.mouse.html">awful.mouse</a> </li> <li> <a href="modules/awful.mouse.finder.html">awful.mouse.finder</a> </li> <li> <a href="modules/awful.placement.html">awful.placement</a> </li> <li> <a href="modules/awful.prompt.html">awful.prompt</a> </li> <li> <a href="modules/awful.remote.html">awful.remote</a> </li> <li> <a href="modules/awful.rules.html">awful.rules</a> </li> <li> <a href="modules/awful.screen.html">awful.screen</a> </li> <li> <a href="modules/awful.startup_notification.html">awful.startup_notification</a> </li> <li> <a href="modules/awful.tag.html">awful.tag</a> </li> <li> <a href="modules/awful.titlebar.html">awful.titlebar</a> </li> <li> <a href="modules/awful.tooltip.html">awful.tooltip</a> </li> <li> <a href="modules/awful.util.html">awful.util</a> </li> <li> <a href="modules/awful.wibox.html">awful.wibox</a> </li> <li> <a href="modules/awful.widget.html">awful.widget</a> </li> <li> <a href="modules/awful.widget.button.html">awful.widget.button</a> </li> <li> <a href="modules/awful.widget.common.html">awful.widget.common</a> </li> <li> <a href="modules/awful.widget.graph.html">awful.widget.graph</a> </li> <li> <a href="modules/awful.widget.launcher.html">awful.widget.launcher</a> </li> <li> <a href="modules/awful.widget.layout.html">awful.widget.layout</a> </li> <li> <a href="modules/awful.widget.layout.default.html">awful.widget.layout.default</a> </li> <li> <a href="modules/awful.widget.layout.horizontal.html">awful.widget.layout.horizontal</a> </li> <li> <a href="modules/awful.widget.layout.vertical.html">awful.widget.layout.vertical</a> </li> <li> <a href="modules/awful.widget.layoutbox.html">awful.widget.layoutbox</a> </li> <li> <a href="modules/awful.widget.progressbar.html">awful.widget.progressbar</a> </li> <li> <a href="modules/awful.widget.prompt.html">awful.widget.prompt</a> </li> <li> <a href="modules/awful.widget.taglist.html">awful.widget.taglist</a> </li> <li> <a href="modules/awful.widget.tasklist.html">awful.widget.tasklist</a> </li> <li> <a href="modules/awful.widget.textclock.html">awful.widget.textclock</a> </li> <li> <a href="modules/beautiful.html">beautiful</a> </li> <li> <a href="modules/button.html">button</a> </li> <li> <a href="modules/client.html">client</a> </li> <li> <a href="modules/dbus.html">dbus</a> </li> <li> <a href="modules/image.html">image</a> </li> <li> <a href="modules/key.html">key</a> </li> <li> <a href="modules/keygrabber.html">keygrabber</a> </li> <li> <a href="modules/mouse.html">mouse</a> </li> <li> <a href="modules/mousegrabber.html">mousegrabber</a> </li> <li> <a href="modules/naughty.html">naughty</a> </li> <li> <a href="modules/root.html">root</a> </li> <li> <a href="modules/screen.html">screen</a> </li> <li> <a href="modules/selection.html">selection</a> </li> <li> <a href="modules/tag.html">tag</a> </li> <li> <a href="modules/timer.html">timer</a> </li> <li> <a href="modules/wibox.html">wibox</a> </li> <li> <a href="modules/widget.html">widget</a> </li> </ul> <!-- File list --> </div> <!-- id="navigation" --> <div id="content"> <h2>Modules</h2> <table class="module_list"> <!--<tr><td colspan="2">Modules</td></tr>--> <tr> <td class="name"><a href="modules/awesome.html">awesome</a></td> <td class="summary">awesome core API </td> </tr> <tr> <td class="name"><a href="modules/awful.html">awful</a></td> <td class="summary">AWesome Functions very UsefuL </td> </tr> <tr> <td class="name"><a href="modules/awful.autofocus.html">awful.autofocus</a></td> <td class="summary">When loaded, this module makes sure that there's always a client that will have focus on event such as tag switching, client unmanaging, etc.</td> </tr> <tr> <td class="name"><a href="modules/awful.button.html">awful.button</a></td> <td class="summary">Create easily new buttons objects ignoring certain modifiers.</td> </tr> <tr> <td class="name"><a href="modules/awful.client.html">awful.client</a></td> <td class="summary">Useful client manipulation functions.</td> </tr> <tr> <td class="name"><a href="modules/awful.completion.html">awful.completion</a></td> <td class="summary">Completion module.</td> </tr> <tr> <td class="name"><a href="modules/awful.dbus.html">awful.dbus</a></td> <td class="summary">D-Bus module for awful.</td> </tr> <tr> <td class="name"><a href="modules/awful.hooks.html">awful.hooks</a></td> <td class="summary">Hooks module for awful.</td> </tr> <tr> <td class="name"><a href="modules/awful.key.html">awful.key</a></td> <td class="summary">Create easily new key objects ignoring certain modifiers.</td> </tr> <tr> <td class="name"><a href="modules/awful.layout.html">awful.layout</a></td> <td class="summary">Layout module for awful </td> </tr> <tr> <td class="name"><a href="modules/awful.layout.suit.html">awful.layout.suit</a></td> <td class="summary">Suits for awful </td> </tr> <tr> <td class="name"><a href="modules/awful.layout.suit.fair.html">awful.layout.suit.fair</a></td> <td class="summary">Fair layouts module for awful </td> </tr> <tr> <td class="name"><a href="modules/awful.layout.suit.floating.html">awful.layout.suit.floating</a></td> <td class="summary">Dummy function for floating layout </td> </tr> <tr> <td class="name"><a href="modules/awful.layout.suit.magnifier.html">awful.layout.suit.magnifier</a></td> <td class="summary">Magnifier layout module for awful </td> </tr> <tr> <td class="name"><a href="modules/awful.layout.suit.max.html">awful.layout.suit.max</a></td> <td class="summary">Maximized and fullscreen layouts module for awful </td> </tr> <tr> <td class="name"><a href="modules/awful.layout.suit.spiral.html">awful.layout.suit.spiral</a></td> <td class="summary"></td> </tr> <tr> <td class="name"><a href="modules/awful.layout.suit.tile.html">awful.layout.suit.tile</a></td> <td class="summary">Tiled layouts module for awful </td> </tr> <tr> <td class="name"><a href="modules/awful.menu.html">awful.menu</a></td> <td class="summary">Creation of menus.</td> </tr> <tr> <td class="name"><a href="modules/awful.mouse.html">awful.mouse</a></td> <td class="summary">Mouse module for awful </td> </tr> <tr> <td class="name"><a href="modules/awful.mouse.finder.html">awful.mouse.finder</a></td> <td class="summary">Find the mouse pointer on the screen.</td> </tr> <tr> <td class="name"><a href="modules/awful.placement.html">awful.placement</a></td> <td class="summary">Places client according to special criteria.</td> </tr> <tr> <td class="name"><a href="modules/awful.prompt.html">awful.prompt</a></td> <td class="summary">Prompt module for awful </td> </tr> <tr> <td class="name"><a href="modules/awful.remote.html">awful.remote</a></td> <td class="summary">Remote control module allowing usage of awesome-client.</td> </tr> <tr> <td class="name"><a href="modules/awful.rules.html">awful.rules</a></td> <td class="summary">Apply rules to clients at startup.</td> </tr> <tr> <td class="name"><a href="modules/awful.screen.html">awful.screen</a></td> <td class="summary">Screen module for awful </td> </tr> <tr> <td class="name"><a href="modules/awful.startup_notification.html">awful.startup_notification</a></td> <td class="summary">Startup notification module for awful </td> </tr> <tr> <td class="name"><a href="modules/awful.tag.html">awful.tag</a></td> <td class="summary">Useful functions for tag manipulation.</td> </tr> <tr> <td class="name"><a href="modules/awful.titlebar.html">awful.titlebar</a></td> <td class="summary">Titlebar module for awful </td> </tr> <tr> <td class="name"><a href="modules/awful.tooltip.html">awful.tooltip</a></td> <td class="summary">Tooltip module for awesome objects.</td> </tr> <tr> <td class="name"><a href="modules/awful.util.html">awful.util</a></td> <td class="summary">Utility module for awful </td> </tr> <tr> <td class="name"><a href="modules/awful.wibox.html">awful.wibox</a></td> <td class="summary">Wibox module for awful.</td> </tr> <tr> <td class="name"><a href="modules/awful.widget.html">awful.widget</a></td> <td class="summary">Widget module for awful </td> </tr> <tr> <td class="name"><a href="modules/awful.widget.button.html">awful.widget.button</a></td> <td class="summary"></td> </tr> <tr> <td class="name"><a href="modules/awful.widget.common.html">awful.widget.common</a></td> <td class="summary">Common widget code </td> </tr> <tr> <td class="name"><a href="modules/awful.widget.graph.html">awful.widget.graph</a></td> <td class="summary">A graph widget.</td> </tr> <tr> <td class="name"><a href="modules/awful.widget.launcher.html">awful.widget.launcher</a></td> <td class="summary"> </td> </tr> <tr> <td class="name"><a href="modules/awful.widget.layout.html">awful.widget.layout</a></td> <td class="summary"></td> </tr> <tr> <td class="name"><a href="modules/awful.widget.layout.default.html">awful.widget.layout.default</a></td> <td class="summary">Simple default layout, emulating the fallback C layout </td> </tr> <tr> <td class="name"><a href="modules/awful.widget.layout.horizontal.html">awful.widget.layout.horizontal</a></td> <td class="summary">Horizontal widget layout </td> </tr> <tr> <td class="name"><a href="modules/awful.widget.layout.vertical.html">awful.widget.layout.vertical</a></td> <td class="summary">Vertical widget layout </td> </tr> <tr> <td class="name"><a href="modules/awful.widget.layoutbox.html">awful.widget.layoutbox</a></td> <td class="summary">Layoutbox widget.</td> </tr> <tr> <td class="name"><a href="modules/awful.widget.progressbar.html">awful.widget.progressbar</a></td> <td class="summary">A progressbar widget.</td> </tr> <tr> <td class="name"><a href="modules/awful.widget.prompt.html">awful.widget.prompt</a></td> <td class="summary"> </td> </tr> <tr> <td class="name"><a href="modules/awful.widget.taglist.html">awful.widget.taglist</a></td> <td class="summary">Taglist widget module for awful </td> </tr> <tr> <td class="name"><a href="modules/awful.widget.tasklist.html">awful.widget.tasklist</a></td> <td class="summary">Tasklist widget module for awful </td> </tr> <tr> <td class="name"><a href="modules/awful.widget.textclock.html">awful.widget.textclock</a></td> <td class="summary">Text clock widget.</td> </tr> <tr> <td class="name"><a href="modules/beautiful.html">beautiful</a></td> <td class="summary">Theme library.</td> </tr> <tr> <td class="name"><a href="modules/button.html">button</a></td> <td class="summary">awesome button API </td> </tr> <tr> <td class="name"><a href="modules/client.html">client</a></td> <td class="summary">awesome client API </td> </tr> <tr> <td class="name"><a href="modules/dbus.html">dbus</a></td> <td class="summary">awesome D-Bus API </td> </tr> <tr> <td class="name"><a href="modules/image.html">image</a></td> <td class="summary">awesome image API </td> </tr> <tr> <td class="name"><a href="modules/key.html">key</a></td> <td class="summary">awesome key API </td> </tr> <tr> <td class="name"><a href="modules/keygrabber.html">keygrabber</a></td> <td class="summary">awesome keygrabber API </td> </tr> <tr> <td class="name"><a href="modules/mouse.html">mouse</a></td> <td class="summary">awesome mouse API </td> </tr> <tr> <td class="name"><a href="modules/mousegrabber.html">mousegrabber</a></td> <td class="summary">awesome mousegrabber API </td> </tr> <tr> <td class="name"><a href="modules/naughty.html">naughty</a></td> <td class="summary">Notification library </td> </tr> <tr> <td class="name"><a href="modules/root.html">root</a></td> <td class="summary">awesome root window API </td> </tr> <tr> <td class="name"><a href="modules/screen.html">screen</a></td> <td class="summary">awesome screen API </td> </tr> <tr> <td class="name"><a href="modules/selection.html">selection</a></td> <td class="summary">awesome selection (clipboard) API </td> </tr> <tr> <td class="name"><a href="modules/tag.html">tag</a></td> <td class="summary">awesome tag API </td> </tr> <tr> <td class="name"><a href="modules/timer.html">timer</a></td> <td class="summary">awesome timer API </td> </tr> <tr> <td class="name"><a href="modules/wibox.html">wibox</a></td> <td class="summary">awesome wibox API </td> </tr> <tr> <td class="name"><a href="modules/widget.html">widget</a></td> <td class="summary">awesome widget API </td> </tr> </table> </div> <!-- id="content" --> </div> <!-- id="main" --> <div id="about"> <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p> </div> <!-- id="about" --> </div> <!-- id="container" --> </body> </html>