File: Break.xml

package info (click to toggle)
fvwm 1%3A2.7.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 15,968 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,087 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='Break'>
<title>Break</title>

<cmdsynopsis>
	<command>Break</command>
	<arg choice='opt'
		><replaceable>levels</replaceable
	></arg>
</cmdsynopsis>

<para>If the break command is used in a function, function execution is
terminated immediately.  Further commands of the function are not
processed.  Normally, all nested invocations of complex functions
are left.  An optional integer number
<replaceable>levels</replaceable>
may be given to break out of the given number of nested functions
and continue execution of a higher level function.
The
<emphasis remap='B'>Break</emphasis>
command always has the return code -2.  Example:</para>

<programlisting>
<fvwmref cmd="AddToFunc"/> PickWindowRaiseAndDeiconify
+ I <fvwmref cmd="Pick"/>
+ I <fvwmref cmd="TestRc"/> (Error) Break
+ I <fvwmref cmd="Raise"/>
+ I <fvwmref cmd="Iconify"/> off
</programlisting>


</section>