update for 2.1; remove docs
6
doc.mdwn
|
@ -1,6 +0,0 @@
|
||||||
Documentation for awesome.
|
|
||||||
|
|
||||||
* [Installation](install)
|
|
||||||
* [Setup](setup)
|
|
||||||
* [Uicb functions](uicb)
|
|
||||||
* [Developement](dev)
|
|
|
@ -1,9 +0,0 @@
|
||||||
Installing awesome is pretty straightforward:
|
|
||||||
|
|
||||||
tar xzvf awesome.tar.gz
|
|
||||||
cd awesome
|
|
||||||
make
|
|
||||||
make install
|
|
||||||
|
|
||||||
will install awesome in /usr/local.
|
|
||||||
Note that you'll need [`libconfuse`](http://www.nongnu.org/confuse/), X developement files and [`cairo`](http://cairographics.org/) installed first.
|
|
115
doc/setup.mdwn
|
@ -1,115 +0,0 @@
|
||||||
# Configuration
|
|
||||||
awesome is configured via the config file `~/.awesomerc`.
|
|
||||||
|
|
||||||
The file format should be self-explanatory. See the source for an example.
|
|
||||||
|
|
||||||
# Guided tour
|
|
||||||
|
|
||||||
In the following guided tour, we will assume that you are using the default configuration file.
|
|
||||||
*awesome* modkey is **Mod4** by default in order to not interact with other applications key bindings. You can change it as you want.
|
|
||||||
|
|
||||||
## First run
|
|
||||||
|
|
||||||
When running *awesome* for the first time, your workspace will be empty. Since we're assuming you want to do stuff with your computer, we're going to run a first client.
|
|
||||||
|
|
||||||
[[img screenshots/guided_tour/empty.png size="320x200"]]
|
|
||||||
|
|
||||||
Type **Mod4+Return** to run a terminal emulator.
|
|
||||||
|
|
||||||
[[img screenshots/guided_tour/term.png size="320x200"]]
|
|
||||||
|
|
||||||
This first client is tiled fullscreen since it's alone.
|
|
||||||
|
|
||||||
## Tiled mode
|
|
||||||
|
|
||||||
Now launch another terminal.
|
|
||||||
|
|
||||||
[[img screenshots/guided_tour/term2.png size="320x200"]]
|
|
||||||
|
|
||||||
You see that windows are automatically arranged.
|
|
||||||
Then run a third terminal.
|
|
||||||
|
|
||||||
[[img screenshots/guided_tour/term3.png size="320x200"]]
|
|
||||||
|
|
||||||
Again, windows are automagically arranged. As you can see, there's two windows on the
|
|
||||||
left (the master area) and one window on the right.
|
|
||||||
|
|
||||||
By default, *awesome* set the number of master windows to 2. That means that only 2 windows will be stacked in the master area. You can change this setting by pressing **Shift+Mod4+h** to increase it or **Shift+Mod4+l** to decrease it.
|
|
||||||
|
|
||||||
If you press now **Control+Mod4+l** to decrease it, windows will be arranged like this:
|
|
||||||
|
|
||||||
[[img screenshots/guided_tour/term4-nmaster1.png size="320x200"]]
|
|
||||||
|
|
||||||
There's now only one window in master area and two windows in the other area.
|
|
||||||
|
|
||||||
You can also change the number of colums for the non-master area. By pressing **Mod4+Control+h** you will increase the number of columns used, and will decrease it if you press **Mod4+Control+l**. By default *awesome* set the number of column to 1.
|
|
||||||
|
|
||||||
If you press **Mod4+Control+h** to switch to 2 column and windows will be arranged like this:
|
|
||||||
|
|
||||||
[[img screenshots/guided_tour/term4-nmaster1-col2.png size="320x200"]]
|
|
||||||
|
|
||||||
The size of the master area can be adjusted by setting the master width factor. By default this value is at 60 %. You can increase it by pressing **Mod4+h** or **Mod4+l** to decrease it.
|
|
||||||
|
|
||||||
If you decrease it like that, you will see that all windows size will be readjusted automatically:
|
|
||||||
|
|
||||||
[[img screenshots/guided_tour/term4-nmaster1-col2-mwfact.png size="320x200"]]
|
|
||||||
|
|
||||||
If you then run a new terminal, it will be put in master area and other windows will be rearrenged in column of the non-master area:
|
|
||||||
|
|
||||||
[[img screenshots/guided_tour/term4-nmaster1-col2-mwfact-newterm.png size="320x200"]]
|
|
||||||
|
|
||||||
## Layouts
|
|
||||||
|
|
||||||
You can switch layout by pressing **Mod4+Space**. If you press it one time, you will switch to the next layout, which is by default *tileleft*. It's like *tile* (the default layout) except that the master area is on the right.
|
|
||||||
|
|
||||||
[[img screenshots/guided_tour/tileleft.png size="320x200"]]
|
|
||||||
|
|
||||||
If you press it another time will switch to the *max* layout, where all windows are fullscreen.
|
|
||||||
|
|
||||||
[[img screenshots/guided_tour/max.png size="320x200"]]
|
|
||||||
|
|
||||||
Press it once again, and you will switch to the floating layout where you can move windows with **Mod4+Button1** and resize them with **Mod4+Button3**.
|
|
||||||
|
|
||||||
[[img screenshots/guided_tour/float.png size="320x200"]]
|
|
||||||
|
|
||||||
Note that in tiled layout you can move and resize windows. If you do this, they will become *floating* windows. Floating can be toggled by pressing **Mod4+Control+Space**.
|
|
||||||
|
|
||||||
## Ordering windows
|
|
||||||
|
|
||||||
You can order windows as you want.
|
|
||||||
|
|
||||||
You can use **Mod4+Shift+j** and **Mod4+Shift+k** to swap window with next or previous one.
|
|
||||||
|
|
||||||
[[img screenshots/guided_tour/swap1.png size="320x200"]]
|
|
||||||
|
|
||||||
If we focus xlogo and then press **Mod4+Shift+j** we will swap xlogo with the next xterm.
|
|
||||||
|
|
||||||
[[img screenshots/guided_tour/swap2.png size="320x200"]]
|
|
||||||
|
|
||||||
You can directly set a window as master by pressing **Mod4+Control+Return**.
|
|
||||||
|
|
||||||
[[img screenshots/guided_tour/zoom.png size="320x200"]]
|
|
||||||
|
|
||||||
You can focus next and previous window by pressing **Mod4+j** and **Mod4+k**.
|
|
||||||
|
|
||||||
## Tagging windows
|
|
||||||
|
|
||||||
*awesome* use a tag system instead of a virtual desktop model. Note that it can be used like virtual desktops, but it's a bit more powerful.
|
|
||||||
|
|
||||||
First, run a terminal in tag 1 (click on 1 in the status bar or press **Mod4+1**).
|
|
||||||
|
|
||||||
[[img screenshots/guided_tour/tag1.png size="320x200"]]
|
|
||||||
|
|
||||||
Then, go to tag 2 and run another terminal.
|
|
||||||
|
|
||||||
[[img screenshots/guided_tour/tag2.png size="320x200"]]
|
|
||||||
|
|
||||||
Finally, you can view both windows tagged with 1 and 2 by right clicking on 1 when you see tag 2 or by pressing **Mod4+Control+1**.
|
|
||||||
|
|
||||||
[[img screenshots/guided_tour/tag12.png size="320x200"]]
|
|
||||||
|
|
||||||
You can change windows tags with **Mod4+Shift+tag number**. You can also tag windows with several tags.
|
|
||||||
|
|
||||||
## More...
|
|
||||||
|
|
||||||
Read awesomerc file to discover all key bindings!
|
|
185
doc/uicb.mdwn
|
@ -1,185 +0,0 @@
|
||||||
[[toc levels=2]]
|
|
||||||
|
|
||||||
# What are uicb?
|
|
||||||
In *awesome*, a lot of functions are available. These functions are called **uicb** (User Interface Call Backs). Each function can be bound to a key shortcut or a mouse button.
|
|
||||||
|
|
||||||
# Uicb function list
|
|
||||||
|
|
||||||
## General
|
|
||||||
|
|
||||||
### quit
|
|
||||||
Syntax: quit
|
|
||||||
|
|
||||||
This function quits *awesome*.
|
|
||||||
|
|
||||||
### togglebar
|
|
||||||
|
|
||||||
Hide or show statusbar.
|
|
||||||
|
|
||||||
### spawn
|
|
||||||
Args: program
|
|
||||||
|
|
||||||
Execute an external program.
|
|
||||||
|
|
||||||
### exec
|
|
||||||
Args: program
|
|
||||||
|
|
||||||
Replace *awesome* with another window manager.
|
|
||||||
|
|
||||||
### reloadconfig
|
|
||||||
|
|
||||||
Reload configuration file.
|
|
||||||
|
|
||||||
### setstatustext
|
|
||||||
Args: text
|
|
||||||
|
|
||||||
Set status bar text.
|
|
||||||
|
|
||||||
## Client
|
|
||||||
|
|
||||||
### client_kill
|
|
||||||
|
|
||||||
This function closes the focused client.
|
|
||||||
|
|
||||||
### client_moveresize
|
|
||||||
Args: x y width height
|
|
||||||
|
|
||||||
This function allows to dynamically move and resize floating windows.
|
|
||||||
|
|
||||||
Coordinates can be relative or absolute. Relative values must begin with + or -.
|
|
||||||
|
|
||||||
For example, resizing a window to 200x200 without moving it will be done with:
|
|
||||||
|
|
||||||
"+0 +0 200 200"
|
|
||||||
|
|
||||||
To move a window 10 pixels up:
|
|
||||||
|
|
||||||
"+0 +10 +0 +0"
|
|
||||||
|
|
||||||
To move a window in the upper left corner and increase its width by 10px:
|
|
||||||
|
|
||||||
"0 0 +0 +10"
|
|
||||||
|
|
||||||
### client_settrans
|
|
||||||
Args: float
|
|
||||||
|
|
||||||
Set client transparency, number can be a relative or absolute floating number in percentage.
|
|
||||||
|
|
||||||
### client_swapnext
|
|
||||||
|
|
||||||
Swap window placement with the next displayed window.
|
|
||||||
|
|
||||||
### client_swapprev
|
|
||||||
|
|
||||||
Swap window placement with the previous displayed window.
|
|
||||||
|
|
||||||
### client_focusnext
|
|
||||||
|
|
||||||
Focus next window.
|
|
||||||
|
|
||||||
### client_focusprev
|
|
||||||
|
|
||||||
Focus previous window.
|
|
||||||
|
|
||||||
### client_togglemax
|
|
||||||
|
|
||||||
Set window fullscreen. Calling this function another time will reset the window to its previous state.
|
|
||||||
|
|
||||||
### client_togglehorizontalmax
|
|
||||||
|
|
||||||
Set window's horizontal size to display width. Calling this function another time will reset the window to its previous state.
|
|
||||||
|
|
||||||
### client_toggleverticalmax
|
|
||||||
|
|
||||||
Set window's vertical size to display height. Calling this function another time will reset the window to its previous state.
|
|
||||||
|
|
||||||
### client_togglefloating
|
|
||||||
|
|
||||||
Set window floating or tiled.
|
|
||||||
|
|
||||||
### client_zoom
|
|
||||||
|
|
||||||
Set window as master window.
|
|
||||||
|
|
||||||
### client_movetoscreen
|
|
||||||
Args: relative or absolute integer
|
|
||||||
|
|
||||||
Move focused window to the nth screen, or next (+1) or previous (-1). If no screen_number
|
|
||||||
is set, move to the next screen.
|
|
||||||
|
|
||||||
### client_tag
|
|
||||||
Args: tag number
|
|
||||||
|
|
||||||
Tag focused window with this tag.
|
|
||||||
|
|
||||||
### client_toggletag
|
|
||||||
Args: tag number
|
|
||||||
|
|
||||||
Add or remove tag to focused window.
|
|
||||||
|
|
||||||
### client_movemouse
|
|
||||||
|
|
||||||
Move client window with mouse.
|
|
||||||
|
|
||||||
### client_resizemouse
|
|
||||||
|
|
||||||
Resize client window with mouse.
|
|
||||||
|
|
||||||
## Tag
|
|
||||||
|
|
||||||
### tag_setlayout
|
|
||||||
Args: relative or absolute integer
|
|
||||||
|
|
||||||
Set layout number # or just switch to the next layout for current tag.
|
|
||||||
|
|
||||||
### tag_toggleview
|
|
||||||
Args: tag number
|
|
||||||
|
|
||||||
Add windows tagged with tag number to current display.
|
|
||||||
|
|
||||||
### tag_view
|
|
||||||
Args: tag number
|
|
||||||
|
|
||||||
View windows tagged with tag number.
|
|
||||||
|
|
||||||
### tag_viewnext
|
|
||||||
|
|
||||||
Show windows tagged with next tag in list.
|
|
||||||
|
|
||||||
### tag_viewprev
|
|
||||||
|
|
||||||
Show windows tagged with previous tag in list.
|
|
||||||
|
|
||||||
### tag\_viewprev\_selected
|
|
||||||
|
|
||||||
Switch back to the previously displayed set of tags.
|
|
||||||
|
|
||||||
### tag_setmwfact
|
|
||||||
Args: relative or absolute float
|
|
||||||
|
|
||||||
Set master width factor.
|
|
||||||
|
|
||||||
### tag_setncol
|
|
||||||
Args: relative or absolute integer
|
|
||||||
|
|
||||||
Set number of columns for non-master windows.
|
|
||||||
|
|
||||||
### tag_setnmaster
|
|
||||||
Args: relative or absolute integer
|
|
||||||
|
|
||||||
Set number of master windows.
|
|
||||||
|
|
||||||
## Screen
|
|
||||||
|
|
||||||
### screen_focusnext
|
|
||||||
|
|
||||||
Focus first window in the next screen and move mouse.
|
|
||||||
|
|
||||||
### screen_focusprev
|
|
||||||
|
|
||||||
Focus first window in the previous screen and move mouse.
|
|
||||||
|
|
||||||
### setborder
|
|
||||||
Args: relative or absolute integer
|
|
||||||
|
|
||||||
Set default border size in pixels for new clients.
|
|
11
index.mdwn
|
@ -2,10 +2,11 @@
|
||||||
awesome is a tiling window manager initialy based on a [dwm](http://www.suckless.org/wiki/dwm) code rewriting.
|
awesome is a tiling window manager initialy based on a [dwm](http://www.suckless.org/wiki/dwm) code rewriting.
|
||||||
It's extremely fast, small, dynamic and awesome.
|
It's extremely fast, small, dynamic and awesome.
|
||||||
|
|
||||||
Windows can be managed in several layouts: tiled, maximized and floating.
|
Windows can be managed in several layouts: tiled, maximized, dwindle, spiral, floating…
|
||||||
Each layout can be applied on the fly, optimizing the environment for the application in use and the task performed.
|
Each layout can be applied on the fly, optimizing the environment for the application in use and the task performed.
|
||||||
|
|
||||||
Managing windows in tiled mode assures that no space will be wasted on your screen. No gaps, no overlap.
|
Managing windows in tiled mode assures that no space will be wasted on your screen. No gaps, no overlap.
|
||||||
|
Other layouts can be used for different purpose.
|
||||||
|
|
||||||
## Tiled layout
|
## Tiled layout
|
||||||
With tiled layout, windows are managed in a master and a stacking area.
|
With tiled layout, windows are managed in a master and a stacking area.
|
||||||
|
@ -27,8 +28,8 @@ Tags can be compared to virtual desktops, but it's more powerful: you can quickl
|
||||||
and go back to only one tag after.
|
and go back to only one tag after.
|
||||||
|
|
||||||
## Status bar
|
## Status bar
|
||||||
awesome contains a small status bar which displays all available tags, the layout, the title of the focused window, and text.
|
awesome contains a small status bar which can contain a lot of widget: display all available tags, the current layout, tasklists, texts, icons, graphs, progress bars. Each widget can have its own mouse bindings.
|
||||||
The selected tags are highlighted with a different color, while the tags of the focused window are highlighted with a small point.
|
|
||||||
*awesome* draws a small border around windows to indicate their focus state.
|
*awesome* draws a small border around windows to indicate their focus state.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
@ -44,7 +45,7 @@ In contrast to ion, larswm, wmii, or dwm, awesome is much, pick 2 from that list
|
||||||
* Some real transparency support (using Composite extension and xcompmgr for now).
|
* Some real transparency support (using Composite extension and xcompmgr for now).
|
||||||
* Some XRandR support.
|
* Some XRandR support.
|
||||||
* No Lua integration, no 9P support, no editable tagbars.
|
* No Lua integration, no 9P support, no editable tagbars.
|
||||||
* No limit on its source size, *awesome* has features we want.
|
* No limit on its source size: *awesome* has features we want.
|
||||||
* Doesn't distinguish between layers: there is no floating or tiled layer. Whether or not the clients of currently selected tag(s) are in tiled layout, you can rearrange them on the fly. Popup and fixed-size windows are always floating, however.
|
* Doesn't distinguish between layers: there is no floating or tiled layer. Whether or not the clients of currently selected tag(s) are in tiled layout, you can rearrange them on the fly. Popup and fixed-size windows are always floating, however.
|
||||||
* Customized through editing a configuration file, which makes it extremely easy to configure. You don't have to learn Lua/sh/ruby or some weird configuration file format (like X resource files), or recompile source code each time you do something:, just edit the configuration file, for god's sake.
|
* Customized through editing a configuration file, which makes it extremely easy to configure. You don't have to learn Lua/sh/ruby or some weird configuration file format (like X resource files), or recompile source code each time you do something:, just edit the configuration file, for god's sake.
|
||||||
* Each function for manipulating environment is bindable to keys shortcut, mouse buttons or executable remotely via awesome-client.
|
* Each function for manipulating environment is bindable to keys shortcut, mouse buttons or executable remotely via *awesome-client*.
|
||||||
|
|
Before Width: | Height: | Size: 737 KiB |
Before Width: | Height: | Size: 89 KiB |
Before Width: | Height: | Size: 7.8 KiB |
Before Width: | Height: | Size: 223 KiB |
Before Width: | Height: | Size: 215 KiB |
Before Width: | Height: | Size: 9.3 KiB |
Before Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 9.3 KiB |
Before Width: | Height: | Size: 9.1 KiB |
Before Width: | Height: | Size: 9.8 KiB |
Before Width: | Height: | Size: 9.9 KiB |
Before Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 9.5 KiB |
Before Width: | Height: | Size: 8.9 KiB |
Before Width: | Height: | Size: 9.7 KiB |
Before Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 138 KiB |
|
@ -22,7 +22,6 @@
|
||||||
<li><a href="/community/">community</a></li>
|
<li><a href="/community/">community</a></li>
|
||||||
<li><a href="/screenshots/">screenshots</a></li>
|
<li><a href="/screenshots/">screenshots</a></li>
|
||||||
<li><a href="/devel/">devel</a></li>
|
<li><a href="/devel/">devel</a></li>
|
||||||
<li><a href="/doc/">documentation</a></li>
|
|
||||||
<li><a href="/download/">download</a></li>
|
<li><a href="/download/">download</a></li>
|
||||||
<li><a href="/news/">news</a></li>
|
<li><a href="/news/">news</a></li>
|
||||||
<li><a href="/">about</a></li>
|
<li><a href="/">about</a></li>
|
||||||
|
|