doc/commands/Iconify.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: Iconify.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='Iconify'>
  12 <title>Iconify</title>
  13
  14 <cmdsynopsis>
  15         <command>Iconify</command
  16         ><arg choice='opt'
  17                 ><replaceable>bool</replaceable
  18         ></arg>
  19 </cmdsynopsis>
  20
  21 <para>Iconifies a window if it is not already iconified or de-iconifies
  22 it if it is already iconified.  The optional argument
  23 <replaceable>bool</replaceable>
  24 is a boolean argument.  "<fvwmopt cmd="Iconify" opt="True"/>" means only iconification is
  25 allowed, while "<fvwmopt cmd="Iconify" opt="False"/>" forces de-iconification.  Using "<fvwmopt cmd="Iconify" opt="toggle"/>"
  26 switches between iconified and de-iconified states.</para>
  27
  28 <para>There are a number of
  29 <fvwmref cmd="Style"/>
  30 options which influence the appearance and behavior of icons (e.g.
  31 <fvwmref cmd="Style" opt="StickyIcon" />, <fvwmref cmd="Style" opt="NoIcon"/>).</para>
  32
  33 <para>For backward compatibility, the optional argument may also be a
  34 positive number instead of "True", or a negative number instead
  35 of "False".  Note that this syntax is obsolete, and will be removed
  36 in the future.</para>
  37
  38 </section>