doc/commands/SetEnv.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: SetEnv.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='SetEnv'>
  12 <title>SetEnv</title>
  13
  14 <cmdsynopsis>
  15         <command>SetEnv</command
  16         ><arg choice='plain'
  17                 ><replaceable>variable</replaceable
  18         ></arg
  19         ><arg choice='plain'
  20                 ><replaceable>value</replaceable
  21         ></arg>
  22 </cmdsynopsis>
  23
  24 <para>Set an environment variable to a new value, similar to the shell's
  25 export or setenv command.  The
  26 <replaceable>variable</replaceable>
  27 and its
  28 <replaceable>value</replaceable>
  29 are inherited by processes started directly by fvwm.  This can be
  30 especially useful in conjunction with the
  31 <fvwmref mod="FvwmM4"/>
  32 module.  For example:</para>
  33
  34 <programlisting>
  35 SetEnv height HEIGHT
  36 </programlisting>
  37
  38 <para>makes the <fvwmref mod="FvwmM4"/> set variable
  39 <emphasis remap='I'>HEIGHT</emphasis>
  40 usable by processes started by fvwm as the environment variable
  41 <emphasis remap='I'>$height</emphasis>.
  42 If
  43 <replaceable>value</replaceable>
  44 includes whitespace, you should enclose it in quotes.  If no
  45 <replaceable>value</replaceable>
  46 is given, the variable is deleted.</para>
  47
  48 </section>