doc/fvwm/environment.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!-- $Id: environment.xml,v 1.2 2007/08/07 10:11:05 griph Exp $ -->
   3 <!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   4   "../docbook-xml/docbookx.dtd"
   5 [
   6 <!ENTITY % myents SYSTEM "../fvwm.ent" >
   7 %myents;
   8 ]>
   9
  10
  11 <section id='environment'>
  12 <title>Environment</title>
  13 The environment variables that have an effect on how fvwm operates
  14 are the following:
  15 <variablelist>
  16   <varlistentry>
  17     <term><envar>DISPLAY</envar></term>
  18     <listitem>
  19       <para>Fvwm starts on this display unless the <option>-display</option>
  20         option is given.</para>
  21     </listitem>
  22   </varlistentry>
  23   <varlistentry>
  24     <term><envar>FVWM_MODULEDIR</envar></term>
  25     <listitem>
  26       <para>Set by fvwm to the directory containing the standard fvwm
  27         modules.</para>
  28     </listitem>
  29   </varlistentry>
  30   <varlistentry>
  31     <term><envar>FVWM_USERDIR</envar></term>
  32     <listitem>
  33       <para>Used to determine the user's data directory for reading and
  34         sometimes writing personal files. If this variable is not already
  35         set, it is set by fvwm to <filename>$HOME/.fvwm</filename>, which
  36         is the default user's data directory.</para>
  37     </listitem>
  38   </varlistentry>
  39   <varlistentry>
  40     <term><envar>SESSION_MANAGER</envar></term>
  41     <listitem>
  42       <para>Fvwm tries to contact this session manager.</para>
  43     </listitem>
  44   </varlistentry>
  45   <varlistentry>
  46     <term><envar>SESSION_MANAGER_NAME</envar></term>
  47     <listitem>
  48       <para>This is used mainly to determine xsm running to work around its
  49 bug. If this variable is set to "xsm", DiscardCommand is set as
  50 xsm expects it and not as XSMP requires.  If you run fvwm under
  51 xsm, you should set this variable to "xsm", otherwise old state
  52 files are not removed.</para>
  53     </listitem>
  54   </varlistentry>
  55   <varlistentry>
  56     <term><envar>SM_SAVE_DIR</envar></term>
  57     <listitem>
  58       <para>If this is set, fvwm saves its session data in this
  59 directory. Otherwise it uses <envar>$HOME</envar>.
  60 Note, the state files are named <filename>.fs-??????</filename>
  61 and normally are removed automatically when not used anymore.</para>
  62     </listitem>
  63   </varlistentry>
  64 </variablelist>
  65 </section>