<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man wmdrawer.sgml > wmdrawer.1x'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.
  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Chris</firstname>">
  <!ENTITY dhsurname   "<surname>Wesley</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>April 7, 2003</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>chris@cwwesley.net</email>">
  <!ENTITY dhusername  "Chris Wesley">
  <!ENTITY dhucpackage "<refentrytitle>WMDRAWER</refentrytitle>">
  <!ENTITY dhpackage   "wmdrawer">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2002-2004</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>

  <refmeta>
    &dhucpackage;
    &dhsection;
  </refmeta>

  <refnamediv>
    <refname>&dhpackage;</refname>
    <refpurpose>a dockapp providing a drawer to launch applications</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <arg><option>-c, --configfile=<replaceable>FILE</replaceable></option> [<option>-n, --instancename=<replaceable>NAME</replaceable></option>]</arg>
      <arg><option>-w, --windowed</option></arg>
      <arg><option>-h, --help</option></arg>
      <arg><option>-v, --version</option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
    <para><command>&dhpackage;</command> is a dock application (dockapp) that
      provides a drawer (retractable button bar) to conveniently launch applications.
    </para>
    <para>The drawer is retractable and animated.</para>
    <para>Several columns of buttons can been defined in the drawer.</para>
    <para>The configuration file is automaticaly reloaded if it changes.</para>
    <para>Multiple instances of the program can run at the same time.</para>
    <para>The buttons can be highlighted under the mouse cursor.</para>
    <para>A tooltip can be defined for each button.</para>
    <para>The drawer can be transparent (need SHAPE extension).</para>
    <para>Ability to launch several apps at once from the drawer.
    By holding down the key Shift or by using mouse buttons
    middle or right instead of left, you can keep the drawer opened.
    </para>
    <para>Adjustable behaviors:
    dock's image (logo),
    dock's width and height (for both min=12, max=128),
    automatic/manual opening and closing of the drawer,
    timeout value in miliseconds if automatic closing selected,
    drawer's opening direction and animation speed,
    mouse cursor type in the drawer,
    drawer's pseudo-transparency,
    icons' background image (only if transparency isn't activated),
    buttons' size (min=12, max=128),
    buttons' highlight type (0:none, 1:target, 2:shading),
    image used as highlight (target type only),
    color and darkening level for highlight (shading type only),
    drawer's border size,
    buttons' tooltips and tooltips' font
   </para>
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term><option>-c, --configfile=<replaceable>FILE</replaceable> [-n, --instancename=<replaceable>NAME</replaceable>]</option>
        </term>
        <listitem>
          <para>Use <replaceable>FILE</replaceable> as config file instead of the default (<filename>~/.wmdrawerrc</filename>) and optionaly set instance name.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-w, --windowed</option>
        </term>
        <listitem>
          <para>Run in windowed mode. Useful for AfterStep, Fvwm, Sawfish and KDE users.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h, --help</option>
        </term>
        <listitem>
          <para>Show summary of options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-v, --version</option>
        </term>
        <listitem>
          <para>Show version of program.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>FILES</title>
    <para><filename>~/.wmdrawerrc</filename> is the default per-user configuration file. Here is a completely commented example.
    </para>
<para><programlisting>
# Config file example for wmdrawer
[general]
# Dock's icon [optional]
#dock_icon	panel-drawer.png

# Drawer's opening direction [required]
# Top to bottom = 0
# Right to Left = 1
# Bottom to Top = 2
# Left to Right = 3
direction       2

# Image used for icons' background [optional]
#icons_bg	defaultTile.xpm

# Allow icons' enlargement to fit them to buttons' size [optional, default 1]
# 0 indicate that icons should never be larger than their original size.
#icons_expand   1

# Activate the drawer's pseudo-transparency [optional, default 0]
# if you choose transparency, icons_bg will be ignored
#transparency   0

# dock's width: min=12, max=128 [optional, default=64]
#dock_width     64

# dock's height: min=12, max=128 [optional, default=64]
#dock_height    64

# buttons' size: min=12, max=128 [optional]
# Useful for the people who want for example to have big icons
# and to define several columns.
#btns_size      32

# Icon's highlight type: 0, 1 or 2 [optional, default 2]
# 0 : no highlight
# 1 : target (unavailable if transparency is activated)
# 2 : shading
#highlight      2

# Image used as highlight [optional]
# only used if you choice target type
#highlight_img	 highlight.xpm

# Tint icons by a specified color [optional, default #ffffff]
# only used if you choice shading type
#highlight_tint	#ffffff

# Shade icons at a specified level [optional, default 60]
# only used if you choice shading type
#highlight_sh   60

# Display buttons' tooltips [optional, default 1]
#tooltips       1

# Tooltips' font [optional, default fixed]
#tooltips_font  fixed

# Drawer's animation speed: 0, 1, 2, 3, 4 [optional, default 1]
#animation_speed 1

# Mouse cursor in drawer: 0, 1, ..., 76 [optional, default 30]
#cursor	        30

# Auto opening of the drawer: 0, 1 [optional, default 0]
#show_on_hover  0

# Auto closing of the drawer: 0, 1 [optional, default 0]
#hide_on_out    0

# drawer's hiding timeout in miliseconds [optional, default 1000]
#hide_timeout   1000

# Runs the dockapp in windowed mode: 0, 1 [optional, default 0]
# Useful for AfterStep, Fvwm, Sawfish or KDE users.
#windowed_mode  0

# Instance name so window manager can distinguish between multiple copies
#instance_name	distinguish_name

# Drawer's border size in pixels [optional, default 1]
#border_size    1

# Images directories
[images_paths]
/usr/share/pixmaps
/usr/local/share/pixmaps/

# A first column with 5 buttons
# Each button must be defined with this syntax:
# (tooltip)  (image)  (command)
[column]
(X Terminal)	(gnome-term.png)	(xterm -bg black -fg wheat)
(Galeon)	(galeon.xpm)		(galeon -s)
(Sylpheed)	(sylpheed.png)		(sylpheed)
(XChat)		(xchat.png)		(xchat)
(MPlayer)	(gnome-multimedia.png)	(mplayer)

# A second column with 5 buttons
[column]
(Xmms)		(gnome-audio2.png)	(xmms)
(Gimp)		(gnome-gimp.png)	(gimp)
(GQview)	(gqview.png)		(gqview)
(Xcalc)		(gnome-calc3.png)	(xcalc)
(GFtp)		(gftp.png)		(gftp)
</programlisting></para>
    <para>
    Look at <filename>/usr/share/doc/wmdrawer/wmdrawerrc.example</filename> for a copy of this example.
    </para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
    <para>wmaker (1)</para>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>
    <para>This software is written and maintained by Val&eacute;ry Febvre
      (<email>vfebvre@vfebvre.lautre.net</email>).</para>
    <para>This manual page was written by &dhusername; (&dhemail;) for
      the &debian; system (but may be used by others).  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the <acronym>GNU</acronym> Free Documentation
      License, Version 1.1 or any later version published by the Free
      Software Foundation; with no Invariant Sections, no Front-Cover
      Texts and no Back-Cover Texts.</para>
  </refsect1>

  <refsect1>
    <title>OTHER INFO</title>
    <para>wmDrawer's webpage is at http://people.easter-eggs.org/~valos/wmdrawer/.
    Here you can find info about wmdrawer and download the latest version.</para>
  </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
