-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.html
356 lines (330 loc) · 11 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
<?xml version="1.0" encoding="utf-8"?>
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Awesome Configuration</title>
<!-- 2015-06-18 Thu 13:49 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="generator" content="Org-mode" />
<meta name="author" content="Andrew Phillips" />
<style type="text/css">
<!--/*--><![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; }
/*]]>*/-->
</style>
<script type="text/javascript">
/*
@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;
}
/*]]>*///-->
</script>
</head>
<body>
<div id="content">
<h1 class="title">Awesome Configuration</h1>
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#sec-1">1. Crappy</a>
<ul>
<li><a href="#sec-1-1">1.1. Installation from Git</a></li>
<li><a href="#sec-1-2">1.2. Installation from APT on Ubuntu</a></li>
</ul>
</li>
<li><a href="#sec-2">2. Configuration</a>
<ul>
<li><a href="#sec-2-1">2.1. Awesome Config GUI</a></li>
<li><a href="#sec-2-2">2.2. Manual Configuration</a></li>
</ul>
</li>
<li><a href="#sec-3">3. Plugin API</a></li>
<li><a href="#sec-4">4. Code Used</a></li>
</ul>
</div>
</div>
<p>
This repository includes the following:
</p>
<ul class="org-ul">
<li>awesome-config - A GUI for manipulating the
</li>
<li>crappy - A library for reading configuration files for Awesome
</li>
</ul>
<div id="outline-container-sec-1" class="outline-2">
<h2 id="sec-1"><span class="section-number-2">1</span> Crappy</h2>
<div class="outline-text-2" id="text-1">
<p>
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.
</p>
</div>
<div id="outline-container-sec-1-1" class="outline-3">
<h3 id="sec-1-1"><span class="section-number-3">1.1</span> Installation from Git</h3>
<div class="outline-text-3" id="text-1-1">
<p>
Clone the repository anywhere you want:
</p>
<div class="org-src-container">
<pre class="src src-sh">git clone https://github.com/theasp/awesome-config.git
</pre>
</div>
<p>
Backup your configuration directory:
</p>
<div class="org-src-container">
<pre class="src src-sh">cp -a ~/.config/awesome ~/.config/awesome.bak-$(<span style="color: #fa8072;">date</span> +%F-%T)
</pre>
</div>
<p>
Make a symlink from your awesome config directory to the libraries:
</p>
<div class="org-src-container">
<pre class="src src-sh">ln -s $(<span style="color: #fa8072;">pwd</span>)/awesome-config/lib/* ~/.config/awesome/
</pre>
</div>
<p>
Copy the example <code>rc.lua</code> and <code>crappy-config.lua</code> to your config directory:
</p>
<div class="org-src-container">
<pre class="src src-sh">cp awesome-config/examples/{crappy-config.lua,rc.lua} ~/.config/awesome/
</pre>
</div>
<p>
Start awesome.
</p>
</div>
</div>
<div id="outline-container-sec-1-2" class="outline-3">
<h3 id="sec-1-2"><span class="section-number-3">1.2</span> Installation from APT on Ubuntu</h3>
<div class="outline-text-3" id="text-1-2">
<p>
For the released version:
</p>
<div class="org-src-container">
<pre class="src src-sh">sudo add-apt-repository ppa:theasp/awesome-config
</pre>
</div>
<p>
For the latest snapshot version:
</p>
<div class="org-src-container">
<pre class="src src-sh">sudo add-apt-repository ppa:theasp/awesome-config-snapshot
</pre>
</div>
<p>
Then run:
</p>
<div class="org-src-container">
<pre class="src src-sh">sudo apt-get update
sudo apt-get install awesome-config
</pre>
</div>
<p>
Backup your configuration directory:
</p>
<div class="org-src-container">
<pre class="src src-sh">cp -a ~/.config/awesome ~/.config/awesome.bak-$(<span style="color: #fa8072;">date</span> +%F-%T)
</pre>
</div>
<p>
Copy the example <code>rc.lua</code> and <code>crappy-config.lua</code> to your config directory:
</p>
<div class="org-src-container">
<pre class="src src-sh">cp /usr/share/doc/awesome-config/examples/{crappy-config.lua,rc.lua} ~/.config/awesome/
</pre>
</div>
<p>
Start awesome.
</p>
</div>
</div>
</div>
<div id="outline-container-sec-2" class="outline-2">
<h2 id="sec-2"><span class="section-number-2">2</span> Configuration</h2>
<div class="outline-text-2" id="text-2">
<p>
You can use your own functions with crappy by defining or requiring them <code>rc.lua</code> before starting crappy, or using anonymous functions.
</p>
</div>
<div id="outline-container-sec-2-1" class="outline-3">
<h3 id="sec-2-1"><span class="section-number-3">2.1</span> Awesome Config GUI</h3>
<div class="outline-text-3" id="text-2-1">
<p>
Run <code>awesome-config</code> to start the configuration GUI.
</p>
</div>
</div>
<div id="outline-container-sec-2-2" class="outline-3">
<h3 id="sec-2-2"><span class="section-number-3">2.2</span> Manual Configuration</h3>
<div class="outline-text-3" id="text-2-2">
<p>
Edit <code>.config/awesome/crappy-config.lua</code> as desired.
</p>
<p>
A more detailed description of the configuration file is provided in the <code>docs/config</code> directory.
</p>
</div>
</div>
</div>
<div id="outline-container-sec-3" class="outline-2">
<h2 id="sec-3"><span class="section-number-2">3</span> Plugin API</h2>
<div class="outline-text-2" id="text-3">
<p>
See the plugin API documentation in <code>docs/plugins</code>.
</p>
</div>
</div>
<div id="outline-container-sec-4" class="outline-2">
<h2 id="sec-4"><span class="section-number-2">4</span> Code Used</h2>
<div class="outline-text-2" id="text-4">
<ul class="org-ul">
<li>crappy by Andrew Phillips <[email protected]> <a href="http://www.gnu.org/licenses/gpl-2.0.html">GPLv2</a> includes code from:
<ul class="org-ul">
<li>ezconfig.lua by Georgi Valkov <[email protected]> <a href="http://www.gnu.org/licenses/gpl-2.0.html">GPLv2</a>
<ul class="org-ul">
<li><a href="https://raw.githubusercontent.com/gvalkov/dotfiles-awesome/master/ezconfig.lua">https://raw.githubusercontent.com/gvalkov/dotfiles-awesome/master/ezconfig.lua</a>
</li>
</ul>
</li>
<li>JSON Encode/Decode in Pure LUA by Jeffrey Friedl <a href="http://creativecommons.org/licenses/by/3.0/">CC-BY 3.0</a>
<ul class="org-ul">
<li><a href="http://regex.info/blog/lua/json">http://regex.info/blog/lua/json</a>
</li>
</ul>
</li>
<li>Serpent by Paul Kulchenko <a href="http://opensource.org/licenses/MIT">MIT</a>
<ul class="org-ul">
<li><a href="https://github.com/pkulchenko/serpent">https://github.com/pkulchenko/serpent</a>
</li>
</ul>
</li>
<li>rc.lua from Awesome by the awesome project <a href="http://www.gnu.org/licenses/gpl-2.0.html">GPLv2</a>
<ul class="org-ul">
<li><a href="http://awesome.naquadah.org/">http://awesome.naquadah.org/</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="postamble" class="status">
<p class="author">Author: Andrew Phillips <<a href="mailto:[email protected]">[email protected]</a>></p>
<p class="date">Date: 2015-06-18 Thu 13:49</p>
</div>
</body>
</html>