doc/commands/XineramaPrimaryScreen.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: XineramaPrimaryScreen.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='XineramaPrimaryScreen'>
  12 <title>XineramaPrimaryScreen</title>
  13
  14 <cmdsynopsis>
  15         <command>XineramaPrimaryScreen</command
  16         ><arg choice='opt'>primary-screen</arg>
  17 </cmdsynopsis>
  18
  19 <para>Takes an integer number or 'g' or 'c' as its argument.  A number
  20 is taken as the number of the Xinerama screen that is to be used
  21 as the primary screen.  The primary screen can be used as the
  22 preferred screen to place windows with</para>
  23
  24 <programlisting>
  25 XineramaPrimaryScreen &lt;screen number&gt;
  26 <fvwmref cmd="Style"/> * StartsOnScreen p
  27 </programlisting>
  28
  29 <para>The primary screen is used in some of the modules and for the
  30 default icon box too.  Any number that is zero or more is taken as
  31 the primary screen's number.  Instead, the letter 'c' indicates to
  32 use the current screen (containing the pointer) whenever the
  33 primary screen is used.  This may be very confusing under some
  34 circumstances.  With 'g', the global screen is used as the primary
  35 screen, effectively disabling the primary screen.  Calling this
  36 function with any other argument (including none) resets the
  37 primary screen to 0.</para>
  38
  39 </section>