<p><cite>This is now merged with master and this article should also be merged, with the Configuration article.</cite></p>
<p>It is a complete rewrite of amazing’s handling of configuration. It targets awesome versions later than 2.2, and the configuration can be written either in <acronym title="Yaml Aint Markup Language"><span class="caps">YAML</span></acronym> or a Ruby <acronym title="Domain Specific Language"><span class="caps">DSL</span></acronym> written specifically for amazing.</p>
<p>To get you started you may generate a <acronym title="Domain Specific Language"><span class="caps">DSL</span></acronym> configuration based on your <code>~/.awesomerc</code> with the <code>-g</code> or <code>--scaffold</code> switch:</p>
<pre class="console">% <span class="command">mkdir -p ~/.amazing</span>
% <span class="command">amazing -g > ~/.amazing/config.rb</span></pre><p><cite>Beware: the above command will overwrite any existing ~/.amazing/config.rb</cite></p>
<p>Then, you just edit away <code>~/.amazing/config.rb</code> to your hearts content. Scroll down to learn more about the <span class="caps">DSL</span> configuration.</p>
<h2><span class="caps">YAML</span></h2>
<p>The <span class="caps">YAML</span> configuration is now structured like this:</p>
<pre><code>awesome:
- screen: <screen> (defaults to 0)
statusbar: <statusbar> (defaults to "mystatusbar")
widgets:
- <identifier name of awesome widget>:
# be wary of indentation - or use inline syntax
module: <widget module> (defaults to same as <identifier>)
# list modules with amazing -w
# module names can be written in either CamelCase or snake_case
property: <fallback property if no properties are configured> (defaults to "text")
interval: <update interval in seconds> (defaults to unspecified)
# tip: 5:0 means five minutes, 5:0:0 five hours
<module option>: <option value> (defaults specific to modules)
# list these with amazing -w <module>
properties:
<property>: <ruby>
# this works as format did before
# list variables ("fields") with amazing -w <module>
# and examples with amazing -t <module> ["<option>: <value>, ..."]</code></pre>
<h2><span class="caps">DSL</span></h2>
<p>While the <span class="caps">DSL</span> is really Ruby, the syntax should hopefully be straight-forward even to people who are not familiar with Ruby.</p>
<pre><code>awesome([options...]) {
set :screen => <screen> (defaults to 0)
set :statusbar => <statusbar> (defaults to "mystatusbar")
widget(<identifier name of awesome widget>, [options...]) {
set :module => <widget module> (defaults to same as <identifier>)
# list modules with amazing -w
# module names can be written in either CamelCase or snake_case
set :property => <fallback property if no properties are configured> (defaults to "text")
set :interval => <update interval in seconds> (defaults to unspecified)
# tip: 5.minutes returns 300, up to x.years is supported (and the suffix "s" is optional)
set :<module option> => <option value> (defaults specific to modules)
# list these with amazing -w <module>
property(<property>) {
<ruby>
# this works as format did before
# list variables ("fields") with amazing -w <module>
# and examples with amazing -t <module> ["<option>: <value>, ..."]
}
}
}</code></pre>
<h3>Options</h3>
<p>Options can be set in multiple ways. Directly in the element directive:</p>
awesome(:statusbar => “top”, …) { … }
<p>With the <code>set</code> directive:</p>
awesome {
set :statusbar => “top”, …
}
<h3>Sample configurations</h3>
<ul>
<li><a href="http://github.com/dag/dotfiles/tree/master/.amazing/config.rb">Dag a.k.a. donri</a></li>
<li><a href="http://github.com/gigamo/config/tree/master/.amazing/config.rb">Gigamo</a></li>
</ul>
2008-03-24T06:22:36-07:00
5816
beyond-awesome-2-2
1388
Beyond awesome 2.2
2008-05-23T09:31:45-07:00
8627