1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"../docbook-xml/docbookx.dtd"
[
<!ENTITY % myents SYSTEM "../fvwm.ent" >
%myents;
]>
<!-- $Id$ -->
<section id='Module'>
<title>Module</title>
<cmdsynopsis>
<command>Module</command
><arg choice='plain'
><replaceable>modulename</replaceable
></arg
><arg choice='opt'
><replaceable>moduleparams</replaceable
></arg>
</cmdsynopsis>
<para>Specifies a module with its optional parameters which should be
spawned. Currently several modules, including
<fvwmref mod="FvwmButtons"/>,
<fvwmref mod="FvwmEvent"/>,
<fvwmref mod="FvwmForm"/>,
<fvwmref mod="FvwmPager"/>,
<fvwmref mod="FvwmScript"/>
support aliases. Aliases are useful if more than one instance of
the module should be spawned. Aliases may be configured
separately using
<emphasis remap='B'>*</emphasis>
syntax. To start a module
<emphasis remap='B'>FvwmForm</emphasis>
using an alias
<emphasis remap='I'>MyForm</emphasis>,
the following syntax may be used:</para>
<programlisting>
Module FvwmForm MyForm
</programlisting>
<para>At the current time the available modules (included with fvwm) are
<fvwmref mod="FvwmAnimate"/> (produces animation effects when a window is iconified or de-iconified),
<fvwmref mod="FvwmAuto"/> (an auto raise module),
<fvwmref mod="FvwmBacker"/> (to change the background when you change desktops),
<fvwmref mod="FvwmBanner"/> (to display a spiffy XBM, XPM, PNG or SVG),
<fvwmref mod="FvwmButtons"/> (brings up a customizable tool bar),
<fvwmref mod="FvwmCommandS"/> (a command server to use with shell's FvwmCommand client),
<fvwmref mod="FvwmConsole"/> (to execute fvwm commands directly),
<fvwmref mod="FvwmCpp"/> (to preprocess your <emphasis remap='I'>config</emphasis> with cpp),
<fvwmref mod="FvwmEvent"/> (trigger various actions by events),
<fvwmref mod="FvwmForm"/> (to bring up dialogs),
<fvwmref mod="FvwmIconMan"/> (a flexible icon manager),
<fvwmref mod="FvwmIdent"/> (to get window info),
<fvwmref mod="FvwmM4"/> (to preprocess your <emphasis remap='I'>config</emphasis> with m4),
<fvwmref mod="FvwmPager"/> (a mini version of the desktop),
<fvwmref mod="FvwmPerl"/> (a Perl manipulator and preprocessor),
<fvwmref mod="FvwmProxy"/> (to locate and control obscured windows by using small proxy windows),
<fvwmref mod="FvwmRearrange"/> (to rearrange windows),
<fvwmref mod="FvwmScript"/> (another powerful dialog toolkit),
These modules have their own man
pages. There may be other modules out on there as well.</para>
<para>Modules can be short lived transient programs or, like
<fvwmref mod="FvwmButtons"/>
,
can remain for the duration of the X session. Modules are
terminated by the window manager prior to restarts and quits, if
possible. See the introductory section on modules. The keyword
<emphasis remap='B'>Module</emphasis>
may be omitted if
<replaceable>modulename</replaceable>
is distinct from all fvwm commands.</para>
</section>
|
