doc/commands/Module.xml

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