Configuring Compiz

The behaviour of each compiz plugin is determined by a number of parameters or preference keys. These 'key-value pairs' can be adjusted with the help of Gnome's [http://www.gnome.org/learn/admin-guide/2.14/gconf-0.html Configuration Editor] tool or the gset-compiz application available for download at the compiz repositories.

To use Configuration Editor, click on the "Applications" menu, select "System Tools" and navigate to "Configuration Editor". You can also run the Configuration Editor by invoking

gconf-editor

from a terminal. In the Configuration Editor's main window, navigate to apps>compiz.

Note: Don't run gconf-editor as root i.e. with sudo.

If you experience freezes or crashes while running gconf-editor from the terminal, start it with this command:

G_SLICE=always-malloc gconf-editor

You can also run the Configuration Editor's command line tool,

gconftool-2

to set or display keys. For help with the command line tool, type "man gconftool-2" into the Help Browser.

General Settings

Loading Plugins

It is recommended that you do not specify any plugins except gconf in your startup script. Compiz will load the plugins automatically. (Once you've loaded the gconf plugin, plugins specified on the command line will be ignored. gconf plugin will override them with the list of plugins already stored in the gconf database.) A startup script could look like this:

gnome-window-decorator &  compiz --replace gconf &

To check if all plugins are loaded correctly, go to apps>compiz>general>allscreens>options and make sure active_plugins looks like this:

gconf
miniwin
decoration
transset
state
wobbly
fade
minimize
cube
rotate
zoom
scale
move
resize
place
switcher
trailfocus
water
bs

The order of the plugins is important! Some plugins depend on other plugins and some plugins needs to be loaded before other plugins. The plugin loader will not do anything to try and resolve the order, if some plugin can't be loaded due to a dependency problem it will just be ignored (i.e. it won't load). Add, move or delete items in this list to make it look like above.

Window Snapping

If you press <Control> while moving a window, it will snap to the border of the workspace or other windows. If you want to make snapping the default behaviour, change the value of snap from <Control>Control_L to Control_L under apps>compiz>plugins>wobbly>screen0>options.

Focus follows the Mouse Pointer

Under general>allscreens>options uncheck click_to_focus.

Default Key Bindings

Switch windows = Alt + Tab

Arrange and View All Windows = F12 turns on or off; clicking a window will zoom it to the front

Arrange and View Windows of the Same Application = F11 turns on or off; clicking a window will zoom it to the front

Slow Motion Effects = Shift + F10

Switch desktops on cube/prism = Ctrl + Alt + Left/Right Arrow

Switch desktops on cube/prism with active window following = Ctrl + Shift + Alt + Left/Right Arrow

Rotate desktop cube/prism = Ctrl + Alt + Left-click on wallpaper and drag

Display svg picture on top of cube = modify gconf db, add svg files to /apps/compiz/plugins/cube/screen0/options/svgs (restart needed)

Make window translucent/opaque (built-in) = Alt + mouse wheel up/down

Make window translucent/opaque (with the opacity plugin) = Ctrl + Shift + Scroll, or right-click the window's title bar and select Opacity (seems to be absent in current compiz cvs.)

Zoom-in once = Super-key right-click

Zoom-in manually = Super-key + wheel mouse up

Zoom-out manually = Super-key + wheel mouse down

Move window = Alt + left-click

Snap Move window (will stick to borders) = Ctrl during move (either by Alt + left-click or by title bar)

Resize window = Alt + right-click

Water Effect = Ctrl + Super-key (I have to press the Ctrl key first) - (depends on water plugin)

Rain = Shift + F9 (Requires the water plugin)

Note: Super-key is the usually the same as the "windows-key" on most keyboards. (adjustable in the keyboard preferences)

Custom Key Bindings

Under apps>compiz>general>allscreens add the command or program you wish to run to commandX and the keybinding to initiate it to run_commandX where X is a number 0-11. Suitable modifiers are <Alt>, <Shift> and <Control>.

Example: To make Control + Alt + Delete bring up the System Monitor tool use gnome-system-monitor as the command and <Control><Alt>Delete as the keybinding.

Increasing the Number of 'ViewPorts'

Under apps>compiz>general>screen0>options, change the value of the size key. The minimal (and default) value is 4, the maximal value is 32.

The 'cube' with its default of four desktops is actually a [http://en.wikipedia.org/wiki/Image:Tetragonal_prism.png tetragonal prism]. Increasing the number of 'viewports' will change your prism into a different type of [http://en.wikipedia.org/wiki/Prism_%28geometry%29#Uniform_prisms prism] -- an [http://en.wikipedia.org/wiki/Image:Octagonal_prism.png octagonal prism] or [http://en.wikipedia.org/wiki/Image:Dodecagonal_prism.png dodecagonal prism] for example.

Increasing the number of viewports from the default 4 will currently cause images located on the caps of the prism to stop working.

Individual Plugins Settings

BS

This plugin controls brightness / saturation values.

• brightness_decrease - Key-binding to decrease brightness.

• brightness_increase - Key-binding to increase brightness.

• brightness_step - Step by which to change the brightness.

• saturation_decrease - Key-binding to decrease saturation.

• saturation_increase - Key-binding to increase saturation.

• saturation_step - Step by which to change the saturation.

Cube

The 'cube' plugin controls various characteristics of the prism (the 'cube').

• color - sets the background color of the cube caps

• draw_caps - Toggle the top and bottom of the cube. Uncheck to keep them transparent and see-through to the skydome.

• images - lists the images for use on the 'cube' caps

• images_bottom - Add the location to images here that will be displayed on the bottom of the cube.

• images_top - Add the location to images here that will be displayed on the top of the cube.

• in - Check the "in" checkbox to make it look like you are inside the cube when rotating (instead of outside)

• next_slide - key binding for switching to the next image in the image list described under images.

• prev_slide - key binding for switching to the previous image in the image list described under images.

• rotate_images - Toggles rotation of the images to the direction of the cube.

• scale_image - enables the scaling of images on the cube's caps

• scale_image_bottom - Toggles image scaling on the cube bottom..

• scale_image_top - Toggles image scaling on the cube top.

• skydome - Check to have an image displayed behind the cube when rotating with mouse.

• skydome_animated - Check to make it look like you are moving around the cube when rotating with mouse.

• skydome_image - Insert path to the image you want to be displayed behind the cube.

Anchor(cube_svgs)

• svgs - Select image(s) to be displayed on top of the cube.

* unfold - key binding for the 'unfold' effect: the cube or prism is laid out like a film strip on your screen, allowing you to select a different screen by moving left or right. Somewhat similar to the 'switcher' feature, but for the desktop as a whole instead of active windows.

Suggested image sizes for skydome feature are:

1024 x 1024, 1024 x 2048, 1024 x 4096, 2048 x 1024, 2048 x 2048, 2048 x 4096, 4096 x 1024, 4096 x 2048, 4096 x 4096

Images for the cube caps should be in either svg or png formats; the skydome images should be in png format.

suggested directories for the images that go on the top or bottom cap of the prism:

~/.compiz BR/usr/share/compiz

Decoration

The 'decoration' plugin enables the window manager.

• decor_theme -

• shadow_offset_x - X-offset for window shadows (can be negative for opposite direction).

• shadow_offset_y - Y-offset for window shadows (can be negative for opposite direction).

• shadow_opacity - Opacity level of window shadows.

• shadow_radius - Radius value for window shadows.

Fade

The 'fade' plugin makes windows, menus or tooltips fade in or out.

• fade_speed - How fast the windows fade in and out.

• window_types - Define the window types that should be affected by the 'fade' plugin. For available types see the [#window_types Window types] section.

Tip: Remove Splash from window_types to allow the switcher to terminate. See [http://compiz.ed3n.com/viewtopic.php?id=144 this compiz forum topic] for details.

Anchor(minimze)

Minimize

Minimize makes windows "zoom in" when created and "zoom out" when closed or minimized.

• speed - The speed of the minimize effect.

• timestep -

• Toolbar -

• window_types - Select the windows you want the effect to apply to. For Available windows see [#window_types window_types]

• zoom_created_windows - Check to make the effect apply to created windows. Note: This takes priority over wobbly creation (the map_effect key in the wobbly plugin).

• zoom_created_windows_from_center - Check to make windows zoom in and out from/to their center, not from/to the mouse pointer.

Anchor(zooming_menus)

Enable Zooming Menus

To make menus zoom on creation, ensure that Unknown is included in the window_types key.

Note: This option takes priority over [#wobbly_menus wobbly menus].

MiniWin

This is an experimental plugin. It allows the user to create an icon of a mini-window, or even 'mindow', that shows a picture of the main window and can be clicked on to return the main window. It is a possible replacement for the minimize funtionality. More information and up-to-date links to the source can be found [http://compiz.blogspot.com/2006/03/miniwin.html here] on the compiz blog and in the compiz forum.

• always_on_top - Toggles mindows being on top of other programs.

• bring_back_centered - deprecated?

• deiconify_key - deprecated? Key binding to maximize a mini-window.

• demindow_key -

• dock_opacity - opacity of the dock

• hide_dock_on_click -

• iconify_key - deprecated? Key binding to create a window.

• iconify_on_minimize - deprecated? Toggles miniwin as default behavior for minimize.

• mindow_key -

• mindow_opacity - Opacity of mini-window (0 - 100).

• mindow_width - Width of mini-window.

• move_key - deprecated? Key binding to move mini-window.

• on_all_workspaces - Toggles mindows to be on all workspaces.

• only_move_up -

• opacity_on_hover - Opacity of mini-window while hovering (0 - 100).

• runs_on_aiglx -

• scale_on_hover_factor -

• scale_on_hover_size - deprecated?

• set_dock_background_key -

• show_dock - Toggles the dock feature.

• taskbar_hide_on_click - deprecated?

• taskbar_opacity - deprecated?

• taskbar_spacing -

• terminate_move_key - deprecated? Key binding to terminate moving of mini-window.

• use_as_taskbar -

• window_types - Valid window types for mini-windows. For Available windows see [#window_types window_types]

Move

• constrain_y - prevents the window from being moved above the top of the screen.

• edgeflip -

• edgeflip_continous_drag - deprecated? now in rotate? Check to make the windows appear at the edge of the screen that corresponds to the workspace you switched from. Otherwise they will appear on the opposite side.

• edgeflip_ratio - deprecated? now in rotate? How many percent of the window's width that must be outside the edge of the screen before flipping.

• edgeflip_ratiobased - deprecated? now in rotate? Check to make the previous setting active.

• edgeflip_time - deprecated? now in rotate? Set amount of second you need to hold the mouse pointer at the edge of the screen while dragging a window before edgeflip commences.

• edgeflip_timebased - deprecated? now in rotate? - Check to make the previous setting active.

• edgeflip_tolerance - deprecated? now in rotate? -

• initiate - Set the key combination for dragging a window by clicking anywhere on its body.

• moving_window_opacity_level (deprecated) - Set transparency of windows being moved (0 is fully transparent, 100 is solid).

• opacity_min_opacity -

• opacity_non_opaque -

• opacity - Set translucency of windows while they are being moved (0 is fully translucent, 100 is opaque).

• snapoff_maximized -

• terminate - Set the key combination to release the dragged window.

Place

Places new windows in logical positions that will usually not overlap with other windows or toolbars.

• workarounds

Resize

The 'resize' plugin controls the resizing of windows by key combinations or mouse clicks.

• initiate - Key combination which allows resizing of windows.

• opacity_non_opaque -

• opacity - Setting the opacity level while resizing.

• terminate - Key combination which stops resizing.

Rotate

• acceleration - Set the acceleration of the cube-rotation. Can be set from 1 to 19.

• edge_flip - When edge flipping is enabled, the cube/prism rotates to the next face (virtual desktop) when you bump the pointer against the edge of the screen.

• flip_move -

• flip_time - Time taken to flip

• initiate - Set key combination to rotate the cube with the mouse. You have to click on the desktop, it will not work by clicking in a window.

• invert_x & invert_y - Invert mouse-axis while rotating the cube.

• rotate_left & rotate_right - Set key combination to rotate the cube with keys.

• rotate_left_window & rotate_right_window - Defined keys keep the active window on top while rotating the cube.

• rotate_to_1 & rotate_to_1_window etc.. -

• sensitivity - Changes the mouse-sensitivity on cube-rotating. Can be set from 1 to 100.

• snap_bottom - Makes it possible to rotate to the bottom of the cube and have it stop in that position after releasing the mouse button. Can be used for slideshows of images listed under cube>[#cube_svgs svgs].

• snap_top - Makes it possible to rotate to the top of the cube and have it stop in that position after releasing the mouse button. Can be used for slideshows of images listed under cube>[#cube_svgs svgs].

• speed - Set the speed with which the cube rotates (1-49)

• terminate - Set key combination to terminate the function described in "initiate".

• timestep - Sets the delay before edge flipping.

Scale

This plugin scales all your active windows so that you can see them all at once, similar to the 'Exposé' feature in Mac OS X. Clicking on any window will activate it and cause all the windows to return to their original size. By default, F12 scales all windows; F11 scales all the windows from any specific application.

• corners - define a screen corner that will tigger the scale feature. For example, TopRight will initiate the feature when moving the mouse pointer to top right screen corner. See initiate for a key combination for the same effect.

• current_corners - define a screen corner that will trigger the scale feature for windows that belong to the currently active application only. For example, TopLeft will initiate scaled mode for the active application when moving the mouse to the top left corner. See initiate_current for a key combination for the same effect.

• all_screens_corners - define a screen corner that will trigger the scale feature for all currently active windows on all desktops. For example, TopLeft will initiate scaled mode for all active windows from all desktops when moving the mouse to the top left corner. See initiate_all_screens for a key combination for the same effect.

• darken_back - Darkens the surrounding desktop and makes the scaled windows stand out more.

• darken_back_factor -

• initiate - Key which activates scaled mode for all windows on the current workspace. See corners for a screen corner definition of the same effect.

• initiate_all_screens - Key which activates scaled mode for windows on all workspaces.

• initiate_current - Key which activates scaled mode for windows of the active application only. If this does not work as you expect it to, try to change [#use_class "use_class"]. See current_corners for a screen corner definition of the same effect.

• next_window - Key with which you can select next window in scaled mode (in addition, windows can also be selected with the mouse).

• opacity - Opacity of unfocused windows in scaled mode.

• prev_window - Key with which you can select previous window in scaled mode (in addition, windows can also be selected with the mouse).

• show_desktop -

• sloppy_focus - If checked, focus follows mousepointer in scaled mode.

• spacing - Padding of scaled windows. Default is 25.

• speed - How fast windows move to their scaled size/position.

• terminate - Key to stop scaling and move windows back to their original size and position. Used if scaling was started with the key set in initiate. Left-click on a window also terminates scaled mode.

• terminate_all_screens - Key to stop scaling and move windows back to their original size/position. Used if scaling was started with the key set in initiate_all_screens. Left-click on a window also terminates scaled mode.

• terminate_current - Key to stop scaling and move windows back to their original size/position. Used if scaling was started with the key set in initiate_current. Left-click on a window also terminates scaled mode.

• timestep

• unfocused_opacity - deprecated? now the opacity option?

Anchor(use_class)

• use_class - If checked, initiate_current uses WM_CLASS instead of WM_NAME to determine which windows belong to one application. WM_CLASS includes different instances of the same application, while WM_NAME does not.

• window_types - Which kinds of windows to include in scaled mode. By default, Menu, Splash and Unknown (Tooltips, etc.) are not included. For Available windows see [#window_types window_types]

Anchor(state)

State

You can set the opacity / translucency of windows, window types, or individual windows on your desktop with the 'state' plugin.

• opacity - List windows by type, class, title or by the application that controls them and adjust their translucency states. For example, to set the opacity of all menus to 80, enter w:Menu:80.

• w = [#window_types window type] (Dock, Toolbar, Menu, Utility, Splash, Normal, Dialog, ModalDialog, Unknown) BRc = window classBRt = window title (set translucency by specific window title. For example, try t:About the GNOME Desktop:80 and navigate to "System">"About GNOME") BRp = window by owning program set translucency by program name as it appears in $PATH).

Switcher

The 'switcher' plugin allows easy switching between various sets of open windows on your desktop.

• all_desktops - Include all windows from all desktops in the switcher.

• brightness - Brightness of the desktop behind all the windows.

• bring_to_front - Bring the selected window to the front of all other windows when selected.

• color - depreciated? Background color of the switcher.

• initiate - Key binding to initiate the switcher. Default: Alt + Tab.

• initiate_all - Key binding to switch between windows from all virtual desktops or 'viewports' (not just the current one). Default: Control + Alt + Tab.

• mipmap - Better performance for the switcher using some cool OpenGL thing.

• next_window - Key binding to move to the next window in the switcher.

• opacity - Opacity of the unfocused windows in the windows list.

• prev_window - Key binding to move to the previous window in the switcher. Default: Shift

• reverse_initiate - Reverse the order in which the windows are being switched.

• saturation - Saturation of the unfocused windows in the windows list.

• show_minimized - Show minimized windows in the switcher.

• single_window -

• speed - Controlling the speed with which the switcher moves mini windows.

• terminate - Key binding to terminate the switcher.

• timestep - ?

• window_types - Types of windows to show in the switcher. For Available windows see [#window_types window_types]

Opaquefocus (deprecated)

Note: The 'opaquefocus' plugin is deprecated as of version 0.0.7-0ubuntu10 (and, in fact, is not contained in any later releases). It should not be used as it causes some bugs with window drawing. You can emulate its behaviour with the [#trailfocus 'trailfocus'] plugin.

To make 'trailfocus' behave like 'opaquefocus', set maximum_trail_count to 2 and adjust the values for the maximum_* and minimum_* keys to your liking. The currently focused window will have the maximum_* values, all other windows will have the minimum_* values.

To remove 'opaquefocus' keys from previous installations from your gconf database, run the following command from a terminal

  gconftool-2 --recursive-unset /apps/compiz/plugins/opaquefocus

Anchor(trailfocus)

Trailfocus

Trailfocus changes brightness, saturation and opacity of your windows depending on how long you have not used them. For details on how Trailfocus can replace Opaquefocus, see below.

• exclude - List applications which will not be affected by Trailfocus. For help on how to find out the name you should fill in see [#xprop "Find out the name of an application"] above.

• maximum_trail_count - Length of the "trail" that your window switching leaves. In other words: the number of states the windows can have.

• maximum_window_brightness_level - Brightness of the most recently focused window.

• maximum_window_opacity_level - Opcaity of the most recently focused window.

• maximum_window_saturation_level - Saturation of the most recently focused window.

• minimum_window_brightness_level - Brightness of the least recently focused window.

• minimum_window_opacity_level - Opacity of the least recently focused window.

• minimum_window_saturation_level - Saturation of the least recently focused window.

Transset (deprecated)

The Transset plugin [http://compiz.net/viewtopic.php?id=787 is now deprecated], use the [#state 'State'] plugin instead

Water

This plugin is currently quite unstable. Reports say it uses intense CPU resources, and crashes X. Use at your own risk.

• initiate - Key binding to initiate the water effect.

• offset_scale -

• rain_delay - Time, in milliseconds, between rain drops.

• terminate - Key binding to terminate the water effect.

• toggle_rain - Key binding to toggle a rain effect (random drops of water).

Wobbly

The 'wobbly' plugin makes windows wobble while they are being moved or resized.

• focus_effect - Makes windows wobble when they receive focus. (Values are None, Shiver).

• focus_friction - defines the window's 'resistance' to the wobble effect described with focus_effect.

• focus_spring_k - Spring constant for focus_effect.

• focus_window_types - Window types that should wobble when focused. See the [#window_types Window types] section for a list of window types.

• friction - deprecated? Affects the overall wobbliness along with spring_k. (Values are 1 to 9). Resistance of the window to wobbling.

• grab_effect - Makes windows wobble when grabbed.

• grab_friction - 'Resistance' to grab_effect.

• grab_spring_k - Spring constant for grab_effect.

• grab_window_types - Describes the window types affected by grab_effect. See the [#window_types Window types] section for a list of window types.

• grid_resolution - The resolution of the grid which is wobbled.

• map_effect - Makes windows wobble when they first appear. (Values are None, Shiver). BR Note: The zoom_created_windows key in the [#minimize 'minimize'] plugin will take priority over this key.

• map_friction - 'Resistance' to the map_effect.

• map_spring_k - Spring constant for map_effect.

• map_window_types - Window types that should wobble when they first appear. For Available windows see [#window_types window_types]

• maximize_effect - Makes windows wobble when maximized.

• maximize_friction - 'Resistance' to the maximize_effect.

• maximize_spring_k - Spring constant for maximize_effect.

• min_grid_size - The minimum size of the grid which is wobbled.

• move_effect - Makes windows wobble when they are moved.

• move_friction - 'Resistance' to the move_effect.

• move_spring_k - Spring constant move effect.

• move_window_types - Window types which should wobble when moved. For Available windows see [#window_types window_types]

• snap - Key binding to snap windows to borders.

• spring_k - deprecated? Affects the overall wobbliness along with friction. (Values are 1 to 9). Ridgidity/flexibility of the window

• window_types - deprecated? Types of windows to wobble. For Available windows see [#window_types window_types]

• wobble_on_grab - deprecated? Toggles wobbling when grabbing a window.

• wobble_on_move - deprecated? Toggles wobbling while moving a window.

• wobble_on_resize - deprecated?

Anchor(wobbly_menus) Tip: To make menus wobble, set the map_effect key to Shiver. Also ensure that Unknown is included in the map_window_types key.

If [#zooming_menus zooming menus] is currently enabled, it will take priority over this option.

Zoom

The 'zoom' plugin allows you to zoom in on a part of the desktop.

• filter_linear - Toggles smoother lines (edges, text, etc..) when zooming in.

• initiate - Key binding to initiate zooming.

• invert_y - Toggles an inverted y-axis for zooming.

• max - How much you can zoom out. A value greater than 1 means you will be able to zoom out "outside" the cube.

• min - How much you can zoom in. A value between 0 and 1 where 1 is no zoom at all.

• sensitivity - Mouse sensitivity when zoomed.

• speed - Speed at which zooming occurs.

• step - Step at which zooming occurs.

• terminate - Key binding to terminate zooming.

• timestep - ?

• zoom_in - Key binding to zoom in.

• zoom_out - Key binding to zoom out.

General Help

Remove black border when minimizing

When minimizing windows to the panel, GNOME draws a black border around them. This looks out of place if you use Compiz' minimize plugin. To disable the border, open gconf-editor and uncheck enable_animations under apps>panel>global.

Stick a window to all workspaces

Right-click on the window's titlebar and select "On All Workspaces".

Anchor(xprop)

Find the name of an application

Some plugins ("Trailfocus: exclude", "Transset", etc.) require you to fill in the names (to be more precise the WM_CLASS) of the applications which it will affect. To find out the name to fill in, enter this into a terminal and click on the application's window:

xprop | grep WM_CLASS | cut -d \" -f 4

Anchor(window_types)

Window Types

The window_types option for the plugins below lists the type of windows you want the plugin to effect avaliable types are

Dock, Toolbar, Menu, Utility, Splash, Normal, Dialog, ModalDialog, Unknown

.

Q. Are there any more window types? And what windows are part of each type?

FAQ

I've got it working, but I don't know how to change a setting - where can I ask questions?

Current discussion with a lot of people who can help you takes place in [http://ubuntuforums.org/showthread.php?t=148472 this thread]. Please use the "Search this Thread" function before asking questions.

• There is also a forum for compiz discussions at http://compiz.ed3n.com/ and also a [http://compiz.blogspot.com/ compiz blog] detailing news on new plugins and updates.

I don't like the theme of Compiz, how can I change it?

At present, compiz relies on 'gnome-window-decorator' to draw its window borders. It cannot use metacity's window themes but the colors used by gnome-window-decorator are those specified by your GTK-theme. Change it, and the color of your titlebar, tooltips, etc. will change, too.

The shadows Compiz draws are so small and are not cast the way I want them to. Is there a way to change that?

Not at the moment. The shadows are currently hardcoded and use pixmaps, but this might change in the future.

My SDL apps are transparent and look strange, how can I fix this?

Set the environment variable XLIB_SKIP_ARGB_VISUALS to 1 and then run your SDL program. For instance, from a terminal, do this:

export XLIB_SKIP_ARGB_VISUALS=1
yourprogram

Is there anything I can do if the water plugin freezes my desktop?

It has generally been noticed that it does not lock up the system, so it can often be corrected by restarting compiz. Use <control><alt>F2 to open a terminal, and type

killall compiz.real

. You should now be able to come back into your desktop <control><alt>F6 and restart compiz:

compiz --replace gconf

CategoryDocumentation