gryf/wmaker
1
0
Fork 0
mirror of https://github.com/gryf/wmaker.git synced 2025-12-19 12:28:22 +01:00
Code Issues Projects Releases Wiki Activity

Updated documentation

Browse Source 
Updated URIs
Removed stale/outdated information
Reformatted for 80 columns
This commit is contained in:
John H. Robinson, IV
2009-09-24 14:10:57 -07:00
committed by Carlos R. Mafra
parent bc3995bf6b
commit 21eb8456ba
5 changed files with 127 additions and 167 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
BUGFORM
View File

@@ -4,11 +4,11 @@
If you find a bug please fill this form and send it to If you find a bug please fill this form and send it to
developers@windowmaker.info Please, USE THIS FORM!!! wmaker-dev@lists.windowmaker.org Please, USE THIS FORM!!!
You can also report a bug in the WWW bug tracker at You can also report a bug in the WWW bug tracker at
http://windowmaker.info/cgi-bin/bugs or by sending this report http://bugs.windowmaker.org/projects/wmaker/issues or by sending this report to
to bugs@windowmaker.info bugs@windowmaker.org
0. Before reporting this bug I already: 0. Before reporting this bug I already:

63
FAQ
View File

@@ -143,10 +143,9 @@ here for example screenshots.
1.2 Where can I get Window Maker? 1.2 Where can I get Window Maker?
---------------------------------- ----------------------------------
The official site to get new developmental versions from is The official site to get new developmental versions from is
ftp://ftp.windowmaker.info/pub/beta/srcs/. http://windowmaker.org/pub/source/beta/
NOTE: Also see http://wm.current.nu/downloads.html for the latest The mercurial repository is available at https://hg.windowmaker.org/wmaker
Stable and Development versions.
The development versions are usually very stable themselves, so if you The development versions are usually very stable themselves, so if you
want to have all the newest features, you can rather safetly go with the want to have all the newest features, you can rather safetly go with the
@@ -158,23 +157,15 @@ crash.
1.3 Where are the mailing list archives? 1.3 Where are the mailing list archives?
---------------------------------------- ----------------------------------------
Phillip Smith from Netplex, our wonderful provider of windowmaker.info, has Please read the information on the web pages at http://lists.windowmaker.org/
set up some new lists from the domain. Please read the information on the for information on how to subscribe, the posting guidelines, and how to access
web pages at http://www.windowmaker.info/lists.html for information on how the web archives.
to subscribe, the posting guidelines, and how to access the web archives.
Many thanks to Ed Orcutt who hosted the original lists from his own machine
for many years and Caldera who graciously allowed Ed to continue hosting
from them when he moved to his new position with them. Ed provided a very
valuable service for many years and we are sad to see him go.
1.4 Where is more documentation on configuring Window Maker? 1.4 Where is more documentation on configuring Window Maker?
---------------------------------- ----------------------------------
Besides the mailing list archives, there are nice documents in Besides the mailing list archives, there are nice documents in
ftp://ftp.windowmaker.info/pub/docs/, at http://windowmaker.org/documentation.php
http://wm.current.nu/downloads.html on my download page and at
http://wm.current.nu/user-guide/index.htm in the online user-guide.
1.5 What is an appicon? 1.5 What is an appicon?
@@ -182,51 +173,33 @@ http://wm.current.nu/user-guide/index.htm in the online user-guide.
An appicon is the icon (without the tiny titlebar a minimized application icon An appicon is the icon (without the tiny titlebar a minimized application icon
has) produced by most applications that initially is in the bottom left corner has) produced by most applications that initially is in the bottom left corner
of the screen while an application is running. For an example, run xterm and of the screen while an application is running. For an example, run xterm and
notice the icon in the corner. (Make sure that you use xterm and not a notice the icon in the corner.
default older rxvt because older versions of rxvt do not properly set their
window attributes.)
1.6. How can I get a question added to the FAQ? 1.6. How can I get a question added to the FAQ?
---------------------------------- ----------------------------------
Right now, the only method is to mail Chris Green <sprout@dok.org> or Ask on the mailing list, or send your request to faqs@windowmaker.org
myself <largo@current.nu> the question or post it on the Window Maker
Mailing list, and see if enough people have the same problem.
If you are a developer and would like to be able to edit the official FAQ on Other avenues are the Window Maker wiki
Chris's site, let him know at <sprout@dok.org> http://bugs.windowmaker.org/projects/wmaker/wiki
and the forums
He is currently pondering writing a front end that allows everyone to add http://bugs.windowmaker.org/projects/wmaker/boards
entries and only require a moderator approval before being posted.
1.7. How do I report bugs? 1.7. How do I report bugs?
---------------------------------- ----------------------------------
You can look at the BUGFORM file in your tarball of Window Maker. You can look at the BUGFORM file in your tarball of Window Maker.
Alternatively, you can use the Window Maker Bugtracker at Alternatively, you can use the Window Maker Bugtracker at
http://windowmaker.info/cgi-bin/bugs. http://bugs.windowmaker.org/projects/wmaker/issues
1.8. Is there an anomymous cvs server? 1.8. Is there a public source code repository?
---------------------------------- ----------------------------------
Yes there is. To check out from cvs, first Yes there is. To check out from mercurial use:
hg clone http://hg.windowmaker.org/wmaker wmaker
export CVSROOT=":pserver:anoncvs@cvs.net-community.com:/gnustep"
cvs login
'anoncvs' is the password.
Then issue the command. "wm" is the name of the module.
cvs -z3 checkout -d WindowMaker wm
To update your source tree, cd to the WindowMaker directory and type
cvs -z3 update
inside the WindowMaker directory.
To update your source tree, cd to the wmaker directory and type
hg pull

9
INSTALL
View File

@@ -372,11 +372,10 @@ Installing the extras package
Unpack WindowMaker-extra-<version-number>.tar.gz in /usr/local/share Unpack WindowMaker-extra-<version-number>.tar.gz in /usr/local/share
You can get the file at ftp://ftp.windowmaker.info. This file is optional You can get the file at http://windowmaker.org/pub/source/release/. This file
and only have a few icons, and themes. Look for the latest <version-number> is optional and only have a few icons, and themes. Look for the latest
available. <version-number> available. Also there is a WindowMaker-extra.readme to
Also there is a WindowMaker-extra.readme to instruct you where that package instruct you where that package should go.
should go.

2
MIRRORS
View File

@@ -4,7 +4,7 @@ Window Maker FTP Mirror Sites
Official Site (USA): Official Site (USA):
-------------------- --------------------
ftp://ftp.windowmaker.info/ http://windowmaker.org/pub/source/release/
Australia: Australia:

208
README
View File

@@ -4,8 +4,7 @@
GNU Window Maker GNU Window Maker
X11 Window Manager X11 Window Manager
<http://windowmaker.info> <http://windowmaker.org>
<ftp://ftp.windowmaker.info>
by by
@@ -41,26 +40,25 @@
Description Description
=========== ===========
Window Maker is the GNU window manager for the X Window System. It was Window Maker is the GNU window manager for the X Window System. It was designed
designed to emulate the look and feel of part of the NEXTSTEP(tm) GUI. It's to emulate the look and feel of part of the NEXTSTEP(tm) GUI. It's supposed to
supposed to be relatively fast and small, feature rich, easy to configure and be relatively fast and small, feature rich, easy to configure and easy to use,
easy to use, with a simple and elegant appearance borrowed from NEXTSTEP(tm). with a simple and elegant appearance borrowed from NEXTSTEP(tm).
Window Maker was designed keeping integration with GNUstep in mind and is the Window Maker was designed keeping integration with GNUstep in mind and is the
"official" window manager for it. It is also part of the GNU project "official" window manager for it. It is also part of the GNU project
(www.gnu.org) Read more about GNUstep further on this file. (www.gnu.org) Read more about GNUstep further on this file.
Hints (information given by applications to integrate well with the window Hints (information given by applications to integrate well with the window
manager) for Motif(tm) and NETWM are also supported (NETWM is used by KDE manager) for Motif(tm) and NETWM are also supported (NETWM is used by KDE and
and GNOME, so they are automatically supported as a result). GNOME, so they are automatically supported as a result). So you can replace any
So you can replace any of the window managers for these environments of the window managers for these environments with Window Maker while keeping
with Window Maker while keeping most, if not all, of the native window manager most, if not all, of the native window manager functionality.
functionality.
Window Maker was previously called WindowMaker. Window Maker was previously called WindowMaker.
Window Maker has no connection with Windowmaker, the software for Window Maker has no connection with Windowmaker, the software for making windows
making windows and doors. and doors.
Documentation Documentation
@@ -72,8 +70,8 @@ Read before asking.
in the directories. in the directories.
* INSTALL has installation instructions and some troubleshooting tips. * INSTALL has installation instructions and some troubleshooting tips.
You're meant to read it before installing. it was not written just to You're meant to read it before installing. it was not written just to fill up
fill up space in the package... space in the package.
* FAQ: Frequently Asked Questions. READ IT!!! FAQ.I18N is for * FAQ: Frequently Asked Questions. READ IT!!! FAQ.I18N is for
internationalization related questions. internationalization related questions.
@@ -88,7 +86,6 @@ including platform specific packages of Window Maker.
* ChangeLog: what changed from the previous version? * ChangeLog: what changed from the previous version?
* BUGS: list of known bugs * BUGS: list of known bugs
*** Tutorial *** Tutorial
@@ -102,8 +99,6 @@ http://www.linuxfocus.org/~georges.t/
The Window Maker User's Guide can be downloaded from the official ftp The Window Maker User's Guide can be downloaded from the official ftp
or web sites. or web sites.
It can also be viewed in HTML format in:
http://people.delphi.com/crc3419/WMUserGuide/index.htm
The User Guide explains how to use Window Maker, the configuration files The User Guide explains how to use Window Maker, the configuration files
and options. and options.
@@ -119,29 +114,29 @@ Directories & Files in the Source Tree
====================================== ======================================
* Install is a script for configuring and compiling Window Maker in a easy * Install is a script for configuring and compiling Window Maker in a easy
way (not that the normal way is difficult, but...). way (not that the normal way is difficult, but...).
* AUTHORS: the credits * AUTHORS: the credits
* TODO: plans for the future * TODO: plans for the future
* contrib/ has some contributed patches that are not supported by Window Maker * contrib/ has some contributed patches that are not supported by Window Maker
because they conflict with design filosophies of the developers or some because they conflict with design philosophies of the developers or some other
other reason. reason.
* util/ has various utility programs. * util/ has various utility programs.
* WPrefs.app/ is the configuration program. * WPrefs.app/ is the configuration program.
* src/wconfig.h has compile time options you can change to select some * src/wconfig.h has compile time options you can change to select some
options/features and other stuff. options/features and other stuff.
* WINGs/ NEXTSTEP lookalike widget library * WINGs/ NEXTSTEP lookalike widget library
* wrlib/ image processing library * wrlib/ image processing library
* po/ has message catalogs wich are the translated versions of the messages * po/ has message catalogs wich are the translated versions of the messages
displayed by Window Maker. displayed by Window Maker.
* docklib-x.x.tar.gz a library for writing dockapps * docklib-x.x.tar.gz a library for writing dockapps
@@ -150,71 +145,68 @@ HELP ME!!!
========== ==========
There is a mailing list for discussing Window Maker at There is a mailing list for discussing Window Maker at
wm-user@windowmaker.info To subscribe to it, send a message containing: wmaker-user@ilists.windowmaker.org To subscribe to it, send a message to
subscribe wmaker-user-subscribe@lists.windowmaker.info
in the subject of the message to wm-user-request@windowmaker.info
If you got a problem, ask there (after reading the docs, of course). The If you got a problem, ask there (after reading the docs, of course). The people
people there is more likely to be able to answer your questions than we are. there is more likely to be able to answer your questions than we are. For bug
For bug reports use the BUGFORM. reports use the BUGFORM.
If you have a problem with a precompiled version of Window Maker If you have a problem with a precompiled version of Window Maker (rpm, deb etc),
(rpm, deb etc), first ask the person who made the package. first ask the person who made the package.
IMPORTANT NOTE: when asking for help (in the mailing list or to the IMPORTANT NOTE: when asking for help (in the mailing list or to the developerts,
developerts, directly) *always* send information about the system you are directly) *always* send information about the system you are using. You can use
using. You can use the system information section at the end of BUGFORM as a the system information section at the end of BUGFORM as a guideline. Another
guideline. Another thing: please don't send HTML mail. thing: please don't send HTML mail.
There is also a #windowmaker IRC channel at openprojects. To join there, There is also a #windowmaker IRC channel at freenode. To join there, connect
connect your irc client to irc.openprojects.net, irc.linux.com or some other your irc client to irc.freenode.net. irc.windowmaker.org will direct you to the
server of that network. correct IRC network.
GNUstep GNUstep
======= =======
GNUstep is a complete object-oriented development system, based on the GNUstep is a complete object-oriented development system, based on the OpenStep
OpenStep specification released by NeXT(tm) (now Apple(tm)) and Sun(tm). It specification released by NeXT(tm) (now Apple(tm)) and Sun(tm). It will provide
will provide everything one needs to produce cross-platform, object-oriented, everything one needs to produce cross-platform, object-oriented, graphical (and
graphical (and non-graphical) applications; providing among other things, non-graphical) applications; providing among other things, base system
base system libraries, a high-level GUI application framework that uses a libraries, a high-level GUI application framework that uses a Display
Display PostScript(tm)-like imaging model (DGS), objects for accessing PostScript(tm)-like imaging model (DGS), objects for accessing relational
relational databases, distributed objects and a graphical development databases, distributed objects and a graphical development environment, with
environment, with tools like interface modeller, a project management system tools like interface modeller, a project management system (project center) and
(project center) and other tools. other tools.
The GNUstep development system will be used to create a user environment, The GNUstep development system will be used to create a user environment, with
with everything needed for a complete graphical user interface, such as a everything needed for a complete graphical user interface, such as a file
file viewer, text editors and other applications. Note that the user viewer, text editors and other applications. Note that the user environment (or
environment (or "desktop environment") is only a small part of the whole "desktop environment") is only a small part of the whole GNUstep project and
GNUstep project and therefore it does not "compete" with other projects like therefore it does not "compete" with other projects like KDE or GNOME, simply
KDE or GNOME, simply because they are completely different things. because they are completely different things.
For more information on the GNUstep project, visit: http://www.gnustep.org For more information on the GNUstep project, visit: http://www.gnustep.org
and http://gnustep.current.nu
Running multiple instances of Window Maker Running multiple instances of Window Maker
========================================== ==========================================
It is not a good idea to run more than one instance of Window Maker It is not a good idea to run more than one instance of Window Maker
from the same user (so that wmaker will use the same configuration from the same user (so that wmaker will use the same configuration files) at the
files) at the same time. You might get unexpected behaviour when Window Maker same time. You might get unexpected behaviour when Window Maker updates it's
updates it's configuration files. configuration files.
If you really desire to do this, try running Window Maker with the If you really desire to do this, try running Window Maker with the command line
command line option --static so that it will not update or change option --static so that it will not update or change any of the configuration
any of the configuration files. files.
Sound support Sound support
============= =============
Sound is supported for Linux and FreeBSD systems with the use of a Sound is supported for Linux and FreeBSD systems with the use of a separately
separately distributed module called WSoundServer. There is also a graphical distributed module called WSoundServer. There is also a graphical configuration
configuration tool for setting up your sounds called WSoundPrefs. tool for setting up your sounds called WSoundPrefs. You can download these at:
You can download these at:
http://shadowmere.student.utwente.nl/ http://shadowmere.student.utwente.nl/
Note that you must compile Window Maker with the --enable-sound configure Note that you must compile Window Maker with the --enable-sound configure
@@ -225,37 +217,35 @@ Performance Tuning
================== ==================
If you want to diminish Window Maker's memory usage and improve performance, If you want to diminish Window Maker's memory usage and improve performance,
while keeping a nice appearance and good functionality, follow the items while keeping a nice appearance and good functionality, follow the items bellow:
bellow:
- use solid textures for everything, mainly titlebars and menus. If you - use solid textures for everything, mainly titlebars and menus. If you want a
want a nice looking desktop, use the Traditional style. nice looking desktop, use the Traditional style.
- turn NewStyle and Superfluous off - turn NewStyle and Superfluous off
- do not bind many shortcuts in the menu and keep only the essential items - do not bind many shortcuts in the menu and keep only the essential items in
in the menu the menu
- turn on DisableClip - turn on DisableClip
- edit wconfig.h and disable the NUMLOCK_HACK and the features you - edit wconfig.h and disable the NUMLOCK_HACK and the features you don't use
don't use anyway (keep in mind that some of the #defines might not anyway (keep in mind that some of the #defines might not work, as they are not
work, as they are not fully supported). Make sure to always keep fully supported). Make sure to always keep NumLock and ScrollLock turned off.
NumLock and ScrollLock turned off.
- turn on DisableAnimations. You can also #undefine ANIMATIONS in wconfig.h - turn on DisableAnimations. You can also #undefine ANIMATIONS in wconfig.h
- strip down the default IconPath and PixmapPath entries to contain only - strip down the default IconPath and PixmapPath entries to contain only
the paths that you really have in your system. the paths that you really have in your system.
- do not use large images in the root background - do not use large images in the root background
- remove support for image formats you don't use - remove support for image formats you don't use
- to reduce memory usage, disable the icon cache, by setting the RIMAGE_CACHE - to reduce memory usage, disable the icon cache, by setting the RIMAGE_CACHE
environment variable to 0. If you want to increase performance at the cost environment variable to 0. If you want to increase performance at the cost of
of memory usage, set it's value to a value like the number of different memory usage, set it's value to a value like the number of different icons you
icons you use. Also, disable anti-aliased text support in ~/GNUstep/Defaults/WMGLOBAL. use. Also, disable anti-aliased text support in ~/GNUstep/Defaults/WMGLOBAL.
Keyboard Mouse Control Keyboard Mouse Control
====================== ======================
Many people ask about adding keyboard control of mouse, like in fvwm, Many people ask about adding keyboard control of mouse, like in fvwm, but Window
but Window Maker will not have such feature. The XKB extension supports Maker will not have such feature. The XKB extension supports mouse simulation
mouse simulation from the keyboard, in a much more powerfull fashion than from the keyboard, in a much more powerfull fashion than any simulation done by
any simulation done by a window manager. a window manager.
To enable it, hit the Control+Shift+NumLock or Shift+NumLock key combination. To enable it, hit the Control+Shift+NumLock or Shift+NumLock key combination.
You should hear the speaker beeping. To disable it, do the same thing. You should hear the speaker beeping. To disable it, do the same thing.
@@ -283,28 +273,27 @@ milleage may vary.
How to make a gdb backtrace How to make a gdb backtrace
=========================== ===========================
Backtraces can help us fix bugs that make Window Maker crash. If you Backtraces can help us fix bugs that make Window Maker crash. If you find a bug
find a bug that crashes Window Maker, please send a backtrace with your that crashes Window Maker, please send a backtrace with your bug report.
bug report.
To make a usefull backtrace, you need a core file with debugging To make a usefull backtrace, you need a core file with debugging information
information produced by Window Maker when it crashes. It should produced by Window Maker when it crashes. It should have been installed without
have been installed without stripping too. stripping too.
To compile wmaker with debugging information: To compile wmaker with debugging information:
./configure ./configure
make CFLAGS=-g make CFLAGS=-g
If you get the dialog window telling you that wmaker crashed and If you get the dialog window telling you that wmaker crashed and asks you what
asks you what to do, tell it to "Abort and leave a core file". to do, tell it to "Abort and leave a core file".
script script
cd src cd src
gdb .libs/wmaker path_to_the_core_file gdb .libs/wmaker path_to_the_core_file
Then, in the gdb prompt type "bt". Quit from gdb by typing "quit" Then, in the gdb prompt type "bt". Quit from gdb by typing "quit" and then, in
and then, in the shell prompt, type "exit". the shell prompt, type "exit".
The file named typescript will contain the backtrace. The file named typescript will contain the backtrace.
@@ -313,20 +302,19 @@ The file named typescript will contain the backtrace.
Copyrights & Disclaimers Copyrights & Disclaimers
======================== ========================
Window Maker is copyrighted by Alfredo K. Kojima and is licensed through the Window Maker is copyrighted by Alfredo K. Kojima and is licensed through the GNU
GNU General Public License. Read the COPYING file for the complete license. General Public License. Read the COPYING file for the complete license.
The icons that are distributed with this program and were made by Marco van The icons that are distributed with this program and were made by Marco van
Hylckama Vlieg, are licensed through the GNU General Public License. Read the Hylckama Vlieg, are licensed through the GNU General Public License. Read the
COPYING file for the complete license. COPYING file for the complete license.
The icons listed in COPYING.WTFPL and are distributed in this The icons listed in COPYING.WTFPL and are distributed in this program and were
program and were made by Banlu Kemiyatorn (]d), are licensed through the made by Banlu Kemiyatorn (]d), are licensed through the "do What The Fuck you
"do What The Fuck you want to Public License". Read the COPYING.WTFPL want to Public License". Read the COPYING.WTFPL file for the complete license.
file for the complete license.
NeXT, OpenStep and NEXTSTEP are a trademarks of NeXT Computer, Inc. NeXT, OpenStep and NEXTSTEP are a trademarks of NeXT Computer, Inc. All other
All other trademarks are property of their respective owners. trademarks are property of their respective owners.
The authors reserve the right to make changes in the software without prior The authors reserve the right to make changes in the software without prior
notice. notice.
@@ -339,15 +327,15 @@ Alfredo K. Kojima <kojima@windowmaker.info>
Dan Pascu <dan@windowmaker.info> Dan Pascu <dan@windowmaker.info>
]d <id@windowmaker.info> ]d <id@windowmaker.info>
Please don't ask us questions before reading the documentation (esp. the Please don't ask us questions before reading the documentation (esp. the FAQ,
FAQ, this file and INSTALL files) and about "cool" things you see in this file and INSTALL files) and about "cool" things you see in people's desktop
people's desktop screenshots. screenshots.
The AUTHORS file contains a list of the people who have contributed to the The AUTHORS file contains a list of the people who have contributed to the
project. The name of people who have helped with localization (translation) project. The name of people who have helped with localization (translation) can
can be found in po/README and Window Maker/README be found in po/README and Window Maker/README
If you have any comments, fixes and bug reports (filled BUGFORMs) send them If you have any comments, fixes and bug reports (filled BUGFORMs) send them
to developers@windowmaker.info to wmaker-dev@lists.windowmaker.org