doc/fvwm/moduleCommands.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: moduleCommands.xml,v 1.4 2007/08/06 22:24:03 domivogt Exp $ -->
  10
  11 <section id='module_commands'>
  12 <title>Module Commands</title>
  13
  14
  15 <para>Fvwm maintains a database of module configuration lines in a form</para>
  16
  17 <programlisting>
  18 <emphasis remap='B'>*</emphasis><emphasis remap='I'>&lt;ModuleName&gt;</emphasis><emphasis remap='B'>: </emphasis><emphasis remap='I'>&lt;Config-Resource&gt;</emphasis>
  19 </programlisting>
  20
  21 <para>where
  22 <emphasis remap='I'>&lt;ModuleName&gt;</emphasis>
  23 is either a real module name or an alias.</para>
  24
  25 <para>This database is initially filled from config file (or from
  26 output of
  27 <option>-cmd</option>
  28 config command), and can be later modified either by user (via
  29 <fvwmref mod="FvwmCommand"/>)
  30 or by modules.</para>
  31
  32 <para>When modules are run, they read appropriate portion of database.
  33 (The concept of this database is similar to one used in X resource
  34 database).</para>
  35
  36 <para>Commands for manipulating module configuration database are
  37 described below.</para>
  38
  39 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Asterisk.xml" />
  40 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="DestroyModuleConfig.xml" />
  41 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="KillModule.xml" />
  42 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Module.xml" />
  43 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="ModuleListenOnly.xml" />
  44 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="ModulePath.xml" />
  45 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="ModuleSynchronous.xml" />
  46 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="ModuleTimeout.xml" />
  47 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="SendToModule.xml" />
  48
  49
  50 </section>