Description of configuration files

This commit is contained in:
mainzelm 2003-05-19 17:29:23 +00:00
parent fd0b0f9b2b
commit fc26f5ddbf
1 changed files with 27 additions and 19 deletions

View File

@ -17,25 +17,33 @@
the managers. The content of this file is created automatically
and you should not need to edit the file manually. In the config
file you can specify all possible configuration options of
orion. The file is parsed and executed as an ordinary scheme
file with the following special syntax extensions:
<p>
<code>
(define-option &lt;group&gt; &lt;name&gt; &lt;value&gt;) <br>
(define-options &lt;group&gt; <br>
&nbsp;&nbsp;(&lt;name1&gt; &lt;value1&gt;) <br>
&nbsp;&nbsp;(&lt;name2&gt; &lt;value2&gt;) <br>
&nbsp;&nbsp;...)
</code>
</p>
<code>&lt;group&gt;</code> specifies which group of options you
want to modify. Currently the possible groups are
<code>root-options</code>, <code>move-options</code>,
<code>switch-options</code> and
<code>split-options</code>. <code>&lt;name&gt;</code> must be
the name of an option defined within the given group. The
following sections list the existing options and the possible
values.
orion. The file is parsed and executed as a scheme module
file. It should define a module <code>config-file</code> with
the interface <code>config-file-interface</code>. This interface
lists 4 association lists <code>root-options</code>,
<code>split-options</code>, <code>switch-options</code>,
<code>move-options</code> for configuring the child window
managers. The following table lists the possible keys, types of
values and default values of the present options. An example
file may look like this:
<pre>
(define-structure config-file config-file-interface
(open scheme xlib config-file-utils)
(begin
(define root-options
'((quit . "F8")
(save-layout . "F7")
(nth-workspace . ("M-1" "M-2" "M-3" "M-4" "M-5" "M-6" "M-7"))
(create-workspace . "F5")))
(define split-options '())
(define switch-options '())
(define move-options '())))
;;; Local Variables:
;;; mode:scheme
;;; End:
</pre>
<h3>root-options</h3>
<table>