Difference between revisions of "Package:Awesome (Window Manager)"

From Funtoo
Jump to: navigation, search
m (Forgot |body=)
(Work still in progress)
Line 8: Line 8:
 
== About Awesome ==
 
== About Awesome ==
  
Awesome is a highly configurable window manager. It handles both '''tiling and floating''' layouts. You can go into a '''fine-grained customization''' to suit your needs with '''Lua scripting'''.
+
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''.
  
 
=== Vocabulary ===
 
=== Vocabulary ===
Line 15: Line 15:
 
;Client: A window.
 
;Client: A window.
 
;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.
 
;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.
 +
;Layout: A layout is a way to arrange your ''clients'' in the current tag (eg. floating, horizontaly tiled, verticaly tiled, focused client full-screen, ...)
 +
;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''.
  
 
== USE flags ==
 
== USE flags ==
Line 31: Line 33:
 
== Installation ==
 
== Installation ==
  
Just emerge it :
+
Just emerge it:
  
 
<console>
 
<console>
Line 37: Line 39:
 
</console>
 
</console>
  
Then you can add this line to you <code>~/.xinitrc</code>:
+
Then you can add this line to your <code>~/.xinitrc</code>:
  
 
{{file|name=~/.xinitrc|body=
 
{{file|name=~/.xinitrc|body=
Line 44: Line 46:
  
 
And run <code>xinit</code> to launch awesome. You can also configure a display manager instead, but this is not covered in this document.
 
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 ==
 +
 +
{{fancynote|A quick introduction to awesome basics and key bindings will be described here soon.}}
  
 
== Configuration ==
 
== 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|A quick introduction to awesome configuration will be described here soon.}}
  
 
{{EbuildFooter}}
 
{{EbuildFooter}}

Revision as of 17:57, August 22, 2014

Awesome (Window Manager)

   Tip

We welcome improvements to this page. To edit this page, Create a Funtoo account. Then log in and then click here to edit this page. See our editing guidelines to becoming a wiki-editing pro.


About Awesome

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.

Vocabulary

Screen
A physical monitor plugged into your computer.
Client
A window.
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.
Layout
A layout is a way to arrange your clients in the current tag (eg. floating, horizontaly tiled, verticaly tiled, focused client full-screen, ...)
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.

USE flags

Name Description
dbus Enables awesome to receive signals from dbus (eg. to trigger events on hotplug)
doc Includes extra HTML documentation (using doxygen)
gnome Enables you to use awesome as gnome's window manager (See. Quickly Setting up Awesome with Gnome)

Installation

Just emerge it:

root # emerge -a awesome

Then you can add this line to your ~/.xinitrc:

   ~/.xinitrc
exec ck-launch-session dbus-launch --sh-syntax --exit-with-session awesome

And run xinit to launch awesome. You can also configure a display manager instead, but this is not covered in this document.

Getting Started

   Note

A quick introduction to awesome basics and key bindings will be described here soon.

Configuration

Awesome user configuration files are located in ~/.config/awesome/. For now, a single file called rc.lua 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.

   Note

A quick introduction to awesome configuration will be described here soon.