File: Function.xml

package info (click to toggle)
fvwm 1%3A2.7.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 15,908 kB
  • sloc: ansic: 145,836; xml: 17,096; perl: 7,237; sh: 5,100; makefile: 1,101; yacc: 688; lex: 187; sed: 11
file content (41 lines) | stat: -rw-r--r-- 1,208 bytes parent folder | download | duplicates (5)
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
<?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='Function'>
<title>Function</title>

<cmdsynopsis>
	<command>Function</command
	><arg choice='plain'
		><replaceable>FunctionName</replaceable
	></arg>
</cmdsynopsis>

<para>Used to bind a previously defined function to a key or mouse
button. The following example binds mouse button 1 to a function
called "Move-or-Raise", whose definition was provided as an
example earlier in this man page.  After performing this binding
fvwm executes the "move-or-raise" function whenever button 1 is
pressed in a window's title-bar.</para>

<programlisting>
<fvwmref cmd="Mouse"/> 1 T A Function Move-or-Raise
</programlisting>

<para>The keyword
<emphasis remap='B'>Function</emphasis>
may be omitted if
<replaceable>FunctionName</replaceable>
does not coincide with an fvwm command.</para>

<para>Warning:  Please read the comments on executing complex functions
in the section <fvwmref sect="scripting" opt="scripting_and_complex_functions" name="Scripting and Complex Functions"/>.</para>

</section>