doc/commands/SendToModule.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: SendToModule.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='SendToModule'>
  12 <title>SendToModule</title>
  13
  14 <cmdsynopsis>
  15         <command>SendToModule</command
  16         ><arg choice='plain'
  17                 ><replaceable>modulename</replaceable
  18         ></arg
  19         ><arg choice='plain'
  20                 ><replaceable>string</replaceable
  21         ></arg>
  22 </cmdsynopsis>
  23
  24 <para>Sends an arbitrary string (no quotes required) to all modules,
  25 whose alias or name matching
  26 <replaceable>modulename</replaceable>,
  27 which may contain wildcards.  This only makes sense if the module
  28 is set up to understand and deal with these strings though. Can be
  29 used for module to module communication, or implementation of more
  30 complex commands in modules.</para>
  31
  32
  33 </section>