doc/commands/Layer.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: Layer.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='Layer'>
  12 <title>Layer</title>
  13
  14 <cmdsynopsis>
  15         <command>Layer</command
  16         ><group choice='plain'
  17                 ><arg choice='opt'
  18                         ><replaceable>arg1</replaceable
  19                         > <replaceable>arg2</replaceable
  20                 ></arg
  21                 ><arg choice='opt'>default</arg
  22         ></group>
  23 </cmdsynopsis>
  24
  25 <para>Puts the current window in a new layer.  If
  26 <replaceable>arg1</replaceable>
  27 is non zero then the next layer is the current layer number plus
  28 <replaceable>arg1</replaceable>.
  29 If
  30 <replaceable>arg1</replaceable>
  31 is zero then the new layer is
  32 <replaceable>arg2</replaceable>.</para>
  33
  34 <para>As a special case,
  35 <fvwmopt cmd="Layer" opt="default"/>
  36 puts the window in its default layer, i.e. the layer it was
  37 initially in.  The same happens if no or invalid arguments are
  38 specified.</para>
  39
  40 </section>