cvsimport
[fvwm.git] / doc / fvwm / xinerama.xml
blob41da3ddf8fbd9db33704d2cc382234a7b0e0c1bd
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 ]>
7 <section id='xinerama_support'>
8 <title>Xinerama Support</title>
9 <para>Fvwm supports the Xinerama extension of newer X servers
10 which is similar to multi head support (multiple screens) but
11 allows to move windows between screens.  If Xinerama support has
12 been compiled into fvwm, it is used whenever fvwm runs on an X
13 server that supports and uses multiple screens via Xinerama.
14 Without this option, the whole desktop is treated as one big
15 screen.  For example, menus might pop up right between two
16 screens.  The <fvwmref cmd="Style" opt="EdgeResistance"/> option
17 of the <fvwmref cmd="Style"/> command command allows for specifying
18 an explicit resistance value for moving windows over the screen
19 edge between two Xinerama screens. Xinerama support can be enabled
20 or disabled on the fly or from the configuration file with the
21 <fvwmref cmd="Xinerama"/> command.  Many modules and commands work
22 nicely with Xinerama displays.</para>
24 <para>Whenever a geometry in the usual X format can be supplied,
25 fvwm's Xinerama extension allows for specifying a screen in addition
26 to the geometry (or even the screen alone).  To do this, a '@' is
27 added to the end of the geometry string followed by either the
28 screen number or a letter.  A number is taken as the number of the
29 Xinerama screen to be used (as configured in the X server).  The
30 letter can be one of 'g' for the global screen (the rectangle that
31 encloses all Xinerama screens), 'p' for the primary screen (see
32 below), 'c' for the current screen (the one that currently
33 contains the pointer).  If the X server does not support Xinerama
34 or only one screen is used, the screen bit is ignored.</para>
37 <programlisting>
38 <fvwmref cmd="Style"/> * <fvwmref cmd="Style" opt="IconBox"/> 64x300-0-0@p
39 </programlisting>
42 <para>Xinerama support can be configured to use a primary screen.  Fvwm
43 can be configured to place new windows and icons on this screen.
44 The primary screen is screen 0 by default but can be changed with
45 the
46 <fvwmref cmd="XineramaPrimaryScreen"/>
47 command.</para>
49 <para>Xinerama support was designed to work out of the box with the same
50 configuration file that would work on a single screen.  It may
51 not perform very well if the involved screens use different screen
52 resolutions.  In this situation, windows may get stuck in the
53 portion of the whole desktop that belongs to neither screen.  When
54 this happens, the windows or icons can be retrieved with the
55 command</para>
57 <programlisting>
58 <fvwmref cmd="All"/> <fvwmref cmd="MoveToScreen"/>
59 </programlisting>
62 <para>that can be entered in an <fvwmref mod="FvwmConsole"/> window or
63 with <fvwmref mod="FvwmCommand"/>.</para>
65 <para>For multi-screen implementations other than Xinerama, such as
66 Single Logical Screen, it is possible to simulate a Xinerama
67 configuration if the total screen seen by fvwm is made up of
68 equal sized monitors in a rectangular grid.  The commands
69 <fvwmref cmd="XineramaSls"/>, <fvwmref cmd="XineramaSlsSize"/> and <fvwmref cmd="XineramaSlsScreens"/>
70 are used to configure this feature.</para>
72 </section>