An open API service indexing awesome lists of open source software.

https://github.com/theasp/awesome-config

Configuration GUI and plugin API for the Awesome window manager
https://github.com/theasp/awesome-config

List: awesome-config

awesome lua

Last synced: 5 months ago
JSON representation

Configuration GUI and plugin API for the Awesome window manager

Awesome Lists containing this project

README

        

Awesome Configuration

<!--/*--><![CDATA[/*><!--*/
.title { text-align: center; }
.todo { font-family: monospace; color: red; }
.done { color: green; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.right { margin-left: auto; margin-right: 0px; text-align: right; }
.left { margin-left: 0px; margin-right: auto; text-align: left; }
.center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #ccc;
box-shadow: 3px 3px 3px #eee;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: visible;
padding-top: 1.2em;
}
pre.src:before {
display: none;
position: absolute;
background-color: white;
top: -10px;
right: 10px;
padding: 3px;
border: 1px solid black;
}
pre.src:hover:before { display: inline;}
pre.src-sh:before { content: 'sh'; }
pre.src-bash:before { content: 'sh'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-R:before { content: 'R'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-java:before { content: 'Java'; }
pre.src-sql:before { content: 'SQL'; }

table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.right { text-align: center; }
th.left { text-align: center; }
th.center { text-align: center; }
td.right { text-align: right; }
td.left { text-align: left; }
td.center { text-align: center; }
dt { font-weight: bold; }
.footpara:nth-child(2) { display: inline; }
.footpara { display: block; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
/*]]>*/-->

/*
@licstart The following is the entire license notice for the
JavaScript code in this tag.

Copyright (C) 2012-2013 Free Software Foundation, Inc.

The JavaScript code in this tag is free software: you can
redistribute it and/or modify it under the terms of the GNU
General Public License (GNU GPL) as published by the Free Software
Foundation, either version 3 of the License, or (at your option)
any later version. The code is distributed WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.

As additional permission under GNU GPL version 3 section 7, you
may distribute non-source (e.g., minimized or compacted) forms of
that code without the copy of the GNU GPL normally required by
section 4, provided you include this license notice and a URL
through which recipients can access the Corresponding Source.

@licend The above is the entire license notice
for the JavaScript code in this tag.
*/
<!--/*--><![CDATA[/*><!--*/
function CodeHighlightOn(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.cacheClassElem = elem.className;
elem.cacheClassTarget = target.className;
target.className = "code-highlighted";
elem.className = "code-highlighted";
}
}
function CodeHighlightOff(elem, id)
{
var target = document.getElementById(id);
if(elem.cacheClassElem)
elem.className = elem.cacheClassElem;
if(elem.cacheClassTarget)
target.className = elem.cacheClassTarget;
}
/*]]>*///-->


Awesome Configuration



Table of Contents





This repository includes the following:



  • awesome-config - A GUI for manipulating the

  • crappy - A library for reading configuration files for Awesome



1 Crappy




Crappy reads a configuration file to configure Awesome 3.4.x or 3.5.x. Specifically tested on 3.4.11 and 3.5.5+. The goal of this is to be able to move between multiple versions of Awesome and maintain the same basic configuration in a relatively easy to edit file.





1.1 Installation from Git




Clone the repository anywhere you want:


git clone https://github.com/theasp/awesome-config.git



Backup your configuration directory:


cp -a ~/.config/awesome ~/.config/awesome.bak-$(date +%F-%T)



Make a symlink from your awesome config directory to the libraries:


ln -s $(pwd)/awesome-config/lib/* ~/.config/awesome/



Copy the example rc.lua and crappy-config.lua to your config directory:


cp awesome-config/examples/{crappy-config.lua,rc.lua} ~/.config/awesome/



Start awesome.






1.2 Installation from APT on Ubuntu




For the released version:


sudo add-apt-repository ppa:theasp/awesome-config



For the latest snapshot version:


sudo add-apt-repository ppa:theasp/awesome-config-snapshot



Then run:


sudo apt-get update

sudo apt-get install awesome-config


Backup your configuration directory:


cp -a ~/.config/awesome ~/.config/awesome.bak-$(date +%F-%T)



Copy the example rc.lua and crappy-config.lua to your config directory:


cp /usr/share/doc/awesome-config/examples/{crappy-config.lua,rc.lua} ~/.config/awesome/



Start awesome.







2 Configuration




You can use your own functions with crappy by defining or requiring them rc.lua before starting crappy, or using anonymous functions.





2.1 Awesome Config GUI




Run awesome-config to start the configuration GUI.






2.2 Manual Configuration




Edit .config/awesome/crappy-config.lua as desired.


A more detailed description of the configuration file is provided in the docs/config directory.







3 Plugin API




See the plugin API documentation in docs/plugins.






4 Code Used








Author: Andrew Phillips <[email protected]>


Date: 2015-06-18 Thu 13:49