diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..3222c32 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,42 @@ + +**amiwm** is Copyright 1995-2011 by Marcus Comstedt + +Amiga, AmigaOS and Workbench are registered trademarks of +AMIGA International Inc. + +# Generic amiwm License + + +This license applies to whomever receives this file. It is a generic +license to use and distribute amiwm. If you want to acquire the software +under a different license, please contact the author. This license is +in part based on the XV license by John Bradley. + +Permission to copy and distribute amiwm in its entirety, for +non-commercial purposes, is hereby granted without fee, provided +that this license information and copyright notice appear in all copies. + +If you redistribute amiwm, the *entire* contents of this distribution +must be distributed, including the README.md and LICENSE.md files, +the sources, and the various scripts and Makefiles. + +You may distribute binaries built from the unmodified amiwm sources, for +non-commercial purposes, provided that the entire amiwm source distribution +is also included, as per the preceding paragraph. + +You may distribute amiwm as a component of an aggregate software +distribution, provided that no other condition of this license is violated. +In particular, the entire amiwm distribution must be included in the +aggregate software distribution. + +Unrestricted use of the software is also hereby granted without fee. +Distribution and modification of source or binaries are not considered use +and explicitly covered by other paragraphs of this license. + +The software may be modified for your own purposes, but modified versions +may not be distributed without prior consent of the author. You may +freely distribute patches against the unmodified source code. + +This software is provided 'as-is', without any express or implied +warranty. In no event will the author be held liable for any damages +arising from the use of this software. \ No newline at end of file diff --git a/MODULES.md b/MODULES.md new file mode 100644 index 0000000..5f476e3 --- /dev/null +++ b/MODULES.md @@ -0,0 +1,64 @@ +## Background module + +To get background images on your screens, use the Background module. +The Module command should come after the Screen command, and the +initstring should be the filename of the picture. Example: + +Screen "My Screen" +Module "Background" "~/megumin.png" + +The Background module is really a shell script that requires the +program 'display' from imagemagick package. Currently, it doesn't +support any standard imagemagick parameters. + +## Keyboard module + +With the Keyboard module, you can bind window manager functions to keys +on the keyboard. The initstring should consist of keybindings on the +form + +modifiers:where:func + +### modifiers + +Modifiers is 0 or more of: + Shift Control Meta Lock + Mod1 Mod2 Mod3 Mod4 Mod5 + Button1 Button2 Button3 Button4 Button5 + +The modifiers listed must be pressed together with the key to activate +the binding. + +### keysym + +Keysym is a standard X keysym name, like F1 or Prior. + +### where + +where is either "all", or one or more of window, frame, icon, root +separated with '|' (bar). This controls in what areas of the screen +that the key will be active. + +### func + + +The function to perform when the key is pressed. +Currently the following are defined: + +rotatescreens - Move the frontmost screen to the back +front - Move the window in which the key is pressed to the front +back - Move the window in which the key is pressed to the back +iconify - Iconify the window in which the key is pressed + + +#### Example + +Module "Keyboard" "\ + Meta:window|frame:front\ + Meta:window|frame:iconify\ + Meta:window|frame:back" + +This binds the keys Meta-F1, Meta-F2 and Meta-F3 to front, back and +iconify respectively. The will only have effect inside windows and in +window frames. (These are the only places that front/iconfy/back has +effect anyway.) diff --git a/README.md b/README.md index 9c7ec74..82aa0c1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,49 @@ # amiwm -Amiga Workbench-like Window Manager for Xorg \ No newline at end of file +Amiga Workbench inspired window manager for Xorg. + +## Getting started +Before compiling, make sure that you have following packages installed: + +``` +gcc make autoconf xorg xorg-xinit +``` + +First, run configuration script: + +``` +./configure +``` + +After that, you can either edit the Makefile, or leave it as is. After that, compile and install amiwm using + +``` +make +sudo make install +``` + +Hopefully, your compilation was succesfull - now you should have amiwm installed! + +## Launching amiwm +To launch amiwm, use + +``` +startx amiwm +``` + +Or add "amiwm" to your xinitrc file + +## Configuration +Configuration utility is not yet available; To configure amiwm, you'll need +to create and edit .amiwmrc file in your home directory. To do so, read +amiwm's manpage. + +## Authors +Originally created by **Marcus Comstedt**; +Contributions by +* Scott Lawrence +* Nicolas Sipieter +* redsPL. + +## License +This project is published under a custom license - see [LICENSE.md](LICENSE.md) for details. +Amiga, AmigaOS and Workbench are registered trademarks of AMIGA International Inc. \ No newline at end of file