12 |
18 |
19 |
13 | awesome 4.3
documentation
(stable) 14 | 15 | Docs for latest git version 16 |
17 | documentation
(stable) 14 | 15 | Docs for latest git version 16 |
20 | [[!img images/screen.png link="images/screen.png" alt="awesome screenshot"]]
21 |
22 |
23 |
24 | # Concepts
25 |
26 | A window manager is probably one of the most used software applications in
27 | your day-to-day tasks, along with your web browser, mail reader and text editor.
28 | Power users and programmers have a big range of choice between several tools
29 | for these day-to-day tasks. Some are heavily extensible and configurable.
30 |
31 | **awesome** tries to complete these tools with what we miss: an extensible,
32 | highly configurable window manager.
33 |
34 | To achieve this goal, **awesome** has been designed as a framework window
35 | manager.
36 | It's extremely fast, small, dynamic and heavily extensible using the
37 | [Lua](http://www.lua.org) programming language.
38 |
39 | We provide a documented API to configure and define the behavior of your
40 | window manager.
41 |
42 |
43 | [[!img images/6mon.small.png link="images/6mon.medium.png" alt="awesome running on 6 monitors"]]
44 |
45 |
46 | # Features and non-features
47 |
48 | * Very stable, fast and small codebase and footprint.
49 | * First window manager using the asynchronous [XCB](http://xcb.freedesktop.org)
50 | library instead of the old, synchronous
51 | [Xlib](http://en.wikipedia.org/wiki/Xlib), which makes **awesome** less
52 | subject to latency compared to other window managers.
53 | * Documented source code and API.
54 | * No mouse needed: everything can be performed with the keyboard.
55 | * Real multihead support (XRandR) with per screen desktops (tags).
56 | * Implements many [Freedesktop](http://www.freedesktop.org) standards:
57 | [EWMH](http://standards.freedesktop.org/wm-spec/wm-spec-latest.html),
58 | [XDG Base Directory](http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html),
59 | [XEmbed](http://standards.freedesktop.org/xembed-spec/xembed-spec-latest.html),
60 | [Desktop Notification](http://www.galago-project.org/specs/notification/),
61 | [System Tray](http://standards.freedesktop.org/systemtray-spec/systemtray-spec-latest.html).
62 | * Does not distinguish between layers: there is no floating or tiled layer.
63 | * Uses tags instead of workspaces: allow to place clients on several tags, and
64 | display several tags at the same time.
65 | * A lot of Lua extensions to add features: dynamic tagging, widget feeding,
66 | tabs, layouts, …
67 | * [D-Bus](http://dbus.freedesktop.org) support.
68 | * And more.
69 |
70 | This is gonna be LEGEN... wait for it... DARY!
71 |
--------------------------------------------------------------------------------
/recipes/gpmdp.lua:
--------------------------------------------------------------------------------
1 |
2 | --[[
3 |
4 | Licensed under GNU General Public License v2
5 | * (c) 2017, Greg Flynn
6 |
7 | --]]
8 | local awful = require("awful")
9 | local naughty = require("naughty")
10 | local dpi = require("beautiful.xresources").apply_dpi
11 | local io, next, os, string, table = io, next, os, string, table
12 |
13 | -- Google Play Music Desktop Player widget
14 | -- requires: curl and dkjson or lain
15 |
16 | local gpmdp = {
17 | notify = "on",
18 | followtag = false,
19 | file_location = os.getenv("HOME") .. "/.config/Google Play Music Desktop Player/json_store/playback.json",
20 | notification_preset = {
21 | title = "Now playing",
22 | icon_size = dpi(128),
23 | timeout = 6
24 | },
25 | notification = nil,
26 | current_track = nil,
27 | album_cover = "/tmp/gpmcover"
28 | }
29 |
30 | function gpmdp.notification_on()
31 | local gpm_now = gpmdp.latest
32 | gpmdp.current_track = gpm_now.title
33 |
34 | if gpmdp.followtag then gpmdp.notification_preset.screen = awful.screen.focused() end
35 | awful.spawn.easy_async({"curl", gpm_now.cover_url, "-o", gpmdp.album_cover}, function(stdout)
36 | local old_id = nil
37 | if gpmdp.notification then old_id = gpmdp.notification.id end
38 |
39 | gpmdp.notification = naughty.notify({
40 | preset = gpmdp.notification_preset,
41 | icon = gpmdp.album_cover,
42 | replaces_id = old_id
43 | })
44 | end)
45 | end
46 |
47 | function gpmdp.notification_off()
48 | if not gpmdp.notification then return end
49 | naughty.destroy(gpmdp.notification)
50 | gpmdp.notification = nil
51 | end
52 |
53 | function gpmdp.get_lines(file)
54 | local f = io.open(file)
55 | if not f then
56 | return
57 | else
58 | f:close()
59 | end
60 |
61 | local lines = {}
62 | for line in io.lines(file) do
63 | lines[#lines + 1] = line
64 | end
65 | return lines
66 | end
67 |
68 | gpmdp.widget = awful.widget.watch({"pidof", "Google Play Music Desktop Player"}, 2, function(widget, stdout)
69 | local filelines = gpmdp.get_lines(gpmdp.file_location)
70 | if not filelines then return end -- GPMDP not running?
71 |
72 | gpm_now = { running = stdout ~= '' }
73 |
74 | if not next(filelines) then
75 | gpm_now.running = false
76 | gpm_now.playing = false
77 | else
78 | dict, pos, err = require("dkjson").decode(table.concat(filelines), 1, nil) -- dkjson
79 | -- dict, pos, err = require("lain.util").dkjson.decode(table.concat(filelines), 1, nil) -- lain
80 | gpm_now.artist = dict.song.artist
81 | gpm_now.album = dict.song.album
82 | gpm_now.title = dict.song.title
83 | gpm_now.cover_url = dict.song.albumArt
84 | gpm_now.playing = dict.playing
85 | end
86 | gpmdp.latest = gpm_now
87 |
88 | -- customize here
89 | gpmdp.notification_preset.text = string.format("%s (%s) - %s", gpm_now.artist, gpm_now.album, gpm_now.title)
90 | widget:set_text(gpm_now.artist .. " - " .. gpm_now.title)
91 |
92 | if gpm_now.playing then
93 | if gpmdp.notify == "on" and gpm_now.title ~= gpmdp.current_track then
94 | gpmdp.notification_on()
95 | end
96 | elseif not gpm_now.running then
97 | gpmdp.current_track = nil
98 | end
99 | end)
100 |
101 | -- add mouse hover
102 | gpmdp.widget:connect_signal("mouse::enter", gpmdp.notification_on)
103 | gpmdp.widget:connect_signal("mouse::leave", gpmdp.notification_off)
104 |
105 | return gpmdp
106 |
--------------------------------------------------------------------------------
/download.mdwn:
--------------------------------------------------------------------------------
1 | # Download
2 |
3 | ## Packages
4 |
5 | **awesome** is currently available in:
6 |
7 | * Arch Linux:
8 | * [stable](https://www.archlinux.org/packages/extra/x86_64/awesome/)
9 | * [awesome-git in AUR](https://aur.archlinux.org/packages/awesome-git)
10 | * [awesome-luajit-git in AUR](https://aur.archlinux.org/packages/awesome-luajit-git/)
11 | * [Debian](http://packages.debian.org/awesome)
12 | * [Ubuntu](http://packages.ubuntu.com/awesome)
13 | * [Fedora](https://packages.fedoraproject.org/pkgs/awesome/awesome/)
14 | * [FreeBSD](http://www.freshports.org/x11-wm/awesome/)
15 | * [Gentoo](http://packages.gentoo.org/package/x11-wm/awesome)
16 | * [OpenBSD](http://openports.se/x11/awesome)
17 | * [NetBSD](http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/wm/awesome/)
18 | * [Source Mage GNU/Linux](http://codex.sourcemage.org/test/windowmanagers/awesome/)
19 | * [T2 SDE](http://t2-project.org/packages/awesome.html)
20 | * [CRUX](http://crux.nu/portdb/index.php?q=awesome&a=search&s=true)
21 | * [openSUSE](http://download.opensuse.org/repositories/X11:/windowmanagers/)
22 | * [Milis Linux](https://notabug.org/milislinux/milis/src/master/talimatname/genel/a/awesome)
23 | * [PLD Linux](http://pld-linux.org)
24 | * [Mageia](http://mageia.madb.org/package/show/application/0/name/awesome)
25 | * [OpenIndiana](http://pkg.openindiana.org/hipster/en/search.shtml?token=awesome&action=Search)
26 |
27 | Repology provides a [comprehensive overview](https://repology.org/metapackage/awesome/versions) of which version of **awesome** is included in which distribution.
28 |
29 | ### Distributions using Awesome as the default window manager
30 |
31 | * [GoboLinux](https://gobolinux.org)
32 |
33 | ## Building from Source
34 |
35 | 36 | We strongly recommend using the awesome package of your distribution. 37 |
38 | 39 | This is because many people who tried to build from source had problems. 40 | [LGI](https://github.com/pavouk/lgi), one of awesome's dependencies, currently 41 | hardcodes the package search path used by Lua 5.1. Part of the reason for this 42 | is that Lua upstream intends Lua to be embedded, which means that detecting an 43 | installed Lua version properly is not easy. 44 | 45 | After installing awesome, you can check if you are affected by this problem by 46 | running `awesome -v`. If an error message is displayed instead of LGI version's 47 | number, you are likely affected. 48 | 49 | ### Stable 50 | 51 | Latest stable version of **awesome** is version 4.3 (*Too long*) 52 | released on 28 January 2019. 53 | 54 | * [v4.3 changelog](../changelogs/v4.3.txt) ([short](../changelogs/short/v4.3.txt)) 55 | * [awesome-4.3.tar.bz2](https://github.com/awesomeWM/awesome-releases/raw/master/awesome-4.3.tar.bz2) ([GPG sig](https://github.com/awesomeWM/awesome-releases/raw/master/awesome-4.3.tar.bz2.asc)) 56 | * [awesome-4.3.tar.xz](https://github.com/awesomeWM/awesome-releases/raw/master/awesome-4.3.tar.xz) ([GPG sig](https://github.com/awesomeWM/awesome-releases/raw/master/awesome-4.3.tar.xz.asc)) 57 | 58 | ### Old stable 59 | 60 | This branch of **awesome** is deprecated. 61 | 62 | Latest old stable version of **awesome** is version 3.5.9 (*Mighty Ravendark*) 63 | released on 6 March 2016. 64 | 65 | * [v3.5.9 changelog](../changelogs/v3.5.9.txt) ([short](../changelogs/short/v3.5.9.txt)) 66 | * [awesome-3.5.9.tar.bz2](https://github.com/awesomeWM/awesome-releases/raw/master/awesome-3.5.9.tar.bz2) 67 | * [awesome-3.5.9.tar.xz](https://github.com/awesomeWM/awesome-releases/raw/master/awesome-3.5.9.tar.xz) 68 | 69 | ### Development 70 | 71 | The Git repository can be cloned from Github: 72 | 73 | `git clone https://github.com/awesomeWM/awesome.git` 74 | 75 | Alternatively, development versions can be downloaded as ZIP files through the 76 | [Github web interface](https://github.com/awesomeWM/awesome). 77 | 78 | ## History 79 | 80 | A list of of old releases [[is available here|releases]]. 81 | -------------------------------------------------------------------------------- /recipes/xrandr.lua: -------------------------------------------------------------------------------- 1 | --- Separating Multiple Monitor functions as a separeted module (taken from awesome wiki) 2 | 3 | local gtable = require("gears.table") 4 | local spawn = require("awful.spawn") 5 | local naughty = require("naughty") 6 | 7 | -- A path to a fancy icon 8 | local icon_path = "" 9 | 10 | -- Get active outputs 11 | local function outputs() 12 | local outputs = {} 13 | local xrandr = io.popen("xrandr -q --current") 14 | 15 | if xrandr then 16 | for line in xrandr:lines() do 17 | local output = line:match("^([%w-]+) connected ") 18 | if output then 19 | outputs[#outputs + 1] = output 20 | end 21 | end 22 | xrandr:close() 23 | end 24 | 25 | return outputs 26 | end 27 | 28 | local function arrange(out) 29 | -- We need to enumerate all permutations of horizontal outputs. 30 | 31 | local choices = {} 32 | local previous = { {} } 33 | for i = 1, #out do 34 | -- Find all permutation of length `i`: we take the permutation 35 | -- of length `i-1` and for each of them, we create new 36 | -- permutations by adding each output at the end of it if it is 37 | -- not already present. 38 | local new = {} 39 | for _, p in pairs(previous) do 40 | for _, o in pairs(out) do 41 | if not gtable.hasitem(p, o) then 42 | new[#new + 1] = gtable.join(p, {o}) 43 | end 44 | end 45 | end 46 | choices = gtable.join(choices, new) 47 | previous = new 48 | end 49 | 50 | return choices 51 | end 52 | 53 | -- Build available choices 54 | local function menu() 55 | local menu = {} 56 | local out = outputs() 57 | local choices = arrange(out) 58 | 59 | for _, choice in pairs(choices) do 60 | local cmd = "xrandr" 61 | -- Enabled outputs 62 | for i, o in pairs(choice) do 63 | cmd = cmd .. " --output " .. o .. " --auto" 64 | if i > 1 then 65 | cmd = cmd .. " --right-of " .. choice[i-1] 66 | end 67 | end 68 | -- Disabled outputs 69 | for _, o in pairs(out) do 70 | if not gtable.hasitem(choice, o) then 71 | cmd = cmd .. " --output " .. o .. " --off" 72 | end 73 | end 74 | 75 | local label = "" 76 | if #choice == 1 then 77 | label = 'Only ' .. choice[1] .. '' 78 | else 79 | for i, o in pairs(choice) do 80 | if i > 1 then label = label .. " + " end 81 | label = label .. '' .. o .. '' 82 | end 83 | end 84 | 85 | menu[#menu + 1] = { label, cmd } 86 | end 87 | 88 | return menu 89 | end 90 | 91 | -- Display xrandr notifications from choices 92 | local state = { cid = nil } 93 | 94 | local function naughty_destroy_callback(reason) 95 | if reason == naughty.notificationClosedReason.expired or 96 | reason == naughty.notificationClosedReason.dismissedByUser then 97 | local action = state.index and state.menu[state.index - 1][2] 98 | if action then 99 | spawn(action, false) 100 | state.index = nil 101 | end 102 | end 103 | end 104 | 105 | local function xrandr() 106 | -- Build the list of choices 107 | if not state.index then 108 | state.menu = menu() 109 | state.index = 1 110 | end 111 | 112 | -- Select one and display the appropriate notification 113 | local label, action 114 | local next = state.menu[state.index] 115 | state.index = state.index + 1 116 | 117 | if not next then 118 | label = "Keep the current configuration" 119 | state.index = nil 120 | else 121 | label, action = next[1], next[2] 122 | end 123 | state.cid = naughty.notify({ text = label, 124 | icon = icon_path, 125 | timeout = 4, 126 | screen = mouse.screen, 127 | replaces_id = state.cid, 128 | destroy = naughty_destroy_callback}).id 129 | end 130 | 131 | return { 132 | outputs = outputs, 133 | arrange = arrange, 134 | menu = menu, 135 | xrandr = xrandr 136 | } 137 | -------------------------------------------------------------------------------- /images/awesome-logo.svg: -------------------------------------------------------------------------------- 1 | 2 | 115 | -------------------------------------------------------------------------------- /releases.mdwn: -------------------------------------------------------------------------------- 1 | # Releases 2 | 3 | This page provides an overview over all releases of awesome. 4 | 5 | ## Version 4 6 | 7 | [[!table data=""" 8 | Date |Version |Codename 9 | 28 January 2019 |awesome 4.3 |Too long 10 | 15 July 2017 |awesome 4.2 |Human after all 11 | 18 March 2017 |awesome 4.1 |Technologic 12 | **25 December 2016** |**awesome 4.0**|**Harder, Better, Faster, Stronger** 13 | """]] 14 | 15 | ## Version 3 16 | 17 | [[!table data=""" 18 | Date |Version |Codename 19 | 6 March 2016 |awesome 3.5.9 |Mighty Ravendark 20 | 30 January 2016 |awesome 3.5.8 |Major Tom 21 | 15 January 2016 |awesome 3.5.7 |Space Oddity 22 | 10 January 2015 |awesome 3.5.6 |For Those About To Rock 23 | 11 April 2014 |awesome 3.5.5 |Kansas City Shuffle 24 | 2 April 2014 |awesome 3.5.4 |Brown Paper Bag 25 | 29 March 2014 |awesome 3.5.3 |Crazy 26 | 12 Octover 2013 |awesome 3.5.2 |The Fox 27 | 1 April 2013 |awesome 3.5.1 |Ruby Tuesday 28 | **21 December 2012** |**awesome 3.5**|**Last Christmas** 29 | 14 December 2012 |awesome 3.5-rc2|I'll Kill Her 30 | 24 November 2012 |awesome 3.5-rc1|Dirty Magic 31 | 11 February 2013 |awesome 3.4.15 |Never Gonna Give You Up 32 | 24 December 2012 |awesome 3.4.14 |White Christmas 33 | 15 July 2012 |awesome 3.4.13 |Octoveropus 34 | 11 June 2012 |awesome 3.4.12 |Starlight 35 | 23 November 2011 |awesome 3.4.11 |Pickapart 36 | 16 May 2011 |awesome 3.4.10 |Exploder 37 | 17 January 2011 |awesome 3.4.9 |Smack 38 | 4 Octover 2010 |awesome 3.4.8 |Never Know 39 | 25 August 2010 |awesome 3.4.7 |Left Of Center 40 | 14 July 2010 |awesome 3.4.6 |Hootch 41 | 10 May 2010 |awesome 3.4.5 |Close To You 42 | 02 March 2010 |awesome 3.4.4 |Jet Sex 43 | 04 January 2010 |awesome 3.4.3 |Engines 44 | 26 November 2009 |awesome 3.4.2 |For The Restless 45 | 9 November 2009 |awesome 3.4.1 |Ego Rock 46 | **20 Octover 2009** |**awesome 3.4**|**Closing In** 47 | 9 Octover 2009 |awesome 3.4-rc3|Black Star 48 | 28 September 2009 |awesome 3.4-rc2|Piku 49 | 11 September 2009 |awesome 3.4-rc1|Uprising 50 | 7 September 2009 |awesome 3.3.4 |Mercury 51 | 25 August 2009 |awesome 3.3.3 |Firelight 52 | 27 July 2009 |awesome 3.3.2 |Half Moon 53 | 18 June 2009 |awesome 3.3.1 |Bionic 54 | **4 June 2009** |**awesome 3.3**|**Stellar** 55 | 26 May 2009 |awesome 3.3-rc4|Breath 56 | 18 May 2009 |awesome 3.3-rc3|Uniform 57 | 8 May 2009 |awesome 3.3-rc2|Bad Boyfriend 58 | 1 May 2009 |awesome 3.3-rc1|The Lightning Strike 59 | 4 April 2009 |awesome 3.2.1 |Complicated 60 | **13 March 2009** |**awesome 3.2**|**Accidental Babies** 61 | 27 February 2009 |awesome 3.2-rc4|Faith 62 | 20 February 2009 |awesome 3.2-rc3|Chocolate 63 | 13 February 2009 |awesome 3.2-rc2|Hunting For Witches 64 | 6 February 2009 |awesome 3.2-rc1|Candyman 65 | 5 February 2009 |awesome 3.1.2 |Nobody Came 66 | 8 January 2009 |awesome 3.1.1 |Ring My Bell 67 | **12 December 2008** |**awesome 3.1**|**Helicopter** 68 | 5 December 2008 |awesome 3.1-rc5|Face 69 | 28 November 2008 |awesome 3.1-rc4|Seven Nation Army 70 | 21 November 2008 |awesome 3.1-rc3|When Doves Cry 71 | 14 November 2008 |awesome 3.1-rc2|When She Believes 72 | 7 November 2008 |awesome 3.1-rc1|The Golden Floor 73 | **18 September 2008**|**awesome 3.0**|**Fake Plastic Trees** 74 | 5 September 2008 |awesome 3.0-rc6|Elect The Dead 75 | 29 August 2008 |awesome 3.0-rc5|Marchshals Are Dead 76 | 22 August 2008 |awesome 3.0-rc4|Scared Of Girls 77 | 15 August 2008 |awesome 3.0-rc3|Into The Groove 78 | 8 August 2008 |awesome 3.0-rc2|Wake Up Call 79 | 1 August 2008 |awesome 3.0-rc1|Time To Pretend 80 | """]] 81 | 82 | ## Version 2 83 | 84 | [[!table data=""" 85 | Date |Version |Codename 86 | 18 April 2009 |awesome 2.3.6 |Tomorrow Morning 87 | 2 January 2009 |awesome 2.3.5 |New Morning 88 | 24 August 2008 |awesome 2.3.4 |Morning Trouble 89 | 26 July 2008 |awesome 2.3.3 |Pure Morning 90 | 24 June 2008 |awesome 2.3.2 |Morning Yearning 91 | 2 June 2008 |awesome 2.3.1 |Morning Glory 92 | **6 May 2008** |**awesome 2.3**|**Morning View** 93 | 21 April 2008 |awesome 2.3-rc3|Dirty Boots 94 | 17 April 2008 |awesome 2.3-rc2|Better Than 95 | 7 April 2008 |awesome 2.3-rc1|Deep Inside 96 | **23 March 2008** |**awesome 2.2**|**Morning Lemon** 97 | 13 March 2008 |awesome 2.2-rc4|Wooden Horse 98 | 4 March 2008 |awesome 2.2-rc3|There There 99 | 25 Feburary 2008 |awesome 2.2-rc2|Broken Man 100 | 14 Feburary 2008 |awesome 2.2-rc1|Digital Love 101 | **21 January 2008**|**awesome 2.1**|**Morning Bell** 102 | 12 January 2008 |awesome 2.1-rc2|Blow out 103 | 9 January 2008 |awesome 2.1-rc1|Dracula Cowboy 104 | **11 December 2007**|**awesome 2.0**|**Fruit Fly** 105 | 29 November 2007 |awesome 2.0-rc2|Softened Lights 106 | 16 November 2007 |awesome 2.0-rc1|Bumping Toaster 107 | """]] 108 | 109 | 110 | ## Version 1 111 | 112 | [[!table data=""" 113 | Date |Version 114 | 5 October 2007 |awesome 1.3 115 | 26 September 2007 |awesome 1.2 116 | 20 September 2007 |awesome 1.1 117 | **19 September 2007**|**awesome 1.0** 118 | """]] 119 | -------------------------------------------------------------------------------- /images/icons/sun.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 128 | -------------------------------------------------------------------------------- /recipes/mic.lua: -------------------------------------------------------------------------------- 1 | --[[ 2 | 3 | Licensed under GNU General Public License v2 4 | * (c) 2021, bzgec 5 | 6 | 7 | # Microphone state widget/watcher 8 | 9 | This widget can be used to display the current microphone status. 10 | 11 | ## Requirements 12 | 13 | - `amixer` - this command is used to get and toggle microphone state 14 | 15 | ## Usage 16 | 17 | - Download [mic.lua](https://awesomewm.org/recipes/mic.lua) file and put it into awesome's 18 | folder (like `~/.config/awesome/widgets/mic.lua`) 19 | 20 | - Add widget to `theme.lua`: 21 | 22 | ```lua 23 | local widgets = { 24 | mic = require("widgets/mic"), 25 | } 26 | theme.mic = widgets.mic({ 27 | timeout = 10, 28 | settings = function(self) 29 | if self.state == "muted" then 30 | self.widget:set_image(theme.widget_micMuted) 31 | else 32 | self.widget:set_image(theme.widget_micUnmuted) 33 | end 34 | end 35 | }) 36 | local widget_mic = wibox.widget { theme.mic.widget, layout = wibox.layout.align.horizontal } 37 | ``` 38 | 39 | - Create a shortcut to toggle microphone state (add to `rc.lua`): 40 | 41 | ```lua 42 | -- Toggle microphone state 43 | awful.key({ modkey, "Shift" }, "m", 44 | function () 45 | beautiful.mic:toggle() 46 | end, 47 | {description = "Toggle microphone (amixer)", group = "Hotkeys"} 48 | ), 49 | ``` 50 | 51 | - You can also add a command to mute the microphone state on boot. Add this to your `rc.lua`: 52 | 53 | ```lua 54 | -- Mute microphone on boot 55 | beautiful.mic:mute() 56 | ``` 57 | 58 | --]] 59 | 60 | 61 | local awful = require("awful") 62 | local naughty = require("naughty") 63 | local gears = require("gears") 64 | local wibox = require("wibox") 65 | 66 | local function factory(args) 67 | local args = args or {} 68 | 69 | local mic = { 70 | widget = args.widget or wibox.widget.imagebox(), 71 | settings = args.settings or function(self) end, 72 | timeout = args.timeout or 10, 73 | timer = gears.timer, 74 | state = "", 75 | } 76 | 77 | function mic:mute() 78 | awful.spawn.easy_async({"amixer", "set", "Capture", "nocap"}, 79 | function() 80 | self:update() 81 | end 82 | ) 83 | end 84 | 85 | function mic:unmute() 86 | awful.spawn.easy_async({"amixer", "set", "Capture", "cap"}, 87 | function() 88 | self:update() 89 | end 90 | ) 91 | end 92 | 93 | function mic:toggle() 94 | awful.spawn.easy_async({"amixer", "set", "Capture", "toggle"}, 95 | function() 96 | self:update() 97 | end 98 | ) 99 | end 100 | 101 | function mic:pressed(button) 102 | if button == 1 then 103 | self:toggle() 104 | end 105 | end 106 | 107 | function mic:update() 108 | -- Check that timer has started 109 | if self.timer.started then 110 | self.timer:emit_signal("timeout") 111 | end 112 | end 113 | 114 | -- Read `amixer get Capture` command and try to `grep` all "[on]" lines. 115 | -- - If there are lines with "[on]" then assume microphone is "unmuted". 116 | -- - If there are NO lines with "[on]" then assume microphone is "muted". 117 | mic, mic.timer = awful.widget.watch( 118 | {"bash", "-c", "amixer get Capture | grep '\\[on\\]'"}, 119 | mic.timeout, 120 | function(self, stdout, stderr, exitreason, exitcode) 121 | local current_micState = "error" 122 | 123 | if exitcode == 1 then 124 | -- Exit code 1 - no line selected 125 | current_micState = "muted" 126 | elseif exitcode == 0 then 127 | -- Exit code 0 - a line is selected 128 | current_micState = "unmuted" 129 | else 130 | -- Other exit code (2) - error occurred 131 | current_micState = "error" 132 | end 133 | 134 | -- Compare new and old state 135 | if current_micState ~= self.state then 136 | if current_micState == "muted" then 137 | naughty.notify({preset=naughty.config.presets.normal, 138 | title="mic widget info", 139 | text='muted'}) 140 | elseif current_micState == "unmuted" then 141 | naughty.notify({preset=naughty.config.presets.normal, 142 | title="mic widget info", 143 | text='unmuted'}) 144 | else 145 | naughty.notify({preset=naughty.config.presets.critical, 146 | title="mic widget error", 147 | text='Error on "amixer get Capture | grep \'\\[on\\]\'"'}) 148 | end 149 | 150 | -- Store new microphone state 151 | self.state = current_micState 152 | end 153 | 154 | -- Call user/theme defined function 155 | self:settings() 156 | end, 157 | mic -- base_widget (passed in callback function as first parameter) 158 | ) 159 | 160 | -- add mouse click 161 | mic.widget:connect_signal("button::press", function(c, _, _, button) 162 | mic:pressed(button) 163 | end) 164 | 165 | return mic 166 | end 167 | 168 | return factory 169 | -------------------------------------------------------------------------------- /.github/workflows/www.yml: -------------------------------------------------------------------------------- 1 | name: Build and publish awesomewm.org 2 | 3 | on: 4 | # Trigger on push to branche `master`. 5 | push: 6 | branches: [ master ] 7 | # Trigger on pull request events for PRs that have `master` as their target branch 8 | pull_request: 9 | branches: [ master ] 10 | 11 | # Allow running the workflow manually 12 | workflow_dispatch: 13 | 14 | defaults: 15 | run: 16 | # GitHub Actions adds `errexit` and `pipefail` by default, but we add `xtrace` 17 | # to improve debugging some of the longer scripts. 18 | shell: /bin/bash -o errexit -o pipefail -o xtrace {0} 19 | 20 | jobs: 21 | main: 22 | runs-on: ubuntu-20.04 23 | 24 | env: 25 | BUILD_WEB: "/tmp/build-web" 26 | 27 | steps: 28 | # Create a cache invalidation key based on the current year + week. 29 | # This way, packages will be checked for updates once every week. 30 | - name: Get Date 31 | id: get-date 32 | run: echo "::set-output name=date::$(/bin/date -u "+%Y%W")" 33 | 34 | - name: Cache apt packages 35 | id: cache-apt 36 | uses: actions/cache@v2 37 | with: 38 | path: /var/cache/apt/archives 39 | # The trailing number serves as a version flag that can be incremented 40 | # to invalidate the cache after changing the list of packages. 41 | key: ${{ github.workflow }}-${{ runner.os }}-${{ steps.get-date.outputs.date }}-apt-3 42 | 43 | - name: Download apt packages 44 | if: steps.cache-apt.outputs.cache-hit != 'true' 45 | run: | 46 | sudo apt-get update 47 | sudo apt-get install --download-only -y --no-install-recommends \ 48 | ikiwiki \ 49 | asciidoc \ 50 | imagemagick \ 51 | perlmagick \ 52 | luarocks \ 53 | cmake \ 54 | libxcb-cursor-dev \ 55 | libxcb-randr0-dev \ 56 | libxcb-xtest0-dev \ 57 | libxcb-xinerama0-dev \ 58 | libxcb-shape0-dev \ 59 | libxcb-util0-dev \ 60 | libxcb-keysyms1-dev \ 61 | libxcb-icccm4-dev \ 62 | libxcb-xrm-dev \ 63 | libxdg-basedir-dev \ 64 | libstartup-notification0-dev \ 65 | libxcb-xkb-dev \ 66 | libxkbcommon-dev \ 67 | libxkbcommon-x11-dev \ 68 | gir1.2-pango-1.0 \ 69 | xutils-dev \ 70 | libgirepository1.0-dev \ 71 | lua-discount 72 | 73 | - name: Install downloaded packages 74 | run: | 75 | sudo dpkg -i /var/cache/apt/archives/*.deb 76 | 77 | - name: Cache luarocks 78 | id: cache-luarocks 79 | uses: actions/cache@v2 80 | with: 81 | path: /tmp/luarocks 82 | key: ${{ github.workflow }}-${{ runner.os }}-luarocks-3.5.0 83 | 84 | - name: Install fresh Luarocks 85 | if: steps.cache-luarocks.outputs.cache-hit != 'true' 86 | run: | 87 | wget -O /tmp/luarocks.tar.gz https://github.com/luarocks/luarocks/archive/v3.5.0.tar.gz 88 | mkdir /tmp/luarocks 89 | tar -xf /tmp/luarocks.tar.gz -C /tmp/luarocks --strip-components=1 90 | cd /tmp/luarocks 91 | ./configure 92 | make build 93 | sudo make install 94 | 95 | - name: Install cached Luarocks 96 | if: steps.cache-luarocks.outputs.cache-hit == 'true' 97 | run: | 98 | cd /tmp/luarocks 99 | sudo make install 100 | 101 | - name: Install rocks 102 | run: | 103 | sudo -H luarocks install lgi 104 | sudo -H luarocks install ldoc 105 | 106 | - name: Install mdl 107 | run: | 108 | sudo gem install mdl -v 0.9.0 109 | 110 | - uses: actions/checkout@v2 111 | with: 112 | submodules: recursive 113 | 114 | - name: Get Awesome website target repo 115 | env: 116 | APIDOC_TOKEN: ${{ secrets.AWESOME_ROBOT_TOKEN || github.token }} 117 | run: | 118 | set -e 119 | git clone \ 120 | https://${APIDOC_TOKEN}@github.com/awesomeWM/awesomeWM.github.io \ 121 | "$BUILD_WEB" 2>&1 | sed "s/$APIDOC_TOKEN/APIDOC_TOKEN/g" 122 | if [ "${{ github.event_name }}" != 'pull_request' ]; then 123 | branch="${{ github.head_ref || github.ref_name }}" 124 | else 125 | branch="pr-${{ github.event.pull_request.number }}" 126 | fi 127 | if [ "$branch" != master ]; then 128 | cd "$BUILD_WEB" 129 | if ! git checkout -b "$branch" "origin/$branch"; then 130 | git checkout -b "$branch" 131 | fi 132 | cd - 133 | fi 134 | 135 | - name: Build website 136 | run: | 137 | cd "${{ github.workspace }}" 138 | PKG_CONFIG_PATH="$HOME/install/lib/pkgconfig" make build_for_gh_actions 139 | mdl --git-recurse . 140 | 141 | - name: Publish website 142 | if: github.event_name != 'pull_request' 143 | env: 144 | APIDOC_TOKEN: ${{ secrets.AWESOME_ROBOT_TOKEN || github.token }} 145 | CLOUDFLARE_ZONE: ${{ secrets.CLOUDFLARE_ZONE }} 146 | CLOUDFLARE_AUTH_EMAIL: ${{ secrets.CLOUDFLARE_AUTH_EMAIL }} 147 | CLOUDFLARE_AUTH_KEY: ${{ secrets.CLOUDFLARE_AUTH_KEY }} 148 | run: | 149 | set -e 150 | commit_hash=$(git rev-parse --short HEAD) 151 | cd "$BUILD_WEB" 152 | git config user.name "awesome-robot on GH Actions" 153 | git config user.email "awesome-robot@users.noreply.github.com" 154 | git add --all . 155 | NL=$'\n' 156 | git commit -m "Update from GH Actions for awesome-www@${commit_hash}${NL}${NL}Commits: ${{ github.event.pull_request.commits_url }}${NL}Build URL: https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}" 157 | git --no-pager show --stat 158 | git push origin "$(git symbolic-ref --quiet HEAD)" 2>&1 | sed "s/$APIDOC_TOKEN/APIDOC_TOKEN/g" 159 | 160 | # Purge CloudFlare cache. 161 | curl -X DELETE "https://api.cloudflare.com/client/v4/zones/$CLOUDFLARE_ZONE/purge_cache" \ 162 | -H "X-Auth-Email: $CLOUDFLARE_AUTH_EMAIL" \ 163 | -H "X-Auth-Key: $CLOUDFLARE_AUTH_KEY" \ 164 | -H "Content-Type: application/json" \ 165 | --data '{"purge_everything":true}' 166 | 167 | # vim: filetype=yaml:expandtab:shiftwidth=2:tabstop=2 168 | -------------------------------------------------------------------------------- /templates/page.tmpl: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |
51 |
52 | 
54 | 
57 | -
121 |
122 |
123 |