doc/commands/Stick.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: Stick.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='Stick'>
  12 <title>Stick</title>
  13
  14 <cmdsynopsis>
  15         <command>Stick</command
  16         ><arg choice='opt'
  17                 ><replaceable>bool</replaceable
  18         ></arg>
  19 </cmdsynopsis>
  20
  21 <para>If the
  22 <replaceable>bool</replaceable>
  23 argument is empty or "<fvwmopt cmd="Stick" opt="toggle"/>", the
  24 <emphasis remap='B'>Stick</emphasis>
  25 command makes a window sticky if it is not already sticky, or
  26 non-sticky if it is already sticky.  To make a window sticky
  27 regardless of its current state the
  28 <replaceable>bool</replaceable>
  29 argument must be "True".  To make it non-sticky use "False".</para>
  30
  31 </section>