Sawfish
(Added links to current docs on rep internals and modules/extensions)
(No difference)

Revision as of 14:25, 13 July 2007

For more information see the included README file. All changes are listed in the NEWS file. The FAQ answers some of the most frequent questions people have asked.

Derek Upham has updated the sawfish programming manual. His version is available from http://home.blarg.net/~sand/sawfish/ and also the original version is available from http://sawmill.sourceforge.net/prog-manual.html

Tutorial

Eric Mangold provides us with a nice tutorial for customizing Sawfish -- for newbies and advanced users alike! http://twistedmatrix.com/~teratorn/better_wm/better_wm.html



Window History

To add window-history back to sawfish 1.3, add (require 'sawfish.wm.ext.window-history) to your sawfish.rc file, and restart sawfish.

Viewports

Viewports were removed from Sawfish sometime after 1.0.1, apparently because of some ostensible usability problems with the whole concept (?? -- can anybody fill in here? I guess the Gnome folks had something with that to do). Anyway, http://article.gmane.org/gmane.comp.window-managers.sawfish:3075 attempts to explain how to put them back.



I've updated the TeXinfo documentation to reflect the DEFUNs and DEFVARs implemented in C, and some of the most common Lisp functions in Sawfish 1.3. You can take a look at the HTML, or download it in Info or TeXinfo, or get a patch file against the original source at http://www.blarg.net/~sand/sawfish/.

Documentation Wanted!

If you would like to see documentation on a specific topic related to sawfish or librep, please add a paragraph or two here. Describe the topic and outline what items should be covered. Please indicate why this documentation would be important to you.

Librep internals

How to write a librep C modules is not documented. The documentation would have the API, the conventions and an skeleton example with a tutorial of sorts. The example would have all the other helper code like Makefiles and directory structure laid out. The reason for this documentation is so that new X protocols (and OpenGL) modules can be created.

Current Docs:

Composite Extension, OpenGL and friends

Ostensibly the future of sawfish is have access to the new protocols. One key to implementing is understanding what they do and how they are supposed to be interacted with. To start these pages can be nothing more than links to the specs and basic tutorials.

Current Docs:

Sawfish event system

To aid in development and understanding, There needs to be documentation the X event model and how Sawfish interacts and deals with it.