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