Private fork of https://github.com/awesomeWM/awesome
27bc445664
Documenting half of the Lua API in the awesomerc manpage and the other half with luadoc, doesn't make much sense. I modified the output of gendoc.lua to something that looks like lua with luadoc markup. That file can then be processed by luadoc and we have all Lua documentation in one place. And yes, we're now pulling custom doxygen tags out of C source code to generate annotated lua source code we never use, which is then mangled again by luadoc to spit out a set of html files. |
||
|---|---|---|
| build-utils | ||
| common | ||
| icons | ||
| layouts | ||
| lib | ||
| widgets | ||
| .gitignore | ||
| AUTHORS | ||
| BUGS | ||
| CMakeLists.txt | ||
| LICENSE | ||
| README | ||
| STYLE | ||
| awesome-client.1.txt | ||
| awesome-client.c | ||
| awesome-version-internal.h.in | ||
| awesome.1.txt | ||
| awesome.c | ||
| awesome.doxygen.in | ||
| awesomeConfig.cmake | ||
| awesomerc.5.txt | ||
| awesomerc.lua.in | ||
| client.c | ||
| client.h | ||
| cnode.c | ||
| cnode.h | ||
| config.h.in | ||
| dbus.c | ||
| dbus.h | ||
| event.c | ||
| event.h | ||
| ewmh.c | ||
| ewmh.h | ||
| focus.c | ||
| focus.h | ||
| keybinding.c | ||
| keygrabber.c | ||
| keygrabber.h | ||
| layout.c | ||
| layout.h | ||
| lua.c | ||
| lua.h | ||
| mouse.c | ||
| mouse.h | ||
| placement.c | ||
| placement.h | ||
| screen.c | ||
| screen.h | ||
| stack.c | ||
| stack.h | ||
| statusbar.c | ||
| statusbar.h | ||
| structs.h | ||
| systray.c | ||
| systray.h | ||
| tag.c | ||
| tag.h | ||
| titlebar.c | ||
| titlebar.h | ||
| widget.c | ||
| widget.h | ||
| window.c | ||
| window.h | ||
README
awesome
=======
awesome is an extremely fast, small, and dynamic window manager for X.
Requirements
------------
In order to build awesome itself, you need header files and libs of:
- Xlib, xcb and xcb-util.
- Lua 5.1
- cairo
- pango and pangocairo
- libev
- glib
- GdkPixBuf or Imlib2 (use --with-imlib2 with ./configure)
- dbus (optional, use --with-dbus=no with ./configure to disable)
- gperf
In order to build the awesome man pages, you need these tools:
- asciidoc (recent version)
- xmlto (recent version)
- docbook XSL stylesheets
In order to build the source code reference, you need these tools:
- doxygen
- graphviz
Building and Installation
-------------------------
If building from git sources, run "./autogen.sh". When autoreconf has
finished, you can follow the following instructions for building a dist
tarball.
After extracting the dist tarball, run "./configure --help" and figure out
what you might want to adapt for your system. Then run ./configure with the
proper parameters, and build and install:
./configure [...]
make
make install # might need root permissions
If you're using gcc as your compiler and do not want awesome's default set
of warning flags, add AWESOME_CFLAGS="" to your "make" lines.
The source code reference can be built with "make doc".
Running awesome
-----------
Add the following line to your .xinitrc to start awesome using startx
or to .xsession to start awesome using gdm/kdm/xdm...:
exec awesome
In order to connect awesome to a specific display, make sure that
the DISPLAY environment variable is set correctly, e.g.:
DISPLAY=foo.bar:1 exec awesome
(This will start awesome on display :1 of the host foo.bar.)
Configuration
-------------
The configuration of awesome is done by creating a ~/.awesomerc.lua file.
An example is provided in the sources.