Difference between pages "Package:Awesome (Window Manager)" and "Template:Ebuild"

(Difference between pages)
(Updated the USE flags table. If someone could advise on the "recommended nature" of the dbus and doc flags, that would be great.)
 
 
Line 1: Line 1:
 +
<noinclude>
 +
This is the "Ebuild" template.
 +
It should be called in the following format:
 +
<pre>
 
{{Ebuild
 
{{Ebuild
|Summary=A dynamic floating and tiling window manager.
+
|Summary=
|CatPkg=x11-wm/awesome
+
|CatPkg=
 
|Maintainer=
 
|Maintainer=
|Homepage=http://awesome.naquadah.org/
+
|Homepage=
 
}}
 
}}
 
+
</pre>
== About Awesome ==
+
Edit the page to see the template text.
 
+
</noinclude><includeonly>__NOTOC__<div style="float: right; width: 30%; padding: 1em; margin-left: 1em; margin-bottom: 1em; border-radius: 10px; border: 1px solid #ddd; background-color: #efefef;" id="eb_infobox">
Awesome is a highly configurable window manager distributed under GPL-2 license. It handles both '''tiling and floating''' layouts. You can go into a '''fine-grained customization''' to suit your needs with '''Lua scripting'''. As a window manager, awesome is an ideal choice if you plan to ''get rid of your mouse''.
+
<b><tt>[[CatPkg::{{{CatPkg|}}}]]</tt></b>
 
+
<hr>{{#vardefine:cat|{{#explode:{{{CatPkg}}}|/|0}}}}{{#vardefine:pkg|{{#explode:{{{CatPkg}}}|/|1}}}}{{#get_web_data:url=http://ports.funtoo.org/packages.xml|format=xml|use xpath|data=repo_id=/packages/category[@name='{{#var:cat}}']/package[@name='{{#var:pkg}}']/@repository}}{{#vardefine:repoid|{{#if:{{#external_value:repo_id}}|{{#external_value:repo_id}}|gentoo}}}}{{#set:RepoID={{#var:repoid}}}}
=== Vocabulary ===
+
<table border="0" width="100%">
 
+
{{#if: {{{Maintainer|}}} |<tr><td><i>Current Maintainer(s):</i></td><td>{{#arraymaptemplate:{{{Maintainer|}}}|MaintainerDisplay|,|<br>}}</td></tr> |}}{{#if: {{{Homepage|}}} |<tr><td></td><td>[[Homepage::{{{Homepage|}}}|Homepage]]</td></tr> |}}<tr><td><i>Source Repository:</i></td><td>{{#ask:[[Category:Repositories]] [[Repository ID::{{#var:repoid}}]]}}</td></tr></table><hr>
;Screen: A physical monitor plugged into your computer.
+
<b>Summary:</b> [[Summary::{{{Summary|}}}]]
;Client: A window.
+
</div><div id="ebuild_header"><div id="ebuild_logo" style="padding-bottom: 1em;">[[File:ebuild.png|link=|frameless]]</div><div id="ebuild_title">
;Tag: A tag is something like a workspace or a desktop that you may find in other window managers. However, it is slightly more flexible as you can attach a ''client'' to multiple tags. Moreover, each ''screen'' has its own range of tags.
+
= {{PAGENAME}} =
;Layout: A layout is a way to arrange your ''clients'' in the current tag (eg. floating, horizontaly tiled, verticaly tiled, focused client full-screen, ...)
+
{{#set:Use|{{#get_web_data:url=http://ports.funtoo.org/packages.xml|format=xml|use xpath|data=repo_id=/packages/category[@name='{{#var:cat}}']/package[@name='{{#var:pkg}}']/@use}}}}
;Widget: A widget is a box that can contain text, images or more advanced objects. It enables you to add pieces of information in the status bar (at the top-right of each ''screen'') such as the time, the volume level or your battery load. You can also add widgets in the title bar of a ''client''.
+
</div></includeonly>
 
+
== USE flags ==
+
 
+
{| class="wikitable" style="margin: 1em auto;" width=80%
+
! width="20%" | Use flag
+
! width="10%" | Default
+
! width="10%" | Recommended
+
! width="60%" | Description
+
|-
+
| style="text-align: center;" | dbus
+
| style="text-align: center;" | Yes
+
| style="text-align: center;" |
+
| style="text-align: center;" | Enables awesome to receive signals from [[Dbus|dbus]] (eg. to trigger events on hotplug)
+
|-
+
| style="text-align: center;" | doc
+
| style="text-align: center;" | No
+
| style="text-align: center;" |  
+
| style="text-align: center;" | Includes extra HTML documentation (using doxygen)
+
|-
+
| style="text-align: center;" | gnome
+
| style="text-align: center;" | No
+
| style="text-align: center; background-color: yellow;" | If you want to run Awesome in GNOME, yes. Otherwise, probably not.
+
| style="text-align: center;" | Enables you to use awesome as gnome's window manager (See. [http://awesome.naquadah.org/wiki/Quickly_Setting_up_Awesome_with_Gnome Quickly Setting up Awesome with Gnome])
+
|}
+
 
+
== Installation ==
+
 
+
Just emerge it:
+
 
+
<console>
+
###i## emerge -a awesome
+
</console>
+
 
+
Then you can add this line to your <code>~/.xinitrc</code>:
+
 
+
{{file|name=~/.xinitrc|body=
+
exec ck-launch-session dbus-launch --sh-syntax --exit-with-session awesome
+
}}
+
 
+
And run <code>xinit</code> to launch awesome. You can also configure a display manager instead, but this is not covered in this document.
+
 
+
== Getting Started ==
+
 
+
So, you should see a nice awesome background and a top bar which includes your tags on the left (from 1 to 9), the status bar (containing a clock widget) on the right and, on the very left, an icon representing the current layout.
+
 
+
You can switch against tags by typing <code>Mod4 + [1..9]</code> or <code>Mod4 + Left/Right</code>. Where Mod4 is the "Super" key and [1..9] any digit from 1 to 9. Mod4 is the default modifier for awesome key bindings, yet you can configure another one (See [[#Configuration]]).
+
 
+
To run a program, hit <code>Mod4 + r</code>. You will be prompted for a command to run (on the top left corner, next to the tags list). Open some clients (3 or 4) and hit <code>Mod4 + Space</code>. This will switch to the next layout. Go ahead and try available layouts (notice the layout icon on the top right corner). You can also switch to the previous layout by hitting <code>Mod4 + Shift + Space</code>. To understand how each layout is arranged, you might want to add some more clients to the current tag. You can also toggle full screen for the current focused client with <code>Mod4 + f</code>.
+
 
+
Here is some other interesting key bindings:
+
 
+
* <code>Mod4 + h/l</code>: Resize clients (this will not work on some layouts)
+
* <code>Mod4 + Ctrl + r</code>: Restart awesome (useful when you want to test the configuration file you just edited)
+
* <code>Mod4 + Shift + q</code>: Quit awesome (note that this will not exit your display manager if ever you have one)
+
 
+
There's plenty of other key bindings. We will see them, how to change them and how to create your own in the next section.
+
 
+
== Configuration ==
+
 
+
Awesome user configuration files are located in <code>~/.config/awesome/</code>. For now, a single file called <code>rc.lua</code> should lie in this directory. It contains the default configuration (including widgets, tags, key bindings, ...). Note that if you don't know Lua, you can still proceed some customization. As far as I'm concerned, I only had to learn Lua basics when I started to create my own widgets.
+
 
+
{{fancynote|The system-wide configuration files are located in <code>/etc/xdg/awesome/</code>.}}
+
 
+
So, the first thing you might want to do is editing the default terminal (run when you hit <code>Mod4 + Return</code>). You can also change the fallback editor, but awesome uses <code>$EDITOR</code> to find your favorite one. This can be done on these lines:
+
{{file|name=~/.config/awesome/rc.lua|lang=lua|body=
+
terminal = "xterm"
+
editor = os.getenv("EDITOR") or "nano"
+
editor_cmd = terminal .. " -e " .. editor
+
}}
+
 
+
For strings, <code>..</code> is the concatenation operator in Lua.
+
 
+
I think the modkey setting is well-documented enough, so next will be the layouts setting:
+
 
+
{{file|name=~/.config/awesome/rc.lua|lang=lua|body=
+
local layouts =
+
{
+
    awful.layouts.suit.floating,
+
    awful.layouts.suit.tile,
+
    awful.layouts.suit.tile.left,
+
    awful.layouts.suit.tile.bottom,
+
    awful.layouts.suit.tile.top,
+
    awful.layouts.suit.fair,
+
    awful.layouts.suit.fair.horizontal,
+
    awful.layouts.suit.spiral,
+
    awful.layouts.suit.spiral.dwindle,
+
    awful.layouts.suit.max,
+
    awful.layouts.suit.max.fullscreen,
+
    awful.layouts.suit.magnifier
+
}
+
}}
+
 
+
These are the default layouts, but you can download some others and create your own. You probably won't do it now, however you might want to change the order. Personally, I don't like to have the floating layout as the default one.
+
 
+
I won't go further about this file, so I would suggest you to go on browsing this file to fetch interesting settings to change. I think one of the most important section you want to check out is "Key bindings". You will see all existing mappings and what they do. As an example, find the following lines at the beginning of the "{{{ Key bindings" section:
+
 
+
{{file|name=~/.config/awesome/rc.lua|lang=lua|body=
+
    awful.key({modkey,          },  "j",
+
        function()
+
            awful.client.focus.byidx( 1)
+
            if client.focus then client.focus:raise() end
+
        end),
+
    awful.key({modkey,          },  "k",
+
        function()
+
            awful.client.focus.byidx(-1)
+
            if client.focus then client.focus:raise() end
+
        end),
+
}}
+
 
+
This enables you to move the focus across the clients in this tag. You may be used to <code>Alt + Tab</code> and <code>Alt + Shift + Tab</code> for that. So why wouldn't you change it to suit what you are used to ?
+
 
+
{{file|name=~/.config/awesome/rc.lua|lang=lua|body=
+
    awful.key({"Mod1", "Shift"  },  "Tab", -- Notice the "Mod1" for Alt key instead of modkey (="Mod4")
+
        function()
+
            awful.client.focus.byidx( 1)
+
            if client.focus then client.focus:raise() end
+
        end),
+
    awful.key({"Mod1", "Shift"  },  "Tab",
+
        function()
+
            awful.client.focus.byidx(-1)
+
            if client.focus then client.focus:raise() end
+
        end),
+
}}
+
 
+
{{EbuildFooter}}
+

Revision as of 03:27, September 16, 2014

This is the "Ebuild" template. It should be called in the following format:

{{Ebuild
|Summary=
|CatPkg=
|Maintainer=
|Homepage=
}}

Edit the page to see the template text.