doc/commands/ImagePath.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: ImagePath.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='ImagePath'>
  12 <title>ImagePath</title>
  13
  14 <cmdsynopsis>
  15         <command>ImagePath</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 images (both monochrome and pixmap).  To find an image given
  23 by a relative pathname, fvwm looks into each directory listed in
  24 turn, and uses the first file found.</para>
  25
  26 <para>If a directory is given in the form "/some/dir;.ext", this means
  27 all images in this directory have the extension ".ext" that should
  28 be forced.  The original image name (that may contain another
  29 extension or no extension at all) is not probed, instead ".ext" is
  30 added or replaces the original extension.  This is useful, for
  31 example, if a user has some image directories with ".xpm" images
  32 and other image directories with the same names, but ".png"
  33 images.</para>
  34
  35 <para>The
  36 <replaceable>path</replaceable>
  37 may contain environment variables such as
  38 <envar>$HOME</envar> (or <envar>${HOME}</envar>).
  39 Further, a '+' in the
  40 <replaceable>path</replaceable>
  41 is expanded to the previous value of the path, allowing appending
  42 or prepending to the path easily.</para>
  43
  44 <para>For example:</para>
  45
  46 <programlisting>
  47 ImagePath $HOME/icons:+:/usr/include/X11/bitmaps
  48 </programlisting>
  49
  50 <para>Note: if the
  51 <fvwmref mod="FvwmM4"/>
  52 module is used to parse your
  53 <filename>config</filename>
  54 files, then m4 may want to mangle the word "include" which
  55 frequently shows up in the
  56 <emphasis remap='B'>ImagePath</emphasis>
  57 command.  To fix this one may add</para>
  58
  59 <programlisting>
  60 undefine(`include')
  61 </programlisting>
  62
  63 <para>prior to the
  64 <emphasis remap='B'>ImagePath</emphasis>
  65 command, or better: use the
  66 <option>-m4-prefix</option>
  67 option to force all
  68 <emphasis remap='B'>m4</emphasis>
  69 directives to have a prefix of "m4_" (see the
  70 <fvwmref mod="FvwmM4"/>
  71 man page).</para>
  72
  73 </section>