Minor manpage formatting fix.
[fvwm.git] / doc / commands / Focus.xml
blob4c029c0b6d0a90674ea1260debfd9ef6a77a9382
1 <?xml version="1.0" encoding="UTF-8" ?>
2 <!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3   "../docbook-xml/docbookx.dtd"
5 <!ENTITY % myents SYSTEM "../fvwm.ent" >
6 %myents;
7 ]>
9 <!-- $Id: Focus.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
11 <section id='Focus'>
12 <title>Focus</title>
14 <cmdsynopsis>
15         <command>Focus</command
16         ><arg choice='opt'>NoWarp</arg>
17 </cmdsynopsis>
19 <para>Sets the keyboard focus to the selected window.  If the
20 <fvwmopt cmd="Focus" opt="NoWarp"/>
21 argument is given, this is all it does.  Otherwise it also moves
22 the viewport or window as needed to make the selected window
23 visible. This command does not automatically raise the
24 window. Does not warp the pointer into the selected window (see
25 <fvwmref cmd="WarpToWindow"/>
26 function).  Does not de-iconify.  This command does not alter the
27 order of the
28 <emphasis remap='B'>WindowList</emphasis>,
29 it rotates the
30 <emphasis remap='B'>WindowList</emphasis>
31 around so that the target window is at the start.</para>
33 <para>When the
34 <emphasis remap='I'>NoWarp</emphasis>
35 argument is given, Focus cannot transfer the keyboard focus to
36 windows on other desks.</para>
38 <para>To raise and/or warp a pointer to a window together with
39 <emphasis remap='B'>Focus</emphasis> or <fvwmref cmd="FlipFocus"/>,
40 use a function, like:</para>
42 <programlisting>
43 <fvwmref cmd="AddToFunc"/> SelectWindow
44 + I Focus
45 + I <fvwmref cmd="Iconify"/> false
46 + I <fvwmref cmd="Raise"/>
47 + I <fvwmref cmd="WarpToWindow"/> 50 8p
48 </programlisting>
50 </section>