/usr/share/awesome/lib/flaw/flaw.7 is in awesome-extra 2012061101.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | .\" Process this file with
.\" groff -t -mandoc -Tascii flaw.7 | less
.\"
.TH flaw 7 "FEBRUARY 2009"
.SH NAME
flaw \- a Lua OO management framework for awesome WM widgets
.SH DESCRIPTION
.B flaw
stands for Fully Loaded AWesome. It is a LUA object oriented library
providing a thin abstraction layer above awesome widgets. It is aimed
at being simple and resources efficient.
.sp
To achieve these goals,
.B flaw
provides the following concepts.
.IP gadgets
To add functionality to awesome widgets,
.B flaw
defines gadget objects, which are a wrapper around a widget. All
gadgets have properties, events, a refresh mechanism and a data
provider (see below). Gadgets can wrap all awesome widget type,
namely text boxes, image boxes, graphs or progress bars.
.B flaw
provides many gadgets for common system information (like CPU or
memory activity).
.IP provider
.B flaw
tries to minimise system access and data refresh. Since all
information do not have the same expiration rate, all gadgets refresh
independently. And since some gadgets can share information, all data
is provided by providers which can be shared among gadgets. Providers
maintain status data from the system and refreshes only when necessary
(ie. when the gadget with the shortest refresh rate demands it).
.IP events
Events are a way for the user to modify the gadget behaviour or
properties when some conditions are met. An event is composed of a
trigger, which computes the condition, and an action. Event triggers
are tested by the providers only when data changes. Both the
condition and the action are provided by the user.
.SH USAGE
.B flaw
depends on the
.RB lua-filesystem
package which can be found
.IR http://luaforge.net/projects/luafilesystem .
Once installed, the following statement must be inserted in awesome
configuration before any
.B flaw
gadget or mechanism is used.
.RS
\f(CWrequire('flaw')\fP
.RE
.PP
Using
.B flaw
consists in creating gadgets, passing them parameters to customize their
display and events to add some behaviour to them, and then adding them
in a wibox like any other awesome widget.
.B flaw
and awful gadgets can live together. The complete
.B flaw
documentation is available in Luadoc format. Enter the following command to generate it.
.RS
\f(CWLUA_PATH="path_toflaw/doclet/html/?;;" luadoc -d html --nofiles *.lua\fP
.RE
.SH DIAGNOSTICS
.B flaw
tries to recover upon bad invocations. When something wrong occurs, it
outputs warning or error messages to stderr (for example, if awesome
was started with xsession, output will be found in
.I ~/.xsession-errors
).
.SH BUGS
Certainly a lot.
.SH AUTHOR
David Soulayrol <david.soulayrol at gmail dot net>
.SH "SEE ALSO"
.BR awesome (1),
.BR awesome-client (1),
.BR awesomerc (5)
|