Menu
▾
▴
[Fvwm-crystal-commits] SF.net SVN: fvwm-crystal:[468]
|
From: <dom...@us...> - 2013-05-25 12:44:16
|
Revision: 468
http://sourceforge.net/p/fvwm-crystal/code/468
Author: dominique_libre
Date: 2013-05-25 12:44:11 +0000 (Sat, 25 May 2013)
Log Message:
-----------
+ asciidoc/MouseBindings & FAQ & KeyboardBindings & ApplicationsDatabase & Tips & CrystalRoxHowto & Tips & create.sh: ported documentation to asciidoc with a helper script to generate the man pages and html documentation; uodated the doc at the same time. - doc/Application Database.txt & Crystal ROX! HOWTO & FAQ & KeyboardBindings & Mouse Bindings & Tips.txt: removed txt documentation + html/*: autogenerated html documentation. man/*: auto updated the man pages
Modified Paths:
--------------
ChangeLog
man/ApplicationDatabase.1
man/CrystalRoxHOWTO.1
man/FVWMCrystalFAQ.1
man/KeyboardBindings.1
man/MouseBindings.1
man/Tips.1
Added Paths:
-----------
asciidoc/
asciidoc/ApplicationDatabase
asciidoc/CrystalRoxHOWTO
asciidoc/FAQ
asciidoc/KeyboardBindings
asciidoc/MouseBindings
asciidoc/Tips
asciidoc/create.sh
doc/html/
doc/html/ApplicationDatabase.html
doc/html/CrystalRoxHOWTO.html
doc/html/FAQ.html
doc/html/KeyboardBindings.html
doc/html/MouseBindings.html
doc/html/Tips.html
Removed Paths:
-------------
doc/Application database.txt
doc/Crystal ROX! HOWTO.txt
doc/FAQ
doc/Keyboard bindings.txt
doc/Mouse bindings.txt
doc/Tips.txt
Modified: ChangeLog
===================================================================
--- ChangeLog 2013-05-25 09:47:54 UTC (rev 467)
+++ ChangeLog 2013-05-25 12:44:11 UTC (rev 468)
@@ -10,7 +10,15 @@
actions prefernces menu.
functions/Preferences-Menu: avoid logout and restart with FVWM-Crystal Desktop
Icons when possible.
-
++ asciidoc/MouseBindings & FAQ & KeyboardBindings & ApplicationsDatabase & Tips &
+ CrystalRoxHowto & Tips & create.sh: ported documentation to asciidoc with a helper
+ script to generate the man pages and html documentation; uodated the doc at the
+ same time.
+- doc/Application Database.txt & Crystal ROX! HOWTO & FAQ & KeyboardBindings &
+ Mouse Bindings & Tips.txt: removed txt documentation
++ html/*: autogenerated html documentation
+ man/*: auto updated the man pages
+
Vendredi 23 Mai 2013 Dominique Michel
functions/FvwmExpose: silent xwd
apps/Thunar: add preliminary preference support for the action 1 and 2
Added: asciidoc/ApplicationDatabase
===================================================================
--- asciidoc/ApplicationDatabase (rev 0)
+++ asciidoc/ApplicationDatabase 2013-05-25 12:44:11 UTC (rev 468)
@@ -0,0 +1,205 @@
+ApplicationDatabase(1)
+======================
+:doctype: manpage
+:man source: ApplicationDatabase
+:man version: 3.1.12
+:man manual: FVWM-Crystal
+
+NAME
+----
+
+ApplicationDatabase - provide "fvwm-crystal.apps" - a feature rich script that generate FVWM-Crystal applications menu from database entries and icons. It can be used in conjunction with "fvwm-crystal.generate-menu" - a script that generate the database entries and the icons used by fvwm-crystal.apps, by reading the desktop files provided by the applications, that with full support of the FreeDesktop additional categories.
+
+
+SYNOPSIS
+--------
+
+None
+
+
+DESCRIPTION
+-----------
+
+Application database (with fvwm-crystal.apps and fvwm-crystal.generate-menu scripts) is one of the most interesting elements of FVWM-Crystal desktop.
+Thanks to these elements you can have a panel or the menu with applications currently installed on a given system.
+
+Database structure is very flexible, allowing you to combine several databases into one (system-wide and user-wide, for example), mask selected applications or even whole directories, so they won't be visible, and so on.
+
+Application panel/menu generator also has many interesting features - you can create different panels and menu systems and easily blend them with your FVWM configuration.
+
+
+Database structure
+~~~~~~~~~~~~~~~~~~
+A database is a set of directories and scripts with special naming structure.
+Each directory and subdirectory creates a *category* in which you can put
+selected applications, for example *Games* or *Office*. Categories can be
+nested, in turn creating subcategories, like *FPP Games* or *OpenOffice.org*.
+In generation process each subdirectory is transformed into a submenu containg menu items specified in this subdirectory.
+
+Each directory and script have a special naming pattern. Here's the list of possible names:
+
+ entry_name
+ ~entry_name
+ ~~entry_name
+ ~executable_name~entry_name
+ priority~entry_name
+ priority~~entry_name
+ priority~executable_name~entry_name
+
+_entry_name_::
++
+is the name of the menu item or button on a panel. This is a required field. If it's the only one present, generator assumes that this entry should be put in the menu or panel without checking if associated application is present.
+
+_executable_name_::
++
+is used to specify a name of the executable file. It's used to determine if
+selected application is installed on the system, and in turn decide if this
+entry should be put in the menu/panel or not. Applications are searched in the
+directories specified using $PATH environment variable. This field is
+optional, and is only tested, if _--check-exec_ option is present.
+
+_priority_::
++
+is a numeric only field (also optional). It is used in the sorting mechanism to determine, what *importance* has particular menu item. Entries with higher priorities will be put higher in the menu system (therefore closer to the mouse pointer), lower priorities will be pushed at the end of the menu.
+By default an entry without priority field has priority set to 0.
+
+As you can see, each directory and script name is used to sort and create
+menus and panels. Also attributes of the files and directories are used in
+this process. Each directory and script has an executable (x) bit set, for
+allowing execution (see below) or reading inside directories. This can be used
+to exclude certain files or directories from the generated menus or panels. By
+removing the executable bit (_chmod -x_) from a file or directory you can
+prevent it to be seen by the generator and ommited in the generated menu. By
+combining this ability with *database merging* (each database masks previous one) you can use, for example, user-side application database to remove certain programs from this users menu.
+
+Generator doesn't put in the menu entry complete path to the binary it found - instead it puts the path to the script itself. In the end, what users do is not launching applications directly, but instead launching scripts located in the application database, which in turn launch the applications themselves.
+That means, what's inside of the script, is completely meaningless to the generator; you can write complex scripts which are shown in the menu system and easily launch them.
+
+Instead of using the scripts, you can also make symlinks to selected binaries (using the specified naming rules), they also will be checked and included in the menu system. Script automatically tests, if symlink is correct (ie. target is present), and if the target has an executable bit set.
+
+
+Database masking
+~~~~~~~~~~~~~~~~
+You can give *fvwm-crystal.apps* script several databases in one command, for example:
+----
+fvwm-crystal.apps --database=/some/directory --database=/other/dir
+----
+When that happens, generator first reads first given database
+(/some/directory), and after that adds next databases (/other/dir) to the
+first one. You can use this feature to make changes in separate database that
+affect generated menus and panels, but not modify the original database
+itself. This mechanism is used in FVWM-Crystal by combining user-side database
+located in *~/.fvwm/Applications* with system-wide, located in
+*/usr/share/fvwm-crystal/fvwm/Applications* (by default).
+
+For successfull *database masking* you need to use the same directory
+structure as the original database. That means, if you want to modify an entry
+located in, for example, */Applications/Games/FPP*, you need to create the
+same directories in your *local* database. You can omit the *priority* field in directory/file names, or change it, thus moving selected menu entry in the menu hierarhy. For example:
+
+ system-wide: /Applications/20~Games/FPP/10~quake~Quake
+ user-wide: /Applications/Games/FPP/30~quake~Quake
+
+File attributes also can be masked. If you want to remove a menu entry (or
+even entire submenu), you need to create all directories and a script which
+lead to selected entry, and then remove the executable bit (chmod -x) from the
+directory or script in your *local* database.
+
+Consequently, if you want to move a menu entry or submenu itself from one
+place to another in the menu structure, you can create neccesary files in
+desired location (or make symlinks to files/directories in original database),
+then create the *old* files and directories, and remove their executable bit. Menu entries will disappear from their original locations and appear in those selected by your database.
+
+
+Application icons
+~~~~~~~~~~~~~~~~~
+Each application has it's own icon. Icon files are found using the entry or exectuable file name, like this:
+
+ entry_name.png
+ executable_name.png
+
+First *entry_name* is tested, if icon doesn't exist, script looks for one with
+*executable_name*.
+
+Icon directories can be specified using *--search-icons-in* option. You can specify more than one directory by separating them using : (colon) sign.
+
+There are two special file names:
+
+*directory.png*::
++
+is used for the *categories* which doesn't have their own icon (it was not
+found by the generator in specified directory). You can specify your own name
+using *--default-dir-icon* option. For example:
+
+ ImagePath $[FVWM_USERDIR]/icons/
+ fvwm-crystal.apps --search-icons-in=$[FVWM_USERDIR]/icons/ \
+ --default-dir-icon=22x22/dir.png
+
+ Result: <ImagePath>22x22/dir.png
+
+*default.png*::
++
+is used for applications which doesn't have their own icon. You can use
+*--default-file-icon* to change the name, in the same way
+ *--default-dir-icon* can be used.
+
+
+Panel/menu generator
+~~~~~~~~~~~~~~~~~~~~
+Here I will describe some example uses of the generator, if you want to see complete list of commandline options, you can use command:
+----
+fvwm-crystal.apps --help | less
+----
+
+*Creating panels*::
++
+Generator doesn't create all panel options specified in *man FvwmButtons*,
+just the button themselves. Therefore you can use FVWM configuration to decide
+how the resulting panel will look and where it will be placed. For example,
+you can create panels with swallowed windows and application buttons, by
+putting PipeRead command with *fvwm-crystal.apps* in between the panel configuration, like this:
+
+ *SomePanel: (1x1, Swallow FvwmPager)
+ PipeRead 'fvwm-crystal.apps --database=/some/base \
+ --panel-name="SomePanel"'
+ *SomePanel: (1x1, Swallow xclock)
++
+You can make application panels which will open app menus, with different icon size on the panel and in the menu (big on the panel, small in the menu), by using generator several times with different options. For example:
+
+ PipeRead 'fvwm-crystal.apps --database=/some/base \
+ --panel-action1=menu --search-icons-in=/icons/32x32/apps \
+ --no-menus'
+ PipeRead 'fvwm-crystal.apps --database=/some/base \
+ --search-icons-in=/icons/22x22/apps --no-panel'
+
+
+TODO
+----
+Add more examples here...
+
+
+AUTHORS
+-------
+Documentation written by Maciej Delmanowski <ha...@be...>
+and ported to asciidoc by Dominique Michel
+
+fvwm-crystal.apps (C) 2005 by Rafal Bisingier
+bugfixes 2008-2013 by Dominique Michel
+
+fvwm-crystal.generate-menu (C) 2008-2013 by Dominique Michel
+<dom...@us...>
+
+
+COPYRIGHT
+---------
+*FVWM-Crystal* and all the scripts and other files coming with
+the distribution are subject to the GNU General Public License (GPL).
+Please refer to the COPYING file that came with *FVWM-Crystal* for details.
+
+
+BUGS
+----
+Bug reports can be sent to the fvwm-crystal-users mailing list at
+<https://mail.gna.org/listinfo/fvwm-crystal-users/>.
+
+
Added: asciidoc/CrystalRoxHOWTO
===================================================================
--- asciidoc/CrystalRoxHOWTO (rev 0)
+++ asciidoc/CrystalRoxHOWTO 2013-05-25 12:44:11 UTC (rev 468)
@@ -0,0 +1,97 @@
+CrystalRoxHOWTO(1)
+==================
+:doctype: manpage
+:man source: CrystalROXHOWTO
+:man version: 3.1.12
+:man manual: FVWM-Crystal
+
+NAME
+----
+
+CrystalRoxHOWTO - Crystal ROX! HOWTO - (Read as "Crystal rocks!" ;)
+
+SYNOPSIS
+--------
+
+None
+
+
+DESCRIPTION
+-----------
+
+In this HOWTO I will show you how to setup FVWM-Crystal desktop with ROX-Filer
+file manager, so they are working smoothly.
+
+
+What is ROX-Filer?
+------------------
+
+(From the ROX-Filer manual)
+ROX-Filer is a graphical file manger for the X Window System. Its user
+interface is based on the RISC OS filer and it supports similar features such
+as application directories and drag-and-drop loading and saving of files. The
+filer can also act as a pinboard, allowing you to pin frequently used files
+onto the desktop background.
+
+Homepage: http://rox.sourceforge.net
+
+In Crystal, while you can utilize an application-based work system (open an
+application and from it's menu open a document), ROX-Filer will let you use
+also document-based work style (open a document file in selected application),
+of course after a little customization of Filer's settings.
+
+
+How to make ROX-Filer work with FVWM-Crystal?
+---------------------------------------------
+
+Install ROX-Filer. I assume that executable is called *rox*. If name is
+different, change it accordingly or make a symlink to */usr/local/bin/rox*.
+
+In FVWM-Crystal you can select a *desktop manager* to use. This option is
+located in: Diamond => Preferences => Desktop manager. Select ROX-Filer.
+Crystal will ask you to logout and start again your X session - you can do it
+right away or later, if you wish.
+
+If everything was correctly installed, FVWM-Crystal should run with gray
+background and *Home* icon in the upper-left corner of the screen (that's
+ROX's pinboard). Now click on the background and from the menu select
+*ROX-Filer* => *Options*. Go to *Iconified windows* and turn off *Show iconified
+windows* option. Now go to *Compatibility* section and turn on *Pass all
+backdrop mouse clicks to window manager* option. This way you will be able to
+open terminal windows using RMB on the desktop. ROX-Filer menu can be still
+accessed by clicling with RMB on the icons. You can now change ROX's options
+at will.
+
+You can change desktop wallpaper using the Crystal's menu system.
+
+
+Known issues:
+-------------
+- window thumbnails aren't transparent, probably because FVWM doesn't use
+ ROX's pinboard as the source of transparency for it's icons?
+- Icon selected on the desktop stays selected; that's because ROX-Filer sends
+ all mouse button clicks to the window manager. If you don't want a selected
+ icon on the desktop all the time, open a directory or launch a file from
+ your desktop.
+
+
+AUTHORS
+-------
+Documentation written by Maciej Delmanowski <ha...@be...>
+and ported to asciidoc by Dominique Michel
+<dom...@us...>
+
+
+COPYRIGHT
+---------
+*FVWM-Crystal* and all the scripts and other files coming with
+the distribution are subject to the GNU General Public License (GPL).
+Please refer to the COPYING file that came with *FVWM-Crystal* for details.
+
+
+BUGS
+----
+Bug reports can be sent to the fvwm-crystal-users mailing list at
+<https://mail.gna.org/listinfo/fvwm-crystal-users/>.
+
+
Added: asciidoc/FAQ
===================================================================
--- asciidoc/FAQ (rev 0)
+++ asciidoc/FAQ 2013-05-25 12:44:11 UTC (rev 468)
@@ -0,0 +1,435 @@
+fvwm-crystal-FAQ(1)
+===================
+:doctype: manpage
+:man source: FAQ
+:man version: 3.1.12
+:man manual: FVWM-Crystal
+
+NAME
+----
+FVWMCrystalFAQ - FVWM-Crystal Frequently Asked Questions
+
+
+SYNOPSIS
+--------
+
+None
+
+
+DESCRIPTION
+-----------
+
+Last updated:
+~~~~~~~~~~~~
+ 19.04.2013, for version 3.0.7
+
+Table of Contents
+-----------------
+
+1. General information.
+~~~~~~~~~~~~~~~~~~~~~~~
+1.1: What is FVWM-Crystal?
+
+1.2: Who are the authors?
+
+1.3: Where I can get the newest version?
+
+1.4: Is there a mailing list?
+
+
+2. Installation.
+~~~~~~~~~~~~~~~~
+2.1: What do I need to install FVWM-Crystal?
+
+2.2: Can I use FVWM-Crystal with *stable* FVWM branch (2.4.x)?
+
+2.3: How to install FVWM-Crystal from distributed packages?
+
+2.4: How to install FVWM-Crystal from darcs repository?
+
+2.5: How to install FVWM-Crystal manually?
+
+2.6: How I can select FVWM-Crystal as my window manager?
+
+2.7: When I start FVWM-Crystal I get only the empty FVWM desktop...
+
+2.8: Why there is no application panel on the desktop?
+
+
+3. Usage.
+~~~~~~~~~
+3.1: Where can I start some prefered application at startup?
+
+3.2: Where can I add my prefered fvwm command?
+
+3.3: How can I have a tear off menu?
+
+3.4: How can I record madias with mplayer?
+
+3.5: The Music menu get screwed. What can I do about this?
+
+3.6: Mplayer doesn't show the movie I selected into the menu. Why?
+
+3.7: Mplayer is flaky. What can I do?
+
+3.8: How to change FVWM-Crystal key bindings that collide with Emacs?
+
+3.9: What do I need to do to create my own personal recipe(s)?
+
+3.10: How to customize the application menu?
+
+3.11: How to get a consistant look between toolkits?
+
+3.12: How can I get my removable media to be mounted with Thunar?
+
+
+Frequently Asked Questions
+--------------------------
+Here are the answers!
+
+1. General information.
+-----------------------
+
+1.1 Q: What is FVWM-Crystal?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: It's a set of FVWM configuration files, some Python and shell scripts, a set of application icons and images. This combination produces a fairly decent and customized Linux desktop using FVWM as it's basic component. With additional file managers, such as Thunar ROX-Filer or Nautilus (from GNOME Project) you can create useable and good-looking Linux desktop environment.
+
+1.2 Q: Who are the authors?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: The original author FVWM-Crystal is Maciej Delmanowski. You can contact with him using his e-mail account <ha...@be...> or through Jabber network <ha...@ja...>.
+
+The current author and maintener is Dominique Michel
+<dom...@us...>
+
+FVWM-Crystal could not be in the present state without the help of other people. You can find their list in the AUTHORS file included in the project's package.
+
+
+1.3 Q: Where I can get the newest version?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: Newest stable version can be always found on the main FVWM-Crystal website:
+----
+https://sourceforge.net/projects/fvwm-crystal/?source=navbar
+----
+Some GNU/Linux distributions have already included packages, usually named *fvwm-crystal*.
+
+You can also use the development version. It is a subversion repository which contains the newest code. You can find more information on
+----
+http://fvwm-crystal.sourceforge.net/download.html
+----
+
+1.4 Q: Is there a mailing list?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: Yes, there is. You can read the archives by pointing your web browser on
+----
+http://lists.berlios.de/pipermail/fvwm-crystal-users/
+----
+If you want to subscribe, you can do it using the Web interface:
+----
+http://lists.berlios.de/mailman/listinfo/fvwm-crystal-users
+----
+
+2. Installation.
+-----------------
+
+2.1 Q: What do I need to install FVWM-Crystal?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: If you want to use FVWM-Crystal, you need to have:
+
+- *FVWM window manager*, version 2.6.5+
+
+- *Python* interpreter 2.7
+
+- POSIX shell interpreter
+
+- an application which can set the desktop wallpaper (Esetroot, hsetroot, feh)
+
+- coreutils (you just already have it)
+
+- gawk
+
+- sed
+
+- xwd (for on the fly icon generation)
+
+- /proc/mounts if Thunar is installed (used to update the icons on the fly)
+
+- bc if AlsaPlayer or MPlayer is installed (speed control)
+
+You can install these applications to get additional functionality:
+
+- terminal emulator (xterm, Aterm, Eterm, urxvt, mrxvt, gnome-terminal, terminator, konsole, mgt or xfce4-terminal are currently supported)
+
+- ImageMagick - for window thumbnails and making screenshots
+
+- XScreenSaver - a desktop screensaver
+
+- stalonetray or trayer - stand-alone tray/notification area application
+
+- sudo - running text-based applications as superuser and for shutdown/reboot commands (needs to be configured properly)
+
+- gksudo - for running graphical applications as superuser
+
+- GDM (gdmflexiserver) - for shutdown/reboot/new login commands
+
+- a music player - AlsaPlayer, XMMS2 , QuodLibet, cdcd, MPlayer, cmus, audacious or MPD are supported
+
+- graphical file manager - Thunar, ROX-Filer or Nautilus
+
+
+Here are URLs for applications specified above:
+
+- FVWM http://www.fvwm.org/
+
+- habak, trayer http://fvwm-crystal.berlios.de/
+
+- Esetroot http://www.jnrowe.ukfsn.org/projects/esetroot.html
+
+- hsetroot http://thegraveyard.org/hsetroot.php
+
+- Aterm http://aterm.sourceforge.net/
+
+- Eterm http://eterm.sourceforge.net/
+
+- URxvt http://software.schmorp.de/
+
+- mrxvt http://materm.sourceforge.net/
+
+- ImageMagick http://www.imagemagick.org/
+
+- XScreenSaver http://www.jwz.org/xscreensaver/
+
+- sudo http://www.courtesan.com/sudo/
+
+- XMMS http://www.xmms.org/
+
+- XMMS2 http://wiki.xmms2.xmms.se/index.php/Main_Page
+
+- xmms-shell http://directory.fsf.org/audio/mp3/xmms-shell.html
+
+- xmms-find http://xmmsfind.sourceforge.net/
+
+- MPD http://www.musicpd.org/
+
+- mpc http://musicpd.org/mpc.shtml
+
+- QuodLibet http://www.sacredchao.net/quodlibet
+
+- cdcd http://libcdaudio.sourceforge.net/
+
+- ROX-Filer http://rox.sourceforge.net/
+
+
+2.2 Q: Can I use FVWM-Crystal with "stable" FVWM branch (2.4.x)?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: No. Old FVWM version (so called "stable") is in fact, old. Even 2.5.x
+series which has many improvements over the old stable tree is old now, for example support for PNG images, new modules, improvements in existing modules and bugfixes.
+
+From FVWM 2.6.x, all releases are stable and 2.7 is outdated.
+
+Due to the introduction of infostore in FVWM and its use in FVWM-Crystal, you will need FVWM 2.6.5+.
+
+2.3 Q: How to install FVWM-Crystal from distributed packages?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: Unpack fvwm-crystal-X.Y.tar.gz to an empty directory. After that cd into unpacked directory and execute:
+----
+make install
+----
+By default Crystal will be installed in /usr/local directory. You can select destination directory using:
+----
+make prefix=/usr install
+----
+After successful installation you can copy sample *~/.Xresources* file from
+*addons/* directory of the FVWM-Crystal package, if you don't have
+one. A Xsession desktop file will be installed into /usr/share/xsessions, so
+any graphical login manager should be able to select FVWM-Crystal as your
+desktop.
+
+2.4 Q: How to install FVWM-Crystal from subversion repository?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: You need to create a local copy of a darcs repository by issuing command:
+----
+svn co svn://svn.code.sf.net/p/fvwm-crystal/code/ fvwm-crystal
+----
+
+When it finishes, cd into newly created 'fvwm-crystal/' directory and issue commands:
+----
+make install
+----
+
+You can change the destination directory as described above.
+
+2.5 Q: How to install FVWM-Crystal manually?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: Parts of FVWM-Crystal configuration needs to have executable bit on, and it's set by the make script. If you can't or don't want to use it, you can installa FVWM-Crystal manually. Unpack the distributed package or get a copy of the subversion repository as described above, then issue commands below:
+
+Note: This answer is obsolete but can get you started. Read the Makefile if it
+doesn't work.
+----
+cd fvwm-crystal
+chmod a+rx bin/*
+chmod -R a+rx fvwm/Applications
+chmod a+rx fvwm/scripts/FvwmMPD/*.py fvwm/scripts/FvwmMPD/*.sh
+----
+
+Now put all files from *fvwm/* directory in the chosen configuration
+directory. If you want to install FVWM-Crystal in your $HOME directory,
+put the configuration files in ~/.fvwm-crystal directory (without the
+'fvwm/' subdirectory!). Startup script will use them automatically.
+
+
+You can also copy ~/.Xresources or fvwm-crystal.desktop as described above.
+
+2.6 Q: How I can select FVWM-Crystal as my window manager?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: If you are using *startx* for running your X session, copy the file
+*addons/Xsession* from FVWM-Crystal package to your ~~/.Xsession or
+~~/.xinitrc file. In other words, you need to start *fvwm-crystal* script,
+*fvwm* or *fvwm2* will not work, because FVWM-Crystal has it's main configuration files in different place than FVWM.
+
+If you are using a graphical login manager like *GDM*, just select
+*FVWM-Crystal* in the Session menu.
+
+2.7 Q: When I start FVWM-Crystal I get only the empty FVWM desktop...
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: Make sure that you have correct path to the system-wide configuration files
+in *fvwm-crystal* script. Also check if in your ~~/.Xsession or ~~/.xinitrc
+the last line contains *exec fvwm-crystal*. Select *FVWM-Crystal* as your
+session in GDM, *FVWM* will not work.
+
+2.8 Q: Why there is no application panel on the desktop?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: Do you have Python installed?
+Is *fvwm-crystal.apps* script in a directory listed in $PATH environment variable?
+All files in Crystal's Application Database needs to have *executable* bit set (all files are actually scripts). You can set it by issuing command:
+----
+chmod -R a+rx <installpath>/Applications
+----
+
+3. Usage
+--------
+
+3.1 Q: Where can I start some prefered application at startup?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: Copy the file */usr/share/fvwm-crystal/fvwm/preferences/Startup* to
+*~/.fvwm-crystal/preferences/Startup* and add yours commands here.
+
+3.2 Q: Where can I add my prefered fvwm command?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: You want to use some custom styles, keybindings or so, or to replace existing ones. Create the file
+----
+~/.fvwm-crystal/userconfig
+----
+and add them here.
+
+3.3 Q: How can I have a tear off menu?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: When in the menu you want to tear off, press the backspace key. To remove
+the menu, press escape. This is a standard FVWM feature. See *man fvwm*.
+
+3.4 Q: How can I record medias with mplayer?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: Recording with mplayer produce a stream dump. Such a dump is unusable for anything else than MPEG streams. Dump only MPEG sources. When watching such a sources, press "c" and mplayer will begin to make a stream dump to the file ~/stream.dump.
+
+Press "c" again to stop capturing. You can use Kino to edit this file.
+
+3.5 Q: The Music menu get screwed. What can I do about this?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: According to Thomas Adam, auto-generated menus in FVWM are very sensitive to special characters. You must change all the special characters in the directories and folders names where FVWM will search for your media files.
+
+3.6 Q: Mplayer doesn't show the movie I selected into the menu. Why?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A; You are watching something else. The file(s) was just added into mplayer's internal playlist. Press Enter or chosse Next in the menu. Only the DVB and DVD sources will play instantly.
+
+3.7 Q: Mplayer is flaky. What can I do?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: Try another video output. For that, edit ~/.mplayer/config and put a line
+like *vo=xv* or *vo=gl*. *mplayer -vo help* will show you a list.
+
+In the worst case (Fvwm-Crystal is unusable), go to one of the primary console
+with *Ctrl + Alt + F<n>*, login and issue a *killall -9 mplayer*.
+
+With *Alt + F7*, you will go back to Fvwm-Crystal.
+
+You can also try a different X graphic driver. For that, you must follow the documentation of your GNU/Linux distribution, install the wanted driver and edit the configuration of your X server.
+
+3.8 Q: How to change FVWM-Crystal key bindings that collide with Emacs?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: With Emacs, the problem is the Alt key. You must change this keyboard modifier. For that, copy
+
+----
+/usr/share/fvwm-crystal/fvwm/compoments/functions/Keyboard-Modifiers
+----
+
+to
+
+----
+~/.fvwm-crystal/components/functions/Keyboard-Modifiers
+----
+
+edit it and change *SetEnv Mod1 M* to *SetEnv Mod1 4*, and *SetEnv Mod2 MS* to
+*SetEnv Mod 2 4S* to use the windows key.
+
+You may want to also change *SetEnv SelectOnReleaseKey Alt_L* to *SetEnv
+SelectOnReleaseKey Super_L*.
+
+3.9 Q: What do I need to do to create my own personal recipe(s)?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: Create the directory ~/.fvwm-crystal/recipes and put your recipe(s) in it. After restrarting FWM-Crystal from its main menu, you will get 2 choices in the preferences recipes menu: system and user.
+
+3.10 Q: How to customize the application menu?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: First, take a look at the documentation: Main FVWM-Crystal menu -> FVWM-Crystal documentation -> Application Database.
+
+The application menu use a priority system based on the file name.
+
+With the default priority of 0, the file name will begin with ~prog_name~*. By renaming it to 10~prog_name~*, you will give it a more important priority than ~prog2~*, and less priority than 20~prog3~*
+
+FVWM-Crystal comme with a collection a preconfigured menu entries. You will
+find them in /usr/fvwm-crystal/fvwm/applications/* and can copy them into
+~/.fvwm-crystal/applications/* for customization.
+
+In the preferences, you can tell FVWM-Crystal to generate the application menu entries for the non provided entries. It will place them into ~/.fvwm-crystal/applications/*
+
+This function use the desktop files provided by the applications. If the application doesn't provide any desktop file, you will have to create your own menu entry and will find many examples in the provided FVWM-Crystal files.
+
+3.11 Q: How to get a consistant look between toolkits?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: This is not related to FVWM-Crystal, but anyway, the look of the applications can be a little bit difficult to configure if you don't have Gnome and KDE installed, and don't know how to proceed.
+
+First, you must install lxappearance and qtconfig. At that time of writing (May 2013), lxappearance have a bug that imply any custom color change will be lost. But anyway, it is the best light application to change the GTK+ themes, icons, etc. If you want to customize the colors, you can always edit ~/.gtkrc-2.0 directly.
+
+After selecting your favorite GTK+ theme with lxappearance, run qtconfig to select the Default theme to use the system settings, or the GTK+ style to apply your GTK+ settings to QT.
+
+3.12 Q: How can I get my removable media to be mounted with Thunar?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A: Short answer: you can't, Thunar is a file manager, nothing else.
+- For the USB and Firewire devices, you can add entries for them in /etc/fstab. For example:
+----
+/dev/sdd1 /mnt/usb ext3 users,noatime 0 2
+----
+They will be mounted at boot and the users tag will let you mount and umount them as users.
+
+- For the USB and Firewire devices not present in the fstab, you can install pmount and pmount-gui. They will be mounted in /media. You mwy want to install uam too.
+
+- For the CD/DVD devices and much more, install and configure autofs.
+
+AUTHORS
+-------
+Original written by Maciej Delmanowski <ha...@be...>,
+augmented, maintained and ported to asciidoc by Dominique Michel
+<dom...@us...>
+
+
+COPYRIGHT
+---------
+*FVWM-Crystal* and all the scripts and other files coming with
+the distribution are subject to the GNU General Public License (GPL).
+Please refer to the COPYING file that came with *FVWM-Crystal* for details.
+
+
+BUGS
+----
+Bug reports can be sent to the fvwm-crystal-users mailing list at
+<https://mail.gna.org/listinfo/fvwm-crystal-users/>.
+
+
Added: asciidoc/KeyboardBindings
===================================================================
--- asciidoc/KeyboardBindings (rev 0)
+++ asciidoc/KeyboardBindings 2013-05-25 12:44:11 UTC (rev 468)
@@ -0,0 +1,305 @@
+KeyboardBindings(1)
+===================
+:doctype: manpage
+:man source: KeyboardBindings
+:man version: 3.1.12
+:man manual: FVWM-Crystal
+
+NAME
+----
+KeyboardBindings - FVWM-Crystal Keyboard Bindings Reference
+
+
+SYNOPSIS
+--------
+
+None
+
+
+DESCRIPTION
+-----------
+
+In this file you can find all keyboard bindings used in FVWM-Crystal desktop.
+
+Legend:
+-------
+ Alt - Meta (Alt)
+ Win_L - Windows Left
+ Win_R - Windows Right
+ Menu - a "menu" key
+ KP_ - means that following key is on the numeric keyboard
+ LMB - Left Mouse Button
+ RMB - Right Mouse Button
+ MMB - Middle Mouse Button
+
+
+Terminal windows:
+-----------------
+*Alt + ` (grave)*::
+ Opens "QuakeConsole", a terminal similar to console available in FPP
+ games, like Quake series. It's a normal terminal where you can launch
+ commands. It stays on top of other windows, is visible on all
+ desktops. When you press Alt+` again, it will roll up and hide,
+ waiting for your next press of Alt+`, when it will show up again, so
+ you can launch a command in this terminal and hide it.
+
+*Alt + Shift + ` (grave)*::
+ It will open new terminal window, Aterm by default.
+
+*Alt + ;*::
+ Opens FvwmConsole in the lower-left corner of the screen, where you
+ can issue FVWM commands, and sometimes see error messages. The same
+ combination will hide/unhide it.
+
+
+System and Applications menu:
+-----------------------------
+*Alt + Menu*::
+ Opens a small menu with all the menus from ApplicationPanel and
+ Docklet. You can navigate the menu using cursor keys, or h, j, k, l,
+ Escape cancels the selection, Enter selects a menu position.
+
+*Alt + Win_R*::
+ Opens an /Applications menu which contains a list of available
+ applications. You can use arrow keys or hjkl to move between menu
+ entries, Enter to select an entry and Escape to close the menu.
+
+
+Desktop switching & moving windows between desktops:
+----------------------------------------------------
+*Alt + Escape*::
+ Swiches between two last used pages of the desktop.
+
+*Alt + F1, F2, F3, F4, F5, F6, F7, F8*::
+ Switches to the selected page of the desktop, from 1 to 8.
+
+*Alt + Shift + F1, F2, F3, F4, F5, F6, F7, F8*::
+ Moves active window to selected page, from 1 to 8.
+
+*Alt + [*::
+ Go to the page on the left side of the current one.
+
+*Alt + ]*::
+ Go to the page on the right side of the current one.
+
+*Alt + Shift + [*::
+ Move the focused window to the page on the left side of the current
+ one and go there.
+
+*Alt + Shift + ]*::
+ Move the focused window to the page on the right side of the current
+ one and go there.
+
+
+Window movement on a single desktop:
+------------------------------------
+*Alt + h, j, k, l*::
+ Move windows to selected screen edge, centered:
+ j
+ h k
+ l
+
+*Alt + Shift + h, j, k, l*::
+ Move windows to selected screen corner:
+ h k
+ j l
+
+
+Window and icon list:
+---------------------
+*Alt + Tab*::
+ Shows a list of opened windows on the current page, allows you to
+ switch between them. Last active window will be at the end of the
+ list, previously active window will be at the top - that way quickly
+ pressed and released Alt+Tab will switch between two last used
+ windows.
+
+*Alt + Shift + Tab*::
+ Shows a list of iconified windows, with thumbnails. After releasing
+ Alt selected window will show up on the current page. Escape cancels
+ this operation.
+
+
+Window resizer:
+---------------
+*Alt + Shift + 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, D*::
+ Resizes currently focused window in different ways. Try it to see what
+ happens :)
+
+
+Music player and audio mixer:
+-----------------------------
+*Alt + Z*::
+ Selects prevouse track in music player.
+
+*Alt + X*::
+ Starts playback in music player.
+
+*Alt + C*::
+ Pauses playback in music player.
+
+*Alt + V*::
+ Stops playback in music player.
+
+*Alt + B*::
+ Selects next track in music player.
+
+*Alt + N*::
+ Selects prevous track ignoring "Shuffle" setting in music player.
+
+*Alt + M*::
+ Selects next track ignoring "Shuffle" setting in music player.
+
+*Alt + ,*::
+ Lowers the volume by 1.5 dB.
+
+*Alt + .*::
+ Raises the volume by 1.5 dB.
+
+*Alt + Shift + ,*::
+ Lowers the volume by 10 %.
+
+*Alt + Shift + .*::
+ Raises the volume by 10 %.
+
+*Alt + / (slash)*::
+ Activates the search function of the music player (currently only XMMS
+ with XMMS-Find)
+
+*Alt + Shift + / (slash)*::
+ Toggles sequential/random playback
+
+
+Numeric keyboard - window focus:
+--------------------------------
+*KP_1, KP_2, KP_3, KP_4, KP_6, KP_7, KP_8, KP_9*::
+ Change focus in the selected direction from the currently focused
+ window.
+
+*KP_5*::
+ Switch focus between two closest windows on the current page.
+
+
+Numeric keyboard - window movement:
+-----------------------------------
+*Alt + KP_1, KP_2, KP_3, KP_4, KP_5, KP_6, KP_7, KP_8, KP_9*::
+ Move currently focused window to the selected part of the screen,
+ corresponding to the numbers on the numeric keyboard. Pressing it
+ twice very fast moves a window instantly.
+
+
+Numeric keyboard - window controls:
+-----------------------------------
+*KP_0* or *Alt + - (substract)*::
+ Raise currently focused window.
+
+*KP_.* or *Alt + - (substract)*::
+ Lower currently focused window.
+
+*KP_/*::
+ Shade or unshade currently focused window.
+
+*Alt + KP_/*::
+ Stick or unstick currently focused window.
+
+*`KP_*`* or *Alt + = (equal)*::
+ Maximize currently focused window.
+
+*`Alt + KP_*`* or *Alt + Shift + = (equal)*::
+ Make currently focused window a full-screened window. It looses the
+ titlebar and border and is maximized to the entire screen.
+ Full-screened window cannot be lowered but can be iconified.
+ Pressing Alt+KP_* on the full-screened window brings back the titlebar
+ and border and resizes a window to it's previous size and position.
+
+*`Alt + Shift + KP_*`*::
+ Switch focus between the different full-screened windows of the current
+ desktop page and the desktop.
+
+*Alt + KP_-* or *Alt + Backspace*::
+ Iconifies currently focused window (or makes a thumbnail).
+
+*Alt + Shift + KP_-* or *Alt + Shift + Backspace*::
+ Closes currently focused window.
+
+*KP_+*::
+ Moves window to the default layer, where are "normal" windows.
+
+*Alt + KP_+*::
+ Moves window to the upper layer, where are "always on top" windows.
+
+*Alt + Shift + KP_+*::
+ Moves window to the lower layer, where are "always at botton"
+ windows.
+
+
+Other functions:
+----------------
+*Print Screen*::
+ Makes a screenshot of the entire desktop in .jpg format and puts it in
+ '~/.fvwm/screenshots/' directory (by default).
+
+*Alt + Home*::
+ Move mouse cursor to "home position" - top left corner of the screen.
+
+Note:
+-----
+If you want to modify some bindings, the best place is to put them into
+ ~/.fvwm-crystal/userconfig
+
+That file will be read at the very end of Fvwm-Crystal startup and restart.
+That way, your changes will not be lost after an update, and they will be
+read after all the other configuration settings.
+
+In case you want to reassign an existing binding to another key, the best
+practice is to unassign the old key and assign the new one. As example:
+
+----
+Key grave A $[Mod1] -
+Key grave A $[Mod1]2 -
+Key Q A $[Mod1] QuakeConsole
+Key Q A $[Mod1]2 QuakeConsole
+----
+
+will unassign Fvwm-Crystal binding (Alt + `) that launch the QuakeConsole
+and assign it to (Alt + Q).
+
+To reassign another function to an existing binding, it is just to reassign
+the binding. As example:
+
+----
+Key grave A $[Mod1] MyFunction
+Key grave A $[Mod1]2 MyFunction
+----
+
+will reassign the QuakeConsole binding (Alt + `) to MyFunction.
+The first binding is for use without NumLock, the second one is for use
+with NumLock (The 2 after $[Mod1]).
+
+For the signification of the modifiers, read the key and mouse commands
+description into `man fvwm`, as well than the output of
+
+less "${FVWM_SYSTEMDIR}"/components/functions/Keyboard-Modifiers
+
+when FVWM-Crystal is running.
+
+AUTHORS
+-------
+Documentation written by Maciej Delmanowski <ha...@be...>
+and ported to asciidoc by Dominique Michel
+<dom...@us...>
+
+
+COPYRIGHT
+---------
+*FVWM-Crystal* and all the scripts and other files coming with
+the distribution are subject to the GNU General Public License (GPL).
+Please refer to the COPYING file that came with *FVWM-Crystal* for details.
+
+
+BUGS
+----
+Bug reports can be sent to the fvwm-crystal-users mailing list at
+<https://mail.gna.org/listinfo/fvwm-crystal-users/>.
+
+
Added: asciidoc/MouseBindings
===================================================================
--- asciidoc/MouseBindings (rev 0)
+++ asciidoc/MouseBindings 2013-05-25 12:44:11 UTC (rev 468)
@@ -0,0 +1,443 @@
+MouseBindings(1)
+================
+:doctype: manpage
+:man source: MouseBindings
+:man version: 3.1.12
+:man manual: FVWM-Crystal
+
+NAME
+----
+MouseBindings - FVWM-Crystal Mouse Bindings Reference
+
+
+SYNOPSIS
+--------
+
+None
+
+
+DESCRIPTION
+-----------
+
+In this file you can find all mouse bindings used in FVWM-Crystal desktop.
+
+Legend:
+-------
+ Alt - Meta (Alt)
+ Win_L - Windows Left
+ Win_R - Windows Right
+ Menu - a "menu" key
+ KP_ - means that following key is on the numeric keyboard
+ LMB - Left Mouse Button
+ RMB - Right Mouse Button
+ MMB - Middle Mouse Button
+ Wheel - The mouse wheel
+
+
+The Desktop:
+------------
+*LMB (+ hold)*::
+ If enabled in the preferences, open applications or system menu
+ depending on the recipe in use.
+
+*RMB*::
+ Open a terminal window.
+
+*MMB*::
+ Toggle the ability to switch desktop pages using screen edge (off/on,
+ defult off).
+
+*Alt + MMB*::
+ Hide or show desktop panels.
+
+
+Window thumbnails:
+------------------
+*Doubleclick LMB*::
+ Bring back minimized window.
+
+*RMB*::
+ Open a terminal window.
+
+*Alt + DoubleClick MMB*::
+ Close selected window.
+
+
+Window:
+-------
+*Alt + LMB*::
+ Raise selected window.
+
+*Alt + LMB + drag*::
+ Raise window and move it on the screen.
+
+*Alt + RMB*::
+ Lower selected window.
+
+*Alt + RMB + drag*::
+ Move window on the screen without raising.
+
+*Alt + MMB*::
+ Resize selected window (move bottom-right corner).
+
+
+Window's titlebar:
+------------------
+*LMB*::
+ Raise selected window.
+
+*LMB + drag*::
+ Raise window and move it on the screen.
+
+*RMB*::
+ Lower selected window.
+
+*RMB + drag*::
+ Move window on the screen without raising.
+
+*MMB*::
+ Shade or unshade window.
+
+*MMB + drag*::
+ Resize selected window (choose window edge(s) to move).
+
+*Wheel*::
+ Increase or decrease the transparency of the selected window.
+
+
+Titlebar buttons:
+-----------------
+
+*LMB, RMB, MMB + hold*::
+ Show button menu(s).
+
+FVWM-Crystal button model:
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+`| Close B. |----//-----| Arrows B.| Options B.| Maximize B.| Close B. |`
+[level="1"]
+This apply also to the Amiga button model, which is the same but with only
+one close button on the left.
+
+Close buttons:
+^^^^^^^^^^^^^^
+*LMB*::
+ Close selected window.
+
+*RMB*::
+ Iconify selected window.
+
+*MMB*::
+ Identify selected window.
+
+*Alt + MMB*::
+ Destroy (kill) selected window.
+
+
+Maximize button (toggle between new size and default size):
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+*LMB*::
+ Maximize window.
+
+*Alt + LMB*::
+ Take the free space (to the next windows).
+
+*RMB*::
+ Maximize window horizontally.
+
+*Alt + RMB*::
+ Take the free space horizontally.
+
+*MMB*::
+ Maximize window vertically.
+
+*Alt + MMB*::
+ Take the free space horizontally.
+
+Window options button:
+^^^^^^^^^^^^^^^^^^^^^^
+*LMB*::
+ Minimize the window (or toggle to the default size).
+
+*Alt + LMB*::
+ Toggle sticky window mode.
+
+*RMB*::
+ Set window in "normal" mode (clears stay on top/bottom).
+
+*MMB*::
+ Set window to stay on top.
+
+*Alt + MMB*::
+ Set window to stay on bottom.
+
+
+Arrows button:
+^^^^^^^^^^^^^^
+*LMB*::
+ Move selected window to the left (upper) desktop page.
+ *Amiga model*: Iconify the window.
+
+*Alt + LMB*::
+ Go to the left (upper) page with selected window.
+
+*RMB*::
+ Move selected window to the right (lower) desktop page.
+
+*Alt + RMB*::
+ Go to the right (lower) page with selected window.
+
+*MMB*::
+ Move selected window to the previously active desktop page.
+
+*Alt + MMB*::
+ Go to the previously active desktop page with selected window.
+
+Other button models:
+~~~~~~~~~~~~~~~~~~~~
+Close button:
+^^^^^^^^^^^^^
+*LMB*::
+ Close window.
+
+*RMB* (in OS/2 and NeXTStep button model)::
+ Iconify window.
+
+Maximize button:
+^^^^^^^^^^^^^^^^
+*LMB*::
+ Maximize window.
+
+*Alt + LMB*::
+ Take the free space (to the next windows).
+
+*RMB*::
+ Maximize window horizontally.
+
+*Alt + RMB*::
+ Take the free space horizontally.
+
+*MMB*::
+ Maximize window vertically.
+
+*Alt + MMB*::
+ Take the free space horizontally.
+
+Iconify button:
+^^^^^^^^^^^^^^^
+*LMB*::
+ Iconify window.
+
+
+Applications panel:
+-------------------
+*LMB*::
+ Open the menu of selected application group.
+
+*RMB*::
+ Launch application which is shown on the app panel.
+
+
+Desktop pager:
+--------------
+*LMB*::
+ Switch to selected desktop/page.
+
+*RMB*::
+ Switch to selected region.
+
+MMB::
+ Move selected miniature window to a different desktop page, or move
+ outside the pager window to the current desktop.
+
+
+Window panel (shows currently opened windows):
+----------------------------------------------
+*LMB*::
+ Go to the window's desktop page, raise and focus it.
+
+*RMB*::
+ Bring selected window to the current page, raise and focus it.
+
+*MMB*::
+ Iconify/deiconify selected window.
+
+
+Icon panel (shows currently iconified windows):
+-----------------------------------------------
+*LMB*::
+ Bring back iconified window on the current page, raise and focus it.
+
+*RMB*::
+ Go to the window's desktop page, bring window back, raise and focus
+ it.
+
+
+Clock:
+------
+*LMB*, *MMB*::
+ Toggle between date and time display.
+
+*RMB*::
+ Toggle between 12h and 24h time format.
+
+
+"FVWM-Crystal" button:
+----------------------
+*LMB*::
+ Open the system menu.
+
+*MMB*::
+ Change wallpaper randomly.
+
+*Mouse wheel*::
+ Change the resolution using xrandr (only when the button is at the top
+ left corner)
+
+
+"FVWM-Crystal" button, Amiga Recipe - Top Desktop bar:
+------------------------------------------------------
+*LMB*::
+ Toggle the top bar between dekstop bar and menu bar.
+
+*MMB*::
+ Change wallpaper randomly
+
+*RMB*::
+ Open the system menu
+
+*Mouse wheel*::
+ Change the resolution using xrandr.
+
+
+Amiga Recipe - Top Menu bar:
+----------------------------
+*LMB*::
+ *Workbench button* - Toggle the top bar between dekstop bar and menu bar.
+ *Application buttons* - Launch preferred application #1
+
+*MMB*::
+ *Workbench button* - Toggle the top bar between dekstop bar and menu bar.
+ *Application buttons* - Launch preferred application #2
+
+*RMB*::
+ *Workbench button* - Open the system menu.
+ *Application buttons* - Open the category application menu
+
+
+
+"Switch left" button, Amiga recipe:
+-----------------------------------
+*LMB*::
+ Show/Hyde the player buttons, the notification area and the
+ application panel.
+
+*MMB*::
+ Show pount-gui to mount removable medias (for *kit free systems).
+
+*RMB*::
+ Show pmount-gui to un-mount removables medias.
+
+
+"Switch middle" button, Amiga recipe:
+-------------------------------------
+*LMB*::
+ Show/Hyde applications panel.
+
+
+"Player" button (not all the players implement all the functions):
+------------------------------------------------------------------
+*LMB*::
+ Open the players system menu.
+
+*MMB*::
+ Toggle player GUI.
+
+*RMB*::
+ Toggle visibility of QJackCtl.
+
+*Mouse wheel*::
+ Change volume up and down.
+
+
+"Eject" button:
+---------------
+*LMB*::
+ Open the playlist menu.
+
+*MMB*::
+ Open the player mixer menu.
+
+*RMB*::
+ Open the system volume menu.
+
+*Mouse wheel*::
+ Play next or previous media.
+
+
+"Play" button:
+--------------
+*LMB*::
+ Play.
+
+*MMB*::
+ Pause or toggle playback/pause.
+
+*RMB*::
+ Show the playback menu.
+
+*Mouse wheel*::
+ Change the speed up and down.
+
+
+"Forward" button:
+-----------------
+*LMB*::
+ Open the speed menu.
+
+*Mouse wheel*::
+ Seek reverse or forward.
+
+
+"Windows" button:
+-----------------
+*LMB*::
+ Show list of currently opened windows.
+
+*RMB*::
+ Show list of currently iconified windows.
+
+*MMB*::
+ Place again all windows on the current desktop page.
+
+
+"Desktop" button:
+-----------------
+*LMB* or *RMB*::
+ Show/hide desktop pager window.
+
+*MMB*::
+ Go to previously active desktop page.
+
+*Mouse wheel*::
+ Go to next/previous desktop page.
+
+AUTHORS
+-------
+Documentation written by Maciej Delmanowski <ha...@be...>
+Augmented, maintained and ported to asciidoc by Dominique Michel
+<dom...@us...>
+
+
+COPYRIGHT
+---------
+*FVWM-Crystal* and all the scripts and other files coming with
+the distribution are subject to the GNU General Public License (GPL).
+Please refer to the COPYING file that came with *FVWM-Crystal* for details.
+
+
+BUGS
+----
+Bug reports can be sent to the fvwm-crystal-users mailing list at
+<https://mail.gna.org/listinfo/fvwm-crystal-users/>.
+
+
Added: asciidoc/Tips
===================================================================
--- asciidoc/Tips (rev 0)
+++ asciidoc/Tips 2013-05-25 12:44:11 UTC (rev 468)
@@ -0,0 +1,74 @@
+Tips(1)
+=======
+:doctype: manpage
+:man source: Tips
+:man version: 3.1.12
+:man manual: FVWM-Crystal
+
+NAME
+----
+Tips - FVWM-Crystal: Tips and tricks
+
+SYNOPSIS
+--------
+
+None
+
+
+DESCRIPTION
+-----------
+Here you can find some random tips for the first run of FVWM-Crystal.
+
+I assume, that you already installed the package (if not, look in INSTALL file
+instead), and you are now inside your brand new desktop environment.
+
+
+* Right click on the desktop opens new terminal window.
+
+* Right click on the Close button will minimize a window. To bring it back,
+ click on the icon of the program in the icons panel, or double-click on the
+ thumbnail placed on the desktop (if you have a layout with thumbnails
+ enabled).
+
+* When you start FVWM-Crystal for the first time, there will be an
+ automatically generated panel with applications installed on your system.
+ Clicking on an icon of selected application with your RMB will
+ launch this application; clicking with LMB will open a menu with other
+ similar apps.
+
+* Clicking and holding a mouse button on the titlebar buttons will result in
+ opening of a small menu, which contains available commands for this button.
+ Letter in brackets indicates, which function will be ececuted when you
+ click on the certain button using your left (L), right (R) or middle (M)
+ mouse button.
+
+* If a wallpaper was not set at startup, make sure that you have 'hsetroot',
+ 'Esetroot' or 'feh' installed and available on your system. Try to set a wallpaper
+ using main menu (it may by a little slow at the first time, because
+ miniatures have to be generated).
+
+* You can change a wallpaper, window decorations and panel/menu colorsets
+ using the main menu (a desk-like icon). Your changes will be automatically
+ remembered for the next startup.
+
+* Some recipes provides no button. In the preferences, you can set if you want
+ or not a menu with a Left click on the desktop. It is On by default.
+ In any cases, Alt + Menu will popup the main menu.
+
+* In the preferences, the first time you will click on 'Generate application
+ menu', a popup will ask you to edit $HOME/.fvwm-crystal/preferences/IconDirs
+ and $HOME/.fvwm-crystal/preferences/DesktopDirs.
+
+AUTHORS
+-------
+Documentation written by Maciej Delmanowski <ha...@be...>
+Maintained and ported to asciidoc by Dominique Michel
+<dom...@us...>
+
+
+COPYRIGHT
+---------
+*FVWM-Crystal* and all the scripts and other files coming with
+the distribution are subject to the GNU General Public License (GPL).
+Please refer to the COPYING file that came with *FVWM-Crystal* for details.
+
Added: asciidoc/create.sh
===================================================================
--- asciidoc/create.sh (rev 0)
+++ asciidoc/create.sh 2013-05-25 12:44:11 UTC (rev 468)
@@ -0,0 +1,28 @@
+#!/bin/bash
+
+asciidoc_files=(ApplicationDatabase CrystalRoxHOWTO FAQ KeyboardBindings MouseBindings Tips)
+
+dodoc() {
+ a2x -vf manpage $1
+ if [[ $? != "0" ]]; then exit 1; fi
+ echo -e "\n**************************************************************************"
+ echo -e "**************************************************************************\n"
+ asciidoc -v $1
+ if [[ $? != "0" ]]; then exit 1; fi
+
+}
+
+for name in ${asciidoc_files[*]}
+do
+ dodoc ${name}
+done
+
+for name in *.1
+do
+ mv ${name} ../man/${name}
+done
+
+for name in *.html
+do
+ mv ${name} ../doc/html/${name}
+done
Property changes on: asciidoc/create.sh
___________________________________________________________________
Added: svn:executable
## -0,0 +1 ##
+*
\ No newline at end of property
Deleted: doc/Application database.txt
===================================================================
--- doc/Application database.txt 2013-05-25 09:47:54 UTC (rev 467)
+++ doc/Application database.txt 2013-05-25 12:44:11 UTC (rev 468)
@@ -1,192 +0,0 @@
-FVWM-Crystal: application database
-Written by: Maciej Delmanowski <ha...@be...>
-==================================================
-
-
-Overview
---------
-
-Application database (and fvwm-crystal.apps script) is one of the most
-interesting elements of FVWM-Crystal desktop. Thanks to these elements you can
-have a panel or the menu with applications currently installed on a given
-system.
-
-Database structure is very flexible, allowing you to combine several databases
-into one (system-wide and user-wide, for example), mask selected applications
-or even whole directories, so they won't be visible, and so on.
-
-Application panel/menu generator also has many interesting features - you can
-create different panels and menu systems and easily blend them with your FVWM
-configuration.
-
-
-Database structure
-------------------
-
-A database is a set of directories and scripts with special naming structure.
-Each directory and subdirectory creates a "category" in which you can put
-selected applications, for example "Games" or "Office". Categories can be
-nested, in turn creating subcategories, like "FPP Games" or "OpenOffice.org".
-In generation process each subdirectory is transformed into a submenu containg
-menu items specified in this subdirectory.
-
-Each directory and script have a special naming pattern. Here's the list of
-possible names:
-
- entry_name
- ~entry_name
- ~~entry_name
- ~executable_name~entry_name
- priority~entry_name
- priority~~entry_name
- priority~executable_name~entry_name
-
-"entry_name" is the name of the menu item or button on a panel. This is
-a required field. If it's the only one present, generator assumes that this
-entry should be put in the menu or panel without checking if associated
-application is present.
-
-"executable_name" is used to specify a name of the executable file. It's used
-to determine if selected application is installed on the system, and in turn
-decide if this entry should be put in the menu/panel or not. Applications are
-searched in the directories specified using $PATH environment variable. This
-field is optional, and is only tested, if '--check-exec' option is present.
-
-"priority" is a numeric only field (also optional). It is used in the sorting
-mechanism to determine, what "importance" has particular menu item. Entries
-with higher priorities will be put higher in the menu system (therefore closer
-to the mouse pointer), lower priorities will be pushed at the end of the menu.
-By default an entry without priority field has priority set to 0.
-
-As you can see, each directory and script name is used to sort and create menus
-and panels. Also attributes of the files and directories are used in this
-process. Each directory and script has an executable (x) bit set, for allowing
-execution (see below) or reading inside directories. This can be used to
-exclude certain files or directories from the generated menus or panels. By
-removing the executable bit (chmod -x) from a file or directory you can
-prevent it to be "seen" by the generator and ommited in the generated menu. By
-combining this ability with "database merging" (each database masks previous
-one) you can use, for example, user-side application database to remove
-certain programs from this users' menu.
-
-Generator doesn't put in the menu entry complete path to the binary it found
-- instead it puts the path to the script itself. In the end, what users do is
-not launching applications directly, but instead launching scripts located in
-the application database, which in turn launch the applications themselves.
-That means, what's inside of the script, is completely meaningless to the
-generator; you can write complex scripts which are shown in the menu system
-and easily launch them.
-
-Instead of using the scripts, you can also make symlinks to selected binaries
-(using the specified naming rules), they also will be checked and included in
-the menu system. Script automatically tests, if symlink is correct (ie. target
-is present), and if the target has an executable bit set.
-
-
-Database masking
-----------------
-
-You can give 'fvwm-crystal.apps' script several databases in one command, for
-example:
-
- fvwm-crystal.apps --database=/some/directory --database=/other/dir
-
-When that happens, generator first reads first given database
-(/some/directory), and after that adds next databases (/other/dir) to the
-first one. You can use this feature to make changes in separate database that
-affect generated menus and panels, but not modify the original database
-itself. This mechanism is used in FVWM-Crystal by combining user-side database
-located in '~/.fvwm/Applications' with system-wide, located in
-'/usr/share/fvwm-crystal/fvwm/Applications' (by default).
-
-For successfull "database masking" you need to use the same directory
-structure as the original database. That means, if you want to modify an entry
-located in, for example, '/Applications/Games/FPP', you need to create the
-same directories in your "local" database. You can omit the "priority" field
-in directory/file names, or change it, thus moving selected menu entry in the
-menu hierarhy. For example:
-
- system-wide: /Applications/20~Games/FPP/10~quake~Quake
- user-wide: /Applications/Games/FPP/30~quake~Quake
-
-File attributes also can be masked. If you want to remove a menu entry (or
-even entire submenu), you need to create all directories and a script which
-lead to selected entry, and then remove the executable bit (chmod -x) from the
-directory or script in your "local" database.
-
-Consequently, if you want to move a menu entry or submenu itself from one
-place to another in the menu structure, you can create neccesary files in
-desired location (or make symlinks to files/directories in original
-database), then creat...
[truncated message content] |
