doc/commands/Read.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: Read.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='Read'>
  12 <title>Read</title>
  13
  14 <cmdsynopsis>
  15         <command>Read</command
  16         ><arg choice='plain'
  17                 ><replaceable>filename</replaceable
  18         ></arg
  19         ><arg choice='opt'>quiet</arg>
  20 </cmdsynopsis>
  21
  22 <para>Causes fvwm to read commands from the file named
  23 <replaceable>filename</replaceable>.
  24 If the keyword
  25 <fvwmopt cmd="Read" opt="Quiet"/>
  26 follows the command no message is produced if the file is not
  27 found.  If the file name does not begin with a slash ('/'), fvwm
  28 looks in the user's data directory, then the system data
  29 directory.  The user's data directory is by default
  30 <filename><envar>$HOME</envar>/.fvwm</filename>.
  31 It can be overridden by exporting
  32 <envar>FVWM_USERDIR</envar>
  33 set to any other directory.  The
  34 <emphasis remap='B'>Read</emphasis>
  35 command returns 1 if the given file could be read or -1 if not
  36 (see the section
  37 <fvwmref sect="conditionals" opt="conditional_commands" name="Conditional Commands"/>
  38 for the meaning of return codes).</para>
  39
  40
  41 </section>