doc/commands/BorderStyle.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: BorderStyle.xml,v 1.3 2007/06/16 12:38:45 griph Exp $ -->
  10
  11 <section id='BorderStyle'>
  12 <title>BorderStyle</title>
  13
  14 <cmdsynopsis>
  15         <command>BorderStyle</command
  16         ><arg choice='plain'
  17                 ><replaceable>state</replaceable
  18         ></arg
  19         ><arg choice='opt'
  20                 ><replaceable>style</replaceable
  21         ></arg
  22         ><arg choice='opt'
  23                 >-- <arg choice='plain' rep='repeat'
  24                         ><optional>!</optional
  25                         ><replaceable>flag</replaceable
  26                 ></arg
  27         ></arg>
  28 </cmdsynopsis>
  29
  30 <para>Defines a border style for windows.
  31 <replaceable>state</replaceable>
  32 can be either "<fvwmopt cmd="BorderStyle" opt="Active"/>" or "<fvwmopt cmd="BorderStyle" opt="Inactive"/>".  If
  33 <replaceable>state</replaceable>
  34 is omitted, then the style is set for both states.  If the
  35 <replaceable>style</replaceable> and <replaceable>flags</replaceable>
  36 are enclosed in parentheses, then multiple
  37 <replaceable>state</replaceable>
  38 definitions can be specified per line.</para>
  39
  40 <para><replaceable>style</replaceable>
  41 is a subset of the available button styles, and can only be
  42 <fvwmopt cmd="BorderStyle" opt="TiledPixmap"/>
  43 (uniform pixmaps which match the bevel colors work best this
  44 way) or <fvwmopt cmd="BorderStyle" opt="Colorset"/>. If a
  45 '!' is prefixed to any
  46 <replaceable>flag</replaceable>,
  47 the behavior is negated.  If
  48 <replaceable>style</replaceable>
  49 is not specified, then one can change flags without resetting the
  50 style.</para>
  51
  52 <para>The
  53 <fvwmopt cmd="BorderStyle" opt="HiddenHandles"/>
  54 flag hides the corner handle dividing lines on windows with
  55 handles (this option has no effect for !<fvwmref cmd="Style" opt="Handles"/> windows).  By
  56 default,
  57 <emphasis remap='I'>HiddenHandles</emphasis>
  58 is disabled.</para>
  59
  60 <para>The
  61 <fvwmopt cmd="BorderStyle" opt="NoInset"/>
  62 flag supplements
  63 <emphasis remap='I'>HiddenHandles</emphasis>.
  64 If given, the inner bevel around the window frame is not drawn.
  65 If
  66 <emphasis remap='I'>HiddenHandles</emphasis>
  67 is not specified, the frame looks a little strange.</para>
  68
  69 <para>
  70 <fvwmopt cmd="BorderStyle" opt="Raised"/>
  71 causes a raised relief pattern to be drawn (default).
  72 <fvwmopt cmd="BorderStyle" opt="Sunk"/>
  73 causes a sunken relief pattern to be drawn.
  74 <fvwmopt cmd="BorderStyle" opt="Flat"/>
  75 inhibits the relief pattern from being drawn.</para>
  76
  77 <para>To decorate the active and inactive window borders with a textured
  78 pixmap, one might specify:</para>
  79
  80 <programlisting>
  81 BorderStyle Active TiledPixmap marble.xpm
  82 BorderStyle Inactive TiledPixmap granite.xpm
  83 BorderStyle Active -- HiddenHandles NoInset
  84 </programlisting>
  85
  86 <para>To clear the style for both states:</para>
  87
  88 <programlisting>
  89 BorderStyle <fvwmopt cmd="BorderStyle" opt="Simple"/>
  90 </programlisting>
  91
  92 <para>To clear for a single state:</para>
  93
  94 <programlisting>
  95 BorderStyle Active Simple
  96 </programlisting>
  97
  98 <para>To unset a flag for a given state:</para>
  99
 100 <programlisting>
 101 BorderStyle Inactive -- !NoInset
 102 </programlisting>
 103
 104 <para>title-bar buttons can inherit the border style with the
 105 <fvwmref cmd="ButtonStyle" opt="UseBorderStyle"/>
 106 flag (see
 107 <fvwmref cmd="ButtonStyle"/>).</para>
 108
 109 </section>