doc/fvwm/configuration.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: configuration.xml,v 1.3 2007/08/07 20:17:42 domivogt Exp $ -->
  10
  11 <section id='configuration'>
  12 <title>Configuration</title>
  13 <section id='configuration_files'>
  14 <title>Configuration Files</title>
  15 <para>The configuration file is used to describe mouse and button
  16 bindings, colors, the virtual display size, and related items.
  17 The initialization configuration file is typically called
  18 <filename>config</filename> (or <filename>.fvwm2rc</filename>).
  19 By using the
  20 <fvwmref cmd="Read"/>
  21 command, it is easy to read in new configuration files as you go.</para>
  22
  23 <para>Lines beginning with '#' are ignored by fvwm.  Lines starting with '*'
  24 are expected to contain module configuration commands (rather
  25 than configuration commands for fvwm itself). Like in shell
  26 scripts embedded newlines in a configuration file line can be
  27 quoted by preceding them with a backslash.  All lines linked in
  28 this fashion are treated as a single line.  The newline itself is
  29 ignored.</para>
  30
  31 <para>Fvwm makes no distinction between configuration commands and
  32 action commands, so anything mentioned in the fvwm commands
  33 section can be placed on a line by itself for fvwm to execute as
  34 it reads the configuration file, or it can be placed as an
  35 executable command in a menu or bound to a mouse button or a
  36 keyboard key.  It is left as an exercise for the user to decide
  37 which function make sense for initialization and which ones make
  38 sense for run-time.</para>
  39
  40 </section>
  41
  42 <section id='supplied_configuration'>
  43 <title>Supplied Configuration</title>
  44 <para>A sample configuration file,
  45 <filename>system.fvwm2rc</filename>,
  46 is supplied with the fvwm distribution.  It is well commented and
  47 can be used as a source of examples for fvwm configuration.
  48 It may be copied to <filename>/usr/local/share/fvwm/config</filename> file.</para>
  49
  50 <para>Alternatively, the built-in menu (accessible when no
  51 configuration file is found) has options to create an initial
  52 config file for the user.</para>
  53
  54 <para>If you are new to fvwm, try
  55 <ulink url="http://fvwm-themes.sourceforge.net/">fvwm-themes</ulink>
  56 package demonstrating the powerful fvwm functionality.</para>
  57
  58 </section>
  59 </section>