http://blog.gmane.org/gmane.comp.window-managers.awesome.devel hourly 1 1901-01-01T00:00+00:00 http://gmane.org/img/gmane-25t.png http://gmane.org http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/8358 <pre>This is the same kind of refactoring as awful faced. Signed-off-by: Ignas Anikevicius (gns_ank) &lt;anikevicius&lt; at &gt;gmail.com&gt; --- lib/beautiful.lua.in | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/beautiful.lua.in b/lib/beautiful.lua.in index cf91bfd..b1f4ff4 100644 --- a/lib/beautiful.lua.in +++ b/lib/beautiful.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,6 &lt; at &gt;&lt; at &gt; ---------------------------------------------------------------------------- +--- Theme library. +-- -- &lt; at &gt;author Damien Leone &amp;lt;damien.leone&lt; at &gt;gmail.com&amp;gt; -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;copyright 2008-2009 Damien Leone, Julien Danjou &lt; at &gt;&lt; at &gt; -24,7 +26,6 &lt; at &gt;&lt; at &gt; local capi = awesome = awesome } ---- Theme library. local beautiful = { mt = {} } -- Local data &lt; at &gt;&lt; at &gt; -68,7 +69,7 &lt; at &gt;&lt; at &gt; function beautiful.get_font_height(name) end --- Init function, should be runned at the beginning of configuration file. --- &lt; at &gt;param path The theme file path. +-- &lt; at &gt;tparam string path The theme file path. function beautiful.init(path) if path then local success </pre> Ignas Anikevicius (gns_ank 2013-06-02T21:37:05 http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/8357 <pre>Here I have done more than just refactoring docs, I have moved most of the default values from the description of the notify function to the naughty.config.defaults table description. I hope that the changes are in the right direction. Signed-off-by: Ignas Anikevicius (gns_ank) &lt;anikevicius&lt; at &gt;gmail.com&gt; --- lib/naughty.lua.in | 114 ++++++++++++++++++++++++++++++----------------------- 1 file changed, 64 insertions(+), 50 deletions(-) diff --git a/lib/naughty.lua.in b/lib/naughty.lua.in index 228ff17..98275b6 100644 --- a/lib/naughty.lua.in +++ b/lib/naughty.lua.in &lt; at &gt;&lt; at &gt; -33,35 +33,39 &lt; at &gt;&lt; at &gt; local naughty = {} --- Naughty configuration - a table containing common popup settings. naughty.config = {} ---- Space between popups and edge of the workarea. Default: 4 +--- Space between popups and edge of the workarea. +-- **Default:** `4` naughty.config.padding = 4 ---- Spacing between popups. Default: 1 +--- Spacing between popups. +-- **Default:** `1` naughty.config.spacing = 1 --- List of directories that will be checked by getIcon() --- Default: { "/usr/share/pixmaps/", } +-- **Default:** `{ "/usr/share/pixmaps/", }` naughty.config.icon_dirs = { "/usr/share/pixmaps/", } --- List of formats that will be checked by getIcon() --- Default: { "png", "gif" } +-- **Default:** `{ "png", "gif" }` naughty.config.icon_formats = { "png", "gif" } --- Callback used to modify or reject notifications. --- Default: nil --- Example: --- naughty.config.notify_callback = function(args) --- args.text = 'prefix: ' .. args.text --- return args --- end +-- **Default:** `nil` +-- &lt; at &gt;usage +--naughty.config.notify_callback = function(args) +-- args.text = 'prefix: ' .. args.text +-- return args +--end naughty.config.notify_callback = nil --- Notification Presets - a table containing presets for different purposes -- Preset is a table of any parameters available to notify(), overriding default --- values (&lt; at &gt;see defaults) +-- values. -- You have to pass a reference of a preset in your notify() call to use the preset -- The presets "low", "normal" and "critical" are used for notifications over DBUS +-- +-- &lt; at &gt;table naughty.config.presets -- &lt; at &gt;field low The preset for notifications with low urgency level -- &lt; at &gt;field normal The default preset for every notification without a preset that will also be used for normal urgency level -- &lt; at &gt;field critical The preset for notifications with a critical urgency level --- &lt; at &gt;class table +-- &lt; at &gt;see naughty.config.defaults naughty.config.presets = { normal = {}, low = { &lt; at &gt;&lt; at &gt; -76,6 +80,13 &lt; at &gt;&lt; at &gt; naughty.config.presets = { --- Default values for the params to notify(). -- These can optionally be overridden by specifying a preset +-- &lt; at &gt;param timeout `5` +-- &lt; at &gt;param text `""` +-- &lt; at &gt;param screen `1` +-- &lt; at &gt;param ontop `true` +-- &lt; at &gt;param margin `"5"` +-- &lt; at &gt;param border_width `"1"` +-- &lt; at &gt;param position `"top_right"` -- &lt; at &gt;see naughty.config.presets -- &lt; at &gt;see naughty.notify naughty.config.defaults = { &lt; at &gt;&lt; at &gt; -100,7 +111,6 &lt; at &gt;&lt; at &gt; local urgency = { -- If the rules in the filter matches the associated preset will be applied -- The rules object can contain: urgency, category, appname -- The second element is the preset - naughty.config.mapping = { {{urgency = urgency.low}, naughty.config.presets.low}, {{urgency = urgency.normal}, naughty.config.presets.normal}, &lt; at &gt;&lt; at &gt; -114,13 +124,13 &lt; at &gt;&lt; at &gt; local counter = 1 -- True if notifying is suspended local suspended = false ---- Index of notifications per screen and position. See config table for valid --- 'position' values. Each element is a table consisting of: --- &lt; at &gt;field box Wibox object containing the popup --- &lt; at &gt;field height Popup height --- &lt; at &gt;field width Popup width --- &lt; at &gt;field die Function to be executed on timeout --- &lt; at &gt;field id Unique notification id based on a counter +--- Index of notifications per screen and position. &lt; at &gt;see naughty.config table +-- for valid 'position' values. Each element is a table consisting of: +-- * box Wibox object containing the popup +-- * height Popup height +-- * width Popup width +-- * die Function to be executed on timeout +-- * id Unique notification id based on a counter naughty.notifications = { suspended = { } } for s = 1, capi.screen.count() do naughty.notifications[s] = { &lt; at &gt;&lt; at &gt; -157,7 +167,7 &lt; at &gt;&lt; at &gt; end -- Evaluate desired position of the notification by index - internal -- &lt; at &gt;param idx Index of the notification --- &lt; at &gt;param position top_right | top_left | bottom_right | bottom_left +-- &lt; at &gt;param position `"top_right"` | `"top_left"` | `"bottom_right"` | `"bottom_left"` -- &lt; at &gt;param height Popup height -- &lt; at &gt;param width Popup width (optional) -- &lt; at &gt;return Absolute position and index in { x = X, y = Y, idx = I } table &lt; at &gt;&lt; at &gt; -211,8 +221,11 &lt; at &gt;&lt; at &gt; local function arrange(screen) end --- Destroy notification by notification object --- &lt; at &gt;param notification Notification object to be destroyed +-- &lt; at &gt;tparam notification notification Notification object to be destroyed -- &lt; at &gt;return True if the popup was successfully destroyed, nil otherwise +-- &lt; at &gt;usage +--mynotification = naughty.notify({ text = "An example" }) +--naughty.destroy(mynotification) function naughty.destroy(notification) if notification and notification.box.visible then if suspended then &lt; at &gt;&lt; at &gt; -250,36 +263,37 &lt; at &gt;&lt; at &gt; local function getById(id) end end ---- Create notification. args is a dictionary of (optional) arguments. --- &lt; at &gt;param text Text of the notification. Default: '' --- &lt; at &gt;param title Title of the notification. Default: nil --- &lt; at &gt;param timeout Time in seconds after which popup expires. --- Set 0 for no timeout. Default: 5 --- &lt; at &gt;param hover_timeout Delay in seconds after which hovered popup disappears. --- Default: nil --- &lt; at &gt;param screen Target screen for the notification. Default: 1 --- &lt; at &gt;param position Corner of the workarea displaying the popups. --- Values: "top_right" (default), "top_left", "bottom_left", "bottom_right". --- &lt; at &gt;param ontop Boolean forcing popups to display on top. Default: true --- &lt; at &gt;param height Popup height. Default: nil (auto) --- &lt; at &gt;param width Popup width. Default: nil (auto) --- &lt; at &gt;param font Notification font. Default: beautiful.font or awesome.font --- &lt; at &gt;param icon Path to icon. Default: nil --- &lt; at &gt;param icon_size Desired icon size in px. Default: nil --- &lt; at &gt;param fg Foreground color. Default: beautiful.fg_focus or '#ffffff' --- &lt; at &gt;param bg Background color. Default: beautiful.bg_focus or '#535d6c' --- &lt; at &gt;param border_width Border width. Default: 1 --- &lt; at &gt;param border_color Border color. --- Default: beautiful.border_focus or '#535d6c' --- &lt; at &gt;param run Function to run on left click. Default: nil --- &lt; at &gt;param preset Table with any of the above parameters. Note: Any parameters --- specified directly in args will override ones defined in the preset. --- &lt; at &gt;param replaces_id Replace the notification with the given ID --- &lt; at &gt;param callback function that will be called with all arguments --- the notification will only be displayed if the function returns true --- note: this function is only relevant to notifications sent via dbus +--- Create notification. +-- &lt; at &gt;param args a dictionary of (optional) arguments: +-- &lt; at &gt;string args.text Text of the notification. +-- &lt; at &gt;string args.title Title of the notification. +-- &lt; at &gt;int args.timeout Time in seconds after which popup expires. Set `0` for no +-- timeout. +-- &lt; at &gt;int args.hover_timeout Delay in seconds after which hovered popup disappears. +-- &lt; at &gt;int args.screen Target screen for the notification. +-- &lt; at &gt;string args.position Corner of the workarea displaying the popups. +-- **Values:** `"top_right"`, `"top_left"`, `"bottom_left"`, `"bottom_right"`. +-- &lt; at &gt;bool args.ontop Boolean forcing popups to display on top. +-- &lt; at &gt;int args.height Popup height. +-- &lt; at &gt;int args.width Popup width. +-- &lt; at &gt;string args.font Notification font. +-- &lt; at &gt;string args.icon Path to icon. +-- &lt; at &gt;int args.icon_size Desired icon size in px. +-- &lt; at &gt;string args.fg Foreground color. +-- &lt; at &gt;string args.bg Background color. +-- &lt; at &gt;int args.border_width Border width. +-- &lt; at &gt;string args.border_color Border color. +-- &lt; at &gt;tparam function args.run Function to run on left click. +-- &lt; at &gt;tparam table args.preset Table with any of the above parameters. Note: Any +-- parameters specified directly in args will override ones defined in the +-- preset. +-- &lt; at &gt;int args.replaces_id Replace the notification with the given ID +-- &lt; at &gt;tparam function args.callback function that will be called with all arguments the +-- notification will only be displayed if the function returns true note: this +-- function is only relevant to notifications sent via dbus -- &lt; at &gt;usage naughty.notify({ title = "Achtung!", text = "You're idling", timeout = 0 }) -- &lt; at &gt;return The notification object +-- &lt; at &gt;see naughty.config.defaults function naughty.notify(args) if naughty.config.notify_callback then args = naughty.config.notify_callback(args) </pre> Ignas Anikevicius (gns_ank 2013-06-02T21:36:38 http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/8356 <pre>Signed-off-by: Ignas Anikevicius (gns_ank) &lt;anikevicius&lt; at &gt;gmail.com&gt; --- lib/menubar/init.lua.in | 28 ++++++++++++---------------- lib/menubar/utils.lua.in | 1 - 2 files changed, 12 insertions(+), 17 deletions(-) diff --git a/lib/menubar/init.lua.in b/lib/menubar/init.lua.in index 4583c78..11db2c5 100644 --- a/lib/menubar/init.lua.in +++ b/lib/menubar/init.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,16 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- List of menubar keybindings: +-- +-- * "Left" | "C-j" select an item on the left +-- * "Right" | "C-k" select an item on the right +-- * "Backspace" exit the current category if we are in any +-- * "Escape" exit the current directory or exit menubar +-- * "Home" select the first item +-- * "End" select the last +-- * "Return" execute the entry +-- * "C-Return" execute the command with `awful.util.spawn` +-- * "C-M-Return" execute the command in a terminal +-- -- &lt; at &gt;author Alexander Yakushev &amp;lt;yakushev.alex&lt; at &gt;gmail.com&amp;gt; -- &lt; at &gt;copyright 2011-2012 Alexander Yakushev -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; &lt; at &gt;&lt; at &gt; -15,26 +27,10 &lt; at &gt;&lt; at &gt; local common = require("awful.widget.common") local theme = require("beautiful") local wibox = require("wibox") --- menubar local menubar = { mt = {} } menubar.menu_gen = require("menubar.menu_gen") menubar.utils = require("menubar.utils") ---- List of menubar keybindings: --- &lt;p&gt;&lt;ul&gt; --- &lt;li&gt;"Left" | "C-j" select an item on the left&lt;/li&gt; --- &lt;li&gt;"Right" | "C-k" select an item on the right&lt;/li&gt; --- &lt;li&gt;"Backspace" exit the current category if we are in any&lt;/li&gt; --- &lt;li&gt;"Escape" exit the current directory or exit menubar&lt;/li&gt; --- &lt;li&gt;"Home" select the first item&lt;/li&gt; --- &lt;li&gt;"End" select the last&lt;/li&gt; --- &lt;li&gt;"Return" execute the entry&lt;/li&gt; --- &lt;li&gt;"C-Return" execute the command with awful.util.spawn&lt;/li&gt; --- &lt;li&gt;"C-M-Return" execute the command in a terminal&lt;/li&gt; --- &lt;/ul&gt;&lt;/p&gt; --- --- &lt; at &gt;class table --- &lt; at &gt;name Menubar keybindings -- Options section diff --git a/lib/menubar/utils.lua.in b/lib/menubar/utils.lua.in index 9f280ec..9535cc3 100644 --- a/lib/menubar/utils.lua.in +++ b/lib/menubar/utils.lua.in &lt; at &gt;&lt; at &gt; -194,7 +194,6 &lt; at &gt;&lt; at &gt; end --- Parse a directory with .desktop files -- &lt; at &gt;param dir The directory. --- &lt; at &gt;param icons_size, The icons sizes, optional. -- &lt; at &gt;return A table with all .desktop entries. function utils.parse_dir(dir) local programs = {} </pre> Ignas Anikevicius (gns_ank 2013-06-02T21:35:41 http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/8355 <pre>Signed-off-by: Ignas Anikevicius (gns_ank) &lt;anikevicius&lt; at &gt;gmail.com&gt; --- lib/wibox/drawable.lua.in | 4 ++-- lib/wibox/init.lua.in | 10 +++++----- lib/wibox/layout/align.lua.in | 1 - lib/wibox/layout/base.lua.in | 1 - lib/wibox/layout/constraint.lua.in | 1 - lib/wibox/layout/fixed.lua.in | 1 - lib/wibox/layout/flex.lua.in | 1 - lib/wibox/layout/init.lua.in | 5 ++--- lib/wibox/layout/margin.lua.in | 1 - lib/wibox/layout/mirror.lua.in | 1 - lib/wibox/layout/rotate.lua.in | 1 - lib/wibox/widget/init.lua.in | 2 -- 12 files changed, 9 insertions(+), 20 deletions(-) diff --git a/lib/wibox/drawable.lua.in b/lib/wibox/drawable.lua.in index ca043f5..9ee10c2 100644 --- a/lib/wibox/drawable.lua.in +++ b/lib/wibox/drawable.lua.in &lt; at &gt;&lt; at &gt; -1,11 +1,11 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- A File class. +-- -- &lt; at &gt;author Uli Schlachter -- &lt; at &gt;copyright 2012 Uli Schlachter -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; --------------------------------------------------------------------------- ---- A File class. --- &lt; at &gt;type The drawable to use local drawable = {} local capi = { diff --git a/lib/wibox/init.lua.in b/lib/wibox/init.lua.in index f41dca9..9dff9e9 100644 --- a/lib/wibox/init.lua.in +++ b/lib/wibox/init.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,7 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- This provides widget box windows. Every wibox can also be used as if it were +-- a drawin. All drawin functions and properties are also available on wiboxes! +-- -- &lt; at &gt;author Uli Schlachter -- &lt; at &gt;copyright 2010 Uli Schlachter -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; &lt; at &gt;&lt; at &gt; -21,9 +24,6 &lt; at &gt;&lt; at &gt; local beautiful = require("beautiful") local surface = require("gears.surface") local cairo = require("lgi").cairo ---- This provides widget box windows. Every wibox can also be used as if it were --- a drawin. All drawin functions and properties are also available on wiboxes! --- wibox local wibox = { mt = {} } wibox.layout = require("wibox.layout") wibox.widget = require("wibox.widget") &lt; at &gt;&lt; at &gt; -36,14 +36,14 &lt; at &gt;&lt; at &gt; end --- Set the background of the wibox -- &lt; at &gt;param c The background to use. This must either be a cairo pattern object, --- nil or a string that gears.color() understands. +-- nil or a string that gears.color() understands. function wibox:set_bg(c) self._drawable:set_bg(c) end --- Set the foreground of the wibox -- &lt; at &gt;param c The foreground to use. This must either be a cairo pattern object, --- nil or a string that gears.color() understands. +-- nil or a string that gears.color() understands. function wibox:set_fg(c) self._drawable:set_fg(c) end diff --git a/lib/wibox/layout/align.lua.in b/lib/wibox/layout/align.lua.in index 1631c68..c105dca 100644 --- a/lib/wibox/layout/align.lua.in +++ b/lib/wibox/layout/align.lua.in &lt; at &gt;&lt; at &gt; -11,7 +11,6 &lt; at &gt;&lt; at &gt; local type = type local base = require("wibox.layout.base") local widget_base = require("wibox.widget.base") --- wibox.layout.align local align = {} --- Draw an align layout. diff --git a/lib/wibox/layout/base.lua.in b/lib/wibox/layout/base.lua.in index 0d7e787..a37cf39 100644 --- a/lib/wibox/layout/base.lua.in +++ b/lib/wibox/layout/base.lua.in &lt; at &gt;&lt; at &gt; -10,7 +10,6 &lt; at &gt;&lt; at &gt; local print = print local min = math.min local max = math.max --- wibox.layout.base local base = {} --- Figure out the geometry in device coordinate space. This will break if diff --git a/lib/wibox/layout/constraint.lua.in b/lib/wibox/layout/constraint.lua.in index 9f75f03..51dcb24 100644 --- a/lib/wibox/layout/constraint.lua.in +++ b/lib/wibox/layout/constraint.lua.in &lt; at &gt;&lt; at &gt; -11,7 +11,6 &lt; at &gt;&lt; at &gt; local base = require("wibox.layout.base") local widget_base = require("wibox.widget.base") local math = math --- wibox.layout.constraint local constraint = { mt = {} } --- Draw a constraint layout diff --git a/lib/wibox/layout/fixed.lua.in b/lib/wibox/layout/fixed.lua.in index bb898f6..9aa4008 100644 --- a/lib/wibox/layout/fixed.lua.in +++ b/lib/wibox/layout/fixed.lua.in &lt; at &gt;&lt; at &gt; -9,7 +9,6 &lt; at &gt;&lt; at &gt; local widget_base = require("wibox.widget.base") local table = table local pairs = pairs --- wibox.layout.fixed local fixed = {} --- Draw a fixed layout. Each widget gets just the space it asks for. diff --git a/lib/wibox/layout/flex.lua.in b/lib/wibox/layout/flex.lua.in index 0b2b5a8..717f358 100644 --- a/lib/wibox/layout/flex.lua.in +++ b/lib/wibox/layout/flex.lua.in &lt; at &gt;&lt; at &gt; -10,7 +10,6 &lt; at &gt;&lt; at &gt; local table = table local pairs = pairs local floor = math.floor --- wibox.layout.flex local flex = {} local function round(x) diff --git a/lib/wibox/layout/init.lua.in b/lib/wibox/layout/init.lua.in index c89297e..5297b0d 100644 --- a/lib/wibox/layout/init.lua.in +++ b/lib/wibox/layout/init.lua.in &lt; at &gt;&lt; at &gt; -1,12 +1,11 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- Collection of layouts that can be used in widget boxes +-- -- &lt; at &gt;author Uli Schlachter -- &lt; at &gt;copyright 2010 Uli Schlachter -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; --------------------------------------------------------------------------- ---- Collection of layouts that can be used in widget boxes --- wibox.layout - return { base = require("wibox.layout.base"); diff --git a/lib/wibox/layout/margin.lua.in b/lib/wibox/layout/margin.lua.in index 98d770d..acc78b7 100644 --- a/lib/wibox/layout/margin.lua.in +++ b/lib/wibox/layout/margin.lua.in &lt; at &gt;&lt; at &gt; -10,7 +10,6 &lt; at &gt;&lt; at &gt; local setmetatable = setmetatable local base = require("wibox.layout.base") local widget_base = require("wibox.widget.base") --- wibox.layout.margin local margin = { mt = {} } --- Draw a margin layout diff --git a/lib/wibox/layout/mirror.lua.in b/lib/wibox/layout/mirror.lua.in index 1b55066..5816a70 100644 --- a/lib/wibox/layout/mirror.lua.in +++ b/lib/wibox/layout/mirror.lua.in &lt; at &gt;&lt; at &gt; -12,7 +12,6 &lt; at &gt;&lt; at &gt; local setmetatable = setmetatable local base = require("wibox.layout.base") local widget_base = require("wibox.widget.base") --- wibox.layout.mirror local mirror = { mt = {} } --- Draw this layout diff --git a/lib/wibox/layout/rotate.lua.in b/lib/wibox/layout/rotate.lua.in index ac262f3..1fcecf7 100644 --- a/lib/wibox/layout/rotate.lua.in +++ b/lib/wibox/layout/rotate.lua.in &lt; at &gt;&lt; at &gt; -13,7 +13,6 &lt; at &gt;&lt; at &gt; local tostring = tostring local base = require("wibox.layout.base") local widget_base = require("wibox.widget.base") --- wibox.layout.rotate local rotate = { mt = {} } local function transform(layout, width, height) diff --git a/lib/wibox/widget/init.lua.in b/lib/wibox/widget/init.lua.in index aedd5a1..b6fa5ef 100644 --- a/lib/wibox/widget/init.lua.in +++ b/lib/wibox/widget/init.lua.in &lt; at &gt;&lt; at &gt; -4,8 +4,6 &lt; at &gt;&lt; at &gt; -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; --------------------------------------------------------------------------- ---- wibox.widget - return { base = require("wibox.widget.base"); </pre> Ignas Anikevicius (gns_ank 2013-06-02T21:35:07 http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/8354 <pre>Here I made some refactoring on the drawable side. Not much was needed. in this stage. Signed-off-by: Ignas Anikevicius (gns_ank) &lt;anikevicius&lt; at &gt;gmail.com&gt; --- lib/wibox/drawable.lua.in | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/lib/wibox/drawable.lua.in b/lib/wibox/drawable.lua.in index a31e618..ca043f5 100644 --- a/lib/wibox/drawable.lua.in +++ b/lib/wibox/drawable.lua.in &lt; at &gt;&lt; at &gt; -4,7 +4,10 &lt; at &gt;&lt; at &gt; -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; --------------------------------------------------------------------------- +--- A File class. +-- &lt; at &gt;type The drawable to use local drawable = {} + local capi = { awesome = awesome, root = root &lt; at &gt;&lt; at &gt; -69,7 +72,7 &lt; at &gt;&lt; at &gt; end -- &lt; at &gt;param x X coordinate of the point -- &lt; at &gt;param y Y coordinate of the point -- &lt; at &gt;return A sorted table with all widgets that contain the given point. The --- widgets are sorted by relevance. +-- widgets are sorted by relevance. function drawable:find_widgets(x, y) local matches = {} -- Find all widgets that contain the point &lt; at &gt;&lt; at &gt; -112,9 +115,8 &lt; at &gt;&lt; at &gt; function drawable:set_widget(widget) end --- Set the background of the drawable --- &lt; at &gt;param drawable The drawable to use -- &lt; at &gt;param c The background to use. This must either be a cairo pattern object, --- nil or a string that gears.color() understands. +-- nil or a string that gears.color() understands. function drawable:set_bg(c) local c = c or "#000000" if type(c) == "string" or type(c) == "table" then &lt; at &gt;&lt; at &gt; -125,9 +127,8 &lt; at &gt;&lt; at &gt; function drawable:set_bg(c) end --- Set the foreground of the drawable --- &lt; at &gt;param drawable The drawable to use -- &lt; at &gt;param c The foreground to use. This must either be a cairo pattern object, --- nil or a string that gears.color() understands. +-- nil or a string that gears.color() understands. function drawable:set_fg(c) local c = c or "#FFFFFF" if type(c) == "string" or type(c) == "table" then </pre> Ignas Anikevicius (gns_ank 2013-06-02T21:34:23 http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/8353 <pre>This essentially changes lots of stuff in awful documentation. Use markdown where necessary and update the formating of the parameters. Some of the changes are not consistent, but in my opinion it is a move to the right direction. I hope that it will be easier to maintain stuff in the future. Signed-off-by: Ignas Anikevicius (gns_ank) &lt;anikevicius&lt; at &gt;gmail.com&gt; --- lib/awful/autofocus.lua.in | 7 +- lib/awful/button.lua.in | 10 ++- lib/awful/client.lua.in | 52 +++++++------- lib/awful/completion.lua.in | 24 +++---- lib/awful/dbus.lua.in | 9 ++- lib/awful/ewmh.lua.in | 6 +- lib/awful/init.lua.in | 5 +- lib/awful/key.lua.in | 4 +- lib/awful/keygrabber.lua.in | 4 +- lib/awful/layout/init.lua.in | 2 +- lib/awful/menu.lua.in | 118 ++++++++++++++++++------------- lib/awful/rules.lua.in | 135 +++++++++++++++--------------------- lib/awful/screen.lua.in | 2 +- lib/awful/tag.lua.in | 6 +- lib/awful/tooltip.lua.in | 65 +++++++++-------- lib/awful/util.lua.in | 4 +- lib/awful/wibox.lua.in | 2 +- lib/awful/widget/button.lua.in | 3 +- lib/awful/widget/common.lua.in | 3 +- lib/awful/widget/graph.lua.in | 5 +- lib/awful/widget/init.lua.in | 5 +- lib/awful/widget/launcher.lua.in | 3 +- lib/awful/widget/layoutbox.lua.in | 4 +- lib/awful/widget/progressbar.lua.in | 4 +- lib/awful/widget/prompt.lua.in | 3 +- lib/awful/widget/taglist.lua.in | 49 +++++++------ lib/awful/widget/tasklist.lua.in | 58 ++++++++-------- lib/awful/widget/textclock.lua.in | 8 +-- 28 files changed, 302 insertions(+), 298 deletions(-) diff --git a/lib/awful/autofocus.lua.in b/lib/awful/autofocus.lua.in index 271b29f..bdd979e 100644 --- a/lib/awful/autofocus.lua.in +++ b/lib/awful/autofocus.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,7 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- 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. +-- -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;copyright 2009 Julien Danjou -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; &lt; at &gt;&lt; at &gt; -9,10 +12,6 &lt; at &gt;&lt; at &gt; local screen = screen local aclient = require("awful.client") local atag = require("awful.tag") ---- 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. --- awful.autofocus - -- Give focus when clients appear/disappear. -- &lt; at &gt;param obj An object that should have a .screen property. local function check_focus(obj) diff --git a/lib/awful/button.lua.in b/lib/awful/button.lua.in index 1d3b31c..65f9936 100644 --- a/lib/awful/button.lua.in +++ b/lib/awful/button.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,6 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- Create easily new button objects ignoring certain modifiers. +-- -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;copyright 2009 Julien Danjou -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; &lt; at &gt;&lt; at &gt; -10,12 +12,10 &lt; at &gt;&lt; at &gt; local ipairs = ipairs local capi = { button = button } local util = require("awful.util") ---- Create easily new buttons objects ignoring certain modifiers. --- awful.button local button = { mt = {} } --- Modifiers to ignore. --- By default this is initialized as { "Lock", "Mod2" } +-- By default this is initialized as `{ "Lock", "Mod2" }` -- so the Caps Lock or Num Lock modifier are not taking into account by awesome -- when pressing keys. -- &lt; at &gt;name ignore_modifiers &lt; at &gt;&lt; at &gt; -30,6 +30,10 &lt; at &gt;&lt; at &gt; local ignore_modifiers = { "Lock", "Mod2" } -- ignored by default by this function), creating button binding with this function -- will return 2 button objects: one with CapsLock on, and the other one with -- CapsLock off. +-- &lt; at &gt;tparam table mod A table containing modifiers +-- &lt; at &gt;tparam string _button Button name +-- &lt; at &gt;tparam function press Press action +-- &lt; at &gt;tparam function release Release action -- &lt; at &gt;see button -- &lt; at &gt;return A table with one or several button objects. function button.new(mod, _button, press, release) diff --git a/lib/awful/client.lua.in b/lib/awful/client.lua.in index 469dbfe..1644042 100644 --- a/lib/awful/client.lua.in +++ b/lib/awful/client.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,6 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- Useful client manipulation functions. +-- -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;copyright 2008 Julien Danjou -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; &lt; at &gt;&lt; at &gt; -23,8 +25,6 &lt; at &gt;&lt; at &gt; local capi = -- we use require("awful.screen") inside functions to prevent circular dependencies. local screen ---- Useful client manipulation functions. --- awful.client local client = {} &lt; at &gt;&lt; at &gt; -228,7 +228,9 &lt; at &gt;&lt; at &gt; function client.tiled(screen) end --- Get a client by its relative index to the focused window. --- &lt; at &gt;usage Set i to 1 to get next, -1 to get previous. +-- &lt; at &gt;usage +-- client.next(1,c) -- to get next +-- client.next(-1,c) -- to get previous -- &lt; at &gt;param i The index. -- &lt; at &gt;param c Optional client. -- &lt; at &gt;return A client, or nil if no client is available. &lt; at &gt;&lt; at &gt; -890,20 +892,18 &lt; at &gt;&lt; at &gt; end -- the given index, all clients that match a given criteria. -- -- &lt; at &gt;param filter a function that returns true to indicate a positive match --- &lt; at &gt;param start what index to start iterating from. Defaults to using the +-- &lt; at &gt;param start what index to start iterating from. Defaults to using the -- index of the currently focused client. --- &lt; at &gt;param s which screen to use. nil means all screens. +-- &lt; at &gt;param s which screen to use. nil means all screens. +-- +-- &lt; at &gt;usage -- un-minimize all urxvt instances +-- local urxvt = function (c) +-- return awful.rules.match(c, {class = "URxvt"}) +-- end -- --- &lt; at &gt;usage e.g.: un-minimize all urxvt instances --- &lt;p&gt;&lt;code&gt; --- local urxvt = function (c) &lt;br/&gt; --- return awful.rules.match(c, {class = "URxvt"}) &lt;br/&gt; --- end &lt;br/&gt; --- &lt;/br&gt; --- for c in awful.client.iterate(urxvt) do &lt;br/&gt; --- c.minimized = false &lt;br/&gt; --- end &lt;br/&gt; --- &lt;/code&gt;&lt;/p&gt; +-- for c in awful.client.iterate(urxvt) do +-- c.minimized = false +-- end function client.iterate(filter, start, s) local clients = capi.client.get(s) local focused = capi.client.focus &lt; at &gt;&lt; at &gt; -912,23 +912,21 &lt; at &gt;&lt; at &gt; function client.iterate(filter, start, s) end --- --- &lt;p&gt;Switch to a client matching the given condition if running, else spawn it. +-- Switch to a client matching the given condition if running, else spawn it. -- If multiple clients match the given condition then the next one is --- focussed.&lt;/p&gt; +-- focussed. -- --- &lt; at &gt;param cmd the command to execute +-- &lt; at &gt;param cmd the command to execute -- &lt; at &gt;param matcher a function that returns true to indicate a matching client --- &lt; at &gt;param merge if true then merge tags when clients are not visible +-- &lt; at &gt;param merge if true then merge tags when clients are not visible -- --- &lt; at &gt;usage run or raise urxvt (perhaps, with tabs) on modkey + semicolon --- &lt;p&gt;&lt;code&gt; --- awful.key({ modkey, }, 'semicolon', function () &lt;br/&gt; --- local matcher = function (c) &lt;br/&gt; --- return awful.rules.match(c, {class = 'URxvt'}) &lt;br/&gt; --- end &lt;br/&gt; +-- &lt; at &gt;usage -- run or raise urxvt (perhaps, with tabs) on modkey + semicolon +-- awful.key({ modkey, }, 'semicolon', function () +-- local matcher = function (c) +-- return awful.rules.match(c, {class = 'URxvt'}) +-- end -- awful.client.run_or_raise('urxvt', matcher) --- end); --- &lt;/code&gt;&lt;/p&gt; +-- end) function client.run_or_raise(cmd, matcher, merge) local clients = capi.client.get() local findex = util.table.hasitem(clients, capi.client.focus) or 1 diff --git a/lib/awful/completion.lua.in b/lib/awful/completion.lua.in index 5f0450d..129475a 100644 --- a/lib/awful/completion.lua.in +++ b/lib/awful/completion.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,7 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- Completion module. +-- A set of helper functions to complete command names using shell. +-- -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;author Sébastien Gross &amp;lt;seb-awesome&lt; at &gt;chezwam.org&amp;gt; -- &lt; at &gt;copyright 2008 Julien Danjou, Sébastien Gross &lt; at &gt;&lt; at &gt; -15,9 +18,6 &lt; at &gt;&lt; at &gt; local pairs = pairs local string = string local util = require("awful.util") ---- Completion module. --- This module store a set of function using shell to complete commands name. --- awful.completion local completion = {} -- mapping of command/completion function &lt; at &gt;&lt; at &gt; -26,7 +26,7 &lt; at &gt;&lt; at &gt; local bashcomp_src = "&lt; at &gt;SYSCONFDIR&lt; at &gt;/bash_completion" --- Enable programmable bash completion in awful.completion.bash at the price of -- a slight overhead. --- &lt; at &gt;param src The bash completion source file, /etc/bash_completion by default. +-- &lt; at &gt;tparam string src The bash completion source file, /etc/bash_completion by default. function completion.bashcomp_load(src) if src then bashcomp_src = src end local c, err = io.popen("/usr/bin/env bash -c 'source " .. bashcomp_src .. "; complete -p'") &lt; at &gt;&lt; at &gt; -55,10 +55,10 &lt; at &gt;&lt; at &gt; local function bash_escape(str) end --- Use shell completion system to complete command and filename. --- &lt; at &gt;param command The command line. --- &lt; at &gt;param cur_pos The cursor position. --- &lt; at &gt;param ncomp The element number to complete. --- &lt; at &gt;param shell The shell to use for completion (bash (default) or zsh). +-- &lt; at &gt;tparam string command The command line. +-- &lt; at &gt;tparam int cur_pos The cursor position. +-- &lt; at &gt;tparam int ncomp The element number to complete. +-- &lt; at &gt;tparam string shell The shell to use for completion (bash (default) or zsh). -- &lt; at &gt;return The new command, the new cursor position, the table of all matches. function completion.shell(command, cur_pos, ncomp, shell) local wstart = 1 &lt; at &gt;&lt; at &gt; -156,10 +156,10 &lt; at &gt;&lt; at &gt; end --- Run a generic completion. -- For this function to run properly the awful.completion.keyword table should -- be fed up with all keywords. The completion is run against these keywords. --- &lt; at &gt;param text The current text the user had typed yet. --- &lt; at &gt;param cur_pos The current cursor position. --- &lt; at &gt;param ncomp The number of yet requested completion using current text. --- &lt; at &gt;param keywords The keywords table uised for completion. +-- &lt; at &gt;tparam string text The current text the user had already typed. +-- &lt; at &gt;tparam int cur_pos The current cursor position. +-- &lt; at &gt;tparam int ncomp The number of yet requested completion using current text. +-- &lt; at &gt;tparam table keywords The keywords table used for completion. -- &lt; at &gt;return The new match, the new cursor position, the table of all matches. function completion.generic(text, cur_pos, ncomp, keywords) -- The keywords table may be empty diff --git a/lib/awful/dbus.lua.in b/lib/awful/dbus.lua.in index 323df02..e800936 100644 --- a/lib/awful/dbus.lua.in +++ b/lib/awful/dbus.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,8 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- D-Bus module for awful. +-- This module simply requests the org.naquadah.awesome.awful name on the D-Bus +-- for future usage by other awful modules. +-- -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;copyright 2009 Julien Danjou -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; &lt; at &gt;&lt; at &gt; -7,11 +11,6 &lt; at &gt;&lt; at &gt; -- Grab environment we need local dbus = dbus ---- D-Bus module for awful. --- This module simply request the org.naquadah.awesome.awful name on the D-Bus --- for futur usage by other awful modules. --- awful.dbus - if dbus then dbus.request_name("session", "org.naquadah.awesome.awful") end diff --git a/lib/awful/ewmh.lua.in b/lib/awful/ewmh.lua.in index a99add1..2b4f007 100644 --- a/lib/awful/ewmh.lua.in +++ b/lib/awful/ewmh.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,7 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- EWMH implementation for awful. +-- Implements EWMH requests handling in LUA. +-- -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;copyright 2009 Julien Danjou -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; &lt; at &gt;&lt; at &gt; -10,9 +13,6 &lt; at &gt;&lt; at &gt; local screen = screen local ipairs = ipairs local math = math ---- Implements EWMH requests handling. --- awful.ewmh - local data = setmetatable({}, { __mode = 'k' }) local function store_geometry(window, reqtype) diff --git a/lib/awful/init.lua.in b/lib/awful/init.lua.in index cb64420..361367f 100644 --- a/lib/awful/init.lua.in +++ b/lib/awful/init.lua.in &lt; at &gt;&lt; at &gt; -1,12 +1,11 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- AWesome Functions very UsefuL +-- -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;copyright 2008 Julien Danjou -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; --------------------------------------------------------------------------- ---- AWesome Functions very UsefuL --- awful - return { client = require("awful.client"); diff --git a/lib/awful/key.lua.in b/lib/awful/key.lua.in index 5e211fd..3bbc13a 100644 --- a/lib/awful/key.lua.in +++ b/lib/awful/key.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,6 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- Create easily new key objects ignoring certain modifiers. +-- -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;copyright 2009 Julien Danjou -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; &lt; at &gt;&lt; at &gt; -10,8 +12,6 &lt; at &gt;&lt; at &gt; local ipairs = ipairs local capi = { key = key } local util = require("awful.util") ---- Create easily new key objects ignoring certain modifiers. --- awful.key local key = { mt = {} } --- Modifiers to ignore. diff --git a/lib/awful/keygrabber.lua.in b/lib/awful/keygrabber.lua.in index e1deef8..d9e163b 100644 --- a/lib/awful/keygrabber.lua.in +++ b/lib/awful/keygrabber.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,6 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- Keygrabber Stack +-- -- &lt; at &gt;author dodo -- &lt; at &gt;copyright 2012 dodo -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; &lt; at &gt;&lt; at &gt; -9,8 +11,6 &lt; at &gt;&lt; at &gt; local table = table local capi = { keygrabber = keygrabber } ---- Keygrabber Stack --- awful.keygrabber local keygrabber = {} -- Private data diff --git a/lib/awful/layout/init.lua.in b/lib/awful/layout/init.lua.in index fec04ee..05cabd6 100644 --- a/lib/awful/layout/init.lua.in +++ b/lib/awful/layout/init.lua.in &lt; at &gt;&lt; at &gt; -89,7 +89,7 &lt; at &gt;&lt; at &gt; function layout.arrange(screen) end --- Get the current layout name. --- &lt; at &gt;param layout The layout. +-- &lt; at &gt;param _layout The layout. -- &lt; at &gt;return The layout name. function layout.getname(_layout) local _layout = _layout or layout.get() diff --git a/lib/awful/menu.lua.in b/lib/awful/menu.lua.in index ba92da7..9952697 100644 --- a/lib/awful/menu.lua.in +++ b/lib/awful/menu.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,6 &lt; at &gt;&lt; at &gt; -------------------------------------------------------------------------------- +--- The menu module for awful. +-- -- &lt; at &gt;author Damien Leone &amp;lt;damien.leone&lt; at &gt;gmail.com&amp;gt; -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;author dodo &lt; at &gt;&lt; at &gt; -31,8 +33,6 &lt; at &gt;&lt; at &gt; local capi = { mouse = mouse, client = client } - --- awful.menu local menu = { mt = {} } &lt; at &gt;&lt; at &gt; -51,17 +51,24 &lt; at &gt;&lt; at &gt; end --- Key bindings for menu navigation. --- Keys are: up, down, exec, enter, back, close. Value are table with a list of valid +-- Value are table with a list of valid -- keys for the action, i.e. menu_keys.up = { "j", "k" } will bind 'j' and 'k' -- key to up action. This is common to all created menu. --- &lt; at &gt;class table --- &lt; at &gt;name menu_keys -menu.menu_keys = { up = { "Up" }, - down = { "Down" }, - back = { "Left" }, - exec = { "Return" }, - enter = { "Right" }, - close = { "Escape" } } +-- &lt; at &gt;table menu.menu_keys +-- &lt; at &gt;field up Select the item above the current position. Default: `"Up"` +-- &lt; at &gt;field down Select the item bellow the current position. Default: `"Down"` +-- &lt; at &gt;field back Go back to the previous menu. Default: `"Left"` +-- &lt; at &gt;field enter Go into the currently selected menu item. Default: `"Right"` +-- &lt; at &gt;field exec Execute the currently selected item Default: `"Return"` +-- &lt; at &gt;field close Close the menu. Default: `"Escape"` +menu.menu_keys = { + up = { "Up" }, + down = { "Down" }, + back = { "Left" }, + enter = { "Right" }, + exec = { "Return" }, + close = { "Escape" } +} local function load_theme(a, b) &lt; at &gt;&lt; at &gt; -309,6 +316,7 &lt; at &gt;&lt; at &gt; end --- Show a menu. +-- &lt; at &gt;tparam table args A parameter table -- &lt; at &gt;param args.coords Menu position defaulting to mouse.coords() function menu:show(args) args = args or {} &lt; at &gt;&lt; at &gt; -339,7 +347,7 &lt; at &gt;&lt; at &gt; function menu:hide() end --- Toggle menu visibility. --- &lt; at &gt;param _menu The menu to show if it's hidden, or to hide if it's shown. +-- &lt; at &gt;tparam table args A parameter table -- &lt; at &gt;param args.coords Menu position {x,y} function menu:toggle(args) if self.wibox.visible then &lt; at &gt;&lt; at &gt; -364,10 +372,9 &lt; at &gt;&lt; at &gt; function menu:get_root() end --- Add a new menu entry. --- args.new (Default: awful.menu.entry) The menu entry constructor. --- args.theme (Optional) The menu entry theme. --- args.* params needed for the menu entry constructor. --- &lt; at &gt;param args The item params +-- &lt; at &gt;param args The item params needed for the menu entry constructor +-- &lt; at &gt;param args.new (Default: awful.menu.entry) The menu entry constructor. +-- &lt; at &gt;param args.theme (Optional) The menu entry theme. -- &lt; at &gt;param index (Optional) the index where the new entry will inserted function menu:add(args, index) if not args then return end &lt; at &gt;&lt; at &gt; -424,7 +431,6 &lt; at &gt;&lt; at &gt; function menu:add(args, index) end -- Delete menu entry at given position --- &lt; at &gt;param _menu The menu -- &lt; at &gt;param num The position in the table of the menu entry to be deleted; can be also the menu entry itself function menu:delete(num) if type(num) == "table" then &lt; at &gt;&lt; at &gt; -455,7 +461,7 &lt; at &gt;&lt; at &gt; end -------------------------------------------------------------------------------- --- Build a popup menu with running clients and shows it. --- &lt; at &gt;param _menu Menu table, see new() function for more informations +-- &lt; at &gt;param args Menu table, see new() function for more informations -- &lt; at &gt;return The menu. function menu:clients(args) -- FIXME crude api _menu = self or {} &lt; at &gt;&lt; at &gt; -578,37 +584,53 &lt; at &gt;&lt; at &gt; end -------------------------------------------------------------------------------- --- Create a menu popup. --- &lt; at &gt;param args Table containing the menu informations.&lt;br/&gt; --- &lt;ul&gt; --- &lt;li&gt; Key items: Table containing the displayed items. Each element is a table by default (when element 'new' is awful.menu.entry) containing: item name, triggered action, submenu table or function, item icon (optional). &lt;/li&gt; --- &lt;li&gt; Keys theme.[fg|bg]_[focus|normal], theme.border_color, theme.border_width, theme.submenu_icon, theme.height and theme.width override the default display for your menu and/or of your menu entry, each of them are optional. &lt;/li&gt; --- &lt;li&gt; Key auto_expand controls the submenu auto expand behaviour by setting it to true (default) or false. &lt;/li&gt; --- &lt;/ul&gt; --- &lt; at &gt;param parent Specify the parent menu if we want to open a submenu, this value should never be set by the user. --- &lt; at &gt;usage The following function builds, and shows a menu of clients that match --- a particular rule. Bound to a key, it can for example be used to select from --- dozens of terminals open on several tags. With the use of --- &lt;code&gt;match_any&lt;/code&gt; instead of &lt;code&gt;match&lt;/code&gt;, menu of clients with --- different classes can also be build. +-- &lt; at &gt;tparam table args Table containing the menu informations. +-- +-- &lt; at &gt;tparam table args.items Table containing the displayed items. Each element is a table +-- by default (when element 'new' is `awful.menu.entry`) containing: item name, +-- triggered action, submenu table or function, item icon (optional). +-- +-- &lt; at &gt;tparam table args.theme A table overriding the default display for your menu +-- and/or of yor menu entry, each of the following is optional. +-- &lt; at &gt;tparam string args.theme.fg_focus +-- &lt; at &gt;tparam string args.theme.bg_focus +-- &lt; at &gt;tparam string args.theme.fg_normal +-- &lt; at &gt;tparam string args.theme.bg_normal +-- &lt; at &gt;tparam string args.theme.border_color +-- &lt; at &gt;tparam string args.theme.border_width +-- &lt; at &gt;tparam string args.theme.submenu_icon +-- &lt; at &gt;tparam int args.theme.height +-- &lt; at &gt;tparam int args.theme.width +-- +-- &lt; at &gt;tparam bool args.auto_expand controls the submenu auto expand behaviour by +-- setting it to true (default) or false. +-- +-- &lt; at &gt;param parent Specify the parent menu if we want to open a submenu, this +-- value should never be set by the user. +-- +-- &lt; at &gt;usage +-- -- The following function builds, and shows a menu of clients that +-- -- match a particular rule. Bound to a key, it can for example be used to +-- -- select from dozens of terminals open on several tags. With the use of +-- -- 'match_any' instead of 'match', menu of clients with different classes can +-- -- also be build. -- --- &lt;p&gt;&lt;code&gt; --- function terminal_menu () &lt;br/&gt; --- &amp;nbsp; terms = {} &lt;br/&gt; --- &amp;nbsp; for i, c in pairs(client.get()) do &lt;br/&gt; --- &amp;nbsp;&amp;nbsp; if awful.rules.match(c, {class = "URxvt"}) then &lt;br/&gt; --- &amp;nbsp;&amp;nbsp;&amp;nbsp; terms[i] = &lt;br/&gt; --- &amp;nbsp;&amp;nbsp;&amp;nbsp; {c.name, &lt;br/&gt; --- &amp;nbsp;&amp;nbsp;&amp;nbsp; function() &lt;br/&gt; --- &amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp; awful.tag.viewonly(c:tags()[1]) &lt;br/&gt; --- &amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp; client.focus = c &lt;br/&gt; --- &amp;nbsp;&amp;nbsp;&amp;nbsp; end, &lt;br/&gt; --- &amp;nbsp;&amp;nbsp;&amp;nbsp; c.icon &lt;br/&gt; --- &amp;nbsp;&amp;nbsp;&amp;nbsp; } &lt;br/&gt; --- &amp;nbsp;&amp;nbsp; end &lt;br/&gt; --- &amp;nbsp; end &lt;br/&gt; --- &amp;nbsp; awful.menu(terms):show() &lt;br/&gt; --- end &lt;br/&gt; ---&lt;/code&gt;&lt;/p&gt; +-- function terminal_menu () +-- terms = {} +-- for i, c in pairs(client.get()) do +-- if awful.rules.match(c, {class = "URxvt"}) then +-- terms[i] = +-- {c.name, +-- function() +-- awful.tag.viewonly(c:tags()[1]) +-- client.focus = c +-- end, +-- c.icon +-- } +-- end +-- end +-- awful.menu(terms):show() +-- end function menu.new(args, parent) args = args or {} args.layout = args.layout or wibox.layout.flex.vertical diff --git a/lib/awful/rules.lua.in b/lib/awful/rules.lua.in index 8891d44..5d543ba 100644 --- a/lib/awful/rules.lua.in +++ b/lib/awful/rules.lua.in &lt; at &gt;&lt; at &gt; -18,91 +18,70 &lt; at &gt;&lt; at &gt; local atag = require("awful.tag") local rules = {} --- This is the global rules table. --- &lt;p&gt;You should fill this table with your rule and properties to apply. +-- You should fill this table with your rule and properties to apply. -- For example, if you want to set xterm maximized at startup, you can add: --- &lt;br/&gt; --- &lt;code&gt; --- { rule = { class = "xterm" }, --- properties = { maximized_vertical = true, maximized_horizontal = true } } --- &lt;/code&gt; --- &lt;/p&gt; --- &lt;p&gt;If you want to set mplayer floating at startup, you can add: --- &lt;br/&gt; --- &lt;code&gt; --- { rule = { name = "MPlayer" }, --- properties = { floating = true } } --- &lt;/code&gt; --- &lt;/p&gt; --- &lt;p&gt;If you want to put Firefox on a specific tag at startup, you --- can add: --- &lt;br/&gt; --- &lt;code&gt; --- { rule = { instance = "firefox" }, --- properties = { tag = mytagobject } } --- &lt;/code&gt; --- &lt;/p&gt; --- &lt;p&gt;If you want to put Emacs on a specific tag at startup, and --- immediately switch to that tag you can add: --- &lt;br/&gt; --- &lt;code&gt; --- { rule = { class = "Emacs" }, --- properties = { tag = mytagobject, switchtotag = true } } --- &lt;/code&gt; --- &lt;/p&gt; --- &lt;p&gt;If you want to apply a custom callback to execute when a rule matched, +-- +-- { rule = { class = "xterm" }, +-- properties = { maximized_vertical = true, maximized_horizontal = true } } +-- +-- If you want to set mplayer floating at startup, you can add: +-- +-- { rule = { name = "MPlayer" }, +-- properties = { floating = true } } +-- +-- If you want to put Firefox on a specific tag at startup, you can add: +-- +-- { rule = { instance = "firefox" }, +-- properties = { tag = mytagobject } } +-- +-- If you want to put Emacs on a specific tag at startup, and immediately switch +-- to that tag you can add: +-- +-- { rule = { class = "Emacs" }, +-- properties = { tag = mytagobject, switchtotag = true } } +-- +-- If you want to apply a custom callback to execute when a rule matched, -- for example to pause playing music from mpd when you start dosbox, you -- can add: --- &lt;br/&gt; --- &lt;code&gt; --- { rule = { class = "dosbox" }, --- callback = function(c) --- awful.util.spawn('mpc pause') --- end } --- &lt;/code&gt; --- &lt;/p&gt; --- &lt;p&gt;Note that all "rule" entries need to match. If any of the entry does not --- match, the rule won't be applied.&lt;/p&gt; --- &lt;p&gt;If a client matches multiple rules, their applied in the order they are +-- +-- { rule = { class = "dosbox" }, +-- callback = function(c) +-- awful.util.spawn('mpc pause') +-- end } +-- +-- Note that all "rule" entries need to match. If any of the entry does not +-- match, the rule won't be applied. +-- +-- If a client matches multiple rules, their applied in the order they are -- put in this global rules table. If the value of a rule is a string, then the --- match function is used to determine if the client matches the rule.&lt;/p&gt; --- &lt;p&gt;If the value of a property is a function, that function gets called and --- function's return value is used for the property.&lt;/p&gt; +-- match function is used to determine if the client matches the rule. -- --- &lt;p&gt; To match multiple clients to a rule one need to use slightly different +-- If the value of a property is a function, that function gets called and +-- function's return value is used for the property. +-- +-- To match multiple clients to a rule one need to use slightly different -- syntax: --- &lt;br/&gt; --- &lt;code&gt; --- { rule_any = { class = { "MPlayer", "Nitrogen" }, instance = { "xterm" } }, --- properties = { floating = true } } --- &lt;/code&gt; --- &lt;/p&gt; --- --- &lt;p&gt; To match multiple clients with an exception one can couple 'except' or +-- +-- { rule_any = { class = { "MPlayer", "Nitrogen" }, instance = { "xterm" } }, +-- properties = { floating = true } } +-- +-- To match multiple clients with an exception one can couple 'except' or -- 'except_any' with the rules: --- &lt;br/&gt; --- &lt;code&gt; --- { rule = { class = "Firefox" }, --- except = { instance = "Navigator" }, --- properties = {floating = true}, --- }, --- &lt;/code&gt; --- &lt;br/&gt; --- &lt;code&gt; --- { rule_any = { class = { "Pidgin", "Xchat" } }, --- except_any = { role = { "conversation" } }, --- properties = { tag = tags[1][1] } --- } --- &lt;br/&gt; --- &lt;code&gt; --- { rule = {}, --- except_any = { class = { "Firefox", "Vim" } }, --- properties = { floating = true } --- } --- &lt;/code&gt; --- &lt;/p&gt; --- --- &lt; at &gt;class table --- &lt; at &gt;name rules +-- +-- { rule = { class = "Firefox" }, +-- except = { instance = "Navigator" }, +-- properties = {floating = true}, +-- }, +-- { rule_any = { class = { "Pidgin", "Xchat" } }, +-- except_any = { role = { "conversation" } }, +-- properties = { tag = tags[1][1] } +-- }, +-- { rule = {}, +-- except_any = { class = { "Firefox", "Vim" } }, +-- properties = { floating = true } +-- } +-- + rules.rules = {} --- Check if a client match a rule. diff --git a/lib/awful/screen.lua.in b/lib/awful/screen.lua.in index 38caf85..1cac26e 100644 --- a/lib/awful/screen.lua.in +++ b/lib/awful/screen.lua.in &lt; at &gt;&lt; at &gt; -44,7 +44,7 &lt; at &gt;&lt; at &gt; function screen.getbycoord(x, y, default) end --- Give the focus to a screen, and move pointer. Keeps relative position of the pointer on the screen. --- &lt; at &gt;param screen Screen number. +-- &lt; at &gt;param _screen Screen number. function screen.focus(_screen) client = client or require("awful.client") if _screen &gt; capi.screen.count() then _screen = capi.mouse.screen end diff --git a/lib/awful/tag.lua.in b/lib/awful/tag.lua.in index c2cd1d3..040f556 100644 --- a/lib/awful/tag.lua.in +++ b/lib/awful/tag.lua.in &lt; at &gt;&lt; at &gt; -389,7 +389,7 &lt; at &gt;&lt; at &gt; function tag.incncol(add, t) end --- View no tag. --- &lt; at &gt;param Optional screen number. +-- &lt; at &gt;param screen Optional screen number. function tag.viewnone(screen) local tags = tag.gettags(screen or capi.mouse.screen) for i, t in pairs(tags) do &lt; at &gt;&lt; at &gt; -479,14 +479,14 &lt; at &gt;&lt; at &gt; function tag.viewmore(tags, screen) end --- Toggle selection of a tag --- &lt; at &gt;param tag Tag to be toggled +-- &lt; at &gt;param t Tag to be toggled function tag.viewtoggle(t) t.selected = not t.selected capi.screen[tag.getscreen(t)]:emit_signal("tag::history::update") end --- Get tag data table. --- &lt; at &gt;param tag The Tag. +-- &lt; at &gt;param _tag The Tag. -- &lt; at &gt;return The data table. function tag.getdata(_tag) return data.tags[_tag] diff --git a/lib/awful/tooltip.lua.in b/lib/awful/tooltip.lua.in index 2edc17f..3473875 100644 --- a/lib/awful/tooltip.lua.in +++ b/lib/awful/tooltip.lua.in &lt; at &gt;&lt; at &gt; -15,38 +15,35 &lt; at &gt;&lt; at &gt; local setmetatable = setmetatable local ipairs = ipairs --- Tooltip module for awesome objects. --- A tooltip is a small hint displayed when the mouse cursor --- hovers a specific item. --- In awesome, a tooltip can be linked with almost any --- object having a &lt;code&gt;connect_signal()&lt;/code&gt; method and receiving --- &lt;code&gt;mouse::enter&lt;/code&gt; and &lt;code&gt;mouse::leave&lt;/code&gt; signals. --- &lt;p&gt;How to create a tooltip?&lt;br/&gt; --- &lt;code&gt; --- myclock = awful.widget.textclock({}, "%T", 1)&lt;br/&gt; --- myclock_t = awful.tooltip({&lt;br/&gt; --- objects = { myclock },&lt;br/&gt; --- timer_function = function()&lt;br/&gt; --- return os.date("Today is %A %B %d %Y\nThe time is %T")&lt;br/&gt; --- end,&lt;br/&gt; --- })&lt;br/&gt; --- &lt;/code&gt; --- &lt;/p&gt; --- &lt;p&gt;How to add the same tooltip to several objects?&lt;br/&gt; --- &lt;code&gt; --- myclock_t:add_to_object(obj1)&lt;br/&gt; --- myclock_t:add_to_object(obj2)&lt;br/&gt; --- &lt;/code&gt; --- Now the same tooltip is attached to &lt;code&gt;myclock&lt;/code&gt;, &lt;code&gt;obj1&lt;/code&gt;, --- &lt;code&gt;obj2&lt;/code&gt;.&lt;br/&gt; --- &lt;/p&gt; --- &lt;p&gt;How to remove tooltip from many objects?&lt;br/&gt; --- &lt;code&gt; --- myclock_t:remove_from_object(obj1)&lt;br/&gt; --- myclock_t:remove_from_object(obj2)&lt;br/&gt; --- &lt;/code&gt; --- Now the same tooltip is only attached to &lt;code&gt;myclock&lt;/code&gt;.&lt;br/&gt; --- &lt;/p&gt; --- awful.tooltip +-- A tooltip is a small hint displayed when the mouse cursor hovers a specific item. +-- In awesome, a tooltip can be linked with almost any object having a +-- `connect_signal()` method and receiving `mouse::enter` and `mouse::leave` +-- signals. +-- +-- * How to create a tooltip? +-- +-- myclock = awful.widget.textclock({}, "%T", 1) +-- myclock_t = awful.tooltip({ +-- objects = { myclock }, +-- timer_function = function() +-- return os.date("Today is %A %B %d %Y\nThe time is %T") +-- end, +-- }) +-- +-- * How to add the same tooltip to several objects? +-- +-- myclock_t:add_to_object(obj1) +-- myclock_t:add_to_object(obj2) +-- +-- Now the same tooltip is attached to `myclock`, `obj1`, `obj2`. +-- +-- * How to remove tooltip from many objects? +-- +-- myclock_t:remove_from_object(obj1) +-- myclock_t:remove_from_object(obj2) +-- +-- Now the same tooltip is only attached to `myclock`. +-- local tooltip = { mt = {} } local data = setmetatable({}, { __mode = 'k' }) &lt; at &gt;&lt; at &gt; -163,7 +160,7 &lt; at &gt;&lt; at &gt; end --- Create a new tooltip and link it to a widget. --- &lt; at &gt;param args Arguments for tooltip creation may containt:&lt;br/&gt; +-- &lt; at &gt;param args Arguments for tooltip creation may containt: -- &lt;code&gt;timeout&lt;/code&gt;: The timeout value for update_func.&lt;br/&gt; -- &lt;code&gt;timer_function&lt;/code&gt;: A function to dynamically change the tooltip -- text.&lt;br/&gt; &lt; at &gt;&lt; at &gt; -229,4 +226,4 &lt; at &gt;&lt; at &gt; end return setmetatable(tooltip, tooltip.mt) --- vim: ft=lua:et:sw=4:ts=4:sts=4:enc=utf-8:tw=78 +-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80 diff --git a/lib/awful/util.lua.in b/lib/awful/util.lua.in index ff94e0e..96524cb 100644 --- a/lib/awful/util.lua.in +++ b/lib/awful/util.lua.in &lt; at &gt;&lt; at &gt; -157,7 +157,7 &lt; at &gt;&lt; at &gt; function util.restart() end --- Get the user's config or cache dir. --- It first checks XDG_CONFIG_HOME / XDG_CACHE_HOME, but then goes with the +-- It first checks `XDG_CONFIG_HOME` / `XDG_CACHE_HOME`, but then goes with the -- default paths. -- &lt; at &gt;param d The directory to get (either "config" or "cache"). -- &lt; at &gt;return A string containing the requested path. &lt; at &gt;&lt; at &gt; -183,7 +183,7 &lt; at &gt;&lt; at &gt; end -- &lt; at &gt;param exts Table of image extensions allowed, otherwise { 'png', gif' } -- &lt; at &gt;param dirs Table of dirs to search, otherwise { '/usr/share/pixmaps/' } -- &lt; at &gt;param size Optional size. If this is specified, subdirectories &lt;size&gt;x&lt;size&gt; --- of the dirs are searched first +-- of the dirs are searched first function util.geticonpath(iconname, exts, dirs, size) exts = exts or { 'png', 'gif' } dirs = dirs or { '/usr/share/pixmaps/' } diff --git a/lib/awful/wibox.lua.in b/lib/awful/wibox.lua.in index 1e35944..f48ece3 100644 --- a/lib/awful/wibox.lua.in +++ b/lib/awful/wibox.lua.in &lt; at &gt;&lt; at &gt; -204,7 +204,7 &lt; at &gt;&lt; at &gt; end --- Create a new wibox and attach it to a screen edge. -- &lt; at &gt;see wibox --- &lt; at &gt;param args A table with standard arguments to wibox() creator. +-- &lt; at &gt;param arg A table with standard arguments to wibox() creator. -- You can add also position key with value top, bottom, left or right. -- You can also use width or height in % and set align to center, right or left. -- You can also set the screen key with a screen number to attach the wibox. diff --git a/lib/awful/widget/button.lua.in b/lib/awful/widget/button.lua.in index 0f0d758..1dca02e 100644 --- a/lib/awful/widget/button.lua.in +++ b/lib/awful/widget/button.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,6 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- A button widget for awful +-- -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;copyright 2008-2009 Julien Danjou -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; &lt; at &gt;&lt; at &gt; -13,7 +15,6 &lt; at &gt;&lt; at &gt; local surface = require("gears.surface") local cairo = require("lgi").cairo local capi = { mouse = mouse } --- awful.widget.button local button = { mt = {} } --- Create a button widget. When clicked, the image is deplaced to make it like diff --git a/lib/awful/widget/common.lua.in b/lib/awful/widget/common.lua.in index a555268..3fa011d 100644 --- a/lib/awful/widget/common.lua.in +++ b/lib/awful/widget/common.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,6 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- Common utilities for awful widgets +-- -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;copyright 2008-2009 Julien Danjou -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; &lt; at &gt;&lt; at &gt; -17,7 +19,6 &lt; at &gt;&lt; at &gt; local wibox = require("wibox") local imagebox = require("wibox.widget.imagebox") local textbox = require("wibox.widget.textbox") ---- Common utilities for awful widgets local common = {} function common.create_buttons(buttons, object) diff --git a/lib/awful/widget/graph.lua.in b/lib/awful/widget/graph.lua.in index 4c14e1e..0310806 100644 --- a/lib/awful/widget/graph.lua.in +++ b/lib/awful/widget/graph.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,6 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- A graph widget. +-- -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;copyright 2009 Julien Danjou -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; &lt; at &gt;&lt; at &gt; -12,8 +14,6 &lt; at &gt;&lt; at &gt; local type = type local color = require("gears.color") local base = require("wibox.widget.base") ---- A graph widget. --- awful.widget.graph local graph = { mt = {} } local data = setmetatable({}, { __mode = "k" }) &lt; at &gt;&lt; at &gt; -209,7 +209,6 &lt; at &gt;&lt; at &gt; function graph:set_height(height) end --- Set the graph width. --- &lt; at &gt;param graph The graph. -- &lt; at &gt;param width The width to set. function graph:set_width(width) if width &gt;= 5 then diff --git a/lib/awful/widget/init.lua.in b/lib/awful/widget/init.lua.in index c414d13..95053cc 100644 --- a/lib/awful/widget/init.lua.in +++ b/lib/awful/widget/init.lua.in &lt; at &gt;&lt; at &gt; -1,12 +1,11 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- Widget library for awful +-- -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;copyright 2008-2009 Julien Danjou -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; --------------------------------------------------------------------------- ---- Widget module for awful --- awful.widget - return { taglist = require("awful.widget.taglist"); diff --git a/lib/awful/widget/launcher.lua.in b/lib/awful/widget/launcher.lua.in index aff7ff9..f6cd578 100644 --- a/lib/awful/widget/launcher.lua.in +++ b/lib/awful/widget/launcher.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,6 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- A launcher widget +-- -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;copyright 2008-2009 Julien Danjou -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; &lt; at &gt;&lt; at &gt; -9,7 +11,6 &lt; at &gt;&lt; at &gt; local util = require("awful.util") local wbutton = require("awful.widget.button") local button = require("awful.button") --- awful.widget.launcher local launcher = { mt = {} } --- Create a button widget which will launch a command. diff --git a/lib/awful/widget/layoutbox.lua.in b/lib/awful/widget/layoutbox.lua.in index f332b8d..eb8f477 100644 --- a/lib/awful/widget/layoutbox.lua.in +++ b/lib/awful/widget/layoutbox.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,6 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- Layoutbox widget. +-- -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;copyright 2009 Julien Danjou -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; &lt; at &gt;&lt; at &gt; -12,8 +14,6 &lt; at &gt;&lt; at &gt; local tag = require("awful.tag") local beautiful = require("beautiful") local imagebox = require("wibox.widget.imagebox") ---- Layoutbox widget. --- awful.widget.layoutbox local layoutbox = { mt = {} } local function update(w, screen) diff --git a/lib/awful/widget/progressbar.lua.in b/lib/awful/widget/progressbar.lua.in index b8c906d..96bcf69 100644 --- a/lib/awful/widget/progressbar.lua.in +++ b/lib/awful/widget/progressbar.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,6 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- A progressbar widget. +-- -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;copyright 2009 Julien Danjou -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; &lt; at &gt;&lt; at &gt; -10,8 +12,6 &lt; at &gt;&lt; at &gt; local math = math local base = require("wibox.widget.base") local color = require("gears.color") ---- A progressbar widget. --- awful.widget.progressbar local progressbar = { mt = {} } local data = setmetatable({}, { __mode = "k" }) diff --git a/lib/awful/widget/prompt.lua.in b/lib/awful/widget/prompt.lua.in index f058828..fc9d456 100644 --- a/lib/awful/widget/prompt.lua.in +++ b/lib/awful/widget/prompt.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,6 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- A promptbox widget for awful +-- -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;copyright 2009 Julien Danjou -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; &lt; at &gt;&lt; at &gt; -13,7 +15,6 &lt; at &gt;&lt; at &gt; local widget_base = require("wibox.widget.base") local textbox = require("wibox.widget.textbox") local type = type --- awful.widget.prompt local widgetprompt = { mt = {} } --- Run method for promptbox. diff --git a/lib/awful/widget/taglist.lua.in b/lib/awful/widget/taglist.lua.in index 9f84df8..60d9610 100644 --- a/lib/awful/widget/taglist.lua.in +++ b/lib/awful/widget/taglist.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,6 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- Taglist widget module for awful +-- -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;copyright 2008-2009 Julien Danjou -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; &lt; at &gt;&lt; at &gt; -20,8 +22,6 &lt; at &gt;&lt; at &gt; local beautiful = require("beautiful") local fixed = require("wibox.layout.fixed") local surface = require("gears.surface") ---- Taglist widget module for awful --- awful.widget.taglist local taglist = { mt = {} } taglist.filter = {} &lt; at &gt;&lt; at &gt; -133,30 +133,33 &lt; at &gt;&lt; at &gt; function taglist.gettag(widget) return common.tagwidgets[widget] end ---- Create a new taglist widget. The last two arguments (update_function --- and base_widget) serve to customize the layout of the taglist (eg. to +--- Create a new taglist widget. The last two arguments (`update_function` +-- and `base_widget`) serve to customize the layout of the taglist (eg. to -- make it vertical). For that, you will need to copy the --- awful.widget.common.list_update function, make your changes to it +-- `awful.widget.common.list_update` function, make your changes to it -- and pass it as update_function here. Also change the base_widget if the -- default is not what you want. --- &lt; at &gt;param screen The screen to draw taglist for. --- &lt; at &gt;param filter Filter function to define what clients will be listed. --- &lt; at &gt;param buttons A table with buttons binding to set. --- &lt; at &gt;param style The style overrides default theme. --- &lt; at &gt;param update_function Optional function to create a tag widget on each --- update. &lt; at &gt;see awful.widget.common. --- &lt; at &gt;param base_widget Optional container widget for tag widgets. Default --- is wibox.layout.fixed.horizontal(). --- bg_focus The background color for focused client. --- fg_focus The foreground color for focused client. --- bg_urgent The background color for urgent clients. --- fg_urgent The foreground color for urgent clients. --- squares_sel Optional: a user provided image for selected squares. --- squares_unsel Optional: a user provided image for unselected squares. --- squares_sel_empty Optional: a user provided image for selected squares for empty tags. --- squares_unsel_empty Optional: a user provided image for unselected squares for empty tags. --- squares_resize Optional: true or false to resize squares. --- font The font. +-- +-- &lt; at &gt;tparam int screen The screen to draw taglist for. +-- &lt; at &gt;tparam function filter Filter function to define what clients will be +-- listed. +-- &lt; at &gt;tparam table buttons A table with buttons binding to set. +-- &lt; at &gt;tparam table style The style overrides default theme. +-- &lt; at &gt;tparam function update_function Optional function to create a tag widget on +-- each update. &lt; at &gt;see awful.widget.common. +-- &lt; at &gt;tparam widget base_widget Optional container widget for tag widgets. Default is +-- wibox.layout.fixed.horizontal(). +-- +-- &lt; at &gt;param style.bg_focus The background color for focused client. +-- &lt; at &gt;param style.fg_focus The foreground color for focused client. +-- &lt; at &gt;param style.bg_urgent The background color for urgent clients. +-- &lt; at &gt;param style.fg_urgent The foreground color for urgent clients. +-- &lt; at &gt;param style.squares_sel Optional: a user provided image for selected squares. +-- &lt; at &gt;param style.squares_unsel Optional: a user provided image for unselected squares. +-- &lt; at &gt;param style.squares_sel_empty Optional: a user provided image for selected squares for empty tags. +-- &lt; at &gt;param style.squares_unsel_empty Optional: a user provided image for unselected squares for empty tags. +-- &lt; at &gt;param style.squares_resize Optional: true or false to resize squares. +-- &lt; at &gt;param style.font The font. function taglist.new(screen, filter, buttons, style, update_function, base_widget) local uf = update_function or common.list_update local w = base_widget or fixed.horizontal() diff --git a/lib/awful/widget/tasklist.lua.in b/lib/awful/widget/tasklist.lua.in index a843b72..20799ea 100644 --- a/lib/awful/widget/tasklist.lua.in +++ b/lib/awful/widget/tasklist.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,6 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- Tasklist widget module for awful +-- -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;copyright 2008-2009 Julien Danjou -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; &lt; at &gt;&lt; at &gt; -17,8 +19,6 &lt; at &gt;&lt; at &gt; local util = require("awful.util") local tag = require("awful.tag") local flex = require("wibox.layout.flex") ---- Tasklist widget module for awful --- awful.widget.tasklist local tasklist = { mt = {} } -- Public structures &lt; at &gt;&lt; at &gt; -106,33 +106,35 &lt; at &gt;&lt; at &gt; local function tasklist_update(s, w, buttons, filter, data, style, update_functi update_function(w, buttons, label, data, clients) end ---- Create a new tasklist widget. The last two arguments (update_function --- and base_widget) serve to customize the layout of the tasklist (eg. to --- make it vertical). For that, you will need to copy the --- awful.widget.common.list_update function, make your changes to it --- and pass it as update_function here. Also change the base_widget if the +--- Create a new tasklist widget. The last two arguments (`update_function` and +-- `base_widget`) serve to customize the layout of the tasklist (eg. to make it +-- vertical). For that, you will need to copy the +-- `awful.widget.common.list_update` function, make your changes to it +-- and pass it as `update_function` here. Also change the base_widget if the -- default is not what you want. --- &lt; at &gt;param screen The screen to draw tasklist for. --- &lt; at &gt;param filter Filter function to define what clients will be listed. --- &lt; at &gt;param buttons A table with buttons binding to set. --- &lt; at &gt;param style The style overrides default theme. --- &lt; at &gt;param update_function Optional function to create a tag widget on each --- update. &lt; at &gt;see awful.widget.common. --- &lt; at &gt;param base_widget Optional container widget for tag widgets. Default --- is wibox.layout.flex.horizontal(). --- bg_normal The background color for unfocused client. --- fg_normal The foreground color for unfocused client. --- bg_focus The background color for focused client. --- fg_focus The foreground color for focused client. --- bg_urgent The background color for urgent clients. --- fg_urgent The foreground color for urgent clients. --- bg_minimize The background color for minimized clients. --- fg_minimize The foreground color for minimized clients. --- floating Symbol to use for floating clients. --- ontop Symbol to use for ontop clients. --- maximized_horizontal Symbol to use for clients that have been horizontally maximized. --- maximized_vertical Symbol to use for clients that have been vertically maximized. --- font The font. +-- +-- &lt; at &gt;tparam int screen The screen to draw tasklist for. +-- &lt; at &gt;tparam function filter Filter function to define what clients will be listed. +-- &lt; at &gt;tparam table buttons A table with buttons binding to set. +-- &lt; at &gt;tparam table style The style overrides default theme. +-- &lt; at &gt;tparam function update_function Optional function to create a tag widget on each +-- update. &lt; at &gt;see awful.widget.common. +-- &lt; at &gt;tparam widget base_widget Optional container widget for tag widgets. Default +-- is wibox.layout.flex.horizontal(). +-- +-- &lt; at &gt;param style.bg_normal The background color for unfocused client. +-- &lt; at &gt;param style.fg_normal The foreground color for unfocused client. +-- &lt; at &gt;param style.bg_focus The background color for focused client. +-- &lt; at &gt;param style.fg_focus The foreground color for focused client. +-- &lt; at &gt;param style.bg_urgent The background color for urgent clients. +-- &lt; at &gt;param style.fg_urgent The foreground color for urgent clients. +-- &lt; at &gt;param style.bg_minimize The background color for minimized clients. +-- &lt; at &gt;param style.fg_minimize The foreground color for minimized clients. +-- &lt; at &gt;param style.floating Symbol to use for floating clients. +-- &lt; at &gt;param style.ontop Symbol to use for ontop clients. +-- &lt; at &gt;param style.maximized_horizontal Symbol to use for clients that have been horizontally maximized. +-- &lt; at &gt;param style.maximized_vertical Symbol to use for clients that have been vertically maximized. +-- &lt; at &gt;param style.font The font. function tasklist.new(screen, filter, buttons, style, update_function, base_widget) local uf = update_function or common.list_update local w = base_widget or flex.horizontal() diff --git a/lib/awful/widget/textclock.lua.in b/lib/awful/widget/textclock.lua.in index df04f4d..78dcbb8 100644 --- a/lib/awful/widget/textclock.lua.in +++ b/lib/awful/widget/textclock.lua.in &lt; at &gt;&lt; at &gt; -1,4 +1,6 &lt; at &gt;&lt; at &gt; --------------------------------------------------------------------------- +--- Text clock widget. +-- -- &lt; at &gt;author Julien Danjou &amp;lt;julien&lt; at &gt;danjou.info&amp;gt; -- &lt; at &gt;copyright 2009 Julien Danjou -- &lt; at &gt;release &lt; at &gt;AWESOME_VERSION&lt; at &gt; &lt; at &gt;&lt; at &gt; -9,13 +11,11 &lt; at &gt;&lt; at &gt; local os = os local textbox = require("wibox.widget.textbox") local capi = { timer = timer } ---- Text clock widget. --- awful.widget.textclock local textclock = { mt = {} } --- Create a textclock widget. It draws the time it is in a textbox. --- &lt; at &gt;param format The time format. Default is " %a %b %d, %H:%M ". --- &lt; at &gt;param timeout How often update the time. Default is 60. +-- &lt; at &gt;param format The time format. Default is `" %a %b %d, %H:%M "`. +-- &lt; at &gt;param timeout How often update the time. Default is `60`. -- &lt; at &gt;return A textbox widget. function textclock.new(format, timeout) local format = format or " %a %b %d, %H:%M " </pre> Ignas Anikevicius (gns_ank 2013-06-02T21:33:55 http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/8352 <pre>This is one of the first of many changes to documentation. We first start with the core modules. Signed-off-by: Ignas Anikevicius (gns_ank) &lt;anikevicius&lt; at &gt;gmail.com&gt; --- luadoc/client.lua | 6 +++--- luadoc/keygrabber.lua | 29 ++++++++++++++--------------- 2 files changed, 17 insertions(+), 18 deletions(-) diff --git a/luadoc/client.lua b/luadoc/client.lua index 4aa4bfb..36f977c 100644 --- a/luadoc/client.lua +++ b/luadoc/client.lua &lt; at &gt;&lt; at &gt; -26,7 +26,7 &lt; at &gt;&lt; at &gt; module("client") -- &lt; at &gt;field urgent The client urgent state. -- &lt; at &gt;field content An image representing the client window content (screenshot). -- &lt; at &gt;field focus The focused client. --- &lt; at &gt;field opacity The client opacity between 0 and 1. +-- &lt; at &gt;field opacity The client opacity between `0` and `1`. -- &lt; at &gt;field ontop The client is on top of every other windows. -- &lt; at &gt;field above The client is above normal windows. -- &lt; at &gt;field below The client is below normal windows. &lt; at &gt;&lt; at &gt; -36,8 +36,8 &lt; at &gt;&lt; at &gt; module("client") -- &lt; at &gt;field transient_for The client the window is transient for. -- &lt; at &gt;field group_window Window identification unique to a group of windows. -- &lt; at &gt;field leader_id Identification unique to windows spawned by the same command. --- &lt; at &gt;field size_hints A table with size hints of the client: user_position, --- user_size, program_position, program_size, etc. +-- &lt; at &gt;field size_hints A table with size hints of the client: `user_position`, +-- `user_size`, `program_position`, `program_size`, etc. -- &lt; at &gt;field sticky Set the client sticky, i.e. available on all tags. -- &lt; at &gt;field modal Indicate if the client is modal. -- &lt; at &gt;field focusable True if the client can receive the input focus. diff --git a/luadoc/keygrabber.lua b/luadoc/keygrabber.lua index 4e2e8ba..fb5f01b 100644 --- a/luadoc/keygrabber.lua +++ b/luadoc/keygrabber.lua &lt; at &gt;&lt; at &gt; -12,23 +12,22 &lt; at &gt;&lt; at &gt; module("keygrabber") -- &lt; at &gt;param callback A callback function as described above. -- &lt; at &gt;name run -- &lt; at &gt;class function --- &lt; at &gt;usage Following function can be bound to a key, and used to resize a client --- using keyboard. --- &lt;p&gt;&lt;code&gt; --- function resize(c) &lt;br/&gt; --- keygrabber.run(function(mod, key, event) &lt;/br&gt; --- if event == "release" then return end &lt;/br&gt;&lt;/br&gt; +-- &lt; at &gt;usage +-- -- Following function can be bound to a key, and used to resize a client +-- -- using keyboard. +-- function resize(c) +-- keygrabber.run(function(mod, key, event) +-- if event == "release" then return end -- --- if key == 'Up' then awful.client.moveresize(0, 0, 0, 5, c) &lt;br/&gt; --- elseif key == 'Down' then awful.client.moveresize(0, 0, 0, -5, c) &lt;br/&gt; --- elseif key == 'Right' then awful.client.moveresize(0, 0, 5, 0, c) &lt;br/&gt; --- elseif key == 'Left' then awful.client.moveresize(0, 0, -5, 0, c) &lt;br/&gt; --- else keygrabber.stop() &lt;br/&gt; --- end &lt;br/&gt;&lt;br/&gt; +-- if key == 'Up' then awful.client.moveresize(0, 0, 0, 5, c) +-- elseif key == 'Down' then awful.client.moveresize(0, 0, 0, -5, c) +-- elseif key == 'Right' then awful.client.moveresize(0, 0, 5, 0, c) +-- elseif key == 'Left' then awful.client.moveresize(0, 0, -5, 0, c) +-- else keygrabber.stop() +-- end -- --- end) &lt;br/&gt; --- end &lt;br/&gt; --- &lt;/code&gt;&lt;/p&gt; +-- end) +-- end --- Stop grabbing the keyboard. -- &lt; at &gt;name stop </pre> Ignas Anikevicius (gns_ank 2013-06-02T21:31:05 http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/8351 <pre>Enable Markdown and write some exception rules, so that we do not have empty documentation pages about modules which nobody wants to read about (like awful.dbus). Signed-off-by: Ignas Anikevicius (gns_ank) &lt;anikevicius&lt; at &gt;gmail.com&gt; --- config.ld.in | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/config.ld.in b/config.ld.in index a29b834..a70735e 100644 --- a/config.ld.in +++ b/config.ld.in &lt; at &gt;&lt; at &gt; -2,6 +2,25 &lt; at &gt;&lt; at &gt; project='awesome' title='awesome API documentation' description='highly configurable X window manager' ---format='markdown' or should it be discount? what is that anyway? how about plain? +-- use markdown.lua bundled together with ldoc. +-- More on it: https://github.com/stevedonovan/LDoc/blob/master/doc/doc.md#markdown-support +format='markdown' dir='doc' -file={ 'lib/', '&lt; at &gt;SOURCE_DIR&lt; at &gt;/luadoc' } +file={ + -- File to include + 'lib/', 'luadoc/', + -- Exclude some specific files or directories + exclude = { + 'lib/awful/init.lua', + 'lib/awful/dbus.lua', + 'lib/awful/ewmh.lua', + 'lib/awful/autofocus.lua', + 'lib/awful/widget/init.lua', + 'lib/awful/widget/common.lua', + 'lib/wibox/layout/init.lua', + 'lib/wibox/widget/init.lua', + 'lib/gears/init.lua', + } +} + +-- vim: filetype=lua </pre> Ignas Anikevicius (gns_ank 2013-06-02T21:30:27 http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/8350 <pre>Hello list, Since my exams have finished, I could work a bit on my favorite window manager. I wanted to improve the documentation a bit and here it goes. I wanted to make use of Markdown as HTML documentation in source doesn't look too elegant, at least in my opinion. Also, we already are using LDoc for our documentation and it comes as with a markdown parser. It has one bug which doesn't let me use it, but the change is really trivial and you can look at it on LDoc bugtracker #68. So, please let me know what you think about my changes to awesome. Main things which I have done are: * Fix the &lt; at &gt;param tags, and add types in some places. * Correct the usage of tables in documentation. * Markdown usage instead of HTML. * Some other random fixes. * Do not include files in the final index.html which do not have any descriptions. This is currently done manually. and maybe something else, which I forgot to mention. Let me know, what you think. Ignas. PS. My github awesome repo: https://github.com/gns-ank/awesome.git There you can pull everything to your repo, if you want. </pre> Ignas Anikevicius (gns_ank 2013-06-02T21:27:59 http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/8334 <pre>As threatened on IRC, here's a bunch of patches to 2.3. I didn't yet get around to adding a systray widget, but that will come. Most of the patches are fairly self explanatory, I guess, but as always, suggestions and questions are welcome :) </pre> Gregor Best 2013-05-21T17:26:53 http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/8264 <pre>Since only the body text of a notification may contain markup, by combining the two together and calling set_markup(), the title would also get interpreted as if it had markup. This could be seen with: $ notify-send "Title &amp; text" "&lt;i&gt;body text&lt;/i&gt;" The unescaped &amp; would get interpreted as broken markup and so naughty would fall back to escaping everything which would make the "&lt;i&gt;" tags be shown rather than interpreted. So, the title must always be escaped so that it is not interpreted as markup. Signed-off-by: Ross Lagerwall &lt;rosslagerwall&lt; at &gt;gmail.com&gt; --- lib/naughty.lua.in | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/lib/naughty.lua.in b/lib/naughty.lua.in index cf015c2..228ff17 100644 --- a/lib/naughty.lua.in +++ b/lib/naughty.lua.in &lt; at &gt;&lt; at &gt; -303,6 +303,8 &lt; at &gt;&lt; at &gt; function naughty.notify(args) local margin = args.margin or preset.margin local border_width = args.border_width or preset.border_width local position = args.position or preset.position + local escape_pattern = "[&lt;&gt;&amp;]" + local escape_subs = { ['&lt;'] = "&amp;lt;", ['&gt;'] = "&amp;gt;", ['&amp;'] = "&amp;amp;" } -- beautiful local beautiful = bt.get() &lt; at &gt;&lt; at &gt; -376,17 +378,20 &lt; at &gt;&lt; at &gt; function naughty.notify(args) textbox:set_font(font) local function setMarkup(pattern, replacements) - textbox:set_markup(string.format('&lt;b&gt;%s&lt;/b&gt;%s', title:gsub(pattern, replacements), text:gsub(pattern, replacements))) + textbox:set_markup(string.format('&lt;b&gt;%s&lt;/b&gt;%s', title, text:gsub(pattern, replacements))) end local function setText() textbox:set_text(string.format('%s %s', title, text)) end - -- First try to set the text while only interpreting &lt;br&gt;. + -- Since the title cannot contain markup, it must be escaped first so that + -- it is not interpreted by Pango later. + title = title:gsub(escape_pattern, escape_subs) + -- Try to set the text while only interpreting &lt;br&gt;. -- (Setting a textbox' .text to an invalid pattern throws a lua error) if not pcall(setMarkup, "&lt;br.-&gt;", "\n") then -- That failed, escape everything which might cause an error from pango - if not pcall(setMarkup, "[&lt;&gt;&amp;]", { ['&lt;'] = "&amp;lt;", ['&gt;'] = "&amp;gt;", ['&amp;'] = "&amp;amp;" }) then + if not pcall(setMarkup, escape_pattern, escape_subs) then -- Ok, just ignore all pango markup. If this fails, we got some invalid utf8 if not pcall(setText) then textbox:set_markup("&lt;i&gt;&amp;lt;Invalid markup or UTF8, cannot display message&amp;gt;&lt;/i&gt;") </pre> Ross Lagerwall 2013-03-26T08:16:58 http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/8211 <pre>Hey all, had a look at https://awesome.naquadah.org/bugs/index.php?do=details&amp;task_id=1112 (performance issues with converting an ARGB image to BGRA for Cairo) with psychon. Sort of toyed around with it and he tells me this makes it run rather quickly. See attached :&gt; </pre> Majic 2013-03-17T13:11:31 http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/8119 <pre>I created a button that toggles DPMS (monitor power control) and displays whether it's on or off: local function is_dpms_on() local ison local file = io.popen('xset q', 'r') for line in file:lines() do if line:match('DPMS is Disabled') then ison = false; break elseif line:match('DPMS is Enabled') then ison = true; break end end file:close() return ison end local power_images = {on=image('img/gtk-yes.png'), off=image('img/gtk-no.png')} local monitor_power_button = awful.widget.button { image = is_dpms_on() and power_images.on or power_images.off, } monitor_power_button:buttons(awful.button({}, 1, function() if is_dpms_on() then os.execute('xset -dpms') monitor_power_button.image = power_images.off else os.execute('xset +dpms') monitor_power_button.image = power_images.on end end)) The button is then added to a wibox on the screen. This works fine, except for one issue: when I click the button, the image changes as expected, but as soon as the mouse moves, it changes back to what it was originally. Is there something I need to do to make the new image stick? </pre> Rena 2013-02-23T12:02:00 http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/8118 <pre>Something that's bugged me for a while is that awful.widget.taglist is always left-aligned. I wanted mine right-aligned, so I made a simple patch to awesome/lib/awful/widget/taglist.lua: 50c50 &lt; function new(screen, label, buttons) --- 52c52 &lt; layout = layout.horizontal.leftright --- That allows to specify a layout when creating the taglist. If you create a right-aligned list, the tags appear in reverse order, so maybe it could be improved. BTW, on https://awesome.naquadah.org/wiki/FAQ#Do_you_accept_patches_and_enhancements.3F, the "development page" link is broken. Apologies if this isn't the best way to submit/create this patch. </pre> Rena 2013-02-22T22:35:36 http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/8107 <pre>Hoy! I have a setup where I prefer to have a single wibox holding the layoutbox and taglist for each screen. Basically have all the widgets on a single wibox on screen #1. Like so: http://auditty.org/images/screenies/2013-02-19_03%3a48%3a01_2730x1680_screenie.png The problem is when I would click on the layoutbox for screen #2 to change its layout -- this winds up changing the layout of screen #1, the screen the layoutbox appears on. This is because it calls awful.tag.selected() with no parameters, assuming the focused screen, and subsequently awful.layout.get() and awful.layout.set(). My patch extends awful.layout.inc() to accept a 3rd parameter allowing you to specify a target screen to cycle the layout on. You can also see how I modified my rc.lua to take advantage of this modification in my screenshot. I hope I conformed to the style guidelines well enough ^__^ Tah! </pre> Majic 2013-02-19T04:07:41 http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/8088 <pre>And now in 'plain-text' mode. Hope that will look better. This patch adds a "top_center" position for naughty notifications: diff --git a/lib/naughty.lua.in b/lib/naughty.lua.in index 1f089bb..4cf2dce 100644 --- a/lib/naughty.lua.in +++ b/lib/naughty.lua.in &lt; at &gt;&lt; at &gt; -120,6 +120,7 &lt; at &gt;&lt; at &gt; for s = 1, capi.screen.count() do naughty.notifications[s] = { top_left = {}, top_right = {}, + top_center = {}, bottom_left = {}, bottom_right = {}, } &lt; at &gt;&lt; at &gt; -151,7 +152,7 &lt; at &gt;&lt; at &gt; end -- Evaluate desired position of the notification by index - internal -- &lt; at &gt;param idx Index of the notification --- &lt; at &gt;param position top_right | top_left | bottom_right | bottom_left +-- &lt; at &gt;param position top_right | top_left | top_center | bottom_right | bottom_left -- &lt; at &gt;param height Popup height -- &lt; at &gt;param width Popup width (optional) -- &lt; at &gt;return Absolute position and index in { x = X, y = Y, idx = I } table &lt; at &gt;&lt; at &gt; -164,6 +165,8 &lt; at &gt;&lt; at &gt; local function get_offset(screen, position, idx, width, height) -- calculate x if position:match("left") then v.x = ws.x + naughty.config.padding + elseif position:match("center") then + v.x = ws.x + ( ws.width - (width + config.padding) ) / 2 else v.x = ws.x + ws.width - (width + naughty.config.padding) end &lt; at &gt;&lt; at &gt; -253,7 +256,7 &lt; at &gt;&lt; at &gt; end -- Default: nil -- &lt; at &gt;param screen Target screen for the notification. Default: 1 -- &lt; at &gt;param position Corner of the workarea displaying the popups. --- Values: "top_right" (default), "top_left", "bottom_left", "bottom_right". +-- Values: "top_right" (default), "top_left", "top_center", "bottom_left", "bottom_right". -- &lt; at &gt;param ontop Boolean forcing popups to display on top. Default: true -- &lt; at &gt;param height Popup height. Default: nil (auto) -- &lt; at &gt;param width Popup width. Default: nil (auto) </pre> David Lesaffre 2013-02-11T16:50:26 http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/8087 <pre>We needed this for an internal project. Maybe there is a more general interest. Posting this for the x'th time. This time to the correct list. I hope. This patch adds a "top_center" position for naughty notifications: diff --git a/lib/naughty.lua.in b/lib/naughty.lua.in index 1f089bb..4cf2dce 100644 --- a/lib/naughty.lua.in +++ b/lib/naughty.lua.in &lt; at &gt;&lt; at &gt; -120,6 +120,7 &lt; at &gt;&lt; at &gt; for s = 1, capi.screen.count() do naughty.notifications[s] = { top_left = {}, top_right = {}, + top_center = {}, bottom_left = {}, bottom_right = {}, } &lt; at &gt;&lt; at &gt; -151,7 +152,7 &lt; at &gt;&lt; at &gt; end -- Evaluate desired position of the notification by index - internal -- &lt; at &gt;param idx Index of the notification --- &lt; at &gt;param position top_right | top_left | bottom_right | bottom_left +-- &lt; at &gt;param position top_right | top_left | top_center | bottom_right | bottom_left -- &lt; at &gt;param height Popup height -- &lt; at &gt;param width Popup width (optional) -- &lt; at &gt;return Absolute position and index in { x = X, y = Y, idx = I } table &lt; at &gt;&lt; at &gt; -164,6 +165,8 &lt; at &gt;&lt; at &gt; local function get_offset(screen, position, idx, width, height) -- calculate x if position:match("left") then v.x = ws.x + naughty.config.padding + elseif position:match("center") then + v.x = ws.x + ( ws.width - (width + config.padding) ) / 2 else v.x = ws.x + ws.width - (width + naughty.config.padding) end &lt; at &gt;&lt; at &gt; -253,7 +256,7 &lt; at &gt;&lt; at &gt; end -- Default: nil -- &lt; at &gt;param screen Target screen for the notification. Default: 1 -- &lt; at &gt;param position Corner of the workarea displaying the popups. --- Values: "top_right" (default), "top_left", "bottom_left", "bottom_right". +-- Values: "top_right" (default), "top_left", "top_center", "bottom_left", "bottom_right". -- &lt; at &gt;param ontop Boolean forcing popups to display on top. Default: true -- &lt; at &gt;param height Popup height. Default: nil (auto) -- &lt; at &gt;param width Popup width. Default: nil (auto) </pre> David Lesaffre 2013-02-11T16:27:41 http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/8076 <pre>-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA256 Good morning, did you ever do something really stupid? Like, writing "this is meant to be the last release of the 3.4 branch" in an announce mail? Well, I did. Of course, the universe couldn't let this slip. So now we have awesome 3.4.15. And again, this is meant to be the last release of the 3.4 branch. Yeah, now I am really asking for it... The "big changes" since 3.4.14 is a single commit which tells Xlib to stop trolling so that it stops messing with our keyboard events. This should fix all the cases of "my keyboard layout broke and now is US-only". Cheers, Uli awesome version 3.4.15 has been released. It is available from: tar.xz: http://awesome.naquadah.org/download/awesome-3.4.15.tar.xz md5: 4e3a14bed1e6a0d424fc79aba03d981e sha1: 54f8201f6aa48ffa47b21b28a5074e1ea1b41e74 tar.bz2: http://awesome.naquadah.org/download/awesome-3.4.15.tar.bz2 md5: 63bbc25691254d04b96c00ba46b9ae59 sha1: d282080bde91dabbece211608c390d5ae826bc2f number of changes - ----------------- 2 number of commiters - ------------------- 1 shortlog - -------- Uli Schlachter (2): Fix keyboard layouts change codename diffstat - -------- awesome.c | 4 ++++ awesomeConfig.cmake | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) - -- - - Buck, when, exactly, did you lose your mind? - - Three months ago. I woke up one morning married to a pineapple. An ugly pineapple... But I loved her. -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.12 (GNU/Linux) iQEcBAEBCAAGBQJRGPr5AAoJECLkKOvLj8sGkCUIAILpinmGD079htaH4Q8zFl0b LZhsh2MgFqLmqGMpo83qVlYG2xGdZTQFWa4a+gvFdkGTKvVb//DEK5lkW1H6WkVd JrfLycSGCwaNa0DmGFVvqZY3g+3MuxznTkJeFvPJ+DwTQVqa7+EcmPaNN0/fLM+D B8wAtPGT2VZU7zvR0+nKK76agGqH8uNjZobxKFBs51Kvk+cG0XK8C4+uzRXuZujQ GtIIbrCaSSadilaI90uW1zpL+1MxraVCsbezg2XrZELdR/9Pazht/8v+Kyd2WG2x EZOUqjXDD4J1MuXvPlGa0IifiV2x/vsJVVf6ybrjOlbpGYH0GQcsKc96DFanshk= =2v0M -----END PGP SIGNATURE----- </pre> Uli Schlachter 2013-02-11T14:06:50 http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/7991 <pre>Hi, there exists a regression in awesome 3.5 (see [1] and maybe [2]): It’s not possible to use sloppy focus to exactly define which window should have the input focus. On fast mouse moves the wrong window is getting the focus. I tried to eliminate the problem and I even found a working solution (at least for me it’s working). It seems to me, that awesome is handling all the focus itself but then there is the focusin-event listener. Probably awesome is switching the focus very fast (because of the sloppy focus and the fast moves). Now xcb fires focusin-events for each of the focus-switches and calls the function client_update_focus(c) where c is the window xcb sends in the event. But this must be the wrong window, because after the mouse move the correct window has the focus and after that there is the focusin-event for the wrong window. So awesome unfocuses the correctly focused window and gives the focus via the client_update_focus(…)-call to the wrong one. When I completely disable the focusin-event handler, everything works as I expect. So far I noticed also no other flaws since using my patched version of awesome. Probably my patch is not ok, but maybe there is someone who can point me in the right direction? There must be something wrong with the ordering of the events or maybe awesome triggers xcb events which it is receiving afterwards at the wrong time? The patch for discussion is in a follow-up. Best regards, Stefan Haller [1] http://thread.gmane.org/gmane.comp.window-managers.awesome/9692 [2] https://awesome.naquadah.org/bugs/index.php?do=details&amp;task_id=1084 </pre> Stefan Haller 2013-01-20T14:50:18 http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/7989 <pre>Hi, this is my first patch for awesome, so I hope I’m doing it right. My problem was, than when I click on a link, Firefox is getting the input focus, which is the right thing. The problem is, that Firefox is usually hidden below other windows, because I’m using the fullscreen layout for a workspace with Thunderbird and Firefox. My suggestion is to raise the window in addition to hand over the focus for EWMH-requests. (If such a behavior is not desired, I suggest adding a signal for EWMH-requests or make this information accessible in the focus-signal.) See patch in follow-up. Best regards, Stefan Haller </pre> Stefan Haller 2013-01-20T14:33:58 http://comments.gmane.org/gmane.comp.window-managers.awesome.devel/7986 <pre>Hi, I'm sending the amended patches. lukash </pre> Lukáš Hrázký 2013-01-20T14:00:27 Search the mailing list at Gmane query http://search.gmane.org/?group=$group=gmane.comp.window-managers.awesome.devel