diff --git a/doc/user.html b/doc/user.html new file mode 100644 index 0000000..e7373a7 --- /dev/null +++ b/doc/user.html @@ -0,0 +1,351 @@ + + + Orion User's Manual + + +

Configuration Files

+ + Orion uses two kinds of configuration files residing in the + directory ~/.orion-wm. The first one is called + "layout" and the second "config". Both + configuration files are created for each screen you run orion + on. The name of the screen is appended to the filename, so + usually you will have the files + ~/.orion-wm/layout-:0.1 and + ~/.orion-wm/config-:0.1. The layout file contains + your manager hierarchy and some automatically managed options of + 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: +

+ + (define-option <group> <name> <value>)
+ (define-options <group>
+   (<name1> <value1>)
+   (<name2> <value2>)
+   ...) + +

+ <group> specifies which group of options you + want to modify. Currently the possible groups are + root-options, move-options, + switch-options and + split-options. <name> must be + the name of an option defined within the given group. The + following sections list the existing options and the possible + values. + +

root-options

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
nametypedefault valuedescription
split-horizontalkeys "M-s h"Shortcut for splitting the current manager into a left + and a right part.
split-verticalkeys"M-s v"Shortcut for splitting the current manager into an upper + and a lower part.
split-horizontal-with-switch-wmkeys"M-s s h"Shortcut for splitting the current manager into a left + and a right part with a switch manager in the right part.
split-vertical-with-switch-wmkeys"M-s s v"Shortcut for splitting the current manager into an upper + and a lower part with a switch manager in the right part.
split-horizontal-with-move-wmkeys"M-s m h"Shortcut for splitting the current manager into a left + and a right part with a move manager in the right part.
split-vertical-with-move-wmkeys"M-s m v"Shortcut for splitting the current manager into an upper + and a lower part with a move manager in the right part.
create-switch-wmkeys"M-k s"Create a new switch manager.
create-move-wmkeys"M-k m"Create a new move manager.
split-questionstring"What kind of manager..."
quitkeys"F12"Shortcut for quitting Orion.
quit-questionstring"Really quit orion?"
executekeys"F3"Shortcut for running a program.
execute-questionstring"Execute:"
attachkeys"M-a"Shortcut for attaching a window to the current manager.
attach-questionstring"Attach:"
workspace-optionssexp'()
nth-workspacekeys-list'("M-1" "M-2" "M-3" "M-4")A list of shortcuts for changing directly to the nth + workspace.
create-workspacekeys"F9"Shortcut for creating a new workspace.
create-workspace-questionstring"What kind of manager..."
kill-clientkeys"M-c"Shortcut for closing the current window.
+ +

switch-options

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
nametypedefault valuedescription
titlebar-colorscolors'("#aaaaaa" "#eeeeee" "#777777" "black")Colors for the titlebar. The colors are (background + light-color dark-color font-color).
titlebar-colors-focusedcolors'("#666699" "#aaaacc" "#333366" "#eeeeee")Colors for the titlebar of a focused window.
titlebar-colors-activecolors'("#9999aa" "#eeeeff" "#777788" "black")Colors for the titlebar of an active but not focused window.
titlebar-heightint18The height of a titlebar.
titlebar-stylesymbol'raisedThe style of the titlebar which can be 'raised, 'sunken or 'flat.
fontfont"-*-helvetica-medium-r-normal-*-12-*-*-*-*-*-*-*"The font used for the titlebar text.
select-nextkeys"M-k n"Shortcut for selecting the next client.
select-previouskeys"M-k p"Shortcut for selecting the previous client.
+ +

move-options

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
nametypedefault valuedescription
titlebar-colorscolors'("#aaaaaa" "#eeeeee" "#777777" "black")Colors for the titlebar. The colors are (background + light-color dark-color font-color).
titlebar-colors-focusedcolors'("#666699" "#aaaacc" "#333366" "#eeeeee")Colors for the titlebar of a focused window.
titlebar-heightint18The height of a titlebar.
titlebar-stylesymbol'flatThe style of the titlebar which can be 'raised, 'sunken or 'flat.
fontfont"-*-helvetica-medium-r-normal-*-12-*-*-*-*-*-*-*"The font used for the titlebar text.
border-widthint3The size of a window's border, which also specifies the + area that can be dragged with the mouse to resize a + window.
corner-widthint10This size specifies how big the area in a window's + corner is, that is used for resizing a window in the + diagonal directions.
border-stylesymbol'raisedThe style of the window's border, which can be 'raised, 'sunken or 'flat.
border-colorscolors'("#333333" "#dddddd")Colors for the window's border. The colors are (light-color dark-color).
+ +

split-options

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
nametypedefault valuedescription
bar-widthint3The size of the bar between the two frames.
bar-stylesymbol'raiseThe style of the bar between the two frames which can be 'raised, 'sunken or 'flat.
bar-colorscolors'("#dddddd" "#888888" "#333333")The colors of the bar. The colors are (light main dark).
select-rightkeys"M-Right"Shortcut for selecting the right frame.
select-leftkeys"M-Left"Shortcut for selecting the left frame.
select-upkeys"M-Up"Shortcut for selecting the upper frame.
select-downkeys"M-Down"Shortcut for selecting the lower frame.
+ + +