doc/commands/ModulePath.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: ModulePath.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='ModulePath'>
  12 <title>ModulePath</title>
  13
  14 <cmdsynopsis>
  15         <command>ModulePath</command
  16         ><arg choice='plain'
  17                 ><replaceable>path</replaceable
  18         ></arg>
  19 </cmdsynopsis>
  20
  21 <para>Specifies a colon separated list of directories in which to search
  22 for modules.  To find a module, fvwm searches each directory in
  23 turn and uses the first file found.  Directory names on the list
  24 do not need trailing slashes.</para>
  25
  26 <para>The
  27 <emphasis remap='B'>ModulePath</emphasis>
  28 may contain environment variables such as
  29 <envar>$HOME</envar> (or <envar>${HOME}</envar>).
  30 Further, a '+' in the
  31 <replaceable>path</replaceable>
  32 is expanded to the previous value of the
  33 <replaceable>path</replaceable>,
  34 allowing easy appending or prepending to the
  35 <replaceable>path</replaceable>.</para>
  36
  37 <para>For example:</para>
  38
  39 <programlisting>
  40 ModulePath ${HOME}/lib/fvwm/modules:+
  41 </programlisting>
  42
  43 <para>The directory containing the standard modules is available via the
  44 environment variable
  45 <envar>$FVWM_MODULEDIR</envar>.</para>
  46
  47 </section>