doc/commands/Function.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: Function.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='Function'>
  12 <title>Function</title>
  13
  14 <cmdsynopsis>
  15         <command>Function</command
  16         ><arg choice='plain'
  17                 ><replaceable>FunctionName</replaceable
  18         ></arg>
  19 </cmdsynopsis>
  20
  21 <para>Used to bind a previously defined function to a key or mouse
  22 button. The following example binds mouse button 1 to a function
  23 called "Move-or-Raise", whose definition was provided as an
  24 example earlier in this man page.  After performing this binding
  25 fvwm executes the "move-or-raise" function whenever button 1 is
  26 pressed in a window's title-bar.</para>
  27
  28 <programlisting>
  29 <fvwmref cmd="Mouse"/> 1 T A Function Move-or-Raise
  30 </programlisting>
  31
  32 <para>The keyword
  33 <emphasis remap='B'>Function</emphasis>
  34 may be omitted if
  35 <replaceable>FunctionName</replaceable>
  36 does not coincide with an fvwm command.</para>
  37
  38 <para>Warning:  Please read the comments on executing complex functions
  39 in the section <fvwmref sect="scripting" opt="scripting_and_complex_functions" name="Scripting and Complex Functions"/>.</para>
  40
  41 </section>